Replace deprecated symbols SAMPLE_FMT_* with AV_SAMPLE_FMT_*, and enum
[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",
201              perms & AV_PERM_READ      ? "r" : "",
202              perms & AV_PERM_WRITE     ? "w" : "",
203              perms & AV_PERM_PRESERVE  ? "p" : "",
204              perms & AV_PERM_REUSE     ? "r" : "",
205              perms & AV_PERM_REUSE2    ? "R" : "");
206     return buf;
207 }
208
209 void ff_dprintf_ref(void *ctx, AVFilterBufferRef *ref, int end)
210 {
211     av_unused char buf[16];
212     dprintf(ctx,
213             "ref[%p buf:%p refcount:%d perms:%s data:%p linesize[%d, %d, %d, %d] pts:%"PRId64" pos:%"PRId64,
214             ref, ref->buf, ref->buf->refcount, ff_get_ref_perms_string(buf, sizeof(buf), ref->perms), ref->data[0],
215             ref->linesize[0], ref->linesize[1], ref->linesize[2], ref->linesize[3],
216             ref->pts, ref->pos);
217
218     if (ref->video) {
219         dprintf(ctx, " a:%d/%d s:%dx%d i:%c",
220                 ref->video->pixel_aspect.num, ref->video->pixel_aspect.den,
221                 ref->video->w, ref->video->h,
222                 !ref->video->interlaced     ? 'P' :         /* Progressive  */
223                 ref->video->top_field_first ? 'T' : 'B');   /* Top / Bottom */
224     }
225     if (ref->audio) {
226         dprintf(ctx, " cl:%"PRId64"d sn:%d s:%d sr:%d p:%d",
227                 ref->audio->channel_layout,
228                 ref->audio->samples_nb,
229                 ref->audio->size,
230                 ref->audio->sample_rate,
231                 ref->audio->planar);
232     }
233
234     dprintf(ctx, "]%s", end ? "\n" : "");
235 }
236
237 void ff_dprintf_link(void *ctx, AVFilterLink *link, int end)
238 {
239     dprintf(ctx,
240             "link[%p s:%dx%d fmt:%-16s %-16s->%-16s]%s",
241             link, link->w, link->h,
242             av_pix_fmt_descriptors[link->format].name,
243             link->src ? link->src->filter->name : "",
244             link->dst ? link->dst->filter->name : "",
245             end ? "\n" : "");
246 }
247
248 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms, int w, int h)
249 {
250     AVFilterBufferRef *ret = NULL;
251
252     av_unused char buf[16];
253     FF_DPRINTF_START(NULL, get_video_buffer); ff_dprintf_link(NULL, link, 0);
254     dprintf(NULL, " perms:%s w:%d h:%d\n", ff_get_ref_perms_string(buf, sizeof(buf), perms), w, h);
255
256     if (link->dstpad->get_video_buffer)
257         ret = link->dstpad->get_video_buffer(link, perms, w, h);
258
259     if (!ret)
260         ret = avfilter_default_get_video_buffer(link, perms, w, h);
261
262     if (ret)
263         ret->type = AVMEDIA_TYPE_VIDEO;
264
265     FF_DPRINTF_START(NULL, get_video_buffer); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " returning "); ff_dprintf_ref(NULL, ret, 1);
266
267     return ret;
268 }
269
270 AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
271                                              enum AVSampleFormat sample_fmt, int size,
272                                              int64_t channel_layout, int planar)
273 {
274     AVFilterBufferRef *ret = NULL;
275
276     if (link->dstpad->get_audio_buffer)
277         ret = link->dstpad->get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
278
279     if (!ret)
280         ret = avfilter_default_get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
281
282     if (ret)
283         ret->type = AVMEDIA_TYPE_AUDIO;
284
285     return ret;
286 }
287
288 int avfilter_request_frame(AVFilterLink *link)
289 {
290     FF_DPRINTF_START(NULL, request_frame); ff_dprintf_link(NULL, link, 1);
291
292     if (link->srcpad->request_frame)
293         return link->srcpad->request_frame(link);
294     else if (link->src->inputs[0])
295         return avfilter_request_frame(link->src->inputs[0]);
296     else return -1;
297 }
298
299 int avfilter_poll_frame(AVFilterLink *link)
300 {
301     int i, min = INT_MAX;
302
303     if (link->srcpad->poll_frame)
304         return link->srcpad->poll_frame(link);
305
306     for (i = 0; i < link->src->input_count; i++) {
307         int val;
308         if (!link->src->inputs[i])
309             return -1;
310         val = avfilter_poll_frame(link->src->inputs[i]);
311         min = FFMIN(min, val);
312     }
313
314     return min;
315 }
316
317 /* XXX: should we do the duplicating of the picture ref here, instead of
318  * forcing the source filter to do it? */
319 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
320 {
321     void (*start_frame)(AVFilterLink *, AVFilterBufferRef *);
322     AVFilterPad *dst = link->dstpad;
323
324     FF_DPRINTF_START(NULL, start_frame); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " "); ff_dprintf_ref(NULL, picref, 1);
325
326     if (!(start_frame = dst->start_frame))
327         start_frame = avfilter_default_start_frame;
328
329     /* prepare to copy the picture if it has insufficient permissions */
330     if ((dst->min_perms & picref->perms) != dst->min_perms ||
331          dst->rej_perms & picref->perms) {
332         av_log(link->dst, AV_LOG_DEBUG,
333                 "frame copy needed (have perms %x, need %x, reject %x)\n",
334                 picref->perms,
335                 link->dstpad->min_perms, link->dstpad->rej_perms);
336
337         link->cur_buf = avfilter_get_video_buffer(link, dst->min_perms, link->w, link->h);
338         link->src_buf = picref;
339         avfilter_copy_buffer_ref_props(link->cur_buf, link->src_buf);
340     }
341     else
342         link->cur_buf = picref;
343
344     start_frame(link, link->cur_buf);
345 }
346
347 void avfilter_end_frame(AVFilterLink *link)
348 {
349     void (*end_frame)(AVFilterLink *);
350
351     if (!(end_frame = link->dstpad->end_frame))
352         end_frame = avfilter_default_end_frame;
353
354     end_frame(link);
355
356     /* unreference the source picture if we're feeding the destination filter
357      * a copied version dues to permission issues */
358     if (link->src_buf) {
359         avfilter_unref_buffer(link->src_buf);
360         link->src_buf = NULL;
361     }
362 }
363
364 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
365 {
366     uint8_t *src[4], *dst[4];
367     int i, j, vsub;
368     void (*draw_slice)(AVFilterLink *, int, int, int);
369
370     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);
371
372     /* copy the slice if needed for permission reasons */
373     if (link->src_buf) {
374         vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
375
376         for (i = 0; i < 4; i++) {
377             if (link->src_buf->data[i]) {
378                 src[i] = link->src_buf-> data[i] +
379                     (y >> (i==0 ? 0 : vsub)) * link->src_buf-> linesize[i];
380                 dst[i] = link->cur_buf->data[i] +
381                     (y >> (i==0 ? 0 : vsub)) * link->cur_buf->linesize[i];
382             } else
383                 src[i] = dst[i] = NULL;
384         }
385
386         for (i = 0; i < 4; i++) {
387             int planew =
388                 av_image_get_linesize(link->format, link->cur_buf->video->w, i);
389
390             if (!src[i]) continue;
391
392             for (j = 0; j < h >> (i==0 ? 0 : vsub); j++) {
393                 memcpy(dst[i], src[i], planew);
394                 src[i] += link->src_buf->linesize[i];
395                 dst[i] += link->cur_buf->linesize[i];
396             }
397         }
398     }
399
400     if (!(draw_slice = link->dstpad->draw_slice))
401         draw_slice = avfilter_default_draw_slice;
402     draw_slice(link, y, h, slice_dir);
403 }
404
405 void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref)
406 {
407     void (*filter_samples)(AVFilterLink *, AVFilterBufferRef *);
408     AVFilterPad *dst = link->dstpad;
409
410     if (!(filter_samples = dst->filter_samples))
411         filter_samples = avfilter_default_filter_samples;
412
413     /* prepare to copy the samples if the buffer has insufficient permissions */
414     if ((dst->min_perms & samplesref->perms) != dst->min_perms ||
415         dst->rej_perms & samplesref->perms) {
416
417         av_log(link->dst, AV_LOG_DEBUG,
418                "Copying audio data in avfilter (have perms %x, need %x, reject %x)\n",
419                samplesref->perms, link->dstpad->min_perms, link->dstpad->rej_perms);
420
421         link->cur_buf = avfilter_default_get_audio_buffer(link, dst->min_perms,
422                                                           samplesref->format,
423                                                           samplesref->audio->size,
424                                                           samplesref->audio->channel_layout,
425                                                           samplesref->audio->planar);
426         link->cur_buf->pts                = samplesref->pts;
427         link->cur_buf->audio->sample_rate = samplesref->audio->sample_rate;
428
429         /* Copy actual data into new samples buffer */
430         memcpy(link->cur_buf->data[0], samplesref->data[0], samplesref->audio->size);
431
432         avfilter_unref_buffer(samplesref);
433     } else
434         link->cur_buf = samplesref;
435
436     filter_samples(link, link->cur_buf);
437 }
438
439 #define MAX_REGISTERED_AVFILTERS_NB 64
440
441 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
442
443 static int next_registered_avfilter_idx = 0;
444
445 AVFilter *avfilter_get_by_name(const char *name)
446 {
447     int i;
448
449     for (i = 0; registered_avfilters[i]; i++)
450         if (!strcmp(registered_avfilters[i]->name, name))
451             return registered_avfilters[i];
452
453     return NULL;
454 }
455
456 int avfilter_register(AVFilter *filter)
457 {
458     if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB)
459         return -1;
460
461     registered_avfilters[next_registered_avfilter_idx++] = filter;
462     return 0;
463 }
464
465 AVFilter **av_filter_next(AVFilter **filter)
466 {
467     return filter ? ++filter : &registered_avfilters[0];
468 }
469
470 void avfilter_uninit(void)
471 {
472     memset(registered_avfilters, 0, sizeof(registered_avfilters));
473     next_registered_avfilter_idx = 0;
474 }
475
476 static int pad_count(const AVFilterPad *pads)
477 {
478     int count;
479
480     for(count = 0; pads->name; count ++) pads ++;
481     return count;
482 }
483
484 static const char *filter_name(void *p)
485 {
486     AVFilterContext *filter = p;
487     return filter->filter->name;
488 }
489
490 static const AVClass avfilter_class = {
491     "AVFilter",
492     filter_name,
493     NULL,
494     LIBAVUTIL_VERSION_INT,
495 };
496
497 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
498 {
499     AVFilterContext *ret;
500     *filter_ctx = NULL;
501
502     if (!filter)
503         return AVERROR(EINVAL);
504
505     ret = av_mallocz(sizeof(AVFilterContext));
506
507     ret->av_class = &avfilter_class;
508     ret->filter   = filter;
509     ret->name     = inst_name ? av_strdup(inst_name) : NULL;
510     ret->priv     = av_mallocz(filter->priv_size);
511
512     ret->input_count  = pad_count(filter->inputs);
513     if (ret->input_count) {
514         ret->input_pads   = av_malloc(sizeof(AVFilterPad) * ret->input_count);
515         memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->input_count);
516         ret->inputs       = av_mallocz(sizeof(AVFilterLink*) * ret->input_count);
517     }
518
519     ret->output_count = pad_count(filter->outputs);
520     if (ret->output_count) {
521         ret->output_pads  = av_malloc(sizeof(AVFilterPad) * ret->output_count);
522         memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->output_count);
523         ret->outputs      = av_mallocz(sizeof(AVFilterLink*) * ret->output_count);
524     }
525
526     *filter_ctx = ret;
527     return 0;
528 }
529
530 void avfilter_free(AVFilterContext *filter)
531 {
532     int i;
533     AVFilterLink *link;
534
535     if (filter->filter->uninit)
536         filter->filter->uninit(filter);
537
538     for (i = 0; i < filter->input_count; i++) {
539         if ((link = filter->inputs[i])) {
540             if (link->src)
541                 link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
542             avfilter_formats_unref(&link->in_formats);
543             avfilter_formats_unref(&link->out_formats);
544         }
545         av_freep(&link);
546     }
547     for (i = 0; i < filter->output_count; i++) {
548         if ((link = filter->outputs[i])) {
549             if (link->dst)
550                 link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
551             avfilter_formats_unref(&link->in_formats);
552             avfilter_formats_unref(&link->out_formats);
553         }
554         av_freep(&link);
555     }
556
557     av_freep(&filter->name);
558     av_freep(&filter->input_pads);
559     av_freep(&filter->output_pads);
560     av_freep(&filter->inputs);
561     av_freep(&filter->outputs);
562     av_freep(&filter->priv);
563     av_free(filter);
564 }
565
566 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
567 {
568     int ret=0;
569
570     if (filter->filter->init)
571         ret = filter->filter->init(filter, args, opaque);
572     return ret;
573 }
574