commit 164a00aebebefe42245957dcfe7c810304ad4567
parent d1affdea923a0ac117ebb5e4c2e5011f59fd3188
Author: Mattias Andrée <maandree@kth.se>
Date: Sun, 22 Jan 2017 11:59:42 +0100
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat:
4 files changed, 156 insertions(+), 3 deletions(-)
diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1
@@ -0,0 +1,76 @@
+.TH BLIND-GAUSS-BLUR 1 blind
+.SH NAME
+blind-gauss-blur - Apply Gaussian blur to a video
+.SH SYNOPSIS
+.B blind-gauss-blur
+[-j
+.IR jobs ]
+[-s
+.I spread
+|
+-s
+.RB ' auto ']
+[-achvy]
+.I sd-stream
+.SH DESCRIPTION
+.B blind-gauss-blur
+reads a video from stdin and a mask video from
+.IR sd-stream .
+The video is printed to stdout, with all pixels are
+blurred using Gaussian blur with a standard
+deviation calculated for each pixel individually.
+The standard deviation is calculated by multiplying
+the X, Y, or Z value with the alpha value of the
+corresponding pixel and frame in
+.IR sd-stream .
+The X value is used when blurring the X channel,
+and analogously for Y and Z. If the standard
+deviation is 0, the pixel is not blurred.
+.P
+If stdin is longer than
+.IR sd-stream ,
+the remainder or stdin is printed without any changes.
+If stdin is shorter than
+.IR sd-stream ,
+the remainder of
+.I sd-stream
+is ignored but may be partially read.
+.SH OPTIONS
+.TP
+.B -a
+Used to optimise performance if it is known that
+the video is opaque.
+.TP
+.B -c
+Blur the chroma only, not the luma.
+.TP
+.B -h
+Blur horizontally only. Has no affect if -v is also
+specified.
+.TP
+.BR -j " "\fIjobs\fP
+Process the video in parallel, using
+.I jobs
+processes.
+.TP
+.BR -s " "\fIspread\fP
+Pixels with Manhattan distances exceeding
+.I spread
+shall not affect each other. If
+.RB ' auto '
+is specified, this value is calculated from
+the standard deviation used to blir a pixel.
+If -s is not used, there will not be
+distance limit.
+.TP
+.B -v
+Blur vertically only. Has no affect if -h is also
+specified.
+.TP
+.B -y
+Use the Y value (multiplied by the alpha value) from
+.I sd-stream
+as the standard deviation all channels.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-invert-luma.1 b/man/blind-invert-luma.1
@@ -0,0 +1,43 @@
+.TH BLIND-INVERT-LUMA 1 blind
+.SH NAME
+blind-invert-luma - Invert the luminosity of a video
+.SH SYNOPSIS
+.B blind-invert-luma
+[-iw]
+.I mask-stream
+.SH DESCRIPTION
+.B blind-invert-luma
+reads a video from stdin and a mask video from
+.IR mask-stream .
+The video is printed to stdout, with the luminosity
+inverted where, in
+.IR mask-stream ,
+the product of the luminosity and the alpha value is
+1, and unchanged where the product is 0. For other
+products, the result is linearly interpolated or
+linearly extrapolated.
+.P
+If stdin is longer than
+.IR mask-stream ,
+the remainder or stdin is printed without any changes.
+If stdin is shorter than
+.IR mask-stream ,
+the remainder of
+.I mask-stream
+is ignored but may be partially read.
+.SH OPTIONS
+.TP
+.B -i
+Invert the luminosity in
+.I mask-stream
+before calculating the product of the luminosity and
+the alpha value.
+.TP
+.B -w
+Instead of using CIE Standard Illuminant D65 as the
+whitepoint, use the X and Z from each pixel in
+.I mask-stream
+for the whitepoint.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
diff --git a/man/blind-set-luma.1 b/man/blind-set-luma.1
@@ -14,12 +14,12 @@ luminosity and the alpha value of the corresponding
pixel and frame in the mask video.
.P
If stdin is longer than
-.IR alpha-stream ,
+.IR luma-stream ,
the remainder or stdin is printed without any changes.
If stdin is shorter than
-.IR alpha-stream ,
+.IR luma-stream ,
the remainder of
-.I alpha-stream
+.I luma-stream
is ignored but may be partially read.
.SH NOTES
In most cases, this is not what you want to use, instead
diff --git a/man/blind-set-saturation.1 b/man/blind-set-saturation.1
@@ -0,0 +1,34 @@
+.TH BLIND-SET-SATURATION 1 blind
+.SH NAME
+blind-set-saturation - Multiply the saturation of a video
+.SH SYNOPSIS
+.B blind-set-saturation
+[-w]
+.I saturation-stream
+.SH DESCRIPTION
+.B blind-set-saturation
+reads a video from stdin and a mask video from
+.IR saturation-stream .
+The video is printed to stdout, with the saturation
+of each pixel multiplied by the product of the
+luminosity and the alpha value of the corresponding
+pixel and frame in the mask video.
+.P
+If stdin is longer than
+.IR saturation-stream ,
+the remainder or stdin is printed without any changes.
+If stdin is shorter than
+.IR saturation-stream ,
+the remainder of
+.I saturation-stream
+is ignored but may be partially read.
+.SH OPTIONS
+.TP
+.B -w
+Instead of using CIE Standard Illuminant D65 as the
+whitepoint, use the X and Z from each pixel in
+.I saturation-stream
+for the whitepoint.
+.SH AUTHORS
+Mattias Andree
+.RI < maandree@kth.se >
