3 * This file is part of FFmpeg.
5 * FFmpeg is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * FFmpeg is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with FFmpeg; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 #ifndef AVFILTER_BUFFERSRC_H
21 #define AVFILTER_BUFFERSRC_H
25 * @ingroup lavfi_buffersrc
26 * Memory buffer source API.
29 #include "libavcodec/avcodec.h"
33 * @defgroup lavfi_buffersrc Buffer source API
41 * Do not check for format changes.
43 AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1,
46 * Immediately push the frame to the output.
48 AV_BUFFERSRC_FLAG_PUSH = 4,
51 * Keep a reference to the frame.
52 * If the frame if reference-counted, create a new reference; otherwise
53 * copy the frame data.
55 AV_BUFFERSRC_FLAG_KEEP_REF = 8,
60 * Get the number of failed requests.
62 * A failed request is when the request_frame method is called while no
63 * frame is present in the buffer.
64 * The number is reset when a frame is added.
66 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src);
69 * Add a frame to the buffer source.
71 * @param ctx an instance of the buffersrc filter
72 * @param frame frame to be added. If the frame is reference counted, this
73 * function will make a new reference to it. Otherwise the frame data will be
76 * @return 0 on success, a negative AVERROR on error
78 * This function is equivalent to av_buffersrc_add_frame_flags() with the
79 * AV_BUFFERSRC_FLAG_KEEP_REF flag.
82 int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
85 * Add a frame to the buffer source.
87 * @param ctx an instance of the buffersrc filter
88 * @param frame frame to be added. If the frame is reference counted, this
89 * function will take ownership of the reference(s) and reset the frame.
90 * Otherwise the frame data will be copied. If this function returns an error,
91 * the input frame is not touched.
93 * @return 0 on success, a negative AVERROR on error.
95 * @note the difference between this function and av_buffersrc_write_frame() is
96 * that av_buffersrc_write_frame() creates a new reference to the input frame,
97 * while this function takes ownership of the reference passed to it.
99 * This function is equivalent to av_buffersrc_add_frame_flags() without the
100 * AV_BUFFERSRC_FLAG_KEEP_REF flag.
102 av_warn_unused_result
103 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
106 * Add a frame to the buffer source.
108 * By default, if the frame is reference-counted, this function will take
109 * ownership of the reference(s) and reset the frame. This can be controlled
112 * If this function returns an error, the input frame is not touched.
114 * @param buffer_src pointer to a buffer source context
115 * @param frame a frame, or NULL to mark EOF
116 * @param flags a combination of AV_BUFFERSRC_FLAG_*
117 * @return >= 0 in case of success, a negative AVERROR code
120 av_warn_unused_result
121 int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src,
122 AVFrame *frame, int flags);
129 #endif /* AVFILTER_BUFFERSRC_H */