mpv/DOCS/tech/vop.txt

223 lines
9.3 KiB
Plaintext

VideoOutPlugins - Video Filters
===============
video filters are plugin-like code modules implementing the interface
defined in vf.h
basically it means video output manipulation, ie. these plugins can
modify the image and the image properties (size, colorspace etc) between
the video decoders (vd.h) and output layer (libvo or video encoders)
the actual API is a mixture of the video decoder (vd.h) and libvo
(video_out.h) APIs.
the main differences:
- vf plugins may be "loaded" multiple times, with different parameters
and context - it's new in mplayer, old APIs weren't reentrant
- vf plugins don't have to implement all functions - all funcs has
'fallback' version, so the plugins only override these if want
- each vf plugin has its own get_image context, and they can interchange
images/buffers using these get_image/put_image calls.
API details:
-- TO DO -- (see vf.h fpr API and vf_*.c for examples)
Current plugins:
================
-vop crop[=w:h:x:y]
Simple cropping plugin.
w,h (cropped width,height) defaults to original width,height
x,y (position of cropped subimage on the original image) defaults to center
MPI: EXPORT only, using stride manipulation
-vop expand[=w:h:x:y:o]
Expanding _and_ (optional) OSD rendering plugin.
w,h (expanded width,height) defaults (-1) to original width,height
x,y (position of original image on the expanded image) defaults (-1) to center
o (0=disable/1=enable SUB/OSD rendering) defaults (0) to disabled
MPI: DR (if possible) or copy
Special: mpcodecs core uses it to solve stride restrictions between filters
mencoder uses (autoload) it to render SUB/OSD
-vop flip
Flips image upside-down (vertical mirroring)
No parameters.
MPI: DR (if possible) or EXPORT, using stride manipulation
Special: dec_video autoloads it when flipping is required and libvo can't do
-vop mirror
Horizontal mirroring
No parameters.
MPI: TEMP
-vop rectangle[=w:h:x:y]
Draw a rectangle. Useful for testing crop plugin parameters.
w,h (rectangle's width and height) defaults (-1) to maximum
possible width while keeping the boundaries visible.
x,y (rectangle's top left corner position) defauts (-1) to upper
left most position.
The plugin responds to the input.conf directive "change_control"
that takes two parameters. The first parameter can be 0 for w, 1
for h, 2 for x or 3 for y. The second parameter is the amount to
change the designated rectangle boundary.
MPI: TEMP, accepts stride
-vop rotate[=x]
Rotate image +/- 90 degrees
Optional 'x' parameter (0..3) controls horizontal and vertical mirroring
MPI: TEMP
-vop scale[=w:h[:c[:p]]]
Software scaling (zoom) _and_ yuv<->rgb colorspace conversion
w,h (new width/height after scaling) defaults to original width,height
note: if -zoom is used, and underlaying filters (including libvo)
uncapable of scaling, then it defaults to d_width/d_height !
note 2: w/h values -1 means original width/height, 0 means scaled
d_width/d_height. -2/-3 means calculating w or h using the other
dimension and the original (-3) or prescaled (-2) aspect ratio.
c chroma skipping
0 -> use all available input lines for chroma
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
p scaling parameter (depends upon the used scaling method)
for -sws 2 (bicubic) its sharpness (0 (soft) - 100 (sharp))
for -sws 7 (gaussian) its sharpness (0 (soft) - 100 (sharp))
for -sws 9 (lanczos) its filter length (1 - 10)
MPI: TEMP, accepts stride
Special: dec_video and mpcodecs core autoloads it for colorspace conv.
-vop yuy2
Forced software YV12/I420 -> YUY2 conversion
(usefull for video cards/drivers with slow YV12 but fast YUY2 support)
MPI: TEMP, accepts stride
-vop rgb2bgr[=swap]
RGB 24/32 <-> BGR 24/32 colorspace conversion (default) or
RGB 24/32 <-> RGB 24/32 conversion with R<->B swapping ('swap' option)
MPI: TEMP, accepts stride
-vop palette
RGB/BGR 8 -> RGB/BGR 15/16/24/32 colorspace conversion using palette
MPI: TEMP, accepts stride
-vop format[=fourcc]
_restrict_ the list of supported colorspaces (query-format()) to a single,
given fourcc. The 'fourcc' option defaults to 'yuy2', but may be any
format name, like rgb15, bgr24, yv12 etc...
note again, it does NOT do any conversion, it just limits the _next_
plugins format list.
MPI: passthru
-vop pp=[<filterName>[:<option>[:<option>...]][/[-]<filterName>[:<option>...]]...]
Postprocessing filter. (usefull for codecs without built-in
postprocessing, like libmpeg12 or libavcodec)
see `mplayer -vop pp=help`
MPI: DR (if possible) or TEMP
Special: dec_video autoloads it if -pp option used but codec can't do pp.
-vop lavc[=quality:fps]
Fast software YV12->MPEG1 conversion, usefull for dxr3/dvb drivers
It uses libavcodec. Currently faster and better quality than -vop fame!
Param quality: fixed qscale (1<=quality<32) or bitrate (32<=quality KBits)
Param fps: force output fps (float value). If not give, or 0, it's
autodetected based on height (240,480->29.97fps, others -> 25fps)
MPI: EXPORT special
-vop fame
Fast software YV12->MPEG1 conversion, usefull for dxr3/dvb drivers
It uses libfame.
MPI: EXPORT special
-vop dvbscale[=aspect]
Setup scaling to the optimal values for the DVB card.
(use HW for X-scaling, calc sw Y scaling to keep aspect)
The 'aspect' parameter controls aspect ratio, it should be calculated
as aspect=DVB_HEIGHT*ASPECTRATIO, default is 576*(4/3)=768
(for 16:9 TV set it to 576*(16/9)=1024)
It's only usefull together with expand+scale:
-vop lavc,expand=-1:576:-1:-1:1,scale=-1:0,dvbscale
MPI: passthru
-vop cropdetect[=limit]
It's a special filter, it doesn't alter the image itself, but detects
(using some kind of heuristics) the black borders/bands of the image,
and prints the optimal -vop crop= parameters to the stdout/console.
It calculates the average value of pixel luminances for a line, and
depending on the result it's either black band (result<=limit) or
picture (result>limit). Optional parameter 'limit' defaults to 24.
MPI: EXPORT
-vop test[=first frame number]
generate various test patterns
MPI: TEMP, accepts stride
-vop noise[=lumaNoise[u][t|a][h]:chromaNoise[u][t|a][h]
add noise
0<= lumaNoise, chromaNoise <=100
u uniform noise (gaussian otherwise)
t temporal noise (noise pattern changes between frames)
a averaged temporal (smoother, but a lot slower)
h high quality (slightly better looking, slightly slower)
p mix random noise with a (semi)regular pattern
MPI: DR (if possible) or TEMP, accepts stride
-vop eq[=brightness:contrast]
software equalizer, for use with cards that don't support
brightness and contrast controls in hardware. It might also be
useful with mencoder, either for fixing poorly captured movies, or
for slightly reducing contrast to mask artifacts and get by with
lower bitrates. Initial values in the range -100..100 may be
given on the command line, and the eq filter is controllable
interactively just like with normal hardware equalizer controls.
-vop unsharp=l|cWxH:amount[:l|cWxH:amount]
unsharp mask / gaussian blur.
l apply effect on luma component
c apply effect on chroma components
WxH width and height of the matrix, odd sized in both directions
min = 3x3, max = 13x11 or 11x13
usually you will use somthing between 3x3 and 7x7
amount relative amount of sharpness / blur to add to the image
amount < 0 = blur, amount > 0 = sharpen
usually you will use something between -1.5 and 1.5
MPI: DR (if possible) or TEMP, accepts stride
-vop swapuv
swap U & V plane
MPI: EXPORT
-vop il=[d|i][s][:[d|i][s]]
(de)interleaves lines
d deinterleave
i interleave
s swap fields (exchange even & odd lines)
The goal of this filter to add ability of processing interlaced images
pre-field without deinterlacing it. You can filter your interlaced dvd
and playback on TV without breaking the interlacing.
While deinterlacing (with the post processing filter) removes permamently
the interlacing (by smoothing averaging etc) deinterleaving splits the
frame into 2 fields (so called half pictures), so you can process (filter)
them independently and then re-interleave them.
MPI: TEMP, accepts stride
-vop boxblur=radius:power[:radius:power]
radius size of the filter
power how often the filter should be applied
MPI: TEMP, accepts stride
-vop sab=radius:prefilter:colorDiff[:radius:prefilter:colorDiff]
radius blur filter strength (~0.1-4.0) (slower if larger)
prefilter prefilter strength (~0.1-2.0)
colorDiff how different the pixels are allowed to be to be considered (~0.1-100.0)
-vop smartblur=radius:stregth:threshold[:radius:stregth:threshold]
radius blur filter strength (~0.1-5.0) (slower if larger)
strength (0.0-1.0) -> blur, (-1.0-0.0) -> sharpen
threshold 0 -> filter all, (0-30) -> filter flat areas, (-30-0) -> filter edges
-vop perspective=x0:y0:x1:y1:x2:y2:x3:y3:t
x0,y0,... coordinates of the topleft, topright, bottomleft, bottomright corners
t 0-> linear, 1->cubic resampling