libavfilter/vf_blackframe.c

   1 /*
   2  * Copyright (c) 2010 Stefano Sabatini
   3  * Copyright (c) 2006 Ivo van Poorten
   4  * Copyright (c) 2006 Julian Hall
   5  * Copyright (c) 2002-2003 Brian J. Murrell
   6  *
   7  * This file is part of FFmpeg.
   8  *
   9  * FFmpeg is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * FFmpeg is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with FFmpeg; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 /**
  25  * @file
  26  * Search for black frames to detect scene transitions.
  27  * Ported from MPlayer libmpcodecs/vf_blackframe.c.
  28  */
  29
  30 #include "avfilter.h"
  31
  32 typedef struct {
  33     unsigned int bamount; ///< black amount
  34     unsigned int bthresh; ///< black threshold
  35     unsigned int frame;   ///< frame number
  36     unsigned int nblack;  ///< number of black pixels counted so far
  37     unsigned int last_keyframe; ///< frame number of the last received key-frame
  38 } BlackFrameContext;
  39
  40 static int query_formats(AVFilterContext *ctx)
  41 {
  42     static const enum PixelFormat pix_fmts[] = {
  43         PIX_FMT_YUV410P, PIX_FMT_YUV420P, PIX_FMT_GRAY8, PIX_FMT_NV12,
  44         PIX_FMT_NV21, PIX_FMT_YUV444P, PIX_FMT_YUV422P, PIX_FMT_YUV411P,
  45         PIX_FMT_NONE
  46     };
  47
  48     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
  49     return 0;
  50 }
  51
  52 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
  53 {
  54     BlackFrameContext *blackframe = ctx->priv;
  55
  56     blackframe->bamount = 98;
  57     blackframe->bthresh = 32;
  58     blackframe->nblack = 0;
  59     blackframe->frame = 0;
  60     blackframe->last_keyframe = 0;
  61
  62     if (args)
  63         sscanf(args, "%u:%u", &blackframe->bamount, &blackframe->bthresh);
  64
  65     av_log(ctx, AV_LOG_INFO, "bamount:%u bthresh:%u\n",
  66            blackframe->bamount, blackframe->bthresh);
  67
  68     if (blackframe->bamount > 100 || blackframe->bthresh > 255) {
  69         av_log(ctx, AV_LOG_ERROR, "Too big value for bamount (max is 100) or bthresh (max is 255)\n");
  70         return AVERROR(EINVAL);
  71     }
  72
  73     return 0;
  74 }
  75
  76 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
  77 {
  78     AVFilterContext *ctx = inlink->dst;
  79     BlackFrameContext *blackframe = ctx->priv;
  80     AVFilterBufferRef *picref = inlink->cur_buf;
  81     int x, i;
  82     uint8_t *p = picref->data[0] + y * picref->linesize[0];
  83
  84     for (i = 0; i < h; i++) {
  85         for (x = 0; x < inlink->w; x++)
  86             blackframe->nblack += p[x] < blackframe->bthresh;
  87         p += picref->linesize[0];
  88     }
  89
  90     avfilter_draw_slice(ctx->outputs[0], y, h, slice_dir);
  91 }
  92
  93 static void end_frame(AVFilterLink *inlink)
  94 {
  95     AVFilterContext *ctx = inlink->dst;
  96     BlackFrameContext *blackframe = ctx->priv;
  97     AVFilterBufferRef *picref = inlink->cur_buf;
  98     int pblack = 0;
  99
 100     if (picref->video->key_frame)
 101         blackframe->last_keyframe = blackframe->frame;
 102
 103     pblack = blackframe->nblack * 100 / (inlink->w * inlink->h);
 104     if (pblack >= blackframe->bamount)
 105         av_log(ctx, AV_LOG_INFO, "frame:%u pblack:%u pos:%"PRId64" pts:%"PRId64" t:%f "
 106                "type:%c last_keyframe:%d\n",
 107                blackframe->frame, pblack, picref->pos, picref->pts,
 108                picref->pts == AV_NOPTS_VALUE ? -1 : picref->pts * av_q2d(inlink->time_base),
 109                av_get_picture_type_char(picref->video->pict_type), blackframe->last_keyframe);
 110
 111     blackframe->frame++;
 112     blackframe->nblack = 0;
 113     avfilter_end_frame(inlink->dst->outputs[0]);
 114 }
 115
 116 AVFilter avfilter_vf_blackframe = {
 117     .name        = "blackframe",
 118     .description = NULL_IF_CONFIG_SMALL("Detect frames that are (almost) black."),
 119
 120     .priv_size = sizeof(BlackFrameContext),
 121     .init      = init,
 122
 123     .query_formats = query_formats,
 124
 125     .inputs    = (AVFilterPad[]) {{ .name = "default",
 126                                     .type             = AVMEDIA_TYPE_VIDEO,
 127                                     .draw_slice       = draw_slice,
 128                                     .get_video_buffer = avfilter_null_get_video_buffer,
 129                                     .start_frame      = avfilter_null_start_frame,
 130                                     .end_frame        = end_frame, },
 131                                   { .name = NULL}},
 132
 133     .outputs   = (AVFilterPad[]) {{ .name             = "default",
 134                                     .type             = AVMEDIA_TYPE_VIDEO },
 135                                   { .name = NULL}},
 136 };