lavfi/blackdetect: fix pts time debug printing
[ffmpeg.git] / libavfilter / vf_blackdetect.c
1 /*
2  * Copyright (c) 2012 Stefano Sabatini
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * Video black detector, loosely based on blackframe with extended
24  * syntax and features
25  */
26
27 #include <float.h>
28 #include "libavutil/opt.h"
29 #include "libavutil/timestamp.h"
30 #include "avfilter.h"
31 #include "internal.h"
32
33 typedef struct {
34     const AVClass *class;
35     double  black_min_duration_time; ///< minimum duration of detected black, in seconds
36     int64_t black_min_duration;      ///< minimum duration of detected black, expressed in timebase units
37     int64_t black_start;             ///< pts start time of the first black picture
38     int64_t black_end;               ///< pts end time of the last black picture
39     int black_started;
40
41     double       picture_black_ratio_th;
42     double       pixel_black_th;
43     unsigned int pixel_black_th_i;
44
45     unsigned int frame_count;       ///< frame number
46     unsigned int nb_black_pixels;   ///< number of black pixels counted so far
47 } BlackDetectContext;
48
49 #define OFFSET(x) offsetof(BlackDetectContext, x)
50 static const AVOption blackdetect_options[] = {
51     { "d",                  "set minimum detected black duration in seconds", OFFSET(black_min_duration_time), AV_OPT_TYPE_DOUBLE, {.dbl=2}, 0, DBL_MAX},
52     { "black_min_duration", "set minimum detected black duration in seconds", OFFSET(black_min_duration_time), AV_OPT_TYPE_DOUBLE, {.dbl=2}, 0, DBL_MAX},
53     { "picture_black_ratio_th", "set the picture black ratio threshold", OFFSET(picture_black_ratio_th), AV_OPT_TYPE_DOUBLE, {.dbl=.98}, 0, 1},
54     { "pic_th",                 "set the picture black ratio threshold", OFFSET(picture_black_ratio_th), AV_OPT_TYPE_DOUBLE, {.dbl=.98}, 0, 1},
55     { "pixel_black_th", "set the pixel black threshold", OFFSET(pixel_black_th), AV_OPT_TYPE_DOUBLE, {.dbl=.10}, 0, 1},
56     { "pix_th",         "set the pixel black threshold", OFFSET(pixel_black_th), AV_OPT_TYPE_DOUBLE, {.dbl=.10}, 0, 1},
57     { NULL },
58 };
59
60 static const AVClass blackdetect_class = {
61     .class_name = "blackdetect",
62     .item_name  = av_default_item_name,
63     .option     = blackdetect_options,
64     .version    = LIBAVUTIL_VERSION_INT,
65     .category   = AV_CLASS_CATEGORY_FILTER,
66 };
67
68 #define YUVJ_FORMATS \
69     PIX_FMT_YUVJ420P, PIX_FMT_YUVJ422P, PIX_FMT_YUVJ444P, PIX_FMT_YUVJ440P
70
71 static enum PixelFormat yuvj_formats[] = {
72     YUVJ_FORMATS, PIX_FMT_NONE
73 };
74
75 static int query_formats(AVFilterContext *ctx)
76 {
77     static const enum PixelFormat pix_fmts[] = {
78         PIX_FMT_YUV410P, PIX_FMT_YUV420P, PIX_FMT_GRAY8, PIX_FMT_NV12,
79         PIX_FMT_NV21, PIX_FMT_YUV444P, PIX_FMT_YUV422P, PIX_FMT_YUV411P,
80         YUVJ_FORMATS,
81         PIX_FMT_NONE
82     };
83
84     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
85     return 0;
86 }
87
88 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
89 {
90     int ret;
91     BlackDetectContext *blackdetect = ctx->priv;
92
93     blackdetect->class = &blackdetect_class;
94     av_opt_set_defaults(blackdetect);
95
96     if ((ret = av_set_options_string(blackdetect, args, "=", ":")) < 0) {
97         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
98         return ret;
99     }
100
101     return 0;
102 }
103
104 static int config_input(AVFilterLink *inlink)
105 {
106     AVFilterContext *ctx = inlink->dst;
107     BlackDetectContext *blackdetect = ctx->priv;
108
109     blackdetect->black_min_duration =
110         blackdetect->black_min_duration_time / av_q2d(inlink->time_base);
111
112     blackdetect->pixel_black_th_i = ff_fmt_is_in(inlink->format, yuvj_formats) ?
113         // luminance_minimum_value + pixel_black_th * luminance_range_size
114              blackdetect->pixel_black_th *  255 :
115         16 + blackdetect->pixel_black_th * (235 - 16);
116
117     av_log(blackdetect, AV_LOG_INFO,
118            "black_min_duration:%s pixel_black_th:%f pixel_black_th_i:%d picture_black_ratio_th:%f\n",
119            av_ts2timestr(blackdetect->black_min_duration, &inlink->time_base),
120            blackdetect->pixel_black_th, blackdetect->pixel_black_th_i,
121            blackdetect->picture_black_ratio_th);
122     return 0;
123 }
124
125 static void draw_slice(AVFilterLink *inlink, int y, int h, int slice_dir)
126 {
127     AVFilterContext *ctx = inlink->dst;
128     BlackDetectContext *blackdetect = ctx->priv;
129     AVFilterBufferRef *picref = inlink->cur_buf;
130     int x, i;
131     const uint8_t *p = picref->data[0] + y * picref->linesize[0];
132
133     for (i = 0; i < h; i++) {
134         for (x = 0; x < inlink->w; x++)
135             blackdetect->nb_black_pixels += p[x] <= blackdetect->pixel_black_th_i;
136         p += picref->linesize[0];
137     }
138
139     ff_draw_slice(ctx->outputs[0], y, h, slice_dir);
140 }
141
142 static void end_frame(AVFilterLink *inlink)
143 {
144     AVFilterContext *ctx = inlink->dst;
145     BlackDetectContext *blackdetect = ctx->priv;
146     AVFilterBufferRef *picref = inlink->cur_buf;
147     double picture_black_ratio = 0;
148
149     picture_black_ratio = (double)blackdetect->nb_black_pixels / (inlink->w * inlink->h);
150
151     av_log(ctx, AV_LOG_DEBUG,
152            "frame:%u picture_black_ratio:%f pos:%"PRId64" pts:%s t:%s type:%c\n",
153            blackdetect->frame_count, picture_black_ratio,
154            picref->pos, av_ts2str(picref->pts), av_ts2timestr(picref->pts, &inlink->time_base),
155            av_get_picture_type_char(picref->video->pict_type));
156
157     if (picture_black_ratio >= blackdetect->picture_black_ratio_th) {
158         if (!blackdetect->black_started) {
159             /* black starts here */
160             blackdetect->black_started = 1;
161             blackdetect->black_start = picref->pts;
162         }
163     } else if (blackdetect->black_started) {
164         /* black ends here */
165         blackdetect->black_started = 0;
166         blackdetect->black_end = picref->pts;
167
168         if ((blackdetect->black_end - blackdetect->black_start) >= blackdetect->black_min_duration) {
169             av_log(blackdetect, AV_LOG_INFO,
170                    "black_start:%s black_end:%s black_duration:%s\n",
171                    av_ts2timestr(blackdetect->black_start, &inlink->time_base),
172                    av_ts2timestr(blackdetect->black_end, &inlink->time_base),
173                    av_ts2timestr(blackdetect->black_end - blackdetect->black_start, &inlink->time_base));
174         }
175     }
176
177     blackdetect->frame_count++;
178     blackdetect->nb_black_pixels = 0;
179     avfilter_unref_buffer(picref);
180     ff_end_frame(inlink->dst->outputs[0]);
181 }
182
183 AVFilter avfilter_vf_blackdetect = {
184     .name          = "blackdetect",
185     .description   = NULL_IF_CONFIG_SMALL("Detect video intervals that are (almost) black."),
186     .priv_size     = sizeof(BlackDetectContext),
187     .init          = init,
188     .query_formats = query_formats,
189
190     .inputs = (const AVFilterPad[]) {
191         { .name             = "default",
192           .type             = AVMEDIA_TYPE_VIDEO,
193           .config_props     = config_input,
194           .draw_slice       = draw_slice,
195           .get_video_buffer = ff_null_get_video_buffer,
196           .start_frame      = ff_null_start_frame_keep_ref,
197           .end_frame        = end_frame, },
198         { .name = NULL }
199     },
200
201     .outputs = (const AVFilterPad[]) {
202         { .name             = "default",
203           .type             = AVMEDIA_TYPE_VIDEO },
204         { .name = NULL }
205     },
206 };