1 #LyX 1.6.7 created this file. For more info see http://www.lyx.org/
6 \use_default_options true
11 \font_typewriter default
12 \font_default_family default
19 \paperfontsize default
27 \paperorientation portrait
30 \paragraph_separation indent
32 \quotes_language english
35 \paperpagestyle default
36 \tracking_changes false
44 Dumping processing tools manual
51 \begin_layout Standard
52 Concatenation of dump files is concatenation of their contents.
53 So cat and similar tools can be used to concatenate dumps.
60 \begin_layout Standard
61 Converts raw PCM audio to dump file containing said audio as PCM audio track.
64 \begin_layout LyX-Code
65 Syntax: audiotodump.exe <options> <input> <stream> <output>
68 \begin_layout Standard
69 Convert raw PCM audio from file <input> to dump named <output>.
70 The audio data is placed as PCM-type stream named <stream>.
73 \begin_layout Subsection
77 \begin_layout Subsubsection
81 \begin_layout Standard
82 Assume that samples in file are 8 bits per channel.
85 \begin_layout Subsubsection
89 \begin_layout Standard
90 See --16bit-little-endian
93 \begin_layout Subsubsection
97 \begin_layout Standard
98 Assume that sample in file are 16 bits per channel and little-endian.
102 \begin_layout Subsubsection
106 \begin_layout Standard
107 Assume that sample in file are 16 bits per channel and big-endian.
110 \begin_layout Subsubsection
114 \begin_layout Standard
115 Assume that samples in file have only one channel.
118 \begin_layout Subsubsection
122 \begin_layout Standard
123 Assume that samples in file have two channels in order left, right, left,
128 \begin_layout Subsubsection
132 \begin_layout Standard
133 Assume that samples in file have two channels in order right, left, right,
137 \begin_layout Subsubsection
141 \begin_layout Standard
142 Assume that samples in file are signed.
146 \begin_layout Subsubsection
150 \begin_layout Standard
151 Assume that samples in file are unsigned.
154 \begin_layout Subsubsection
158 \begin_layout Standard
159 Assume that sampling rate in input file is <rate> Hz.
162 \begin_layout Subsubsection
163 --volume=<left>,<right>
166 \begin_layout Standard
167 Write initial volume <left> for left channel and <right> for right channel
171 \begin_layout Subsubsection
175 \begin_layout Standard
176 Write initial volume <volume> for both channels to output.
179 \begin_layout Section
183 \begin_layout Standard
184 Copies section out of the dump.
187 \begin_layout LyX-Code
188 syntax: cutdump.exe <input> <start> <end> <output>
191 \begin_layout Standard
192 Cuts section <start> to <end> from dump <input> and saves it to <output>.
195 \begin_layout Standard
196 <start> and <end> are specified in nanoseconds if these don't contain '.'.
197 Otherwise these are assumed to be in seconds.
198 So for example both 100000000 and 0.1 signifies 0.1s point.
201 \begin_layout Section
205 \begin_layout Standard
206 Copies stream out of the dump.
209 \begin_layout LyX-Code
210 syntax: demuxdump.exe <input> <stream> <output>
213 \begin_layout Standard
214 Cuts stream <stream> from dump <input> and saves it to <output>.
217 \begin_layout Section
221 \begin_layout Standard
222 The main dump to other formats converter.
225 \begin_layout LyX-Code
226 syntax: dumpconvert.exe <options> [<subtitle options>...] [<audio options>...]
230 \begin_layout Standard
233 Note that this tool takes subtitle and audio options (and that they are
234 shared with playdump.exe).
237 \begin_layout Subsection
241 \begin_layout Subsubsection
242 --video-width=<width>
245 \begin_layout Standard
246 Set video output width to <width>.
247 No default, must be specified.
250 \begin_layout Subsubsection
251 --video-height=<height>
254 \begin_layout Standard
255 Set video output height to <height>.
256 No default, must be specified.
259 \begin_layout Subsubsection
260 --video-framerate=<fps>
263 \begin_layout Standard
264 Set video output fps to <fps>.
265 <fps> can also be 'auto' to allow variable-framerate output.
266 Default is fixed 60fps.
269 \begin_layout Subsubsection
270 --video-scale-algo=<algo>
273 \begin_layout Standard
274 Set video scaling algorithm to <algo>.
275 Currently following algorithms are available:
278 \begin_layout Itemize
279 'nearest' (nearest neighbor)
282 \begin_layout Itemize
283 'average' (weighted average of covered pixels)
286 \begin_layout Itemize
287 'lanczos1', 'lanczos2', 'lanczos3', 'lanczos4', 'lanczos5' (higher-quality
291 \begin_layout Subsubsection
293 \begin_inset Quotes erd
296 <algo> <width> <height>
297 \begin_inset Quotes erd
303 \begin_layout Standard
304 Set video scaling algorithm to <algo> for frames that are <width> by <height>
306 set special scaler for specific resolution).
309 \begin_layout Subsubsection
310 --video-max-dedup=<dedup>
313 \begin_layout Standard
314 Allow up to <dedup> consequtive frames to be elided if they are indentical
315 to previous (truly identical, not just
316 \begin_inset Quotes eld
320 \begin_inset Quotes erd
324 Requires variable framerate output.
327 \begin_layout Subsubsection
328 --audio-delay=<delay>
331 \begin_layout Standard
332 Delay audio by <delay> nanoseconds/seconds (seconds if <delay> has '.', nanosecon
334 Delay may be negative.
337 \begin_layout Subsubsection
338 --subtitle-delay=<delay>
341 \begin_layout Standard
342 Delay subtitles by <delay> nanoseconds/seconds (seconds if <delay> has '.',
343 nanoseconds otherwise).
344 Delay may be negative.
347 \begin_layout Subsubsection
348 --output-<format>=<filename>[,<parameters>]
351 \begin_layout Standard
352 Output to <filename> in format <format>.
353 <parameters> is format-dependent parameters.
356 \begin_layout Subsection
360 \begin_layout Subsubsection
364 \begin_layout LyX-Code
365 syntax: --output-oggenc=<filename>[,<oggenc-option>[,<oggenc-option[...]]]
368 \begin_layout Standard
369 Pipe audio to oggenc in order to encode OGG Vorbis to <filename>.
370 Note that audio bitrate and format is automatically set correctly.
371 For oggenc options in form --foo=bar, use foo=bar as <oggenc-option>.
372 For oggenc options of form --baz, use baz as <oggenc-option>
375 \begin_layout Subsubsection
379 \begin_layout LyX-Code
380 syntax: --output-rawaudio=<filename>
383 \begin_layout Standard
384 Write 16-bit stereo little-endian signed audio track in raw format to <filename>.
387 \begin_layout Subsubsection
391 \begin_layout LyX-Code
392 syntax: --output-rawi420=<filename>
395 \begin_layout Standard
396 Write video in raw I420 format to <filename>
399 \begin_layout Subsubsection
403 \begin_layout LyX-Code
404 syntax: --output-rawi420-uvswap=<filename>
407 \begin_layout Standard
408 Write video in raw I420 format to <filename>.
409 Red and blue are swapped.
412 \begin_layout Subsubsection
416 \begin_layout LyX-Code
417 syntax: --output-rawrgbx=<filename>
420 \begin_layout Standard
421 Write video in raw RGBx format to <filename>.
424 \begin_layout Subsubsection
428 \begin_layout LyX-Code
429 syntax: --output-timecodev2=<filename>
432 \begin_layout Standard
433 Write video timestamp data in v2 format to <filename>.
434 Very useful for automatic-/variable-fps encoding.
437 \begin_layout Subsubsection
441 \begin_layout LyX-Code
442 syntax: --output-wav=<filename>
445 \begin_layout Standard
446 Write audio in wav form to <filename>.
447 Note that files with over 1 billion samples are not written properly.
450 \begin_layout Subsubsection
454 \begin_layout LyX-Code
455 syntax: --output-x264=<filename>[,<x264-option>[,<x264-option[...]]]
458 \begin_layout Standard
459 Pipe video to x264 in order to encode h.264 to <filename>.
460 Note that video size is automatically set correctly.
461 For x264 options in form --foo bar, use foo=bar as <x264-option>.
462 For x264 options of form --baz, use baz as <x264-option>.
466 \begin_layout Standard
467 BUG: Framerate is not set correctly automatically.
470 \begin_layout Section
474 \begin_layout Standard
475 Dump the stream in textual format (useful for debugging):
478 \begin_layout LyX-Code
479 syntax: dumppackets.exe <file>
482 \begin_layout Standard
483 Dumps the data in <file> in textual form.
486 \begin_layout Section
490 \begin_layout Standard
491 Convert given stream from FM format to PCM format (this is mainly useful
492 for dumps somehow containing multiple FM streams).
495 \begin_layout LyX-Code
496 syntax: fmtopcm.exe <input> <stream> <rate> <output>
499 \begin_layout Standard
500 Reads dump from <input> and converts FM output on stream <stream> into PCM
501 output at sampling rate <rate>.
502 The output (all other streams plus converted stream) is written to <output>.
505 \begin_layout Section
509 \begin_layout Standard
510 Try to guess proper encoding resolution from dump.
513 \begin_layout LyX-Code
514 sytax: guessresolution.exe <files>...
517 \begin_layout Standard
518 Read given files <files>...
519 and try to guess the proper resolution.
522 \begin_layout Section
526 \begin_layout Standard
527 Make empty clip of specified length.
530 \begin_layout LyX-Code
531 syntax: mknulldump.exe <length> <output>
534 \begin_layout Standard
535 Make empty clip of <length> nanoseconds (seconds if <length> contains dot)
536 and write it to <output>.
539 \begin_layout Section
543 \begin_layout Standard
544 Mux multiple dumps into one.
547 \begin_layout LyX-Code
548 syntax: muxdump.exe <input>...
552 \begin_layout Standard
553 Read dump files <input>...
554 and combine streams, writing result to <output>.
557 \begin_layout Section
561 \begin_layout Standard
562 Transform set of pictures into dump.
565 \begin_layout LyX-Code
566 syntax: picturestodump.exe [--fps=<fps>] <input>...
570 \begin_layout Standard
571 Reads pictures from <input>...
572 and writes dump at <fps> (defaults to 60 if not specified) to <output>
573 containing those pictures.
576 \begin_layout Section
580 \begin_layout Standard
581 Play dump in realtime.
584 \begin_layout LyX-Code
585 syntax: playdump.exe [<subtitle options>...] [<audio options>...] [--audio-rate=<rate>]
588 \begin_layout LyX-Code
589 [--speed=<percent>] <files>...
592 \begin_layout Standard
593 Play concatenation of <files>...
594 at <percent>% realtime speed (default 100%).
595 Use <rate> Hz for audio sampling rate (default 44100Hz).
596 Note that this command accepts audio and subtitle options.
599 \begin_layout Section
600 Audio processing options
603 \begin_layout Standard
604 Audio processing has three stages:
607 \begin_layout Itemize
608 Per-stream premix filtering
611 \begin_layout Itemize
615 \begin_layout Itemize
619 \begin_layout Standard
620 For each, the operations are done in order they are given on command line.
621 If <stream> is specified for some operation, it occurs as part of premix
622 filtering for that stream.
623 Otherwise it occurs as postmix filtering.
626 \begin_layout Subsection
627 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...
630 \begin_layout Standard
631 Perform FIR filtering using coefficients <a0>, <a1>, ..., given in order of
635 \begin_layout Subsection
636 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...;<b0>,<b1>,...
639 \begin_layout Standard
640 Perform IIR filtering using input coefficents <a0>, <a1>, ..., output coefficients
642 given in order of increasing delay.
645 \begin_layout Subsection
646 --audio-mixer-gain=[<stream>:]<gain>
649 \begin_layout Standard
650 Amplify signal by <gain> dB.
653 \begin_layout Subsection
654 --audio-mixer-attenuate=[<stream>:]<attenuation>
657 \begin_layout Standard
658 Attenuate signal by <attenuation> dB.
661 \begin_layout Subsection
665 \begin_layout Standard
666 Silence specified stream or entiere sound output.
669 \begin_layout Section
670 Subtitle processing options
673 \begin_layout Standard
674 Subtitle option of form foo=bar is given as --video-hardsub-foo=bar on command
675 line and as foo=bar in script file.
676 For option of form baz, the corresponding forms are --video-hardsub-baz
678 Options are processed in order they are encountered, script files are processed
679 immediately when script file option is encountered.
682 \begin_layout Subsection
686 \begin_layout LyX-Code
687 Syntax (command line): --video-hardsub-font=<font>
690 \begin_layout LyX-Code
691 Syntax (script): font=<font>
694 \begin_layout Standard
695 Set the font used to <font>.
696 No default, this has to be set before using any font rendering commands.
699 \begin_layout Subsection
703 \begin_layout LyX-Code
704 Syntax (command line): --video-hardsub-size=<size>
707 \begin_layout LyX-Code
708 Syntax (script): size=<size>
711 \begin_layout Standard
712 Set the size used to <size>.
716 \begin_layout Subsection
720 \begin_layout LyX-Code
721 Syntax (command line): --video-hardsub-xpos=<xpos>
724 \begin_layout LyX-Code
725 Syntax (script): xpos=<xpos>
728 \begin_layout Standard
729 Set the x offset to <xpos> pixels.
730 There are also special offsets left, center and right.
734 \begin_layout Subsection
738 \begin_layout LyX-Code
739 Syntax (command line): --video-hardsub-ypos=<ypos>
742 \begin_layout LyX-Code
743 Syntax (script): ypos=<ypos>
746 \begin_layout Standard
747 Set the y offset to <ypos> pixels.
748 There are also special offsets top, center and bottom.
752 \begin_layout Subsection
756 \begin_layout LyX-Code
757 Syntax (command line): --video-hardsub-duration=<duration>
760 \begin_layout LyX-Code
761 Syntax (script): duration=<duration>
764 \begin_layout Standard
765 Set the duration to <duration> (nano)seconds (seconds being selected if
767 Default is 5.0 (5 seconds).
770 \begin_layout Subsection
774 \begin_layout LyX-Code
775 Syntax (command line): --video-hardsub-halo=<thickness>
778 \begin_layout LyX-Code
779 Syntax (script): halo=<thickness>
782 \begin_layout Standard
783 Set the halo thickness to <thickness> pixels.
788 \begin_layout Subsection
792 \begin_layout LyX-Code
793 Syntax (command line): --video-hardsub-textalign=<align>
796 \begin_layout LyX-Code
797 Syntax (script): textalign=<align>
800 \begin_layout Standard
801 Set the between-lines text alignment to <align>.
802 Valid alignments are left, center and right.
806 \begin_layout Subsection
810 \begin_layout LyX-Code
811 Syntax (command line): --video-hardsub-spacing=<amount>
814 \begin_layout LyX-Code
815 Syntax (script): spacing=<amount>
818 \begin_layout Standard
819 Set the between-lines text spacing to <amount> pixels.
823 \begin_layout Subsection
827 \begin_layout LyX-Code
828 Syntax (command line): --video-hardsub-script=<file>
831 \begin_layout Standard
832 Read file <file> and execute it as subtitle commands.
835 \begin_layout Subsection
836 text=<timestamp>,<text>
839 \begin_layout LyX-Code
840 Syntax (command line): --video-hardsub-text=<timestamp>,<text>
843 \begin_layout LyX-Code
844 Syntax (script): text=<timestamp>,<text>
847 \begin_layout Standard
848 Display <text> at <timestamp> (seconds or nanoseconds, depending on presence
850 The following sequences are special in <text>:
853 \begin_layout Itemize
861 \begin_layout Itemize
867 \begin_layout Itemize
870 A': Authors from runinfo
873 \begin_layout Itemize
876 G': Game name from runinfo
879 \begin_layout Itemize
882 L': Movie length from runinfo.
885 \begin_layout Itemize
888 R': Movie rerecord count from runinfo.
891 \begin_layout Subsection
892 background-color=<color>
895 \begin_layout LyX-Code
896 Syntax (command line): --video-hardsub-background-color=<color>
899 \begin_layout LyX-Code
900 Syntax (script): background-color=<color>
903 \begin_layout Standard
904 Set the background color to <color>.
905 Following <color> specifications are allowed:
908 \begin_layout Itemize
909 '<a>': Partially transparent black.
910 <a> of 0 is fully transparent, 255 is fully opaque.
913 \begin_layout Itemize
914 '<rgb>,<a>': Partially transparent gray.
915 <a> of 0 is fully transparent, 255 is fully opaque.
916 <rgb> sets brightness of gray, 0 is black and 255 is white.
919 \begin_layout Itemize
920 '<r>,<g>,<b>,<a>': Partially transparent color.
921 <a> of 0 is fuly transparent, 255 is fully opaque.
922 <r>, <g> and <b> set the color (0-255 for each component).
925 \begin_layout Standard
926 Default is fully transparent.
929 \begin_layout Subsection
930 foreground-color=<color>
933 \begin_layout LyX-Code
934 Syntax (command line): --video-hardsub-foreground-color=<color>
937 \begin_layout LyX-Code
938 Syntax (script): foreground-color=<color>
941 \begin_layout Standard
942 Set the foreground color to <color>.
943 Following <color> specifications are allowed:
946 \begin_layout Itemize
947 '<a>': Partially transparent white.
948 <a> of 0 is fully transparent, 255 is fully opaque.
951 \begin_layout Itemize
952 '<rgb>,<a>': Partially transparent gray.
953 <a> of 0 is fully transparent, 255 is fully opaque.
954 <rgb> sets brightness of gray, 0 is black and 255 is white.
957 \begin_layout Itemize
958 '<r>,<g>,<b>': Fully opaque color.
959 <r>,<g>, <b> set the color (0-255 for each component).
962 \begin_layout Itemize
963 '<r>,<g>,<b>,<a>': Partially transparent color.
964 <a> of 0 is fuly transparent, 255 is fully opaque.
965 <r>, <g> and <b> set the color (0-255 for each component).
968 \begin_layout Standard
969 Default is fully opaque white.
972 \begin_layout Subsection
976 \begin_layout LyX-Code
977 Syntax (command line): --video-hardsub-halo-color=<color>
980 \begin_layout LyX-Code
981 Syntax (script): halo-color=<color>
984 \begin_layout Standard
985 Set the halo color to <color>.
986 Following <color> specifications are allowed:
989 \begin_layout Itemize
990 '<a>': Partially transparent black.
991 <a> of 0 is fully transparent, 255 is fully opaque.
994 \begin_layout Itemize
995 '<rgb>,<a>': Partially transparent gray.
996 <a> of 0 is fully transparent, 255 is fully opaque.
997 <rgb> sets brightness of gray, 0 is black and 255 is white.
1000 \begin_layout Itemize
1001 '<r>,<g>,<b>': Fully opaque color.
1002 <r>,<g>, <b> set the color (0-255 for each component).
1005 \begin_layout Itemize
1006 '<r>,<g>,<b>,<a>': Partially transparent color.
1007 <a> of 0 is fuly transparent, 255 is fully opaque.
1008 <r>, <g> and <b> set the color (0-255 for each component).
1011 \begin_layout Standard
1012 Default is fully opaque black.
1015 \begin_layout Subsection
1019 \begin_layout LyX-Code
1020 Syntax (command line): --video-hardsub-push
1023 \begin_layout LyX-Code
1024 Syntax (script): push
1027 \begin_layout Standard
1028 Save all settings to settings stack.
1031 \begin_layout Subsection
1035 \begin_layout LyX-Code
1036 Syntax (command line): --video-hardsub-pop
1039 \begin_layout LyX-Code
1040 Syntax (script): pop
1043 \begin_layout Standard
1044 Pop all settings to settings stack and apply them.
1047 \begin_layout Subsection
1051 \begin_layout LyX-Code
1052 Syntax (command line): --video-hardsub-reset
1055 \begin_layout LyX-Code
1056 Syntax (script): reset
1059 \begin_layout Standard
1060 Reset all settings that have defaults to defaults (ones that don't are not