From 1653027ac40b598cec8416da31ab4742b6ef9c4e Mon Sep 17 00:00:00 2001 From: Stefano Sabatini Date: Fri, 17 Dec 2010 14:57:29 +0000 Subject: Improve layout and clarify / complete documentation for the yadif filter. Originally committed as revision 26043 to svn://svn.ffmpeg.org/ffmpeg/trunk --- doc/filters.texi | 45 ++++++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 19 deletions(-) (limited to 'doc/filters.texi') diff --git a/doc/filters.texi b/doc/filters.texi index be3f8e180e..9efed219aa 100644 --- a/doc/filters.texi +++ b/doc/filters.texi @@ -884,34 +884,41 @@ Flip the input video vertically. @section yadif -yadif is "yet another deinterlacing filter". +Deinterlace the input video ("yadif" means "yet another deinterlacing +filter"). -It accepts the syntax: -@example -yadif=[@var{mode}[:@var{parity}]] -@end example - -@table @option +It accepts the optional parameters: @var{mode}:@var{parity}. -@item mode -Specify the interlacing mode to adopt, accepts one of the following values. +@var{mode} specifies the interlacing mode to adopt, accepts one of the +following values: -0: Output 1 frame for each frame. - -1: Output 1 frame for each field. - -2: Like 0 but skips spatial interlacing check. - -3: Like 1 but skips spatial interlacing check. +@table @option +@item 0 +output 1 frame for each frame +@item 1 +output 1 frame for each field +@item 2 +like 0 but skips spatial interlacing check +@item 3 +like 1 but skips spatial interlacing check +@end table Default value is 0. -@item parity -0 if is bottom field first, 1 if the interlaced video is top field -first, -1 to enable automatic detection. +@var{parity} specifies the picture field parity assumed for the input +interlaced video, accepts one of the following values: +@table @option +@item 0 +assume bottom field first +@item 1 +assume top field first +@item -1 +enable automatic detection @end table +Default value is -1. + @c man end VIDEO FILTERS @chapter Video Sources -- cgit v1.2.3