From 65fc530f0c3ff02f982a0e4c74988d4a53730f04 Mon Sep 17 00:00:00 2001 From: wm4 Date: Thu, 11 Oct 2012 02:04:08 +0200 Subject: Rename to "mpv" This changes the name of this project to mpv. Most user-visible mentions of "MPlayer" and "mplayer" are changed to "mpv". The binary name and the default config file location are changed as well. The new default config file location is: ~/.mpv/ Remove etc/mplayer.desktop. Apparently this was for the MPlayer GUI, which has been removed from mplayer2 ages ago. We don't have a logo, and the MS Windows resource files sort-of require one, so leave etc/mplayer.ico/.xpm as-is. Remove the debian and rpm packaging scripts. These contained outdated dependencies and likely were more harmful than useful. (Patches which add working and well-tested packaging are welcome.) --- DOCS/encoding.rst | 36 +-- DOCS/man/en/af.rst | 42 +-- DOCS/man/en/ao.rst | 4 +- DOCS/man/en/changes.rst | 17 +- DOCS/man/en/mplayer.rst | 674 ----------------------------------------------- DOCS/man/en/mpv.rst | 676 ++++++++++++++++++++++++++++++++++++++++++++++++ DOCS/man/en/options.rst | 162 ++++++------ DOCS/man/en/vo.rst | 12 +- DOCS/tech-overview.txt | 6 +- 9 files changed, 808 insertions(+), 821 deletions(-) delete mode 100644 DOCS/man/en/mplayer.rst create mode 100644 DOCS/man/en/mpv.rst (limited to 'DOCS') diff --git a/DOCS/encoding.rst b/DOCS/encoding.rst index 67ad19bae6..84b1007afd 100644 --- a/DOCS/encoding.rst +++ b/DOCS/encoding.rst @@ -3,15 +3,15 @@ General usage :: - mplayer infile -o outfile [-of outfileformat] [-ofopts formatoptions] \ + mpv infile -o outfile [-of outfileformat] [-ofopts formatoptions] \ [-ofps outfps | -oautofps] [-oharddup] [-ocopyts | -orawts] [-oneverdrop] \ - [(any other mplayer options)] \ + [(any other mpv options)] \ -ovc outvideocodec [-ovcopts outvideocodecoptions] \ -oac outaudiocodec [-oacopts outaudiocodecoptions] Help for these options is provided if giving help as parameter, as in:: - mplayer -ovc help + mpv -ovc help The suboptions of these generally are identical to ffmpeg's (as option parsing is simply delegated to ffmpeg). The option -ocopyts enables copying timestamps @@ -25,7 +25,7 @@ from the input video. Note that not all codecs and not all formats support VFR encoding, and some which do have bugs when a target bitrate is specified - use -ofps or -oautofps to force CFR encoding in these cases. -Of course, the options can be stored in a profile, like this .mplayer/config +Of course, the options can be stored in a profile, like this .mpv/config section:: [myencprofile] @@ -40,7 +40,7 @@ section:: One can then encode using this profile using the command:: - mplayer infile -o outfile.mp4 -profile myencprofile + mpv infile -o outfile.mp4 -profile myencprofile Some example profiles are provided in a file etc/encoding-example-profiles.conf; as for this, see below. @@ -54,7 +54,7 @@ for. Typical MPEG-4 Part 2 ("ASP", "DivX") encoding, AVI container:: - mplayer infile -o outfile.avi \ + mpv infile -o outfile.avi \ -ofps 25 \ -ovc mpeg4 -ovcopts qscale=4 \ -oac libmp3lame -oacopts ab=128k @@ -65,19 +65,19 @@ for NTSC) Typical MPEG-4 Part 10 ("AVC", "H.264") encoding, Matroska (MKV) container:: - mplayer infile -o outfile.mkv \ + mpv infile -o outfile.mkv \ -ovc libx264 -ovcopts preset=medium,crf=23,profile=baseline \ -oac vorbis -oacopts qscale=3 Typical MPEG-4 Part 10 ("AVC", "H.264") encoding, MPEG-4 (MP4) container:: - mplayer infile -o outfile.mp4 \ + mpv infile -o outfile.mp4 \ -ovc libx264 -ovcopts preset=medium,crf=23,profile=baseline \ -oac aac -oacopts ab=128k Typical VP8 encoding, WebM (restricted Matroska) container:: - mplayer infile -o outfile.mkv \ + mpv infile -o outfile.mkv \ -of webm \ -ovc libvpx -ovcopts qmin=6,b=1000000k \ -oac libvorbis -oacopts qscale=3 @@ -90,10 +90,10 @@ As the options for various devices can get complex, profiles can be used. An example profile file for encoding is provided in etc/encoding-example-profiles.conf in the source tree. You can include it into -your configuration by doing, from the mplayer2-build directory:: +your configuration by doing, from the mpv-build directory:: - mkdir -p ~/.mplayer - echo "include = $PWD/mplayer/etc/encoding-example-profiles.conf" >> ~/.mplayer/config + mkdir -p ~/.mpv + echo "include = $PWD/mpv/etc/encoding-example-profiles.conf" >> ~/.mpv/config Refer to the top of that file for more comments - in a nutshell, the following options are added by it:: @@ -108,7 +108,7 @@ options are added by it:: You can encode using these with a command line like:: - mplayer infile -o outfile.mp4 -profile enc-to-bb-9000 + mpv infile -o outfile.mp4 -profile enc-to-bb-9000 Of course, you are free to override options set by these profiles by specifying them after the -profile option. @@ -122,15 +122,15 @@ What works * 2-pass encoding (specify flags=+pass1 in the first pass's -ovcopts, specify flags=+pass2 in the second pass) * Hardcoding subtitles using vobsub, ass or srt subtitle rendering (just - configure mplayer for the subtitles as usual) -* Hardcoding any other mplayer OSD (e.g. time codes, using -osdlevel 3 and -vf + configure mpv for the subtitles as usual) +* Hardcoding any other mpv OSD (e.g. time codes, using -osdlevel 3 and -vf expand=::::1) * Encoding directly from a DVD, network stream, webcam, or any other source - mplayer supports + mpv supports * Using x264 presets/tunings/profiles (by using profile=, tune=, preset= in the -ovcopts) -* Deinterlacing/Inverse Telecine with any of mplayer's filters for that -* Audio file converting: mplayer -o outfile.mp3 infile.flac -novideo -oac +* Deinterlacing/Inverse Telecine with any of mpv's filters for that +* Audio file converting: mpv -o outfile.mp3 infile.flac -novideo -oac libmp3lame -oacopts ab=320k * inverse telecine filters (confirmed working: detc, pullup, filmdint) diff --git a/DOCS/man/en/af.rst b/DOCS/man/en/af.rst index dc0450241f..1fe480dcdc 100644 --- a/DOCS/man/en/af.rst +++ b/DOCS/man/en/af.rst @@ -57,7 +57,7 @@ resample[=srate[:sloppy[:type]]] *EXAMPLE*: - ``mplayer --af=resample=44100:0:0`` + ``mpv --af=resample=44100:0:0`` would set the output frequency of the resample filter to 44100Hz using exact output frequency scaling and linear interpolation. @@ -200,7 +200,7 @@ equalizer=[g1:g2:g3:...:g10] *EXAMPLE*: - ``mplayer --af=equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi`` + ``mpv --af=equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi`` Would amplify the sound in the upper and lower frequency region while canceling it almost completely around 1kHz. @@ -223,13 +223,13 @@ channels=nch[:nr:from1:to1:from2:to2:from3:to3:...] *EXAMPLE*: - ``mplayer --af=channels=4:4:0:1:1:0:2:2:3:3 media.avi`` + ``mpv --af=channels=4:4:0:1:1:0:2:2:3:3 media.avi`` Would change the number of channels to 4 and set up 4 routes that swap channel 0 and channel 1 and leave channel 2 and 3 intact. Observe that if media containing two channels was played back, channels 2 and 3 would contain silence but 0 and 1 would still be swapped. - ``mplayer --af=channels=6:4:0:0:0:1:0:2:0:3 media.avi`` + ``mpv --af=channels=6:4:0:0:0:1:0:2:0:3 media.avi`` Would change the number of channels to 6 and set up 4 routes that copy channel 0 to channels 0 to 3. Channel 4 and 5 will contain silence. @@ -242,7 +242,7 @@ format[=format] the sign (either 's' for signed or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32) and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian and 'ne' the - endianness of the computer MPlayer is running on). Valid values + endianness of the computer mpv is running on). Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'. Exceptions to this rule that are also valid format specifiers: u8, s8, floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm. @@ -260,7 +260,7 @@ volume[=v[:sc]] background is gone. This filter has a second feature: It measures the overall maximum sound - level and prints out that level when MPlayer exits. This feature currently + level and prints out that level when mpv exits. This feature currently only works with floating-point data, use e.g. ``--af-adv=force=5``, or use ``--af=stats``. @@ -281,7 +281,7 @@ volume[=v[:sc]] *EXAMPLE*: - ``mplayer --af=volume=10.1:0 media.avi`` + ``mpv --af=volume=10.1:0 media.avi`` Would amplify the sound by 10.1dB and hard-clip if the sound level is too high. @@ -306,10 +306,10 @@ pan=n[:L00:L01:L02:...L10:L11:L12:...Ln0:Ln1:Ln2:...] *EXAMPLE*: - ``mplayer --af=pan=1:0.5:0.5 media.avi`` + ``mpv --af=pan=1:0.5:0.5 media.avi`` Would down-mix from stereo to mono. - ``mplayer --af=pan=3:1:0:0.5:0:1:0.5 media.avi`` + ``mpv --af=pan=3:1:0:0.5:0:1:0.5 media.avi`` Would give 3 channel output leaving channels 0 and 1 intact, and mix channels 0 and 1 into output channel 2 (which could be sent to a subwoofer for example). @@ -338,7 +338,7 @@ sub[=fc:ch] *EXAMPLE*: - ``mplayer --af=sub=100:4 --channels=5 media.avi`` + ``mpv --af=sub=100:4 --channels=5 media.avi`` Would add a sub-woofer channel with a cutoff frequency of 100Hz to output channel 4. @@ -367,7 +367,7 @@ surround[=delay] *EXAMPLE*: - ``mplayer --af=surround=15 --channels=4 media.avi`` + ``mpv --af=surround=15 --channels=4 media.avi`` Would add surround sound decoding with 15ms delay for the sound to the rear speakers. @@ -395,7 +395,7 @@ delay[=ch1:ch2:...] *EXAMPLE*: - ``mplayer --af=delay=10.5:10.5:0:0:7:0 media.avi`` + ``mpv --af=delay=10.5:10.5:0:0:7:0 media.avi`` Would delay front left and right by 10.5ms, the two rear channels and the sub by 0ms and the center channel by 7ms. @@ -410,14 +410,14 @@ export[=mmapped_file[:nsamples]] The rest is payload (non-interleaved) 16 bit data. - file to map data to (default: ``~/.mplayer/mplayer-af_export``) + file to map data to (default: ``~/.mpv/mpv-af_export``) number of samples per channel (default: 512) *EXAMPLE*: - ``mplayer --af=export=/tmp/mplayer-af_export:1024 media.avi`` - Would export 1024 samples per channel to ``/tmp/mplayer-af_export``. + ``mpv --af=export=/tmp/mpv-af_export:1024 media.avi`` + Would export 1024 samples per channel to ``/tmp/mpv-af_export``. extrastereo[=mul] (Linearly) increases the difference between left and right channels which @@ -461,7 +461,7 @@ ladspa=file:label[:controls...] Controls are zero or more floating point values that determine the behavior of the loaded plugin (for example delay, threshold or gain). - In verbose mode (add ``-v`` to the MPlayer command line), all + In verbose mode (add ``-v`` to the mpv command line), all available controls and their valid ranges are printed. This eliminates the use of 'analyseplugin' from the LADSPA SDK. @@ -516,21 +516,21 @@ scaletempo[=option1:option2:...] *EXAMPLE*: - ``mplayer --af=scaletempo --speed=1.2 media.ogg`` + ``mpv --af=scaletempo --speed=1.2 media.ogg`` Would playback media at 1.2x normal speed, with audio at normal pitch. Changing playback speed, would change audio tempo to match. - ``mplayer --af=scaletempo=scale=1.2:speed=none --speed=1.2 media.ogg`` + ``mpv --af=scaletempo=scale=1.2:speed=none --speed=1.2 media.ogg`` Would playback media at 1.2x normal speed, with audio at normal pitch, but changing playback speed has no effect on audio tempo. - ``mplayer --af=scaletempo=stride=30:overlap=.50:search=10 media.ogg`` + ``mpv --af=scaletempo=stride=30:overlap=.50:search=10 media.ogg`` Would tweak the quality and performace parameters. - ``mplayer --af=format=floatne,scaletempo media.ogg`` + ``mpv --af=format=floatne,scaletempo media.ogg`` Would make scaletempo use float code. Maybe faster on some platforms. - ``mplayer --af=scaletempo=scale=1.2:speed=pitch audio.ogg`` + ``mpv --af=scaletempo=scale=1.2:speed=pitch audio.ogg`` Would playback audio file at 1.2x normal speed, with audio at normal pitch. Changing playback speed, would change pitch, leaving audio tempo at 1.2x. diff --git a/DOCS/man/en/ao.rst b/DOCS/man/en/ao.rst index 00dd1e9e6d..412d9ac939 100644 --- a/DOCS/man/en/ao.rst +++ b/DOCS/man/en/ao.rst @@ -9,7 +9,7 @@ syntax is: --ao= Specify a priority list of audio output drivers to be used. -If the list has a trailing ',' MPlayer will fall back on drivers not contained +If the list has a trailing ',' mpv will fall back on drivers not contained in the list. Suboptions are optional and can mostly be omitted. *NOTE*: See ``--ao=help`` for a list of compiled-in audio output drivers. @@ -48,7 +48,7 @@ jack port= Connects to the ports with the given name (default: physical ports). name= - Client name that is passed to JACK (default: MPlayer []). Useful + Client name that is passed to JACK (default: mpv []). Useful if you want to have certain connections established automatically. (no-)estimate Estimate the audio delay, supposed to make the video playback smoother diff --git a/DOCS/man/en/changes.rst b/DOCS/man/en/changes.rst index cdbfb8f0ab..5b1c3ea4a6 100644 --- a/DOCS/man/en/changes.rst +++ b/DOCS/man/en/changes.rst @@ -3,10 +3,7 @@ CHANGES FROM OTHER VERSIONS OF MPLAYER ====================================== -xxx: since I don't have a new name yet, I'm referring to this version of mplayer -as **mplayer3**, I don't intend to use that name. - -**mplayer3** is based on mplayer2, which in turn is based on the original +**mpv** is based on mplayer2, which in turn is based on the original MPlayer (also called mplayer, mplayer-svn, mplayer1). Many changes have been made. Some changes are incompatible, or completely change how the player behaves. @@ -37,7 +34,7 @@ General changes for mplayer-svn to mplayer2 * General code cleanups * Many more changes -General changes for mplayer2 to mplayer3 +General changes for mplayer2 to mpv ---------------------------------------- * Removal of lots of unneeded code to encourage developer activity (less @@ -51,9 +48,9 @@ General changes for mplayer2 to mplayer3 languages like Arabic should be better supported. * Cleaned up terminal output (nicer status line, less useless noise) * Support for playing URLs of popular streaming sites directly - (e.g. ``mplayer3 https://www.youtube.com/watch?v=...``) + (e.g. ``mpv https://www.youtube.com/watch?v=...``) * Improved OpenGL output (``vo_opengl``) -* Make ``--softvol`` default (**mplayer3** is not a mixer control panel) +* Make ``--softvol`` default (**mpv** is not a mixer control panel) * Improved support for .cue files * Screenshot improvements (can save screenshots as JPG, configurable filenames) * Removal of teletext support @@ -113,7 +110,7 @@ input.conf and slave commands Other ~~~~~ -* The playtree has been removed. **mplayer3**'s internal playlist is a simple and +* The playtree has been removed. **mpv**'s internal playlist is a simple and flat list now. This makes the code easier, and makes using it less confusing. * Slave mode is broken. This mode is entirely insane in the ``old`` versions of mplayer. A proper slave mode application needed tons of code and hacks to get @@ -123,7 +120,7 @@ Other slave mode application, and as such it's virtually impossible to improve terminal output intended for users without possibly breaking something. - This is absolutely insane, and **mplayer3** will not try to keep slave mode + This is absolutely insane, and **mpv** will not try to keep slave mode compatible. If you're a developer of a slave mode application, contact us, and a new and better protocol can be developed. @@ -152,6 +149,6 @@ Why this fork? withheld as to not turn this into a rant. * mplayer-svn rarely merged from mplayer2, and mplayer2 practically stopped merging from mplayer-svn (not even code cleanups or new features are merged) -* **mplayer3** intents to continuously merge from mplayer-svn and mplayer2, while +* **mpv** intents to continuously merge from mplayer-svn and mplayer2, while speeding up development. There is willingness for significant changes, even if this means breaking compatibility. diff --git a/DOCS/man/en/mplayer.rst b/DOCS/man/en/mplayer.rst deleted file mode 100644 index 89b03737c3..0000000000 --- a/DOCS/man/en/mplayer.rst +++ /dev/null @@ -1,674 +0,0 @@ -mplayer2 manual page -#################### - -Synopsis -======== - -| **mplayer** [options] [file|URL|-] -| **mplayer** [options] --playlist=PLAYLIST -| **mplayer** [options] files -| **mplayer** [options] {group of files and options} -| **mplayer** [bd]://[title][/device] [options] -| **mplayer** dvd://[title|[start\_title]-end\_title][/device] [options] -| **mplayer** \vcd://track[/device] -| **mplayer** \tv://[channel][/input_id] [options] -| **mplayer** radio://[channel|frequency][/capture] [options] -| **mplayer** \pvr:// [options] -| **mplayer** \dvb://[card\_number@]channel [options] -| **mplayer** \mf://[filemask|\@listfile] [-mf options] [options] -| **mplayer** [cdda|cddb]://track[-endtrack][:speed][/device] [options] -| **mplayer** [file|mms[t]|http|http\_proxy|rt[s]p|ftp|udp|unsv|icyx|noicyx|smb]:// [user:pass\@]URL[:port] [options] -| **mplayer** \sdp://file [options] -| **mplayer** \mpst://host[:port]/URL [options] -| **mplayer** \tivo://host/[list|llist|fsid] [options] - - -DESCRIPTION -=========== - -**mplayer** is a movie player for Linux. It supports a wide variety of video -file formats, audio and video codecs, and subtitle types. Special input URL -types are available to read input from a variety of sources other than disk -files. Depending on platform, a variety of different video and audio output -methods are supported. - -Usage examples to get you started quickly can be found at the end of this man -page. - - -INTERACTIVE CONTROL -=================== - -MPlayer has a fully configurable, command-driven control layer which allows you -to control MPlayer using keyboard, mouse, joystick or remote control (with -LIRC). See the ``--input`` option for ways to customize it. - -keyboard control ----------------- - -LEFT and RIGHT - Seek backward/forward 10 seconds. Shift+arrow does a 1 second exact seek - (see ``--hr-seek``; currently modifier keys like shift only work if used in - an X output window). - -UP and DOWN - Seek forward/backward 1 minute. Shift+arrow does a 5 second exact seek (see - ``--hr-seek``; currently modifier keys like shift only work if used in an X - output window). - -PGUP and PGDWN - Seek forward/backward 10 minutes. - -[ and ] - Decrease/increase current playback speed by 10%. - -{ and } - Halve/double current playback speed. - -BACKSPACE - Reset playback speed to normal. - -< and > - Go backward/forward in the playlist. - -ENTER - Go forward in the playlist, even over the end. - -p / SPACE - Pause (pressing again unpauses). - -. - Step forward. Pressing once will pause movie, every consecutive press will - play one frame and then go into pause mode again. - -q / ESC - Stop playing and quit. - -U - Stop playing (and quit if ``--idle`` is not used). - -\+ and - - Adjust audio delay by +/- 0.1 seconds. - -/ and * - Decrease/increase volume. - -9 and 0 - Decrease/increase volume. - -( and ) - Adjust audio balance in favor of left/right channel. - -m - Mute sound. - -\_ - Cycle through the available video tracks. - -\# - Cycle through the available audio tracks. - -TAB (MPEG-TS and libavformat only) - Cycle through the available programs. - -f - Toggle fullscreen (see also ``--fs``). - -T - Toggle stay-on-top (see also ``--ontop``). - -w and e - Decrease/increase pan-and-scan range. - -o - Toggle OSD states: none / seek / seek + timer / seek + timer + total time. - -d - Toggle frame dropping states: none / skip display / skip decoding (see - ``--framedrop`` and ``--hardframedrop``). - -v - Toggle subtitle visibility. - -j and J - Cycle through the available subtitles. - -y and g - Adjust subtitle delay to immediately display previous/next subtitle. - -F - Toggle displaying "forced subtitles". - -a - Toggle subtitle alignment: top / middle / bottom. - -x and z - Adjust subtitle delay by +/- 0.1 seconds. - -V - Toggle subtitle VSFilter aspect compatibility mode. See - ``--ass-vsfilter-aspect-compat`` for more info. - -C (``--capture`` only) - Start/stop capturing the primary stream. - -r and t - Move subtitles up/down. - -i (``--edlout`` mode only) - Set start or end of an EDL skip and write it out to the given file. - -s - Take a screenshot. - -S - Start/stop taking screenshots. - -I - Show filename on the OSD. - -P - Show progression bar, elapsed time and total duration on the OSD. - -! and @ - Seek to the beginning of the previous/next chapter. - -D (``--vo=vdpau``, ``--vf=yadif``, ``--vf=kerndeint`` only) - Activate/deactivate deinterlacer. - -A - Cycle through the available DVD angles. - -c - Change YUV colorspace. - -(The following keys are valid only when using a video output that supports the -corresponding adjustment, the software equalizer (``--vf=eq`` or ``--vf=eq2``) -or hue filter (``--vf=hue``).) - -1 and 2 - Adjust contrast. - -3 and 4 - Adjust brightness. - -5 and 6 - Adjust hue. - -7 and 8 - Adjust saturation. - -(The following keys are valid only when using the corevideo video output -driver.) - -command + 0 - Resize movie window to half its original size. - -command + 1 - Resize movie window to its original size. - -command + 2 - Resize movie window to double its original size. - -command + f - Toggle fullscreen (see also ``--fs``). - -command + [ and command + ] - Set movie window alpha. - -(The following keys are valid if you have a keyboard with multimedia keys.) - -PAUSE - Pause. - -STOP - Stop playing and quit. - -PREVIOUS and NEXT - Seek backward/forward 1 minute. - -(The following keys are only valid if you compiled with TV or DVB input -support and will take precedence over the keys defined above.) - -h and k - Select previous/next channel. - -n - Change norm. - -u - Change channel list. - -mouse control -------------- - -button 3 and button 4 - Seek backward/forward 1 minute. - -button 5 and button 6 - Decrease/increase volume. - -joystick control ----------------- - -left and right - Seek backward/forward 10 seconds. - -up and down - Seek forward/backward 1 minute. - -button 1 - Pause. - -button 2 - Toggle OSD states: none / seek / seek + timer / seek + timer + total time. - -button 3 and button 4 - Decrease/increase volume. - - -USAGE -===== - -Every *flag* option has a *no-flag* counterpart, e.g. the opposite of the -``--fs`` option is ``--no-fs``. ``--fs=yes`` is same as ``--fs``, ``--fs=no`` -is the same as ``--no-fs``. - -If an option is marked as *(XXX only)*, it will only work in combination with -the *XXX* option or if *XXX* is compiled in. - -| *NOTE*: The suboption parser (used for example for ``--ao=pcm`` suboptions) - supports a special kind of string-escaping intended for use with external - GUIs. -| It has the following format: -| %n%string\_of\_length\_n -| *EXAMPLES*: -| `mplayer --ao pcm:file=%10%C:test.wav test.avi` -| Or in a script: -| `mplayer --ao pcm:file=%\`expr length "$NAME"\`%"$NAME" test.avi` - - -Per-file options ----------------- - -When playing multiple files, any option given on the command line usually -affects all files. Example: - -`mplayer --a file1.mkv --b file2.mkv --c` - -+-----------+-------------------------+ -| File | Active options | -+===========+=========================+ -| file1.mkv | --a --b --c | -+-----------+-------------------------+ -| file2.mkv | --a --b --c | -+-----------+-------------------------+ - -Also, if any option is changed at runtime (via slave commands), they aren't -reset when a new file is played. - -Sometimes, it's useful to change options per-file. This can be achieved by -adding the special per-file markers `--{` and `--}`. (Note that you must -escape these on some shells.) Example: - -`mplayer --a file1.mkv --b --\\\{ --c file2.mkv --d file3.mkv --e --\\\} file4.mkv --f` - -+-----------+-------------------------+ -| File | Active options | -+===========+=========================+ -| file1.mkv | --a --b --f | -+-----------+-------------------------+ -| file2.mkv | --a --b --f --c --d --e | -+-----------+-------------------------+ -| file3.mkv | --a --b --f --c --d --e | -+-----------+-------------------------+ -| file4.mkv | --a --b --f | -+-----------+-------------------------+ - -Additionally, any file-local option changed at runtime is reset when the current -file stops playing. If option ``--c`` is changed during playback of `file2.mkv`, -it's reset when advancing to `file3.mkv`. This only affects file-local options. -The option ``--a`` is never reset here. - -CONFIGURATION FILES -=================== - -You can put all of the options in configuration files which will be read every -time MPlayer is run. The system-wide configuration file 'mplayer.conf' is in -your configuration directory (e.g. ``/etc/mplayer`` or -``/usr/local/etc/mplayer``), the user specific one is ``~/.mplayer/config``. -User specific options override system-wide options and options given on the -command line override either. The syntax of the configuration files is -``option=``, everything after a *#* is considered a comment. Options -that work without values can be enabled by setting them to *yes* or *1* or -*true* and disabled by setting them to *no* or *0* or *false*. Even suboptions -can be specified in this way. - -You can also write file-specific configuration files. If you wish to have a -configuration file for a file called 'movie.avi', create a file named -'movie.avi.conf' with the file-specific options in it and put it in -``~/.mplayer/``. You can also put the configuration file in the same directory -as the file to be played, as long as you give the ``--use-filedir-conf`` -option (either on the command line or in your global config file). If a -file-specific configuration file is found in the same directory, no -file-specific configuration is loaded from ``~/.mplayer``. In addition, the -``--use-filedir-conf`` option enables directory-specific configuration files. -For this, MPlayer first tries to load a mplayer.conf from the same directory -as the file played and then tries to load any file-specific configuration. - -*EXAMPLE MPLAYER CONFIGURATION FILE:* - -| # Use gl3 video output by default. -| vo=gl3 -| # I love practicing handstands while watching videos. -| flip=yes -| # Decode multiple files from PNG, -| # start with mf://filemask -| mf=type=png:fps=25 -| # Eerie negative images are cool. -| vf=eq2=1.0:-0.8 - - -PROFILES -======== - -To ease working with different configurations profiles can be defined in the -configuration files. A profile starts with its name between square brackets, -e.g. *[my-profile]*. All following options will be part of the profile. A -description (shown by ``--profile=help``) can be defined with the profile-desc -option. To end the profile, start another one or use the profile name -*default* to continue with normal options. - -*EXAMPLE MPLAYER PROFILE:* - -| [protocol.dvd] -| profile-desc="profile for dvd:// streams" -| vf=pp=hb/vb/dr/al/fd -| alang=en -| -| [extension.flv] -| profile-desc="profile for .flv files" -| flip=yes -| -| [ao.alsa] -| device=spdif - - -OPTIONS -======= - -.. include:: options.rst - -.. include:: ao.rst - -.. include:: vo.rst - -.. include:: af.rst - -.. include:: vf.rst - -.. include:: encode.rst - -Taking screenshots -================== - -Screenshots of the currently played file can be taken using the 'screenshot' -slave mode command, which is by default bound to the ``s`` key. Files named -``shotNNNN.png`` will be saved in the working directory, using the first -available number - no files will be overwritten. - -A screenshot will usually contain the unscaled video contents at the end of the -video filter chain. Some video output drivers will include subtitles and OSD in -the video frame as well - this is because of technical restrictions. - -The ``screenshot`` video filter is normally not required when using a -recommended GUI video output driver. The ``screenshot`` filter will be attempted -to be used if the video output doesn't support screenshots. Note that taking -screenshots with the video filter is not instant: the screenshot will be only -saved when the next video frame is displayed. This means attempting to take a -screenshot while the player is paused will do nothing, until the user unpauses -or seeks. Also, the screenshot filter is not compatible with hardware decoding, -and actually will cause initialization failure when use with hardware decoding -is attempted. Using the ``screenshot`` video filter is not recommended for -these reasons. - -.. include:: changes.rst - -ENVIRONMENT VARIABLES -===================== - -There are a number of environment variables that can be used to control the -behavior of MPlayer. - -``MPLAYER_CHARSET`` (see also ``--msgcharset``) - Convert console messages to the specified charset (default: autodetect). A - value of "noconv" means no conversion. - -``MPLAYER_HOME`` - Directory where MPlayer looks for user settings. - -``MPLAYER_LOCALEDIR`` - Directory where MPlayer looks for gettext translation files (if enabled). - -``MPLAYER_VERBOSE`` (see also ``-v`` and ``--msglevel``) - Set the initial verbosity level across all message modules (default: 0). - The resulting verbosity corresponds to that of ``--msglevel=5`` plus the - value of ``MPLAYER_VERBOSE``. - -libaf: - ``LADSPA_PATH`` - If ``LADSPA_PATH`` is set, it searches for the specified file. If it - is not set, you must supply a fully specified pathname. - - FIXME: This is also mentioned in the ladspa section. - -libdvdcss: - ``DVDCSS_CACHE`` - Specify a directory in which to store title key values. This will - speed up descrambling of DVDs which are in the cache. The - ``DVDCSS_CACHE`` directory is created if it does not exist, and a - subdirectory is created named after the DVD's title or manufacturing - date. If ``DVDCSS_CACHE`` is not set or is empty, libdvdcss will use - the default value which is ``${HOME}/.dvdcss/`` under Unix and - ``C:\Documents and Settings\$USER\Application Data\dvdcss\`` under - Win32. The special value "off" disables caching. - - ``DVDCSS_METHOD`` - Sets the authentication and decryption method that libdvdcss will use - to read scrambled discs. Can be one of title, key or disc. - - key - is the default method. libdvdcss will use a set of calculated - player keys to try and get the disc key. This can fail if the drive - does not recognize any of the player keys. - - disc - is a fallback method when key has failed. Instead of using player - keys, libdvdcss will crack the disc key using a brute force - algorithm. This process is CPU intensive and requires 64 MB of - memory to store temporary data. - - title - is the fallback when all other methods have failed. It does not - rely on a key exchange with the DVD drive, but rather uses a crypto - attack to guess the title key. On rare cases this may fail because - there is not enough encrypted data on the disc to perform a - statistical attack, but on the other hand it is the only way to - decrypt a DVD stored on a hard disc, or a DVD with the wrong region - on an RPC2 drive. - - ``DVDCSS_RAW_DEVICE`` - Specify the raw device to use. Exact usage will depend on your - operating system, the Linux utility to set up raw devices is raw(8) - for instance. Please note that on most operating systems, using a raw - device requires highly aligned buffers: Linux requires a 2048 bytes - alignment (which is the size of a DVD sector). - - ``DVDCSS_VERBOSE`` - Sets the libdvdcss verbosity level. - - :0: Outputs no messages at all. - :1: Outputs error messages to stderr. - :2: Outputs error messages and debug messages to stderr. - - ``DVDREAD_NOKEYS`` - Skip retrieving all keys on startup. Currently disabled. - - ``HOME`` - FIXME: Document this. - -libao2: - ``AUDIOSERVER`` - Specifies the Network Audio System server to which the nas audio - output driver should connect and the transport that should be used. If - unset DISPLAY is used instead. The transport can be one of tcp and - unix. Syntax is ``tcp/:``, - ``:`` or ``[unix]:``. The - NAS base port is 8000 and is added to that. - - *EXAMPLES*: - - ``AUDIOSERVER=somehost:0`` - Connect to NAS server on somehost using default port and - transport. - ``AUDIOSERVER=tcp/somehost:8000`` - Connect to NAS server on somehost listening on TCP port 8000. - ``AUDIOSERVER=(unix)?:0`` - Connect to NAS server instance 0 on localhost using unix domain - sockets. - - ``DISPLAY`` - FIXME: Document this. - -osdep: - ``TERM`` - FIXME: Document this. - -libvo: - ``DISPLAY`` - FIXME: Document this. - - ``FRAMEBUFFER`` - FIXME: Document this. - - ``HOME`` - FIXME: Document this. - -libmpdemux: - - ``HOME`` - FIXME: Document this. - - ``HOMEPATH`` - FIXME: Document this. - - ``http_proxy`` - FIXME: Document this. - - ``LOGNAME`` - FIXME: Document this. - - ``USERPROFILE`` - FIXME: Document this. - -libavformat: - - ``AUDIO_FLIP_LEFT`` - FIXME: Document this. - - ``BKTR_DEV`` - FIXME: Document this. - - ``BKTR_FORMAT`` - FIXME: Document this. - - ``BKTR_FREQUENCY`` - FIXME: Document this. - - ``http_proxy`` - FIXME: Document this. - - ``no_proxy`` - FIXME: Document this. - - -FILES -===== - -``/usr/local/etc/mplayer/mplayer.conf`` - MPlayer system-wide settings - -``~/.mplayer/config`` - MPlayer user settings - -``~/.mplayer/input.conf`` - input bindings (see ``--input=keylist`` for the full list) - -``~/.mplayer/DVDkeys/`` - cached CSS keys - - -EXAMPLES OF MPLAYER USAGE -========================= - -Quickstart Blu-ray playing: - - ``mplayer bd:////path/to/disc`` - - ``mplayer bd:// --bluray-device=/path/to/disc`` - -Quickstart DVD playing: - ``mplayer dvd://1`` - -Play in Japanese with English subtitles: - ``mplayer dvd://1 --alang=ja --slang=en`` - -Play only chapters 5, 6, 7: - ``mplayer dvd://1 --chapter=5-7`` - -Play only titles 5, 6, 7: - ``mplayer dvd://5-7`` - -Play a multiangle DVD: - ``mplayer dvd://1 --dvdangle=2`` - -Play from a different DVD device: - ``mplayer dvd://1 --dvd-device=/dev/dvd2`` - -Play DVD video from a directory with VOB files: - ``mplayer dvd://1 --dvd-device=/path/to/directory/`` - -Stream from HTTP: - ``mplayer http://mplayer.hq/example.avi`` - -Stream using RTSP: - ``mplayer rtsp://server.example.com/streamName`` - -input from standard V4L: - ``mplayer tv:// --tv=driver=v4l:width=640:height=480:outfmt=i420 --vc=rawi420 --vo=xv`` - -Play DTS-CD with passthrough: - ``mplayer --ac=hwdts --rawaudio=format=0x2001 --cdrom-device=/dev/cdrom cdda://`` - - You can also use ``--afm=hwac3`` instead of ``--ac=hwdts``. Adjust - ``/dev/cdrom`` to match the CD-ROM device on your system. If your external - receiver supports decoding raw DTS streams, you can directly play it via - ``cdda://`` without setting format, hwac3 or hwdts. - -Play a 6-channel AAC file with only two speakers: - ``mplayer --rawaudio=format=0xff --demuxer=rawaudio --af=pan=2:.32:.32:.39:.06:.06:.39:.17:-.17:-.17:.17:.33:.33 adts_he-aac160_51.aac`` - - You might want to play a bit with the pan values (e.g multiply with a - value) to increase volume or avoid clipping. - -checkerboard invert with geq filter: - ``mplayer --vf=geq='128+(p(X\,Y)-128)*(0.5-gt(mod(X/SW\,128)\,64))*(0.5-gt(mod(Y/SH\,128)\,64))*4'`` - - -AUTHORS -======= - -MPlayer was initially written by Arpad Gereoffy. See the ``AUTHORS`` file for -a list of some of the many other contributors. - -MPlayer is (C) 2000-2011 The MPlayer Team - -This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun. diff --git a/DOCS/man/en/mpv.rst b/DOCS/man/en/mpv.rst new file mode 100644 index 0000000000..2cca30c383 --- /dev/null +++ b/DOCS/man/en/mpv.rst @@ -0,0 +1,676 @@ +mpv manual page +#################### + +Synopsis +======== + +| **mpv** [options] [file|URL|-] +| **mpv** [options] --playlist=PLAYLIST +| **mpv** [options] files +| **mpv** [options] {group of files and options} +| **mpv** [bd]://[title][/device] [options] +| **mpv** dvd://[title|[start\_title]-end\_title][/device] [options] +| **mpv** \vcd://track[/device] +| **mpv** \tv://[channel][/input_id] [options] +| **mpv** radio://[channel|frequency][/capture] [options] +| **mpv** \pvr:// [options] +| **mpv** \dvb://[card\_number@]channel [options] +| **mpv** \mf://[filemask|\@listfile] [-mf options] [options] +| **mpv** [cdda|cddb]://track[-endtrack][:speed][/device] [options] +| **mpv** [file|mms[t]|http|http\_proxy|rt[s]p|ftp|udp|unsv|icyx|noicyx|smb]:// [user:pass\@]URL[:port] [options] +| **mpv** \sdp://file [options] +| **mpv** \mpst://host[:port]/URL [options] +| **mpv** \tivo://host/[list|llist|fsid] [options] + + +DESCRIPTION +=========== + +**mpv** is a movie player based on MPlayer and mplayer2. It supports a wide variety of video +file formats, audio and video codecs, and subtitle types. Special input URL +types are available to read input from a variety of sources other than disk +files. Depending on platform, a variety of different video and audio output +methods are supported. + +Usage examples to get you started quickly can be found at the end of this man +page. + + +INTERACTIVE CONTROL +=================== + +mpv has a fully configurable, command-driven control layer which allows you +to control mpv using keyboard, mouse, joystick or remote control (with +LIRC). See the ``--input`` option for ways to customize it. + +keyboard control +---------------- + +LEFT and RIGHT + Seek backward/forward 10 seconds. Shift+arrow does a 1 second exact seek + (see ``--hr-seek``; currently modifier keys like shift only work if used in + an X output window). + +UP and DOWN + Seek forward/backward 1 minute. Shift+arrow does a 5 second exact seek (see + ``--hr-seek``; currently modifier keys like shift only work if used in an X + output window). + +PGUP and PGDWN + Seek forward/backward 10 minutes. + +[ and ] + Decrease/increase current playback speed by 10%. + +{ and } + Halve/double current playback speed. + +BACKSPACE + Reset playback speed to normal. + +< and > + Go backward/forward in the playlist. + +ENTER + Go forward in the playlist, even over the end. + +p / SPACE + Pause (pressing again unpauses). + +. + Step forward. Pressing once will pause movie, every consecutive press will + play one frame and then go into pause mode again. + +q / ESC + Stop playing and quit. + +U + Stop playing (and quit if ``--idle`` is not used). + +\+ and - + Adjust audio delay by +/- 0.1 seconds. + +/ and * + Decrease/increase volume. + +9 and 0 + Decrease/increase volume. + +( and ) + Adjust audio balance in favor of left/right channel. + +m + Mute sound. + +\_ + Cycle through the available video tracks. + +\# + Cycle through the available audio tracks. + +TAB (MPEG-TS and libavformat only) + Cycle through the available programs. + +f + Toggle fullscreen (see also ``--fs``). + +T + Toggle stay-on-top (see also ``--ontop``). + +w and e + Decrease/increase pan-and-scan range. + +o + Toggle OSD states: none / seek / seek + timer / seek + timer + total time. + +d + Toggle frame dropping states: none / skip display / skip decoding (see + ``--framedrop`` and ``--hardframedrop``). + +v + Toggle subtitle visibility. + +j and J + Cycle through the available subtitles. + +y and g + Adjust subtitle delay to immediately display previous/next subtitle. + +F + Toggle displaying "forced subtitles". + +a + Toggle subtitle alignment: top / middle / bottom. + +x and z + Adjust subtitle delay by +/- 0.1 seconds. + +V + Toggle subtitle VSFilter aspect compatibility mode. See + ``--ass-vsfilter-aspect-compat`` for more info. + +C (``--capture`` only) + Start/stop capturing the primary stream. + +r and t + Move subtitles up/down. + +i (``--edlout`` mode only) + Set start or end of an EDL skip and write it out to the given file. + +s + Take a screenshot. + +S + Start/stop taking screenshots. + +I + Show filename on the OSD. + +P + Show progression bar, elapsed time and total duration on the OSD. + +! and @ + Seek to the beginning of the previous/next chapter. + +D (``--vo=vdpau``, ``--vf=yadif``, ``--vf=kerndeint`` only) + Activate/deactivate deinterlacer. + +A + Cycle through the available DVD angles. + +c + Change YUV colorspace. + +(The following keys are valid only when using a video output that supports the +corresponding adjustment, the software equalizer (``--vf=eq`` or ``--vf=eq2``) +or hue filter (``--vf=hue``).) + +1 and 2 + Adjust contrast. + +3 and 4 + Adjust brightness. + +5 and 6 + Adjust hue. + +7 and 8 + Adjust saturation. + +(The following keys are valid only when using the corevideo video output +driver.) + +command + 0 + Resize movie window to half its original size. + +command + 1 + Resize movie window to its original size. + +command + 2 + Resize movie window to double its original size. + +command + f + Toggle fullscreen (see also ``--fs``). + +command + [ and command + ] + Set movie window alpha. + +(The following keys are valid if you have a keyboard with multimedia keys.) + +PAUSE + Pause. + +STOP + Stop playing and quit. + +PREVIOUS and NEXT + Seek backward/forward 1 minute. + +(The following keys are only valid if you compiled with TV or DVB input +support and will take precedence over the keys defined above.) + +h and k + Select previous/next channel. + +n + Change norm. + +u + Change channel list. + +mouse control +------------- + +button 3 and button 4 + Seek backward/forward 1 minute. + +button 5 and button 6 + Decrease/increase volume. + +joystick control +---------------- + +left and right + Seek backward/forward 10 seconds. + +up and down + Seek forward/backward 1 minute. + +button 1 + Pause. + +button 2 + Toggle OSD states: none / seek / seek + timer / seek + timer + total time. + +button 3 and button 4 + Decrease/increase volume. + + +USAGE +===== + +Every *flag* option has a *no-flag* counterpart, e.g. the opposite of the +``--fs`` option is ``--no-fs``. ``--fs=yes`` is same as ``--fs``, ``--fs=no`` +is the same as ``--no-fs``. + +If an option is marked as *(XXX only)*, it will only work in combination with +the *XXX* option or if *XXX* is compiled in. + +| *NOTE*: The suboption parser (used for example for ``--ao=pcm`` suboptions) + supports a special kind of string-escaping intended for use with external + GUIs. +| It has the following format: +| %n%string\_of\_length\_n +| *EXAMPLES*: +| `mpv --ao pcm:file=%10%C:test.wav test.avi` +| Or in a script: +| `mpv --ao pcm:file=%\`expr length "$NAME"\`%"$NAME" test.avi` + + +Per-file options +---------------- + +When playing multiple files, any option given on the command line usually +affects all files. Example: + +`mpv --a file1.mkv --b file2.mkv --c` + ++-----------+-------------------------+ +| File | Active options | ++===========+=========================+ +| file1.mkv | --a --b --c | ++-----------+-------------------------+ +| file2.mkv | --a --b --c | ++-----------+-------------------------+ + +Also, if any option is changed at runtime (via slave commands), they aren't +reset when a new file is played. + +Sometimes, it's useful to change options per-file. This can be achieved by +adding the special per-file markers `--{` and `--}`. (Note that you must +escape these on some shells.) Example: + +`mpv --a file1.mkv --b --\\\{ --c file2.mkv --d file3.mkv --e --\\\} file4.mkv --f` + ++-----------+-------------------------+ +| File | Active options | ++===========+=========================+ +| file1.mkv | --a --b --f | ++-----------+-------------------------+ +| file2.mkv | --a --b --f --c --d --e | ++-----------+-------------------------+ +| file3.mkv | --a --b --f --c --d --e | ++-----------+-------------------------+ +| file4.mkv | --a --b --f | ++-----------+-------------------------+ + +Additionally, any file-local option changed at runtime is reset when the current +file stops playing. If option ``--c`` is changed during playback of `file2.mkv`, +it's reset when advancing to `file3.mkv`. This only affects file-local options. +The option ``--a`` is never reset here. + +CONFIGURATION FILES +=================== + +You can put all of the options in configuration files which will be read every +time mpv is run. The system-wide configuration file 'mpv.conf' is in +your configuration directory (e.g. ``/etc/mpv`` or +``/usr/local/etc/mpv``), the user specific one is ``~/.mpv/config``. +User specific options override system-wide options and options given on the +command line override either. The syntax of the configuration files is +``option=``, everything after a *#* is considered a comment. Options +that work without values can be enabled by setting them to *yes* or *1* or +*true* and disabled by setting them to *no* or *0* or *false*. Even suboptions +can be specified in this way. + +You can also write file-specific configuration files. If you wish to have a +configuration file for a file called 'movie.avi', create a file named +'movie.avi.conf' with the file-specific options in it and put it in +``~/.mpv/``. You can also put the configuration file in the same directory +as the file to be played, as long as you give the ``--use-filedir-conf`` +option (either on the command line or in your global config file). If a +file-specific configuration file is found in the same directory, no +file-specific configuration is loaded from ``~/.mpv``. In addition, the +``--use-filedir-conf`` option enables directory-specific configuration files. +For this, mpv first tries to load a mpv.conf from the same directory +as the file played and then tries to load any file-specific configuration. + +*EXAMPLE MPV CONFIGURATION FILE:* + +| # Use gl3 video output by default. +| vo=gl3 +| # I love practicing handstands while watching videos. +| flip=yes +| # Decode multiple files from PNG, +| # start with mf://filemask +| mf=type=png:fps=25 +| # Eerie negative images are cool. +| vf=eq2=1.0:-0.8 + + +PROFILES +======== + +To ease working with different configurations profiles can be defined in the +configuration files. A profile starts with its name between square brackets, +e.g. *[my-profile]*. All following options will be part of the profile. A +description (shown by ``--profile=help``) can be defined with the profile-desc +option. To end the profile, start another one or use the profile name +*default* to continue with normal options. + +*EXAMPLE MPV PROFILE:* + +| [protocol.dvd] +| profile-desc="profile for dvd:// streams" +| vf=pp=hb/vb/dr/al/fd +| alang=en +| +| [extension.flv] +| profile-desc="profile for .flv files" +| flip=yes +| +| [ao.alsa] +| device=spdif + + +OPTIONS +======= + +.. include:: options.rst + +.. include:: ao.rst + +.. include:: vo.rst + +.. include:: af.rst + +.. include:: vf.rst + +.. include:: encode.rst + +Taking screenshots +================== + +Screenshots of the currently played file can be taken using the 'screenshot' +slave mode command, which is by default bound to the ``s`` key. Files named +``shotNNNN.png`` will be saved in the working directory, using the first +available number - no files will be overwritten. + +A screenshot will usually contain the unscaled video contents at the end of the +video filter chain. Some video output drivers will include subtitles and OSD in +the video frame as well - this is because of technical restrictions. + +The ``screenshot`` video filter is normally not required when using a +recommended GUI video output driver. The ``screenshot`` filter will be attempted +to be used if the video output doesn't support screenshots. Note that taking +screenshots with the video filter is not instant: the screenshot will be only +saved when the next video frame is displayed. This means attempting to take a +screenshot while the player is paused will do nothing, until the user unpauses +or seeks. Also, the screenshot filter is not compatible with hardware decoding, +and actually will cause initialization failure when use with hardware decoding +is attempted. Using the ``screenshot`` video filter is not recommended for +these reasons. + +.. include:: changes.rst + +ENVIRONMENT VARIABLES +===================== + +There are a number of environment variables that can be used to control the +behavior of mpv. + +``MPV_CHARSET`` (see also ``--msgcharset``) + Convert console messages to the specified charset (default: autodetect). A + value of "noconv" means no conversion. + +``MPV_HOME`` + Directory where mpv looks for user settings. + +``MPV_LOCALEDIR`` + Directory where mpv looks for gettext translation files (if enabled). + +``MPV_VERBOSE`` (see also ``-v`` and ``--msglevel``) + Set the initial verbosity level across all message modules (default: 0). + The resulting verbosity corresponds to that of ``--msglevel=5`` plus the + value of ``MPV_VERBOSE``. + +libaf: + ``LADSPA_PATH`` + If ``LADSPA_PATH`` is set, it searches for the specified file. If it + is not set, you must supply a fully specified pathname. + + FIXME: This is also mentioned in the ladspa section. + +libdvdcss: + ``DVDCSS_CACHE`` + Specify a directory in which to store title key values. This will + speed up descrambling of DVDs which are in the cache. The + ``DVDCSS_CACHE`` directory is created if it does not exist, and a + subdirectory is created named after the DVD's title or manufacturing + date. If ``DVDCSS_CACHE`` is not set or is empty, libdvdcss will use + the default value which is ``${HOME}/.dvdcss/`` under Unix and + ``C:\Documents and Settings\$USER\Application Data\dvdcss\`` under + Win32. The special value "off" disables caching. + + ``DVDCSS_METHOD`` + Sets the authentication and decryption method that libdvdcss will use + to read scrambled discs. Can be one of title, key or disc. + + key + is the default method. libdvdcss will use a set of calculated + player keys to try and get the disc key. This can fail if the drive + does not recognize any of the player keys. + + disc + is a fallback method when key has failed. Instead of using player + keys, libdvdcss will crack the disc key using a brute force + algorithm. This process is CPU intensive and requires 64 MB of + memory to store temporary data. + + title + is the fallback when all other methods have failed. It does not + rely on a key exchange with the DVD drive, but rather uses a crypto + attack to guess the title key. On rare cases this may fail because + there is not enough encrypted data on the disc to perform a + statistical attack, but on the other hand it is the only way to + decrypt a DVD stored on a hard disc, or a DVD with the wrong region + on an RPC2 drive. + + ``DVDCSS_RAW_DEVICE`` + Specify the raw device to use. Exact usage will depend on your + operating system, the Linux utility to set up raw devices is raw(8) + for instance. Please note that on most operating systems, using a raw + device requires highly aligned buffers: Linux requires a 2048 bytes + alignment (which is the size of a DVD sector). + + ``DVDCSS_VERBOSE`` + Sets the libdvdcss verbosity level. + + :0: Outputs no messages at all. + :1: Outputs error messages to stderr. + :2: Outputs error messages and debug messages to stderr. + + ``DVDREAD_NOKEYS`` + Skip retrieving all keys on startup. Currently disabled. + + ``HOME`` + FIXME: Document this. + +libao2: + ``AUDIOSERVER`` + Specifies the Network Audio System server to which the nas audio + output driver should connect and the transport that should be used. If + unset DISPLAY is used instead. The transport can be one of tcp and + unix. Syntax is ``tcp/:``, + ``:`` or ``[unix]:``. The + NAS base port is 8000 and is added to that. + + *EXAMPLES*: + + ``AUDIOSERVER=somehost:0`` + Connect to NAS server on somehost using default port and + transport. + ``AUDIOSERVER=tcp/somehost:8000`` + Connect to NAS server on somehost listening on TCP port 8000. + ``AUDIOSERVER=(unix)?:0`` + Connect to NAS server instance 0 on localhost using unix domain + sockets. + + ``DISPLAY`` + FIXME: Document this. + +osdep: + ``TERM`` + FIXME: Document this. + +libvo: + ``DISPLAY`` + FIXME: Document this. + + ``FRAMEBUFFER`` + FIXME: Document this. + + ``HOME`` + FIXME: Document this. + +libmpdemux: + + ``HOME`` + FIXME: Document this. + + ``HOMEPATH`` + FIXME: Document this. + + ``http_proxy`` + FIXME: Document this. + + ``LOGNAME`` + FIXME: Document this. + + ``USERPROFILE`` + FIXME: Document this. + +libavformat: + + ``AUDIO_FLIP_LEFT`` + FIXME: Document this. + + ``BKTR_DEV`` + FIXME: Document this. + + ``BKTR_FORMAT`` + FIXME: Document this. + + ``BKTR_FREQUENCY`` + FIXME: Document this. + + ``http_proxy`` + FIXME: Document this. + + ``no_proxy`` + FIXME: Document this. + + +FILES +===== + +``/usr/local/etc/mpv/mpv.conf`` + mpv system-wide settings + +``~/.mpv/config`` + mpv user settings + +``~/.mpv/input.conf`` + input bindings (see ``--input=keylist`` for the full list) + +``~/.mpv/DVDkeys/`` + cached CSS keys + + +EXAMPLES OF MPV USAGE +========================= + +Quickstart Blu-ray playing: + - ``mpv bd:////path/to/disc`` + - ``mpv bd:// --bluray-device=/path/to/disc`` + +Quickstart DVD playing: + ``mpv dvd://1`` + +Play in Japanese with English subtitles: + ``mpv dvd://1 --alang=ja --slang=en`` + +Play only chapters 5, 6, 7: + ``mpv dvd://1 --chapter=5-7`` + +Play only titles 5, 6, 7: + ``mpv dvd://5-7`` + +Play a multiangle DVD: + ``mpv dvd://1 --dvdangle=2`` + +Play from a different DVD device: + ``mpv dvd://1 --dvd-device=/dev/dvd2`` + +Play DVD video from a directory with VOB files: + ``mpv dvd://1 --dvd-device=/path/to/directory/`` + +Stream from HTTP: + ``mpv http://mpv.hq/example.avi`` + +Stream using RTSP: + ``mpv rtsp://server.example.com/streamName`` + +input from standard V4L: + ``mpv tv:// --tv=driver=v4l:width=640:height=480:outfmt=i420 --vc=rawi420 --vo=xv`` + +Play DTS-CD with passthrough: + ``mpv --ac=hwdts --rawaudio=format=0x2001 --cdrom-device=/dev/cdrom cdda://`` + + You can also use ``--afm=hwac3`` instead of ``--ac=hwdts``. Adjust + ``/dev/cdrom`` to match the CD-ROM device on your system. If your external + receiver supports decoding raw DTS streams, you can directly play it via + ``cdda://`` without setting format, hwac3 or hwdts. + +Play a 6-channel AAC file with only two speakers: + ``mpv --rawaudio=format=0xff --demuxer=rawaudio --af=pan=2:.32:.32:.39:.06:.06:.39:.17:-.17:-.17:.17:.33:.33 adts_he-aac160_51.aac`` + + You might want to play a bit with the pan values (e.g multiply with a + value) to increase volume or avoid clipping. + +checkerboard invert with geq filter: + ``mpv --vf=geq='128+(p(X\,Y)-128)*(0.5-gt(mod(X/SW\,128)\,64))*(0.5-gt(mod(Y/SH\,128)\,64))*4'`` + + +AUTHORS +======= + +mpv is a MPlayer fork based on mplayer2, which in turn is a fork of MPlayer. + +MPlayer was initially written by Arpad Gereoffy. See the ``AUTHORS`` file for +a list of some of the many other contributors. + +MPlayer is (C) 2000-2012 The MPlayer Team + +This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun. diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst index c52c8b307e..dbac793fa9 100644 --- a/DOCS/man/en/options.rst +++ b/DOCS/man/en/options.rst @@ -14,7 +14,7 @@ Specify a priority list of audio codecs to be used, according to their codec name in codecs.conf. Use a '-' before the codec name to omit it. Use a '+' before the codec name to force it, this will likely crash! If - the list has a trailing ',' MPlayer will fall back on codecs not contained + the list has a trailing ',' mpv will fall back on codecs not contained in the list. *NOTE*: See ``--ac=help`` for a full list of available codecs. @@ -58,7 +58,7 @@ may silently fail, and the sound quality may drop. 3 Use no automatic insertion of filters and no optimization. - *Warning*: It may be possible to crash MPlayer using this setting. + *Warning*: It may be possible to crash mpv using this setting. 4 Use automatic insertion of filters according to 0 above, but use floating point processing when possible. @@ -95,15 +95,15 @@ Specify a priority list of audio languages to use. Different container formats employ different language codes. DVDs use ISO 639-1 two letter language codes, Matroska, MPEG-TS and NUT use ISO 639-2 three letter - language codes while OGM uses a free-form identifier. MPlayer prints the + language codes while OGM uses a free-form identifier. mpv prints the available languages when run in verbose (``-v``) mode. See also ``--aid``. *EXAMPLE*: - ``mplayer dvd://1 --alang=hu,en`` + ``mpv dvd://1 --alang=hu,en`` Chooses the Hungarian language track on a DVD and falls back on English if Hungarian is not available. - ``mplayer --alang=jpn example.mkv`` + ``mpv --alang=jpn example.mkv`` Plays a Matroska file in Japanese. --ao= @@ -245,11 +245,11 @@ --bluray-angle= Some Blu-ray discs contain scenes that can be viewed from multiple angles. - Here you can tell MPlayer which angles to use (default: 1). + Here you can tell mpv which angles to use (default: 1). --bluray-chapter= (Blu-ray only) - Tells MPlayer which Blu-ray chapter to start the current title from + Tells mpv which Blu-ray chapter to start the current title from (default: 1). --bluray-device= @@ -278,12 +278,12 @@ --cache-seek-min= If a seek is to be made to a position within of the cache - size from the current position, MPlayer will wait for the cache to be + size from the current position, mpv will wait for the cache to be filled to this position rather than performing a stream seek (default: 50). --cdda= - This option can be used to tune the CD Audio reading feature of MPlayer. + This option can be used to tune the CD Audio reading feature of mpv. Available options are: @@ -323,7 +323,7 @@ Specify the CD-ROM device (default: ``/dev/cdrom``). --channels= - Request the number of playback channels (default: 2). MPlayer asks the + Request the number of playback channels (default: 2). mpv asks the decoder to decode the audio into as many channels as specified. Then it is up to the decoder to fulfill the requirement. This is usually only important when playing videos with AC-3 audio (like DVDs). In that case @@ -457,7 +457,7 @@ assumed to be in Netscape format. --correct-pts, --no-correct-pts - Switches MPlayer to a mode where timestamps for video frames are + Switches mpv to a mode where timestamps for video frames are calculated differently and video filters which add new frames or modify timestamps of existing ones are supported. Now enabled automatically for most common file formats. The more accurate timestamps can be visible for @@ -502,10 +502,10 @@ override the default ones: :card=<1-4>: Specifies using card number 1-4 (default: 1). - :file=: Instructs MPlayer to read the channels list from + :file=: Instructs mpv to read the channels list from . Default is - ``~/.mplayer/channels.conf.{sat,ter,cbl,atsc}`` (based - on your card type) or ``~/.mplayer/channels.conf`` as a + ``~/.mpv/channels.conf.{sat,ter,cbl,atsc}`` (based + on your card type) or ``~/.mpv/channels.conf`` as a last resort. :timeout=<1-30>: Maximum number of seconds to wait when trying to tune a frequency before giving up (default: 30). @@ -519,7 +519,7 @@ Try to limit DVD speed (default: 0, no change). DVD base speed is 1385 kB/s, so a 8x drive can read at speeds up to 11080 kB/s. Slower speeds make the drive more quiet. For watching DVDs 2700 kB/s should be quiet and - fast enough. MPlayer resets the speed to the drive default value on close. + fast enough. mpv resets the speed to the drive default value on close. Values of at least 100 mean speed in kB/s. Values less than 100 mean multiples of 1385 kB/s, i.e. ``--dvd-speed=8`` selects 11080 kB/s. @@ -527,12 +527,12 @@ --dvdangle= Some DVD discs contain scenes that can be viewed from multiple angles. - Here you can tell MPlayer which angles to use (default: 1). + Here you can tell mpv which angles to use (default: 1). --edition= (Matroska files only) Specify the edition (set of chapters) to use, where 0 is the first. If set - to -1 (the default), MPlayer will choose the first edition declared as a + to -1 (the default), mpv will choose the first edition declared as a default, or if there is no default, the first edition defined. --edlout= @@ -611,16 +611,16 @@ specify a particular font. See also ``--subfont``. With fontconfig enabled the argument is a fontconfig pattern and the default is ``sans``. Without fontconfig the argument is a filename and the default is - ``~/.mplayer/subfont.ttf``. + ``~/.mpv/subfont.ttf``. *EXAMPLE*: - - ``--font=~/.mplayer/arialuni.ttf`` (no fontconfig) + - ``--font=~/.mpv/arialuni.ttf`` (no fontconfig) - ``--font='Bitstream Vera Sans'`` (usual case with fontconfig) - ``--font='Bitstream Vera Sans:style=Bold'`` (usual case with fontconfig) --force-window-position - Forcefully move MPlayer's video output window to default location whenever + Forcefully move mpv's video output window to default location whenever there is a change in video parameters, video stream or file. This used to be the default behavior. Currently only affects X11 VOs. @@ -760,7 +760,7 @@ Command that is executed every 30 seconds during playback via *system()* - i.e. using the shell. - *NOTE*: mplayer uses this command without any checking, it is your + *NOTE*: mpv uses this command without any checking, it is your responsibility to ensure