3 * Copyright (c) 2007 Bobby Bingham
5 * This file is part of FFmpeg.
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.
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.
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
22 #include "libavutil/avassert.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/channel_layout.h"
25 #include "libavutil/common.h"
26 #include "libavutil/imgutils.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/pixdesc.h"
29 #include "libavutil/rational.h"
30 #include "libavutil/samplefmt.h"
38 static int ff_filter_frame_framed(AVFilterLink *link, AVFrame *frame);
40 void ff_tlog_ref(void *ctx, AVFrame *ref, int end)
42 av_unused char buf[16];
44 "ref[%p buf:%p data:%p linesize[%d, %d, %d, %d] pts:%"PRId64" pos:%"PRId64,
45 ref, ref->buf, ref->data[0],
46 ref->linesize[0], ref->linesize[1], ref->linesize[2], ref->linesize[3],
47 ref->pts, av_frame_get_pkt_pos(ref));
50 ff_tlog(ctx, " a:%d/%d s:%dx%d i:%c iskey:%d type:%c",
51 ref->sample_aspect_ratio.num, ref->sample_aspect_ratio.den,
52 ref->width, ref->height,
53 !ref->interlaced_frame ? 'P' : /* Progressive */
54 ref->top_field_first ? 'T' : 'B', /* Top / Bottom */
56 av_get_picture_type_char(ref->pict_type));
58 if (ref->nb_samples) {
59 ff_tlog(ctx, " cl:%"PRId64"d n:%d r:%d",
65 ff_tlog(ctx, "]%s", end ? "\n" : "");
68 unsigned avfilter_version(void) {
69 av_assert0(LIBAVFILTER_VERSION_MICRO >= 100);
70 return LIBAVFILTER_VERSION_INT;
73 const char *avfilter_configuration(void)
75 return FFMPEG_CONFIGURATION;
78 const char *avfilter_license(void)
80 #define LICENSE_PREFIX "libavfilter license: "
81 return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
84 void ff_command_queue_pop(AVFilterContext *filter)
86 AVFilterCommand *c= filter->command_queue;
88 av_freep(&c->command);
89 filter->command_queue= c->next;
93 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
94 AVFilterPad **pads, AVFilterLink ***links,
99 idx = FFMIN(idx, *count);
101 *pads = av_realloc(*pads, sizeof(AVFilterPad) * (*count + 1));
102 *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
103 memmove(*pads +idx+1, *pads +idx, sizeof(AVFilterPad) * (*count-idx));
104 memmove(*links+idx+1, *links+idx, sizeof(AVFilterLink*) * (*count-idx));
105 memcpy(*pads+idx, newpad, sizeof(AVFilterPad));
106 (*links)[idx] = NULL;
109 for (i = idx+1; i < *count; i++)
111 (*(unsigned *)((uint8_t *) *links[i] + padidx_off))++;
114 int avfilter_link(AVFilterContext *src, unsigned srcpad,
115 AVFilterContext *dst, unsigned dstpad)
119 if (src->nb_outputs <= srcpad || dst->nb_inputs <= dstpad ||
120 src->outputs[srcpad] || dst->inputs[dstpad])
123 if (src->output_pads[srcpad].type != dst->input_pads[dstpad].type) {
124 av_log(src, AV_LOG_ERROR,
125 "Media type mismatch between the '%s' filter output pad %d (%s) and the '%s' filter input pad %d (%s)\n",
126 src->name, srcpad, (char *)av_x_if_null(av_get_media_type_string(src->output_pads[srcpad].type), "?"),
127 dst->name, dstpad, (char *)av_x_if_null(av_get_media_type_string(dst-> input_pads[dstpad].type), "?"));
128 return AVERROR(EINVAL);
131 src->outputs[srcpad] =
132 dst-> inputs[dstpad] = link = av_mallocz(sizeof(AVFilterLink));
136 link->srcpad = &src->output_pads[srcpad];
137 link->dstpad = &dst->input_pads[dstpad];
138 link->type = src->output_pads[srcpad].type;
139 av_assert0(AV_PIX_FMT_NONE == -1 && AV_SAMPLE_FMT_NONE == -1);
145 void avfilter_link_free(AVFilterLink **link)
150 av_frame_free(&(*link)->partial_buf);
155 int avfilter_link_get_channels(AVFilterLink *link)
157 return link->channels;
160 void avfilter_link_set_closed(AVFilterLink *link, int closed)
162 link->closed = closed;
165 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
166 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx)
169 unsigned dstpad_idx = link->dstpad - link->dst->input_pads;
171 av_log(link->dst, AV_LOG_VERBOSE, "auto-inserting filter '%s' "
172 "between the filter '%s' and the filter '%s'\n",
173 filt->name, link->src->name, link->dst->name);
175 link->dst->inputs[dstpad_idx] = NULL;
176 if ((ret = avfilter_link(filt, filt_dstpad_idx, link->dst, dstpad_idx)) < 0) {
177 /* failed to link output filter to new filter */
178 link->dst->inputs[dstpad_idx] = link;
182 /* re-hookup the link to the new destination filter we inserted */
184 link->dstpad = &filt->input_pads[filt_srcpad_idx];
185 filt->inputs[filt_srcpad_idx] = link;
187 /* if any information on supported media formats already exists on the
188 * link, we need to preserve that */
189 if (link->out_formats)
190 ff_formats_changeref(&link->out_formats,
191 &filt->outputs[filt_dstpad_idx]->out_formats);
193 if (link->out_samplerates)
194 ff_formats_changeref(&link->out_samplerates,
195 &filt->outputs[filt_dstpad_idx]->out_samplerates);
196 if (link->out_channel_layouts)
197 ff_channel_layouts_changeref(&link->out_channel_layouts,
198 &filt->outputs[filt_dstpad_idx]->out_channel_layouts);
203 int avfilter_config_links(AVFilterContext *filter)
205 int (*config_link)(AVFilterLink *);
209 for (i = 0; i < filter->nb_inputs; i ++) {
210 AVFilterLink *link = filter->inputs[i];
211 AVFilterLink *inlink;
215 inlink = link->src->nb_inputs ? link->src->inputs[0] : NULL;
216 link->current_pts = AV_NOPTS_VALUE;
218 switch (link->init_state) {
221 case AVLINK_STARTINIT:
222 av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
225 link->init_state = AVLINK_STARTINIT;
227 if ((ret = avfilter_config_links(link->src)) < 0)
230 if (!(config_link = link->srcpad->config_props)) {
231 if (link->src->nb_inputs != 1) {
232 av_log(link->src, AV_LOG_ERROR, "Source filters and filters "
233 "with more than one input "
234 "must set config_props() "
235 "callbacks on all outputs\n");
236 return AVERROR(EINVAL);
238 } else if ((ret = config_link(link)) < 0) {
239 av_log(link->src, AV_LOG_ERROR,
240 "Failed to configure output pad on %s\n",
245 switch (link->type) {
246 case AVMEDIA_TYPE_VIDEO:
247 if (!link->time_base.num && !link->time_base.den)
248 link->time_base = inlink ? inlink->time_base : AV_TIME_BASE_Q;
250 if (!link->sample_aspect_ratio.num && !link->sample_aspect_ratio.den)
251 link->sample_aspect_ratio = inlink ?
252 inlink->sample_aspect_ratio : (AVRational){1,1};
254 if (inlink && !link->frame_rate.num && !link->frame_rate.den)
255 link->frame_rate = inlink->frame_rate;
262 } else if (!link->w || !link->h) {
263 av_log(link->src, AV_LOG_ERROR,
264 "Video source filters must set their output link's "
265 "width and height\n");
266 return AVERROR(EINVAL);
270 case AVMEDIA_TYPE_AUDIO:
272 if (!link->time_base.num && !link->time_base.den)
273 link->time_base = inlink->time_base;
276 if (!link->time_base.num && !link->time_base.den)
277 link->time_base = (AVRational) {1, link->sample_rate};
280 if ((config_link = link->dstpad->config_props))
281 if ((ret = config_link(link)) < 0) {
282 av_log(link->src, AV_LOG_ERROR,
283 "Failed to configure input pad on %s\n",
288 link->init_state = AVLINK_INIT;
295 void ff_tlog_link(void *ctx, AVFilterLink *link, int end)
297 if (link->type == AVMEDIA_TYPE_VIDEO) {
299 "link[%p s:%dx%d fmt:%s %s->%s]%s",
300 link, link->w, link->h,
301 av_get_pix_fmt_name(link->format),
302 link->src ? link->src->filter->name : "",
303 link->dst ? link->dst->filter->name : "",
307 av_get_channel_layout_string(buf, sizeof(buf), -1, link->channel_layout);
310 "link[%p r:%d cl:%s fmt:%s %s->%s]%s",
311 link, (int)link->sample_rate, buf,
312 av_get_sample_fmt_name(link->format),
313 link->src ? link->src->filter->name : "",
314 link->dst ? link->dst->filter->name : "",
319 int ff_request_frame(AVFilterLink *link)
322 FF_TPRINTF_START(NULL, request_frame); ff_tlog_link(NULL, link, 1);
326 if (link->srcpad->request_frame)
327 ret = link->srcpad->request_frame(link);
328 else if (link->src->inputs[0])
329 ret = ff_request_frame(link->src->inputs[0]);
330 if (ret == AVERROR_EOF && link->partial_buf) {
331 AVFrame *pbuf = link->partial_buf;
332 link->partial_buf = NULL;
333 ret = ff_filter_frame_framed(link, pbuf);
335 if (ret == AVERROR_EOF)
340 int ff_poll_frame(AVFilterLink *link)
342 int i, min = INT_MAX;
344 if (link->srcpad->poll_frame)
345 return link->srcpad->poll_frame(link);
347 for (i = 0; i < link->src->nb_inputs; i++) {
349 if (!link->src->inputs[i])
351 val = ff_poll_frame(link->src->inputs[i]);
352 min = FFMIN(min, val);
358 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts)
360 if (pts == AV_NOPTS_VALUE)
362 link->current_pts = av_rescale_q(pts, link->time_base, AV_TIME_BASE_Q);
363 /* TODO use duration */
364 if (link->graph && link->age_index >= 0)
365 ff_avfilter_graph_update_heap(link->graph, link);
368 int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags)
370 if(!strcmp(cmd, "ping")){
371 av_strlcatf(res, res_len, "pong from:%s %s\n", filter->filter->name, filter->name);
373 }else if(filter->filter->process_command) {
374 return filter->filter->process_command(filter, cmd, arg, res, res_len, flags);
376 return AVERROR(ENOSYS);
379 #define MAX_REGISTERED_AVFILTERS_NB 256
381 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
383 static int next_registered_avfilter_idx = 0;
385 AVFilter *avfilter_get_by_name(const char *name)
389 for (i = 0; registered_avfilters[i]; i++)
390 if (!strcmp(registered_avfilters[i]->name, name))
391 return registered_avfilters[i];
396 int avfilter_register(AVFilter *filter)
400 if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB) {
401 av_log(NULL, AV_LOG_ERROR,
402 "Maximum number of registered filters %d reached, "
403 "impossible to register filter with name '%s'\n",
404 MAX_REGISTERED_AVFILTERS_NB, filter->name);
405 return AVERROR(ENOMEM);
408 for(i=0; filter->inputs && filter->inputs[i].name; i++) {
409 const AVFilterPad *input = &filter->inputs[i];
410 av_assert0( !input->filter_frame
411 || (!input->start_frame && !input->end_frame));
414 registered_avfilters[next_registered_avfilter_idx++] = filter;
418 AVFilter **av_filter_next(AVFilter **filter)
420 return filter ? ++filter : ®istered_avfilters[0];
423 void avfilter_uninit(void)
425 memset(registered_avfilters, 0, sizeof(registered_avfilters));
426 next_registered_avfilter_idx = 0;
429 static int pad_count(const AVFilterPad *pads)
436 for(count = 0; pads->name; count ++) pads ++;
440 static const char *default_filter_name(void *filter_ctx)
442 AVFilterContext *ctx = filter_ctx;
443 return ctx->name ? ctx->name : ctx->filter->name;
446 static void *filter_child_next(void *obj, void *prev)
448 AVFilterContext *ctx = obj;
449 if (!prev && ctx->filter && ctx->filter->priv_class)
454 static const AVClass *filter_child_class_next(const AVClass *prev)
456 AVFilter **filter_ptr = NULL;
458 /* find the filter that corresponds to prev */
459 while (prev && *(filter_ptr = av_filter_next(filter_ptr)))
460 if ((*filter_ptr)->priv_class == prev)
463 /* could not find filter corresponding to prev */
464 if (prev && !(*filter_ptr))
467 /* find next filter with specific options */
468 while (*(filter_ptr = av_filter_next(filter_ptr)))
469 if ((*filter_ptr)->priv_class)
470 return (*filter_ptr)->priv_class;
474 static const AVClass avfilter_class = {
475 .class_name = "AVFilter",
476 .item_name = default_filter_name,
477 .version = LIBAVUTIL_VERSION_INT,
478 .category = AV_CLASS_CATEGORY_FILTER,
479 .child_next = filter_child_next,
480 .child_class_next = filter_child_class_next,
483 const AVClass *avfilter_get_class(void)
485 return &avfilter_class;
488 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
490 AVFilterContext *ret;
494 return AVERROR(EINVAL);
496 ret = av_mallocz(sizeof(AVFilterContext));
498 return AVERROR(ENOMEM);
500 ret->av_class = &avfilter_class;
501 ret->filter = filter;
502 ret->name = inst_name ? av_strdup(inst_name) : NULL;
503 if (filter->priv_size) {
504 ret->priv = av_mallocz(filter->priv_size);
509 ret->nb_inputs = pad_count(filter->inputs);
510 if (ret->nb_inputs ) {
511 ret->input_pads = av_malloc(sizeof(AVFilterPad) * ret->nb_inputs);
512 if (!ret->input_pads)
514 memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->nb_inputs);
515 ret->inputs = av_mallocz(sizeof(AVFilterLink*) * ret->nb_inputs);
520 ret->nb_outputs = pad_count(filter->outputs);
521 if (ret->nb_outputs) {
522 ret->output_pads = av_malloc(sizeof(AVFilterPad) * ret->nb_outputs);
523 if (!ret->output_pads)
525 memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->nb_outputs);
526 ret->outputs = av_mallocz(sizeof(AVFilterLink*) * ret->nb_outputs);
531 ret->output_count = ret->nb_outputs;
532 ret->input_count = ret->nb_inputs;
539 av_freep(&ret->inputs);
540 av_freep(&ret->input_pads);
542 av_freep(&ret->outputs);
543 av_freep(&ret->output_pads);
545 av_freep(&ret->priv);
547 return AVERROR(ENOMEM);
550 void avfilter_free(AVFilterContext *filter)
558 if (filter->filter->uninit)
559 filter->filter->uninit(filter);
560 if (filter->filter->shorthand)
561 av_opt_free(filter->priv);
563 for (i = 0; i < filter->nb_inputs; i++) {
564 if ((link = filter->inputs[i])) {
566 link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
567 ff_formats_unref(&link->in_formats);
568 ff_formats_unref(&link->out_formats);
569 ff_formats_unref(&link->in_samplerates);
570 ff_formats_unref(&link->out_samplerates);
571 ff_channel_layouts_unref(&link->in_channel_layouts);
572 ff_channel_layouts_unref(&link->out_channel_layouts);
574 avfilter_link_free(&link);
576 for (i = 0; i < filter->nb_outputs; i++) {
577 if ((link = filter->outputs[i])) {
579 link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
580 ff_formats_unref(&link->in_formats);
581 ff_formats_unref(&link->out_formats);
582 ff_formats_unref(&link->in_samplerates);
583 ff_formats_unref(&link->out_samplerates);
584 ff_channel_layouts_unref(&link->in_channel_layouts);
585 ff_channel_layouts_unref(&link->out_channel_layouts);
587 avfilter_link_free(&link);
590 av_freep(&filter->name);
591 av_freep(&filter->input_pads);
592 av_freep(&filter->output_pads);
593 av_freep(&filter->inputs);
594 av_freep(&filter->outputs);
595 av_freep(&filter->priv);
596 while(filter->command_queue){
597 ff_command_queue_pop(filter);
602 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
606 if (filter->filter->shorthand) {
607 av_assert0(filter->priv);
608 av_assert0(filter->filter->priv_class);
609 *(const AVClass **)filter->priv = filter->filter->priv_class;
610 av_opt_set_defaults(filter->priv);
611 ret = av_opt_set_from_string(filter->priv, args,
612 filter->filter->shorthand, "=", ":");
617 if (filter->filter->init_opaque)
618 ret = filter->filter->init_opaque(filter, args, opaque);
619 else if (filter->filter->init)
620 ret = filter->filter->init(filter, args);
624 const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx)
626 return pads[pad_idx].name;
629 enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx)
631 return pads[pad_idx].type;
634 static int default_filter_frame(AVFilterLink *link, AVFrame *frame)
636 return ff_filter_frame(link->dst->outputs[0], frame);
639 static int ff_filter_frame_framed(AVFilterLink *link, AVFrame *frame)
641 int (*filter_frame)(AVFilterLink *, AVFrame *);
642 AVFilterPad *dst = link->dstpad;
645 AVFilterCommand *cmd= link->dst->command_queue;
649 av_frame_free(&frame);
653 if (!(filter_frame = dst->filter_frame))
654 filter_frame = default_filter_frame;
656 /* copy the frame if needed */
657 if (dst->needs_writable && !av_frame_is_writable(frame)) {
658 av_log(link->dst, AV_LOG_DEBUG, "Copying data in avfilter.\n");
660 /* Maybe use ff_copy_buffer_ref instead? */
661 switch (link->type) {
662 case AVMEDIA_TYPE_VIDEO:
663 out = ff_get_video_buffer(link, link->w, link->h);
665 case AVMEDIA_TYPE_AUDIO:
666 out = ff_get_audio_buffer(link, frame->nb_samples);
668 default: return AVERROR(EINVAL);
671 av_frame_free(&frame);
672 return AVERROR(ENOMEM);
674 av_frame_copy_props(out, frame);
676 switch (link->type) {
677 case AVMEDIA_TYPE_VIDEO:
678 av_image_copy(out->data, out->linesize, (const uint8_t **)frame->data, frame->linesize,
679 frame->format, frame->width, frame->height);
681 case AVMEDIA_TYPE_AUDIO:
682 av_samples_copy(out->extended_data, frame->extended_data,
683 0, 0, frame->nb_samples,
684 av_get_channel_layout_nb_channels(frame->channel_layout),
687 default: return AVERROR(EINVAL);
690 av_frame_free(&frame);
694 while(cmd && cmd->time <= out->pts * av_q2d(link->time_base)){
695 av_log(link->dst, AV_LOG_DEBUG,
696 "Processing command time:%f command:%s arg:%s\n",
697 cmd->time, cmd->command, cmd->arg);
698 avfilter_process_command(link->dst, cmd->command, cmd->arg, 0, 0, cmd->flags);
699 ff_command_queue_pop(link->dst);
700 cmd= link->dst->command_queue;
704 ret = filter_frame(link, out);
705 ff_update_link_current_pts(link, pts);
709 static int ff_filter_frame_needs_framing(AVFilterLink *link, AVFrame *frame)
711 int insamples = frame->nb_samples, inpos = 0, nb_samples;
712 AVFrame *pbuf = link->partial_buf;
713 int nb_channels = av_frame_get_channels(frame);
716 /* Handle framing (min_samples, max_samples) */
719 AVRational samples_tb = { 1, link->sample_rate };
720 pbuf = ff_get_audio_buffer(link, link->partial_buf_size);
722 av_log(link->dst, AV_LOG_WARNING,
723 "Samples dropped due to memory allocation failure.\n");
726 av_frame_copy_props(pbuf, frame);
727 pbuf->pts = frame->pts +
728 av_rescale_q(inpos, samples_tb, link->time_base);
729 pbuf->nb_samples = 0;
731 nb_samples = FFMIN(insamples,
732 link->partial_buf_size - pbuf->nb_samples);
733 av_samples_copy(pbuf->extended_data, frame->extended_data,
734 pbuf->nb_samples, inpos,
735 nb_samples, nb_channels, link->format);
737 insamples -= nb_samples;
738 pbuf->nb_samples += nb_samples;
739 if (pbuf->nb_samples >= link->min_samples) {
740 ret = ff_filter_frame_framed(link, pbuf);
744 av_frame_free(&frame);
745 link->partial_buf = pbuf;
749 int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
751 FF_TPRINTF_START(NULL, filter_frame); ff_tlog_link(NULL, link, 1); ff_tlog(NULL, " "); ff_tlog_ref(NULL, frame, 1);
753 /* Consistency checks */
754 if (link->type == AVMEDIA_TYPE_VIDEO) {
755 if (strcmp(link->dst->filter->name, "scale")) {
756 av_assert1(frame->format == link->format);
757 av_assert1(frame->width == link->w);
758 av_assert1(frame->height == link->h);
761 av_assert1(frame->format == link->format);
762 av_assert1(av_frame_get_channels(frame) == link->channels);
763 av_assert1(frame->channel_layout == link->channel_layout);
764 av_assert1(frame->sample_rate == link->sample_rate);
767 /* Go directly to actual filtering if possible */
768 if (link->type == AVMEDIA_TYPE_AUDIO &&
770 (link->partial_buf ||
771 frame->nb_samples < link->min_samples ||
772 frame->nb_samples > link->max_samples)) {
773 return ff_filter_frame_needs_framing(link, frame);
775 return ff_filter_frame_framed(link, frame);