lavfi/buffersink: fix doxy, remove "video" reference
[ffmpeg.git] / libavfilter / sink_buffer.c
1 /*
2  * Copyright (c) 2011 Stefano Sabatini
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * buffer sink
24  */
25
26 #include "libavutil/avassert.h"
27 #include "libavutil/fifo.h"
28 #include "avfilter.h"
29 #include "buffersink.h"
30 #include "internal.h"
31
32 AVBufferSinkParams *av_buffersink_params_alloc(void)
33 {
34     static const int pixel_fmts[] = { -1 };
35     AVBufferSinkParams *params = av_malloc(sizeof(AVBufferSinkParams));
36     if (!params)
37         return NULL;
38
39     params->pixel_fmts = pixel_fmts;
40     return params;
41 }
42
43 AVABufferSinkParams *av_abuffersink_params_alloc(void)
44 {
45     static const int sample_fmts[] = { -1 };
46     static const int64_t channel_layouts[] = { -1 };
47     AVABufferSinkParams *params = av_malloc(sizeof(AVABufferSinkParams));
48
49     if (!params)
50         return NULL;
51
52     params->sample_fmts = sample_fmts;
53     params->channel_layouts = channel_layouts;
54     return params;
55 }
56
57 typedef struct {
58     AVFifoBuffer *fifo;                      ///< FIFO buffer of video frame references
59     unsigned warning_limit;
60
61     /* only used for video */
62     enum PixelFormat *pixel_fmts;           ///< list of accepted pixel formats, must be terminated with -1
63
64     /* only used for audio */
65     enum AVSampleFormat *sample_fmts;       ///< list of accepted sample formats, terminated by AV_SAMPLE_FMT_NONE
66     int64_t *channel_layouts;               ///< list of accepted channel layouts, terminated by -1
67 } BufferSinkContext;
68
69 #define FIFO_INIT_SIZE 8
70
71 static av_cold int common_init(AVFilterContext *ctx)
72 {
73     BufferSinkContext *buf = ctx->priv;
74
75     buf->fifo = av_fifo_alloc(FIFO_INIT_SIZE*sizeof(AVFilterBufferRef *));
76     if (!buf->fifo) {
77         av_log(ctx, AV_LOG_ERROR, "Failed to allocate fifo\n");
78         return AVERROR(ENOMEM);
79     }
80     buf->warning_limit = 100;
81     return 0;
82 }
83
84 static av_cold void common_uninit(AVFilterContext *ctx)
85 {
86     BufferSinkContext *buf = ctx->priv;
87     AVFilterBufferRef *picref;
88
89     if (buf->fifo) {
90         while (av_fifo_size(buf->fifo) >= sizeof(AVFilterBufferRef *)) {
91             av_fifo_generic_read(buf->fifo, &picref, sizeof(picref), NULL);
92             avfilter_unref_buffer(picref);
93         }
94         av_fifo_free(buf->fifo);
95         buf->fifo = NULL;
96     }
97 }
98
99 static void end_frame(AVFilterLink *inlink)
100 {
101     AVFilterContext *ctx = inlink->dst;
102     BufferSinkContext *buf = inlink->dst->priv;
103
104     av_assert1(inlink->cur_buf);
105     if (av_fifo_space(buf->fifo) < sizeof(AVFilterBufferRef *)) {
106         /* realloc fifo size */
107         if (av_fifo_realloc2(buf->fifo, av_fifo_size(buf->fifo) * 2) < 0) {
108             av_log(ctx, AV_LOG_ERROR,
109                    "Cannot buffer more frames. Consume some available frames "
110                    "before adding new ones.\n");
111             return;
112         }
113     }
114
115     /* cache frame */
116     av_fifo_generic_write(buf->fifo,
117                           &inlink->cur_buf, sizeof(AVFilterBufferRef *), NULL);
118     if (buf->warning_limit &&
119         av_fifo_size(buf->fifo) / sizeof(AVFilterBufferRef *) >= buf->warning_limit) {
120         av_log(ctx, AV_LOG_WARNING,
121                "%d buffers queued in %s, something may be wrong.\n",
122                buf->warning_limit,
123                (char *)av_x_if_null(ctx->name, ctx->filter->name));
124         buf->warning_limit *= 10;
125     }
126 }
127
128 void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size)
129 {
130     AVFilterLink *inlink = ctx->inputs[0];
131
132     inlink->min_samples = inlink->max_samples =
133     inlink->partial_buf_size = frame_size;
134 }
135
136 int av_buffersink_get_buffer_ref(AVFilterContext *ctx,
137                                   AVFilterBufferRef **bufref, int flags)
138 {
139     BufferSinkContext *buf = ctx->priv;
140     AVFilterLink *inlink = ctx->inputs[0];
141     int ret;
142     *bufref = NULL;
143
144     av_assert0(!strcmp(ctx->filter->name, "buffersink") || !strcmp(ctx->filter->name, "abuffersink"));
145
146     /* no picref available, fetch it from the filterchain */
147     if (!av_fifo_size(buf->fifo)) {
148         if (flags & AV_BUFFERSINK_FLAG_NO_REQUEST)
149             return AVERROR(EAGAIN);
150         if ((ret = ff_request_frame(inlink)) < 0)
151             return ret;
152     }
153
154     if (!av_fifo_size(buf->fifo))
155         return AVERROR(EINVAL);
156
157     if (flags & AV_BUFFERSINK_FLAG_PEEK)
158         *bufref = *((AVFilterBufferRef **)av_fifo_peek2(buf->fifo, 0));
159     else
160         av_fifo_generic_read(buf->fifo, bufref, sizeof(*bufref), NULL);
161
162     return 0;
163 }
164
165 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx)
166 {
167     av_assert0(!strcmp(ctx->filter->name, "buffersink"));
168
169     return ctx->inputs[0]->frame_rate;
170 }
171
172 int av_buffersink_poll_frame(AVFilterContext *ctx)
173 {
174     BufferSinkContext *buf = ctx->priv;
175     AVFilterLink *inlink = ctx->inputs[0];
176
177     av_assert0(!strcmp(ctx->filter->name, "buffersink") || !strcmp(ctx->filter->name, "abuffersink"));
178
179     return av_fifo_size(buf->fifo)/sizeof(AVFilterBufferRef *) + ff_poll_frame(inlink);
180 }
181
182 #if CONFIG_BUFFERSINK_FILTER
183
184 static av_cold int vsink_init(AVFilterContext *ctx, const char *args)
185 {
186     BufferSinkContext *buf = ctx->priv;
187     AVBufferSinkParams *params = NULL;
188
189 //     if(args && !strcmp(args, "opaque"))
190 //         params = (AVBufferSinkParams *)(args+7);
191
192     if (!params) {
193         av_log(ctx, AV_LOG_WARNING,
194                "No opaque field provided\n");
195         buf->pixel_fmts = NULL;
196     } else {
197         const int *pixel_fmts = params->pixel_fmts;
198
199         buf->pixel_fmts = ff_copy_int_list(pixel_fmts);
200         if (!buf->pixel_fmts)
201             return AVERROR(ENOMEM);
202     }
203
204     return common_init(ctx);
205 }
206
207 static av_cold void vsink_uninit(AVFilterContext *ctx)
208 {
209     BufferSinkContext *buf = ctx->priv;
210     av_freep(&buf->pixel_fmts);
211     common_uninit(ctx);
212 }
213
214 static int vsink_query_formats(AVFilterContext *ctx)
215 {
216     BufferSinkContext *buf = ctx->priv;
217
218     if (buf->pixel_fmts)
219         ff_set_common_formats(ctx, ff_make_format_list(buf->pixel_fmts));
220     else
221         ff_default_query_formats(ctx);
222
223     return 0;
224 }
225
226 AVFilter avfilter_vsink_buffersink = {
227     .name      = "buffersink",
228     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them available to the end of the filter graph."),
229     .priv_size = sizeof(BufferSinkContext),
230     .init      = vsink_init,
231     .uninit    = vsink_uninit,
232
233     .query_formats = vsink_query_formats,
234
235     .inputs    = (const AVFilterPad[]) {{ .name    = "default",
236                                     .type          = AVMEDIA_TYPE_VIDEO,
237                                     .end_frame     = end_frame,
238                                     .min_perms     = AV_PERM_READ, },
239                                   { .name = NULL }},
240     .outputs   = (const AVFilterPad[]) {{ .name = NULL }},
241 };
242
243 #endif /* CONFIG_BUFFERSINK_FILTER */
244
245 #if CONFIG_ABUFFERSINK_FILTER
246
247 static void filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref)
248 {
249     end_frame(link);
250 }
251
252 static av_cold int asink_init(AVFilterContext *ctx, const char *args)
253 {
254     BufferSinkContext *buf = ctx->priv;
255     AVABufferSinkParams *params = NULL;
256
257 //     if(args && !strcmp(args, "opaque"))
258 //         params = (AVABufferSinkParams *)(args+7);
259
260     if (params && params->sample_fmts) {
261         buf->sample_fmts     = ff_copy_int_list  (params->sample_fmts);
262         if (!buf->sample_fmts)
263             goto fail_enomem;
264     }
265     if (params && params->channel_layouts) {
266         buf->channel_layouts = ff_copy_int64_list(params->channel_layouts);
267         if (!buf->channel_layouts)
268             goto fail_enomem;
269     }
270     if (!common_init(ctx))
271         return 0;
272
273 fail_enomem:
274     av_freep(&buf->sample_fmts);
275     av_freep(&buf->channel_layouts);
276     return AVERROR(ENOMEM);
277 }
278
279 static av_cold void asink_uninit(AVFilterContext *ctx)
280 {
281     BufferSinkContext *buf = ctx->priv;
282
283     av_freep(&buf->sample_fmts);
284     av_freep(&buf->channel_layouts);
285     common_uninit(ctx);
286 }
287
288 static int asink_query_formats(AVFilterContext *ctx)
289 {
290     BufferSinkContext *buf = ctx->priv;
291     AVFilterFormats *formats = NULL;
292     AVFilterChannelLayouts *layouts = NULL;
293
294     if (buf->sample_fmts) {
295     if (!(formats = ff_make_format_list(buf->sample_fmts)))
296         return AVERROR(ENOMEM);
297     ff_set_common_formats(ctx, formats);
298     }
299
300     if (buf->channel_layouts) {
301     if (!(layouts = avfilter_make_format64_list(buf->channel_layouts)))
302         return AVERROR(ENOMEM);
303     ff_set_common_channel_layouts(ctx, layouts);
304     }
305
306     return 0;
307 }
308
309 AVFilter avfilter_asink_abuffersink = {
310     .name      = "abuffersink",
311     .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them available to the end of the filter graph."),
312     .init      = asink_init,
313     .uninit    = asink_uninit,
314     .priv_size = sizeof(BufferSinkContext),
315     .query_formats = asink_query_formats,
316
317     .inputs    = (const AVFilterPad[]) {{ .name     = "default",
318                                     .type           = AVMEDIA_TYPE_AUDIO,
319                                     .filter_samples = filter_samples,
320                                     .min_perms      = AV_PERM_READ, },
321                                   { .name = NULL }},
322     .outputs   = (const AVFilterPad[]) {{ .name = NULL }},
323 };
324
325 #endif /* CONFIG_ABUFFERSINK_FILTER */