Include libavcore/audioconvert.h, required for
[ffmpeg.git] / libavfilter / avfilter.c
1 /*
2  * filter layer
3  * Copyright (c) 2007 Bobby Bingham
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /* #define DEBUG */
23
24 #include "libavutil/pixdesc.h"
25 #include "libavutil/rational.h"
26 #include "libavcore/audioconvert.h"
27 #include "libavcore/imgutils.h"
28 #include "avfilter.h"
29 #include "internal.h"
30
31 unsigned avfilter_version(void) {
32     return LIBAVFILTER_VERSION_INT;
33 }
34
35 const char *avfilter_configuration(void)
36 {
37     return FFMPEG_CONFIGURATION;
38 }
39
40 const char *avfilter_license(void)
41 {
42 #define LICENSE_PREFIX "libavfilter license: "
43     return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
44 }
45
46 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask)
47 {
48     AVFilterBufferRef *ret = av_malloc(sizeof(AVFilterBufferRef));
49     if (!ret)
50         return NULL;
51     *ret = *ref;
52     if (ref->type == AVMEDIA_TYPE_VIDEO) {
53         ret->video = av_malloc(sizeof(AVFilterBufferRefVideoProps));
54         if (!ret->video) {
55             av_free(ret);
56             return NULL;
57         }
58         *ret->video = *ref->video;
59     } else if (ref->type == AVMEDIA_TYPE_AUDIO) {
60         ret->audio = av_malloc(sizeof(AVFilterBufferRefAudioProps));
61         if (!ret->audio) {
62             av_free(ret);
63             return NULL;
64         }
65         *ret->audio = *ref->audio;
66     }
67     ret->perms &= pmask;
68     ret->buf->refcount ++;
69     return ret;
70 }
71
72 void avfilter_unref_buffer(AVFilterBufferRef *ref)
73 {
74     if (!ref)
75         return;
76     if (!(--ref->buf->refcount))
77         ref->buf->free(ref->buf);
78     av_free(ref->video);
79     av_free(ref->audio);
80     av_free(ref);
81 }
82
83 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
84                          AVFilterPad **pads, AVFilterLink ***links,
85                          AVFilterPad *newpad)
86 {
87     unsigned i;
88
89     idx = FFMIN(idx, *count);
90
91     *pads  = av_realloc(*pads,  sizeof(AVFilterPad)   * (*count + 1));
92     *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
93     memmove(*pads +idx+1, *pads +idx, sizeof(AVFilterPad)   * (*count-idx));
94     memmove(*links+idx+1, *links+idx, sizeof(AVFilterLink*) * (*count-idx));
95     memcpy(*pads+idx, newpad, sizeof(AVFilterPad));
96     (*links)[idx] = NULL;
97
98     (*count)++;
99     for (i = idx+1; i < *count; i++)
100         if (*links[i])
101             (*(unsigned *)((uint8_t *) *links[i] + padidx_off))++;
102 }
103
104 int avfilter_link(AVFilterContext *src, unsigned srcpad,
105                   AVFilterContext *dst, unsigned dstpad)
106 {
107     AVFilterLink *link;
108
109     if (src->output_count <= srcpad || dst->input_count <= dstpad ||
110         src->outputs[srcpad]        || dst->inputs[dstpad])
111         return -1;
112
113     if (src->output_pads[srcpad].type != dst->input_pads[dstpad].type) {
114         av_log(src, AV_LOG_ERROR,
115                "Media type mismatch between the '%s' filter output pad %d and the '%s' filter input pad %d\n",
116                src->name, srcpad, dst->name, dstpad);
117         return AVERROR(EINVAL);
118     }
119
120     src->outputs[srcpad] =
121     dst-> inputs[dstpad] = link = av_mallocz(sizeof(AVFilterLink));
122
123     link->src     = src;
124     link->dst     = dst;
125     link->srcpad  = &src->output_pads[srcpad];
126     link->dstpad  = &dst->input_pads[dstpad];
127     link->type    = src->output_pads[srcpad].type;
128     assert(PIX_FMT_NONE == -1 && AV_SAMPLE_FMT_NONE == -1);
129     link->format  = -1;
130
131     return 0;
132 }
133
134 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
135                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx)
136 {
137     int ret;
138     unsigned dstpad_idx = link->dstpad - link->dst->input_pads;
139
140     av_log(link->dst, AV_LOG_INFO, "auto-inserting filter '%s' "
141            "between the filter '%s' and the filter '%s'\n",
142            filt->name, link->src->name, link->dst->name);
143
144     link->dst->inputs[dstpad_idx] = NULL;
145     if ((ret = avfilter_link(filt, filt_dstpad_idx, link->dst, dstpad_idx)) < 0) {
146         /* failed to link output filter to new filter */
147         link->dst->inputs[dstpad_idx] = link;
148         return ret;
149     }
150
151     /* re-hookup the link to the new destination filter we inserted */
152     link->dst = filt;
153     link->dstpad = &filt->input_pads[filt_srcpad_idx];
154     filt->inputs[filt_srcpad_idx] = link;
155
156     /* if any information on supported media formats already exists on the
157      * link, we need to preserve that */
158     if (link->out_formats)
159         avfilter_formats_changeref(&link->out_formats,
160                                    &filt->outputs[filt_dstpad_idx]->out_formats);
161
162     return 0;
163 }
164
165 int avfilter_config_links(AVFilterContext *filter)
166 {
167     int (*config_link)(AVFilterLink *);
168     unsigned i;
169     int ret;
170
171     for (i = 0; i < filter->input_count; i ++) {
172         AVFilterLink *link = filter->inputs[i];
173
174         if (!link) continue;
175
176         switch (link->init_state) {
177         case AVLINK_INIT:
178             continue;
179         case AVLINK_STARTINIT:
180             av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
181             return 0;
182         case AVLINK_UNINIT:
183             link->init_state = AVLINK_STARTINIT;
184
185             if ((ret = avfilter_config_links(link->src)) < 0)
186                 return ret;
187
188             if (!(config_link = link->srcpad->config_props))
189                 config_link  = avfilter_default_config_output_link;
190             if ((ret = config_link(link)) < 0)
191                 return ret;
192
193             if (link->time_base.num == 0 && link->time_base.den == 0)
194                 link->time_base = link->src && link->src->input_count ?
195                     link->src->inputs[0]->time_base : AV_TIME_BASE_Q;
196
197             if ((config_link = link->dstpad->config_props))
198                 if ((ret = config_link(link)) < 0)
199                     return ret;
200
201             link->init_state = AVLINK_INIT;
202         }
203     }
204
205     return 0;
206 }
207
208 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms)
209 {
210     snprintf(buf, buf_size, "%s%s%s%s%s%s",
211              perms & AV_PERM_READ      ? "r" : "",
212              perms & AV_PERM_WRITE     ? "w" : "",
213              perms & AV_PERM_PRESERVE  ? "p" : "",
214              perms & AV_PERM_REUSE     ? "u" : "",
215              perms & AV_PERM_REUSE2    ? "U" : "",
216              perms & AV_PERM_NEG_LINESIZES ? "n" : "");
217     return buf;
218 }
219
220 void ff_dprintf_ref(void *ctx, AVFilterBufferRef *ref, int end)
221 {
222     av_unused char buf[16];
223     dprintf(ctx,
224             "ref[%p buf:%p refcount:%d perms:%s data:%p linesize[%d, %d, %d, %d] pts:%"PRId64" pos:%"PRId64,
225             ref, ref->buf, ref->buf->refcount, ff_get_ref_perms_string(buf, sizeof(buf), ref->perms), ref->data[0],
226             ref->linesize[0], ref->linesize[1], ref->linesize[2], ref->linesize[3],
227             ref->pts, ref->pos);
228
229     if (ref->video) {
230         dprintf(ctx, " a:%d/%d s:%dx%d i:%c",
231                 ref->video->pixel_aspect.num, ref->video->pixel_aspect.den,
232                 ref->video->w, ref->video->h,
233                 !ref->video->interlaced     ? 'P' :         /* Progressive  */
234                 ref->video->top_field_first ? 'T' : 'B');   /* Top / Bottom */
235     }
236     if (ref->audio) {
237         dprintf(ctx, " cl:%"PRId64"d sn:%d s:%d sr:%d p:%d",
238                 ref->audio->channel_layout,
239                 ref->audio->nb_samples,
240                 ref->audio->size,
241                 ref->audio->sample_rate,
242                 ref->audio->planar);
243     }
244
245     dprintf(ctx, "]%s", end ? "\n" : "");
246 }
247
248 void ff_dprintf_link(void *ctx, AVFilterLink *link, int end)
249 {
250     if (link->type == AVMEDIA_TYPE_VIDEO) {
251         dprintf(ctx,
252                 "link[%p s:%dx%d fmt:%-16s %-16s->%-16s]%s",
253                 link, link->w, link->h,
254                 av_pix_fmt_descriptors[link->format].name,
255                 link->src ? link->src->filter->name : "",
256                 link->dst ? link->dst->filter->name : "",
257                 end ? "\n" : "");
258     } else {
259         char buf[128];
260         av_get_channel_layout_string(buf, sizeof(buf), -1, link->channel_layout);
261
262         dprintf(ctx,
263                 "link[%p r:%"PRId64" cl:%s fmt:%-16s %-16s->%-16s]%s",
264                 link, link->sample_rate, buf,
265                 av_get_sample_fmt_name(link->format),
266                 link->src ? link->src->filter->name : "",
267                 link->dst ? link->dst->filter->name : "",
268                 end ? "\n" : "");
269     }
270 }
271
272 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms, int w, int h)
273 {
274     AVFilterBufferRef *ret = NULL;
275
276     av_unused char buf[16];
277     FF_DPRINTF_START(NULL, get_video_buffer); ff_dprintf_link(NULL, link, 0);
278     dprintf(NULL, " perms:%s w:%d h:%d\n", ff_get_ref_perms_string(buf, sizeof(buf), perms), w, h);
279
280     if (link->dstpad->get_video_buffer)
281         ret = link->dstpad->get_video_buffer(link, perms, w, h);
282
283     if (!ret)
284         ret = avfilter_default_get_video_buffer(link, perms, w, h);
285
286     if (ret)
287         ret->type = AVMEDIA_TYPE_VIDEO;
288
289     FF_DPRINTF_START(NULL, get_video_buffer); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " returning "); ff_dprintf_ref(NULL, ret, 1);
290
291     return ret;
292 }
293
294 AVFilterBufferRef *
295 avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
296                                           int w, int h, enum PixelFormat format)
297 {
298     AVFilterBuffer *pic = av_mallocz(sizeof(AVFilterBuffer));
299     AVFilterBufferRef *picref = av_mallocz(sizeof(AVFilterBufferRef));
300
301     if (!pic || !picref)
302         goto fail;
303
304     picref->buf = pic;
305     picref->buf->free = ff_avfilter_default_free_buffer;
306     if (!(picref->video = av_mallocz(sizeof(AVFilterBufferRefVideoProps))))
307         goto fail;
308
309     pic->w = picref->video->w = w;
310     pic->h = picref->video->h = h;
311
312     /* make sure the buffer gets read permission or it's useless for output */
313     picref->perms = perms | AV_PERM_READ;
314
315     pic->refcount = 1;
316     picref->type = AVMEDIA_TYPE_VIDEO;
317     pic->format = picref->format = format;
318
319     memcpy(pic->data,        data,          sizeof(pic->data));
320     memcpy(pic->linesize,    linesize,      sizeof(pic->linesize));
321     memcpy(picref->data,     pic->data,     sizeof(picref->data));
322     memcpy(picref->linesize, pic->linesize, sizeof(picref->linesize));
323
324     return picref;
325
326 fail:
327     if (picref && picref->video)
328         av_free(picref->video);
329     av_free(picref);
330     av_free(pic);
331     return NULL;
332 }
333
334 AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
335                                              enum AVSampleFormat sample_fmt, int size,
336                                              int64_t channel_layout, int planar)
337 {
338     AVFilterBufferRef *ret = NULL;
339
340     if (link->dstpad->get_audio_buffer)
341         ret = link->dstpad->get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
342
343     if (!ret)
344         ret = avfilter_default_get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
345
346     if (ret)
347         ret->type = AVMEDIA_TYPE_AUDIO;
348
349     return ret;
350 }
351
352 int avfilter_request_frame(AVFilterLink *link)
353 {
354     FF_DPRINTF_START(NULL, request_frame); ff_dprintf_link(NULL, link, 1);
355
356     if (link->srcpad->request_frame)
357         return link->srcpad->request_frame(link);
358     else if (link->src->inputs[0])
359         return avfilter_request_frame(link->src->inputs[0]);
360     else return -1;
361 }
362
363 int avfilter_poll_frame(AVFilterLink *link)
364 {
365     int i, min = INT_MAX;
366
367     if (link->srcpad->poll_frame)
368         return link->srcpad->poll_frame(link);
369
370     for (i = 0; i < link->src->input_count; i++) {
371         int val;
372         if (!link->src->inputs[i])
373             return -1;
374         val = avfilter_poll_frame(link->src->inputs[i]);
375         min = FFMIN(min, val);
376     }
377
378     return min;
379 }
380
381 /* XXX: should we do the duplicating of the picture ref here, instead of
382  * forcing the source filter to do it? */
383 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
384 {
385     void (*start_frame)(AVFilterLink *, AVFilterBufferRef *);
386     AVFilterPad *dst = link->dstpad;
387     int perms = picref->perms;
388
389     FF_DPRINTF_START(NULL, start_frame); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " "); ff_dprintf_ref(NULL, picref, 1);
390
391     if (!(start_frame = dst->start_frame))
392         start_frame = avfilter_default_start_frame;
393
394     if (picref->linesize[0] < 0)
395         perms |= AV_PERM_NEG_LINESIZES;
396     /* prepare to copy the picture if it has insufficient permissions */
397     if ((dst->min_perms & perms) != dst->min_perms || dst->rej_perms & perms) {
398         av_log(link->dst, AV_LOG_DEBUG,
399                 "frame copy needed (have perms %x, need %x, reject %x)\n",
400                 picref->perms,
401                 link->dstpad->min_perms, link->dstpad->rej_perms);
402
403         link->cur_buf = avfilter_get_video_buffer(link, dst->min_perms, link->w, link->h);
404         link->src_buf = picref;
405         avfilter_copy_buffer_ref_props(link->cur_buf, link->src_buf);
406     }
407     else
408         link->cur_buf = picref;
409
410     start_frame(link, link->cur_buf);
411 }
412
413 void avfilter_end_frame(AVFilterLink *link)
414 {
415     void (*end_frame)(AVFilterLink *);
416
417     if (!(end_frame = link->dstpad->end_frame))
418         end_frame = avfilter_default_end_frame;
419
420     end_frame(link);
421
422     /* unreference the source picture if we're feeding the destination filter
423      * a copied version dues to permission issues */
424     if (link->src_buf) {
425         avfilter_unref_buffer(link->src_buf);
426         link->src_buf = NULL;
427     }
428 }
429
430 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
431 {
432     uint8_t *src[4], *dst[4];
433     int i, j, vsub;
434     void (*draw_slice)(AVFilterLink *, int, int, int);
435
436     FF_DPRINTF_START(NULL, draw_slice); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " y:%d h:%d dir:%d\n", y, h, slice_dir);
437
438     /* copy the slice if needed for permission reasons */
439     if (link->src_buf) {
440         vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
441
442         for (i = 0; i < 4; i++) {
443             if (link->src_buf->data[i]) {
444                 src[i] = link->src_buf-> data[i] +
445                     (y >> (i==1 || i==2 ? vsub : 0)) * link->src_buf-> linesize[i];
446                 dst[i] = link->cur_buf->data[i] +
447                     (y >> (i==1 || i==2 ? vsub : 0)) * link->cur_buf->linesize[i];
448             } else
449                 src[i] = dst[i] = NULL;
450         }
451
452         for (i = 0; i < 4; i++) {
453             int planew =
454                 av_image_get_linesize(link->format, link->cur_buf->video->w, i);
455
456             if (!src[i]) continue;
457
458             for (j = 0; j < h >> (i==1 || i==2 ? vsub : 0); j++) {
459                 memcpy(dst[i], src[i], planew);
460                 src[i] += link->src_buf->linesize[i];
461                 dst[i] += link->cur_buf->linesize[i];
462             }
463         }
464     }
465
466     if (!(draw_slice = link->dstpad->draw_slice))
467         draw_slice = avfilter_default_draw_slice;
468     draw_slice(link, y, h, slice_dir);
469 }
470
471 void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref)
472 {
473     void (*filter_samples)(AVFilterLink *, AVFilterBufferRef *);
474     AVFilterPad *dst = link->dstpad;
475
476     if (!(filter_samples = dst->filter_samples))
477         filter_samples = avfilter_default_filter_samples;
478
479     /* prepare to copy the samples if the buffer has insufficient permissions */
480     if ((dst->min_perms & samplesref->perms) != dst->min_perms ||
481         dst->rej_perms & samplesref->perms) {
482
483         av_log(link->dst, AV_LOG_DEBUG,
484                "Copying audio data in avfilter (have perms %x, need %x, reject %x)\n",
485                samplesref->perms, link->dstpad->min_perms, link->dstpad->rej_perms);
486
487         link->cur_buf = avfilter_default_get_audio_buffer(link, dst->min_perms,
488                                                           samplesref->format,
489                                                           samplesref->audio->size,
490                                                           samplesref->audio->channel_layout,
491                                                           samplesref->audio->planar);
492         link->cur_buf->pts                = samplesref->pts;
493         link->cur_buf->audio->sample_rate = samplesref->audio->sample_rate;
494
495         /* Copy actual data into new samples buffer */
496         memcpy(link->cur_buf->data[0], samplesref->data[0], samplesref->audio->size);
497
498         avfilter_unref_buffer(samplesref);
499     } else
500         link->cur_buf = samplesref;
501
502     filter_samples(link, link->cur_buf);
503 }
504
505 #define MAX_REGISTERED_AVFILTERS_NB 64
506
507 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
508
509 static int next_registered_avfilter_idx = 0;
510
511 AVFilter *avfilter_get_by_name(const char *name)
512 {
513     int i;
514
515     for (i = 0; registered_avfilters[i]; i++)
516         if (!strcmp(registered_avfilters[i]->name, name))
517             return registered_avfilters[i];
518
519     return NULL;
520 }
521
522 int avfilter_register(AVFilter *filter)
523 {
524     if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB)
525         return -1;
526
527     registered_avfilters[next_registered_avfilter_idx++] = filter;
528     return 0;
529 }
530
531 AVFilter **av_filter_next(AVFilter **filter)
532 {
533     return filter ? ++filter : &registered_avfilters[0];
534 }
535
536 void avfilter_uninit(void)
537 {
538     memset(registered_avfilters, 0, sizeof(registered_avfilters));
539     next_registered_avfilter_idx = 0;
540 }
541
542 static int pad_count(const AVFilterPad *pads)
543 {
544     int count;
545
546     for(count = 0; pads->name; count ++) pads ++;
547     return count;
548 }
549
550 static const char *filter_name(void *p)
551 {
552     AVFilterContext *filter = p;
553     return filter->filter->name;
554 }
555
556 static const AVClass avfilter_class = {
557     "AVFilter",
558     filter_name,
559     NULL,
560     LIBAVUTIL_VERSION_INT,
561 };
562
563 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
564 {
565     AVFilterContext *ret;
566     *filter_ctx = NULL;
567
568     if (!filter)
569         return AVERROR(EINVAL);
570
571     ret = av_mallocz(sizeof(AVFilterContext));
572
573     ret->av_class = &avfilter_class;
574     ret->filter   = filter;
575     ret->name     = inst_name ? av_strdup(inst_name) : NULL;
576     ret->priv     = av_mallocz(filter->priv_size);
577
578     ret->input_count  = pad_count(filter->inputs);
579     if (ret->input_count) {
580         ret->input_pads   = av_malloc(sizeof(AVFilterPad) * ret->input_count);
581         memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->input_count);
582         ret->inputs       = av_mallocz(sizeof(AVFilterLink*) * ret->input_count);
583     }
584
585     ret->output_count = pad_count(filter->outputs);
586     if (ret->output_count) {
587         ret->output_pads  = av_malloc(sizeof(AVFilterPad) * ret->output_count);
588         memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->output_count);
589         ret->outputs      = av_mallocz(sizeof(AVFilterLink*) * ret->output_count);
590     }
591
592     *filter_ctx = ret;
593     return 0;
594 }
595
596 void avfilter_free(AVFilterContext *filter)
597 {
598     int i;
599     AVFilterLink *link;
600
601     if (filter->filter->uninit)
602         filter->filter->uninit(filter);
603
604     for (i = 0; i < filter->input_count; i++) {
605         if ((link = filter->inputs[i])) {
606             if (link->src)
607                 link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
608             avfilter_formats_unref(&link->in_formats);
609             avfilter_formats_unref(&link->out_formats);
610         }
611         av_freep(&link);
612     }
613     for (i = 0; i < filter->output_count; i++) {
614         if ((link = filter->outputs[i])) {
615             if (link->dst)
616                 link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
617             avfilter_formats_unref(&link->in_formats);
618             avfilter_formats_unref(&link->out_formats);
619         }
620         av_freep(&link);
621     }
622
623     av_freep(&filter->name);
624     av_freep(&filter->input_pads);
625     av_freep(&filter->output_pads);
626     av_freep(&filter->inputs);
627     av_freep(&filter->outputs);
628     av_freep(&filter->priv);
629     av_free(filter);
630 }
631
632 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
633 {
634     int ret=0;
635
636     if (filter->filter->init)
637         ret = filter->filter->init(filter, args, opaque);
638     return ret;
639 }
640