Merge remote-tracking branch 'qatar/master'
authorMichael Niedermayer <michaelni@gmx.at>
Sat, 15 Feb 2014 03:05:04 +0000 (04:05 +0100)
committerMichael Niedermayer <michaelni@gmx.at>
Sat, 15 Feb 2014 03:05:04 +0000 (04:05 +0100)
* qatar/master:
  lavfi doxy: add buffer{src,sink}.h to the main lavfi doxy group

Conflicts:
libavfilter/buffersink.h
libavfilter/buffersrc.h

Merged-by: Michael Niedermayer <michaelni@gmx.at>
1  2 
libavfilter/buffersink.h
libavfilter/buffersrc.h

  
  /**
   * @file
 - * memory buffer sink API
+  * @ingroup lavfi_buffersink
 + * memory buffer sink API for audio and video
   */
  
  #include "avfilter.h"
  
+ /**
+  * @defgroup lavfi_buffersink Buffer sink API
+  * @ingroup lavfi
+  * @{
+  */
  #if FF_API_AVFILTERBUFFER
  /**
 + * Get an audio/video buffer data from buffer_sink and put it in bufref.
 + *
 + * This function works with both audio and video buffer sinks.
 + *
 + * @param buffer_sink pointer to a buffersink or abuffersink context
 + * @param flags a combination of AV_BUFFERSINK_FLAG_* flags
 + * @return >= 0 in case of success, a negative AVERROR code in case of
 + * failure
 + */
 +attribute_deprecated
 +int av_buffersink_get_buffer_ref(AVFilterContext *buffer_sink,
 +                                 AVFilterBufferRef **bufref, int flags);
 +
 +/**
 + * Get the number of immediately available frames.
 + */
 +attribute_deprecated
 +int av_buffersink_poll_frame(AVFilterContext *ctx);
 +
 +/**
   * Get a buffer with filtered data from sink and put it in buf.
   *
   * @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
   * Memory buffer source API.
   */
  
 +#include "libavcodec/avcodec.h"
  #include "avfilter.h"
  
+ /**
+  * @defgroup lavfi_buffersrc Buffer source API
+  * @ingroup lavfi
+  * @{
+  */
 +enum {
 +
 +    /**
 +     * Do not check for format changes.
 +     */
 +    AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1,
 +
 +#if FF_API_AVFILTERBUFFER
 +    /**
 +     * Ignored
 +     */
 +    AV_BUFFERSRC_FLAG_NO_COPY = 2,
 +#endif
 +
 +    /**
 +     * Immediately push the frame to the output.
 +     */
 +    AV_BUFFERSRC_FLAG_PUSH = 4,
 +
 +    /**
 +     * Keep a reference to the frame.
 +     * If the frame if reference-counted, create a new reference; otherwise
 +     * copy the frame data.
 +     */
 +    AV_BUFFERSRC_FLAG_KEEP_REF = 8,
 +
 +};
 +
 +/**
 + * Add buffer data in picref to buffer_src.
 + *
 + * @param buffer_src  pointer to a buffer source context
 + * @param picref      a buffer reference, or NULL to mark EOF
 + * @param flags       a combination of AV_BUFFERSRC_FLAG_*
 + * @return            >= 0 in case of success, a negative AVERROR code
 + *                    in case of failure
 + */
 +int av_buffersrc_add_ref(AVFilterContext *buffer_src,
 +                         AVFilterBufferRef *picref, int flags);
 +
 +/**
 + * Get the number of failed requests.
 + *
 + * A failed request is when the request_frame method is called while no
 + * frame is present in the buffer.
 + * The number is reset when a frame is added.
 + */
 +unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src);
 +
  #if FF_API_AVFILTERBUFFER
  /**
   * Add a buffer to a filtergraph.
@@@ -128,22 -79,7 +135,26 @@@ int av_buffersrc_write_frame(AVFilterCo
  int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
  
  /**
 + * Add a frame to the buffer source.
 + *
 + * By default, if the frame is reference-counted, this function will take
 + * ownership of the reference(s) and reset the frame. This can be controled
 + * using the flags.
 + *
 + * If this function returns an error, the input frame is not touched.
 + *
 + * @param buffer_src  pointer to a buffer source context
 + * @param frame       a frame, or NULL to mark EOF
 + * @param flags       a combination of AV_BUFFERSRC_FLAG_*
 + * @return            >= 0 in case of success, a negative AVERROR code
 + *                    in case of failure
 + */
 +int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src,
 +                                 AVFrame *frame, int flags);
 +
 +
++/**
+  * @}
+  */
  #endif /* AVFILTER_BUFFERSRC_H */