summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/vf.rst304
1 files changed, 0 insertions, 304 deletions
diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst
index 617ceeea04..7f53e4ef17 100644
--- a/DOCS/man/vf.rst
+++ b/DOCS/man/vf.rst
@@ -100,159 +100,6 @@ With filters that support it, you can access parameters by their name.
Available mpv-only filters are:
-``crop[=w:h:x:y]``
- Crops the given part of the image and discards the rest. Useful to remove
- black bands from widescreen videos.
-
- ``<w>,<h>``
- Cropped width and height, defaults to original width and height.
- ``<x>,<y>``
- Position of the cropped picture, defaults to center.
-
-``expand[=w:h:x:y:aspect:round]``
- Expands (not scales) video resolution to the given value and places the
- unscaled original at coordinates x, y.
-
- ``<w>,<h>``
- Expanded width,height (default: original width,height). Negative
- values for w and h are treated as offsets to the original size.
-
- .. admonition:: Example
-
- ``expand=0:-50:0:0``
- Adds a 50 pixel border to the bottom of the picture.
-
- ``<x>,<y>``
- position of original image on the expanded image (default: center)
-
- ``<aspect>``
- Expands to fit an aspect instead of a resolution (default: 0).
-
- .. admonition:: Example
-
- ``expand=800::::4/3``
- Expands to 800x600, unless the source is higher resolution, in
- which case it expands to fill a 4/3 aspect.
-
- ``<round>``
- Rounds up to make both width and height divisible by <r> (default: 1).
-
-``flip``
- Flips the image upside down.
-
-``mirror``
- Mirrors the image on the Y axis.
-
-``rotate[=0|90|180|270]``
- Rotates the image by a multiple of 90 degrees clock-wise.
-
-``scale[=w:h:param:param2:chr-drop:noup:arnd``
- Scales the image with the software scaler (slow) and performs a YUV<->RGB
- color space conversion (see also ``--sws``).
-
- All parameters are optional.
-
- ``<w>:<h>``
- scaled width/height (default: original width/height)
-
- :0: scaled d_width/d_height
- :-1: original width/height
- :-2: Calculate w/h using the other dimension and the prescaled
- aspect ratio.
- :-3: Calculate w/h using the other dimension and the original
- aspect ratio.
- :-(n+8): Like -n above, but rounding the dimension to the closest
- multiple of 16.
-
- ``<param>[:<param2>]`` (see also ``--sws``)
- Set some scaling parameters depending on the type of scaler selected
- with ``--sws``::
-
- --sws=2 (bicubic): B (blurring) and C (ringing)
- 0.00:0.60 default
- 0.00:0.75 VirtualDub's "precise bicubic"
- 0.00:0.50 Catmull-Rom spline
- 0.33:0.33 Mitchell-Netravali spline
- 1.00:0.00 cubic B-spline
-
- --sws=7 (Gaussian): sharpness (0 (soft) - 100 (sharp))
-
- --sws=9 (Lanczos): filter length (1-10)
-
- ``<chr-drop>``
- chroma skipping
-
- :0: Use all available input lines for chroma (default).
- :1: Use only every 2. input line for chroma.
- :2: Use only every 4. input line for chroma.
- :3: Use only every 8. input line for chroma.
-
- ``<noup>``
- Disallow upscaling past the original dimensions.
-
- :0: Allow upscaling (default).
- :1: Disallow upscaling if one dimension exceeds its original value.
- :2: Disallow upscaling if both dimensions exceed their original values.
-
- ``<arnd>``
- Accurate rounding for the vertical scaler, which may be faster or
- slower than the default rounding.
-
- :no: Disable accurate rounding (default).
- :yes: Enable accurate rounding.
-
-``dsize[=w:h:aspect-method:r:aspect]``
- Changes the intended display aspect at an arbitrary point in the
- filter chain. Aspect can be given as a fraction (4/3) or floating point
- number (1.33). Note that this filter does *not* do any scaling itself; it
- just affects what later scalers (software or hardware) will do when
- auto-scaling to the correct aspect.
-
- ``<w>,<h>``
- New aspect ratio given by a display width and height. Unlike older mpv
- versions or MPlayer, this does not set the display size.
-
- Can also be these special values:
-
- :0: original display width and height
- :-1: original video width and height (default)
- :-2: Calculate w/h using the other dimension and the original display
- aspect ratio.
- :-3: Calculate w/h using the other dimension and the original video
- aspect ratio.
-
- .. admonition:: Example
-
- ``dsize=800:-2``
- Specifies a display resolution of 800x600 for a 4/3 aspect
- video, or 800x450 for a 16/9 aspect video.
-
- ``<aspect-method>``
- Modifies width and height according to original aspect ratios.
-
- :-1: Ignore original aspect ratio (default).
- :0: Keep display aspect ratio by using ``<w>`` and ``<h>`` as maximum
- resolution.
- :1: Keep display aspect ratio by using ``<w>`` and ``<h>`` as minimum
- resolution.
- :2: Keep video aspect ratio by using ``<w>`` and ``<h>`` as maximum
- resolution.
- :3: Keep video aspect ratio by using ``<w>`` and ``<h>`` as minimum
- resolution.
-
- .. admonition:: Example
-
- ``dsize=800:600:0``
- Specifies a display resolution of at most 800x600, or smaller,
- in order to keep aspect.
-
- ``<r>``
- Rounds up to make both width and height divisible by ``<r>``
- (default: 1).
-
- ``<aspect>``
- Force an aspect ratio.
-
``format=fmt=<value>:colormatrix=<value>:...``
Restricts the color space for the next filter without doing any conversion.
Use together with the scale filter for a real conversion.
@@ -425,16 +272,6 @@ Available mpv-only filters are:
``<spherical-yaw>``, ``<spherical-pitch>``, ``<spherical-roll>``
Reference angle in degree, if spherical video is used.
-``noformat[=fmt]``
- Restricts the color space for the next filter without doing any conversion.
- Unlike the format filter, this will allow any color space except the one
- you specify.
-
- .. note:: For a list of available formats, see ``noformat=fmt=help``.
-
- ``<fmt>``
- Format name, e.g. rgb15, bgr24, 420p, etc. (default: 420p).
-
``lavfi=graph[:sws-flags[:o=opts]]``
Filter video using FFmpeg's libavfilter.
@@ -484,62 +321,6 @@ Available mpv-only filters are:
``'--vf=lavfi=yadif:o="threads=2,thread_type=slice"'``
forces a specific threading configuration.
-``pullup[=jl:jr:jt:jb:sb:mp]``
- Pulldown reversal (inverse telecine) filter, capable of handling mixed
- hard-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive
- content. The ``pullup`` filter makes use of future context in making its
- decisions. It is stateless in the sense that it does not lock onto a pattern
- to follow, but it instead looks forward to the following fields in order to
- identify matches and rebuild progressive frames.
-
- ``jl``, ``jr``, ``jt``, and ``jb``
- These options set the amount of "junk" to ignore at the left, right,
- top, and bottom of the image, respectively. Left/right are in units of
- 8 pixels, while top/bottom are in units of 2 lines. The default is 8
- pixels on each side.
-
- ``sb`` (strict breaks)
- Setting this option to 1 will reduce the chances of ``pullup``
- generating an occasional mismatched frame, but it may also cause an
- excessive number of frames to be dropped during high motion sequences.
- Conversely, setting it to -1 will make ``pullup`` match fields more
- easily. This may help process video with slight blurring between the
- fields, but may also cause interlaced frames in the output.
-
- ``mp`` (metric plane)
- This option may be set to ``u`` or ``v`` to use a chroma plane instead of the
- luma plane for doing ``pullup``'s computations. This may improve accuracy
- on very clean source material, but more likely will decrease accuracy,
- especially if there is chroma noise (rainbow effect) or any grayscale
- video. The main purpose of setting ``mp`` to a chroma plane is to reduce
- CPU load and make pullup usable in realtime on slow machines.
-
-``yadif=[mode:interlaced-only]``
- Yet another deinterlacing filter
-
- ``<mode>``
- :frame: Output 1 frame for each frame.
- :field: Output 1 frame for each field (default).
- :frame-nospatial: Like ``frame`` but skips spatial interlacing check.
- :field-nospatial: Like ``field`` but skips spatial interlacing check.
-
- ``<interlaced-only>``
- :no: Deinterlace all frames.
- :yes: Only deinterlace frames marked as interlaced (default).
-
- This filter is automatically inserted when using the ``d`` key (or any
- other key that toggles the ``deinterlace`` property or when using the
- ``--deinterlace`` switch), assuming the video output does not have native
- deinterlacing support.
-
- If you just want to set the default mode, put this filter and its options
- into ``--vf-defaults`` instead, and enable deinterlacing with ``d`` or
- ``--deinterlace``.
-
- Also, note that the ``d`` key is stupid enough to insert a deinterlacer twice
- when inserting yadif with ``--vf``, so using the above methods is
- recommended.
-
``sub=[=bottom-margin:top-margin]``
Moves subtitle rendering to an arbitrary point in the filter chain, or force
subtitle rendering in the video filter as opposed to using video output OSD
@@ -558,91 +339,6 @@ Available mpv-only filters are:
subtitle colors and video under the influence of the video equalizer
settings.
-``stereo3d[=in:out]``
- Stereo3d converts between different stereoscopic image formats.
-
- ``<in>``
- Stereoscopic image format of input. Possible values:
-
- ``sbsl`` or ``side_by_side_left_first``
- side by side parallel (left eye left, right eye right)
- ``sbsr`` or ``side_by_side_right_first``
- side by side crosseye (right eye left, left eye right)
- ``abl`` or ``above_below_left_first``
- above-below (left eye above, right eye below)
- ``abr`` or ``above_below_right_first``
- above-below (right eye above, left eye below)
- ``ab2l`` or ``above_below_half_height_left_first``
- above-below with half height resolution (left eye above, right eye
- below)
- ``ab2r`` or ``above_below_half_height_right_first``
- above-below with half height resolution (right eye above, left eye
- below)
-
- ``<out>``
- Stereoscopic image format of output. Possible values are all the input
- formats as well as:
-
- ``arcg`` or ``anaglyph_red_cyan_gray``
- anaglyph red/cyan gray (red filter on left eye, cyan filter on
- right eye)
- ``arch`` or ``anaglyph_red_cyan_half_color``
- anaglyph red/cyan half colored (red filter on left eye, cyan filter
- on right eye)
- ``arcc`` or ``anaglyph_red_cyan_color``
- anaglyph red/cyan color (red filter on left eye, cyan filter on
- right eye)
- ``arcd`` or ``anaglyph_red_cyan_dubois``
- anaglyph red/cyan color optimized with the least-squares
- projection of Dubois (red filter on left eye, cyan filter on right
- eye)
- ``agmg`` or ``anaglyph_green_magenta_gray``
- anaglyph green/magenta gray (green filter on left eye, magenta
- filter on right eye)
- ``agmh`` or ``anaglyph_green_magenta_half_color``
- anaglyph green/magenta half colored (green filter on left eye,
- magenta filter on right eye)
- ``agmc`` or ``anaglyph_green_magenta_color``
- anaglyph green/magenta colored (green filter on left eye, magenta
- filter on right eye)
- ``aybg`` or ``anaglyph_yellow_blue_gray``
- anaglyph yellow/blue gray (yellow filter on left eye, blue filter
- on right eye)
- ``aybh`` or ``anaglyph_yellow_blue_half_color``
- anaglyph yellow/blue half colored (yellow filter on left eye, blue
- filter on right eye)
- ``aybc`` or ``anaglyph_yellow_blue_color``
- anaglyph yellow/blue colored (yellow filter on left eye, blue
- filter on right eye)
- ``irl`` or ``interleave_rows_left_first``
- Interleaved rows (left eye has top row, right eye starts on next
- row)
- ``irr`` or ``interleave_rows_right_first``
- Interleaved rows (right eye has top row, left eye starts on next
- row)
- ``ml`` or ``mono_left``
- mono output (left eye only)
- ``mr`` or ``mono_right``
- mono output (right eye only)
-
-``gradfun[=strength[:radius|:size=<size>]]``
- Fix the banding artifacts that are sometimes introduced into nearly flat
- regions by truncation to 8-bit color depth. Interpolates the gradients that
- should go where the bands are, and dithers them.
-
- ``<strength>``
- Maximum amount by which the filter will change any one pixel. Also the
- threshold for detecting nearly flat regions (default: 1.5).
-
- ``<radius>``
- Neighborhood to fit the gradient to. Larger radius makes for smoother
- gradients, but also prevents the filter from modifying pixels near
- detailed regions (default: disabled).
-
- ``<size>``
- size of the filter in percent of the image diagonal size. This is
- used to calculate the final radius size (default: 1).
-
``vapoursynth=file:buffered-frames:concurrent-frames``
Loads a VapourSynth filter script. This is intended for streamed
processing: mpv actually provides a source filter, instead of using a