avfilter/af_headphone: do not free frame that's gonna be reused later
[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     AVBufferRef *hw_frames_ctx;
58
59     /* audio only */
60     int sample_rate;
61     enum AVSampleFormat sample_fmt;
62     int channels;
63     uint64_t channel_layout;
64     char    *channel_layout_str;
65
66     int got_format_from_params;
67     int eof;
68 } BufferSourceContext;
69
70 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format)\
71     if (c->w != width || c->h != height || c->pix_fmt != format) {\
72         av_log(s, AV_LOG_INFO, "Changing frame properties on the fly is not supported by all filters.\n");\
73     }
74
75 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format)\
76     if (c->sample_fmt != format || c->sample_rate != srate ||\
77         c->channel_layout != ch_layout || c->channels != ch_count) {\
78         av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
79         return AVERROR(EINVAL);\
80     }
81
82 AVBufferSrcParameters *av_buffersrc_parameters_alloc(void)
83 {
84     AVBufferSrcParameters *par = av_mallocz(sizeof(*par));
85     if (!par)
86         return NULL;
87
88     par->format = -1;
89
90     return par;
91 }
92
93 int av_buffersrc_parameters_set(AVFilterContext *ctx, AVBufferSrcParameters *param)
94 {
95     BufferSourceContext *s = ctx->priv;
96
97     if (param->time_base.num > 0 && param->time_base.den > 0)
98         s->time_base = param->time_base;
99
100     switch (ctx->filter->outputs[0].type) {
101     case AVMEDIA_TYPE_VIDEO:
102         if (param->format != AV_PIX_FMT_NONE) {
103             s->got_format_from_params = 1;
104             s->pix_fmt = param->format;
105         }
106         if (param->width > 0)
107             s->w = param->width;
108         if (param->height > 0)
109             s->h = param->height;
110         if (param->sample_aspect_ratio.num > 0 && param->sample_aspect_ratio.den > 0)
111             s->pixel_aspect = param->sample_aspect_ratio;
112         if (param->frame_rate.num > 0 && param->frame_rate.den > 0)
113             s->frame_rate = param->frame_rate;
114         if (param->hw_frames_ctx) {
115             av_buffer_unref(&s->hw_frames_ctx);
116             s->hw_frames_ctx = av_buffer_ref(param->hw_frames_ctx);
117             if (!s->hw_frames_ctx)
118                 return AVERROR(ENOMEM);
119         }
120         break;
121     case AVMEDIA_TYPE_AUDIO:
122         if (param->format != AV_SAMPLE_FMT_NONE) {
123             s->got_format_from_params = 1;
124             s->sample_fmt = param->format;
125         }
126         if (param->sample_rate > 0)
127             s->sample_rate = param->sample_rate;
128         if (param->channel_layout)
129             s->channel_layout = param->channel_layout;
130         break;
131     default:
132         return AVERROR_BUG;
133     }
134
135     return 0;
136 }
137
138 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
139 {
140     return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
141                                         AV_BUFFERSRC_FLAG_KEEP_REF);
142 }
143
144 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
145 {
146     return av_buffersrc_add_frame_flags(ctx, frame, 0);
147 }
148
149 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
150                                            AVFrame *frame, int flags);
151
152 int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
153 {
154     AVFrame *copy = NULL;
155     int ret = 0;
156
157     if (frame && frame->channel_layout &&
158         av_get_channel_layout_nb_channels(frame->channel_layout) != frame->channels) {
159         av_log(ctx, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
160         return AVERROR(EINVAL);
161     }
162
163     if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
164         return av_buffersrc_add_frame_internal(ctx, frame, flags);
165
166     if (!(copy = av_frame_alloc()))
167         return AVERROR(ENOMEM);
168     ret = av_frame_ref(copy, frame);
169     if (ret >= 0)
170         ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
171
172     av_frame_free(&copy);
173     return ret;
174 }
175
176 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
177                                            AVFrame *frame, int flags)
178 {
179     BufferSourceContext *s = ctx->priv;
180     AVFrame *copy;
181     int refcounted, ret;
182
183     s->nb_failed_requests = 0;
184
185     if (!frame) {
186         s->eof = 1;
187         ff_avfilter_link_set_in_status(ctx->outputs[0], AVERROR_EOF, AV_NOPTS_VALUE);
188         return 0;
189     } else if (s->eof)
190         return AVERROR(EINVAL);
191
192     refcounted = !!frame->buf[0];
193
194     if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
195
196     switch (ctx->outputs[0]->type) {
197     case AVMEDIA_TYPE_VIDEO:
198         CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
199                                  frame->format);
200         break;
201     case AVMEDIA_TYPE_AUDIO:
202         /* For layouts unknown on input but known on link after negotiation. */
203         if (!frame->channel_layout)
204             frame->channel_layout = s->channel_layout;
205         CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
206                                  frame->channels, frame->format);
207         break;
208     default:
209         return AVERROR(EINVAL);
210     }
211
212     }
213
214     if (!av_fifo_space(s->fifo) &&
215         (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
216                                          sizeof(copy))) < 0)
217         return ret;
218
219     if (!(copy = av_frame_alloc()))
220         return AVERROR(ENOMEM);
221
222     if (refcounted) {
223         av_frame_move_ref(copy, frame);
224     } else {
225         ret = av_frame_ref(copy, frame);
226         if (ret < 0) {
227             av_frame_free(&copy);
228             return ret;
229         }
230     }
231
232     if ((ret = av_fifo_generic_write(s->fifo, &copy, sizeof(copy), NULL)) < 0) {
233         if (refcounted)
234             av_frame_move_ref(frame, copy);
235         av_frame_free(&copy);
236         return ret;
237     }
238
239     if ((ret = ctx->output_pads[0].request_frame(ctx->outputs[0])) < 0)
240         return ret;
241
242     return 0;
243 }
244
245 static av_cold int init_video(AVFilterContext *ctx)
246 {
247     BufferSourceContext *c = ctx->priv;
248
249     if (!(c->pix_fmt != AV_PIX_FMT_NONE || c->got_format_from_params) || !c->w || !c->h ||
250         av_q2d(c->time_base) <= 0) {
251         av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
252         return AVERROR(EINVAL);
253     }
254
255     if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
256         return AVERROR(ENOMEM);
257
258     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",
259            c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
260            c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
261            c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
262     c->warning_limit = 100;
263     return 0;
264 }
265
266 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
267 {
268     return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
269 }
270
271 #define OFFSET(x) offsetof(BufferSourceContext, x)
272 #define A AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
273 #define V AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
274
275 static const AVOption buffer_options[] = {
276     { "width",         NULL,                     OFFSET(w),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
277     { "video_size",    NULL,                     OFFSET(w),                AV_OPT_TYPE_IMAGE_SIZE,                .flags = V },
278     { "height",        NULL,                     OFFSET(h),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
279     { "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 },
280 #if FF_API_OLD_FILTER_OPTS
281     /* those 4 are for compatibility with the old option passing system where each filter
282      * did its own parsing */
283     { "time_base_num", "deprecated, do not use", OFFSET(time_base.num),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
284     { "time_base_den", "deprecated, do not use", OFFSET(time_base.den),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
285     { "sar_num",       "deprecated, do not use", OFFSET(pixel_aspect.num), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
286     { "sar_den",       "deprecated, do not use", OFFSET(pixel_aspect.den), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
287 #endif
288     { "sar",           "sample aspect ratio",    OFFSET(pixel_aspect),     AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
289     { "pixel_aspect",  "sample aspect ratio",    OFFSET(pixel_aspect),     AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
290     { "time_base",     NULL,                     OFFSET(time_base),        AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
291     { "frame_rate",    NULL,                     OFFSET(frame_rate),       AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
292     { "sws_param",     NULL,                     OFFSET(sws_param),        AV_OPT_TYPE_STRING,                    .flags = V },
293     { NULL },
294 };
295
296 AVFILTER_DEFINE_CLASS(buffer);
297
298 static const AVOption abuffer_options[] = {
299     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
300     { "sample_rate",    NULL, OFFSET(sample_rate),         AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, A },
301     { "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 },
302     { "channel_layout", NULL, OFFSET(channel_layout_str),  AV_OPT_TYPE_STRING,             .flags = A },
303     { "channels",       NULL, OFFSET(channels),            AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, A },
304     { NULL },
305 };
306
307 AVFILTER_DEFINE_CLASS(abuffer);
308
309 static av_cold int init_audio(AVFilterContext *ctx)
310 {
311     BufferSourceContext *s = ctx->priv;
312     int ret = 0;
313
314     if (!(s->sample_fmt != AV_SAMPLE_FMT_NONE || s->got_format_from_params)) {
315         av_log(ctx, AV_LOG_ERROR, "Sample format was not set or was invalid\n");
316         return AVERROR(EINVAL);
317     }
318
319     if (s->channel_layout_str || s->channel_layout) {
320         int n;
321
322         if (!s->channel_layout) {
323             s->channel_layout = av_get_channel_layout(s->channel_layout_str);
324             if (!s->channel_layout) {
325                 av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
326                        s->channel_layout_str);
327                 return AVERROR(EINVAL);
328             }
329         }
330         n = av_get_channel_layout_nb_channels(s->channel_layout);
331         if (s->channels) {
332             if (n != s->channels) {
333                 av_log(ctx, AV_LOG_ERROR,
334                        "Mismatching channel count %d and layout '%s' "
335                        "(%d channels)\n",
336                        s->channels, s->channel_layout_str, n);
337                 return AVERROR(EINVAL);
338             }
339         }
340         s->channels = n;
341     } else if (!s->channels) {
342         av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
343                                   "channel layout specified\n");
344         return AVERROR(EINVAL);
345     }
346
347     if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
348         return AVERROR(ENOMEM);
349
350     if (!s->time_base.num)
351         s->time_base = (AVRational){1, s->sample_rate};
352
353     av_log(ctx, AV_LOG_VERBOSE,
354            "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
355            s->time_base.num, s->time_base.den, av_get_sample_fmt_name(s->sample_fmt),
356            s->sample_rate, s->channel_layout_str);
357     s->warning_limit = 100;
358
359     return ret;
360 }
361
362 static av_cold void uninit(AVFilterContext *ctx)
363 {
364     BufferSourceContext *s = ctx->priv;
365     while (s->fifo && av_fifo_size(s->fifo)) {
366         AVFrame *frame;
367         av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
368         av_frame_free(&frame);
369     }
370     av_buffer_unref(&s->hw_frames_ctx);
371     av_fifo_freep(&s->fifo);
372 }
373
374 static int query_formats(AVFilterContext *ctx)
375 {
376     BufferSourceContext *c = ctx->priv;
377     AVFilterChannelLayouts *channel_layouts = NULL;
378     AVFilterFormats *formats = NULL;
379     AVFilterFormats *samplerates = NULL;
380     int ret;
381
382     switch (ctx->outputs[0]->type) {
383     case AVMEDIA_TYPE_VIDEO:
384         if ((ret = ff_add_format         (&formats, c->pix_fmt)) < 0 ||
385             (ret = ff_set_common_formats (ctx     , formats   )) < 0)
386             return ret;
387         break;
388     case AVMEDIA_TYPE_AUDIO:
389         if ((ret = ff_add_format             (&formats    , c->sample_fmt )) < 0 ||
390             (ret = ff_set_common_formats     (ctx         , formats       )) < 0 ||
391             (ret = ff_add_format             (&samplerates, c->sample_rate)) < 0 ||
392             (ret = ff_set_common_samplerates (ctx         , samplerates   )) < 0)
393             return ret;
394
395         if ((ret = ff_add_channel_layout(&channel_layouts,
396                               c->channel_layout ? c->channel_layout :
397                               FF_COUNT2LAYOUT(c->channels))) < 0)
398             return ret;
399         if ((ret = ff_set_common_channel_layouts(ctx, channel_layouts)) < 0)
400             return ret;
401         break;
402     default:
403         return AVERROR(EINVAL);
404     }
405
406     return 0;
407 }
408
409 static int config_props(AVFilterLink *link)
410 {
411     BufferSourceContext *c = link->src->priv;
412
413     switch (link->type) {
414     case AVMEDIA_TYPE_VIDEO:
415         link->w = c->w;
416         link->h = c->h;
417         link->sample_aspect_ratio = c->pixel_aspect;
418
419         if (c->hw_frames_ctx) {
420             link->hw_frames_ctx = av_buffer_ref(c->hw_frames_ctx);
421             if (!link->hw_frames_ctx)
422                 return AVERROR(ENOMEM);
423         }
424         break;
425     case AVMEDIA_TYPE_AUDIO:
426         if (!c->channel_layout)
427             c->channel_layout = link->channel_layout;
428         break;
429     default:
430         return AVERROR(EINVAL);
431     }
432
433     link->time_base = c->time_base;
434     link->frame_rate = c->frame_rate;
435     return 0;
436 }
437
438 static int request_frame(AVFilterLink *link)
439 {
440     BufferSourceContext *c = link->src->priv;
441     AVFrame *frame;
442     int ret;
443
444     if (!av_fifo_size(c->fifo)) {
445         if (c->eof)
446             return AVERROR_EOF;
447         c->nb_failed_requests++;
448         return AVERROR(EAGAIN);
449     }
450     av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
451
452     ret = ff_filter_frame(link, frame);
453
454     return ret;
455 }
456
457 static int poll_frame(AVFilterLink *link)
458 {
459     BufferSourceContext *c = link->src->priv;
460     int size = av_fifo_size(c->fifo);
461     if (!size && c->eof)
462         return AVERROR_EOF;
463     return size/sizeof(AVFrame*);
464 }
465
466 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
467     {
468         .name          = "default",
469         .type          = AVMEDIA_TYPE_VIDEO,
470         .request_frame = request_frame,
471         .poll_frame    = poll_frame,
472         .config_props  = config_props,
473     },
474     { NULL }
475 };
476
477 AVFilter ff_vsrc_buffer = {
478     .name      = "buffer",
479     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
480     .priv_size = sizeof(BufferSourceContext),
481     .query_formats = query_formats,
482
483     .init      = init_video,
484     .uninit    = uninit,
485
486     .inputs    = NULL,
487     .outputs   = avfilter_vsrc_buffer_outputs,
488     .priv_class = &buffer_class,
489 };
490
491 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
492     {
493         .name          = "default",
494         .type          = AVMEDIA_TYPE_AUDIO,
495         .request_frame = request_frame,
496         .poll_frame    = poll_frame,
497         .config_props  = config_props,
498     },
499     { NULL }
500 };
501
502 AVFilter ff_asrc_abuffer = {
503     .name          = "abuffer",
504     .description   = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
505     .priv_size     = sizeof(BufferSourceContext),
506     .query_formats = query_formats,
507
508     .init      = init_audio,
509     .uninit    = uninit,
510
511     .inputs    = NULL,
512     .outputs   = avfilter_asrc_abuffer_outputs,
513     .priv_class = &abuffer_class,
514 };