aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-07-22 19:33:54 +0200
committerMattias Andrée <maandree@kth.se>2017-07-22 19:33:54 +0200
commitebe2e88b44f46e59bdefef1eb585078d5fa6d4d4 (patch)
tree706cb86db22122b6a586a4149673faa499da44fb /man
parentRemove leftover backslash (diff)
downloadblind-ebe2e88b44f46e59bdefef1eb585078d5fa6d4d4.tar.gz
blind-ebe2e88b44f46e59bdefef1eb585078d5fa6d4d4.tar.bz2
blind-ebe2e88b44f46e59bdefef1eb585078d5fa6d4d4.tar.xz
Add blind-apply-kernel
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man')
-rw-r--r--man/blind-apply-kernel.169
-rw-r--r--man/blind-gauss-blur.14
-rw-r--r--man/blind.76
3 files changed, 78 insertions, 1 deletions
diff --git a/man/blind-apply-kernel.1 b/man/blind-apply-kernel.1
new file mode 100644
index 0000000..f09cc6e
--- /dev/null
+++ b/man/blind-apply-kernel.1
@@ -0,0 +1,69 @@
+.TH BLIND-APPLY-KERNEL 1 blind
+.SH NAME
+blind-apply-kernel - Apply a convolution matrix to a video
+.SH SYNOPSIS
+.B blind-apply-kernel
+[-apPxy]
+.I kernel-stream
+.SH DESCRIPTION
+.B blind-apply-kernel
+reads a video from stdin and a convolution matrix video
+from
+.I kernel-stream
+and apply the convolution matrix in each frame the
+same frame in stdin, and prints the resulting video
+to stdout.
+.SH OPTIONS
+.TP
+.B -a
+Used to optimise performance if it is known that
+the video is opaque, and to ensure that the output
+video is opaque.
+.TP
+.B -p
+Each frame in
+.I kernel-stream
+shall contain one matrix per pixel in a frame in
+stdin. The width of
+.I kernel-stream
+shall be a multiple of the width of stdin, the width
+shall be the width of stdin multiplied by the width
+of the convolution matrix. The height of
+.I kernel-stream
+shall be a multiple of the height of stdin, the
+height shall be the height of stdin multiplied by the
+height of the convolution matrix.
+.TP
+.B -P
+Apply the convolution with first premultiplying
+the alpha channel.
+.TP
+.B -x
+When encountering the left or right edge of the video,
+wrap around to the opposite edge.
+.TP
+.B -y
+When encountering the upper or lower edge of the video,
+wrap around to the opposite edge.
+.SH REQUIREMENTS
+.B blind-apply-kernel
+requires enough free memory to load two full frames
+from stdin and one full frame from
+.I kernel-stream
+into memory. However, if
+.I -p
+is used, the height of
+.I kernel-stream
+divide by the height of stdin number of rows from
+.I kernel-stream
+rather than a full frame from
+.I kernel-stream
+is loaded into memory.
+A frame or row requires 32 bytes per pixel it contains.
+.SH SEE ALSO
+.BR blind (7),
+.BR blind-make-kernel (1),
+.BR blind-gauss-blur (1)
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >
diff --git a/man/blind-gauss-blur.1 b/man/blind-gauss-blur.1
index 652a5e5..e0e84a9 100644
--- a/man/blind-gauss-blur.1
+++ b/man/blind-gauss-blur.1
@@ -79,7 +79,9 @@ memory. A frame requires 32 bytes per pixel it contains.
.SH SEE ALSO
.BR blind (7),
.BR blind-single-colour (1),
-.BR blind-time-blur (1)
+.BR blind-time-blur (1),
+.BR blind-make-kernel (1),
+.BR blind-apply-kernel (1)
.SH AUTHORS
Mattias Andrée
.RI < maandree@kth.se >
diff --git a/man/blind.7 b/man/blind.7
index 1e61ee3..b6ce62d 100644
--- a/man/blind.7
+++ b/man/blind.7
@@ -22,6 +22,12 @@ first convert it with
.BR blind-affine-colour (1)
Apply an affine transformation to the colours in a video
.TP
+.BR blind-apply-kernel (1)
+Apply a convolution matrix to a video
+.TP
+.BR blind-apply-palette (1)
+Apply a colour palette to a video
+.TP
.BR blind-arithm (1)
Perform simple arithmetic on a video
.TP