commit e17f1326d3a358e280579716c3dfc83dd5337f3c
parent 82a1b9b836a16af7354784d3a53fd034dd81a172
Author: Mattias Andrée <maandree@kth.se>
Date: Sun, 22 Jan 2017 16:20:44 +0100
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat:
3 files changed, 134 insertions(+), 1 deletion(-)
diff --git a/man/blind-from-video.1 b/man/blind-from-video.1
@@ -0,0 +1,79 @@
+.TH BLIND-FROM-VIDEO 1 blind
+.SH NAME
+blind-from-video - Converts a regular, cooked video to a blind video
+.SH SYNOPSIS
+.B blind-from-video
+[-r
+.IR frame-rate ]
+[-w
+.I width
+-h
+.IR height ]
+[-dL]
+.I input-file
+.I output-file
+.SH DESCRIPTION
+.B blind-from-video
+converts the video, in the file
+.IR input-file ,
+to a format usable by the
+.B blind
+tools, and prints the new video to the file
+.IR output-file .
+.I input-file
+and, unless -L is used,
+.I output-file
+must be regular files.
+.I input-file
+must be a normal video file with a container (i.e. not raw video)
+that is supported by
+.BR ffmpeg (1).
+It is unspecified what happens if
+.I input-file
+does not have exactly one video stream. All non-video streams,
+such as audio and subtitles are discarded.
+.SH OPTIONS
+.TP
+.B -d
+Perform coarse colour-model conversion. This will increase the
+performance of the conversion, but modifications to the colours
+will not produce the expected colours. This is useful for
+drafting or if you will not modify the colours. If you use this
+flag, you should also use it in
+.BR blind-to-video (1),
+otherwise the colours will be modified.
+.TP
+.BR -h " "\fIheight\fP
+Change the height of the video to
+.IR height .
+.TP
+.B -L
+Write to stdout that the number of frames in the video is 0.
+This allows you to use a non-regular file, including a pipe, as
+.IR output-file .
+If you specify
+.RB ' - '
+as the
+.IR output-file ,
+the video is printed to stdout.
+
+This option is useful if you want to split a video, into
+multiple videos, as it allows to to split the video without
+having to store the entire raw video to disc.
+
+If you use this option, you can use
+.BR blind-split (1)
+to write the actual number of frames to the head, if this
+is needed.
+.TP
+.BR -r " "\fIframe-rate\fP
+Change the frame rate of the video to
+.IR frame-rate .
+This value can be a rational.
+.TP
+.BR -w " "\fIwidth\fP
+Change the width of the video to
+.IR width .
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >
diff --git a/man/blind-next-frame.1 b/man/blind-next-frame.1
@@ -30,7 +30,7 @@ with <space> in between.
.SH EXIT STATUS
.TP
0
-The process was successful.
+Successful completion.
.TP
1
End of file reached, no more frames available.
diff --git a/man/blind-to-video.1 b/man/blind-to-video.1
@@ -0,0 +1,54 @@
+.TH BLIND-TO-VIDEO 1 blind
+.SH NAME
+blind-to-video - Converts blind video to a regular video
+.SH SYNOPSIS
+.B blind-to-video
+[-d]
+.I frame-rate
+.IR ffmpeg-arguments " ..."
+.SH DESCRIPTION
+.B blind-to-video
+reads a
+.B blind
+video from stdin and uses
+.BR ffmpeg (1)
+to convert it to a normal video format.
+.I frame-rate
+must be set to the frame-rate of the input video,
+lest the tempo in the output video be modified. You
+can use
+.BR ffprobe (1)
+(an
+.B ffmpeg
+utility) on your original video to find out the frame rate:
+
+.nf
+ ffprobe -v quiet -show_streams -select_streams v -- your-video.mkv |
+ grep '^r_frame_rate=' | cut -d = -f 2-
+.fi
+
+This value will be a rational value, which is supported.
+All argumnets after
+.I frame-rate
+(that is
+.IR ffmpeg-arguments " ...)"
+are arguments that will be passed to
+.BR ffmpeg (1)
+after the arguments that
+.B blind-to-video
+will create that specifies the input file and necessary metadata
+such as frame rate, geometry, and format, of the input video.
+Beginners are recommended to use
+.B -c:v libx264 -preset veryslow -crf 0 -pix_fmt yuv444p --
+.IR output-file .
+.SH OPTIONS
+.TP
+.B -d
+Perform coarse colour-model conversion. This will increase the
+performance of the conversion, however, it the colours will
+not look correct, unless the -d flag was also with
+.BR blind-from-video (1)
+and not colours have been modified between to the processes.
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >
