lavfi/blackframe: add support for named options
[ffmpeg.git] / 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 <stdio.h>
31 #include <inttypes.h>
32
33 #include "libavutil/internal.h"
34 #include "libavutil/opt.h"
35 #include "avfilter.h"
36 #include "internal.h"
37 #include "formats.h"
38 #include "internal.h"
39 #include "video.h"
40
41 typedef struct {
42     const AVClass *class;
43     unsigned int bamount; ///< black amount
44     unsigned int bthresh; ///< black threshold
45     unsigned int frame;   ///< frame number
46     unsigned int nblack;  ///< number of black pixels counted so far
47     unsigned int last_keyframe; ///< frame number of the last received key-frame
48 } BlackFrameContext;
49
50 #define OFFSET(x) offsetof(BlackFrameContext, x)
51 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
52
53 static const AVOption blackframe_options[] = {
54     { "amount", "set least percentual amount of pixels below the black threshold enabling black detection", OFFSET(bamount), AV_OPT_TYPE_INT, {.i64=98}, 0, 100, FLAGS },
55     { "thresh", "set threshold below which a pixel value is considered black", OFFSET(bthresh), AV_OPT_TYPE_INT, {.i64=32}, 0, 255, FLAGS },
56     { NULL }
57 };
58
59 AVFILTER_DEFINE_CLASS(blackframe);
60
61 static int query_formats(AVFilterContext *ctx)
62 {
63     static const enum AVPixelFormat pix_fmts[] = {
64         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV420P, AV_PIX_FMT_GRAY8, AV_PIX_FMT_NV12,
65         AV_PIX_FMT_NV21, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV411P,
66         AV_PIX_FMT_NONE
67     };
68
69     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
70     return 0;
71 }
72
73 static av_cold int init(AVFilterContext *ctx, const char *args)
74 {
75     BlackFrameContext *blackframe = ctx->priv;
76     static const char *shorthand[] = { "amount", "thresh", NULL };
77     int ret;
78
79     blackframe->class = &blackframe_class;
80     av_opt_set_defaults(blackframe);
81
82     if ((ret = av_opt_set_from_string(blackframe, args, shorthand, "=", ":")) < 0)
83         return ret;
84
85     av_log(ctx, AV_LOG_VERBOSE, "bamount:%u bthresh:%u\n",
86            blackframe->bamount, blackframe->bthresh);
87
88     return 0;
89 }
90
91 static av_cold void uninit(AVFilterContext *ctx)
92 {
93     BlackFrameContext *blackframe = ctx->priv;
94     av_opt_free(blackframe);
95 }
96
97 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
98 {
99     AVFilterContext *ctx = inlink->dst;
100     BlackFrameContext *blackframe = ctx->priv;
101     int x, i;
102     int pblack = 0;
103     uint8_t *p = frame->data[0];
104
105     for (i = 0; i < frame->height; i++) {
106         for (x = 0; x < inlink->w; x++)
107             blackframe->nblack += p[x] < blackframe->bthresh;
108         p += frame->linesize[0];
109     }
110
111     if (frame->key_frame)
112         blackframe->last_keyframe = blackframe->frame;
113
114     pblack = blackframe->nblack * 100 / (inlink->w * inlink->h);
115     if (pblack >= blackframe->bamount)
116         av_log(ctx, AV_LOG_INFO, "frame:%u pblack:%u pts:%"PRId64" t:%f "
117                "type:%c last_keyframe:%d\n",
118                blackframe->frame, pblack, frame->pts,
119                frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base),
120                av_get_picture_type_char(frame->pict_type), blackframe->last_keyframe);
121
122     blackframe->frame++;
123     blackframe->nblack = 0;
124     return ff_filter_frame(inlink->dst->outputs[0], frame);
125 }
126
127 static const AVFilterPad avfilter_vf_blackframe_inputs[] = {
128     {
129         .name             = "default",
130         .type             = AVMEDIA_TYPE_VIDEO,
131         .get_video_buffer = ff_null_get_video_buffer,
132         .filter_frame     = filter_frame,
133     },
134     { NULL }
135 };
136
137 static const AVFilterPad avfilter_vf_blackframe_outputs[] = {
138     {
139         .name = "default",
140         .type = AVMEDIA_TYPE_VIDEO
141     },
142     { NULL }
143 };
144
145 AVFilter avfilter_vf_blackframe = {
146     .name        = "blackframe",
147     .description = NULL_IF_CONFIG_SMALL("Detect frames that are (almost) black."),
148
149     .priv_size = sizeof(BlackFrameContext),
150     .init      = init,
151     .uninit    = uninit,
152
153     .query_formats = query_formats,
154
155     .inputs    = avfilter_vf_blackframe_inputs,
156
157     .outputs   = avfilter_vf_blackframe_outputs,
158
159     .priv_class = &blackframe_class,
160 };