gst/audiofx/audioecho.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * SECTION:element-audioecho
  23  * @Since: 0.10.14
  24  *
  25  * audioecho adds an echo or (simple) reverb effect to an audio stream. The echo
  26  * delay, intensity and the percentage of feedback can be configured.
  27  *
  28  * For getting an echo effect you have to set the delay to a larger value,
  29  * for example 200ms and more. Everything below will result in a simple
  30  * reverb effect, which results in a slightly metallic sound.
  31  *
  32  * Use the max-delay property to set the maximum amount of delay that
  33  * will be used. This can only be set before going to the PAUSED or PLAYING
  34  * state and will be set to the current delay by default.
  35  *
  36  * <refsect2>
  37  * <title>Example launch line</title>
  38  * |[
  39  * gst-launch filesrc location="melo1.ogg" ! audioconvert ! audioecho delay=500000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
  40  * gst-launch filesrc location="melo1.ogg" ! decodebin ! audioconvert ! audioecho delay=50000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
  41  * ]|
  42  * </refsect2>
  43  */
  44
  45 #ifdef HAVE_CONFIG_H
  46 #include "config.h"
  47 #endif
  48
  49 #include <gst/gst.h>
  50 #include <gst/base/gstbasetransform.h>
  51 #include <gst/audio/audio.h>
  52 #include <gst/audio/gstaudiofilter.h>
  53
  54 #include "audioecho.h"
  55
  56 #define GST_CAT_DEFAULT gst_audio_echo_debug
  57 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  58
  59 enum
  60 {
  61   PROP_0,
  62   PROP_DELAY,
  63   PROP_MAX_DELAY,
  64   PROP_INTENSITY,
  65   PROP_FEEDBACK
  66 };
  67
  68 #define ALLOWED_CAPS \
  69     "audio/x-raw,"                                                 \
  70     " format=(string) {"GST_AUDIO_NE(F32)","GST_AUDIO_NE(F64)"}, " \
  71     " rate=(int)[1,MAX],"                                          \
  72     " channels=(int)[1,MAX]"
  73
  74 #define gst_audio_echo_parent_class parent_class
  75 G_DEFINE_TYPE (GstAudioEcho, gst_audio_echo, GST_TYPE_AUDIO_FILTER);
  76
  77 static void gst_audio_echo_set_property (GObject * object, guint prop_id,
  78     const GValue * value, GParamSpec * pspec);
  79 static void gst_audio_echo_get_property (GObject * object, guint prop_id,
  80     GValue * value, GParamSpec * pspec);
  81 static void gst_audio_echo_finalize (GObject * object);
  82
  83 static gboolean gst_audio_echo_setup (GstAudioFilter * self,
  84     const GstAudioInfo * info);
  85 static gboolean gst_audio_echo_stop (GstBaseTransform * base);
  86 static GstFlowReturn gst_audio_echo_transform_ip (GstBaseTransform * base,
  87     GstBuffer * buf);
  88
  89 static void gst_audio_echo_transform_float (GstAudioEcho * self,
  90     gfloat * data, guint num_samples);
  91 static void gst_audio_echo_transform_double (GstAudioEcho * self,
  92     gdouble * data, guint num_samples);
  93
  94 /* GObject vmethod implementations */
  95
  96 static void
  97 gst_audio_echo_class_init (GstAudioEchoClass * klass)
  98 {
  99   GObjectClass *gobject_class = (GObjectClass *) klass;
 100   GstElementClass *gstelement_class = (GstElementClass *) klass;
 101   GstBaseTransformClass *basetransform_class = (GstBaseTransformClass *) klass;
 102   GstAudioFilterClass *audioself_class = (GstAudioFilterClass *) klass;
 103   GstCaps *caps;
 104
 105   GST_DEBUG_CATEGORY_INIT (gst_audio_echo_debug, "audioecho", 0,
 106       "audioecho element");
 107
 108   gobject_class->set_property = gst_audio_echo_set_property;
 109   gobject_class->get_property = gst_audio_echo_get_property;
 110   gobject_class->finalize = gst_audio_echo_finalize;
 111
 112   g_object_class_install_property (gobject_class, PROP_DELAY,
 113       g_param_spec_uint64 ("delay", "Delay",
 114           "Delay of the echo in nanoseconds", 1, G_MAXUINT64,
 115           1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
 116           | GST_PARAM_CONTROLLABLE));
 117
 118   g_object_class_install_property (gobject_class, PROP_MAX_DELAY,
 119       g_param_spec_uint64 ("max-delay", "Maximum Delay",
 120           "Maximum delay of the echo in nanoseconds"
 121           " (can't be changed in PLAYING or PAUSED state)",
 122           1, G_MAXUINT64, 1,
 123           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
 124           GST_PARAM_MUTABLE_READY));
 125
 126   g_object_class_install_property (gobject_class, PROP_INTENSITY,
 127       g_param_spec_float ("intensity", "Intensity",
 128           "Intensity of the echo", 0.0, 1.0,
 129           0.0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
 130           | GST_PARAM_CONTROLLABLE));
 131
 132   g_object_class_install_property (gobject_class, PROP_FEEDBACK,
 133       g_param_spec_float ("feedback", "Feedback",
 134           "Amount of feedback", 0.0, 1.0,
 135           0.0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
 136           | GST_PARAM_CONTROLLABLE));
 137
 138   gst_element_class_set_details_simple (gstelement_class, "Audio echo",
 139       "Filter/Effect/Audio",
 140       "Adds an echo or reverb effect to an audio stream",
 141       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 142
 143   caps = gst_caps_from_string (ALLOWED_CAPS);
 144   gst_audio_filter_class_add_pad_templates (GST_AUDIO_FILTER_CLASS (klass),
 145       caps);
 146   gst_caps_unref (caps);
 147
 148   audioself_class->setup = GST_DEBUG_FUNCPTR (gst_audio_echo_setup);
 149   basetransform_class->transform_ip =
 150       GST_DEBUG_FUNCPTR (gst_audio_echo_transform_ip);
 151   basetransform_class->stop = GST_DEBUG_FUNCPTR (gst_audio_echo_stop);
 152 }
 153
 154 static void
 155 gst_audio_echo_init (GstAudioEcho * self)
 156 {
 157   self->delay = 1;
 158   self->max_delay = 1;
 159   self->intensity = 0.0;
 160   self->feedback = 0.0;
 161
 162   gst_base_transform_set_in_place (GST_BASE_TRANSFORM (self), TRUE);
 163 }
 164
 165 static void
 166 gst_audio_echo_finalize (GObject * object)
 167 {
 168   GstAudioEcho *self = GST_AUDIO_ECHO (object);
 169
 170   g_free (self->buffer);
 171   self->buffer = NULL;
 172
 173   G_OBJECT_CLASS (parent_class)->finalize (object);
 174 }
 175
 176 static void
 177 gst_audio_echo_set_property (GObject * object, guint prop_id,
 178     const GValue * value, GParamSpec * pspec)
 179 {
 180   GstAudioEcho *self = GST_AUDIO_ECHO (object);
 181
 182   switch (prop_id) {
 183     case PROP_DELAY:{
 184       guint64 max_delay, delay;
 185
 186       GST_BASE_TRANSFORM_LOCK (self);
 187       delay = g_value_get_uint64 (value);
 188       max_delay = self->max_delay;
 189
 190       if (delay > max_delay && GST_STATE (self) > GST_STATE_READY) {
 191         GST_WARNING_OBJECT (self, "New delay (%" GST_TIME_FORMAT ") "
 192             "is larger than maximum delay (%" GST_TIME_FORMAT ")",
 193             GST_TIME_ARGS (delay), GST_TIME_ARGS (max_delay));
 194         self->delay = max_delay;
 195       } else {
 196         self->delay = delay;
 197         self->max_delay = MAX (delay, max_delay);
 198       }
 199       GST_BASE_TRANSFORM_UNLOCK (self);
 200     }
 201       break;
 202     case PROP_MAX_DELAY:{
 203       guint64 max_delay, delay;
 204
 205       GST_BASE_TRANSFORM_LOCK (self);
 206       max_delay = g_value_get_uint64 (value);
 207       delay = self->delay;
 208
 209       if (GST_STATE (self) > GST_STATE_READY) {
 210         GST_ERROR_OBJECT (self, "Can't change maximum delay in"
 211             " PLAYING or PAUSED state");
 212       } else {
 213         self->delay = delay;
 214         self->max_delay = max_delay;
 215       }
 216       GST_BASE_TRANSFORM_UNLOCK (self);
 217     }
 218       break;
 219     case PROP_INTENSITY:{
 220       GST_BASE_TRANSFORM_LOCK (self);
 221       self->intensity = g_value_get_float (value);
 222       GST_BASE_TRANSFORM_UNLOCK (self);
 223     }
 224       break;
 225     case PROP_FEEDBACK:{
 226       GST_BASE_TRANSFORM_LOCK (self);
 227       self->feedback = g_value_get_float (value);
 228       GST_BASE_TRANSFORM_UNLOCK (self);
 229     }
 230       break;
 231     default:
 232       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 233       break;
 234   }
 235 }
 236
 237 static void
 238 gst_audio_echo_get_property (GObject * object, guint prop_id,
 239     GValue * value, GParamSpec * pspec)
 240 {
 241   GstAudioEcho *self = GST_AUDIO_ECHO (object);
 242
 243   switch (prop_id) {
 244     case PROP_DELAY:
 245       GST_BASE_TRANSFORM_LOCK (self);
 246       g_value_set_uint64 (value, self->delay);
 247       GST_BASE_TRANSFORM_UNLOCK (self);
 248       break;
 249     case PROP_MAX_DELAY:
 250       GST_BASE_TRANSFORM_LOCK (self);
 251       g_value_set_uint64 (value, self->max_delay);
 252       GST_BASE_TRANSFORM_UNLOCK (self);
 253       break;
 254     case PROP_INTENSITY:
 255       GST_BASE_TRANSFORM_LOCK (self);
 256       g_value_set_float (value, self->intensity);
 257       GST_BASE_TRANSFORM_UNLOCK (self);
 258       break;
 259     case PROP_FEEDBACK:
 260       GST_BASE_TRANSFORM_LOCK (self);
 261       g_value_set_float (value, self->feedback);
 262       GST_BASE_TRANSFORM_UNLOCK (self);
 263       break;
 264     default:
 265       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 266       break;
 267   }
 268 }
 269
 270 /* GstAudioFilter vmethod implementations */
 271
 272 static gboolean
 273 gst_audio_echo_setup (GstAudioFilter * base, const GstAudioInfo * info)
 274 {
 275   GstAudioEcho *self = GST_AUDIO_ECHO (base);
 276   gboolean ret = TRUE;
 277
 278   switch (GST_AUDIO_INFO_FORMAT (info)) {
 279     case GST_AUDIO_FORMAT_F32:
 280       self->process = (GstAudioEchoProcessFunc)
 281           gst_audio_echo_transform_float;
 282       break;
 283     case GST_AUDIO_FORMAT_F64:
 284       self->process = (GstAudioEchoProcessFunc)
 285           gst_audio_echo_transform_double;
 286       break;
 287     default:
 288       ret = FALSE;
 289       break;
 290   }
 291
 292   g_free (self->buffer);
 293   self->buffer = NULL;
 294   self->buffer_pos = 0;
 295   self->buffer_size = 0;
 296   self->buffer_size_frames = 0;
 297
 298   return ret;
 299 }
 300
 301 static gboolean
 302 gst_audio_echo_stop (GstBaseTransform * base)
 303 {
 304   GstAudioEcho *self = GST_AUDIO_ECHO (base);
 305
 306   g_free (self->buffer);
 307   self->buffer = NULL;
 308   self->buffer_pos = 0;
 309   self->buffer_size = 0;
 310   self->buffer_size_frames = 0;
 311
 312   return TRUE;
 313 }
 314
 315 #define TRANSFORM_FUNC(name, type) \
 316 static void \
 317 gst_audio_echo_transform_##name (GstAudioEcho * self, \
 318     type * data, guint num_samples) \
 319 { \
 320   type *buffer = (type *) self->buffer; \
 321   guint channels = GST_AUDIO_FILTER_CHANNELS (self); \
 322   guint rate = GST_AUDIO_FILTER_RATE (self); \
 323   guint i, j; \
 324   guint echo_index = self->buffer_size_frames - self->delay_frames; \
 325   gdouble echo_off = ((((gdouble) self->delay) * rate) / GST_SECOND) - self->delay_frames; \
 326   \
 327   if (echo_off < 0.0) \
 328     echo_off = 0.0; \
 329   \
 330   num_samples /= channels; \
 331   \
 332   for (i = 0; i < num_samples; i++) { \
 333     guint echo0_index = ((echo_index + self->buffer_pos) % self->buffer_size_frames) * channels; \
 334     guint echo1_index = ((echo_index + self->buffer_pos +1) % self->buffer_size_frames) * channels; \
 335     guint rbout_index = (self->buffer_pos % self->buffer_size_frames) * channels; \
 336     for (j = 0; j < channels; j++) { \
 337       gdouble in = data[i*channels + j]; \
 338       gdouble echo0 = buffer[echo0_index + j]; \
 339       gdouble echo1 = buffer[echo1_index + j]; \
 340       gdouble echo = echo0 + (echo1-echo0)*echo_off; \
 341       type out = in + self->intensity * echo; \
 342       \
 343       data[i*channels + j] = out; \
 344       \
 345       buffer[rbout_index + j] = in + self->feedback * echo; \
 346     } \
 347     self->buffer_pos = (self->buffer_pos + 1) % self->buffer_size_frames; \
 348   } \
 349 }
 350
 351 TRANSFORM_FUNC (float, gfloat);
 352 TRANSFORM_FUNC (double, gdouble);
 353
 354 /* GstBaseTransform vmethod implementations */
 355 static GstFlowReturn
 356 gst_audio_echo_transform_ip (GstBaseTransform * base, GstBuffer * buf)
 357 {
 358   GstAudioEcho *self = GST_AUDIO_ECHO (base);
 359   guint num_samples;
 360   GstClockTime timestamp, stream_time;
 361   guint8 *data;
 362   gsize size;
 363
 364   timestamp = GST_BUFFER_TIMESTAMP (buf);
 365   stream_time =
 366       gst_segment_to_stream_time (&base->segment, GST_FORMAT_TIME, timestamp);
 367
 368   GST_DEBUG_OBJECT (self, "sync to %" GST_TIME_FORMAT,
 369       GST_TIME_ARGS (timestamp));
 370
 371   if (GST_CLOCK_TIME_IS_VALID (stream_time))
 372     gst_object_sync_values (GST_OBJECT (self), stream_time);
 373
 374   if (self->buffer == NULL) {
 375     guint bpf, rate;
 376
 377     bpf = GST_AUDIO_FILTER_BPF (self);
 378     rate = GST_AUDIO_FILTER_RATE (self);
 379
 380     self->delay_frames =
 381         MAX (gst_util_uint64_scale (self->delay, rate, GST_SECOND), 1);
 382     self->buffer_size_frames =
 383         MAX (gst_util_uint64_scale (self->max_delay, rate, GST_SECOND), 1);
 384
 385     self->buffer_size = self->buffer_size_frames * bpf;
 386     self->buffer = g_try_malloc0 (self->buffer_size);
 387     self->buffer_pos = 0;
 388
 389     if (self->buffer == NULL) {
 390       GST_ERROR_OBJECT (self, "Failed to allocate %u bytes", self->buffer_size);
 391       return GST_FLOW_ERROR;
 392     }
 393   }
 394
 395   data = gst_buffer_map (buf, &size, NULL, GST_MAP_READWRITE);
 396   num_samples = size / GST_AUDIO_FILTER_BPS (self);
 397
 398   self->process (self, data, num_samples);
 399
 400   gst_buffer_unmap (buf, data, size);
 401
 402   return GST_FLOW_OK;
 403 }