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