FFmpeg
vf_blackframe.c
Go to the documentation of this file.
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 <stdio.h>
31 #include <inttypes.h>
32 
33 #include "libavutil/internal.h"
34 #include "libavutil/opt.h"
35 #include "avfilter.h"
36 #include "formats.h"
37 #include "internal.h"
38 #include "video.h"
39 
40 typedef struct BlackFrameContext {
41  const AVClass *class;
42  int bamount; ///< black amount
43  int bthresh; ///< black threshold
44  unsigned int frame; ///< frame number
45  unsigned int nblack; ///< number of black pixels counted so far
46  unsigned int last_keyframe; ///< frame number of the last received key-frame
48 
49 static const enum AVPixelFormat pix_fmts[] = {
53 };
54 
55 #define SET_META(key, format, value) \
56  snprintf(buf, sizeof(buf), format, value); \
57  av_dict_set(metadata, key, buf, 0)
58 
60 {
61  AVFilterContext *ctx = inlink->dst;
62  BlackFrameContext *s = ctx->priv;
63  int x, i;
64  int pblack = 0;
65  uint8_t *p = frame->data[0];
66  AVDictionary **metadata;
67  char buf[32];
68 
69  for (i = 0; i < frame->height; i++) {
70  for (x = 0; x < inlink->w; x++)
71  s->nblack += p[x] < s->bthresh;
72  p += frame->linesize[0];
73  }
74 
75  if (frame->key_frame)
76  s->last_keyframe = s->frame;
77 
78  pblack = s->nblack * 100 / (inlink->w * inlink->h);
79  if (pblack >= s->bamount) {
80  metadata = &frame->metadata;
81 
82  av_log(ctx, AV_LOG_INFO, "frame:%u pblack:%u pts:%"PRId64" t:%f "
83  "type:%c last_keyframe:%d\n",
84  s->frame, pblack, frame->pts,
85  frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base),
86  av_get_picture_type_char(frame->pict_type), s->last_keyframe);
87 
88  SET_META("lavfi.blackframe.pblack", "%u", pblack);
89  }
90 
91  s->frame++;
92  s->nblack = 0;
93  return ff_filter_frame(inlink->dst->outputs[0], frame);
94 }
95 
96 #define OFFSET(x) offsetof(BlackFrameContext, x)
97 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
98 static const AVOption blackframe_options[] = {
99  { "amount", "percentage of the pixels that have to be below the threshold "
100  "for the frame to be considered black", OFFSET(bamount), AV_OPT_TYPE_INT, { .i64 = 98 }, 0, 100, FLAGS },
101  { "threshold", "threshold below which a pixel value is considered black",
102  OFFSET(bthresh), AV_OPT_TYPE_INT, { .i64 = 32 }, 0, 255, FLAGS },
103  { "thresh", "threshold below which a pixel value is considered black",
104  OFFSET(bthresh), AV_OPT_TYPE_INT, { .i64 = 32 }, 0, 255, FLAGS },
105  { NULL }
106 };
107 
108 AVFILTER_DEFINE_CLASS(blackframe);
109 
111  {
112  .name = "default",
113  .type = AVMEDIA_TYPE_VIDEO,
114  .filter_frame = filter_frame,
115  },
116 };
117 
119  {
120  .name = "default",
121  .type = AVMEDIA_TYPE_VIDEO
122  },
123 };
124 
126  .name = "blackframe",
127  .description = NULL_IF_CONFIG_SMALL("Detect frames that are (almost) black."),
128  .priv_size = sizeof(BlackFrameContext),
129  .priv_class = &blackframe_class,
133 };
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
opt.h
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
FILTER_PIXFMTS_ARRAY
#define FILTER_PIXFMTS_ARRAY(array)
Definition: internal.h:171
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVOption
AVOption.
Definition: opt.h:247
AVDictionary
Definition: dict.c:30
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
avfilter_vf_blackframe_outputs
static const AVFilterPad avfilter_vf_blackframe_outputs[]
Definition: vf_blackframe.c:118
filter_frame
static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
Definition: vf_blackframe.c:59
video.h
BlackFrameContext::nblack
unsigned int nblack
number of black pixels counted so far
Definition: vf_blackframe.c:45
formats.h
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: vf_blackframe.c:49
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
s
#define s(width, name)
Definition: cbs_vp9.c:257
av_q2d
static double av_q2d(AVRational a)
Convert an AVRational to a double.
Definition: rational.h:104
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
SET_META
#define SET_META(key, format, value)
Definition: vf_blackframe.c:55
NULL
#define NULL
Definition: coverity.c:32
avfilter_vf_blackframe_inputs
static const AVFilterPad avfilter_vf_blackframe_inputs[]
Definition: vf_blackframe.c:110
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
BlackFrameContext::bthresh
int bthresh
black threshold
Definition: vf_blackframe.c:43
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
BlackFrameContext::bamount
int bamount
black amount
Definition: vf_blackframe.c:42
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
internal.h
FLAGS
#define FLAGS
Definition: vf_blackframe.c:97
av_get_picture_type_char
char av_get_picture_type_char(enum AVPictureType pict_type)
Return a single letter to describe the given picture type pict_type.
Definition: utils.c:83
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
internal.h
blackframe_options
static const AVOption blackframe_options[]
Definition: vf_blackframe.c:98
BlackFrameContext::frame
unsigned int frame
frame number
Definition: vf_blackframe.c:44
AV_PIX_FMT_NV21
@ AV_PIX_FMT_NV21
as above, but U and V bytes are swapped
Definition: pixfmt.h:90
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
OFFSET
#define OFFSET(x)
Definition: vf_blackframe.c:96
AVFilter
Filter definition.
Definition: avfilter.h:149
AV_PIX_FMT_NV12
@ AV_PIX_FMT_NV12
planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (firs...
Definition: pixfmt.h:89
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
ff_vf_blackframe
const AVFilter ff_vf_blackframe
Definition: vf_blackframe.c:125
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:71
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
AV_PIX_FMT_YUV411P
@ AV_PIX_FMT_YUV411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:73
AV_PIX_FMT_YUV410P
@ AV_PIX_FMT_YUV410P
planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
Definition: pixfmt.h:72
BlackFrameContext::last_keyframe
unsigned int last_keyframe
frame number of the last received key-frame
Definition: vf_blackframe.c:46
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
BlackFrameContext
Definition: vf_blackframe.c:40
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(blackframe)