lavfi: add a closed field to AVFilerLink.
[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 #include "libavutil/common.h"
23 #include "libavutil/pixdesc.h"
24 #include "libavutil/rational.h"
25 #include "libavutil/audioconvert.h"
26 #include "libavutil/avassert.h"
27 #include "libavutil/avstring.h"
28
29 #include "avfilter.h"
30 #include "formats.h"
31 #include "internal.h"
32 #include "audio.h"
33
34 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms)
35 {
36     snprintf(buf, buf_size, "%s%s%s%s%s%s",
37              perms & AV_PERM_READ      ? "r" : "",
38              perms & AV_PERM_WRITE     ? "w" : "",
39              perms & AV_PERM_PRESERVE  ? "p" : "",
40              perms & AV_PERM_REUSE     ? "u" : "",
41              perms & AV_PERM_REUSE2    ? "U" : "",
42              perms & AV_PERM_NEG_LINESIZES ? "n" : "");
43     return buf;
44 }
45
46 void ff_tlog_ref(void *ctx, AVFilterBufferRef *ref, int end)
47 {
48     av_unused char buf[16];
49     ff_tlog(ctx,
50             "ref[%p buf:%p refcount:%d perms:%s data:%p linesize[%d, %d, %d, %d] pts:%"PRId64" pos:%"PRId64,
51             ref, ref->buf, ref->buf->refcount, ff_get_ref_perms_string(buf, sizeof(buf), ref->perms), ref->data[0],
52             ref->linesize[0], ref->linesize[1], ref->linesize[2], ref->linesize[3],
53             ref->pts, ref->pos);
54
55     if (ref->video) {
56         ff_tlog(ctx, " a:%d/%d s:%dx%d i:%c iskey:%d type:%c",
57                 ref->video->sample_aspect_ratio.num, ref->video->sample_aspect_ratio.den,
58                 ref->video->w, ref->video->h,
59                 !ref->video->interlaced     ? 'P' :         /* Progressive  */
60                 ref->video->top_field_first ? 'T' : 'B',    /* Top / Bottom */
61                 ref->video->key_frame,
62                 av_get_picture_type_char(ref->video->pict_type));
63     }
64     if (ref->audio) {
65         ff_tlog(ctx, " cl:%"PRId64"d n:%d r:%d",
66                 ref->audio->channel_layout,
67                 ref->audio->nb_samples,
68                 ref->audio->sample_rate);
69     }
70
71     ff_tlog(ctx, "]%s", end ? "\n" : "");
72 }
73
74 unsigned avfilter_version(void) {
75     av_assert0(LIBAVFILTER_VERSION_MICRO >= 100);
76     return LIBAVFILTER_VERSION_INT;
77 }
78
79 const char *avfilter_configuration(void)
80 {
81     return FFMPEG_CONFIGURATION;
82 }
83
84 const char *avfilter_license(void)
85 {
86 #define LICENSE_PREFIX "libavfilter license: "
87     return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
88 }
89
90 void ff_command_queue_pop(AVFilterContext *filter)
91 {
92     AVFilterCommand *c= filter->command_queue;
93     av_freep(&c->arg);
94     av_freep(&c->command);
95     filter->command_queue= c->next;
96     av_free(c);
97 }
98
99 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
100                    AVFilterPad **pads, AVFilterLink ***links,
101                    AVFilterPad *newpad)
102 {
103     unsigned i;
104
105     idx = FFMIN(idx, *count);
106
107     *pads  = av_realloc(*pads,  sizeof(AVFilterPad)   * (*count + 1));
108     *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
109     memmove(*pads +idx+1, *pads +idx, sizeof(AVFilterPad)   * (*count-idx));
110     memmove(*links+idx+1, *links+idx, sizeof(AVFilterLink*) * (*count-idx));
111     memcpy(*pads+idx, newpad, sizeof(AVFilterPad));
112     (*links)[idx] = NULL;
113
114     (*count)++;
115     for (i = idx+1; i < *count; i++)
116         if (*links[i])
117             (*(unsigned *)((uint8_t *) *links[i] + padidx_off))++;
118 }
119
120 int avfilter_link(AVFilterContext *src, unsigned srcpad,
121                   AVFilterContext *dst, unsigned dstpad)
122 {
123     AVFilterLink *link;
124
125     if (src->nb_outputs <= srcpad || dst->nb_inputs <= dstpad ||
126         src->outputs[srcpad]      || dst->inputs[dstpad])
127         return -1;
128
129     if (src->output_pads[srcpad].type != dst->input_pads[dstpad].type) {
130         av_log(src, AV_LOG_ERROR,
131                "Media type mismatch between the '%s' filter output pad %d (%s) and the '%s' filter input pad %d (%s)\n",
132                src->name, srcpad, (char *)av_x_if_null(av_get_media_type_string(src->output_pads[srcpad].type), "?"),
133                dst->name, dstpad, (char *)av_x_if_null(av_get_media_type_string(dst-> input_pads[dstpad].type), "?"));
134         return AVERROR(EINVAL);
135     }
136
137     src->outputs[srcpad] =
138     dst-> inputs[dstpad] = link = av_mallocz(sizeof(AVFilterLink));
139
140     link->src     = src;
141     link->dst     = dst;
142     link->srcpad  = &src->output_pads[srcpad];
143     link->dstpad  = &dst->input_pads[dstpad];
144     link->type    = src->output_pads[srcpad].type;
145     av_assert0(PIX_FMT_NONE == -1 && AV_SAMPLE_FMT_NONE == -1);
146     link->format  = -1;
147
148     return 0;
149 }
150
151 void avfilter_link_free(AVFilterLink **link)
152 {
153     if (!*link)
154         return;
155
156     if ((*link)->pool)
157         ff_free_pool((*link)->pool);
158
159     av_freep(link);
160 }
161
162 void avfilter_link_set_closed(AVFilterLink *link, int closed)
163 {
164     link->closed = closed;
165 }
166
167 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
168                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx)
169 {
170     int ret;
171     unsigned dstpad_idx = link->dstpad - link->dst->input_pads;
172
173     av_log(link->dst, AV_LOG_VERBOSE, "auto-inserting filter '%s' "
174            "between the filter '%s' and the filter '%s'\n",
175            filt->name, link->src->name, link->dst->name);
176
177     link->dst->inputs[dstpad_idx] = NULL;
178     if ((ret = avfilter_link(filt, filt_dstpad_idx, link->dst, dstpad_idx)) < 0) {
179         /* failed to link output filter to new filter */
180         link->dst->inputs[dstpad_idx] = link;
181         return ret;
182     }
183
184     /* re-hookup the link to the new destination filter we inserted */
185     link->dst = filt;
186     link->dstpad = &filt->input_pads[filt_srcpad_idx];
187     filt->inputs[filt_srcpad_idx] = link;
188
189     /* if any information on supported media formats already exists on the
190      * link, we need to preserve that */
191     if (link->out_formats)
192         ff_formats_changeref(&link->out_formats,
193                                    &filt->outputs[filt_dstpad_idx]->out_formats);
194
195     if (link->out_samplerates)
196         ff_formats_changeref(&link->out_samplerates,
197                                    &filt->outputs[filt_dstpad_idx]->out_samplerates);
198     if (link->out_channel_layouts)
199         ff_channel_layouts_changeref(&link->out_channel_layouts,
200                                      &filt->outputs[filt_dstpad_idx]->out_channel_layouts);
201
202     return 0;
203 }
204
205 int avfilter_config_links(AVFilterContext *filter)
206 {
207     int (*config_link)(AVFilterLink *);
208     unsigned i;
209     int ret;
210
211     for (i = 0; i < filter->nb_inputs; i ++) {
212         AVFilterLink *link = filter->inputs[i];
213         AVFilterLink *inlink = link->src->nb_inputs ?
214             link->src->inputs[0] : NULL;
215
216         if (!link) continue;
217
218         link->current_pts = AV_NOPTS_VALUE;
219
220         switch (link->init_state) {
221         case AVLINK_INIT:
222             continue;
223         case AVLINK_STARTINIT:
224             av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
225             return 0;
226         case AVLINK_UNINIT:
227             link->init_state = AVLINK_STARTINIT;
228
229             if ((ret = avfilter_config_links(link->src)) < 0)
230                 return ret;
231
232             if (!(config_link = link->srcpad->config_props)) {
233                 if (link->src->nb_inputs != 1) {
234                     av_log(link->src, AV_LOG_ERROR, "Source filters and filters "
235                                                     "with more than one input "
236                                                     "must set config_props() "
237                                                     "callbacks on all outputs\n");
238                     return AVERROR(EINVAL);
239                 }
240             } else if ((ret = config_link(link)) < 0) {
241                 av_log(link->src, AV_LOG_ERROR,
242                        "Failed to configure output pad on %s\n",
243                        link->src->name);
244                 return ret;
245             }
246
247             switch (link->type) {
248             case AVMEDIA_TYPE_VIDEO:
249                 if (!link->time_base.num && !link->time_base.den)
250                     link->time_base = inlink ? inlink->time_base : AV_TIME_BASE_Q;
251
252                 if (!link->sample_aspect_ratio.num && !link->sample_aspect_ratio.den)
253                     link->sample_aspect_ratio = inlink ?
254                         inlink->sample_aspect_ratio : (AVRational){1,1};
255
256                 if (inlink && !link->frame_rate.num && !link->frame_rate.den)
257                     link->frame_rate = inlink->frame_rate;
258
259                 if (inlink) {
260                     if (!link->w)
261                         link->w = inlink->w;
262                     if (!link->h)
263                         link->h = inlink->h;
264                 } else if (!link->w || !link->h) {
265                     av_log(link->src, AV_LOG_ERROR,
266                            "Video source filters must set their output link's "
267                            "width and height\n");
268                     return AVERROR(EINVAL);
269                 }
270                 break;
271
272             case AVMEDIA_TYPE_AUDIO:
273                 if (inlink) {
274                     if (!link->sample_rate)
275                         link->sample_rate = inlink->sample_rate;
276                     if (!link->time_base.num && !link->time_base.den)
277                         link->time_base = inlink->time_base;
278                 } else if (!link->sample_rate) {
279                     av_log(link->src, AV_LOG_ERROR,
280                            "Audio source filters must set their output link's "
281                            "sample_rate\n");
282                     return AVERROR(EINVAL);
283                 }
284
285                 if (!link->time_base.num && !link->time_base.den)
286                     link->time_base = (AVRational) {1, link->sample_rate};
287             }
288
289             if ((config_link = link->dstpad->config_props))
290                 if ((ret = config_link(link)) < 0) {
291                     av_log(link->src, AV_LOG_ERROR,
292                            "Failed to configure input pad on %s\n",
293                            link->dst->name);
294                     return ret;
295                 }
296
297             link->init_state = AVLINK_INIT;
298         }
299     }
300
301     return 0;
302 }
303
304 void ff_tlog_link(void *ctx, AVFilterLink *link, int end)
305 {
306     if (link->type == AVMEDIA_TYPE_VIDEO) {
307         ff_tlog(ctx,
308                 "link[%p s:%dx%d fmt:%s %s->%s]%s",
309                 link, link->w, link->h,
310                 av_pix_fmt_descriptors[link->format].name,
311                 link->src ? link->src->filter->name : "",
312                 link->dst ? link->dst->filter->name : "",
313                 end ? "\n" : "");
314     } else {
315         char buf[128];
316         av_get_channel_layout_string(buf, sizeof(buf), -1, link->channel_layout);
317
318         ff_tlog(ctx,
319                 "link[%p r:%d cl:%s fmt:%s %s->%s]%s",
320                 link, (int)link->sample_rate, buf,
321                 av_get_sample_fmt_name(link->format),
322                 link->src ? link->src->filter->name : "",
323                 link->dst ? link->dst->filter->name : "",
324                 end ? "\n" : "");
325     }
326 }
327
328 int ff_request_frame(AVFilterLink *link)
329 {
330     int ret = -1;
331     FF_TPRINTF_START(NULL, request_frame); ff_tlog_link(NULL, link, 1);
332
333     if (link->closed)
334         return AVERROR_EOF;
335     if (link->srcpad->request_frame)
336         ret = link->srcpad->request_frame(link);
337     else if (link->src->inputs[0])
338         ret = ff_request_frame(link->src->inputs[0]);
339     if (ret == AVERROR_EOF && link->partial_buf) {
340         AVFilterBufferRef *pbuf = link->partial_buf;
341         link->partial_buf = NULL;
342         ff_filter_samples_framed(link, pbuf);
343         return 0;
344     }
345     if (ret == AVERROR_EOF)
346         link->closed = 1;
347     return ret;
348 }
349
350 int ff_poll_frame(AVFilterLink *link)
351 {
352     int i, min = INT_MAX;
353
354     if (link->srcpad->poll_frame)
355         return link->srcpad->poll_frame(link);
356
357     for (i = 0; i < link->src->nb_inputs; i++) {
358         int val;
359         if (!link->src->inputs[i])
360             return -1;
361         val = ff_poll_frame(link->src->inputs[i]);
362         min = FFMIN(min, val);
363     }
364
365     return min;
366 }
367
368 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts)
369 {
370     if (pts == AV_NOPTS_VALUE)
371         return;
372     link->current_pts = av_rescale_q(pts, link->time_base, AV_TIME_BASE_Q);
373     /* TODO use duration */
374     if (link->graph && link->age_index >= 0)
375         ff_avfilter_graph_update_heap(link->graph, link);
376 }
377
378 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags)
379 {
380     if(!strcmp(cmd, "ping")){
381         av_strlcatf(res, res_len, "pong from:%s %s\n", filter->filter->name, filter->name);
382         return 0;
383     }else if(filter->filter->process_command) {
384         return filter->filter->process_command(filter, cmd, arg, res, res_len, flags);
385     }
386     return AVERROR(ENOSYS);
387 }
388
389 #define MAX_REGISTERED_AVFILTERS_NB 128
390
391 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
392
393 static int next_registered_avfilter_idx = 0;
394
395 AVFilter *avfilter_get_by_name(const char *name)
396 {
397     int i;
398
399     for (i = 0; registered_avfilters[i]; i++)
400         if (!strcmp(registered_avfilters[i]->name, name))
401             return registered_avfilters[i];
402
403     return NULL;
404 }
405
406 int avfilter_register(AVFilter *filter)
407 {
408     if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB) {
409         av_log(NULL, AV_LOG_ERROR,
410                "Maximum number of registered filters %d reached, "
411                "impossible to register filter with name '%s'\n",
412                MAX_REGISTERED_AVFILTERS_NB, filter->name);
413         return AVERROR(ENOMEM);
414     }
415
416     registered_avfilters[next_registered_avfilter_idx++] = filter;
417     return 0;
418 }
419
420 AVFilter **av_filter_next(AVFilter **filter)
421 {
422     return filter ? ++filter : &registered_avfilters[0];
423 }
424
425 void avfilter_uninit(void)
426 {
427     memset(registered_avfilters, 0, sizeof(registered_avfilters));
428     next_registered_avfilter_idx = 0;
429 }
430
431 static int pad_count(const AVFilterPad *pads)
432 {
433     int count;
434
435     for(count = 0; pads->name; count ++) pads ++;
436     return count;
437 }
438
439 static const char *default_filter_name(void *filter_ctx)
440 {
441     AVFilterContext *ctx = filter_ctx;
442     return ctx->name ? ctx->name : ctx->filter->name;
443 }
444
445 static void *filter_child_next(void *obj, void *prev)
446 {
447     AVFilterContext *ctx = obj;
448     if (!prev && ctx->filter && ctx->filter->priv_class)
449         return ctx->priv;
450     return NULL;
451 }
452
453 static const AVClass *filter_child_class_next(const AVClass *prev)
454 {
455     AVFilter **filter_ptr = NULL;
456
457     /* find the filter that corresponds to prev */
458     while (prev && *(filter_ptr = av_filter_next(filter_ptr)))
459         if ((*filter_ptr)->priv_class == prev)
460             break;
461
462     /* could not find filter corresponding to prev */
463     if (prev && !(*filter_ptr))
464         return NULL;
465
466     /* find next filter with specific options */
467     while (*(filter_ptr = av_filter_next(filter_ptr)))
468         if ((*filter_ptr)->priv_class)
469             return (*filter_ptr)->priv_class;
470     return NULL;
471 }
472
473 static const AVClass avfilter_class = {
474     .class_name = "AVFilter",
475     .item_name  = default_filter_name,
476     .version    = LIBAVUTIL_VERSION_INT,
477     .category   = AV_CLASS_CATEGORY_FILTER,
478     .child_next = filter_child_next,
479     .child_class_next = filter_child_class_next,
480 };
481
482 const AVClass *avfilter_get_class(void)
483 {
484     return &avfilter_class;
485 }
486
487 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
488 {
489     AVFilterContext *ret;
490     *filter_ctx = NULL;
491
492     if (!filter)
493         return AVERROR(EINVAL);
494
495     ret = av_mallocz(sizeof(AVFilterContext));
496     if (!ret)
497         return AVERROR(ENOMEM);
498
499     ret->av_class = &avfilter_class;
500     ret->filter   = filter;
501     ret->name     = inst_name ? av_strdup(inst_name) : NULL;
502     if (filter->priv_size) {
503         ret->priv     = av_mallocz(filter->priv_size);
504         if (!ret->priv)
505             goto err;
506     }
507
508     ret->nb_inputs = pad_count(filter->inputs);
509     if (ret->nb_inputs ) {
510         ret->input_pads   = av_malloc(sizeof(AVFilterPad) * ret->nb_inputs);
511         if (!ret->input_pads)
512             goto err;
513         memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->nb_inputs);
514         ret->inputs       = av_mallocz(sizeof(AVFilterLink*) * ret->nb_inputs);
515         if (!ret->inputs)
516             goto err;
517     }
518
519     ret->nb_outputs = pad_count(filter->outputs);
520     if (ret->nb_outputs) {
521         ret->output_pads  = av_malloc(sizeof(AVFilterPad) * ret->nb_outputs);
522         if (!ret->output_pads)
523             goto err;
524         memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->nb_outputs);
525         ret->outputs      = av_mallocz(sizeof(AVFilterLink*) * ret->nb_outputs);
526         if (!ret->outputs)
527             goto err;
528     }
529 #if FF_API_FOO_COUNT
530     ret->output_count = ret->nb_outputs;
531     ret->input_count  = ret->nb_inputs;
532 #endif
533
534     *filter_ctx = ret;
535     return 0;
536
537 err:
538     av_freep(&ret->inputs);
539     av_freep(&ret->input_pads);
540     ret->nb_inputs = 0;
541     av_freep(&ret->outputs);
542     av_freep(&ret->output_pads);
543     ret->nb_outputs = 0;
544     av_freep(&ret->priv);
545     av_free(ret);
546     return AVERROR(ENOMEM);
547 }
548
549 void avfilter_free(AVFilterContext *filter)
550 {
551     int i;
552     AVFilterLink *link;
553
554     if (!filter)
555         return;
556
557     if (filter->filter->uninit)
558         filter->filter->uninit(filter);
559
560     for (i = 0; i < filter->nb_inputs; i++) {
561         if ((link = filter->inputs[i])) {
562             if (link->src)
563                 link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
564             ff_formats_unref(&link->in_formats);
565             ff_formats_unref(&link->out_formats);
566             ff_formats_unref(&link->in_samplerates);
567             ff_formats_unref(&link->out_samplerates);
568             ff_channel_layouts_unref(&link->in_channel_layouts);
569             ff_channel_layouts_unref(&link->out_channel_layouts);
570         }
571         avfilter_link_free(&link);
572     }
573     for (i = 0; i < filter->nb_outputs; i++) {
574         if ((link = filter->outputs[i])) {
575             if (link->dst)
576                 link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
577             ff_formats_unref(&link->in_formats);
578             ff_formats_unref(&link->out_formats);
579             ff_formats_unref(&link->in_samplerates);
580             ff_formats_unref(&link->out_samplerates);
581             ff_channel_layouts_unref(&link->in_channel_layouts);
582             ff_channel_layouts_unref(&link->out_channel_layouts);
583         }
584         avfilter_link_free(&link);
585     }
586
587     av_freep(&filter->name);
588     av_freep(&filter->input_pads);
589     av_freep(&filter->output_pads);
590     av_freep(&filter->inputs);
591     av_freep(&filter->outputs);
592     av_freep(&filter->priv);
593     while(filter->command_queue){
594         ff_command_queue_pop(filter);
595     }
596     av_free(filter);
597 }
598
599 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
600 {
601     int ret=0;
602
603     if (filter->filter->init_opaque)
604         ret = filter->filter->init_opaque(filter, args, opaque);
605     else if (filter->filter->init)
606         ret = filter->filter->init(filter, args);
607     return ret;
608 }
609
610 const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx)
611 {
612     return pads[pad_idx].name;
613 }
614
615 enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx)
616 {
617     return pads[pad_idx].type;
618 }