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 * Memory buffer source API.
28 #include "libavcodec/avcodec.h"
34 * Do not check for format changes.
36 AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1,
38 #if FF_API_AVFILTERBUFFER
42 AV_BUFFERSRC_FLAG_NO_COPY = 2,
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 * Add buffer data in picref to buffer_src.
62 * @param buffer_src pointer to a buffer source context
63 * @param picref a buffer reference, or NULL to mark EOF
64 * @param flags a combination of AV_BUFFERSRC_FLAG_*
65 * @return >= 0 in case of success, a negative AVERROR code
68 int av_buffersrc_add_ref(AVFilterContext *buffer_src,
69 AVFilterBufferRef *picref, int flags);
72 * Get the number of failed requests.
74 * A failed request is when the request_frame method is called while no
75 * frame is present in the buffer.
76 * The number is reset when a frame is added.
78 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src);
80 #if FF_API_AVFILTERBUFFER
82 * Add a buffer to a filtergraph.
84 * @param ctx an instance of the buffersrc filter
85 * @param buf buffer containing frame data to be passed down the filtergraph.
86 * This function will take ownership of buf, the user must not free it.
87 * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
89 * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
92 int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
96 * Add a frame to the buffer source.
98 * @param ctx an instance of the buffersrc filter
99 * @param frame frame to be added. If the frame is reference counted, this
100 * function will make a new reference to it. Otherwise the frame data will be
103 * @return 0 on success, a negative AVERROR on error
105 * This function is equivalent to av_buffersrc_add_frame_flags() with the
106 * AV_BUFFERSRC_FLAG_KEEP_REF flag.
108 int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
111 * Add a frame to the buffer source.
113 * @param ctx an instance of the buffersrc filter
114 * @param frame frame to be added. If the frame is reference counted, this
115 * function will take ownership of the reference(s) and reset the frame.
116 * Otherwise the frame data will be copied. If this function returns an error,
117 * the input frame is not touched.
119 * @return 0 on success, a negative AVERROR on error.
121 * @note the difference between this function and av_buffersrc_write_frame() is
122 * that av_buffersrc_write_frame() creates a new reference to the input frame,
123 * while this function takes ownership of the reference passed to it.
125 * This function is equivalent to av_buffersrc_add_frame_flags() without the
126 * AV_BUFFERSRC_FLAG_KEEP_REF flag.
128 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
131 * Add a frame to the buffer source.
133 * By default, if the frame is reference-counted, this function will take
134 * ownership of the reference(s) and reset the frame. This can be controled
137 * If this function returns an error, the input frame is not touched.
139 * @param buffer_src pointer to a buffer source context
140 * @param frame a frame, or NULL to mark EOF
141 * @param flags a combination of AV_BUFFERSRC_FLAG_*
142 * @return >= 0 in case of success, a negative AVERROR code
145 int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src,
146 AVFrame *frame, int flags);
149 #endif /* AVFILTER_BUFFERSRC_H */