avfilter/vf_maskedmerge: get rid of MaskedMergeContext from functions that do actual...
[ffmpeg.git] / libavfilter / buffersrc.c
1 /*
2  * Copyright (c) 2008 Vitor Sessak
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  * memory buffer source filter
24  */
25
26 #include <float.h>
27
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/common.h"
30 #include "libavutil/fifo.h"
31 #include "libavutil/frame.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/samplefmt.h"
36 #include "audio.h"
37 #include "avfilter.h"
38 #include "buffersrc.h"
39 #include "formats.h"
40 #include "internal.h"
41 #include "video.h"
42
43 typedef struct BufferSourceContext {
44     const AVClass    *class;
45     AVFifoBuffer     *fifo;
46     AVRational        time_base;     ///< time_base to set in the output link
47     AVRational        frame_rate;    ///< frame_rate to set in the output link
48     unsigned          nb_failed_requests;
49     unsigned          warning_limit;
50
51     /* video only */
52     int               w, h;
53     enum AVPixelFormat  pix_fmt;
54     AVRational        pixel_aspect;
55     char              *sws_param;
56
57     /* audio only */
58     int sample_rate;
59     enum AVSampleFormat sample_fmt;
60     int channels;
61     uint64_t channel_layout;
62     char    *channel_layout_str;
63
64     int eof;
65 } BufferSourceContext;
66
67 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format)\
68     if (c->w != width || c->h != height || c->pix_fmt != format) {\
69         av_log(s, AV_LOG_INFO, "Changing frame properties on the fly is not supported by all filters.\n");\
70     }
71
72 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format)\
73     if (c->sample_fmt != format || c->sample_rate != srate ||\
74         c->channel_layout != ch_layout || c->channels != ch_count) {\
75         av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
76         return AVERROR(EINVAL);\
77     }
78
79 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
80 {
81     return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
82                                         AV_BUFFERSRC_FLAG_KEEP_REF);
83 }
84
85 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
86 {
87     return av_buffersrc_add_frame_flags(ctx, frame, 0);
88 }
89
90 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
91                                            AVFrame *frame, int flags);
92
93 int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
94 {
95     AVFrame *copy = NULL;
96     int ret = 0;
97
98     if (frame && frame->channel_layout &&
99         av_get_channel_layout_nb_channels(frame->channel_layout) != av_frame_get_channels(frame)) {
100         av_log(ctx, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
101         return AVERROR(EINVAL);
102     }
103
104     if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
105         return av_buffersrc_add_frame_internal(ctx, frame, flags);
106
107     if (!(copy = av_frame_alloc()))
108         return AVERROR(ENOMEM);
109     ret = av_frame_ref(copy, frame);
110     if (ret >= 0)
111         ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
112
113     av_frame_free(&copy);
114     return ret;
115 }
116
117 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
118                                            AVFrame *frame, int flags)
119 {
120     BufferSourceContext *s = ctx->priv;
121     AVFrame *copy;
122     int refcounted, ret;
123
124     s->nb_failed_requests = 0;
125
126     if (!frame) {
127         s->eof = 1;
128         return 0;
129     } else if (s->eof)
130         return AVERROR(EINVAL);
131
132     refcounted = !!frame->buf[0];
133
134     if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
135
136     switch (ctx->outputs[0]->type) {
137     case AVMEDIA_TYPE_VIDEO:
138         CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
139                                  frame->format);
140         break;
141     case AVMEDIA_TYPE_AUDIO:
142         /* For layouts unknown on input but known on link after negotiation. */
143         if (!frame->channel_layout)
144             frame->channel_layout = s->channel_layout;
145         CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
146                                  av_frame_get_channels(frame), frame->format);
147         break;
148     default:
149         return AVERROR(EINVAL);
150     }
151
152     }
153
154     if (!av_fifo_space(s->fifo) &&
155         (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
156                                          sizeof(copy))) < 0)
157         return ret;
158
159     if (!(copy = av_frame_alloc()))
160         return AVERROR(ENOMEM);
161
162     if (refcounted) {
163         av_frame_move_ref(copy, frame);
164     } else {
165         ret = av_frame_ref(copy, frame);
166         if (ret < 0) {
167             av_frame_free(&copy);
168             return ret;
169         }
170     }
171
172     if ((ret = av_fifo_generic_write(s->fifo, &copy, sizeof(copy), NULL)) < 0) {
173         if (refcounted)
174             av_frame_move_ref(frame, copy);
175         av_frame_free(&copy);
176         return ret;
177     }
178
179     if ((flags & AV_BUFFERSRC_FLAG_PUSH))
180         if ((ret = ctx->output_pads[0].request_frame(ctx->outputs[0])) < 0)
181             return ret;
182
183     return 0;
184 }
185
186 static av_cold int init_video(AVFilterContext *ctx)
187 {
188     BufferSourceContext *c = ctx->priv;
189
190     if (c->pix_fmt == AV_PIX_FMT_NONE || !c->w || !c->h || av_q2d(c->time_base) <= 0) {
191         av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
192         return AVERROR(EINVAL);
193     }
194
195     if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
196         return AVERROR(ENOMEM);
197
198     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d pixfmt:%s tb:%d/%d fr:%d/%d sar:%d/%d sws_param:%s\n",
199            c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
200            c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
201            c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
202     c->warning_limit = 100;
203     return 0;
204 }
205
206 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
207 {
208     return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
209 }
210
211 #define OFFSET(x) offsetof(BufferSourceContext, x)
212 #define A AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
213 #define V AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
214
215 static const AVOption buffer_options[] = {
216     { "width",         NULL,                     OFFSET(w),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
217     { "video_size",    NULL,                     OFFSET(w),                AV_OPT_TYPE_IMAGE_SIZE,                .flags = V },
218     { "height",        NULL,                     OFFSET(h),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
219     { "pix_fmt",       NULL,                     OFFSET(pix_fmt),          AV_OPT_TYPE_PIXEL_FMT, { .i64 = AV_PIX_FMT_NONE }, .min = AV_PIX_FMT_NONE, .max = INT_MAX, .flags = V },
220 #if FF_API_OLD_FILTER_OPTS
221     /* those 4 are for compatibility with the old option passing system where each filter
222      * did its own parsing */
223     { "time_base_num", "deprecated, do not use", OFFSET(time_base.num),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
224     { "time_base_den", "deprecated, do not use", OFFSET(time_base.den),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
225     { "sar_num",       "deprecated, do not use", OFFSET(pixel_aspect.num), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
226     { "sar_den",       "deprecated, do not use", OFFSET(pixel_aspect.den), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
227 #endif
228     { "sar",           "sample aspect ratio",    OFFSET(pixel_aspect),     AV_OPT_TYPE_RATIONAL, { .dbl = 1 }, 0, DBL_MAX, V },
229     { "pixel_aspect",  "sample aspect ratio",    OFFSET(pixel_aspect),     AV_OPT_TYPE_RATIONAL, { .dbl = 1 }, 0, DBL_MAX, V },
230     { "time_base",     NULL,                     OFFSET(time_base),        AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
231     { "frame_rate",    NULL,                     OFFSET(frame_rate),       AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
232     { "sws_param",     NULL,                     OFFSET(sws_param),        AV_OPT_TYPE_STRING,                    .flags = V },
233     { NULL },
234 };
235
236 AVFILTER_DEFINE_CLASS(buffer);
237
238 static const AVOption abuffer_options[] = {
239     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
240     { "sample_rate",    NULL, OFFSET(sample_rate),         AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, A },
241     { "sample_fmt",     NULL, OFFSET(sample_fmt),          AV_OPT_TYPE_SAMPLE_FMT, { .i64 = AV_SAMPLE_FMT_NONE }, .min = AV_SAMPLE_FMT_NONE, .max = INT_MAX, .flags = A },
242     { "channel_layout", NULL, OFFSET(channel_layout_str),  AV_OPT_TYPE_STRING,             .flags = A },
243     { "channels",       NULL, OFFSET(channels),            AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, A },
244     { NULL },
245 };
246
247 AVFILTER_DEFINE_CLASS(abuffer);
248
249 static av_cold int init_audio(AVFilterContext *ctx)
250 {
251     BufferSourceContext *s = ctx->priv;
252     int ret = 0;
253
254     if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
255         av_log(ctx, AV_LOG_ERROR, "Sample format was not set or was invalid\n");
256         return AVERROR(EINVAL);
257     }
258
259     if (s->channel_layout_str) {
260         int n;
261
262         s->channel_layout = av_get_channel_layout(s->channel_layout_str);
263         if (!s->channel_layout) {
264             av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
265                    s->channel_layout_str);
266             return AVERROR(EINVAL);
267         }
268         n = av_get_channel_layout_nb_channels(s->channel_layout);
269         if (s->channels) {
270             if (n != s->channels) {
271                 av_log(ctx, AV_LOG_ERROR,
272                        "Mismatching channel count %d and layout '%s' "
273                        "(%d channels)\n",
274                        s->channels, s->channel_layout_str, n);
275                 return AVERROR(EINVAL);
276             }
277         }
278         s->channels = n;
279     } else if (!s->channels) {
280         av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
281                                   "channel layout specified\n");
282         return AVERROR(EINVAL);
283     }
284
285     if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
286         return AVERROR(ENOMEM);
287
288     if (!s->time_base.num)
289         s->time_base = (AVRational){1, s->sample_rate};
290
291     av_log(ctx, AV_LOG_VERBOSE,
292            "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
293            s->time_base.num, s->time_base.den, av_get_sample_fmt_name(s->sample_fmt),
294            s->sample_rate, s->channel_layout_str);
295     s->warning_limit = 100;
296
297     return ret;
298 }
299
300 static av_cold void uninit(AVFilterContext *ctx)
301 {
302     BufferSourceContext *s = ctx->priv;
303     while (s->fifo && av_fifo_size(s->fifo)) {
304         AVFrame *frame;
305         av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
306         av_frame_free(&frame);
307     }
308     av_fifo_freep(&s->fifo);
309 }
310
311 static int query_formats(AVFilterContext *ctx)
312 {
313     BufferSourceContext *c = ctx->priv;
314     AVFilterChannelLayouts *channel_layouts = NULL;
315     AVFilterFormats *formats = NULL;
316     AVFilterFormats *samplerates = NULL;
317
318     switch (ctx->outputs[0]->type) {
319     case AVMEDIA_TYPE_VIDEO:
320         ff_add_format(&formats, c->pix_fmt);
321         ff_set_common_formats(ctx, formats);
322         break;
323     case AVMEDIA_TYPE_AUDIO:
324         ff_add_format(&formats,           c->sample_fmt);
325         ff_set_common_formats(ctx, formats);
326
327         ff_add_format(&samplerates,       c->sample_rate);
328         ff_set_common_samplerates(ctx, samplerates);
329
330         ff_add_channel_layout(&channel_layouts,
331                               c->channel_layout ? c->channel_layout :
332                               FF_COUNT2LAYOUT(c->channels));
333         ff_set_common_channel_layouts(ctx, channel_layouts);
334         break;
335     default:
336         return AVERROR(EINVAL);
337     }
338
339     return 0;
340 }
341
342 static int config_props(AVFilterLink *link)
343 {
344     BufferSourceContext *c = link->src->priv;
345
346     switch (link->type) {
347     case AVMEDIA_TYPE_VIDEO:
348         link->w = c->w;
349         link->h = c->h;
350         link->sample_aspect_ratio = c->pixel_aspect;
351         break;
352     case AVMEDIA_TYPE_AUDIO:
353         if (!c->channel_layout)
354             c->channel_layout = link->channel_layout;
355         break;
356     default:
357         return AVERROR(EINVAL);
358     }
359
360     link->time_base = c->time_base;
361     link->frame_rate = c->frame_rate;
362     return 0;
363 }
364
365 static int request_frame(AVFilterLink *link)
366 {
367     BufferSourceContext *c = link->src->priv;
368     AVFrame *frame;
369
370     if (!av_fifo_size(c->fifo)) {
371         if (c->eof)
372             return AVERROR_EOF;
373         c->nb_failed_requests++;
374         return AVERROR(EAGAIN);
375     }
376     av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
377
378     return ff_filter_frame(link, frame);
379 }
380
381 static int poll_frame(AVFilterLink *link)
382 {
383     BufferSourceContext *c = link->src->priv;
384     int size = av_fifo_size(c->fifo);
385     if (!size && c->eof)
386         return AVERROR_EOF;
387     return size/sizeof(AVFrame*);
388 }
389
390 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
391     {
392         .name          = "default",
393         .type          = AVMEDIA_TYPE_VIDEO,
394         .request_frame = request_frame,
395         .poll_frame    = poll_frame,
396         .config_props  = config_props,
397     },
398     { NULL }
399 };
400
401 AVFilter ff_vsrc_buffer = {
402     .name      = "buffer",
403     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
404     .priv_size = sizeof(BufferSourceContext),
405     .query_formats = query_formats,
406
407     .init      = init_video,
408     .uninit    = uninit,
409
410     .inputs    = NULL,
411     .outputs   = avfilter_vsrc_buffer_outputs,
412     .priv_class = &buffer_class,
413 };
414
415 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
416     {
417         .name          = "default",
418         .type          = AVMEDIA_TYPE_AUDIO,
419         .request_frame = request_frame,
420         .poll_frame    = poll_frame,
421         .config_props  = config_props,
422     },
423     { NULL }
424 };
425
426 AVFilter ff_asrc_abuffer = {
427     .name          = "abuffer",
428     .description   = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
429     .priv_size     = sizeof(BufferSourceContext),
430     .query_formats = query_formats,
431
432     .init      = init_audio,
433     .uninit    = uninit,
434
435     .inputs    = NULL,
436     .outputs   = avfilter_asrc_abuffer_outputs,
437     .priv_class = &abuffer_class,
438 };