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

[stefano]

Author: stefano
Date: Wed Jul 21 19:14:22 2010
New Revision: 24388

Log:
Document the buffer source.

Modified:
   trunk/doc/filters.texi

Modified: trunk/doc/filters.texi
==============================================================================
--- trunk/doc/filters.texi	Wed Jul 21 19:14:19 2010	(r24387)
+++ trunk/doc/filters.texi	Wed Jul 21 19:14:22 2010	(r24388)
@@ -229,6 +229,46 @@ Flip the input video vertically.
 
 Below is a description of the currently available video sources.
 
+ at section buffer
+
+Buffer video frames, and make them available to the filter chain.
+
+This source is mainly intended for a programmatic use, in particular
+through the interface defined in @file{libavfilter/vsr_buffer.h}.
+
+It accepts the following parameters:
+ at var{width}:@var{height}:@var{pix_fmt_string}
+
+All the parameters need to be explicitely defined.
+
+Follows the list of the accepted parameters.
+
+ at table @option
+
+ at item width, height
+Specify the width and height of the buffered video frames.
+
+ at item pix_fmt_string
+
+A string representing the pixel format of the buffered video frames.
+It may be a number corresponding to a pixel format, or a pixel format
+name.
+
+ at end table
+
+For example:
+ at example
+buffer=320:240:yuv410p
+ at end example
+
+will instruct the source to accept video frames with size 320x240 and
+with format "yuv410p". Since the pixel format with name "yuv410p"
+corresponds to the number 6 (check the enum PixelFormat definition in
+ at file{libavutil/pixfmt.h}), this example corresponds to:
+ at example
+buffer=320:240:6
+ at end example
+
 @section color
 
 Provide an uniformly colored input.