diff options
| author | Mattias Andrée <maandree@kth.se> | 2017-04-08 13:57:36 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2017-04-08 13:57:36 +0200 |
| commit | 478b53f935264bdfe4efe394f8d804a1361a6770 (patch) | |
| tree | 31c87de7b67f928ff93b4564e0929d7db2a369f8 /man | |
| parent | Update TODO: blind-from-sent (diff) | |
| download | blind-478b53f935264bdfe4efe394f8d804a1361a6770.tar.gz blind-478b53f935264bdfe4efe394f8d804a1361a6770.tar.bz2 blind-478b53f935264bdfe4efe394f8d804a1361a6770.tar.xz | |
Document memory requirements, minor style fixes, more use of BUFSIZ, fix warnings, and fix potential buffer overflow
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man')
| -rw-r--r-- | man/blind-compress.1 | 4 | ||||
| -rw-r--r-- | man/blind-crop.1 | 15 | ||||
| -rw-r--r-- | man/blind-decompress.1 | 4 | ||||
| -rw-r--r-- | man/blind-extend.1 | 9 | ||||
| -rw-r--r-- | man/blind-flip.1 | 4 | ||||
| -rw-r--r-- | man/blind-flop.1 | 5 | ||||
| -rw-r--r-- | man/blind-gauss-blur.1 | 4 | ||||
| -rw-r--r-- | man/blind-repeat.1 | 6 | ||||
| -rw-r--r-- | man/blind-rotate-180.1 | 11 | ||||
| -rw-r--r-- | man/blind-rotate-270.1 | 10 | ||||
| -rw-r--r-- | man/blind-rotate-90.1 | 10 | ||||
| -rw-r--r-- | man/blind-transpose.1 | 7 |
12 files changed, 89 insertions, 0 deletions
diff --git a/man/blind-compress.1 b/man/blind-compress.1 index 7a39b6c..7ffa5ad 100644 --- a/man/blind-compress.1 +++ b/man/blind-compress.1 @@ -18,6 +18,10 @@ It is recommended to combine .B blind-compress with .BR "lz4 -1" . +.SH REQUIREMENTS +.B blind-compress +requires enough free memory to load two full frames into +memory. A frame requires 32 bytes per pixel it contains. .SH SEE ALSO .BR blind (7), .BR blind-decompress (1), diff --git a/man/blind-crop.1 b/man/blind-crop.1 index 8e2a34e..fc635a9 100644 --- a/man/blind-crop.1 +++ b/man/blind-crop.1 @@ -49,6 +49,21 @@ pixels rightward of the output video's left-most pixel, and the subvideo's top-most pixel will be positioned .I top pixels downward of the output video's left-most pixel. +.SH REQUIREMENTS +.B blind-crop +requires enough free memory to load two full frames into +memory, one of the size of the source video's frames, +and one of the size of the target video's frames. However, +if +.B -s +or +.B -S +is used, only memory for one full frame, of the size of +the source video's frames, are required. A frame requires +32 bytes per pixel it contains. +.B blind-crop +has not been optimised for memory usage, but instead +for code simplicity. .SH SEE ALSO .BR blind (7), .BR blind-extend (1) diff --git a/man/blind-decompress.1 b/man/blind-decompress.1 index 260a09a..9be346d 100644 --- a/man/blind-decompress.1 +++ b/man/blind-decompress.1 @@ -7,6 +7,10 @@ blind-decompress - Decompress a video compressed by blind-compress(1) .B blind-decompress removes compressed added by .BR blind-compress (1). +.SH REQUIREMENTS +.B blind-decompress +requires enough free memory to load one full frame into +memory. A frame requires 32 bytes per pixel it contains. .SH SEE ALSO .BR blind (7), .BR blind-compress (1), diff --git a/man/blind-extend.1 b/man/blind-extend.1 index 455a838..3e09843 100644 --- a/man/blind-extend.1 +++ b/man/blind-extend.1 @@ -52,6 +52,15 @@ of the input videos in the new room, such that the right-most part of the video has is put side-by-side with the left-most part of the video, and analogously for the other sides. +.SH REQUIREMENTS +.B blind-extend +requires enough free memory to load two full frames into +memory, one of the size of the source video's frames, +and one of the size of the target video's frames. A frame +requires 32 bytes per pixel it contains. +.B blind-extend +has not been optimised for memory usage, but instead +for code simplicity. .SH SEE ALSO .BR blind (7), .BR blind-crop (1) diff --git a/man/blind-flip.1 b/man/blind-flip.1 index 6f0a806..424e071 100644 --- a/man/blind-flip.1 +++ b/man/blind-flip.1 @@ -7,6 +7,10 @@ blind-flip - Mirror a video vertically .B blind-flip reads a video from stdin and prints it, mirrored vertically, to stdout. +.SH REQUIREMENTS +.B blind-flip +requires enough free memory to load one full frame into +memory. A frame requires 32 bytes per pixel it contains. .SH SEE ALSO .BR blind (7), .BR blind-flop (1), diff --git a/man/blind-flop.1 b/man/blind-flop.1 index 182b712..674306e 100644 --- a/man/blind-flop.1 +++ b/man/blind-flop.1 @@ -7,6 +7,11 @@ blind-flop - Mirror a video horizontally .B blind-flop reads a video from stdin and prints it, mirrored horizontally, to stdout. +.SH REQUIREMENTS +.B blind-flop +requires enough free memory to load two frame rows into memory. +A frame row requires 32 bytes per pixel it contains, that is, +32 bytes times the width of the video in pixel. .SH SEE ALSO .BR blind (7), .BR blind-flip (1), diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1 index 58381a5..6405f00 100644 --- a/man/blind-gauss-blur.1 +++ b/man/blind-gauss-blur.1 @@ -72,6 +72,10 @@ specified. Use the Y value (multiplied by the alpha value) from .I sd-stream as the standard deviation all channels. +.SH REQUIREMENTS +.B blind-compress +requires enough free memory to load three full frames into +memory. A frame requires 32 bytes per pixel it contains. .SH SEE ALSO .BR blind (7), .BR blind-single-colour (1), diff --git a/man/blind-repeat.1 b/man/blind-repeat.1 index 1c15965..ce5a8c0 100644 --- a/man/blind-repeat.1 +++ b/man/blind-repeat.1 @@ -33,6 +33,12 @@ will read stdin into memory; you are highly discouraged from using this unless stdin is a single frame, or known to only be a very small number of frames, is it can potentially use all of the computer's memory. +.SH REQUIREMENTS +.B blind-repeat +requires enough free memory to load the entire video +into memory if it is read from stdin. A frame requires +32 bytes per pixel it contains. So for a 720p video at +25 Hz, 1 GB is reached in just below 1.5 seconds. .SH SEE ALSO .BR blind (7), .BR blind-from-image (1) diff --git a/man/blind-rotate-180.1 b/man/blind-rotate-180.1 index 89d8a09..8167af1 100644 --- a/man/blind-rotate-180.1 +++ b/man/blind-rotate-180.1 @@ -7,6 +7,17 @@ blind-rotate-180 - Rotate a video 180 degrees .B blind-rotate-180 reads a video from stdin and prints it, rotated 180 degrees, to stdout. +.SH REQUIREMENTS +.B blind-rotate-180 +is implemented as a shell script pipeline of +.BR blind-flip (1) +and +.BR blind-flop (1), +see those for details on requirements. +.B blind-rotate-180 +is not been optimised for memory usage, but instead +for code simplicity, however, it does not exceed the +optimum greatly. .SH SEE ALSO .BR blind (7), .BR blind-rotate-90 (1), diff --git a/man/blind-rotate-270.1 b/man/blind-rotate-270.1 index 46420b7..18839c3 100644 --- a/man/blind-rotate-270.1 +++ b/man/blind-rotate-270.1 @@ -8,6 +8,16 @@ blind-rotate-270 - Rotate a video 270 degrees clockwise reads a video from stdin and prints it, rotated 270 degrees clockwise (90 degrees anti-clockwise), to stdout. +.SH REQUIREMENTS +.B blind-rotate-270 +is implemented as a shell script pipeline of +.BR blind-flop (1) +and +.BR blind-transpose (1), +see those for details on requirements. +.B blind-rotate-270 +is not been optimised for memory usage, but instead +for code simplicity. .SH SEE ALSO .BR blind (7), .BR blind-rotate-90 (1), diff --git a/man/blind-rotate-90.1 b/man/blind-rotate-90.1 index 515c524..7097b59 100644 --- a/man/blind-rotate-90.1 +++ b/man/blind-rotate-90.1 @@ -7,6 +7,16 @@ blind-rotate-90 - Rotate a video 90 degrees clockwise .B blind-rotate-90 reads a video from stdin and prints it, rotated 90 degrees clockwise, to stdout. +.SH REQUIREMENTS +.B blind-rotate-90 +is implemented as a shell script pipeline of +.BR blind-transpose (1) +and +.BR blind-flop (1), +see those for details on requirements. +.B blind-rotate-90 +is not been optimised for memory usage, but instead +for code simplicity. .SH SEE ALSO .BR blind (7), .BR blind-rotate-180 (1), diff --git a/man/blind-transpose.1 b/man/blind-transpose.1 index 9aa2706..61ecd86 100644 --- a/man/blind-transpose.1 +++ b/man/blind-transpose.1 @@ -10,6 +10,13 @@ transposed, to stdout. .P To transpose a videos means to swap the X and Y coordinates. +.SH REQUIREMENTS +.B blind-transpose +requires enough free memory to load two full frames into +memory. A frame requires 32 bytes per pixel it contains. +.B blind-transpose +has not been optimised for memory usage, but instead +for code simplicity. .SH SEE ALSO .BR blind (7), .BR blind-flip (1), |
