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