From 6fc3f383845b564d1f0e28b7c63196ec7a3fd770 Mon Sep 17 00:00:00 2001
From: Ilari Liusvaara <ilari.liusvaara@elisanet.fi>
Date: Tue, 28 Sep 2010 14:55:06 +0300
Subject: [PATCH] Update the streamtools manual

---
 streamtools/manual.lyx | 104 +++++++++++++++++++++++++-
 streamtools/manual.txt | 194 +++++++++++++++++++++++++++++++------------------
 2 files changed, 225 insertions(+), 73 deletions(-)

diff --git a/streamtools/manual.lyx b/streamtools/manual.lyx
index 805d86e..1fd88b4 100644
--- a/streamtools/manual.lyx
+++ b/streamtools/manual.lyx
@@ -36,6 +36,7 @@
 \tracking_changes false
 \output_changes false
 \author "" 
+\author "" 
 \end_header
 
 \begin_body
@@ -54,6 +55,59 @@ Concatenation of dump files is concatenation of their contents.
 \end_layout
 
 \begin_layout Section
+Brief description of tools
+\end_layout
+
+\begin_layout Itemize
+audiotodump.exe - Convert raw PCM audio to dump file.
+\end_layout
+
+\begin_layout Itemize
+cutdump.exe - Save section of dump file to another.
+\end_layout
+
+\begin_layout Itemize
+demuxdump.exe - Save stream from dump file to another.
+\end_layout
+
+\begin_layout Itemize
+dumpconvert.exe - Convert dump files to variety of formats.
+\end_layout
+
+\begin_layout Itemize
+dumppackets.exe - Dump contents of dump in textual form (meant for debugging).
+\end_layout
+
+\begin_layout Itemize
+fmtopcm.exe - Convert individual FM-type stream into PCM-type stream.
+\end_layout
+
+\begin_layout Itemize
+guessresolution.exe - Try to guess resolution of video.
+\end_layout
+
+\begin_layout Itemize
+mknulldump.exe - Make empty dump of specified length.
+\end_layout
+
+\begin_layout Itemize
+muxdump.exe - Mux streams from multiple dumps together.
+\end_layout
+
+\begin_layout Itemize
+picturestodump.exe - Make dump with specified image or animation.
+\end_layout
+
+\begin_layout Itemize
+playdump.exe - Play dump in realtime.
+\end_layout
+
+\begin_layout Itemize
+testresizer.exe - Test various resizer algorithms on still image (meant for
+ debugging).
+\end_layout
+
+\begin_layout Section
 audiotodump.exe
 \end_layout
 
@@ -211,7 +265,7 @@ syntax: demuxdump.exe <input> <stream> <output>
 \end_layout
 
 \begin_layout Standard
-Cuts stream <stream> from dump <input> and saves it to <output>.
+Copies stream <stream> from dump <input> and saves it to <output>.
 \end_layout
 
 \begin_layout Section
@@ -280,12 +334,21 @@ Set video scaling algorithm to <algo>.
 \end_layout
 
 \begin_layout Itemize
+'bilinear' (bilinear interpolation)
+\end_layout
+
+\begin_layout Itemize
 'average' (weighted average of covered pixels)
 \end_layout
 
 \begin_layout Itemize
 'lanczos1', 'lanczos2', 'lanczos3', 'lanczos4', 'lanczos5' (higher-quality
- resizeers).
+ resizeers)
+\end_layout
+
+\begin_layout Itemize
+'hqx2', 'hqx3', 'hqx4', 'hqx22', 'hqx32', 'hqx42', 'hqx2d', 'hqx3d', 'hqx4d'
+ (HQx resizers; requires compile with HQx support).
 \end_layout
 
 \begin_layout Subsubsection
@@ -467,6 +530,20 @@ Pipe video to x264 in order to encode h.264 to <filename>.
 BUG: Framerate is not set correctly automatically.
 \end_layout
 
+\begin_layout Subsubsection
+faac
+\end_layout
+
+\begin_layout LyX-Code
+syntax: --output-faac=<filename>[,<option>[,<option>[...]]]
+\end_layout
+
+\begin_layout Standard
+Pipe audio to faac in order to encode AAC to <filename>.
+ Interesting options include 'q=<quality>' (set quality), 'c=<freq>' (force
+ bandwidth, default is autodetect).
+\end_layout
+
 \begin_layout Section
 dumppackets.exe
 \end_layout
@@ -597,6 +674,25 @@ Play concatenation of <files>...
 \end_layout
 
 \begin_layout Section
+testresizer.exe
+\end_layout
+
+\begin_layout Standard
+Resize image and show result.
+ This is mainly intended for debugging resizers.
+\end_layout
+
+\begin_layout LyX-Code
+syntax: testresizer.exe <image> <algo> <width> <height>
+\end_layout
+
+\begin_layout Standard
+Read <image> and resize it to <width> by <height> using algorithm <algo>
+ (see dumpconvert.exe option --video-scale-algo for possible algorithms).
+ Then display the result on screen.
+\end_layout
+
+\begin_layout Section
 Audio processing options
 \end_layout
 
@@ -1029,7 +1125,7 @@ Save all settings to settings stack.
 \end_layout
 
 \begin_layout Subsection
-push
+pop
 \end_layout
 
 \begin_layout LyX-Code
@@ -1041,7 +1137,7 @@ Syntax (script): pop
 \end_layout
 
 \begin_layout Standard
-Pop all settings to settings stack and apply them.
+Pop all settings from settings stack and apply them.
 \end_layout
 
 \begin_layout Subsection
diff --git a/streamtools/manual.txt b/streamtools/manual.txt
index 918e984..b0b716a 100644
--- a/streamtools/manual.txt
+++ b/streamtools/manual.txt
@@ -5,7 +5,37 @@ Dumping processing tools manual
 Concatenation of dump files is concatenation of their contents. 
 So cat and similar tools can be used to concatenate dumps.
 
-2 audiotodump.exe
+2 Brief description of tools
+
+• audiotodump.exe - Convert raw PCM audio to dump file.
+
+• cutdump.exe - Save section of dump file to another.
+
+• demuxdump.exe - Save stream from dump file to another.
+
+• dumpconvert.exe - Convert dump files to variety of formats.
+
+• dumppackets.exe - Dump contents of dump in textual form (meant 
+  for debugging).
+
+• fmtopcm.exe - Convert individual FM-type stream into PCM-type 
+  stream.
+
+• guessresolution.exe - Try to guess resolution of video.
+
+• mknulldump.exe - Make empty dump of specified length.
+
+• muxdump.exe - Mux streams from multiple dumps together.
+
+• picturestodump.exe - Make dump with specified image or 
+  animation.
+
+• playdump.exe - Play dump in realtime.
+
+• testresizer.exe - Test various resizer algorithms on still 
+  image (meant for debugging).
+
+3 audiotodump.exe
 
 Converts raw PCM audio to dump file containing said audio as PCM 
 audio track.
@@ -15,62 +45,62 @@ Syntax: audiotodump.exe <options> <input> <stream> <output>
 Convert raw PCM audio from file <input> to dump named <output>. 
 The audio data is placed as PCM-type stream named <stream>.
 
-2.1 Options
+3.1 Options
 
-2.1.1 --8bit
+3.1.1 --8bit
 
 Assume that samples in file are 8 bits per channel.
 
-2.1.2 --16bit
+3.1.2 --16bit
 
 See --16bit-little-endian
 
-2.1.3 --16bit-little-endian
+3.1.3 --16bit-little-endian
 
 Assume that sample in file are 16 bits per channel and 
 little-endian. This is the default.
 
-2.1.4 --16bit-big-endian
+3.1.4 --16bit-big-endian
 
 Assume that sample in file are 16 bits per channel and 
 big-endian.
 
-2.1.5 --mono
+3.1.5 --mono
 
 Assume that samples in file have only one channel.
 
-2.1.6 --stereo
+3.1.6 --stereo
 
 Assume that samples in file have two channels in order left, 
 right, left, right,... This is the default.
 
-2.1.7 --stereo-swapped
+3.1.7 --stereo-swapped
 
 Assume that samples in file have two channels in order right, 
 left, right, left...
 
-2.1.8 --signed
+3.1.8 --signed
 
 Assume that samples in file are signed. This is the default.
 
-2.1.9 --unsigned
+3.1.9 --unsigned
 
 Assume that samples in file are unsigned.
 
-2.1.10 --rate=<rate>
+3.1.10 --rate=<rate>
 
 Assume that sampling rate in input file is <rate> Hz.
 
-2.1.11 --volume=<left>,<right>
+3.1.11 --volume=<left>,<right>
 
 Write initial volume <left> for left channel and <right> for 
 right channel to output.
 
-2.1.12 --volume=<volume>
+3.1.12 --volume=<volume>
 
 Write initial volume <volume> for both channels to output.
 
-3 cutdump.exe
+4 cutdump.exe
 
 Copies section out of the dump.
 
@@ -83,15 +113,16 @@ Cuts section <start> to <end> from dump <input> and saves it to
 contain '.'. Otherwise these are assumed to be in seconds. So for 
 example both 100000000 and 0.1 signifies 0.1s point.
 
-4 demuxdump.exe
+5 demuxdump.exe
 
 Copies stream out of the dump.
 
 syntax: demuxdump.exe <input> <stream> <output>
 
-Cuts stream <stream> from dump <input> and saves it to <output>.
+Copies stream <stream> from dump <input> and saves it to 
+<output>.
 
-5 dumpconvert.exe
+6 dumpconvert.exe
 
 The main dump to other formats converter.
 
@@ -102,63 +133,69 @@ Convert <files>... into other formats. Note that this tool takes
 subtitle and audio options (and that they are shared with 
 playdump.exe).
 
-5.1 Options
+6.1 Options
 
-5.1.1 --video-width=<width>
+6.1.1 --video-width=<width>
 
 Set video output width to <width>. No default, must be specified.
 
-5.1.2 --video-height=<height>
+6.1.2 --video-height=<height>
 
 Set video output height to <height>. No default, must be 
 specified.
 
-5.1.3 --video-framerate=<fps>
+6.1.3 --video-framerate=<fps>
 
 Set video output fps to <fps>. <fps> can also be 'auto' to allow 
 variable-framerate output. Default is fixed 60fps.
 
-5.1.4 --video-scale-algo=<algo>
+6.1.4 --video-scale-algo=<algo>
 
 Set video scaling algorithm to <algo>. Currently following 
 algorithms are available:
 
 • 'nearest' (nearest neighbor)
 
+• 'bilinear' (bilinear interpolation)
+
 • 'average' (weighted average of covered pixels)
 
 • 'lanczos1', 'lanczos2', 'lanczos3', 'lanczos4', 'lanczos5' 
-  (higher-quality resizeers).
+  (higher-quality resizeers)
 
-5.1.5 --video-scale-algo=”<algo> <width> <height>”
+• 'hqx2', 'hqx3', 'hqx4', 'hqx22', 'hqx32', 'hqx42', 'hqx2d', 
+  'hqx3d', 'hqx4d' (HQx resizers; requires compile with HQx 
+  support).
+
+6.1.5 --video-scale-algo=”<algo> <width> <height>”
 
 Set video scaling algorithm to <algo> for frames that are <width> 
 by <height> (i.e. set special scaler for specific resolution).
 
-5.1.6 --video-max-dedup=<dedup>
+6.1.6 --video-max-dedup=<dedup>
 
 Allow up to <dedup> consequtive frames to be elided if they are 
 indentical to previous (truly identical, not just “identical”). 
 Requires variable framerate output.
 
-5.1.7 --audio-delay=<delay>
+6.1.7 --audio-delay=<delay>
 
 Delay audio by <delay> nanoseconds/seconds (seconds if <delay> 
 has '.', nanoseconds otherwise). Delay may be negative.
 
-5.1.8 --subtitle-delay=<delay>
+6.1.8 --subtitle-delay=<delay>
 
 Delay subtitles by <delay> nanoseconds/seconds (seconds if 
 <delay> has '.', nanoseconds otherwise). Delay may be negative.
 
-5.1.9 --output-<format>=<filename>[,<parameters>]
+6.1.9 --output-<format>=<filename>[,<parameters>]
 
 Output to <filename> in format <format>. <parameters> is 
 format-dependent parameters.
 
-5.2 Output formats
+6.2 Output formats
 
-5.2.1 oggenc
+6.2.1 oggenc
 
 syntax: 
 --output-oggenc=<filename>[,<oggenc-option>[,<oggenc-option[...]]]
@@ -169,47 +206,47 @@ correctly. For oggenc options in form --foo=bar, use foo=bar as
 <oggenc-option>. For oggenc options of form --baz, use baz as 
 <oggenc-option>
 
-5.2.2 rawaudio
+6.2.2 rawaudio
 
 syntax: --output-rawaudio=<filename>
 
 Write 16-bit stereo little-endian signed audio track in raw 
 format to <filename>.
 
-5.2.3 rawi420
+6.2.3 rawi420
 
 syntax: --output-rawi420=<filename>
 
 Write video in raw I420 format to <filename>
 
-5.2.4 rawi420-uvswap
+6.2.4 rawi420-uvswap
 
 syntax: --output-rawi420-uvswap=<filename>
 
 Write video in raw I420 format to <filename>. Red and blue are 
 swapped.
 
-5.2.5 rawrgbx
+6.2.5 rawrgbx
 
 syntax: --output-rawrgbx=<filename>
 
 Write video in raw RGBx format to <filename>.
 
-5.2.6 timecodev2
+6.2.6 timecodev2
 
 syntax: --output-timecodev2=<filename>
 
 Write video timestamp data in v2 format to <filename>. Very 
 useful for automatic-/variable-fps encoding.
 
-5.2.7 wav
+6.2.7 wav
 
 syntax: --output-wav=<filename>
 
 Write audio in wav form to <filename>. Note that files with over 
 1 billion samples are not written properly.
 
-5.2.8 x264
+6.2.8 x264
 
 syntax: 
 --output-x264=<filename>[,<x264-option>[,<x264-option[...]]]
@@ -221,7 +258,15 @@ of form --baz, use baz as <x264-option>.
 
 BUG: Framerate is not set correctly automatically.
 
-6 dumppackets.exe
+6.2.9 faac
+
+syntax: --output-faac=<filename>[,<option>[,<option>[...]]]
+
+Pipe audio to faac in order to encode AAC to <filename>. 
+Interesting options include 'q=<quality>' (set quality), 
+'c=<freq>' (force bandwidth, default is autodetect).
+
+7 dumppackets.exe
 
 Dump the stream in textual format (useful for debugging):
 
@@ -229,7 +274,7 @@ syntax: dumppackets.exe <file>
 
 Dumps the data in <file> in textual form.
 
-7 fmtopcm.exe
+8 fmtopcm.exe
 
 Convert given stream from FM format to PCM format (this is mainly 
 useful for dumps somehow containing multiple FM streams).
@@ -240,7 +285,7 @@ Reads dump from <input> and converts FM output on stream <stream>
 into PCM output at sampling rate <rate>. The output (all other 
 streams plus converted stream) is written to <output>.
 
-8 guessresolution.exe
+9 guessresolution.exe
 
 Try to guess proper encoding resolution from dump.
 
@@ -249,7 +294,7 @@ sytax: guessresolution.exe <files>...
 Read given files <files>... and try to guess the proper 
 resolution.
 
-9 mknulldump.exe
+10 mknulldump.exe
 
 Make empty clip of specified length.
 
@@ -258,7 +303,7 @@ syntax: mknulldump.exe <length> <output>
 Make empty clip of <length> nanoseconds (seconds if <length> 
 contains dot) and write it to <output>.
 
-10 muxdump.exe
+11 muxdump.exe
 
 Mux multiple dumps into one.
 
@@ -267,7 +312,7 @@ syntax: muxdump.exe <input>... <output>
 Read dump files <input>... and combine streams, writing result to 
 <output>.
 
-11 picturestodump.exe
+12 picturestodump.exe
 
 Transform set of pictures into dump.
 
@@ -276,7 +321,7 @@ syntax: picturestodump.exe [--fps=<fps>] <input>... <output>
 Reads pictures from <input>... and writes dump at <fps> (defaults 
 to 60 if not specified) to <output> containing those pictures.
 
-12 playdump.exe
+13 playdump.exe
 
 Play dump in realtime.
 
@@ -290,7 +335,18 @@ Play concatenation of <files>... at <percent>% realtime speed
 44100Hz). Note that this command accepts audio and subtitle 
 options.
 
-13 Audio processing options
+14 testresizer.exe
+
+Resize image and show result. This is mainly intended for 
+debugging resizers.
+
+syntax: testresizer.exe <image> <algo> <width> <height>
+
+Read <image> and resize it to <width> by <height> using algorithm 
+<algo> (see dumpconvert.exe option --video-scale-algo for 
+possible algorithms). Then display the result on screen.
+
+15 Audio processing options
 
 Audio processing has three stages:
 
@@ -305,30 +361,30 @@ command line. If <stream> is specified for some operation, it
 occurs as part of premix filtering for that stream. Otherwise it 
 occurs as postmix filtering.
 
-13.1 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...
+15.1 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...
 
 Perform FIR filtering using coefficients <a0>, <a1>, ..., given 
 in order of increasing delay.
 
-13.2 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...;<b0>,<b1>,...
+15.2 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...;<b0>,<b1>,...
 
 Perform IIR filtering using input coefficents <a0>, <a1>, ..., 
 output coefficients <b0>, <b1>,... given in order of increasing 
 delay.
 
-13.3 --audio-mixer-gain=[<stream>:]<gain>
+15.3 --audio-mixer-gain=[<stream>:]<gain>
 
 Amplify signal by <gain> dB.
 
-13.4 --audio-mixer-attenuate=[<stream>:]<attenuation>
+15.4 --audio-mixer-attenuate=[<stream>:]<attenuation>
 
 Attenuate signal by <attenuation> dB.
 
-13.5 --silence[=<stream>]
+15.5 --silence[=<stream>]
 
 Silence specified stream or entiere sound output.
 
-14 Subtitle processing options
+16 Subtitle processing options
 
 Subtitle option of form foo=bar is given as 
 --video-hardsub-foo=bar on command line and as foo=bar in script 
@@ -337,7 +393,7 @@ file. For option of form baz, the corresponding forms are
 are encountered, script files are processed immediately when 
 script file option is encountered.
 
-14.1 font=<font>
+16.1 font=<font>
 
 Syntax (command line): --video-hardsub-font=<font>
 
@@ -346,7 +402,7 @@ Syntax (script): font=<font>
 Set the font used to <font>. No default, this has to be set 
 before using any font rendering commands.
 
-14.2 size=<size>
+16.2 size=<size>
 
 Syntax (command line): --video-hardsub-size=<size>
 
@@ -354,7 +410,7 @@ Syntax (script): size=<size>
 
 Set the size used to <size>. Default is 16.
 
-14.3 xpos=<xpos>
+16.3 xpos=<xpos>
 
 Syntax (command line): --video-hardsub-xpos=<xpos>
 
@@ -363,7 +419,7 @@ Syntax (script): xpos=<xpos>
 Set the x offset to <xpos> pixels. There are also special offsets 
 left, center and right. Default is center.
 
-14.4 ypos=<ypos>
+16.4 ypos=<ypos>
 
 Syntax (command line): --video-hardsub-ypos=<ypos>
 
@@ -372,7 +428,7 @@ Syntax (script): ypos=<ypos>
 Set the y offset to <ypos> pixels. There are also special offsets 
 top, center and bottom. Default is bottom.
 
-14.5 duration=<duration>
+16.5 duration=<duration>
 
 Syntax (command line): --video-hardsub-duration=<duration>
 
@@ -381,7 +437,7 @@ Syntax (script): duration=<duration>
 Set the duration to <duration> (nano)seconds (seconds being 
 selected if <duration> has '.'). Default is 5.0 (5 seconds).
 
-14.6 halo=<thickness>
+16.6 halo=<thickness>
 
 Syntax (command line): --video-hardsub-halo=<thickness>
 
@@ -390,7 +446,7 @@ Syntax (script): halo=<thickness>
 Set the halo thickness to <thickness> pixels. 0 disables halo. 
 Default is 0.
 
-14.7 textalign=<align>
+16.7 textalign=<align>
 
 Syntax (command line): --video-hardsub-textalign=<align>
 
@@ -399,7 +455,7 @@ Syntax (script): textalign=<align>
 Set the between-lines text alignment to <align>. Valid alignments 
 are left, center and right. Default is center.
 
-14.8 spacing=<amount>
+16.8 spacing=<amount>
 
 Syntax (command line): --video-hardsub-spacing=<amount>
 
@@ -408,13 +464,13 @@ Syntax (script): spacing=<amount>
 Set the between-lines text spacing to <amount> pixels. Default is 
 0.
 
-14.9 script=<file>
+16.9 script=<file>
 
 Syntax (command line): --video-hardsub-script=<file>
 
 Read file <file> and execute it as subtitle commands.
 
-14.10 text=<timestamp>,<text>
+16.10 text=<timestamp>,<text>
 
 Syntax (command line): --video-hardsub-text=<timestamp>,<text>
 
@@ -436,7 +492,7 @@ on presence of '.'). The following sequences are special in
 
 • '\R': Movie rerecord count from runinfo.
 
-14.11 background-color=<color>
+16.11 background-color=<color>
 
 Syntax (command line): --video-hardsub-background-color=<color>
 
@@ -458,7 +514,7 @@ specifications are allowed:
 
 Default is fully transparent.
 
-14.12 foreground-color=<color>
+16.12 foreground-color=<color>
 
 Syntax (command line): --video-hardsub-foreground-color=<color>
 
@@ -483,7 +539,7 @@ specifications are allowed:
 
 Default is fully opaque white.
 
-14.13 halo-color=<color>
+16.13 halo-color=<color>
 
 Syntax (command line): --video-hardsub-halo-color=<color>
 
@@ -508,7 +564,7 @@ are allowed:
 
 Default is fully opaque black.
 
-14.14 push
+16.14 push
 
 Syntax (command line): --video-hardsub-push
 
@@ -516,15 +572,15 @@ Syntax (script): push
 
 Save all settings to settings stack.
 
-14.15 push
+16.15 pop
 
 Syntax (command line): --video-hardsub-pop
 
 Syntax (script): pop
 
-Pop all settings to settings stack and apply them.
+Pop all settings from settings stack and apply them.
 
-14.16 reset
+16.16 reset
 
 Syntax (command line): --video-hardsub-reset
 
-- 
2.11.4.GIT