[FFmpeg-devel] [PATCH] vsrc_buffer: document av_vsrc_buffer_add_frame()

[Stefano Sabatini]

---
 libavfilter/vsrc_buffer.h |   24 +++++++++++++++++++++---
 1 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/libavfilter/vsrc_buffer.h b/libavfilter/vsrc_buffer.h
index 2f892ec..db5d23e 100644
--- a/libavfilter/vsrc_buffer.h
+++ b/libavfilter/vsrc_buffer.h
@@ -19,10 +19,28 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * memory buffer source API for video
+ */
+
 #include "avfilter.h"
 
-int av_vsrc_buffer_add_frame(AVFilterContext *buffer_filter,
+/**
+ * Queue a video frame to the video buffer source.
+ *
+ * @param bufsrc video source buffer context, must be a "buffer" video source context
+ * @param data pointers to the video frame plane buffers
+ * @param linesize linesizes of the video plane buffers
+ * @param interlaced non-zero if the provided frame is interlaced
+ * @param top_field_first non-zero if the provided frame is top-field-first
+ * @param sample_aspect sample aspect ratio of the provided frame
+ * @param pts presentation timestamp of the video buffer. The assumed
+ * timebase is the same configured when initializing the "buffer"
+ * video source in bufsrc.
+ * @return 0 in case of success, a negative AVERROR* code in case of failure
+ */
+int av_vsrc_buffer_add_frame(AVFilterContext *bufsrc,
                              uint8_t *data[4], int linesize[4],
                              int interlaced, int top_field_first,
-                             int64_t pts, AVRational pixel_aspect);
-
+                             int64_t pts, AVRational sample_aspect);
-- 
1.7.2.3