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