3 * Copyright (C) 2007 Sebastian Dröge <slomo@circular-chaos.org>
4 * Copyright (C) 2006 Stefan Kost <ensonic@users.sf.net>
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., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * SECTION:element-audioamplify
25 * Amplifies an audio stream by a given factor and allows the selection of different clipping modes.
26 * The difference between the clipping modes is best evaluated by testing.
29 * <title>Example launch line</title>
31 * gst-launch audiotestsrc wave=saw ! audioamplify amplification=1.5 ! alsasink
32 * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audioamplify amplification=1.5 method=wrap-negative ! alsasink
33 * gst-launch audiotestsrc wave=saw ! audioconvert ! audioamplify amplification=1.5 method=wrap-positive ! audioconvert ! alsasink
43 #include <gst/base/gstbasetransform.h>
44 #include <gst/audio/audio.h>
45 #include <gst/audio/gstaudiofilter.h>
47 #include "audioamplify.h"
49 #define GST_CAT_DEFAULT gst_audio_amplify_debug
50 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
52 /* Filter signals and args */
75 #define GST_TYPE_AUDIO_AMPLIFY_CLIPPING_METHOD (gst_audio_amplify_clipping_method_get_type ())
77 gst_audio_amplify_clipping_method_get_type (void)
79 static GType gtype = 0;
82 static const GEnumValue values[] = {
83 {METHOD_CLIP, "Normal clipping (default)", "clip"},
84 {METHOD_WRAP_NEGATIVE,
85 "Push overdriven values back from the opposite side",
87 {METHOD_WRAP_POSITIVE, "Push overdriven values back from the same side",
89 {METHOD_NOCLIP, "No clipping", "none"},
92 gtype = g_enum_register_static ("GstAudioAmplifyClippingMethod", values);
97 #define ALLOWED_CAPS \
99 " format=(string) {S8,"GST_AUDIO_NE(S16)","GST_AUDIO_NE(S32)"," \
100 GST_AUDIO_NE(F32)","GST_AUDIO_NE(F64)"}," \
101 " rate=(int)[1,MAX]," \
102 " channels=(int)[1,MAX], " \
103 " layout=(string) {interleaved, non-interleaved}"
105 G_DEFINE_TYPE (GstAudioAmplify, gst_audio_amplify, GST_TYPE_AUDIO_FILTER);
107 static gboolean gst_audio_amplify_set_process_function (GstAudioAmplify *
108 filter, gint clipping, GstAudioFormat format);
109 static void gst_audio_amplify_set_property (GObject * object, guint prop_id,
110 const GValue * value, GParamSpec * pspec);
111 static void gst_audio_amplify_get_property (GObject * object, guint prop_id,
112 GValue * value, GParamSpec * pspec);
114 static gboolean gst_audio_amplify_setup (GstAudioFilter * filter,
115 const GstAudioInfo * info);
116 static GstFlowReturn gst_audio_amplify_transform_ip (GstBaseTransform * base,
119 #define MIN_gint8 G_MININT8
120 #define MAX_gint8 G_MAXINT8
121 #define MIN_gint16 G_MININT16
122 #define MAX_gint16 G_MAXINT16
123 #define MIN_gint32 G_MININT32
124 #define MAX_gint32 G_MAXINT32
126 #define MAKE_INT_FUNCS(type,largetype) \
128 gst_audio_amplify_transform_##type##_clip (GstAudioAmplify * filter, \
129 void * data, guint num_samples) \
133 while (num_samples--) { \
134 largetype val = *d * filter->amplification; \
135 *d++ = CLAMP (val, MIN_##type, MAX_##type); \
139 gst_audio_amplify_transform_##type##_wrap_negative (GstAudioAmplify * filter, \
140 void * data, guint num_samples) \
144 while (num_samples--) { \
145 largetype val = *d * filter->amplification; \
146 if (val > MAX_##type) \
147 val = MIN_##type + (val - MIN_##type) % ((largetype) MAX_##type + 1 - \
149 else if (val < MIN_##type) \
150 val = MAX_##type - (MAX_##type - val) % ((largetype) MAX_##type + 1 - \
156 gst_audio_amplify_transform_##type##_wrap_positive (GstAudioAmplify * filter, \
157 void * data, guint num_samples) \
161 while (num_samples--) { \
162 largetype val = *d * filter->amplification; \
164 if (val > MAX_##type) \
165 val = MAX_##type - (val - MAX_##type); \
166 else if (val < MIN_##type) \
167 val = MIN_##type + (MIN_##type - val); \
175 gst_audio_amplify_transform_##type##_noclip (GstAudioAmplify * filter, \
176 void * data, guint num_samples) \
180 while (num_samples--) \
181 *d++ *= filter->amplification; \
184 #define MAKE_FLOAT_FUNCS(type) \
186 gst_audio_amplify_transform_##type##_clip (GstAudioAmplify * filter, \
187 void * data, guint num_samples) \
191 while (num_samples--) { \
192 type val = *d* filter->amplification; \
193 *d++ = CLAMP (val, -1.0, +1.0); \
197 gst_audio_amplify_transform_##type##_wrap_negative (GstAudioAmplify * \
198 filter, void * data, guint num_samples) \
202 while (num_samples--) { \
203 type val = *d * filter->amplification; \
206 val = -1.0 + (val - 1.0); \
207 else if (val < -1.0) \
208 val = 1.0 - (1.0 - val); \
216 gst_audio_amplify_transform_##type##_wrap_positive (GstAudioAmplify * filter, \
217 void * data, guint num_samples) \
221 while (num_samples--) { \
222 type val = *d* filter->amplification; \
225 val = 1.0 - (val - 1.0); \
226 else if (val < -1.0) \
227 val = -1.0 + (-1.0 - val); \
235 gst_audio_amplify_transform_##type##_noclip (GstAudioAmplify * filter, \
236 void * data, guint num_samples) \
240 while (num_samples--) \
241 *d++ *= filter->amplification; \
245 MAKE_INT_FUNCS (gint8,gint)
246 MAKE_INT_FUNCS (gint16,gint)
247 MAKE_INT_FUNCS (gint32,gint64)
248 MAKE_FLOAT_FUNCS (gfloat)
249 MAKE_FLOAT_FUNCS (gdouble)
252 /* GObject vmethod implementations */
255 gst_audio_amplify_class_init (GstAudioAmplifyClass * klass)
257 GObjectClass *gobject_class;
258 GstElementClass *gstelement_class;
261 GST_DEBUG_CATEGORY_INIT (gst_audio_amplify_debug, "audioamplify", 0,
262 "audioamplify element");
264 gobject_class = (GObjectClass *) klass;
265 gstelement_class = (GstElementClass *) klass;
267 gobject_class->set_property = gst_audio_amplify_set_property;
268 gobject_class->get_property = gst_audio_amplify_get_property;
270 g_object_class_install_property (gobject_class, PROP_AMPLIFICATION,
271 g_param_spec_float ("amplification", "Amplification",
272 "Factor of amplification", -G_MAXFLOAT, G_MAXFLOAT,
274 G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
277 * GstAudioAmplify:clipping-method
279 * Clipping method: clip mode set values higher than the maximum to the
280 * maximum. The wrap-negative mode pushes those values back from the
281 * opposite side, wrap-positive pushes them back from the same side.
284 g_object_class_install_property (gobject_class, PROP_CLIPPING_METHOD,
285 g_param_spec_enum ("clipping-method", "Clipping method",
286 "Selects how to handle values higher than the maximum",
287 GST_TYPE_AUDIO_AMPLIFY_CLIPPING_METHOD, METHOD_CLIP,
288 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
290 gst_element_class_set_details_simple (gstelement_class, "Audio amplifier",
291 "Filter/Effect/Audio",
292 "Amplifies an audio stream by a given factor",
293 "Sebastian Dröge <slomo@circular-chaos.org>");
295 caps = gst_caps_from_string (ALLOWED_CAPS);
296 gst_audio_filter_class_add_pad_templates (GST_AUDIO_FILTER_CLASS (klass),
298 gst_caps_unref (caps);
300 GST_AUDIO_FILTER_CLASS (klass)->setup =
301 GST_DEBUG_FUNCPTR (gst_audio_amplify_setup);
302 GST_BASE_TRANSFORM_CLASS (klass)->transform_ip =
303 GST_DEBUG_FUNCPTR (gst_audio_amplify_transform_ip);
307 gst_audio_amplify_init (GstAudioAmplify * filter)
309 filter->amplification = 1.0;
310 gst_audio_amplify_set_process_function (filter, METHOD_CLIP,
311 GST_AUDIO_FORMAT_S16);
312 gst_base_transform_set_in_place (GST_BASE_TRANSFORM (filter), TRUE);
313 gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM (filter), TRUE);
316 static GstAudioAmplifyProcessFunc
317 gst_audio_amplify_process_function (gint clipping, GstAudioFormat format)
319 static const struct process
321 GstAudioFormat format;
323 GstAudioAmplifyProcessFunc func;
326 GST_AUDIO_FORMAT_F32, METHOD_CLIP, gst_audio_amplify_transform_gfloat_clip}, {
327 GST_AUDIO_FORMAT_F32, METHOD_WRAP_NEGATIVE,
328 gst_audio_amplify_transform_gfloat_wrap_negative}, {
329 GST_AUDIO_FORMAT_F32, METHOD_WRAP_POSITIVE,
330 gst_audio_amplify_transform_gfloat_wrap_positive}, {
331 GST_AUDIO_FORMAT_F32, METHOD_NOCLIP,
332 gst_audio_amplify_transform_gfloat_noclip}, {
333 GST_AUDIO_FORMAT_F64, METHOD_CLIP,
334 gst_audio_amplify_transform_gdouble_clip}, {
335 GST_AUDIO_FORMAT_F64, METHOD_WRAP_NEGATIVE,
336 gst_audio_amplify_transform_gdouble_wrap_negative}, {
337 GST_AUDIO_FORMAT_F64, METHOD_WRAP_POSITIVE,
338 gst_audio_amplify_transform_gdouble_wrap_positive}, {
339 GST_AUDIO_FORMAT_F64, METHOD_NOCLIP,
340 gst_audio_amplify_transform_gdouble_noclip}, {
341 GST_AUDIO_FORMAT_S8, METHOD_CLIP, gst_audio_amplify_transform_gint8_clip}, {
342 GST_AUDIO_FORMAT_S8, METHOD_WRAP_NEGATIVE,
343 gst_audio_amplify_transform_gint8_wrap_negative}, {
344 GST_AUDIO_FORMAT_S8, METHOD_WRAP_POSITIVE,
345 gst_audio_amplify_transform_gint8_wrap_positive}, {
346 GST_AUDIO_FORMAT_S8, METHOD_NOCLIP,
347 gst_audio_amplify_transform_gint8_noclip}, {
348 GST_AUDIO_FORMAT_S16, METHOD_CLIP, gst_audio_amplify_transform_gint16_clip}, {
349 GST_AUDIO_FORMAT_S16, METHOD_WRAP_NEGATIVE,
350 gst_audio_amplify_transform_gint16_wrap_negative}, {
351 GST_AUDIO_FORMAT_S16, METHOD_WRAP_POSITIVE,
352 gst_audio_amplify_transform_gint16_wrap_positive}, {
353 GST_AUDIO_FORMAT_S16, METHOD_NOCLIP,
354 gst_audio_amplify_transform_gint16_noclip}, {
355 GST_AUDIO_FORMAT_S32, METHOD_CLIP, gst_audio_amplify_transform_gint32_clip}, {
356 GST_AUDIO_FORMAT_S32, METHOD_WRAP_NEGATIVE,
357 gst_audio_amplify_transform_gint32_wrap_negative}, {
358 GST_AUDIO_FORMAT_S32, METHOD_WRAP_POSITIVE,
359 gst_audio_amplify_transform_gint32_wrap_positive}, {
360 GST_AUDIO_FORMAT_S32, METHOD_NOCLIP,
361 gst_audio_amplify_transform_gint32_noclip}, {
364 const struct process *p;
366 for (p = process; p->func; p++)
367 if (p->format == format && p->clipping == clipping)
373 gst_audio_amplify_set_process_function (GstAudioAmplify * filter, gint
374 clipping_method, GstAudioFormat format)
376 GstAudioAmplifyProcessFunc process;
378 /* set processing function */
380 process = gst_audio_amplify_process_function (clipping_method, format);
382 GST_DEBUG ("wrong format");
386 filter->process = process;
387 filter->clipping_method = clipping_method;
388 filter->format = format;
394 gst_audio_amplify_set_property (GObject * object, guint prop_id,
395 const GValue * value, GParamSpec * pspec)
397 GstAudioAmplify *filter = GST_AUDIO_AMPLIFY (object);
400 case PROP_AMPLIFICATION:
401 filter->amplification = g_value_get_float (value);
402 gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (filter),
403 filter->amplification == 1.0);
405 case PROP_CLIPPING_METHOD:
406 gst_audio_amplify_set_process_function (filter, g_value_get_enum (value),
410 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
416 gst_audio_amplify_get_property (GObject * object, guint prop_id,
417 GValue * value, GParamSpec * pspec)
419 GstAudioAmplify *filter = GST_AUDIO_AMPLIFY (object);
422 case PROP_AMPLIFICATION:
423 g_value_set_float (value, filter->amplification);
425 case PROP_CLIPPING_METHOD:
426 g_value_set_enum (value, filter->clipping_method);
429 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
434 /* GstAudioFilter vmethod implementations */
436 gst_audio_amplify_setup (GstAudioFilter * base, const GstAudioInfo * info)
438 GstAudioAmplify *filter = GST_AUDIO_AMPLIFY (base);
440 return gst_audio_amplify_set_process_function (filter,
441 filter->clipping_method, GST_AUDIO_INFO_FORMAT (info));
444 /* GstBaseTransform vmethod implementations */
446 gst_audio_amplify_transform_ip (GstBaseTransform * base, GstBuffer * buf)
448 GstAudioAmplify *filter = GST_AUDIO_AMPLIFY (base);
450 GstClockTime timestamp, stream_time;
453 timestamp = GST_BUFFER_TIMESTAMP (buf);
455 gst_segment_to_stream_time (&base->segment, GST_FORMAT_TIME, timestamp);
457 GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT,
458 GST_TIME_ARGS (timestamp));
460 if (GST_CLOCK_TIME_IS_VALID (stream_time))
461 gst_object_sync_values (GST_OBJECT (filter), stream_time);
463 if (gst_base_transform_is_passthrough (base) ||
464 G_UNLIKELY (GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLAG_GAP)))
467 gst_buffer_map (buf, &map, GST_MAP_READWRITE);
468 num_samples = map.size / GST_AUDIO_FILTER_BPS (filter);
470 filter->process (filter, map.data, num_samples);
472 gst_buffer_unmap (buf, &map);