Merge commit 'e67a87eac814c7805d18c983c43033a8a1bd62af'
[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
77     av_log(ctx, AV_LOG_VERBOSE, "bamount:%u bthresh:%u\n",
78            blackframe->bamount, blackframe->bthresh);
79
80     return 0;
81 }
82
83 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
84 {
85     AVFilterContext *ctx = inlink->dst;
86     BlackFrameContext *blackframe = ctx->priv;
87     int x, i;
88     int pblack = 0;
89     uint8_t *p = frame->data[0];
90
91     for (i = 0; i < frame->height; i++) {
92         for (x = 0; x < inlink->w; x++)
93             blackframe->nblack += p[x] < blackframe->bthresh;
94         p += frame->linesize[0];
95     }
96
97     if (frame->key_frame)
98         blackframe->last_keyframe = blackframe->frame;
99
100     pblack = blackframe->nblack * 100 / (inlink->w * inlink->h);
101     if (pblack >= blackframe->bamount)
102         av_log(ctx, AV_LOG_INFO, "frame:%u pblack:%u pts:%"PRId64" t:%f "
103                "type:%c last_keyframe:%d\n",
104                blackframe->frame, pblack, frame->pts,
105                frame->pts == AV_NOPTS_VALUE ? -1 : frame->pts * av_q2d(inlink->time_base),
106                av_get_picture_type_char(frame->pict_type), blackframe->last_keyframe);
107
108     blackframe->frame++;
109     blackframe->nblack = 0;
110     return ff_filter_frame(inlink->dst->outputs[0], frame);
111 }
112
113 static const AVFilterPad avfilter_vf_blackframe_inputs[] = {
114     {
115         .name             = "default",
116         .type             = AVMEDIA_TYPE_VIDEO,
117         .get_video_buffer = ff_null_get_video_buffer,
118         .filter_frame     = filter_frame,
119     },
120     { NULL }
121 };
122
123 static const AVFilterPad avfilter_vf_blackframe_outputs[] = {
124     {
125         .name = "default",
126         .type = AVMEDIA_TYPE_VIDEO
127     },
128     { NULL }
129 };
130
131 static const char *const shorthand[] = { "amount", "thresh", NULL };
132
133 AVFilter avfilter_vf_blackframe = {
134     .name        = "blackframe",
135     .description = NULL_IF_CONFIG_SMALL("Detect frames that are (almost) black."),
136
137     .priv_size = sizeof(BlackFrameContext),
138     .init      = init,
139
140     .query_formats = query_formats,
141
142     .inputs    = avfilter_vf_blackframe_inputs,
143
144     .outputs   = avfilter_vf_blackframe_outputs,
145
146     .priv_class = &blackframe_class,
147     .shorthand  = shorthand,
148 };