TOOLS/README

   1 README for the TOOLS directory
   2 ==============================
   3
   4 Preamble
   5 --------
   6
   7 In this directory you can find some nice scripts and code that makes
   8 using MPlayer and MEncoder easier, for example scripts for DVD track
   9 encoding in three pass mode or creating SVCDs from a movie.
  10
  11 FIXME: Document all the stuff in the subdirectories:
  12
  13 mpfc
  14 benchmark
  15 bmovl-test
  16 mwallp
  17 subfont-c
  18 GL-test
  19 TVout
  20 TVout/matroxset
  21 TVout/con2fb
  22 benchmark-gab
  23 netstream
  24 realcodecs
  25
  26
  27 MPlayer scripts in the TOOLS dir
  28 --------------------------------
  29
  30 midentify
  31
  32 Author:       Tobias Diedrich
  33
  34 Description:  Runs 'mplayer -identify' for all arguments while preventing
  35               video window flashing.
  36
  37 Usage:        midentify file1 [file2 ...]
  38
  39
  40 mpconsole
  41
  42 Author:       Rich Felker
  43
  44 Description:  Script to run MPlayer on the console (fbdev/mga_vid/etc.) without
  45               the console text and/or flashing cursor getting in the way.
  46
  47 Usage:        mpconsole [mplayer options]
  48
  49
  50 mplmult.sh
  51
  52 Author:       Reimar Döffinger
  53
  54 Description:  Example how to output video on multiple windows in sync. Might
  55               be even more useful in combination with -vo ggi to distribute
  56               the video arbitrarily.
  57
  58 Usage:        mplmult.sh <n> <options>
  59               n        Number of MPlayer instances that display the video.
  60               options  Any options you would pass to MPlayer, more than
  61                        one file will usually not work.
  62
  63
  64 subsearch.sh
  65
  66 Author:       Alex Beregszaszi
  67
  68 Description:  Collects subtitle files from the directory given as argument
  69               ('.' if none is given) and its subdirectories and prints
  70               them as a comma separated list to stdout.
  71
  72 Usage:        subsearch.sh [directory]
  73               mplayer -sub `subsearch.sh` movie
  74
  75
  76 x2mpsub.sh
  77
  78 Author:       Gabucino
  79
  80 Description:  Converts the subtitles in the current directory into MPsub
  81               format (subtitles go in ./converted-subtitles/).
  82
  83 Usage:        x2mpsub.sh
  84
  85
  86 mp.pl
  87
  88 Author:       Felix Bünemann
  89
  90 Description:  Small helper script that allows to play multiple files with
  91               MPlayer. Wildcards are supported.
  92
  93 Usage:        mp.pl <parameters> <files>
  94               Where <parameters> are all possible command line switches
  95               for MPlayer and <files> can be either a list of files,
  96               like file1 file2 file3 and/or a wildcard definition,
  97               like *.avi.
  98
  99               example: mp.pl -vo x11 /dvd/VIDEO_TS/VTS_05_*.VOB movie.asf
 100
 101
 102 wma2ogg.pl
 103
 104 Author:       Peter Simon
 105
 106 Description:  Converts WMA files to Ogg or MP3.
 107
 108 Usage:        wma2ogg [options] <-f FILE1 | -f FILE2 ... | -a>
 109               -f, -file   filename
 110               -a          converts all WMA files in the current directory
 111               -t          output filetype (ogg, mp3) [default=ogg]
 112               -lame       I wanna use L.A.M.E. sure enough!
 113               -br         bitrate (kb/s) [default=from the WMA]
 114               -del        remove WMA file(s) after the transcoding
 115
 116
 117
 118 MEncoder scripts in the TOOLS dir
 119 ---------------------------------
 120
 121 divx2svcd
 122
 123 Author:       Miklos Vajna
 124
 125 Description:  A simple utility that creates an SVCD from a video in an AVI
 126               container.
 127
 128 Usage:        divx2svcd <input_avi> [options]
 129               see 'divx2svcd -h' for more info
 130
 131
 132 menc2pass
 133
 134 Author:       Felix Bünemann
 135
 136 Description:  Helper script to ease MEncoder two pass encoding. Give it all
 137               the encoding parameters you would pass to mencoder, but leave
 138               out the (v)pass=<n> suboption.
 139
 140 Usage:        menc2pass <options>
 141
 142
 143 mencvcd
 144
 145 Author:       Jürgen Hammelmann
 146
 147 Description:  Converts DVD (or anything else that MPlayer plays) to (S)VCD
 148
 149 Usage:        mencvcd <basename> [mencvcd options] [mplayer options]
 150               see 'mencvcd -h' for more info
 151
 152 Note:         Requires MPlayer, mjpegtools, VCDImager, cdrdao, and optionally
 153               LAME, tooLAME and SoX.
 154
 155
 156 dvd2divxscript.pl
 157
 158 Author:       Florian Schilhabel
 159
 160 Description:  Yet another DVD to divx helper script.
 161               This script encodes a DVD track in three pass mode to MPEG-4 with
 162               libavcodec. Optionally it writes the resulting movie file to
 163               CD-ROM the corresponding audio track to MP3. It can also shut
 164               down the computer when it finishes. If you like, you can
 165               watch the MEncoder output on /dev/tty8.
 166
 167 Usage:        --help       show help
 168               --abr        (AudioBitRate) Please enter the desired bitrate this
 169                            can be either [96|128|192] kbit/sec (default: 128).
 170               --lang       Specify the Language of the audio track this can be
 171                            for example <en> or <de> (default: <de>).
 172               --dvd        Specify the DVD track you want to encode.
 173               --cdsize     Specify the size of your CD-ROM (default: 700MB).
 174               --shutdown   Shutdown the system, when the encoding process has
 175                            finished. Needs appropriate privileges.
 176               --out        Specify the name of your encoded movie. The file
 177                            extension will be appended automatically.
 178               --writecd    Takes the newly created movie and writes it to a
 179                            CD-ROM.
 180               --writedev   cdrecord device identifier, for example 0,1,0
 181               --speed      writing speed (default: 4)
 182               --dvd-device device to pull the video off (default: /dev/dvd)
 183
 184
 185 aconvert
 186
 187 Author:       Jonas Jermann
 188
 189 Description:  A hack to allow MEncoder to read respectively encode from audio
 190               only files.
 191
 192 Usage:        aconvert <"input file"> <"output file"> <"options">
 193               If no options are specified the following is assumed:
 194               -oac lavc -lavcopts acodec=mp3:abitrate=192
 195
 196 Note:         The script is probably bash dependent and it's just a quick
 197               hack, feel free to improve it (or much better: fix MEncoder ;).
 198
 199
 200
 201 qepdvcd.sh
 202
 203 Author:       Reynaldo H. Verdejo Pinochet
 204
 205 Description:  converter from any supported format to VCD/SVCD PAL/NTSC
 206
 207 Usage:        qepdvcd.sh file <options>
 208               Run with no arguments to see the list of options.
 209
 210 Note:         You will need vcdimager/cdrecord to master/burn the resulting
 211               files.
 212
 213
 214
 215 encode2mpeglight
 216
 217 Author:       Giacomo Comes
 218
 219 Description:  Convert anything MPlayer can play to VCD/SVCD/DVD MPEG.
 220
 221 Usage:        encode2mpeglight -o <NAME> -n <NORM> [options] <source>
 222               For help and documentation run:
 223                 encode2mpeglight -h
 224                 encode2mpeglight -l
 225                 encode2mpeglight -doc
 226
 227 Note:         This script uses only MEncode/MPlayer. Check the final log
 228               file for informations/warnings about the encoding process.
 229
 230
 231 Tech scripts in the TOOLS dir
 232 -----------------------------
 233
 234 fastmem.sh
 235
 236 Author:       Arpi
 237
 238 Description:  benchmark/testbed for fastmemcpy stuff
 239
 240 Usage:        fastmem.sh
 241
 242
 243 sws-test
 244
 245 Author:       Michael Niedermayer
 246
 247 Description:  Very simple script to generate PNG images from a video with all
 248               -sws methods.
 249
 250 Usage:        sws-test <video-file> <start-pos> <res>
 251
 252               example: sws-test abc.avi 10 160:120
 253
 254
 255 calcbpp.pl
 256
 257 Author:       Moritz Bunkus
 258
 259 Description:  A script that calculates the $bpp for a movie, mentioned in
 260               DOCS/tech/encoding-tips.txt, see that document for more info.
 261
 262 Usage:        calcbpp.pl <resolution> <aspect ratio> <bitrate> <fps>
 263               resolution:    the cropped but unscaled resolution
 264                              (use '-vf cropdetect')
 265               aspect ratio:  the encoded aspect ratio. All DVDs come at
 266                              720x576 but contain a flag that tells the player
 267                              wether it should display the DVD at an aspect
 268                              ratio of 4/3 (1.333) or at 16/9 (1.777). Have a
 269                              look at MPlayer's output - there's something
 270                              about 'prescaling'. That's what you are looking
 271                              for.
 272               bitrate:       the video bitrate in kbit/s
 273               fps:           the fps
 274
 275               example: calcbpp.pl 720x440 16/9 896 25
 276
 277
 278 countquant.pl
 279
 280 Author:       Moritz Bunkus
 281
 282 Description:  Counts the quantizers used for the encoding, mentioned in
 283               DOCS/tech/encoding-tips.txt, see that document for more info.
 284
 285 Usage:        countquant.pl < divx2pass.log
 286               It will print out which quantizer was used how often. If you see
 287               that e.g. the lowest quantizer (vqmin=2) gets used for > 95% of
 288               the frames then you can safely increase your picture size.
 289
 290
 291 perlbench.pl
 292
 293 Author:       Felix Bünemann
 294
 295 Description:  fastmemcpy benchmark script
 296
 297 Usage:        perlbench.pl
 298
 299
 300 plotpsnr.pl
 301
 302 Author:       Jonas Jermann
 303
 304 Description:  Draw PSNR log graphs using gnuplot.
 305
 306 Usage:        plotpsnr.pl [options] <file>
 307               -h, --help    Display this help message
 308               -quant        Display quantizers
 309               -size         Display size
 310               -psnr         Display PSNR
 311               -iframes      Display I-frames
 312               -pframes      Display P-frames
 313               -bframes      Display B-frames
 314               -aframes      Display all frames in different colors
 315               -cmp <file2>  Compare two files
 316               -qs <style>   Quantizer style
 317               -ss <style>   Size style
 318               -ps <style>   PSNR style
 319
 320               Default: -quant -size -psnr -qs "p" -ss "i" -ps "p"
 321
 322 Note:         Requires gnuplot. Comparison is based on file2. Comparison
 323               assumes that the frame numbers of both files fit.
 324
 325
 326 psnr-video.sh
 327
 328 Author:       Matthias Wieser
 329
 330 Description:  Calculates the PSNR between two existing video files.
 331               The PSNR is calculated frame by frame.
 332               Also prints the overall PSNR.
 333               The script can be used to:
 334                * Compare different softwarescalers (should I use
 335                  -sws 1 or -sws 2 ?)
 336                * Compare different resolutions (is it better to scale
 337                  down to 640x360 or to 560x320)
 338                * Compare different deinterlacers
 339                * Compare different video codecs
 340                * Compare video filters (is it better to use -vf hqdn3d
 341                  or lavcopts:nr=400)
 342                * [...]
 343
 344 Usage:        psnr-video.sh <file1> <file2> [<frames>] [<options1>] [<options2>]
 345
 346               <file1> and <file2> are the video files for which the PSNR
 347                 should be calculated.
 348               [<frames>] is the number of frames to process, starting
 349                 from frame 1.
 350               [<options1>] are additional MPlayer options for <file1>
 351               [<options2>] are additional MPlayer options for <file2>
 352
 353               A file called ./psnr.dat will be created with the following
 354               content:
 355
 356               File;Y;Cb;Cr
 357               00000001.ppm;34.23;39.54;40.06;35.426
 358               00000002.ppm;33.03;38.71;39.26;34.271
 359               00000003.ppm;33.45;38.91;39.28;34.655
 360               00000004.ppm;32.72;38.69;38.85;33.972
 361               [...]
 362               00000247.ppm;35.55;40.84;42.15;36.785
 363               PSNR:;35.9887
 364
 365 Note:         This script relies on the the tool "pnmpsnr" for the
 366               frame-by-frame PSNR calculation.
 367               Be aware that psnr-video.sh needs a lot of temporary space
 368               in /tmp/.
 369
 370
 371 asfinfo
 372
 373 Author:       Arpi
 374
 375 Description:  a simple ASF header display program
 376
 377 Usage:        asfinfo <filename.asf>
 378
 379 Note:         Also see MPlayer's -identify option.
 380
 381
 382 avi-fix
 383
 384 Author:       Arpi
 385
 386 Description:  A simple tool to fix chunk sizes in RIFF AVI files.
 387
 388 Usage:        avi-fix [-fix] <badfile.avi>
 389
 390 Note:         It does not check or fix the index, to do this use
 391               'mencoder -forceidx -oac copy -ovc copy'.
 392
 393
 394 bios2dump
 395
 396 Author:       Nick Kurshev
 397
 398 Description:  Extract your PC BIOS and save it to file.
 399
 400 Usage:        As argument requires DOS interrupt number in hexadecimal form.
 401               As output - will write 64KB file which will named:
 402               SSSS_OOOO.intXX
 403       where:  SSSS - segment of BIOS interrupt handler
 404               OOOO - offset of BIOS interrupt handler
 405               XX   - interrupt number which was passed as argument
 406
 407
 408 checktree.sh
 409
 410 Author:       Ivo van Poorten
 411
 412 Description:  Check the source tree for anomalies.
 413
 414 Usage:        checktree.sh -help
 415
 416 Note:         This script is meant for developers to check the current
 417               source tree and/or the patches they are working on.
 418
 419
 420 mphelp_check.py
 421
 422 Author:       Uoti Urpala
 423
 424 Description:  Check console message translations for common errors.
 425
 426 Usage:        mphelp_check.py [--missing] <master file> <files to check>
 427
 428 Note:         Compares MPlayer translation files against a master file and
 429               reports conflicting arguments, extra strings not present in
 430               the base file and (optionally) missing strings.
 431
 432
 433 cpuinfo
 434
 435 Author:       Jürgen Keil
 436
 437 Description:  the prototype ../cpuinfo.c
 438
 439 Note:         Used by configure to emulate /proc/cpuinfo on non-Linux systems.
 440
 441
 442 dump_mp4
 443
 444 Author:       Arpi
 445
 446 Description:  MPEG4-ES stream inspector, dumps the stream startcodes.
 447
 448
 449 fastmemcpybench
 450
 451 Author:       Felix Bünemann
 452
 453 Description:  benchmark/testbed for fastmemcpy stuff
 454
 455 Note:         Also see fastmem.sh.
 456
 457
 458 mem2dump
 459
 460 Author:   Nick Kurshev
 461
 462 Description:  Dump memory block to file.
 463
 464 Usage:        As argument requires absolute address of memory dump and its
 465               length (in hexadecimal form).
 466               As output - will write file which will be named:
 467               memADDR_LEN.dump
 468        where: ADDR - given address of memory
 469               LEN  - given length of memory
 470
 471
 472 movinfo
 473
 474 Author:       Arpi
 475
 476 Description:  Show QuickTime MOV file structure.
 477
 478 Usage:        movinfo <filename.mov>
 479
 480
 481 png2raw
 482
 483 Author:       Arpi
 484
 485 Description:  PNG to RAW image converter, used by .raw font creators.
 486
 487 Usage:        png2raw <file1> [file2...]
 488
 489
 490 vivodump
 491
 492 Author:       Arpi
 493
 494 Description:  Dump H.263 frame headers from VIVO files.
 495
 496 Usage:        vivodump <input_file> <output_file>
 497
 498
 499
 500 Miscellaneous scripts in the TOOLS dir
 501 --------------------------------------
 502
 503 subedit.pl
 504
 505 Author:       Michael Klepikov
 506
 507 Description:  A script for pipelined editing of subtitle files.
 508
 509 Usage:        subedit.pl [switches]
 510     -if,--input-format <fmt>   input format; supported: SRT (default: SRT)
 511     -of,--output-format <fmt>  output format; supported: SRT
 512                                (default: input format)
 513     -s,--shift <time>          shift all subtitles by <time>
 514                                (format: [-]hh:mm:ss,fraction)
 515     -c,--scale <time>          scale by adding <time> to overall duration
 516     -f,--split-from <time>     drop subtitles that end before <time>
 517     -t,--split-to <time>       drop subtitles that start after <time> (will
 518                                truncate timing if it overlaps a boundary)
 519     -r,--renumber              renumber SRT subtitles in output
 520     -d,--debug                 enable debug output
 521     -h,--help                  help message
 522
 523
 524 w32codec_dl.pl
 525
 526 Author:       Tom Lees
 527
 528 Description:  This script will use the Windows Media Player codec download
 529               infrastructure to aquire the codecs listed in codecs.conf and put
 530               them in a directory named "codecs/" below the current directory.
 531
 532 Usage:        w32codec_dl.pl <codecs.conf location>
 533
 534 Note:         You will need the libwww-perl stuff and the cabextract utility
 535               which can be found at http://www.kyz.uklinux.net/cabextract.php3.
 536
 537
 538 install-w32codecs.sh
 539
 540 Author:       Andrea Menucci, thuglife
 541
 542 Description:  Downloads binary codecs from mplayerhq.hu and installs them
 543               on a Debian system.
 544
 545 Usage:        install-w32codecs.sh install
 546               install-w32codecs.sh uninstall
 547
 548
 549 vobshift.py
 550
 551 Author:       Gábor Farkas
 552
 553 Description:  Adjust the time-info in vobsub files
 554
 555 Usage:        vobshift.py in.idx out.idx +8.3
 556               Will shift the time by 8.3 seconds
 557
 558
 559 subrip.c
 560
 561 Author:       Kim Minh Kaplan
 562
 563 Description:  Transform VOBsub subtitles into Subrip text subtitles using
 564               GOCR/JOCR.
 565
 566 Usage:        subrip <vobsub basename> [subid [output filename] ]
 567
 568 Note:         Requires at least JOCR/GOCR 0.37.
 569               You will have to change the 'vobsub_id' value if you want a
 570               subtitle different from number 0. Hint: You can view the
 571               subtitle that is being decoded with "display subtitle-*.pgm".
 572
 573
 574 alaw-gen.c
 575
 576 Author:       Arpi
 577
 578 Description:  Generates alaw/ulaw tables.
 579
 580 Note:         Created to work around a past license issue, no longer useful.
 581
 582
 583 avisubdump.c
 584
 585 Author:       Tobias Diedrich
 586
 587 Description:  Dumps vobsub soft subtitles streams embedded in AVI files.
 588
 589 Usage:        avisubdump <movie.avi>
 590
 591
 592
 593 Format conversion scripts in the TOOLS dir
 594 ------------------------------------------
 595
 596 302m_convert.c
 597
 598 Author:       Reimar Döffinger
 599
 600 Description:  Converts D-Cinema Audio (SMPTE 302M?) to WAV.
 601
 602 Usage:        302m_convert <in.302> <out.wav>
 603
 604
 605 360m_convert.c
 606
 607 Author:       Reimar Döffinger
 608
 609 Description:  Converts D-Cinema Video (MPEG-2 in GXF, SMPTE 360M) to MPEG-ES.
 610               Use -demuxer mpeges to play the converted file.
 611
 612 Usage:        360m_convert <in.gxf> <out.m2v>