lavfi: Drop deprecated AVFilterBuffer* code
[ffmpeg.git] / libavfilter / buffersrc.h
1 /*
2  *
3  * This file is part of Libav.
4  *
5  * Libav 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.
9  *
10  * Libav 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.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with Libav; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 #ifndef AVFILTER_BUFFERSRC_H
21 #define AVFILTER_BUFFERSRC_H
22
23 /**
24  * @file
25  * @ingroup lavfi_buffersrc
26  * Memory buffer source API.
27  */
28
29 #include "avfilter.h"
30
31 /**
32  * @defgroup lavfi_buffersrc Buffer source API
33  * @ingroup lavfi
34  * @{
35  */
36
37 /**
38  * Add a frame to the buffer source.
39  *
40  * @param ctx   an instance of the buffersrc filter
41  * @param frame frame to be added. If the frame is reference counted, this
42  * function will make a new reference to it. Otherwise the frame data will be
43  * copied.
44  *
45  * @return 0 on success, a negative AVERROR on error
46  */
47 int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
48
49 /**
50  * Add a frame to the buffer source.
51  *
52  * @param ctx   an instance of the buffersrc filter
53  * @param frame frame to be added. If the frame is reference counted, this
54  * function will take ownership of the reference(s) and reset the frame.
55  * Otherwise the frame data will be copied. If this function returns an error,
56  * the input frame is not touched.
57  *
58  * @return 0 on success, a negative AVERROR on error.
59  *
60  * @note the difference between this function and av_buffersrc_write_frame() is
61  * that av_buffersrc_write_frame() creates a new reference to the input frame,
62  * while this function takes ownership of the reference passed to it.
63  */
64 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
65
66 /**
67  * @}
68  */
69
70 #endif /* AVFILTER_BUFFERSRC_H */