lavfi: remove avfilter_null_* from public API on next bump.
[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 Libav.
8  *
9  * Libav 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  * Libav 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 Libav; 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 #include "video.h"
32
33 typedef struct {
34     unsigned int bamount; ///< black amount
35     unsigned int bthresh; ///< black threshold
36     unsigned int frame;   ///< frame number
37     unsigned int nblack;  ///< number of black pixels counted so far
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_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
61     if (args)
62         sscanf(args, "%u:%u", &blackframe->bamount, &blackframe->bthresh);
63
64     av_log(ctx, AV_LOG_INFO, "bamount:%u bthresh:%u\n",
65            blackframe->bamount, blackframe->bthresh);
66
67     if (blackframe->bamount > 100 || blackframe->bthresh > 255) {
68         av_log(ctx, AV_LOG_ERROR, "Too big value for bamount (max is 100) or bthresh (max is 255)\n");
69         return AVERROR(EINVAL);
70     }
71
72     return 0;
73 }
74
75 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
76 {
77     AVFilterContext *ctx = inlink->dst;
78     BlackFrameContext *blackframe = ctx->priv;
79     AVFilterBufferRef *picref = inlink->cur_buf;
80     int x, i;
81     uint8_t *p = picref->data[0] + y * picref->linesize[0];
82
83     for (i = 0; i < h; i++) {
84         for (x = 0; x < inlink->w; x++)
85             blackframe->nblack += p[x] < blackframe->bthresh;
86         p += picref->linesize[0];
87     }
88
89     avfilter_draw_slice(ctx->outputs[0], y, h, slice_dir);
90 }
91
92 static void end_frame(AVFilterLink *inlink)
93 {
94     AVFilterContext *ctx = inlink->dst;
95     BlackFrameContext *blackframe = ctx->priv;
96     AVFilterBufferRef *picref = inlink->cur_buf;
97     int pblack = 0;
98
99     pblack = blackframe->nblack * 100 / (inlink->w * inlink->h);
100     if (pblack >= blackframe->bamount)
101         av_log(ctx, AV_LOG_INFO, "frame:%u pblack:%u pos:%"PRId64" pts:%"PRId64" t:%f\n",
102                blackframe->frame, pblack, picref->pos, picref->pts,
103                picref->pts == AV_NOPTS_VALUE ? -1 : picref->pts * av_q2d(inlink->time_base));
104
105     blackframe->frame++;
106     blackframe->nblack = 0;
107     avfilter_end_frame(inlink->dst->outputs[0]);
108 }
109
110 AVFilter avfilter_vf_blackframe = {
111     .name        = "blackframe",
112     .description = NULL_IF_CONFIG_SMALL("Detect frames that are (almost) black."),
113
114     .priv_size = sizeof(BlackFrameContext),
115     .init      = init,
116
117     .query_formats = query_formats,
118
119     .inputs    = (AVFilterPad[]) {{ .name = "default",
120                                     .type             = AVMEDIA_TYPE_VIDEO,
121                                     .draw_slice       = draw_slice,
122                                     .get_video_buffer = ff_null_get_video_buffer,
123                                     .start_frame      = ff_null_start_frame,
124                                     .end_frame        = end_frame, },
125                                   { .name = NULL}},
126
127     .outputs   = (AVFilterPad[]) {{ .name             = "default",
128                                     .type             = AVMEDIA_TYPE_VIDEO },
129                                   { .name = NULL}},
130 };