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