lavfi doxy: add buffer{src,sink}.h to the main lavfi doxy group
[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 #if FF_API_AVFILTERBUFFER
38 /**
39  * Add a buffer to a filtergraph.
40  *
41  * @param ctx an instance of the buffersrc filter
42  * @param buf buffer containing frame data to be passed down the filtergraph.
43  * This function will take ownership of buf, the user must not free it.
44  * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
45  *
46  * @deprecated use av_buffersrc_write_frame() or av_buffersrc_add_frame()
47  */
48 attribute_deprecated
49 int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf);
50 #endif
51
52 /**
53  * Add a frame to the buffer source.
54  *
55  * @param ctx   an instance of the buffersrc filter
56  * @param frame frame to be added. If the frame is reference counted, this
57  * function will make a new reference to it. Otherwise the frame data will be
58  * copied.
59  *
60  * @return 0 on success, a negative AVERROR on error
61  */
62 int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame);
63
64 /**
65  * Add a frame to the buffer source.
66  *
67  * @param ctx   an instance of the buffersrc filter
68  * @param frame frame to be added. If the frame is reference counted, this
69  * function will take ownership of the reference(s) and reset the frame.
70  * Otherwise the frame data will be copied. If this function returns an error,
71  * the input frame is not touched.
72  *
73  * @return 0 on success, a negative AVERROR on error.
74  *
75  * @note the difference between this function and av_buffersrc_write_frame() is
76  * that av_buffersrc_write_frame() creates a new reference to the input frame,
77  * while this function takes ownership of the reference passed to it.
78  */
79 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame);
80
81 /**
82  * @}
83  */
84
85 #endif /* AVFILTER_BUFFERSRC_H */