streamtools/manual.lyx

   1 #LyX 1.6.7 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 345
   3 \begin_document
   4 \begin_header
   5 \textclass article
   6 \use_default_options true
   7 \language finnish
   8 \inputencoding auto
   9 \font_roman default
  10 \font_sans default
  11 \font_typewriter default
  12 \font_default_family default
  13 \font_sc false
  14 \font_osf false
  15 \font_sf_scale 100
  16 \font_tt_scale 100
  17
  18 \graphics default
  19 \paperfontsize default
  20 \use_hyperref false
  21 \papersize default
  22 \use_geometry false
  23 \use_amsmath 1
  24 \use_esint 1
  25 \cite_engine basic
  26 \use_bibtopic false
  27 \paperorientation portrait
  28 \secnumdepth 3
  29 \tocdepth 3
  30 \paragraph_separation indent
  31 \defskip medskip
  32 \quotes_language english
  33 \papercolumns 1
  34 \papersides 1
  35 \paperpagestyle default
  36 \tracking_changes false
  37 \output_changes false
  38 \author ""
  39 \author ""
  40 \end_header
  41
  42 \begin_body
  43
  44 \begin_layout Title
  45 Dumping processing tools manual
  46 \end_layout
  47
  48 \begin_layout Section
  49 Concatenating dumps
  50 \end_layout
  51
  52 \begin_layout Standard
  53 Concatenation of dump files is concatenation of their contents.
  54  So cat and similar tools can be used to concatenate dumps.
  55 \end_layout
  56
  57 \begin_layout Section
  58 Brief description of tools
  59 \end_layout
  60
  61 \begin_layout Itemize
  62 audiotodump.exe - Convert raw PCM audio to dump file.
  63 \end_layout
  64
  65 \begin_layout Itemize
  66 cutdump.exe - Save section of dump file to another.
  67 \end_layout
  68
  69 \begin_layout Itemize
  70 demuxdump.exe - Save stream from dump file to another.
  71 \end_layout
  72
  73 \begin_layout Itemize
  74 dumpconvert.exe - Convert dump files to variety of formats.
  75 \end_layout
  76
  77 \begin_layout Itemize
  78 dumppackets.exe - Dump contents of dump in textual form (meant for debugging).
  79 \end_layout
  80
  81 \begin_layout Itemize
  82 fmtopcm.exe - Convert individual FM-type stream into PCM-type stream.
  83 \end_layout
  84
  85 \begin_layout Itemize
  86 guessresolution.exe - Try to guess resolution of video.
  87 \end_layout
  88
  89 \begin_layout Itemize
  90 mknulldump.exe - Make empty dump of specified length.
  91 \end_layout
  92
  93 \begin_layout Itemize
  94 muxdump.exe - Mux streams from multiple dumps together.
  95 \end_layout
  96
  97 \begin_layout Itemize
  98 picturestodump.exe - Make dump with specified image or animation.
  99 \end_layout
 100
 101 \begin_layout Itemize
 102 playdump.exe - Play dump in realtime.
 103 \end_layout
 104
 105 \begin_layout Itemize
 106 testresizer.exe - Test various resizer algorithms on still image (meant for
 107  debugging).
 108 \end_layout
 109
 110 \begin_layout Section
 111 audiotodump.exe
 112 \end_layout
 113
 114 \begin_layout Standard
 115 Converts raw PCM audio to dump file containing said audio as PCM audio track.
 116 \end_layout
 117
 118 \begin_layout LyX-Code
 119 Syntax: audiotodump.exe <options> <input> <stream> <output>
 120 \end_layout
 121
 122 \begin_layout Standard
 123 Convert raw PCM audio from file <input> to dump named <output>.
 124  The audio data is placed as PCM-type stream named <stream>.
 125 \end_layout
 126
 127 \begin_layout Subsection
 128 Options
 129 \end_layout
 130
 131 \begin_layout Subsubsection
 132 --8bit
 133 \end_layout
 134
 135 \begin_layout Standard
 136 Assume that samples in file are 8 bits per channel.
 137 \end_layout
 138
 139 \begin_layout Subsubsection
 140 --16bit
 141 \end_layout
 142
 143 \begin_layout Standard
 144 See --16bit-little-endian
 145 \end_layout
 146
 147 \begin_layout Subsubsection
 148 --16bit-little-endian
 149 \end_layout
 150
 151 \begin_layout Standard
 152 Assume that sample in file are 16 bits per channel and little-endian.
 153  This is the default.
 154 \end_layout
 155
 156 \begin_layout Subsubsection
 157 --16bit-big-endian
 158 \end_layout
 159
 160 \begin_layout Standard
 161 Assume that sample in file are 16 bits per channel and big-endian.
 162 \end_layout
 163
 164 \begin_layout Subsubsection
 165 --mono
 166 \end_layout
 167
 168 \begin_layout Standard
 169 Assume that samples in file have only one channel.
 170 \end_layout
 171
 172 \begin_layout Subsubsection
 173 --stereo
 174 \end_layout
 175
 176 \begin_layout Standard
 177 Assume that samples in file have two channels in order left, right, left,
 178  right,...
 179  This is the default.
 180 \end_layout
 181
 182 \begin_layout Subsubsection
 183 --stereo-swapped
 184 \end_layout
 185
 186 \begin_layout Standard
 187 Assume that samples in file have two channels in order right, left, right,
 188  left...
 189 \end_layout
 190
 191 \begin_layout Subsubsection
 192 --signed
 193 \end_layout
 194
 195 \begin_layout Standard
 196 Assume that samples in file are signed.
 197  This is the default.
 198 \end_layout
 199
 200 \begin_layout Subsubsection
 201 --unsigned
 202 \end_layout
 203
 204 \begin_layout Standard
 205 Assume that samples in file are unsigned.
 206 \end_layout
 207
 208 \begin_layout Subsubsection
 209 --rate=<rate>
 210 \end_layout
 211
 212 \begin_layout Standard
 213 Assume that sampling rate in input file is <rate> Hz.
 214 \end_layout
 215
 216 \begin_layout Subsubsection
 217 --volume=<left>,<right>
 218 \end_layout
 219
 220 \begin_layout Standard
 221 Write initial volume <left> for left channel and <right> for right channel
 222  to output.
 223 \end_layout
 224
 225 \begin_layout Subsubsection
 226 --volume=<volume>
 227 \end_layout
 228
 229 \begin_layout Standard
 230 Write initial volume <volume> for both channels to output.
 231 \end_layout
 232
 233 \begin_layout Section
 234 cutdump.exe
 235 \end_layout
 236
 237 \begin_layout Standard
 238 Copies section out of the dump.
 239 \end_layout
 240
 241 \begin_layout LyX-Code
 242 syntax: cutdump.exe <input> <start> <end> <output>
 243 \end_layout
 244
 245 \begin_layout Standard
 246 Cuts section <start> to <end> from dump <input> and saves it to <output>.
 247 \end_layout
 248
 249 \begin_layout Standard
 250 <start> and <end> are specified in nanoseconds if these don't contain '.'.
 251  Otherwise these are assumed to be in seconds.
 252  So for example both 100000000 and 0.1 signifies 0.1s point.
 253 \end_layout
 254
 255 \begin_layout Section
 256 demuxdump.exe
 257 \end_layout
 258
 259 \begin_layout Standard
 260 Copies stream out of the dump.
 261 \end_layout
 262
 263 \begin_layout LyX-Code
 264 syntax: demuxdump.exe <input> <stream> <output>
 265 \end_layout
 266
 267 \begin_layout Standard
 268 Copies stream <stream> from dump <input> and saves it to <output>.
 269 \end_layout
 270
 271 \begin_layout Section
 272 dumpconvert.exe
 273 \end_layout
 274
 275 \begin_layout Standard
 276 The main dump to other formats converter.
 277 \end_layout
 278
 279 \begin_layout LyX-Code
 280 syntax: dumpconvert.exe <options> [<subtitle options>...] [<audio options>...]
 281  <files>...
 282 \end_layout
 283
 284 \begin_layout Standard
 285 Convert <files>...
 286  into other formats.
 287  Note that this tool takes subtitle and audio options (and that they are
 288  shared with playdump.exe).
 289 \end_layout
 290
 291 \begin_layout Subsection
 292 Options
 293 \end_layout
 294
 295 \begin_layout Subsubsection
 296 --video-width=<width>
 297 \end_layout
 298
 299 \begin_layout Standard
 300 Set video output width to <width>.
 301  No default, must be specified.
 302 \end_layout
 303
 304 \begin_layout Subsubsection
 305 --video-height=<height>
 306 \end_layout
 307
 308 \begin_layout Standard
 309 Set video output height to <height>.
 310  No default, must be specified.
 311 \end_layout
 312
 313 \begin_layout Subsubsection
 314 --video-framerate=<fps>
 315 \end_layout
 316
 317 \begin_layout Standard
 318 Set video output fps to <fps>.
 319  <fps> can also be 'auto' to allow variable-framerate output.
 320  Default is fixed 60fps.
 321 \end_layout
 322
 323 \begin_layout Subsubsection
 324 --video-scale-algo=<algo>
 325 \end_layout
 326
 327 \begin_layout Standard
 328 Set video scaling algorithm to <algo>.
 329  Currently following algorithms are available:
 330 \end_layout
 331
 332 \begin_layout Itemize
 333 'nearest' (nearest neighbor)
 334 \end_layout
 335
 336 \begin_layout Itemize
 337 'bilinear' (bilinear interpolation)
 338 \end_layout
 339
 340 \begin_layout Itemize
 341 'average' (weighted average of covered pixels)
 342 \end_layout
 343
 344 \begin_layout Itemize
 345 'lanczos1', 'lanczos2', 'lanczos3', 'lanczos4', 'lanczos5' (higher-quality
 346  resizeers)
 347 \end_layout
 348
 349 \begin_layout Itemize
 350 'xdrop9' (drop every 9th column followed by nearest neighbor, handy for
 351  matching 720x400 text mode with 640x400 GFX mode)
 352 \end_layout
 353
 354 \begin_layout Itemize
 355 'hqx2', 'hqx3', 'hqx4', 'hqx22', 'hqx32', 'hqx42', 'hqx2d', 'hqx3d', 'hqx4d'
 356  (HQx resizers; requires compile with HQx support).
 357 \end_layout
 358
 359 \begin_layout Standard
 360 Additionally <algo> can be in form [<algo> <width> <height>]...
 361  <algo> to do multi-step resize with specified intermediate resolutions.
 362  The order resizes are performed is from right to left.
 363 \end_layout
 364
 365 \begin_layout Subsubsection
 366 --video-scale-algo=
 367 \begin_inset Quotes erd
 368 \end_inset
 369
 370 <algo> <width> <height>
 371 \begin_inset Quotes erd
 372 \end_inset
 373
 374
 375 \end_layout
 376
 377 \begin_layout Standard
 378 Set video scaling algorithm to <algo> for frames that are <width> by <height>
 379  (i.e.
 380  set special scaler for specific resolution).
 381 \end_layout
 382
 383 \begin_layout Subsubsection
 384 --video-max-dedup=<dedup>
 385 \end_layout
 386
 387 \begin_layout Standard
 388 Allow up to <dedup> consequtive frames to be elided if they are indentical
 389  to previous (truly identical, not just
 390 \begin_inset Quotes eld
 391 \end_inset
 392
 393 identical
 394 \begin_inset Quotes erd
 395 \end_inset
 396
 397 ).
 398  Requires variable framerate output.
 399 \end_layout
 400
 401 \begin_layout Subsubsection
 402 --audio-delay=<delay>
 403 \end_layout
 404
 405 \begin_layout Standard
 406 Delay audio by <delay> nanoseconds/seconds (seconds if <delay> has '.', nanosecon
 407 ds otherwise).
 408  Delay may be negative.
 409 \end_layout
 410
 411 \begin_layout Subsubsection
 412 --subtitle-delay=<delay>
 413 \end_layout
 414
 415 \begin_layout Standard
 416 Delay subtitles by <delay> nanoseconds/seconds (seconds if <delay> has '.',
 417  nanoseconds otherwise).
 418  Delay may be negative.
 419 \end_layout
 420
 421 \begin_layout Subsubsection
 422 --output-<format>=<filename>[,<parameters>]
 423 \end_layout
 424
 425 \begin_layout Standard
 426 Output to <filename> in format <format>.
 427  <parameters> is format-dependent parameters.
 428 \end_layout
 429
 430 \begin_layout Subsection
 431 Output formats
 432 \end_layout
 433
 434 \begin_layout Subsubsection
 435 oggenc
 436 \end_layout
 437
 438 \begin_layout LyX-Code
 439 syntax: --output-oggenc=<filename>[,<oggenc-option>[,<oggenc-option[...]]]
 440 \end_layout
 441
 442 \begin_layout Standard
 443 Pipe audio to oggenc in order to encode OGG Vorbis to <filename>.
 444  Note that audio bitrate and format is automatically set correctly.
 445  For oggenc options in form --foo=bar, use foo=bar as <oggenc-option>.
 446  For oggenc options of form --baz, use baz as <oggenc-option>
 447 \end_layout
 448
 449 \begin_layout Subsubsection
 450 rawaudio
 451 \end_layout
 452
 453 \begin_layout LyX-Code
 454 syntax: --output-rawaudio=<filename>
 455 \end_layout
 456
 457 \begin_layout Standard
 458 Write 16-bit stereo little-endian signed audio track in raw format to <filename>.
 459 \end_layout
 460
 461 \begin_layout Subsubsection
 462 rawi420
 463 \end_layout
 464
 465 \begin_layout LyX-Code
 466 syntax: --output-rawi420=<filename>
 467 \end_layout
 468
 469 \begin_layout Standard
 470 Write video in raw I420 format to <filename>
 471 \end_layout
 472
 473 \begin_layout Subsubsection
 474 rawi420-uvswap
 475 \end_layout
 476
 477 \begin_layout LyX-Code
 478 syntax: --output-rawi420-uvswap=<filename>
 479 \end_layout
 480
 481 \begin_layout Standard
 482 Write video in raw I420 format to <filename>.
 483  Red and blue are swapped.
 484 \end_layout
 485
 486 \begin_layout Subsubsection
 487 rawrgbx
 488 \end_layout
 489
 490 \begin_layout LyX-Code
 491 syntax: --output-rawrgbx=<filename>
 492 \end_layout
 493
 494 \begin_layout Standard
 495 Write video in raw RGBx format to <filename>.
 496 \end_layout
 497
 498 \begin_layout Subsubsection
 499 timecodev2
 500 \end_layout
 501
 502 \begin_layout LyX-Code
 503 syntax: --output-timecodev2=<filename>
 504 \end_layout
 505
 506 \begin_layout Standard
 507 Write video timestamp data in v2 format to <filename>.
 508  Very useful for automatic-/variable-fps encoding.
 509 \end_layout
 510
 511 \begin_layout Subsubsection
 512 wav
 513 \end_layout
 514
 515 \begin_layout LyX-Code
 516 syntax: --output-wav=<filename>
 517 \end_layout
 518
 519 \begin_layout Standard
 520 Write audio in wav form to <filename>.
 521  Note that files with over 1 billion samples are not written properly.
 522 \end_layout
 523
 524 \begin_layout Subsubsection
 525 x264
 526 \end_layout
 527
 528 \begin_layout LyX-Code
 529 syntax: --output-x264=<filename>[,<x264-option>[,<x264-option[...]]]
 530 \end_layout
 531
 532 \begin_layout Standard
 533 Pipe video to x264 in order to encode h.264 to <filename>.
 534  Note that video size is automatically set correctly.
 535  For x264 options in form --foo bar, use foo=bar as <x264-option>.
 536  For x264 options of form --baz, use baz as <x264-option>.
 537
 538 \end_layout
 539
 540 \begin_layout Standard
 541 BUG: Framerate is not set correctly automatically.
 542 \end_layout
 543
 544 \begin_layout Subsubsection
 545 faac
 546 \end_layout
 547
 548 \begin_layout LyX-Code
 549 syntax: --output-faac=<filename>[,<option>[,<option>[...]]]
 550 \end_layout
 551
 552 \begin_layout Standard
 553 Pipe audio to faac in order to encode AAC to <filename>.
 554  Interesting options include 'q=<quality>' (set quality), 'c=<freq>' (force
 555  bandwidth, default is autodetect).
 556 \end_layout
 557
 558 \begin_layout Section
 559 dumppackets.exe
 560 \end_layout
 561
 562 \begin_layout Standard
 563 Dump the stream in textual format (useful for debugging):
 564 \end_layout
 565
 566 \begin_layout LyX-Code
 567 syntax: dumppackets.exe <file>
 568 \end_layout
 569
 570 \begin_layout Standard
 571 Dumps the data in <file> in textual form.
 572 \end_layout
 573
 574 \begin_layout Section
 575 fmtopcm.exe
 576 \end_layout
 577
 578 \begin_layout Standard
 579 Convert given stream from FM format to PCM format (this is mainly useful
 580  for dumps somehow containing multiple FM streams).
 581 \end_layout
 582
 583 \begin_layout LyX-Code
 584 syntax: fmtopcm.exe <input> <stream> <rate> <output>
 585 \end_layout
 586
 587 \begin_layout Standard
 588 Reads dump from <input> and converts FM output on stream <stream> into PCM
 589  output at sampling rate <rate>.
 590  The output (all other streams plus converted stream) is written to <output>.
 591 \end_layout
 592
 593 \begin_layout Section
 594 guessresolution.exe
 595 \end_layout
 596
 597 \begin_layout Standard
 598 Try to guess proper encoding resolution from dump.
 599 \end_layout
 600
 601 \begin_layout LyX-Code
 602 sytax: guessresolution.exe <files>...
 603 \end_layout
 604
 605 \begin_layout Standard
 606 Read given files <files>...
 607  and try to guess the proper resolution.
 608 \end_layout
 609
 610 \begin_layout Section
 611 mknulldump.exe
 612 \end_layout
 613
 614 \begin_layout Standard
 615 Make empty clip of specified length.
 616 \end_layout
 617
 618 \begin_layout LyX-Code
 619 syntax: mknulldump.exe <length> <output>
 620 \end_layout
 621
 622 \begin_layout Standard
 623 Make empty clip of <length> nanoseconds (seconds if <length> contains dot)
 624  and write it to <output>.
 625 \end_layout
 626
 627 \begin_layout Section
 628 muxdump.exe
 629 \end_layout
 630
 631 \begin_layout Standard
 632 Mux multiple dumps into one.
 633 \end_layout
 634
 635 \begin_layout LyX-Code
 636 syntax: muxdump.exe <input>...
 637  <output>
 638 \end_layout
 639
 640 \begin_layout Standard
 641 Read dump files <input>...
 642  and combine streams, writing result to <output>.
 643 \end_layout
 644
 645 \begin_layout Section
 646 picturestodump.exe
 647 \end_layout
 648
 649 \begin_layout Standard
 650 Transform set of pictures into dump.
 651 \end_layout
 652
 653 \begin_layout LyX-Code
 654 syntax: picturestodump.exe [--fps=<fps>] <input>...
 655  <output>
 656 \end_layout
 657
 658 \begin_layout Standard
 659 Reads pictures from <input>...
 660  and writes dump at <fps> (defaults to 60 if not specified) to <output>
 661  containing those pictures.
 662 \end_layout
 663
 664 \begin_layout Section
 665 playdump.exe
 666 \end_layout
 667
 668 \begin_layout Standard
 669 Play dump in realtime.
 670 \end_layout
 671
 672 \begin_layout LyX-Code
 673 syntax: playdump.exe [<subtitle options>...] [<audio options>...] [--audio-rate=<rate>]
 674 \end_layout
 675
 676 \begin_layout LyX-Code
 677 [--speed=<percent>] <files>...
 678 \end_layout
 679
 680 \begin_layout Standard
 681 Play concatenation of <files>...
 682  at <percent>% realtime speed (default 100%).
 683  Use <rate> Hz for audio sampling rate (default 44100Hz).
 684  Note that this command accepts audio and subtitle options.
 685 \end_layout
 686
 687 \begin_layout Section
 688 testresizer.exe
 689 \end_layout
 690
 691 \begin_layout Standard
 692 Resize image and show result.
 693  This is mainly intended for debugging resizers.
 694 \end_layout
 695
 696 \begin_layout LyX-Code
 697 syntax: testresizer.exe <image> <algo> <width> <height>
 698 \end_layout
 699
 700 \begin_layout Standard
 701 Read <image> and resize it to <width> by <height> using algorithm <algo>
 702  (see dumpconvert.exe option --video-scale-algo for possible algorithms).
 703  Then display the result on screen.
 704 \end_layout
 705
 706 \begin_layout Section
 707 Audio processing options
 708 \end_layout
 709
 710 \begin_layout Standard
 711 Audio processing has three stages:
 712 \end_layout
 713
 714 \begin_layout Itemize
 715 Per-stream premix filtering
 716 \end_layout
 717
 718 \begin_layout Itemize
 719 Mixing
 720 \end_layout
 721
 722 \begin_layout Itemize
 723 Postmix filtering.
 724 \end_layout
 725
 726 \begin_layout Standard
 727 For each, the operations are done in order they are given on command line.
 728  If <stream> is specified for some operation, it occurs as part of premix
 729  filtering for that stream.
 730  Otherwise it occurs as postmix filtering.
 731 \end_layout
 732
 733 \begin_layout Subsection
 734 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...
 735 \end_layout
 736
 737 \begin_layout Standard
 738 Perform FIR filtering using coefficients <a0>, <a1>, ..., given in order of
 739  increasing delay.
 740 \end_layout
 741
 742 \begin_layout Subsection
 743 --audio-mixer-filter=[<stream>:]<a0>,<a1>,...;<b0>,<b1>,...
 744 \end_layout
 745
 746 \begin_layout Standard
 747 Perform IIR filtering using input coefficents <a0>, <a1>, ..., output coefficients
 748  <b0>, <b1>,...
 749  given in order of increasing delay.
 750 \end_layout
 751
 752 \begin_layout Subsection
 753 --audio-mixer-gain=[<stream>:]<gain>
 754 \end_layout
 755
 756 \begin_layout Standard
 757 Amplify signal by <gain> dB.
 758 \end_layout
 759
 760 \begin_layout Subsection
 761 --audio-mixer-attenuate=[<stream>:]<attenuation>
 762 \end_layout
 763
 764 \begin_layout Standard
 765 Attenuate signal by <attenuation> dB.
 766 \end_layout
 767
 768 \begin_layout Subsection
 769 --silence[=<stream>]
 770 \end_layout
 771
 772 \begin_layout Standard
 773 Silence specified stream or entiere sound output.
 774 \end_layout
 775
 776 \begin_layout Section
 777 Subtitle processing options
 778 \end_layout
 779
 780 \begin_layout Standard
 781 Subtitle option of form foo=bar is given as --video-hardsub-foo=bar on command
 782  line and as foo=bar in script file.
 783  For option of form baz, the corresponding forms are --video-hardsub-baz
 784  and baz.
 785  Options are processed in order they are encountered, script files are processed
 786  immediately when script file option is encountered.
 787 \end_layout
 788
 789 \begin_layout Subsection
 790 font=<font>
 791 \end_layout
 792
 793 \begin_layout LyX-Code
 794 Syntax (command line): --video-hardsub-font=<font>
 795 \end_layout
 796
 797 \begin_layout LyX-Code
 798 Syntax (script): font=<font>
 799 \end_layout
 800
 801 \begin_layout Standard
 802 Set the font used to <font>.
 803  No default, this has to be set before using any font rendering commands.
 804 \end_layout
 805
 806 \begin_layout Subsection
 807 size=<size>
 808 \end_layout
 809
 810 \begin_layout LyX-Code
 811 Syntax (command line): --video-hardsub-size=<size>
 812 \end_layout
 813
 814 \begin_layout LyX-Code
 815 Syntax (script): size=<size>
 816 \end_layout
 817
 818 \begin_layout Standard
 819 Set the size used to <size>.
 820  Default is 16.
 821 \end_layout
 822
 823 \begin_layout Subsection
 824 xpos=<xpos>
 825 \end_layout
 826
 827 \begin_layout LyX-Code
 828 Syntax (command line): --video-hardsub-xpos=<xpos>
 829 \end_layout
 830
 831 \begin_layout LyX-Code
 832 Syntax (script): xpos=<xpos>
 833 \end_layout
 834
 835 \begin_layout Standard
 836 Set the x offset to <xpos> pixels.
 837  There are also special offsets left, center and right.
 838  Default is center.
 839 \end_layout
 840
 841 \begin_layout Subsection
 842 ypos=<ypos>
 843 \end_layout
 844
 845 \begin_layout LyX-Code
 846 Syntax (command line): --video-hardsub-ypos=<ypos>
 847 \end_layout
 848
 849 \begin_layout LyX-Code
 850 Syntax (script): ypos=<ypos>
 851 \end_layout
 852
 853 \begin_layout Standard
 854 Set the y offset to <ypos> pixels.
 855  There are also special offsets top, center and bottom.
 856  Default is bottom.
 857 \end_layout
 858
 859 \begin_layout Subsection
 860 duration=<duration>
 861 \end_layout
 862
 863 \begin_layout LyX-Code
 864 Syntax (command line): --video-hardsub-duration=<duration>
 865 \end_layout
 866
 867 \begin_layout LyX-Code
 868 Syntax (script): duration=<duration>
 869 \end_layout
 870
 871 \begin_layout Standard
 872 Set the duration to <duration> (nano)seconds (seconds being selected if
 873  <duration> has '.').
 874  Default is 5.0 (5 seconds).
 875 \end_layout
 876
 877 \begin_layout Subsection
 878 halo=<thickness>
 879 \end_layout
 880
 881 \begin_layout LyX-Code
 882 Syntax (command line): --video-hardsub-halo=<thickness>
 883 \end_layout
 884
 885 \begin_layout LyX-Code
 886 Syntax (script): halo=<thickness>
 887 \end_layout
 888
 889 \begin_layout Standard
 890 Set the halo thickness to <thickness> pixels.
 891  0 disables halo.
 892  Default is 0.
 893 \end_layout
 894
 895 \begin_layout Subsection
 896 textalign=<align>
 897 \end_layout
 898
 899 \begin_layout LyX-Code
 900 Syntax (command line): --video-hardsub-textalign=<align>
 901 \end_layout
 902
 903 \begin_layout LyX-Code
 904 Syntax (script): textalign=<align>
 905 \end_layout
 906
 907 \begin_layout Standard
 908 Set the between-lines text alignment to <align>.
 909  Valid alignments are left, center and right.
 910  Default is center.
 911 \end_layout
 912
 913 \begin_layout Subsection
 914 spacing=<amount>
 915 \end_layout
 916
 917 \begin_layout LyX-Code
 918 Syntax (command line): --video-hardsub-spacing=<amount>
 919 \end_layout
 920
 921 \begin_layout LyX-Code
 922 Syntax (script): spacing=<amount>
 923 \end_layout
 924
 925 \begin_layout Standard
 926 Set the between-lines text spacing to <amount> pixels.
 927  Default is 0.
 928 \end_layout
 929
 930 \begin_layout Subsection
 931 script=<file>
 932 \end_layout
 933
 934 \begin_layout LyX-Code
 935 Syntax (command line): --video-hardsub-script=<file>
 936 \end_layout
 937
 938 \begin_layout Standard
 939 Read file <file> and execute it as subtitle commands.
 940 \end_layout
 941
 942 \begin_layout Subsection
 943 text=<timestamp>,<text>
 944 \end_layout
 945
 946 \begin_layout LyX-Code
 947 Syntax (command line): --video-hardsub-text=<timestamp>,<text>
 948 \end_layout
 949
 950 \begin_layout LyX-Code
 951 Syntax (script): text=<timestamp>,<text>
 952 \end_layout
 953
 954 \begin_layout Standard
 955 Display <text> at <timestamp> (seconds or nanoseconds, depending on presence
 956  of '.').
 957  The following sequences are special in <text>:
 958 \end_layout
 959
 960 \begin_layout Itemize
 961 '
 962 \backslash
 963
 964 \backslash
 965 ': Literal backslash
 966 \end_layout
 967
 968 \begin_layout Itemize
 969 '
 970 \backslash
 971 n': Newline
 972 \end_layout
 973
 974 \begin_layout Itemize
 975 '
 976 \backslash
 977 A': Authors from runinfo
 978 \end_layout
 979
 980 \begin_layout Itemize
 981 '
 982 \backslash
 983 G': Game name from runinfo
 984 \end_layout
 985
 986 \begin_layout Itemize
 987 '
 988 \backslash
 989 L': Movie length from runinfo.
 990 \end_layout
 991
 992 \begin_layout Itemize
 993 '
 994 \backslash
 995 R': Movie rerecord count from runinfo.
 996 \end_layout
 997
 998 \begin_layout Subsection
 999 background-color=<color>
1000 \end_layout
1001
1002 \begin_layout LyX-Code
1003 Syntax (command line): --video-hardsub-background-color=<color>
1004 \end_layout
1005
1006 \begin_layout LyX-Code
1007 Syntax (script): background-color=<color>
1008 \end_layout
1009
1010 \begin_layout Standard
1011 Set the background color to <color>.
1012  Following <color> specifications are allowed:
1013 \end_layout
1014
1015 \begin_layout Itemize
1016 '<a>': Partially transparent black.
1017  <a> of 0 is fully transparent, 255 is fully opaque.
1018 \end_layout
1019
1020 \begin_layout Itemize
1021 '<rgb>,<a>': Partially transparent gray.
1022  <a> of 0 is fully transparent, 255 is fully opaque.
1023  <rgb> sets brightness of gray, 0 is black and 255 is white.
1024 \end_layout
1025
1026 \begin_layout Itemize
1027 '<r>,<g>,<b>,<a>': Partially transparent color.
1028  <a> of 0 is fuly transparent, 255 is fully opaque.
1029  <r>, <g> and <b> set the color (0-255 for each component).
1030 \end_layout
1031
1032 \begin_layout Standard
1033 Default is fully transparent.
1034 \end_layout
1035
1036 \begin_layout Subsection
1037 foreground-color=<color>
1038 \end_layout
1039
1040 \begin_layout LyX-Code
1041 Syntax (command line): --video-hardsub-foreground-color=<color>
1042 \end_layout
1043
1044 \begin_layout LyX-Code
1045 Syntax (script): foreground-color=<color>
1046 \end_layout
1047
1048 \begin_layout Standard
1049 Set the foreground color to <color>.
1050  Following <color> specifications are allowed:
1051 \end_layout
1052
1053 \begin_layout Itemize
1054 '<a>': Partially transparent white.
1055  <a> of 0 is fully transparent, 255 is fully opaque.
1056 \end_layout
1057
1058 \begin_layout Itemize
1059 '<rgb>,<a>': Partially transparent gray.
1060  <a> of 0 is fully transparent, 255 is fully opaque.
1061  <rgb> sets brightness of gray, 0 is black and 255 is white.
1062 \end_layout
1063
1064 \begin_layout Itemize
1065 '<r>,<g>,<b>': Fully opaque color.
1066  <r>,<g>, <b> set the color (0-255 for each component).
1067 \end_layout
1068
1069 \begin_layout Itemize
1070 '<r>,<g>,<b>,<a>': Partially transparent color.
1071  <a> of 0 is fuly transparent, 255 is fully opaque.
1072  <r>, <g> and <b> set the color (0-255 for each component).
1073 \end_layout
1074
1075 \begin_layout Standard
1076 Default is fully opaque white.
1077 \end_layout
1078
1079 \begin_layout Subsection
1080 halo-color=<color>
1081 \end_layout
1082
1083 \begin_layout LyX-Code
1084 Syntax (command line): --video-hardsub-halo-color=<color>
1085 \end_layout
1086
1087 \begin_layout LyX-Code
1088 Syntax (script): halo-color=<color>
1089 \end_layout
1090
1091 \begin_layout Standard
1092 Set the halo color to <color>.
1093  Following <color> specifications are allowed:
1094 \end_layout
1095
1096 \begin_layout Itemize
1097 '<a>': Partially transparent black.
1098  <a> of 0 is fully transparent, 255 is fully opaque.
1099 \end_layout
1100
1101 \begin_layout Itemize
1102 '<rgb>,<a>': Partially transparent gray.
1103  <a> of 0 is fully transparent, 255 is fully opaque.
1104  <rgb> sets brightness of gray, 0 is black and 255 is white.
1105 \end_layout
1106
1107 \begin_layout Itemize
1108 '<r>,<g>,<b>': Fully opaque color.
1109  <r>,<g>, <b> set the color (0-255 for each component).
1110 \end_layout
1111
1112 \begin_layout Itemize
1113 '<r>,<g>,<b>,<a>': Partially transparent color.
1114  <a> of 0 is fuly transparent, 255 is fully opaque.
1115  <r>, <g> and <b> set the color (0-255 for each component).
1116 \end_layout
1117
1118 \begin_layout Standard
1119 Default is fully opaque black.
1120 \end_layout
1121
1122 \begin_layout Subsection
1123 push
1124 \end_layout
1125
1126 \begin_layout LyX-Code
1127 Syntax (command line): --video-hardsub-push
1128 \end_layout
1129
1130 \begin_layout LyX-Code
1131 Syntax (script): push
1132 \end_layout
1133
1134 \begin_layout Standard
1135 Save all settings to settings stack.
1136 \end_layout
1137
1138 \begin_layout Subsection
1139 pop
1140 \end_layout
1141
1142 \begin_layout LyX-Code
1143 Syntax (command line): --video-hardsub-pop
1144 \end_layout
1145
1146 \begin_layout LyX-Code
1147 Syntax (script): pop
1148 \end_layout
1149
1150 \begin_layout Standard
1151 Pop all settings from settings stack and apply them.
1152 \end_layout
1153
1154 \begin_layout Subsection
1155 reset
1156 \end_layout
1157
1158 \begin_layout LyX-Code
1159 Syntax (command line): --video-hardsub-reset
1160 \end_layout
1161
1162 \begin_layout LyX-Code
1163 Syntax (script): reset
1164 \end_layout
1165
1166 \begin_layout Standard
1167 Reset all settings that have defaults to defaults (ones that don't are not
1168  reset).
1169 \end_layout
1170
1171 \end_body
1172 \end_document