Remove "Error parsing options string [...]" messages.
[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  * Memory buffer source API.
26  */
27
28 #include "libavcodec/avcodec.h"
29 #include "avfilter.h"
30
31 enum {
32
33     /**
34      * Do not check for format changes.
35      */
36     AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1,
37
38     /**
39      * Do not copy buffer data.
40      */
41     AV_BUFFERSRC_FLAG_NO_COPY = 2,
42
43 };
44
45 /**
46  * Add buffer data in picref to buffer_src.
47  *
48  * @param buffer_src  pointer to a buffer source context
49  * @param picref      a buffer reference, or NULL to mark EOF
50  * @param flags       a combination of AV_BUFFERSRC_FLAG_*
51  * @return            >= 0 in case of success, a negative AVERROR code
52  *                    in case of failure
53  */
54 int av_buffersrc_add_ref(AVFilterContext *buffer_src,
55                          AVFilterBufferRef *picref, int flags);
56
57 /**
58  * Get the number of failed requests.
59  *
60  * A failed request is when the request_frame method is called while no
61  * frame is present in the buffer.
62  * The number is reset when a frame is added.
63  */
64 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src);
65
66 #ifdef FF_API_BUFFERSRC_BUFFER
67 /**
68  * Add a buffer to the filtergraph s.
69  *
70  * @param buf buffer containing frame data to be passed down the filtergraph.
71  * This function will take ownership of buf, the user must not free it.
72  * A NULL buf signals EOF -- i.e. no more frames will be sent to this filter.
73  * @deprecated Use av_buffersrc_add_ref(s, picref, AV_BUFFERSRC_FLAG_NO_COPY) instead.
74  */
75 attribute_deprecated
76 int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf);
77 #endif
78
79 /**
80  * Add a frame to the buffer source.
81  *
82  * @param s an instance of the buffersrc filter.
83  * @param frame frame to be added.
84  *
85  * @warning frame data will be memcpy()ed, which may be a big performance
86  *          hit. Use av_buffersrc_buffer() to avoid copying the data.
87  */
88 int av_buffersrc_write_frame(AVFilterContext *s, AVFrame *frame);
89
90 #endif /* AVFILTER_BUFFERSRC_H */