From 69283bc0f8905e7748343f2c5389791f858a5f4c Mon Sep 17 00:00:00 2001 From: wm4 Date: Mon, 5 Sep 2016 21:07:03 +0200 Subject: options: deprecate suboptions for the remaining AO/VOs --- DOCS/man/ao.rst | 72 +++++++++++++++++++++++------------- DOCS/man/vo.rst | 112 ++++++++++++++++++++++++++++++++------------------------ 2 files changed, 111 insertions(+), 73 deletions(-) (limited to 'DOCS/man') diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst index d39ee598ed..4583acff14 100644 --- a/DOCS/man/ao.rst +++ b/DOCS/man/ao.rst @@ -30,6 +30,8 @@ Available audio output drivers are: ``alsa`` (Linux only) ALSA audio output driver + See `ALSA audio output options`_ for options specific to this AO. + .. warning:: To get multichannel/surround audio, use ``--audio-channels=auto``. The @@ -45,11 +47,13 @@ Available audio output drivers are: ``oss`` OSS audio output driver - ```` + The following global options are supported by this audio output: + + ``--oss-device`` Sets the audio output device (default: ``/dev/dsp``). - ```` + ``--oss-mixer-device`` Sets the audio mixer device (default: ``/dev/mixer``). - ```` + ``--oss-mixer-channel`` Sets the audio mixer channel (default: ``pcm``). Other valid values include **vol, pcm, line**. For a complete list of options look for ``SOUND_DEVICE_NAMES`` in ``/usr/include/linux/soundcard.h``. @@ -91,7 +95,9 @@ Available audio output drivers are: Automatically redirects to ``coreaudio_exclusive`` when playing compressed formats. - ``change-physical-format=`` + The following global options are supported by this audio output: + + ``--coreaudio-change-physical-format=`` Change the physical format to one similar to the requested audio format (default: no). This has the advantage that multichannel audio output will actually work. The disadvantage is that it will change the @@ -99,7 +105,7 @@ Available audio output drivers are: setting in the ``Audio Devices`` dialog in the ``Audio MIDI Setup`` utility. Note that this does not affect the selected speaker setup. - ``exclusive`` + ``--coreaudio-exclusive`` Use exclusive mode access. This merely redirects to ``coreaudio_exclusive``, but should be preferred over using that AO directly. @@ -117,18 +123,20 @@ Available audio output drivers are: ``pulse`` PulseAudio audio output driver - ``host=``, ``sink=`` + The following global options are supported by this audio output: + + ``--pulse-host=``, ``--pulse-sink=`` Specify the host and optionally output sink to use. An empty string uses a local connection, "localhost" uses network transfer (most likely not what you want). - ``buffer=<1-2000|native>`` + ``--pulse-buffer=<1-2000|native>`` Set the audio buffer size in milliseconds. A higher value buffers more data, and has a lower probability of buffer underruns. A smaller value makes the audio stream react faster, e.g. to playback speed changes. Default: 250. - ``latency-hacks=`` + ``--pulse-latency-hacks=`` Enable hacks to workaround PulseAudio timing bugs (default: no). If enabled, mpv will do elaborate latency calculations on its own. If disabled, it will use PulseAudio automatically updated timing @@ -148,13 +156,15 @@ Available audio output drivers are: environments, such as systems where none of the other drivers are available. - ``buflen=`` + The following global options are supported by this audio output: + + ``--sdl-buflen=`` Sets the audio buffer length in seconds. Is used only as a hint by the sound system. Playing a file with ``-v`` will show the requested and obtained exact buffer size. A value of 0 selects the sound system default. - ``bufcnt=`` + ``--sdl-bufcnt=`` Sets the number of extra audio buffers in mpv. Usually needs not be changed. @@ -162,47 +172,51 @@ Available audio output drivers are: Produces no audio output but maintains video playback speed. Use ``--ao=null:untimed`` for benchmarking. - ``untimed`` + The following global options are supported by this audio output: + + ``--ao-null-untimed`` Do not simulate timing of a perfect audio device. This means audio decoding will go as fast as possible, instead of timing it to the system clock. - ``buffer`` + ``--ao-null-buffer`` Simulated buffer length in seconds. - ``outburst`` + ``--ao-null-outburst`` Simulated chunk size in samples. - ``speed`` + ``--ao-null-speed`` Simulated audio playback speed as a multiplier. Usually, a real audio device will not go exactly as fast as the system clock. It will deviate just a little, and this option helps to simulate this. - ``latency`` + ``--ao-null-latency`` Simulated device latency. This is additional to EOF. - ``broken-eof`` + ``--ao-null-broken-eof`` Simulate broken audio drivers, which always add the fixed device latency to the reported audio playback position. - ``broken-delay`` + ``--ao-null-broken-delay`` Simulate broken audio drivers, which don't report latency correctly. - ``channel-layouts`` + ``--ao-null-channel-layouts`` If not empty, this is a ``,`` separated list of channel layouts the AO allows. This can be used to test channel layout selection. ``pcm`` Raw PCM/WAVE file writer audio output - ``(no-)waveheader`` + The following global options are supported by this audio output: + + ``--ao-pcm-waveheader=`` Include or do not include the WAVE header (default: included). When not included, raw PCM will be generated. - ``file=`` + ``--ao-pcm-file=`` Write the sound to ```` instead of the default ``audiodump.wav``. If ``no-waveheader`` is specified, the default is ``audiodump.pcm``. - ``(no-)append`` + ``--ao-pcm-append=`` Append to the file, instead of overwriting it. Always use this with the ``no-waveheader`` option - with ``waveheader`` it's broken, because it will write a WAVE header every time the file is opened. @@ -214,11 +228,13 @@ Available audio output drivers are: confused with RoarAudio, which is something completely different. - ``host=`` + The following global options are supported by this audio output: + + ``--rsound-host=`` Set the address of the server (default: localhost). Can be either a network hostname for TCP connections or a Unix domain socket path starting with '/'. - ``port=`` + ``--rsound-port=`` Set the TCP port used for connecting to the server (default: 12345). Not used if connecting to a Unix domain socket. @@ -230,16 +246,20 @@ Available audio output drivers are: (Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel layouts.) - ``device=`` + The following global options are supported by this audio output: + + ``--ao-sndio-device=`` sndio device to use (default: ``$AUDIODEVICE``, resp. ``snd0``). ``wasapi`` Audio output to the Windows Audio Session API. - ``exclusive`` + The following global options are supported by this audio output: + + ``--ao-wasapi-exclusive`` Requests exclusive, direct hardware access. By definition prevents sound playback of any other program until mpv exits. - ``device=`` + ``--ao-wasapi-device=`` Uses the requested endpoint instead of the system's default audio endpoint. Both an ordinal number (0,1,2,...) and the GUID String are valid; the GUID string is guaranteed to not change diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst index 9df07d90dd..7eb8b28bd4 100644 --- a/DOCS/man/vo.rst +++ b/DOCS/man/vo.rst @@ -36,11 +36,13 @@ Available video output drivers are: .. note:: This driver is for compatibility with old systems. - ``adaptor=`` + The following global options are supported by this video output: + + ``--xv-adaptor=`` Select a specific XVideo adapter (check xvinfo results). - ``port=`` + ``--xv-port=`` Select a specific XVideo port. - ``ck=`` + ``--xv-ck=`` Select the source from which the color key is taken (default: cur). cur @@ -51,7 +53,7 @@ Available video output drivers are: set Same as use but also sets the supplied color key. - ``ck-method=`` + ``--xv-ck-method=`` Sets the color key drawing method (default: man). none @@ -63,11 +65,11 @@ Available video output drivers are: auto Let Xv draw the color key. - ``colorkey=`` + ``--xv-colorkey=`` Changes the color key to an RGB value of your choice. ``0x000000`` is black and ``0xffffff`` is white. - ``buffers=`` + ``--xv-buffers=`` Number of image buffers to use for the internal ringbuffer (default: 2). Increasing this will use more memory, but might help with the X server not responding quickly enough if video FPS is close to or higher than @@ -90,17 +92,19 @@ Available video output drivers are: ``chroma-deint``, ``pullup``, ``hqscaling``. These sub-options are deprecated, and you should use the ``vdpaupp`` video filter instead. - ``sharpen=<-1-1>`` + The following global options are supported by this video output: + + ``--vo-vdpau-sharpen=<-1-1>`` (Deprecated. See note about ``vdpaupp``.) For positive values, apply a sharpening algorithm to the video, for negative values a blurring algorithm (default: 0). - ``denoise=<0-1>`` + ``--vo-vdpau-denoise=<0-1>`` (Deprecated. See note about ``vdpaupp``.) Apply a noise reduction algorithm to the video (default: 0; no noise reduction). - ``deint=<-4-4>`` + ``--vo-vdpau-deint=<-4-4>`` (Deprecated. See note about ``vdpaupp``.) Select deinterlacing mode (default: 0). In older versions (as well as @@ -123,32 +127,32 @@ Available video output drivers are: 4 Motion-adaptive temporal deinterlacing with edge-guided spatial interpolation. Needs fast video hardware. - ``chroma-deint`` + ``--vo-vdpau-chroma-deint`` (Deprecated. See note about ``vdpaupp``.) Makes temporal deinterlacers operate both on luma and chroma (default). Use no-chroma-deint to solely use luma and speed up advanced deinterlacing. Useful with slow video memory. - ``pullup`` + ``--vo-vdpau-pullup`` (Deprecated. See note about ``vdpaupp``.) Try to apply inverse telecine, needs motion adaptive temporal deinterlacing. - ``hqscaling=<0-9>`` + ``--vo-vdpau-hqscaling=<0-9>`` (Deprecated. See note about ``vdpaupp``.) 0 Use default VDPAU scaling (default). 1-9 Apply high quality VDPAU scaling (needs capable hardware). - ``fps=`` + ``--vo-vdpau-fps=`` Override autodetected display refresh rate value (the value is needed for framedrop to allow video playback rates higher than display refresh rate, and for vsync-aware frame timing adjustments). Default 0 means use autodetected value. A positive value is interpreted as a refresh rate in Hz and overrides the autodetected value. A negative value disables all timing adjustment and framedrop logic. - ``composite-detect`` + ``--vo-vdpau-composite-detect`` NVIDIA's current VDPAU implementation behaves somewhat differently under a compositing window manager and does not give accurate frame timing information. With this option enabled, the player tries to @@ -159,20 +163,20 @@ Available video output drivers are: with the composited mode behavior of the NVIDIA driver, there is no hard playback speed limit even without the disabled logic. Enabled by default, use ``no-composite-detect`` to disable. - ``queuetime_windowed=`` and ``queuetime_fs=`` + ``--vo-vdpau-queuetime_windowed=`` and ``queuetime_fs=`` Use VDPAU's presentation queue functionality to queue future video frame changes at most this many milliseconds in advance (default: 50). See below for additional information. - ``output_surfaces=<2-15>`` + ``--vo-vdpau-output_surfaces=<2-15>`` Allocate this many output surfaces to display video frames (default: 3). See below for additional information. - ``colorkey=<#RRGGBB|#AARRGGBB>`` + ``--vo-vdpau-colorkey=<#RRGGBB|#AARRGGBB>`` Set the VDPAU presentation queue background color, which in practice is the colorkey used if VDPAU operates in overlay mode (default: ``#020507``, some shade of black). If the alpha component of this value is 0, the default VDPAU colorkey will be used instead (which is usually green). - ``force-yuv`` + ``--vo-vdpau-force-yuv`` Never accept RGBA input. This means mpv will insert a filter to convert to a YUV format before the VO. Sometimes useful to force availability of certain YUV-only features, like video equalizer or deinterlacing. @@ -208,29 +212,31 @@ Available video output drivers are: .. note:: Before to 0.21.0, ``direct3d_shaders`` and ``direct3d`` were different, with ``direct3d`` not using shader by default. Now both use shaders by default, and ``direct3d_shaders`` is a - deprecated alias. Use the ``prefer-stretchrect`` or the - ``disable-shaders`` sub-options to get the old behavior of - ``direct3d``. + deprecated alias. Use the ``--vo-direct3d-prefer-stretchrect`` + or the ``--vo-direct3d-disable-shaders`` options to get the old + behavior of ``direct3d``. - ``prefer-stretchrect`` + The following global options are supported by this video output: + + ``--vo-direct3d-prefer-stretchrect`` Use ``IDirect3DDevice9::StretchRect`` over other methods if possible. - ``disable-stretchrect`` + ``--vo-direct3d-disable-stretchrect`` Never render the video using ``IDirect3DDevice9::StretchRect``. - ``disable-textures`` + ``--vo-direct3d-disable-textures`` Never render the video using D3D texture rendering. Rendering with textures + shader will still be allowed. Add ``disable-shaders`` to completely disable video rendering with textures. - ``disable-shaders`` + ``--vo-direct3d-disable-shaders`` Never use shaders when rendering video. - ``only-8bit`` + ``--vo-direct3d-only-8bit`` Never render YUV video with more than 8 bits per component. Using this flag will force software conversion to 8-bit. - ``disable-texture-align`` + ``--vo-direct3d-disable-texture-align`` Normally texture sizes are always aligned to 16. With this option enabled, the video texture will always have exactly the same size as the video itself. @@ -240,11 +246,11 @@ Available video output drivers are: might crash, might cause slow downs, etc. Contact the developers if you actually need any of these for performance or proper operation. - ``force-power-of-2`` + ``--vo-direct3d-force-power-of-2`` Always force textures to power of 2, even if the device reports non-power-of-2 texture sizes as supported. - ``texture-memory=`` + ``--vo-direct3d-texture-memory=`` Only affects operation with shaders/texturing enabled, and (E)OSD. Possible values: @@ -268,11 +274,11 @@ Available video output drivers are: Use ``D3DPOOL_SCRATCH``, with a ``D3DPOOL_SYSTEMMEM`` texture for locking. - ``swap-discard`` + ``--vo-direct3d-swap-discard`` Use ``D3DSWAPEFFECT_DISCARD``, which might be faster. Might be slower too, as it must(?) clear every frame. - ``exact-backbuffer`` + ``--vo-direct3d-exact-backbuffer`` Always resize the backbuffer to window size. ``opengl`` @@ -315,10 +321,12 @@ Available video output drivers are: .. note:: This driver is for compatibility with systems that don't provide proper graphics drivers, or which support GLES only. - ``sw`` + The following global options are supported by this video output: + + ``--sdl-sw`` Continue even if a software renderer is detected. - ``switch-mode`` + ``--sdl-switch-mode`` Instruct SDL to switch the monitor video mode when going fullscreen. ``vaapi`` @@ -330,7 +338,9 @@ Available video output drivers are: .. note:: This driver is for compatibility with crappy systems. You can use vaapi hardware decoding with ``--vo=opengl`` too. - ``scaling=`` + The following global options are supported by this video output: + + ``--vo-vaapi-scaling=`` default Driver default (mpv default as well). fast @@ -340,7 +350,7 @@ Available video output drivers are: nla ``non-linear anamorphic scaling`` - ``deint-mode=`` + ``--vo-vaapi-deint-mode=`` Select deinterlacing algorithm. Note that by default deinterlacing is initially always off, and needs to be enabled with the ``d`` key (default key binding for ``cycle deinterlace``). @@ -359,7 +369,7 @@ Available video output drivers are: bob bob deinterlacing (default for older libva). - ``scaled-osd=`` + ``--vo-vaapi-scaled-osd=`` If enabled, then the OSD is rendered at video resolution and scaled to display resolution. By default, this is disabled, and the OSD is rendered at display resolution if the driver supports it. @@ -369,7 +379,9 @@ Available video output drivers are: Usually, it's better to disable video with ``--no-video`` instead. - ``fps=`` + The following global options are supported by this video output: + + ``--vo-null-fps=`` Simulate display FPS. This artificially limits how many frames the VO accepts per second. @@ -428,14 +440,16 @@ Available video output drivers are: .. note:: This driver is for compatibility with systems that don't provide working OpenGL drivers. - ``alpha`` + The following global options are supported by this video output: + + ``--vo-wayland-alpha`` Use a buffer format that supports videos and images with alpha information - ``rgb565`` + ``--vo-wayland-rgb565`` Use RGB565 as buffer format. This format is implemented on most platforms, especially on embedded where it is far more efficient then RGB8888. - ``triple-buffering`` + ``--vo-wayland-triple-buffering`` Use 3 buffers instead of 2. This can lead to more fluid playback, but uses more memory. @@ -448,22 +462,24 @@ Available video output drivers are: ``rpi`` (Raspberry Pi) Native video output on the Raspberry Pi using the MMAL API. - ``display=`` + The following global options are supported by this video output: + + ``--rpi-display=`` Select the display number on which the video overlay should be shown (default: 0). - ``layer=`` + ``--rpi-layer=`` Select the dispmanx layer on which the video overlay should be shown (default: -10). Note that mpv will also use the 2 layers above the selected layer, to handle the window background and OSD. Actual video rendering will happen on the layer above the selected layer. - ``background=`` + ``--rpi-background=`` Whether to render a black background behind the video (default: no). Normally it's better to kill the console framebuffer instead, which gives better performance. - ``osd=`` + ``--rpi-osd=`` Enabled by default. If disabled with ``no``, no OSD layer is created. This also means there will be no subtitles rendered. @@ -473,15 +489,17 @@ Available video output drivers are: environment (e.g. no X). Does not support hardware acceleration (if you need this, check the ``drm-egl`` backend for ``opengl`` VO). - ``connector=`` + The following global options are supported by this video output: + + ``--drm-connector=`` Select the connector to use (usually this is a monitor.) If set to -1, mpv renders the output on the first available connector. (default: -1) - ``devpath=`` + ``--drm-devpath=`` Path to graphic card device. (default: /dev/dri/card0) - ``mode=`` + ``--drm-mode=`` Mode ID to use (resolution, bit depth and frame rate). (default: 0) -- cgit v1.2.3