lavfi: use av_default_item_name() as filter private context logger
[ffmpeg.git] / libavfilter / af_silencedetect.c
1 /*
2  * Copyright (c) 2012 Clément Bœsch <ubitux@gmail.com>
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  * Audio silence detector
24  */
25
26 #include "libavutil/opt.h"
27 #include "libavutil/timestamp.h"
28 #include "audio.h"
29 #include "formats.h"
30 #include "avfilter.h"
31
32 typedef struct {
33     const AVClass *class;
34     char *noise_str;            ///< noise option string
35     double noise;               ///< noise amplitude ratio
36     int duration;               ///< minimum duration of silence until notification
37     int64_t nb_null_samples;    ///< current number of continuous zero samples
38     int64_t start;              ///< if silence is detected, this value contains the time of the first zero sample
39     int last_sample_rate;       ///< last sample rate to check for sample rate changes
40 } SilenceDetectContext;
41
42 #define OFFSET(x) offsetof(SilenceDetectContext, x)
43 static const AVOption silencedetect_options[] = {
44     { "n",         "set noise tolerance",              OFFSET(noise_str), AV_OPT_TYPE_STRING, {.str="-60dB"}, CHAR_MIN, CHAR_MAX },
45     { "noise",     "set noise tolerance",              OFFSET(noise_str), AV_OPT_TYPE_STRING, {.str="-60dB"}, CHAR_MIN, CHAR_MAX },
46     { "d",         "set minimum duration in seconds",  OFFSET(duration),  AV_OPT_TYPE_INT,    {.dbl=2},    0, INT_MAX},
47     { "duration",  "set minimum duration in seconds",  OFFSET(duration),  AV_OPT_TYPE_INT,    {.dbl=2},    0, INT_MAX},
48     { NULL },
49 };
50
51 static const AVClass silencedetect_class = {
52     .class_name = "SilenceDetectContext",
53     .item_name  = av_default_item_name,
54     .option     = silencedetect_options,
55 };
56
57 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
58 {
59     int ret;
60     char *tail;
61     SilenceDetectContext *silence = ctx->priv;
62
63     silence->class = &silencedetect_class;
64     av_opt_set_defaults(silence);
65
66     if ((ret = av_set_options_string(silence, args, "=", ":")) < 0) {
67         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
68         return ret;
69     }
70
71     silence->noise = strtod(silence->noise_str, &tail);
72     if (!strcmp(tail, "dB")) {
73         silence->noise = pow(10, silence->noise/20);
74     } else if (*tail) {
75         av_log(ctx, AV_LOG_ERROR, "Invalid value '%s' for noise parameter.\n",
76                silence->noise_str);
77         return AVERROR(EINVAL);
78     }
79
80     return 0;
81 }
82
83 static void filter_samples(AVFilterLink *inlink, AVFilterBufferRef *insamples)
84 {
85     int i;
86     SilenceDetectContext *silence = inlink->dst->priv;
87     const int nb_channels           = av_get_channel_layout_nb_channels(inlink->channel_layout);
88     const int srate                 = inlink->sample_rate;
89     const int nb_samples            = insamples->audio->nb_samples * nb_channels;
90     const int64_t nb_samples_notify = srate * silence->duration    * nb_channels;
91
92     // scale number of null samples to the new sample rate
93     if (silence->last_sample_rate && silence->last_sample_rate != srate)
94         silence->nb_null_samples =
95             srate * silence->nb_null_samples / silence->last_sample_rate;
96     silence->last_sample_rate = srate;
97
98     // TODO: support more sample formats
99     if (insamples->format == AV_SAMPLE_FMT_DBL) {
100         double *p = (double *)insamples->data[0];
101
102         for (i = 0; i < nb_samples; i++, p++) {
103             if (*p < silence->noise && *p > -silence->noise) {
104                 if (!silence->start) {
105                     silence->nb_null_samples++;
106                     if (silence->nb_null_samples >= nb_samples_notify) {
107                         silence->start = insamples->pts - silence->duration / av_q2d(inlink->time_base);
108                         av_log(silence, AV_LOG_INFO,
109                                "silence_start: %s\n", av_ts2timestr(silence->start, &inlink->time_base));
110                     }
111                 }
112             } else {
113                 if (silence->start)
114                     av_log(silence, AV_LOG_INFO,
115                            "silence_end: %s | silence_duration: %s\n",
116                            av_ts2timestr(insamples->pts,                  &inlink->time_base),
117                            av_ts2timestr(insamples->pts - silence->start, &inlink->time_base));
118                 silence->nb_null_samples = silence->start = 0;
119             }
120         }
121     }
122
123     ff_filter_samples(inlink->dst->outputs[0], insamples);
124 }
125
126 static int query_formats(AVFilterContext *ctx)
127 {
128     AVFilterFormats *formats = NULL;
129     AVFilterChannelLayouts *layouts = NULL;
130     enum AVSampleFormat sample_fmts[] = {
131         AV_SAMPLE_FMT_DBL,
132         AV_SAMPLE_FMT_NONE
133     };
134
135     layouts = ff_all_channel_layouts();
136     if (!layouts)
137         return AVERROR(ENOMEM);
138     ff_set_common_channel_layouts(ctx, layouts);
139
140     formats = avfilter_make_format_list(sample_fmts);
141     if (!formats)
142         return AVERROR(ENOMEM);
143     avfilter_set_common_sample_formats(ctx, formats);
144
145     formats = ff_all_samplerates();
146     if (!formats)
147         return AVERROR(ENOMEM);
148     ff_set_common_samplerates(ctx, formats);
149
150     return 0;
151 }
152
153 AVFilter avfilter_af_silencedetect = {
154     .name          = "silencedetect",
155     .description   = NULL_IF_CONFIG_SMALL("Detect silence."),
156     .priv_size     = sizeof(SilenceDetectContext),
157     .init          = init,
158     .query_formats = query_formats,
159
160     .inputs = (const AVFilterPad[]) {
161         { .name             = "default",
162           .type             = AVMEDIA_TYPE_AUDIO,
163           .get_audio_buffer = ff_null_get_audio_buffer,
164           .filter_samples   = filter_samples, },
165         { .name = NULL }
166     },
167     .outputs = (const AVFilterPad[]) {
168         { .name = "default",
169           .type = AVMEDIA_TYPE_AUDIO, },
170         { .name = NULL }
171     },
172 };