libavfilter/af_silencedetect.c
0c019473
 /*
  * Copyright (c) 2012 Clément Bœsch <ubitux@gmail.com>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * Audio silence detector
  */
 
a0b2e8e1
 #include <float.h> /* DBL_MAX */
 
1acd2f6b
 #include "libavutil/channel_layout.h"
0c019473
 #include "libavutil/opt.h"
d3b06399
 #include "libavutil/timestamp.h"
4522df52
 #include "audio.h"
1cbf7fb4
 #include "formats.h"
0c019473
 #include "avfilter.h"
c17808ce
 #include "internal.h"
0c019473
 
 typedef struct {
     const AVClass *class;
     double noise;               ///< noise amplitude ratio
273fca9a
     double duration;            ///< minimum duration of silence until notification
0c019473
     int64_t nb_null_samples;    ///< current number of continuous zero samples
d3b06399
     int64_t start;              ///< if silence is detected, this value contains the time of the first zero sample
0c019473
     int last_sample_rate;       ///< last sample rate to check for sample rate changes
 } SilenceDetectContext;
 
 #define OFFSET(x) offsetof(SilenceDetectContext, x)
42d621d1
 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
0c019473
 static const AVOption silencedetect_options[] = {
a0b2e8e1
     { "n",         "set noise tolerance",              OFFSET(noise),     AV_OPT_TYPE_DOUBLE, {.dbl=0.001},          0, DBL_MAX,  FLAGS },
     { "noise",     "set noise tolerance",              OFFSET(noise),     AV_OPT_TYPE_DOUBLE, {.dbl=0.001},          0, DBL_MAX,  FLAGS },
273fca9a
     { "d",         "set minimum duration in seconds",  OFFSET(duration),  AV_OPT_TYPE_DOUBLE, {.dbl=2.},             0, 24*60*60, FLAGS },
     { "duration",  "set minimum duration in seconds",  OFFSET(duration),  AV_OPT_TYPE_DOUBLE, {.dbl=2.},             0, 24*60*60, FLAGS },
0c019473
     { NULL },
 };
 
c17808ce
 AVFILTER_DEFINE_CLASS(silencedetect);
0c019473
 
052f4f85
 static av_cold int init(AVFilterContext *ctx, const char *args)
0c019473
 {
     int ret;
     SilenceDetectContext *silence = ctx->priv;
 
     silence->class = &silencedetect_class;
     av_opt_set_defaults(silence);
 
cc650cf0
     if ((ret = av_set_options_string(silence, args, "=", ":")) < 0)
0c019473
         return ret;
 
6ac5e3fe
     av_opt_free(silence);
0c019473
 
     return 0;
 }
 
fbedce6b
 static char *get_metadata_val(AVFilterBufferRef *insamples, const char *key)
 {
     AVDictionaryEntry *e = av_dict_get(insamples->metadata, key, NULL, 0);
     return e && e->value ? e->value : NULL;
 }
 
cd7febd3
 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *insamples)
0c019473
 {
     int i;
     SilenceDetectContext *silence = inlink->dst->priv;
     const int nb_channels           = av_get_channel_layout_nb_channels(inlink->channel_layout);
     const int srate                 = inlink->sample_rate;
     const int nb_samples            = insamples->audio->nb_samples * nb_channels;
     const int64_t nb_samples_notify = srate * silence->duration    * nb_channels;
 
     // scale number of null samples to the new sample rate
     if (silence->last_sample_rate && silence->last_sample_rate != srate)
         silence->nb_null_samples =
             srate * silence->nb_null_samples / silence->last_sample_rate;
     silence->last_sample_rate = srate;
 
     // TODO: support more sample formats
fbedce6b
     // TODO: document metadata
0c019473
     if (insamples->format == AV_SAMPLE_FMT_DBL) {
         double *p = (double *)insamples->data[0];
 
         for (i = 0; i < nb_samples; i++, p++) {
             if (*p < silence->noise && *p > -silence->noise) {
                 if (!silence->start) {
                     silence->nb_null_samples++;
                     if (silence->nb_null_samples >= nb_samples_notify) {
273fca9a
                         silence->start = insamples->pts - (int64_t)(silence->duration / av_q2d(inlink->time_base) + .5);
fbedce6b
                         av_dict_set(&insamples->metadata, "lavfi.silence_start",
                                     av_ts2timestr(silence->start, &inlink->time_base), 0);
                         av_log(silence, AV_LOG_INFO, "silence_start: %s\n",
                                get_metadata_val(insamples, "lavfi.silence_start"));
0c019473
                     }
                 }
             } else {
fbedce6b
                 if (silence->start) {
                     av_dict_set(&insamples->metadata, "lavfi.silence_end",
                                 av_ts2timestr(insamples->pts, &inlink->time_base), 0);
                     av_dict_set(&insamples->metadata, "lavfi.silence_duration",
                                 av_ts2timestr(insamples->pts - silence->start, &inlink->time_base), 0);
0c019473
                     av_log(silence, AV_LOG_INFO,
d3b06399
                            "silence_end: %s | silence_duration: %s\n",
fbedce6b
                            get_metadata_val(insamples, "lavfi.silence_end"),
                            get_metadata_val(insamples, "lavfi.silence_duration"));
                 }
0c019473
                 silence->nb_null_samples = silence->start = 0;
             }
         }
     }
 
cd7febd3
     return ff_filter_frame(inlink->dst->outputs[0], insamples);
0c019473
 }
 
 static int query_formats(AVFilterContext *ctx)
 {
     AVFilterFormats *formats = NULL;
1cbf7fb4
     AVFilterChannelLayouts *layouts = NULL;
185d1f3b
     static const enum AVSampleFormat sample_fmts[] = {
0c019473
         AV_SAMPLE_FMT_DBL,
         AV_SAMPLE_FMT_NONE
     };
 
1cbf7fb4
     layouts = ff_all_channel_layouts();
     if (!layouts)
0c019473
         return AVERROR(ENOMEM);
1cbf7fb4
     ff_set_common_channel_layouts(ctx, layouts);
0c019473
 
c9e183b4
     formats = ff_make_format_list(sample_fmts);
0c019473
     if (!formats)
         return AVERROR(ENOMEM);
c9e183b4
     ff_set_common_formats(ctx, formats);
0c019473
 
1cbf7fb4
     formats = ff_all_samplerates();
     if (!formats)
         return AVERROR(ENOMEM);
     ff_set_common_samplerates(ctx, formats);
 
0c019473
     return 0;
 }
 
2d9d4440
 static const AVFilterPad silencedetect_inputs[] = {
     {
         .name             = "default",
         .type             = AVMEDIA_TYPE_AUDIO,
         .get_audio_buffer = ff_null_get_audio_buffer,
         .filter_frame     = filter_frame,
     },
     { NULL }
 };
 
 static const AVFilterPad silencedetect_outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_AUDIO,
     },
     { NULL }
 };
 
0c019473
 AVFilter avfilter_af_silencedetect = {
     .name          = "silencedetect",
     .description   = NULL_IF_CONFIG_SMALL("Detect silence."),
     .priv_size     = sizeof(SilenceDetectContext),
     .init          = init,
     .query_formats = query_formats,
2d9d4440
     .inputs        = silencedetect_inputs,
     .outputs       = silencedetect_outputs,
     .priv_class    = &silencedetect_class,
0c019473
 };