651f2ec4e822acefa7b908f73887fff7822f9edc
[ffmpeg.git] / libavfilter / buffersrc.c
1 /*
2  * Copyright (c) 2008 Vitor Sessak
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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
48     /* video only */
49     int               h, w;
50     enum AVPixelFormat  pix_fmt;
51     char               *pix_fmt_str;
52     AVRational        pixel_aspect;
53
54     /* audio only */
55     int sample_rate;
56     enum AVSampleFormat sample_fmt;
57     char               *sample_fmt_str;
58     uint64_t channel_layout;
59     char    *channel_layout_str;
60
61     int eof;
62 } BufferSourceContext;
63
64 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format)\
65     if (c->w != width || c->h != height || c->pix_fmt != format) {\
66         av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
67         return AVERROR(EINVAL);\
68     }
69
70 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, format)\
71     if (c->sample_fmt != format || c->sample_rate != srate ||\
72         c->channel_layout != ch_layout) {\
73         av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
74         return AVERROR(EINVAL);\
75     }
76
77 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
78 {
79     AVFrame *copy;
80     int ret = 0;
81
82     if (!(copy = av_frame_alloc()))
83         return AVERROR(ENOMEM);
84     ret = av_frame_ref(copy, frame);
85     if (ret >= 0)
86         ret = av_buffersrc_add_frame(ctx, copy);
87
88     av_frame_free(&copy);
89     return ret;
90 }
91
92 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx,
93                                                AVFrame *frame)
94 {
95     BufferSourceContext *s = ctx->priv;
96     AVFrame *copy;
97     int refcounted, ret;
98
99     if (!frame) {
100         s->eof = 1;
101         return 0;
102     } else if (s->eof)
103         return AVERROR(EINVAL);
104
105     refcounted = !!frame->buf[0];
106
107     switch (ctx->outputs[0]->type) {
108     case AVMEDIA_TYPE_VIDEO:
109         CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
110                                  frame->format);
111         break;
112     case AVMEDIA_TYPE_AUDIO:
113         CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
114                                  frame->format);
115         break;
116     default:
117         return AVERROR(EINVAL);
118     }
119
120     if (!av_fifo_space(s->fifo) &&
121         (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
122                                          sizeof(copy))) < 0)
123         return ret;
124
125     if (!(copy = av_frame_alloc()))
126         return AVERROR(ENOMEM);
127
128     if (refcounted) {
129         av_frame_move_ref(copy, frame);
130     } else {
131         ret = av_frame_ref(copy, frame);
132         if (ret < 0) {
133             av_frame_free(&copy);
134             return ret;
135         }
136     }
137
138     if ((ret = av_fifo_generic_write(s->fifo, &copy, sizeof(copy), NULL)) < 0) {
139         if (refcounted)
140             av_frame_move_ref(frame, copy);
141         av_frame_free(&copy);
142         return ret;
143     }
144
145     return 0;
146 }
147
148 static av_cold int init_video(AVFilterContext *ctx)
149 {
150     BufferSourceContext *c = ctx->priv;
151
152     if (!c->pix_fmt_str || !c->w || !c->h || av_q2d(c->time_base) <= 0) {
153         av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
154         return AVERROR(EINVAL);
155     }
156
157     if ((c->pix_fmt = av_get_pix_fmt(c->pix_fmt_str)) == AV_PIX_FMT_NONE) {
158         char *tail;
159         c->pix_fmt = strtol(c->pix_fmt_str, &tail, 10);
160         if (*tail || c->pix_fmt < 0 || !av_pix_fmt_desc_get(c->pix_fmt)) {
161             av_log(ctx, AV_LOG_ERROR, "Invalid pixel format string '%s'\n", c->pix_fmt_str);
162             return AVERROR(EINVAL);
163         }
164     }
165
166     if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
167         return AVERROR(ENOMEM);
168
169     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d pixfmt:%s\n", c->w, c->h, av_get_pix_fmt_name(c->pix_fmt));
170     return 0;
171 }
172
173 #define OFFSET(x) offsetof(BufferSourceContext, x)
174 #define A AV_OPT_FLAG_AUDIO_PARAM
175 #define V AV_OPT_FLAG_VIDEO_PARAM
176
177 static const AVOption video_options[] = {
178     { "width",         NULL,                     OFFSET(w),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
179     { "height",        NULL,                     OFFSET(h),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
180     { "pix_fmt",       NULL,                     OFFSET(pix_fmt_str),      AV_OPT_TYPE_STRING,                    .flags = V },
181 #if FF_API_OLD_FILTER_OPTS
182     /* those 4 are for compatibility with the old option passing system where each filter
183      * did its own parsing */
184     { "time_base_num", "deprecated, do not use", OFFSET(time_base.num),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
185     { "time_base_den", "deprecated, do not use", OFFSET(time_base.den),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
186     { "sar_num",       "deprecated, do not use", OFFSET(pixel_aspect.num), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
187     { "sar_den",       "deprecated, do not use", OFFSET(pixel_aspect.den), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
188 #endif
189     { "sar",           "sample aspect ratio",    OFFSET(pixel_aspect),     AV_OPT_TYPE_RATIONAL, { .dbl = 1 }, 0, DBL_MAX, V },
190     { "time_base",     NULL,                     OFFSET(time_base),        AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
191     { NULL },
192 };
193
194 static const AVClass buffer_class = {
195     .class_name = "buffer source",
196     .item_name  = av_default_item_name,
197     .option     = video_options,
198     .version    = LIBAVUTIL_VERSION_INT,
199 };
200
201 static const AVOption audio_options[] = {
202     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
203     { "sample_rate",    NULL, OFFSET(sample_rate),         AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, A },
204     { "sample_fmt",     NULL, OFFSET(sample_fmt_str),      AV_OPT_TYPE_STRING,             .flags = A },
205     { "channel_layout", NULL, OFFSET(channel_layout_str),  AV_OPT_TYPE_STRING,             .flags = A },
206     { NULL },
207 };
208
209 static const AVClass abuffer_class = {
210     .class_name = "abuffer source",
211     .item_name  = av_default_item_name,
212     .option     = audio_options,
213     .version    = LIBAVUTIL_VERSION_INT,
214 };
215
216 static av_cold int init_audio(AVFilterContext *ctx)
217 {
218     BufferSourceContext *s = ctx->priv;
219     int ret = 0;
220
221     s->sample_fmt = av_get_sample_fmt(s->sample_fmt_str);
222     if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
223         av_log(ctx, AV_LOG_ERROR, "Invalid sample format %s.\n",
224                s->sample_fmt_str);
225         return AVERROR(EINVAL);
226     }
227
228     s->channel_layout = av_get_channel_layout(s->channel_layout_str);
229     if (!s->channel_layout) {
230         av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
231                s->channel_layout_str);
232         return AVERROR(EINVAL);
233     }
234
235     if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
236         return AVERROR(ENOMEM);
237
238     if (!s->time_base.num)
239         s->time_base = (AVRational){1, s->sample_rate};
240
241     av_log(ctx, AV_LOG_VERBOSE, "tb:%d/%d samplefmt:%s samplerate: %d "
242            "ch layout:%s\n", s->time_base.num, s->time_base.den, s->sample_fmt_str,
243            s->sample_rate, s->channel_layout_str);
244
245     return ret;
246 }
247
248 static av_cold void uninit(AVFilterContext *ctx)
249 {
250     BufferSourceContext *s = ctx->priv;
251     while (s->fifo && av_fifo_size(s->fifo)) {
252         AVFrame *frame;
253         av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
254         av_frame_free(&frame);
255     }
256     av_fifo_free(s->fifo);
257     s->fifo = NULL;
258 }
259
260 static int query_formats(AVFilterContext *ctx)
261 {
262     BufferSourceContext *c = ctx->priv;
263     AVFilterChannelLayouts *channel_layouts = NULL;
264     AVFilterFormats *formats = NULL;
265     AVFilterFormats *samplerates = NULL;
266
267     switch (ctx->outputs[0]->type) {
268     case AVMEDIA_TYPE_VIDEO:
269         ff_add_format(&formats, c->pix_fmt);
270         ff_set_common_formats(ctx, formats);
271         break;
272     case AVMEDIA_TYPE_AUDIO:
273         ff_add_format(&formats,           c->sample_fmt);
274         ff_set_common_formats(ctx, formats);
275
276         ff_add_format(&samplerates,       c->sample_rate);
277         ff_set_common_samplerates(ctx, samplerates);
278
279         ff_add_channel_layout(&channel_layouts, c->channel_layout);
280         ff_set_common_channel_layouts(ctx, channel_layouts);
281         break;
282     default:
283         return AVERROR(EINVAL);
284     }
285
286     return 0;
287 }
288
289 static int config_props(AVFilterLink *link)
290 {
291     BufferSourceContext *c = link->src->priv;
292
293     switch (link->type) {
294     case AVMEDIA_TYPE_VIDEO:
295         link->w = c->w;
296         link->h = c->h;
297         link->sample_aspect_ratio = c->pixel_aspect;
298         break;
299     case AVMEDIA_TYPE_AUDIO:
300         link->channel_layout = c->channel_layout;
301         link->sample_rate    = c->sample_rate;
302         break;
303     default:
304         return AVERROR(EINVAL);
305     }
306
307     link->time_base = c->time_base;
308     return 0;
309 }
310
311 static int request_frame(AVFilterLink *link)
312 {
313     BufferSourceContext *c = link->src->priv;
314     AVFrame *frame;
315     int ret = 0;
316
317     if (!av_fifo_size(c->fifo)) {
318         if (c->eof)
319             return AVERROR_EOF;
320         return AVERROR(EAGAIN);
321     }
322     av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
323
324     ff_filter_frame(link, frame);
325
326     return ret;
327 }
328
329 static int poll_frame(AVFilterLink *link)
330 {
331     BufferSourceContext *c = link->src->priv;
332     int size = av_fifo_size(c->fifo);
333     if (!size && c->eof)
334         return AVERROR_EOF;
335     return size/sizeof(AVFrame*);
336 }
337
338 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
339     {
340         .name          = "default",
341         .type          = AVMEDIA_TYPE_VIDEO,
342         .request_frame = request_frame,
343         .poll_frame    = poll_frame,
344         .config_props  = config_props,
345     },
346     { NULL }
347 };
348
349 AVFilter ff_vsrc_buffer = {
350     .name      = "buffer",
351     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
352     .priv_size = sizeof(BufferSourceContext),
353     .priv_class = &buffer_class,
354     .query_formats = query_formats,
355
356     .init      = init_video,
357     .uninit    = uninit,
358
359     .inputs    = NULL,
360     .outputs   = avfilter_vsrc_buffer_outputs,
361 };
362
363 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
364     {
365         .name          = "default",
366         .type          = AVMEDIA_TYPE_AUDIO,
367         .request_frame = request_frame,
368         .poll_frame    = poll_frame,
369         .config_props  = config_props,
370     },
371     { NULL }
372 };
373
374 AVFilter ff_asrc_abuffer = {
375     .name          = "abuffer",
376     .description   = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
377     .priv_size     = sizeof(BufferSourceContext),
378     .priv_class    = &abuffer_class,
379     .query_formats = query_formats,
380
381     .init      = init_audio,
382     .uninit    = uninit,
383
384     .inputs    = NULL,
385     .outputs   = avfilter_asrc_abuffer_outputs,
386 };