[FFmpeg-cvslog] r26043 - trunk/doc/filters.texi

[stefano]

Author: stefano
Date: Fri Dec 17 15:57:29 2010
New Revision: 26043

Log:
Improve layout and clarify / complete documentation for the yadif
filter.

Modified:
   trunk/doc/filters.texi

Modified: trunk/doc/filters.texi
==============================================================================
--- trunk/doc/filters.texi	Fri Dec 17 15:16:13 2010	(r26042)
+++ trunk/doc/filters.texi	Fri Dec 17 15:57:29 2010	(r26043)
@@ -884,34 +884,41 @@ Flip the input video vertically.
 
 @section yadif
 
-yadif is "yet another deinterlacing filter".
-
-It accepts the syntax:
- at example
-yadif=[@var{mode}[:@var{parity}]]
- at end example
-
- at table @option
-
- at item mode
-Specify the interlacing mode to adopt, accepts one of the following values.
-
-0: Output 1 frame for each frame.
+Deinterlace the input video ("yadif" means "yet another deinterlacing
+filter").
 
-1: Output 1 frame for each field.
+It accepts the optional parameters: @var{mode}:@var{parity}.
 
-2: Like 0 but skips spatial interlacing check.
+ at var{mode} specifies the interlacing mode to adopt, accepts one of the
+following values:
 
-3: Like 1 but skips spatial interlacing check.
+ at table @option
+ at item 0
+output 1 frame for each frame
+ at item 1
+output 1 frame for each field
+ at item 2
+like 0 but skips spatial interlacing check
+ at item 3
+like 1 but skips spatial interlacing check
+ at end table
 
 Default value is 0.
 
- at item parity
-0 if is bottom field first, 1 if the interlaced video is top field
-first, -1 to enable automatic detection.
+ at var{parity} specifies the picture field parity assumed for the input
+interlaced video, accepts one of the following values:
 
+ at table @option
+ at item 0
+assume bottom field first
+ at item 1
+assume top field first
+ at item -1
+enable automatic detection
 @end table
 
+Default value is -1.
+
 @c man end VIDEO FILTERS
 
 @chapter Video Sources