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