2 * Copyright (C) 2011 Tiago Katcipis <tiagokatcipis@gmail.com>
3 * Copyright (C) 2011 Paulo Pizarro <paulo.pizarro@gmail.com>
4 * Copyright (C) 2012-2016 Nicola Murino <nicola.murino@gmail.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library 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 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * SECTION:element-removesilence
24 * @title: removesilence
26 * Removes all silence periods from an audio stream, dropping silence buffers.
27 * If the "silent" property is disabled, removesilence will generate
28 * bus messages named "removesilence".
29 * The message's structure contains one of these fields:
31 * - #guint64 "silence_detected": the PTS for the first silent buffer after a non silence period.
33 * - #guint64 "silence_finished": the PTS for the first non silent buffer after a silence period.
35 * ## Example launch line
37 * gst-launch-1.0 -v -m filesrc location="audiofile" ! decodebin ! removesilence remove=true ! wavenc ! filesink location=without_audio.wav
47 #include <gst/base/gstbasetransform.h>
48 #include <gst/audio/audio.h>
50 #include "gstremovesilence.h"
53 GST_DEBUG_CATEGORY_STATIC (gst_remove_silence_debug);
54 #define GST_CAT_DEFAULT gst_remove_silence_debug
55 #define DEFAULT_VAD_HYSTERESIS 480 /* 60 mseg */
56 #define MINIMUM_SILENCE_BUFFERS_MIN 0
57 #define MINIMUM_SILENCE_BUFFERS_MAX 10000
58 #define MINIMUM_SILENCE_BUFFERS_DEF 0
59 #define MINIMUM_SILENCE_TIME_MIN 0
60 #define MINIMUM_SILENCE_TIME_MAX 10000000000
61 #define MINIMUM_SILENCE_TIME_DEF 0
62 #define DEFAULT_VAD_THRESHOLD -60
64 /* Filter signals and args */
79 PROP_MINIMUM_SILENCE_BUFFERS,
80 PROP_MINIMUM_SILENCE_TIME
84 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
87 GST_STATIC_CAPS ("audio/x-raw, "
88 "format = (string) " GST_AUDIO_NE (S16) ", "
89 "layout = (string) interleaved, "
90 "rate = (int) [ 1, MAX ], " "channels = (int) 1"));
92 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
95 GST_STATIC_CAPS ("audio/x-raw, "
96 "format = (string) " GST_AUDIO_NE (S16) ", "
97 "layout = (string) interleaved, "
98 "rate = (int) [ 1, MAX ], " "channels = (int) 1"));
101 #define DEBUG_INIT(bla) \
102 GST_DEBUG_CATEGORY_INIT (gst_remove_silence_debug, "removesilence", 0, "removesilence element")
104 #define gst_remove_silence_parent_class parent_class
105 G_DEFINE_TYPE_WITH_CODE (GstRemoveSilence, gst_remove_silence,
106 GST_TYPE_BASE_TRANSFORM, DEBUG_INIT (0));
108 static void gst_remove_silence_set_property (GObject * object, guint prop_id,
109 const GValue * value, GParamSpec * pspec);
110 static void gst_remove_silence_get_property (GObject * object, guint prop_id,
111 GValue * value, GParamSpec * pspec);
113 static gboolean gst_remove_silence_start (GstBaseTransform * trans);
114 static gboolean gst_remove_silence_sink_event (GstBaseTransform * trans,
116 static GstFlowReturn gst_remove_silence_transform_ip (GstBaseTransform * base,
118 static void gst_remove_silence_finalize (GObject * obj);
120 /* GObject vmethod implementations */
122 /* initialize the removesilence's class */
124 gst_remove_silence_class_init (GstRemoveSilenceClass * klass)
126 GObjectClass *gobject_class;
127 GstElementClass *gstelement_class;
128 GstBaseTransformClass *base_transform_class;
130 gobject_class = (GObjectClass *) klass;
131 gstelement_class = (GstElementClass *) klass;
132 base_transform_class = GST_BASE_TRANSFORM_CLASS (klass);
134 gobject_class->finalize = gst_remove_silence_finalize;
135 gobject_class->set_property = gst_remove_silence_set_property;
136 gobject_class->get_property = gst_remove_silence_get_property;
138 g_object_class_install_property (gobject_class, PROP_REMOVE,
139 g_param_spec_boolean ("remove", "Remove",
140 "Set to true to remove silence from the stream, false otherwhise",
141 FALSE, G_PARAM_READWRITE));
143 g_object_class_install_property (gobject_class, PROP_HYSTERESIS,
144 g_param_spec_uint64 ("hysteresis",
146 "Set the hysteresis (on samples) used on the internal VAD",
147 1, G_MAXUINT64, DEFAULT_VAD_HYSTERESIS, G_PARAM_READWRITE));
149 g_object_class_install_property (gobject_class, PROP_THRESHOLD,
150 g_param_spec_int ("threshold",
152 "Set the silence threshold used on the internal VAD in dB",
153 -70, 70, DEFAULT_VAD_THRESHOLD, G_PARAM_READWRITE));
155 g_object_class_install_property (gobject_class, PROP_SQUASH,
156 g_param_spec_boolean ("squash", "Squash",
157 "Set to true to retimestamp buffers when silence is removed and so avoid timestamp gap",
158 FALSE, G_PARAM_READWRITE));
160 g_object_class_install_property (gobject_class, PROP_SILENT,
161 g_param_spec_boolean ("silent", "Silent",
162 "Disable/enable bus message notifications for silence detected/finished",
163 TRUE, G_PARAM_READWRITE));
165 g_object_class_install_property (gobject_class, PROP_MINIMUM_SILENCE_BUFFERS,
166 g_param_spec_uint ("minimum-silence-buffers", "Minimum silence buffers",
167 "Define the minimum number of consecutive silence buffers before "
168 "removing silence, 0 means disabled. This will not introduce latency",
169 MINIMUM_SILENCE_BUFFERS_MIN, MINIMUM_SILENCE_BUFFERS_MAX,
170 MINIMUM_SILENCE_BUFFERS_DEF, G_PARAM_READWRITE));
172 g_object_class_install_property (gobject_class, PROP_MINIMUM_SILENCE_TIME,
173 g_param_spec_uint64 ("minimum_silence_time",
174 "Minimum silence time",
175 "Define the minimum silence time in nanoseconds before removing "
176 " silence, 0 means disabled. This will not introduce latency",
177 MINIMUM_SILENCE_TIME_MIN, MINIMUM_SILENCE_TIME_MAX,
178 MINIMUM_SILENCE_TIME_DEF, G_PARAM_READWRITE));
180 gst_element_class_set_static_metadata (gstelement_class,
182 "Filter/Effect/Audio",
183 "Removes all the silence periods from the audio stream.",
184 "Tiago Katcipis <tiagokatcipis@gmail.com>\n \
185 Paulo Pizarro <paulo.pizarro@gmail.com>\n \
186 Nicola Murino <nicola.murino@gmail.com>");
188 gst_element_class_add_static_pad_template (gstelement_class, &src_template);
189 gst_element_class_add_static_pad_template (gstelement_class, &sink_template);
191 base_transform_class->start = GST_DEBUG_FUNCPTR (gst_remove_silence_start);
192 base_transform_class->sink_event =
193 GST_DEBUG_FUNCPTR (gst_remove_silence_sink_event);
194 base_transform_class->transform_ip =
195 GST_DEBUG_FUNCPTR (gst_remove_silence_transform_ip);
199 gst_remove_silence_reset (GstRemoveSilence * filter)
201 filter->ts_offset = 0;
202 filter->silence_detected = FALSE;
203 filter->consecutive_silence_buffers = 0;
204 filter->consecutive_silence_time = 0;
207 /* initialize the new element
208 * instantiate pads and add them to element
209 * set pad calback functions
210 * initialize instance structure
213 gst_remove_silence_init (GstRemoveSilence * filter)
215 filter->vad = vad_new (DEFAULT_VAD_HYSTERESIS, DEFAULT_VAD_THRESHOLD);
216 filter->remove = FALSE;
217 filter->squash = FALSE;
218 filter->silent = TRUE;
219 filter->minimum_silence_buffers = MINIMUM_SILENCE_BUFFERS_DEF;
220 filter->minimum_silence_time = MINIMUM_SILENCE_TIME_DEF;
222 gst_remove_silence_reset (filter);
225 GST_DEBUG ("Error initializing VAD !!");
231 gst_remove_silence_start (GstBaseTransform * trans)
233 GstRemoveSilence *filter = GST_REMOVE_SILENCE (trans);
235 GST_INFO ("reset filter on start");
236 gst_remove_silence_reset (filter);
242 gst_remove_silence_sink_event (GstBaseTransform * trans, GstEvent * event)
244 GstRemoveSilence *filter = GST_REMOVE_SILENCE (trans);
246 if (event->type == GST_EVENT_SEGMENT) {
247 GST_INFO ("reset filter on segment event");
248 gst_remove_silence_reset (filter);
252 GST_BASE_TRANSFORM_CLASS (gst_remove_silence_parent_class)->sink_event
257 gst_remove_silence_finalize (GObject * obj)
259 GstRemoveSilence *filter = GST_REMOVE_SILENCE (obj);
260 GST_DEBUG ("Destroying VAD");
261 vad_destroy (filter->vad);
263 GST_DEBUG ("VAD Destroyed");
264 G_OBJECT_CLASS (parent_class)->finalize (obj);
268 gst_remove_silence_set_property (GObject * object, guint prop_id,
269 const GValue * value, GParamSpec * pspec)
271 GstRemoveSilence *filter = GST_REMOVE_SILENCE (object);
275 filter->remove = g_value_get_boolean (value);
277 case PROP_HYSTERESIS:
278 vad_set_hysteresis (filter->vad, g_value_get_uint64 (value));
281 vad_set_threshold (filter->vad, g_value_get_int (value));
284 filter->squash = g_value_get_boolean (value);
287 filter->silent = g_value_get_boolean (value);
289 case PROP_MINIMUM_SILENCE_BUFFERS:
290 filter->minimum_silence_buffers = g_value_get_uint (value);
292 case PROP_MINIMUM_SILENCE_TIME:
293 filter->minimum_silence_time = g_value_get_uint64 (value);
296 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
302 gst_remove_silence_get_property (GObject * object, guint prop_id,
303 GValue * value, GParamSpec * pspec)
305 GstRemoveSilence *filter = GST_REMOVE_SILENCE (object);
309 g_value_set_boolean (value, filter->remove);
311 case PROP_HYSTERESIS:
312 g_value_set_uint64 (value, vad_get_hysteresis (filter->vad));
315 g_value_set_int (value, vad_get_threshold_as_db (filter->vad));
318 g_value_set_boolean (value, filter->squash);
321 g_value_set_boolean (value, filter->silent);
323 case PROP_MINIMUM_SILENCE_BUFFERS:
324 g_value_set_uint (value, filter->minimum_silence_buffers);
326 case PROP_MINIMUM_SILENCE_TIME:
327 g_value_set_uint64 (value, filter->minimum_silence_time);
330 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
336 gst_remove_silence_transform_ip (GstBaseTransform * trans, GstBuffer * inbuf)
338 GstRemoveSilence *filter = NULL;
341 gboolean consecutive_silence_reached;
343 filter = GST_REMOVE_SILENCE (trans);
345 gst_buffer_map (inbuf, &map, GST_MAP_READ);
347 vad_update (filter->vad, (gint16 *) map.data, map.size / sizeof (gint16));
348 gst_buffer_unmap (inbuf, &map);
350 if (frame_type == VAD_SILENCE) {
351 GST_DEBUG ("Silence detected");
352 filter->consecutive_silence_buffers++;
353 if (GST_BUFFER_DURATION_IS_VALID (inbuf)) {
354 filter->consecutive_silence_time += inbuf->duration;
357 ("Invalid buffer duration, consecutive_silence_time update not possible");
359 if (filter->minimum_silence_buffers == 0
360 && filter->minimum_silence_time == 0) {
361 consecutive_silence_reached = TRUE;
363 consecutive_silence_reached =
364 (filter->minimum_silence_buffers > 0
365 && filter->consecutive_silence_buffers >=
366 filter->minimum_silence_buffers)
367 || (filter->minimum_silence_time > 0
368 && filter->consecutive_silence_time >= filter->minimum_silence_time);
370 if (!filter->silence_detected && consecutive_silence_reached) {
371 if (!filter->silent) {
372 if (GST_BUFFER_PTS_IS_VALID (inbuf)) {
375 s = gst_structure_new ("removesilence", "silence_detected",
376 G_TYPE_UINT64, GST_BUFFER_PTS (inbuf) - filter->ts_offset, NULL);
377 m = gst_message_new_element (GST_OBJECT (filter), s);
378 gst_element_post_message (GST_ELEMENT (filter), m);
381 filter->silence_detected = TRUE;
384 if (filter->remove && consecutive_silence_reached) {
385 GST_DEBUG ("Removing silence");
386 if (filter->squash) {
387 if (GST_BUFFER_DURATION_IS_VALID (inbuf)) {
388 filter->ts_offset += inbuf->duration;
390 GST_WARNING ("Invalid buffer duration: ts_offset not updated");
393 return GST_BASE_TRANSFORM_FLOW_DROPPED;
397 filter->consecutive_silence_buffers = 0;
398 filter->consecutive_silence_time = 0;
399 if (filter->silence_detected) {
400 if (!filter->silent) {
401 if (GST_BUFFER_PTS_IS_VALID (inbuf)) {
404 s = gst_structure_new ("removesilence", "silence_finished",
405 G_TYPE_UINT64, GST_BUFFER_PTS (inbuf) - filter->ts_offset, NULL);
406 m = gst_message_new_element (GST_OBJECT (filter), s);
407 gst_element_post_message (GST_ELEMENT (filter), m);
410 filter->silence_detected = FALSE;
414 if (filter->squash && filter->ts_offset > 0) {
415 if (GST_BUFFER_PTS_IS_VALID (inbuf)) {
416 inbuf = gst_buffer_make_writable (inbuf);
417 GST_BUFFER_PTS (inbuf) -= filter->ts_offset;
419 GST_WARNING ("Invalid buffer pts, update not possibile");
426 /*Plugin init functions*/
428 plugin_init (GstPlugin * plugin)
430 return gst_element_register (plugin, "removesilence", GST_RANK_NONE,
431 gst_remove_silence_get_type ());
434 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
437 "Removes silence from an audio stream",
438 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);