[FFmpeg-devel] [PATCH 1/8] avfilter: document request_frame return codes.

[Stefano Sabatini]

On date Friday 2012-04-20 12:31:40 +0200, Nicolas George encoded:
> 
> Signed-off-by: Nicolas George <nicolas.george at normalesup.org>
> ---
>  libavfilter/avfilter.h |    7 ++++++-
>  1 files changed, 6 insertions(+), 1 deletions(-)
> 
> diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
> index fef348d..27849e2 100644
> --- a/libavfilter/avfilter.h
> +++ b/libavfilter/avfilter.h
> @@ -451,6 +451,8 @@ struct AVFilterPad {
>       * Frame request callback. A call to this should result in at least one
>       * frame being output over the given link. This should return zero on
>       * success, and another value on error.

> +     * See avfilter_request_frame for the error codes with a specific
> +     * meaning.

Nit: avfilter_request_frame() will generate a link

>       *
>       * Output video pads only.
>       */
> @@ -777,7 +779,10 @@ avfilter_get_audio_buffer_ref_from_arrays(uint8_t *data[8], int linesize[8], int
>   * Request an input frame from the filter at the other end of the link.
>   *
>   * @param link the input link
> - * @return     zero on success
> + * @return     zero on success or a negative error code; in particular:
> + *             AVERROR_EOF means that the end of frames have been reached;
> + *             AVERROR(EAGAIN) means that no frame could be immediately
> + *             produced.
>   */
>  int avfilter_request_frame(AVFilterLink *link);

Looks good oterwhise.
-- 
FFmpeg = Fast & Fundamentalist Monstrous Peaceful Elected Gadget