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
24 #include "libavutil/pixdesc.h"
25 #include "libavutil/rational.h"
26 #include "libavcore/audioconvert.h"
27 #include "libavcore/imgutils.h"
31 unsigned avfilter_version(void) {
32 return LIBAVFILTER_VERSION_INT;
35 const char *avfilter_configuration(void)
37 return FFMPEG_CONFIGURATION;
40 const char *avfilter_license(void)
42 #define LICENSE_PREFIX "libavfilter license: "
43 return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
46 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask)
48 AVFilterBufferRef *ret = av_malloc(sizeof(AVFilterBufferRef));
52 if (ref->type == AVMEDIA_TYPE_VIDEO) {
53 ret->video = av_malloc(sizeof(AVFilterBufferRefVideoProps));
58 *ret->video = *ref->video;
59 } else if (ref->type == AVMEDIA_TYPE_AUDIO) {
60 ret->audio = av_malloc(sizeof(AVFilterBufferRefAudioProps));
65 *ret->audio = *ref->audio;
68 ret->buf->refcount ++;
72 void avfilter_unref_buffer(AVFilterBufferRef *ref)
76 if (!(--ref->buf->refcount))
77 ref->buf->free(ref->buf);
83 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
84 AVFilterPad **pads, AVFilterLink ***links,
89 idx = FFMIN(idx, *count);
91 *pads = av_realloc(*pads, sizeof(AVFilterPad) * (*count + 1));
92 *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
93 memmove(*pads +idx+1, *pads +idx, sizeof(AVFilterPad) * (*count-idx));
94 memmove(*links+idx+1, *links+idx, sizeof(AVFilterLink*) * (*count-idx));
95 memcpy(*pads+idx, newpad, sizeof(AVFilterPad));
99 for (i = idx+1; i < *count; i++)
101 (*(unsigned *)((uint8_t *) *links[i] + padidx_off))++;
104 int avfilter_link(AVFilterContext *src, unsigned srcpad,
105 AVFilterContext *dst, unsigned dstpad)
109 if (src->output_count <= srcpad || dst->input_count <= dstpad ||
110 src->outputs[srcpad] || dst->inputs[dstpad])
113 if (src->output_pads[srcpad].type != dst->input_pads[dstpad].type) {
114 av_log(src, AV_LOG_ERROR,
115 "Media type mismatch between the '%s' filter output pad %d and the '%s' filter input pad %d\n",
116 src->name, srcpad, dst->name, dstpad);
117 return AVERROR(EINVAL);
120 src->outputs[srcpad] =
121 dst-> inputs[dstpad] = link = av_mallocz(sizeof(AVFilterLink));
125 link->srcpad = &src->output_pads[srcpad];
126 link->dstpad = &dst->input_pads[dstpad];
127 link->type = src->output_pads[srcpad].type;
128 assert(PIX_FMT_NONE == -1 && AV_SAMPLE_FMT_NONE == -1);
134 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
135 unsigned filt_srcpad_idx, unsigned filt_dstpad_idx)
138 unsigned dstpad_idx = link->dstpad - link->dst->input_pads;
140 av_log(link->dst, AV_LOG_INFO, "auto-inserting filter '%s' "
141 "between the filter '%s' and the filter '%s'\n",
142 filt->name, link->src->name, link->dst->name);
144 link->dst->inputs[dstpad_idx] = NULL;
145 if ((ret = avfilter_link(filt, filt_dstpad_idx, link->dst, dstpad_idx)) < 0) {
146 /* failed to link output filter to new filter */
147 link->dst->inputs[dstpad_idx] = link;
151 /* re-hookup the link to the new destination filter we inserted */
153 link->dstpad = &filt->input_pads[filt_srcpad_idx];
154 filt->inputs[filt_srcpad_idx] = link;
156 /* if any information on supported media formats already exists on the
157 * link, we need to preserve that */
158 if (link->out_formats)
159 avfilter_formats_changeref(&link->out_formats,
160 &filt->outputs[filt_dstpad_idx]->out_formats);
165 int avfilter_config_links(AVFilterContext *filter)
167 int (*config_link)(AVFilterLink *);
171 for (i = 0; i < filter->input_count; i ++) {
172 AVFilterLink *link = filter->inputs[i];
176 switch (link->init_state) {
179 case AVLINK_STARTINIT:
180 av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
183 link->init_state = AVLINK_STARTINIT;
185 if ((ret = avfilter_config_links(link->src)) < 0)
188 if (!(config_link = link->srcpad->config_props))
189 config_link = avfilter_default_config_output_link;
190 if ((ret = config_link(link)) < 0)
193 if (link->time_base.num == 0 && link->time_base.den == 0)
194 link->time_base = link->src && link->src->input_count ?
195 link->src->inputs[0]->time_base : AV_TIME_BASE_Q;
197 if (link->sample_aspect_ratio.num == 0 && link->sample_aspect_ratio.den == 0)
198 link->sample_aspect_ratio = link->src->input_count ?
199 link->src->inputs[0]->sample_aspect_ratio : (AVRational){1,1};
201 if ((config_link = link->dstpad->config_props))
202 if ((ret = config_link(link)) < 0)
205 link->init_state = AVLINK_INIT;
212 static char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms)
214 snprintf(buf, buf_size, "%s%s%s%s%s%s",
215 perms & AV_PERM_READ ? "r" : "",
216 perms & AV_PERM_WRITE ? "w" : "",
217 perms & AV_PERM_PRESERVE ? "p" : "",
218 perms & AV_PERM_REUSE ? "u" : "",
219 perms & AV_PERM_REUSE2 ? "U" : "",
220 perms & AV_PERM_NEG_LINESIZES ? "n" : "");
224 static void ff_dlog_ref(void *ctx, AVFilterBufferRef *ref, int end)
226 av_unused char buf[16];
228 "ref[%p buf:%p refcount:%d perms:%s data:%p linesize[%d, %d, %d, %d] pts:%"PRId64" pos:%"PRId64,
229 ref, ref->buf, ref->buf->refcount, ff_get_ref_perms_string(buf, sizeof(buf), ref->perms), ref->data[0],
230 ref->linesize[0], ref->linesize[1], ref->linesize[2], ref->linesize[3],
234 av_dlog(ctx, " a:%d/%d s:%dx%d i:%c",
235 ref->video->pixel_aspect.num, ref->video->pixel_aspect.den,
236 ref->video->w, ref->video->h,
237 !ref->video->interlaced ? 'P' : /* Progressive */
238 ref->video->top_field_first ? 'T' : 'B'); /* Top / Bottom */
241 av_dlog(ctx, " cl:%"PRId64"d sn:%d s:%d sr:%d p:%d",
242 ref->audio->channel_layout,
243 ref->audio->nb_samples,
245 ref->audio->sample_rate,
249 av_dlog(ctx, "]%s", end ? "\n" : "");
252 static void ff_dlog_link(void *ctx, AVFilterLink *link, int end)
254 if (link->type == AVMEDIA_TYPE_VIDEO) {
256 "link[%p s:%dx%d fmt:%-16s %-16s->%-16s]%s",
257 link, link->w, link->h,
258 av_pix_fmt_descriptors[link->format].name,
259 link->src ? link->src->filter->name : "",
260 link->dst ? link->dst->filter->name : "",
264 av_get_channel_layout_string(buf, sizeof(buf), -1, link->channel_layout);
267 "link[%p r:%"PRId64" cl:%s fmt:%-16s %-16s->%-16s]%s",
268 link, link->sample_rate, buf,
269 av_get_sample_fmt_name(link->format),
270 link->src ? link->src->filter->name : "",
271 link->dst ? link->dst->filter->name : "",
276 #define FF_DPRINTF_START(ctx, func) av_dlog(NULL, "%-16s: ", #func)
278 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms, int w, int h)
280 AVFilterBufferRef *ret = NULL;
282 av_unused char buf[16];
283 FF_DPRINTF_START(NULL, get_video_buffer); ff_dlog_link(NULL, link, 0);
284 av_dlog(NULL, " perms:%s w:%d h:%d\n", ff_get_ref_perms_string(buf, sizeof(buf), perms), w, h);
286 if (link->dstpad->get_video_buffer)
287 ret = link->dstpad->get_video_buffer(link, perms, w, h);
290 ret = avfilter_default_get_video_buffer(link, perms, w, h);
293 ret->type = AVMEDIA_TYPE_VIDEO;
295 FF_DPRINTF_START(NULL, get_video_buffer); ff_dlog_link(NULL, link, 0); av_dlog(NULL, " returning "); ff_dlog_ref(NULL, ret, 1);
301 avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
302 int w, int h, enum PixelFormat format)
304 AVFilterBuffer *pic = av_mallocz(sizeof(AVFilterBuffer));
305 AVFilterBufferRef *picref = av_mallocz(sizeof(AVFilterBufferRef));
311 picref->buf->free = ff_avfilter_default_free_buffer;
312 if (!(picref->video = av_mallocz(sizeof(AVFilterBufferRefVideoProps))))
315 pic->w = picref->video->w = w;
316 pic->h = picref->video->h = h;
318 /* make sure the buffer gets read permission or it's useless for output */
319 picref->perms = perms | AV_PERM_READ;
322 picref->type = AVMEDIA_TYPE_VIDEO;
323 pic->format = picref->format = format;
325 memcpy(pic->data, data, sizeof(pic->data));
326 memcpy(pic->linesize, linesize, sizeof(pic->linesize));
327 memcpy(picref->data, pic->data, sizeof(picref->data));
328 memcpy(picref->linesize, pic->linesize, sizeof(picref->linesize));
333 if (picref && picref->video)
334 av_free(picref->video);
340 AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
341 enum AVSampleFormat sample_fmt, int size,
342 int64_t channel_layout, int planar)
344 AVFilterBufferRef *ret = NULL;
346 if (link->dstpad->get_audio_buffer)
347 ret = link->dstpad->get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
350 ret = avfilter_default_get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
353 ret->type = AVMEDIA_TYPE_AUDIO;
358 int avfilter_request_frame(AVFilterLink *link)
360 FF_DPRINTF_START(NULL, request_frame); ff_dlog_link(NULL, link, 1);
362 if (link->srcpad->request_frame)
363 return link->srcpad->request_frame(link);
364 else if (link->src->inputs[0])
365 return avfilter_request_frame(link->src->inputs[0]);
369 int avfilter_poll_frame(AVFilterLink *link)
371 int i, min = INT_MAX;
373 if (link->srcpad->poll_frame)
374 return link->srcpad->poll_frame(link);
376 for (i = 0; i < link->src->input_count; i++) {
378 if (!link->src->inputs[i])
380 val = avfilter_poll_frame(link->src->inputs[i]);
381 min = FFMIN(min, val);
387 /* XXX: should we do the duplicating of the picture ref here, instead of
388 * forcing the source filter to do it? */
389 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
391 void (*start_frame)(AVFilterLink *, AVFilterBufferRef *);
392 AVFilterPad *dst = link->dstpad;
393 int perms = picref->perms;
395 FF_DPRINTF_START(NULL, start_frame); ff_dlog_link(NULL, link, 0); av_dlog(NULL, " "); ff_dlog_ref(NULL, picref, 1);
397 if (!(start_frame = dst->start_frame))
398 start_frame = avfilter_default_start_frame;
400 if (picref->linesize[0] < 0)
401 perms |= AV_PERM_NEG_LINESIZES;
402 /* prepare to copy the picture if it has insufficient permissions */
403 if ((dst->min_perms & perms) != dst->min_perms || dst->rej_perms & perms) {
404 av_log(link->dst, AV_LOG_DEBUG,
405 "frame copy needed (have perms %x, need %x, reject %x)\n",
407 link->dstpad->min_perms, link->dstpad->rej_perms);
409 link->cur_buf = avfilter_get_video_buffer(link, dst->min_perms, link->w, link->h);
410 link->src_buf = picref;
411 avfilter_copy_buffer_ref_props(link->cur_buf, link->src_buf);
414 link->cur_buf = picref;
416 start_frame(link, link->cur_buf);
419 void avfilter_end_frame(AVFilterLink *link)
421 void (*end_frame)(AVFilterLink *);
423 if (!(end_frame = link->dstpad->end_frame))
424 end_frame = avfilter_default_end_frame;
428 /* unreference the source picture if we're feeding the destination filter
429 * a copied version dues to permission issues */
431 avfilter_unref_buffer(link->src_buf);
432 link->src_buf = NULL;
436 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
438 uint8_t *src[4], *dst[4];
440 void (*draw_slice)(AVFilterLink *, int, int, int);
442 FF_DPRINTF_START(NULL, draw_slice); ff_dlog_link(NULL, link, 0); av_dlog(NULL, " y:%d h:%d dir:%d\n", y, h, slice_dir);
444 /* copy the slice if needed for permission reasons */
446 vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
448 for (i = 0; i < 4; i++) {
449 if (link->src_buf->data[i]) {
450 src[i] = link->src_buf-> data[i] +
451 (y >> (i==1 || i==2 ? vsub : 0)) * link->src_buf-> linesize[i];
452 dst[i] = link->cur_buf->data[i] +
453 (y >> (i==1 || i==2 ? vsub : 0)) * link->cur_buf->linesize[i];
455 src[i] = dst[i] = NULL;
458 for (i = 0; i < 4; i++) {
460 av_image_get_linesize(link->format, link->cur_buf->video->w, i);
462 if (!src[i]) continue;
464 for (j = 0; j < h >> (i==1 || i==2 ? vsub : 0); j++) {
465 memcpy(dst[i], src[i], planew);
466 src[i] += link->src_buf->linesize[i];
467 dst[i] += link->cur_buf->linesize[i];
472 if (!(draw_slice = link->dstpad->draw_slice))
473 draw_slice = avfilter_default_draw_slice;
474 draw_slice(link, y, h, slice_dir);
477 void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref)
479 void (*filter_samples)(AVFilterLink *, AVFilterBufferRef *);
480 AVFilterPad *dst = link->dstpad;
482 FF_DPRINTF_START(NULL, filter_samples); ff_dlog_link(NULL, link, 1);
484 if (!(filter_samples = dst->filter_samples))
485 filter_samples = avfilter_default_filter_samples;
487 /* prepare to copy the samples if the buffer has insufficient permissions */
488 if ((dst->min_perms & samplesref->perms) != dst->min_perms ||
489 dst->rej_perms & samplesref->perms) {
491 av_log(link->dst, AV_LOG_DEBUG,
492 "Copying audio data in avfilter (have perms %x, need %x, reject %x)\n",
493 samplesref->perms, link->dstpad->min_perms, link->dstpad->rej_perms);
495 link->cur_buf = avfilter_default_get_audio_buffer(link, dst->min_perms,
497 samplesref->audio->size,
498 samplesref->audio->channel_layout,
499 samplesref->audio->planar);
500 link->cur_buf->pts = samplesref->pts;
501 link->cur_buf->audio->sample_rate = samplesref->audio->sample_rate;
503 /* Copy actual data into new samples buffer */
504 memcpy(link->cur_buf->data[0], samplesref->data[0], samplesref->audio->size);
506 avfilter_unref_buffer(samplesref);
508 link->cur_buf = samplesref;
510 filter_samples(link, link->cur_buf);
513 #define MAX_REGISTERED_AVFILTERS_NB 64
515 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
517 static int next_registered_avfilter_idx = 0;
519 AVFilter *avfilter_get_by_name(const char *name)
523 for (i = 0; registered_avfilters[i]; i++)
524 if (!strcmp(registered_avfilters[i]->name, name))
525 return registered_avfilters[i];
530 int avfilter_register(AVFilter *filter)
532 if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB)
535 registered_avfilters[next_registered_avfilter_idx++] = filter;
539 AVFilter **av_filter_next(AVFilter **filter)
541 return filter ? ++filter : ®istered_avfilters[0];
544 void avfilter_uninit(void)
546 memset(registered_avfilters, 0, sizeof(registered_avfilters));
547 next_registered_avfilter_idx = 0;
550 static int pad_count(const AVFilterPad *pads)
554 for(count = 0; pads->name; count ++) pads ++;
558 static const char *filter_name(void *p)
560 AVFilterContext *filter = p;
561 return filter->filter->name;
564 static const AVClass avfilter_class = {
568 LIBAVUTIL_VERSION_INT,
571 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
573 AVFilterContext *ret;
577 return AVERROR(EINVAL);
579 ret = av_mallocz(sizeof(AVFilterContext));
581 ret->av_class = &avfilter_class;
582 ret->filter = filter;
583 ret->name = inst_name ? av_strdup(inst_name) : NULL;
584 ret->priv = av_mallocz(filter->priv_size);
586 ret->input_count = pad_count(filter->inputs);
587 if (ret->input_count) {
588 ret->input_pads = av_malloc(sizeof(AVFilterPad) * ret->input_count);
589 memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->input_count);
590 ret->inputs = av_mallocz(sizeof(AVFilterLink*) * ret->input_count);
593 ret->output_count = pad_count(filter->outputs);
594 if (ret->output_count) {
595 ret->output_pads = av_malloc(sizeof(AVFilterPad) * ret->output_count);
596 memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->output_count);
597 ret->outputs = av_mallocz(sizeof(AVFilterLink*) * ret->output_count);
604 void avfilter_free(AVFilterContext *filter)
609 if (filter->filter->uninit)
610 filter->filter->uninit(filter);
612 for (i = 0; i < filter->input_count; i++) {
613 if ((link = filter->inputs[i])) {
615 link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
616 avfilter_formats_unref(&link->in_formats);
617 avfilter_formats_unref(&link->out_formats);
621 for (i = 0; i < filter->output_count; i++) {
622 if ((link = filter->outputs[i])) {
624 link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
625 avfilter_formats_unref(&link->in_formats);
626 avfilter_formats_unref(&link->out_formats);
631 av_freep(&filter->name);
632 av_freep(&filter->input_pads);
633 av_freep(&filter->output_pads);
634 av_freep(&filter->inputs);
635 av_freep(&filter->outputs);
636 av_freep(&filter->priv);
640 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
644 if (filter->filter->init)
645 ret = filter->filter->init(filter, args, opaque);