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