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 "libavcodec/audioconvert.c"
  25 #include "libavutil/pixdesc.h"
  26 #include "libavutil/rational.h"
  27 #include "libavcore/imgutils.h"
  28 #include "avfilter.h"
  29 #include "internal.h"
  30
  31 unsigned avfilter_version(void) {
  32     return LIBAVFILTER_VERSION_INT;
  33 }
  34
  35 const char *avfilter_configuration(void)
  36 {
  37     return FFMPEG_CONFIGURATION;
  38 }
  39
  40 const char *avfilter_license(void)
  41 {
  42 #define LICENSE_PREFIX "libavfilter license: "
  43     return LICENSE_PREFIX FFMPEG_LICENSE + sizeof(LICENSE_PREFIX) - 1;
  44 }
  45
  46 AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask)
  47 {
  48     AVFilterBufferRef *ret = av_malloc(sizeof(AVFilterBufferRef));
  49     if (!ret)
  50         return NULL;
  51     *ret = *ref;
  52     if (ref->type == AVMEDIA_TYPE_VIDEO) {
  53         ret->video = av_malloc(sizeof(AVFilterBufferRefVideoProps));
  54         if (!ret->video) {
  55             av_free(ret);
  56             return NULL;
  57         }
  58         *ret->video = *ref->video;
  59     } else if (ref->type == AVMEDIA_TYPE_AUDIO) {
  60         ret->audio = av_malloc(sizeof(AVFilterBufferRefAudioProps));
  61         if (!ret->audio) {
  62             av_free(ret);
  63             return NULL;
  64         }
  65         *ret->audio = *ref->audio;
  66     }
  67     ret->perms &= pmask;
  68     ret->buf->refcount ++;
  69     return ret;
  70 }
  71
  72 void avfilter_unref_buffer(AVFilterBufferRef *ref)
  73 {
  74     if (!(--ref->buf->refcount))
  75         ref->buf->free(ref->buf);
  76     av_free(ref->video);
  77     av_free(ref->audio);
  78     av_free(ref);
  79 }
  80
  81 void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
  82                          AVFilterPad **pads, AVFilterLink ***links,
  83                          AVFilterPad *newpad)
  84 {
  85     unsigned i;
  86
  87     idx = FFMIN(idx, *count);
  88
  89     *pads  = av_realloc(*pads,  sizeof(AVFilterPad)   * (*count + 1));
  90     *links = av_realloc(*links, sizeof(AVFilterLink*) * (*count + 1));
  91     memmove(*pads +idx+1, *pads +idx, sizeof(AVFilterPad)   * (*count-idx));
  92     memmove(*links+idx+1, *links+idx, sizeof(AVFilterLink*) * (*count-idx));
  93     memcpy(*pads+idx, newpad, sizeof(AVFilterPad));
  94     (*links)[idx] = NULL;
  95
  96     (*count)++;
  97     for (i = idx+1; i < *count; i++)
  98         if (*links[i])
  99             (*(unsigned *)((uint8_t *) *links[i] + padidx_off))++;
 100 }
 101
 102 int avfilter_link(AVFilterContext *src, unsigned srcpad,
 103                   AVFilterContext *dst, unsigned dstpad)
 104 {
 105     AVFilterLink *link;
 106
 107     if (src->output_count <= srcpad || dst->input_count <= dstpad ||
 108         src->outputs[srcpad]        || dst->inputs[dstpad])
 109         return -1;
 110
 111     src->outputs[srcpad] =
 112     dst-> inputs[dstpad] = link = av_mallocz(sizeof(AVFilterLink));
 113
 114     link->src     = src;
 115     link->dst     = dst;
 116     link->srcpad  = &src->output_pads[srcpad];
 117     link->dstpad  = &dst->input_pads[dstpad];
 118     link->type    = src->output_pads[srcpad].type;
 119     assert(PIX_FMT_NONE == -1 && SAMPLE_FMT_NONE == -1);
 120     link->format  = -1;
 121
 122     return 0;
 123 }
 124
 125 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
 126                            unsigned filt_srcpad_idx, unsigned filt_dstpad_idx)
 127 {
 128     int ret;
 129     unsigned dstpad_idx = link->dstpad - link->dst->input_pads;
 130
 131     av_log(link->dst, AV_LOG_INFO, "auto-inserting filter '%s' "
 132            "between the filter '%s' and the filter '%s'\n",
 133            filt->name, link->src->name, link->dst->name);
 134
 135     link->dst->inputs[dstpad_idx] = NULL;
 136     if ((ret = avfilter_link(filt, filt_dstpad_idx, link->dst, dstpad_idx)) < 0) {
 137         /* failed to link output filter to new filter */
 138         link->dst->inputs[dstpad_idx] = link;
 139         return ret;
 140     }
 141
 142     /* re-hookup the link to the new destination filter we inserted */
 143     link->dst = filt;
 144     link->dstpad = &filt->input_pads[filt_srcpad_idx];
 145     filt->inputs[filt_srcpad_idx] = link;
 146
 147     /* if any information on supported media formats already exists on the
 148      * link, we need to preserve that */
 149     if (link->out_formats)
 150         avfilter_formats_changeref(&link->out_formats,
 151                                    &filt->outputs[filt_dstpad_idx]->out_formats);
 152
 153     return 0;
 154 }
 155
 156 int avfilter_config_links(AVFilterContext *filter)
 157 {
 158     int (*config_link)(AVFilterLink *);
 159     unsigned i;
 160     int ret;
 161
 162     for (i = 0; i < filter->input_count; i ++) {
 163         AVFilterLink *link = filter->inputs[i];
 164
 165         if (!link) continue;
 166
 167         switch (link->init_state) {
 168         case AVLINK_INIT:
 169             continue;
 170         case AVLINK_STARTINIT:
 171             av_log(filter, AV_LOG_INFO, "circular filter chain detected\n");
 172             return 0;
 173         case AVLINK_UNINIT:
 174             link->init_state = AVLINK_STARTINIT;
 175
 176             if ((ret = avfilter_config_links(link->src)) < 0)
 177                 return ret;
 178
 179             if (!(config_link = link->srcpad->config_props))
 180                 config_link  = avfilter_default_config_output_link;
 181             if ((ret = config_link(link)) < 0)
 182                 return ret;
 183
 184             if (link->time_base.num == 0 && link->time_base.den == 0)
 185                 link->time_base = link->src && link->src->input_count ?
 186                     link->src->inputs[0]->time_base : AV_TIME_BASE_Q;
 187
 188             if ((config_link = link->dstpad->config_props))
 189                 if ((ret = config_link(link)) < 0)
 190                     return ret;
 191
 192             link->init_state = AVLINK_INIT;
 193         }
 194     }
 195
 196     return 0;
 197 }
 198
 199 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms)
 200 {
 201     snprintf(buf, buf_size, "%s%s%s%s%s",
 202              perms & AV_PERM_READ      ? "r" : "",
 203              perms & AV_PERM_WRITE     ? "w" : "",
 204              perms & AV_PERM_PRESERVE  ? "p" : "",
 205              perms & AV_PERM_REUSE     ? "r" : "",
 206              perms & AV_PERM_REUSE2    ? "R" : "");
 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 *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
 272                                              enum SampleFormat sample_fmt, int size,
 273                                              int64_t channel_layout, int planar)
 274 {
 275     AVFilterBufferRef *ret = NULL;
 276
 277     if (link->dstpad->get_audio_buffer)
 278         ret = link->dstpad->get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
 279
 280     if (!ret)
 281         ret = avfilter_default_get_audio_buffer(link, perms, sample_fmt, size, channel_layout, planar);
 282
 283     if (ret)
 284         ret->type = AVMEDIA_TYPE_AUDIO;
 285
 286     return ret;
 287 }
 288
 289 int avfilter_request_frame(AVFilterLink *link)
 290 {
 291     FF_DPRINTF_START(NULL, request_frame); ff_dprintf_link(NULL, link, 1);
 292
 293     if (link->srcpad->request_frame)
 294         return link->srcpad->request_frame(link);
 295     else if (link->src->inputs[0])
 296         return avfilter_request_frame(link->src->inputs[0]);
 297     else return -1;
 298 }
 299
 300 int avfilter_poll_frame(AVFilterLink *link)
 301 {
 302     int i, min = INT_MAX;
 303
 304     if (link->srcpad->poll_frame)
 305         return link->srcpad->poll_frame(link);
 306
 307     for (i = 0; i < link->src->input_count; i++) {
 308         int val;
 309         if (!link->src->inputs[i])
 310             return -1;
 311         val = avfilter_poll_frame(link->src->inputs[i]);
 312         min = FFMIN(min, val);
 313     }
 314
 315     return min;
 316 }
 317
 318 /* XXX: should we do the duplicating of the picture ref here, instead of
 319  * forcing the source filter to do it? */
 320 void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref)
 321 {
 322     void (*start_frame)(AVFilterLink *, AVFilterBufferRef *);
 323     AVFilterPad *dst = link->dstpad;
 324
 325     FF_DPRINTF_START(NULL, start_frame); ff_dprintf_link(NULL, link, 0); dprintf(NULL, " "); ff_dprintf_ref(NULL, picref, 1);
 326
 327     if (!(start_frame = dst->start_frame))
 328         start_frame = avfilter_default_start_frame;
 329
 330     /* prepare to copy the picture if it has insufficient permissions */
 331     if ((dst->min_perms & picref->perms) != dst->min_perms ||
 332          dst->rej_perms & picref->perms) {
 333         av_log(link->dst, AV_LOG_DEBUG,
 334                 "frame copy needed (have perms %x, need %x, reject %x)\n",
 335                 picref->perms,
 336                 link->dstpad->min_perms, link->dstpad->rej_perms);
 337
 338         link->cur_buf = avfilter_get_video_buffer(link, dst->min_perms, link->w, link->h);
 339         link->src_buf = picref;
 340         avfilter_copy_buffer_ref_props(link->cur_buf, link->src_buf);
 341     }
 342     else
 343         link->cur_buf = picref;
 344
 345     start_frame(link, link->cur_buf);
 346 }
 347
 348 void avfilter_end_frame(AVFilterLink *link)
 349 {
 350     void (*end_frame)(AVFilterLink *);
 351
 352     if (!(end_frame = link->dstpad->end_frame))
 353         end_frame = avfilter_default_end_frame;
 354
 355     end_frame(link);
 356
 357     /* unreference the source picture if we're feeding the destination filter
 358      * a copied version dues to permission issues */
 359     if (link->src_buf) {
 360         avfilter_unref_buffer(link->src_buf);
 361         link->src_buf = NULL;
 362     }
 363 }
 364
 365 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
 366 {
 367     uint8_t *src[4], *dst[4];
 368     int i, j, vsub;
 369     void (*draw_slice)(AVFilterLink *, int, int, int);
 370
 371     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);
 372
 373     /* copy the slice if needed for permission reasons */
 374     if (link->src_buf) {
 375         vsub = av_pix_fmt_descriptors[link->format].log2_chroma_h;
 376
 377         for (i = 0; i < 4; i++) {
 378             if (link->src_buf->data[i]) {
 379                 src[i] = link->src_buf-> data[i] +
 380                     (y >> (i==0 ? 0 : vsub)) * link->src_buf-> linesize[i];
 381                 dst[i] = link->cur_buf->data[i] +
 382                     (y >> (i==0 ? 0 : vsub)) * link->cur_buf->linesize[i];
 383             } else
 384                 src[i] = dst[i] = NULL;
 385         }
 386
 387         for (i = 0; i < 4; i++) {
 388             int planew =
 389                 av_image_get_linesize(link->format, link->cur_buf->video->w, i);
 390
 391             if (!src[i]) continue;
 392
 393             for (j = 0; j < h >> (i==0 ? 0 : vsub); j++) {
 394                 memcpy(dst[i], src[i], planew);
 395                 src[i] += link->src_buf->linesize[i];
 396                 dst[i] += link->cur_buf->linesize[i];
 397             }
 398         }
 399     }
 400
 401     if (!(draw_slice = link->dstpad->draw_slice))
 402         draw_slice = avfilter_default_draw_slice;
 403     draw_slice(link, y, h, slice_dir);
 404 }
 405
 406 void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref)
 407 {
 408     void (*filter_samples)(AVFilterLink *, AVFilterBufferRef *);
 409     AVFilterPad *dst = link->dstpad;
 410
 411     if (!(filter_samples = dst->filter_samples))
 412         filter_samples = avfilter_default_filter_samples;
 413
 414     /* prepare to copy the samples if the buffer has insufficient permissions */
 415     if ((dst->min_perms & samplesref->perms) != dst->min_perms ||
 416         dst->rej_perms & samplesref->perms) {
 417
 418         av_log(link->dst, AV_LOG_DEBUG,
 419                "Copying audio data in avfilter (have perms %x, need %x, reject %x)\n",
 420                samplesref->perms, link->dstpad->min_perms, link->dstpad->rej_perms);
 421
 422         link->cur_buf = avfilter_default_get_audio_buffer(link, dst->min_perms,
 423                                                           samplesref->format,
 424                                                           samplesref->audio->size,
 425                                                           samplesref->audio->channel_layout,
 426                                                           samplesref->audio->planar);
 427         link->cur_buf->pts                = samplesref->pts;
 428         link->cur_buf->audio->sample_rate = samplesref->audio->sample_rate;
 429
 430         /* Copy actual data into new samples buffer */
 431         memcpy(link->cur_buf->data[0], samplesref->data[0], samplesref->audio->size);
 432
 433         avfilter_unref_buffer(samplesref);
 434     } else
 435         link->cur_buf = samplesref;
 436
 437     filter_samples(link, link->cur_buf);
 438 }
 439
 440 #define MAX_REGISTERED_AVFILTERS_NB 64
 441
 442 static AVFilter *registered_avfilters[MAX_REGISTERED_AVFILTERS_NB + 1];
 443
 444 static int next_registered_avfilter_idx = 0;
 445
 446 AVFilter *avfilter_get_by_name(const char *name)
 447 {
 448     int i;
 449
 450     for (i = 0; registered_avfilters[i]; i++)
 451         if (!strcmp(registered_avfilters[i]->name, name))
 452             return registered_avfilters[i];
 453
 454     return NULL;
 455 }
 456
 457 int avfilter_register(AVFilter *filter)
 458 {
 459     if (next_registered_avfilter_idx == MAX_REGISTERED_AVFILTERS_NB)
 460         return -1;
 461
 462     registered_avfilters[next_registered_avfilter_idx++] = filter;
 463     return 0;
 464 }
 465
 466 AVFilter **av_filter_next(AVFilter **filter)
 467 {
 468     return filter ? ++filter : &registered_avfilters[0];
 469 }
 470
 471 void avfilter_uninit(void)
 472 {
 473     memset(registered_avfilters, 0, sizeof(registered_avfilters));
 474     next_registered_avfilter_idx = 0;
 475 }
 476
 477 static int pad_count(const AVFilterPad *pads)
 478 {
 479     int count;
 480
 481     for(count = 0; pads->name; count ++) pads ++;
 482     return count;
 483 }
 484
 485 static const char *filter_name(void *p)
 486 {
 487     AVFilterContext *filter = p;
 488     return filter->filter->name;
 489 }
 490
 491 static const AVClass avfilter_class = {
 492     "AVFilter",
 493     filter_name,
 494     NULL,
 495     LIBAVUTIL_VERSION_INT,
 496 };
 497
 498 int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name)
 499 {
 500     AVFilterContext *ret;
 501     *filter_ctx = NULL;
 502
 503     if (!filter)
 504         return AVERROR(EINVAL);
 505
 506     ret = av_mallocz(sizeof(AVFilterContext));
 507
 508     ret->av_class = &avfilter_class;
 509     ret->filter   = filter;
 510     ret->name     = inst_name ? av_strdup(inst_name) : NULL;
 511     ret->priv     = av_mallocz(filter->priv_size);
 512
 513     ret->input_count  = pad_count(filter->inputs);
 514     if (ret->input_count) {
 515         ret->input_pads   = av_malloc(sizeof(AVFilterPad) * ret->input_count);
 516         memcpy(ret->input_pads, filter->inputs, sizeof(AVFilterPad) * ret->input_count);
 517         ret->inputs       = av_mallocz(sizeof(AVFilterLink*) * ret->input_count);
 518     }
 519
 520     ret->output_count = pad_count(filter->outputs);
 521     if (ret->output_count) {
 522         ret->output_pads  = av_malloc(sizeof(AVFilterPad) * ret->output_count);
 523         memcpy(ret->output_pads, filter->outputs, sizeof(AVFilterPad) * ret->output_count);
 524         ret->outputs      = av_mallocz(sizeof(AVFilterLink*) * ret->output_count);
 525     }
 526
 527     *filter_ctx = ret;
 528     return 0;
 529 }
 530
 531 void avfilter_destroy(AVFilterContext *filter)
 532 {
 533     int i;
 534     AVFilterLink *link;
 535
 536     if (filter->filter->uninit)
 537         filter->filter->uninit(filter);
 538
 539     for (i = 0; i < filter->input_count; i++) {
 540         if ((link = filter->inputs[i])) {
 541             if (link->src)
 542                 link->src->outputs[link->srcpad - link->src->output_pads] = NULL;
 543             avfilter_formats_unref(&link->in_formats);
 544             avfilter_formats_unref(&link->out_formats);
 545         }
 546         av_freep(&link);
 547     }
 548     for (i = 0; i < filter->output_count; i++) {
 549         if ((link = filter->outputs[i])) {
 550             if (link->dst)
 551                 link->dst->inputs[link->dstpad - link->dst->input_pads] = NULL;
 552             avfilter_formats_unref(&link->in_formats);
 553             avfilter_formats_unref(&link->out_formats);
 554         }
 555         av_freep(&link);
 556     }
 557
 558     av_freep(&filter->name);
 559     av_freep(&filter->input_pads);
 560     av_freep(&filter->output_pads);
 561     av_freep(&filter->inputs);
 562     av_freep(&filter->outputs);
 563     av_freep(&filter->priv);
 564     av_free(filter);
 565 }
 566
 567 int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque)
 568 {
 569     int ret=0;
 570
 571     if (filter->filter->init)
 572         ret = filter->filter->init(filter, args, opaque);
 573     return ret;
 574 }
 575