git.sesse.net Git - ffmpeg/blob - 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 <float.h> /* DBL_MAX */
  27
  28 #include "libavutil/channel_layout.h"
  29 #include "libavutil/opt.h"
  30 #include "libavutil/timestamp.h"
  31 #include "audio.h"
  32 #include "formats.h"
  33 #include "avfilter.h"
  34 #include "internal.h"
  35
  36 typedef struct {
  37     const AVClass *class;
  38     double noise;               ///< noise amplitude ratio
  39     double duration;            ///< minimum duration of silence until notification
  40     int64_t nb_null_samples;    ///< current number of continuous zero samples
  41     int64_t start;              ///< if silence is detected, this value contains the time of the first zero sample
  42     int last_sample_rate;       ///< last sample rate to check for sample rate changes
  43 } SilenceDetectContext;
  44
  45 #define OFFSET(x) offsetof(SilenceDetectContext, x)
  46 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
  47 static const AVOption silencedetect_options[] = {
  48     { "n",         "set noise tolerance",              OFFSET(noise),     AV_OPT_TYPE_DOUBLE, {.dbl=0.001},          0, DBL_MAX,  FLAGS },
  49     { "noise",     "set noise tolerance",              OFFSET(noise),     AV_OPT_TYPE_DOUBLE, {.dbl=0.001},          0, DBL_MAX,  FLAGS },
  50     { "d",         "set minimum duration in seconds",  OFFSET(duration),  AV_OPT_TYPE_DOUBLE, {.dbl=2.},             0, 24*60*60, FLAGS },
  51     { "duration",  "set minimum duration in seconds",  OFFSET(duration),  AV_OPT_TYPE_DOUBLE, {.dbl=2.},             0, 24*60*60, FLAGS },
  52     { NULL },
  53 };
  54
  55 AVFILTER_DEFINE_CLASS(silencedetect);
  56
  57 static char *get_metadata_val(AVFrame *insamples, const char *key)
  58 {
  59     AVDictionaryEntry *e = av_dict_get(insamples->metadata, key, NULL, 0);
  60     return e && e->value ? e->value : NULL;
  61 }
  62
  63 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
  64 {
  65     int i;
  66     SilenceDetectContext *silence = inlink->dst->priv;
  67     const int nb_channels           = av_get_channel_layout_nb_channels(inlink->channel_layout);
  68     const int srate                 = inlink->sample_rate;
  69     const int nb_samples            = insamples->nb_samples     * nb_channels;
  70     const int64_t nb_samples_notify = srate * silence->duration * nb_channels;
  71
  72     // scale number of null samples to the new sample rate
  73     if (silence->last_sample_rate && silence->last_sample_rate != srate)
  74         silence->nb_null_samples =
  75             srate * silence->nb_null_samples / silence->last_sample_rate;
  76     silence->last_sample_rate = srate;
  77
  78     // TODO: support more sample formats
  79     // TODO: document metadata
  80     if (insamples->format == AV_SAMPLE_FMT_DBL) {
  81         double *p = (double *)insamples->data[0];
  82
  83         for (i = 0; i < nb_samples; i++, p++) {
  84             if (*p < silence->noise && *p > -silence->noise) {
  85                 if (!silence->start) {
  86                     silence->nb_null_samples++;
  87                     if (silence->nb_null_samples >= nb_samples_notify) {
  88                         silence->start = insamples->pts - (int64_t)(silence->duration / av_q2d(inlink->time_base) + .5);
  89                         av_dict_set(&insamples->metadata, "lavfi.silence_start",
  90                                     av_ts2timestr(silence->start, &inlink->time_base), 0);
  91                         av_log(silence, AV_LOG_INFO, "silence_start: %s\n",
  92                                get_metadata_val(insamples, "lavfi.silence_start"));
  93                     }
  94                 }
  95             } else {
  96                 if (silence->start) {
  97                     av_dict_set(&insamples->metadata, "lavfi.silence_end",
  98                                 av_ts2timestr(insamples->pts, &inlink->time_base), 0);
  99                     av_dict_set(&insamples->metadata, "lavfi.silence_duration",
 100                                 av_ts2timestr(insamples->pts - silence->start, &inlink->time_base), 0);
 101                     av_log(silence, AV_LOG_INFO,
 102                            "silence_end: %s | silence_duration: %s\n",
 103                            get_metadata_val(insamples, "lavfi.silence_end"),
 104                            get_metadata_val(insamples, "lavfi.silence_duration"));
 105                 }
 106                 silence->nb_null_samples = silence->start = 0;
 107             }
 108         }
 109     }
 110
 111     return ff_filter_frame(inlink->dst->outputs[0], insamples);
 112 }
 113
 114 static int query_formats(AVFilterContext *ctx)
 115 {
 116     AVFilterFormats *formats = NULL;
 117     AVFilterChannelLayouts *layouts = NULL;
 118     static const enum AVSampleFormat sample_fmts[] = {
 119         AV_SAMPLE_FMT_DBL,
 120         AV_SAMPLE_FMT_NONE
 121     };
 122
 123     layouts = ff_all_channel_layouts();
 124     if (!layouts)
 125         return AVERROR(ENOMEM);
 126     ff_set_common_channel_layouts(ctx, layouts);
 127
 128     formats = ff_make_format_list(sample_fmts);
 129     if (!formats)
 130         return AVERROR(ENOMEM);
 131     ff_set_common_formats(ctx, formats);
 132
 133     formats = ff_all_samplerates();
 134     if (!formats)
 135         return AVERROR(ENOMEM);
 136     ff_set_common_samplerates(ctx, formats);
 137
 138     return 0;
 139 }
 140
 141 static const AVFilterPad silencedetect_inputs[] = {
 142     {
 143         .name             = "default",
 144         .type             = AVMEDIA_TYPE_AUDIO,
 145         .get_audio_buffer = ff_null_get_audio_buffer,
 146         .filter_frame     = filter_frame,
 147     },
 148     { NULL }
 149 };
 150
 151 static const AVFilterPad silencedetect_outputs[] = {
 152     {
 153         .name = "default",
 154         .type = AVMEDIA_TYPE_AUDIO,
 155     },
 156     { NULL }
 157 };
 158
 159 AVFilter avfilter_af_silencedetect = {
 160     .name          = "silencedetect",
 161     .description   = NULL_IF_CONFIG_SMALL("Detect silence."),
 162     .priv_size     = sizeof(SilenceDetectContext),
 163     .query_formats = query_formats,
 164     .inputs        = silencedetect_inputs,
 165     .outputs       = silencedetect_outputs,
 166     .priv_class    = &silencedetect_class,
 167 };