lavfi doxy: add buffer{src,sink}.h to the main lavfi doxy group
[ffmpeg.git] / libavfilter / buffersink.h
index 75cea35..83a8bd9 100644 (file)
 
 /**
  * @file
+ * @ingroup lavfi_buffersink
  * memory buffer sink API
  */
 
 #include "avfilter.h"
 
+/**
+ * @defgroup lavfi_buffersink Buffer sink API
+ * @ingroup lavfi
+ * @{
+ */
+
 #if FF_API_AVFILTERBUFFER
 /**
  * Get a buffer with filtered data from sink and put it in buf.
@@ -70,8 +77,12 @@ int av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
  * @param frame pointer to an allocated frame that will be filled with data.
  *              The data must be freed using av_frame_unref() / av_frame_free()
  *
- * @return >= 0 in case of success, a negative AVERROR code in case of
- *         failure.
+ * @return
+ *         - >= 0 if a frame was successfully returned.
+ *         - AVERROR(EAGAIN) if no frames are available at this point; more
+ *           input frames must be added to the filtergraph to get more output.
+ *         - AVERROR_EOF if there will be no more output frames on this sink.
+ *         - A different negative AVERROR code in other failure cases.
  */
 int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame);
 
@@ -86,9 +97,16 @@ int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame);
  *              frame will contain exactly nb_samples audio samples, except at
  *              the end of stream, when it can contain less than nb_samples.
  *
+ * @return The return codes have the same meaning as for
+ *         av_buffersink_get_samples().
+ *
  * @warning do not mix this function with av_buffersink_get_frame(). Use only one or
  * the other with a single sink, not both.
  */
 int av_buffersink_get_samples(AVFilterContext *ctx, AVFrame *frame, int nb_samples);
 
+/**
+ * @}
+ */
+
 #endif /* AVFILTER_BUFFERSINK_H */