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