624057df3f
This adds av_warn_unused_result whenever it is relevant. Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com> Signed-off-by: Ronald S. Bultje <rsbultje@gmail.com>
130 lines
3.8 KiB
C
130 lines
3.8 KiB
C
/*
|
|
*
|
|
* This file is part of FFmpeg.
|
|
*
|
|
* FFmpeg is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* FFmpeg is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with FFmpeg; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef AVFILTER_BUFFERSRC_H
|
|
#define AVFILTER_BUFFERSRC_H
|
|
|
|
/**
|
|
* @file
|
|
* @ingroup lavfi_buffersrc
|
|
* 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,
|
|
|
|
/**
|
|
* 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,
|
|
|
|
};
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* Add a frame to the buffer source.
|
|
*
|
|
* @param ctx an instance of the buffersrc filter
|
|
* @param frame frame to be added. If the frame is reference counted, this
|
|
* function will make a new reference to it. Otherwise the frame data will be
|
|
* copied.
|
|
*
|
|
* @return 0 on success, a negative AVERROR on error
|
|
*
|
|
* This function is equivalent to av_buffersrc_add_frame_flags() with the
|
|
* AV_BUFFERSRC_FLAG_KEEP_REF flag.
|
|
*/
|
|
av_warn_unused_result
|
|
int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
|
|
|
|
/**
|
|
* Add a frame to the buffer source.
|
|
*
|
|
* @param ctx an instance of the buffersrc filter
|
|
* @param frame frame to be added. If the frame is reference counted, this
|
|
* function will take ownership of the reference(s) and reset the frame.
|
|
* Otherwise the frame data will be copied. If this function returns an error,
|
|
* the input frame is not touched.
|
|
*
|
|
* @return 0 on success, a negative AVERROR on error.
|
|
*
|
|
* @note the difference between this function and av_buffersrc_write_frame() is
|
|
* that av_buffersrc_write_frame() creates a new reference to the input frame,
|
|
* while this function takes ownership of the reference passed to it.
|
|
*
|
|
* This function is equivalent to av_buffersrc_add_frame_flags() without the
|
|
* AV_BUFFERSRC_FLAG_KEEP_REF flag.
|
|
*/
|
|
av_warn_unused_result
|
|
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 controlled
|
|
* 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
|
|
*/
|
|
av_warn_unused_result
|
|
int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src,
|
|
AVFrame *frame, int flags);
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* AVFILTER_BUFFERSRC_H */
|