path: root/DOCS/mplayer.1

.\" MPlayer (C) 2000-2002 Arpad Gereoffy <sendmail@to.mplayer-users>
.\" This manpage was/is done by Gabucino <sendmail@to.mplayer-users>
.\" (Patches done by Jonas Jermann <sendmail@to.mplayer-users>)
.\" 
.TH "MPlayer" "1" "2002-05-13"

.SH "NAME"
mplayer \- Movie Player for Linux
.br
mencoder \- Movie Encoder for Linux

.SH "SYNOPSIS"
.B mplayer
.RB [options]\ [\fIfile\fP\ |\ \fIURL\fP\ |\ \fIplaylist\fP\ |\ \-\ ]
.br
.B mplayer
.RB [global\ options]\ \fIfile1\fP\ [specific\ options]\ [file2]\ [specific\ options]
.br
.B mplayer
.RB [global\ options]\ {\fIgroup\ of\ files\ and\ options\fP}\ [group\ specific\ options]
.br
.B mplayer
.RB [dvd|vcd|tv]://[title]\ [options]
.br
.B mplayer
.RB [mms|http|http_proxy|rtp]://URL[:port]\ [options]
.br
.B mencoder
.RB [options]\ [\fIfile\fP\ |\ \fIURL\fP\ |\ \-\ ]\ [\-o\ file]
.br
.B gmplayer
.RB [options]\ [\-skin\ skin]

.SH "DESCRIPTION"
.B mplayer
is a movie player for LINUX (runs on many other Unices, and non\-x86
CPUs, see the documentation). It plays most MPEG, VOB, AVI, OGG, VIVO, ASF/WMV, QT/MOV,
FLI, RM, NuppelVideo, yuv4mpeg, FILM, RoQ files, supported by many native, XAnim, and
Win32 DLL codecs. You can watch VideoCD, SVCD, DVD, 3ivx, DivX 3/4/5 and even WMV
movies too (and you don't need the avifile library at all!).

Another big feature of mplayer is the wide range of supported output drivers.
It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, AAlib, DirectFB, but you can use
GGI, SDL (and this way all their drivers), VESA (on every VESA compatible card, even 
without X!) and some lowlevel card-specific drivers (for Matrox, 3Dfx and Radeon) too!
.br
Most of them supports software or hardware scaling, so you can enjoy movies in fullscreen.
MPlayer supports displaying through some hardware MPEG decoder boards, such as the Siemens
DVB, DXR2 and DXR3/Hollywood+!

Nice big antialiased shaded subtitles with european/ISO 8859-1,2 (hungarian, english, czech, 
etc), cyrillic, korean fonts are supported (10 supported subtitle formats: VobSub, MicroDVD,
SubRip, SubViewer, Sami, VPlayer, RT, SSA, AQTitle and our own: MPsub).

.B mencoder
(MPlayer's Movie Encoder) is a simple movie encoder, designed to
encode MPlayer-playable movies (AVI/ASF/OGG/DVD/VCD/VOB/MPG/MOV/VIV/FLI/RM/NUV/NET)
to other MPlayer-playable formats (see below).  It encodes to DivX4 
(1, 2 or 3 passes), XviD, codecs of libavcodec, PCM/MP3/VBRMP3 audio. 
Also has stream copying abilities, a powerfull plugin system
(crop, expand, flip, postprocess, rotate, scale, rgb/yuv conversion) and more.

.B gmplayer
is MPlayer with a graphical user interface.
It has the same options as MPlayer.

.SH GENERAL NOTES
Every "flag" option has "noflag" pair, e.g. \-fs opposite is \-nofs.
.br
.B Check the html documentation too!

.SH "DEMUXER/STREAM OPTIONS"
.TP
.B \-aid <id>
Select audio channel [MPG: 0\-31 AVI: 1\-99 ASF: 0\-127 VOB: 128\-...]
.br
.I NOTE:
Use \-alang to define the language by name.
.TP
.B \-alang <audio\ stream\ language>
Usable when playing DVD disks. Expects a two\-letter country code(s) as
parameter, and always tries to play back audio streams those language
matches the given code. For example: \-alang hu,en will always try to play
hungarian or if it's non\-existant then english audio streams if there are any.
.TP
.B \-audio\-demuxer <number>
Force audio demuxer type for \-audiofile. 
Give the demuxer ID as defined in demuxers.h.
You can use \-audio\-demuxer 17 to force .mp3 detection!
.TP
.B \-audiofile <filename>
Play audio from an external file (WAV, MP3 or OggVorbis)
.TP
.B \-cdrom\-device <path\ to\ device>
Override default CDROM drive name /dev/cdrom
.TP
.B \-cache <kbytes>
This option specifies how much memory (in kbytes) to use when precaching a file/URL.
Especially useful on slow media (default is \-nocache).
.TP
.B \-chapter <chapter\ id>[-<end chapter id>]
Specify which chapter to start playing at. Optionally specify which chapter to
end playing at. Examples can be found below.
.TP
.B \-csslib <filename>
(old-style DVD option) This option is used to override the default location of libcss.so
.TP
.B \-demuxer <number>
Force demuxer type. Give the demuxer ID as defined in demuxers.h.
.TP
.B \-dumpaudio (MPLAYER only)
Dumps raw compressed audio stream to ./stream.dump (usefull with mpeg/ac3)
.TP
.B \-dumpfile <filename> (MPLAYER only)
Specify which file MPlayer should dump to. Should be used together
with \-dumpaudio/\-dumpvideo/\-dumpstream.
.TP
.B \-dumpstream (MPLAYER only)
Dumps the raw stream to ./stream.dump . Useful for example
when ripping from DVD or network.
.TP
.B \-dumpsub (MPLAYER only)
Dumps the subtitle substream from VOB streams.
.TP
.B \-dumpvideo (MPLAYER only)
Dump raw compressed video stream to ./stream.dump (not very usable)
.TP
.B \-dvd <title\ id>
Tell MPlayer which movies (marked with titleid) to play. For example
sometimes '1' are trailers, and '2' is the real movie. Sometimes deinterlacing
is required for DVD playback: see '\-pp 0x20000' or '\-npp lb' options too. 
.TP
.B \-dvd\-device <path\ to\ device>
Override default DVD device name /dev/dvd
.TP
.B \-dvdangle <angle\ id>
Some DVD discs contain scenes that can be viewed from multiple angles.
Here you can tell MPlayer which angles to use. Examples can be found below.
.TP
.B \-dvdauth <DVD\ device>
(old-style DVD option) Turns on DVD authentication using the given device.
.TP
.B \-dvdkey <CSS\ key>
(old-style DVD option) When decoding from non-DVD, this option gives the CSS key needed 
to crack the DVD (the key is printed when authenticating with DVD).
.TP
.B \-dvdnav (BETA CODE) 
Force usage of libdvdnav.
.TP
.B \-forceidx
Force rebuilding of INDEX. Useful for files with broken index (desyncs, etc).
Seeking will be possible. You can fix the index permanently with
MEncoder (see the documentation).
.TP
.B \-fps <value>
Override video frame rate (if value is wrong/missing in the header) (float number)
.TP
.B \-frames <number>
Play/convert only first <number> frames, then quit.
.TP
.B \-hr\-mp3\-seek (.MP3 only)
Hi\-res mp3 seeking. Default is: enabled when playing from external MP3 file,
as we need to seek to the very exact position to keep A/V sync. It can be slow
especially when seeking backwards \- it has to rewind to the beginning to find
the exact frame.
.TP
.B \-idx (see \-forceidx option too!)
Rebuilds INDEX of the AVI if no INDEX was found, 
thus allowing seeking. Useful with broken/incomplete
downloads, or badly created AVIs.
.TP
.B \-mc <seconds/frame>
Maximum A-V sync correction per frame (in seconds)
.TP
.B \-mf <option1:option2:...>
Used when decoding from multiple PNG or JPEG files.
(see documentation). They are:

    on            turns on multifile support
    w=<value>     width of the output (autodetect)
    h=<value>     height of the output (autodetect)
    fps=<value>   fps of the output (default: 25)
    type=<value>  type of input files (available types : jpeg, png)
.TP
.B \-ni (.AVI only)
Force usage of non\-interleaved AVI parser (fixes playing
of some bad AVI files).
.TP
.B \-nobps (.AVI only)
Don't use avg. byte/sec value for A\-V sync (AVI).
Helps with some AVI files with broken header.
.TP
.B \-skipopening
Skip dvd opening (dvdnav only).
.TP
.B \-sb <byte\ position> (see \-ss option too!)
Seek to byte position. Useful for playback from cdrom 
images / vob files with junk at the beginning.
.TP
.B \-srate <Hz>
Specifies Hz to playback audio on. Has effect on playback speed!
.TP
.B \-ss <time> (see \-sb option too!)
Seek to given time position. For example:

    \-ss 56         seeks to 56 seconds
    \-ss 01:10:00   seeks to 1 hour 10 min
.TP
.B \-tv <option1:option2:...>
This option enables the TV grabbing feature of MPlayer (see documentation). 
Available options are:

    on                use TV input
    noaudio           no sound
    driver=<value>    available: dummy, v4l
    device=<value>    specify other device than the default /dev/video0
    input=<value>     available: television, s-video, composite, etc
    freq=<value>      specify the frequency to set the tuner (e.g. 511.250)
    outfmt=<value>    output format of the tuner (rgb32, rgb24, yv12, uyvy, i420)
    width=<value>     the width of the output window
    height=<value>    the height of the output window
    norm=<value>      available: PAL, SECAM, NTSC
    channel=<value>   set the tuner to the given channel
    chanlist=<value>  available: us-bcast, us-cable, europe-west, europe-east, etc
.TP
.B \-vcd <track>
Play video cd track from device instead of plain file
.TP
.B \-vid <id>
Select video channel [MPG: 0\-15  ASF:  0\-255 ]
.TP
.B \-vivo <sub\-options> (DEBUG CODE)
Force audio parameters for the .vivo demuxer (for debugging purposes)


.SH "DECODING/FILTERING OPTIONS"
.TP
.B \-ac <codec name>
Force usage of a specific audio codec, according to its name in codecs.conf,
for example:

    \-ac mp3        use libmp3 MP3 codec
    \-ac mp3acm     use l3codeca.acm MP3 codec
    \-ac ac3        use AC3 codec
    \-ac hwac3      enable Hardware AC3 passthrough (see documentation)
    \-ac vorbis     use libvorbis
    \-ac ffmp3      use ffmpeg's MP3 decoder (SLOW)

See '\-ac help' for FULL list!
.TP
.B \-afm <1\-12> (OBSOLETE)
Force usage of a specific audio format. For example:

    \-afm 1         use libmp3 (mp2/mp3, but not mp1)
    \-afm 2         suppose raw PCM audio
    \-afm 3         use libac3
    \-afm 4         use a matching Win32 codec
    \-afm 5         use aLaw/uLaw driver
    \-afm 10        use libvorbis
    \-afm 11        use ffmpeg's MP3 decoder (even mp1)

See \-ac help for FULL list!
.TP
.B \-aspect <ratio>
Override aspect ratio of movies. It's autodetected on MPEG files, but can't be
autodetected on most AVI files. Examples:

    \-aspect 4:3  or \-aspect 1.3333
    \-aspect 16:9 or \-aspect 1.7777
.TP
.B \-flip
Flip image upside-down
.TP
.B \-nosound
Don't play/encode sound
.TP
.B \-npp <option1,option2,...>
This option allows to give more litterate options for postprocessing, 
and is another way of calling it (not with \-pp).
.br
NOTE: -npp only controls the external postprocess filter, and you HAVE TO
load it manually by '-vop pp', it is not auto-loaded!
.br
So, the usage: -vop pp -npp <options>

.I EXAMPLE:
    '\-pp 0x2007f' <=> '\-npp hb,vb,dr,al,lb'
    '\-pp 0x7f'    <=> '\-npp hb,vb,dr,al'

You can get a list of options for \-npp by executing
.I mplayer \-npp help
.br
These keywords accept a '\-' prefix to disable the option.

.I EXAMPLE:
    '\-npp de,\-al' means 'default filters without brightness/contrast correction'

A ':' followed by a letter may be appended to the option to indicate its 
scope:
    a : automatically switches the filter off if the cpu is too slow
    c : do chrominance filtering too
    y : do not do chrominance filtering (that is only luminance filtering)

Each filter defaults to 'c' (chrominance).

.I EXAMPLE:
    '\-npp de,tn:1:2:3' means 'enable default filters & temporal denoiser'
    '\-npp hb:y,vb:a \-autoq 6' means 'deblock horizontal only luminance, and
    automatically switch vertical deblocking on/off depending on available 
    cpu time'
.TP
.B \-pp <quality> (see \-npp option too!)
Apply postprocess filter on decoded image

Value given by -pp is sent to the codec, if the codec has built-in postprocess
filter (newer win32 DShow DLLs, divx4linux) otherwise the external postprocess
filter plugin (-vop pp) is auto-loaded and used.
Note, that you can use the built-in and external pp at the
same time, use -pp to set internal pp, and -vop pp=value to set up the external!

The valid range of -pp value for built-in pp filters vary on codecs, mostly
0-6, where 0=disable 6=slowest/best.

For the external pp filter, this is the numerical mode to use postprocessing. The '\-npp' option described
above has the same effects but with letters. To have several filters at the
same time, simply add the hexadecimal values.

.I EXAMPLE:
The following values are known to give good results:
    \-pp 0x20000 <=> \-npp lb (deinterlacing \- for DVD/MPEG2 playback e.g.)
    \-pp 0x7f    <=> \-npp hb,vb,dr,al (deblocking filter - for DivX)
.TP
.B \-ssf <mode> (BETA CODE)
Specifies SwScaler parameters. Available options are:

    lgb=[0..100]   gaussian blur filter (lum