[FFmpeg-devel] [PATCH 5/5] Document the buffer source.

[Stefano Sabatini]

---
 doc/filters.texi |   41 +++++++++++++++++++++++++++++++++++++++++
 1 files changed, 41 insertions(+), 0 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 6b0a85c..ba7862a 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -229,6 +229,47 @@ 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 API interface defined in
+ at 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.
-- 
1.6.0.4