avfilter/af_silencedetect: document metadata

Reviewed-by: Moritz Barsnick <barsnick@gmx.net>
Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
This commit is contained in:
Limin Wang 2019-10-08 23:04:51 +08:00 committed by Gyan Doshi
parent 09581f7923
commit 0afc1fe147
2 changed files with 10 additions and 2 deletions

View File

@ -4683,7 +4683,16 @@ This filter logs a message when it detects that the input audio volume is less
or equal to a noise tolerance value for a duration greater or equal to the
minimum detected noise duration.
The printed times and duration are expressed in seconds.
The printed times and duration are expressed in seconds. The
@code{lavfi.silence_start} or @code{lavfi.silence_start.X} metadata key
is set on the first frame whose timestamp equals or exceeds the detection
duration and it contains the timestamp of the first frame of the silence.
The @code{lavfi.silence_duration} or @code{lavfi.silence_duration.X}
and @code{lavfi.silence_end} or @code{lavfi.silence_end.X} metadata
keys are set on the first frame after the silence. If @option{mono} is
enabled, and each channel is evaluated separately, the @code{.X}
suffixed keys are used, and @code{X} corresponds to the channel number.
The filter accepts the following options:

View File

@ -187,7 +187,6 @@ static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
s->frame_end = insamples->pts + av_rescale_q(insamples->nb_samples,
(AVRational){ 1, s->last_sample_rate }, inlink->time_base);
// TODO: document metadata
s->silencedetect(s, insamples, nb_samples, nb_samples_notify,
inlink->time_base);