gst/dtmf/gstdtmfsrc.c

   1 /* GStreamer DTMF source
   2  *
   3  * gstdtmfsrc.c:
   4  *
   5  * Copyright (C) <2007> Collabora.
   6  *   Contact: Youness Alaoui <youness.alaoui@collabora.co.uk>
   7  * Copyright (C) <2007> Nokia Corporation.
   8  *   Contact: Zeeshan Ali <zeeshan.ali@nokia.com>
   9  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
  10  *               2000,2005 Wim Taymans <wim@fluendo.com>
  11  *
  12  * This library is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Library General Public
  14  * License as published by the Free Software Foundation; either
  15  * version 2 of the License, or (at your option) any later version.
  16  *
  17  * This library is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with this library; if not, write to the
  24  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  25  * Boston, MA 02110-1301, USA.
  26  */
  27
  28 /**
  29  * SECTION:element-dtmfsrc
  30  * @see_also: rtpdtmsrc, rtpdtmfmuxx
  31  *
  32  * The DTMFSrc element generates DTMF (ITU-T Q.23 Specification) tone packets on request
  33  * from application. The application communicates the beginning and end of a
  34  * DTMF event using custom upstream gstreamer events. To report a DTMF event, an
  35  * application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a
  36  * structure of name "dtmf-event" with fields set according to the following
  37  * table:
  38  *
  39  * <informaltable>
  40  * <tgroup cols='4'>
  41  * <colspec colname='Name' />
  42  * <colspec colname='Type' />
  43  * <colspec colname='Possible values' />
  44  * <colspec colname='Purpose' />
  45  * <thead>
  46  * <row>
  47  * <entry>Name</entry>
  48  * <entry>GType</entry>
  49  * <entry>Possible values</entry>
  50  * <entry>Purpose</entry>
  51  * </row>
  52  * </thead>
  53  * <tbody>
  54  * <row>
  55  * <entry>type</entry>
  56  * <entry>G_TYPE_INT</entry>
  57  * <entry>0-1</entry>
  58  * <entry>The application uses this field to specify which of the two methods
  59  * specified in RFC 2833 to use. The value should be 0 for tones and 1 for
  60  * named events. Tones are specified by their frequencies and events are specied
  61  * by their number. This element can only take events as input. Do not confuse
  62  * with "method" which specified the output.
  63  * </entry>
  64  * </row>
  65  * <row>
  66  * <entry>number</entry>
  67  * <entry>G_TYPE_INT</entry>
  68  * <entry>0-15</entry>
  69  * <entry>The event number.</entry>
  70  * </row>
  71  * <row>
  72  * <entry>volume</entry>
  73  * <entry>G_TYPE_INT</entry>
  74  * <entry>0-36</entry>
  75  * <entry>This field describes the power level of the tone, expressed in dBm0
  76  * after dropping the sign. Power levels range from 0 to -63 dBm0. The range of
  77  * valid DTMF is from 0 to -36 dBm0. Can be omitted if start is set to FALSE.
  78  * </entry>
  79  * </row>
  80  * <row>
  81  * <entry>start</entry>
  82  * <entry>G_TYPE_BOOLEAN</entry>
  83  * <entry>True or False</entry>
  84  * <entry>Whether the event is starting or ending.</entry>
  85  * </row>
  86  * <row>
  87  * <entry>method</entry>
  88  * <entry>G_TYPE_INT</entry>
  89  * <entry>2</entry>
  90  * <entry>The method used for sending event, this element will react if this
  91  * field is absent or 2.
  92  * </entry>
  93  * </row>
  94  * </tbody>
  95  * </tgroup>
  96  * </informaltable>
  97  *
  98  * For example, the following code informs the pipeline (and in turn, the
  99  * DTMFSrc element inside the pipeline) about the start of a DTMF named
 100  * event '1' of volume -25 dBm0:
 101  *
 102  * <programlisting>
 103  * structure = gst_structure_new ("dtmf-event",
 104  *                    "type", G_TYPE_INT, 1,
 105  *                    "number", G_TYPE_INT, 1,
 106  *                    "volume", G_TYPE_INT, 25,
 107  *                    "start", G_TYPE_BOOLEAN, TRUE, NULL);
 108  *
 109  * event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure);
 110  * gst_element_send_event (pipeline, event);
 111  * </programlisting>
 112  *
 113  * When a DTMF tone actually starts or stop, a "dtmf-event-processed"
 114  * element #GstMessage with the same fields as the "dtmf-event"
 115  * #GstEvent that was used to request the event. Also, if any event
 116  * has not been processed when the element goes from the PAUSED to the
 117  * READY state, then a "dtmf-event-dropped" message is posted on the
 118  * #GstBus in the order that they were received.
 119  */
 120
 121 #ifdef HAVE_CONFIG_H
 122 #include "config.h"
 123 #endif
 124
 125 #include <stdlib.h>
 126 #include <string.h>
 127 #include <math.h>
 128
 129 #include <glib.h>
 130
 131 #include "gstdtmfcommon.h"
 132
 133 #include "gstdtmfsrc.h"
 134
 135 #include <gst/audio/audio.h>
 136
 137 #define GST_TONE_DTMF_TYPE_EVENT 1
 138 #define DEFAULT_PACKET_INTERVAL  50     /* ms */
 139 #define MIN_PACKET_INTERVAL      10     /* ms */
 140 #define MAX_PACKET_INTERVAL      50     /* ms */
 141 #define DEFAULT_SAMPLE_RATE      8000
 142 #define SAMPLE_SIZE              16
 143 #define CHANNELS                 1
 144 #define MIN_DUTY_CYCLE           (MIN_INTER_DIGIT_INTERVAL + MIN_PULSE_DURATION)
 145
 146
 147 typedef struct st_dtmf_key
 148 {
 149   const char *event_name;
 150   int event_encoding;
 151   float low_frequency;
 152   float high_frequency;
 153 } DTMF_KEY;
 154
 155 static const DTMF_KEY DTMF_KEYS[] = {
 156   {"DTMF_KEY_EVENT_0", 0, 941, 1336},
 157   {"DTMF_KEY_EVENT_1", 1, 697, 1209},
 158   {"DTMF_KEY_EVENT_2", 2, 697, 1336},
 159   {"DTMF_KEY_EVENT_3", 3, 697, 1477},
 160   {"DTMF_KEY_EVENT_4", 4, 770, 1209},
 161   {"DTMF_KEY_EVENT_5", 5, 770, 1336},
 162   {"DTMF_KEY_EVENT_6", 6, 770, 1477},
 163   {"DTMF_KEY_EVENT_7", 7, 852, 1209},
 164   {"DTMF_KEY_EVENT_8", 8, 852, 1336},
 165   {"DTMF_KEY_EVENT_9", 9, 852, 1477},
 166   {"DTMF_KEY_EVENT_S", 10, 941, 1209},
 167   {"DTMF_KEY_EVENT_P", 11, 941, 1477},
 168   {"DTMF_KEY_EVENT_A", 12, 697, 1633},
 169   {"DTMF_KEY_EVENT_B", 13, 770, 1633},
 170   {"DTMF_KEY_EVENT_C", 14, 852, 1633},
 171   {"DTMF_KEY_EVENT_D", 15, 941, 1633},
 172 };
 173
 174 #define MAX_DTMF_EVENTS 16
 175
 176 enum
 177 {
 178   DTMF_KEY_EVENT_1 = 1,
 179   DTMF_KEY_EVENT_2 = 2,
 180   DTMF_KEY_EVENT_3 = 3,
 181   DTMF_KEY_EVENT_4 = 4,
 182   DTMF_KEY_EVENT_5 = 5,
 183   DTMF_KEY_EVENT_6 = 6,
 184   DTMF_KEY_EVENT_7 = 7,
 185   DTMF_KEY_EVENT_8 = 8,
 186   DTMF_KEY_EVENT_9 = 9,
 187   DTMF_KEY_EVENT_0 = 0,
 188   DTMF_KEY_EVENT_STAR = 10,
 189   DTMF_KEY_EVENT_POUND = 11,
 190   DTMF_KEY_EVENT_A = 12,
 191   DTMF_KEY_EVENT_B = 13,
 192   DTMF_KEY_EVENT_C = 14,
 193   DTMF_KEY_EVENT_D = 15,
 194 };
 195
 196 GST_DEBUG_CATEGORY_STATIC (gst_dtmf_src_debug);
 197 #define GST_CAT_DEFAULT gst_dtmf_src_debug
 198
 199 enum
 200 {
 201   PROP_0,
 202   PROP_INTERVAL,
 203 };
 204
 205 static GstStaticPadTemplate gst_dtmf_src_template =
 206 GST_STATIC_PAD_TEMPLATE ("src",
 207     GST_PAD_SRC,
 208     GST_PAD_ALWAYS,
 209     GST_STATIC_CAPS ("audio/x-raw, "
 210         "format = (string) \"" GST_AUDIO_NE (S16) "\", "
 211         "rate = " GST_AUDIO_RATE_RANGE ", " "channels = (int) 1")
 212     );
 213
 214 #define parent_class gst_dtmf_src_parent_class
 215 G_DEFINE_TYPE (GstDTMFSrc, gst_dtmf_src, GST_TYPE_BASE_SRC);
 216
 217 static void gst_dtmf_src_finalize (GObject * object);
 218
 219 static void gst_dtmf_src_set_property (GObject * object, guint prop_id,
 220     const GValue * value, GParamSpec * pspec);
 221 static void gst_dtmf_src_get_property (GObject * object, guint prop_id,
 222     GValue * value, GParamSpec * pspec);
 223 static gboolean gst_dtmf_src_handle_event (GstBaseSrc * src, GstEvent * event);
 224 static gboolean gst_dtmf_src_send_event (GstElement * src, GstEvent * event);
 225 static GstStateChangeReturn gst_dtmf_src_change_state (GstElement * element,
 226     GstStateChange transition);
 227 static GstFlowReturn gst_dtmf_src_create (GstBaseSrc * basesrc,
 228     guint64 offset, guint length, GstBuffer ** buffer);
 229 static void gst_dtmf_src_add_start_event (GstDTMFSrc * dtmfsrc,
 230     gint event_number, gint event_volume);
 231 static void gst_dtmf_src_add_stop_event (GstDTMFSrc * dtmfsrc);
 232
 233 static gboolean gst_dtmf_src_unlock (GstBaseSrc * src);
 234
 235 static gboolean gst_dtmf_src_unlock_stop (GstBaseSrc * src);
 236 static gboolean gst_dtmf_src_negotiate (GstBaseSrc * basesrc);
 237 static gboolean gst_dtmf_src_query (GstBaseSrc * basesrc, GstQuery * query);
 238
 239
 240 static void
 241 gst_dtmf_src_class_init (GstDTMFSrcClass * klass)
 242 {
 243   GObjectClass *gobject_class;
 244   GstBaseSrcClass *gstbasesrc_class;
 245   GstElementClass *gstelement_class;
 246
 247   gobject_class = G_OBJECT_CLASS (klass);
 248   gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
 249   gstelement_class = GST_ELEMENT_CLASS (klass);
 250
 251
 252   GST_DEBUG_CATEGORY_INIT (gst_dtmf_src_debug, "dtmfsrc", 0, "dtmfsrc element");
 253
 254   gst_element_class_add_static_pad_template (gstelement_class,
 255       &gst_dtmf_src_template);
 256
 257   gst_element_class_set_static_metadata (gstelement_class,
 258       "DTMF tone generator", "Source/Audio", "Generates DTMF tones",
 259       "Youness Alaoui <youness.alaoui@collabora.co.uk>");
 260
 261
 262   gobject_class->finalize = gst_dtmf_src_finalize;
 263   gobject_class->set_property = gst_dtmf_src_set_property;
 264   gobject_class->get_property = gst_dtmf_src_get_property;
 265
 266   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_INTERVAL,
 267       g_param_spec_uint ("interval", "Interval between tone packets",
 268           "Interval in ms between two tone packets", MIN_PACKET_INTERVAL,
 269           MAX_PACKET_INTERVAL, DEFAULT_PACKET_INTERVAL,
 270           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 271
 272   gstelement_class->change_state =
 273       GST_DEBUG_FUNCPTR (gst_dtmf_src_change_state);
 274   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_dtmf_src_send_event);
 275   gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_dtmf_src_unlock);
 276   gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_dtmf_src_unlock_stop);
 277
 278   gstbasesrc_class->event = GST_DEBUG_FUNCPTR (gst_dtmf_src_handle_event);
 279   gstbasesrc_class->create = GST_DEBUG_FUNCPTR (gst_dtmf_src_create);
 280   gstbasesrc_class->negotiate = GST_DEBUG_FUNCPTR (gst_dtmf_src_negotiate);
 281   gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_dtmf_src_query);
 282 }
 283
 284 static void
 285 event_free (GstDTMFSrcEvent * event)
 286 {
 287   if (event)
 288     g_slice_free (GstDTMFSrcEvent, event);
 289 }
 290
 291 static void
 292 gst_dtmf_src_init (GstDTMFSrc * dtmfsrc)
 293 {
 294   /* we operate in time */
 295   gst_base_src_set_format (GST_BASE_SRC (dtmfsrc), GST_FORMAT_TIME);
 296   gst_base_src_set_live (GST_BASE_SRC (dtmfsrc), TRUE);
 297
 298   dtmfsrc->interval = DEFAULT_PACKET_INTERVAL;
 299
 300   dtmfsrc->event_queue = g_async_queue_new_full ((GDestroyNotify) event_free);
 301   dtmfsrc->last_event = NULL;
 302
 303   dtmfsrc->sample_rate = DEFAULT_SAMPLE_RATE;
 304
 305   GST_DEBUG_OBJECT (dtmfsrc, "init done");
 306 }
 307
 308 static void
 309 gst_dtmf_src_finalize (GObject * object)
 310 {
 311   GstDTMFSrc *dtmfsrc;
 312
 313   dtmfsrc = GST_DTMF_SRC (object);
 314
 315   if (dtmfsrc->event_queue) {
 316     g_async_queue_unref (dtmfsrc->event_queue);
 317     dtmfsrc->event_queue = NULL;
 318   }
 319
 320   G_OBJECT_CLASS (gst_dtmf_src_parent_class)->finalize (object);
 321 }
 322
 323 static gboolean
 324 gst_dtmf_src_handle_dtmf_event (GstDTMFSrc * dtmfsrc, GstEvent * event)
 325 {
 326   const GstStructure *event_structure;
 327   GstStateChangeReturn sret;
 328   GstState state;
 329   gint event_type;
 330   gboolean start;
 331   gint method;
 332   GstClockTime last_stop;
 333   gint event_number;
 334   gint event_volume;
 335   gboolean correct_order;
 336
 337   sret = gst_element_get_state (GST_ELEMENT (dtmfsrc), &state, NULL, 0);
 338   if (sret != GST_STATE_CHANGE_SUCCESS || state != GST_STATE_PLAYING) {
 339     GST_DEBUG_OBJECT (dtmfsrc, "dtmf-event, but not in PLAYING state");
 340     goto failure;
 341   }
 342
 343   event_structure = gst_event_get_structure (event);
 344
 345   if (!gst_structure_get_int (event_structure, "type", &event_type) ||
 346       !gst_structure_get_boolean (event_structure, "start", &start) ||
 347       (start == TRUE && event_type != GST_TONE_DTMF_TYPE_EVENT))
 348     goto failure;
 349
 350   if (gst_structure_get_int (event_structure, "method", &method)) {
 351     if (method != 2) {
 352       goto failure;
 353     }
 354   }
 355
 356   if (start)
 357     if (!gst_structure_get_int (event_structure, "number", &event_number) ||
 358         !gst_structure_get_int (event_structure, "volume", &event_volume))
 359       goto failure;
 360
 361
 362   GST_OBJECT_LOCK (dtmfsrc);
 363   if (gst_structure_get_clock_time (event_structure, "last-stop", &last_stop))
 364     dtmfsrc->last_stop = last_stop;
 365   else
 366     dtmfsrc->last_stop = GST_CLOCK_TIME_NONE;
 367   correct_order = (start != dtmfsrc->last_event_was_start);
 368   dtmfsrc->last_event_was_start = start;
 369   GST_OBJECT_UNLOCK (dtmfsrc);
 370
 371   if (!correct_order)
 372     goto failure;
 373
 374   if (start) {
 375     GST_DEBUG_OBJECT (dtmfsrc, "Received start event %d with volume %d",
 376         event_number, event_volume);
 377     gst_dtmf_src_add_start_event (dtmfsrc, event_number, event_volume);
 378   }
 379
 380   else {
 381     GST_DEBUG_OBJECT (dtmfsrc, "Received stop event");
 382     gst_dtmf_src_add_stop_event (dtmfsrc);
 383   }
 384
 385   return TRUE;
 386 failure:
 387   return FALSE;
 388 }
 389
 390 static gboolean
 391 gst_dtmf_src_handle_event (GstBaseSrc * src, GstEvent * event)
 392 {
 393   GstDTMFSrc *dtmfsrc;
 394   gboolean result = FALSE;
 395
 396   dtmfsrc = GST_DTMF_SRC (src);
 397
 398   GST_LOG_OBJECT (dtmfsrc, "Received an %s event on the src pad",
 399       GST_EVENT_TYPE_NAME (event));
 400
 401   switch (GST_EVENT_TYPE (event)) {
 402     case GST_EVENT_CUSTOM_UPSTREAM:
 403       if (gst_event_has_name (event, "dtmf-event")) {
 404         result = gst_dtmf_src_handle_dtmf_event (dtmfsrc, event);
 405         break;
 406       }
 407       /* fall through */
 408     default:
 409       result = GST_BASE_SRC_CLASS (parent_class)->event (src, event);
 410       break;
 411   }
 412
 413   return result;
 414 }
 415
 416
 417 static gboolean
 418 gst_dtmf_src_send_event (GstElement * element, GstEvent * event)
 419 {
 420   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (element);
 421   gboolean ret;
 422
 423   GST_LOG_OBJECT (dtmfsrc, "Received an %s event via send_event",
 424       GST_EVENT_TYPE_NAME (event));
 425
 426   switch (GST_EVENT_TYPE (event)) {
 427     case GST_EVENT_CUSTOM_BOTH:
 428     case GST_EVENT_CUSTOM_BOTH_OOB:
 429     case GST_EVENT_CUSTOM_UPSTREAM:
 430     case GST_EVENT_CUSTOM_DOWNSTREAM:
 431     case GST_EVENT_CUSTOM_DOWNSTREAM_OOB:
 432       if (gst_event_has_name (event, "dtmf-event")) {
 433         ret = gst_dtmf_src_handle_dtmf_event (dtmfsrc, event);
 434         break;
 435       }
 436       /* fall through */
 437     default:
 438       ret = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 439       break;
 440   }
 441
 442   return ret;
 443 }
 444
 445 static void
 446 gst_dtmf_src_set_property (GObject * object, guint prop_id,
 447     const GValue * value, GParamSpec * pspec)
 448 {
 449   GstDTMFSrc *dtmfsrc;
 450
 451   dtmfsrc = GST_DTMF_SRC (object);
 452
 453   switch (prop_id) {
 454     case PROP_INTERVAL:
 455       dtmfsrc->interval = g_value_get_uint (value);
 456       break;
 457     default:
 458       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 459       break;
 460   }
 461 }
 462
 463 static void
 464 gst_dtmf_src_get_property (GObject * object, guint prop_id, GValue * value,
 465     GParamSpec * pspec)
 466 {
 467   GstDTMFSrc *dtmfsrc;
 468
 469   dtmfsrc = GST_DTMF_SRC (object);
 470
 471   switch (prop_id) {
 472     case PROP_INTERVAL:
 473       g_value_set_uint (value, dtmfsrc->interval);
 474       break;
 475     default:
 476       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 477       break;
 478   }
 479 }
 480
 481 static void
 482 gst_dtmf_prepare_timestamps (GstDTMFSrc * dtmfsrc)
 483 {
 484   GstClockTime last_stop;
 485   GstClockTime timestamp;
 486
 487   GST_OBJECT_LOCK (dtmfsrc);
 488   last_stop = dtmfsrc->last_stop;
 489   GST_OBJECT_UNLOCK (dtmfsrc);
 490
 491   if (GST_CLOCK_TIME_IS_VALID (last_stop)) {
 492     timestamp = last_stop;
 493   } else {
 494     GstClock *clock;
 495
 496     /* If there is no valid start time, lets use now as the start time */
 497
 498     clock = gst_element_get_clock (GST_ELEMENT (dtmfsrc));
 499     if (clock != NULL) {
 500       timestamp = gst_clock_get_time (clock)
 501           - gst_element_get_base_time (GST_ELEMENT (dtmfsrc));
 502       gst_object_unref (clock);
 503     } else {
 504       gchar *dtmf_name = gst_element_get_name (dtmfsrc);
 505       GST_ERROR_OBJECT (dtmfsrc, "No clock set for element %s", dtmf_name);
 506       dtmfsrc->timestamp = GST_CLOCK_TIME_NONE;
 507       g_free (dtmf_name);
 508       return;
 509     }
 510   }
 511
 512   /* Make sure the timestamp always goes forward */
 513   if (timestamp > dtmfsrc->timestamp)
 514     dtmfsrc->timestamp = timestamp;
 515 }
 516
 517 static void
 518 gst_dtmf_src_add_start_event (GstDTMFSrc * dtmfsrc, gint event_number,
 519     gint event_volume)
 520 {
 521
 522   GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
 523   event->event_type = DTMF_EVENT_TYPE_START;
 524   event->sample = 0;
 525   event->event_number = CLAMP (event_number, MIN_EVENT, MAX_EVENT);
 526   event->volume = CLAMP (event_volume, MIN_VOLUME, MAX_VOLUME);
 527
 528   g_async_queue_push (dtmfsrc->event_queue, event);
 529 }
 530
 531 static void
 532 gst_dtmf_src_add_stop_event (GstDTMFSrc * dtmfsrc)
 533 {
 534
 535   GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
 536   event->event_type = DTMF_EVENT_TYPE_STOP;
 537   event->sample = 0;
 538   event->event_number = 0;
 539   event->volume = 0;
 540
 541   g_async_queue_push (dtmfsrc->event_queue, event);
 542 }
 543
 544 static GstBuffer *
 545 gst_dtmf_src_generate_silence (float duration, gint sample_rate)
 546 {
 547   gint buf_size;
 548
 549   /* Create a buffer with data set to 0 */
 550   buf_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
 551
 552   return gst_buffer_new_wrapped (g_malloc0 (buf_size), buf_size);
 553 }
 554
 555 static GstBuffer *
 556 gst_dtmf_src_generate_tone (GstDTMFSrcEvent * event, DTMF_KEY key,
 557     float duration, gint sample_rate)
 558 {
 559   GstBuffer *buffer;
 560   GstMapInfo map;
 561   gint16 *p;
 562   gint tone_size;
 563   double i = 0;
 564   double amplitude, f1, f2;
 565   double volume_factor;
 566   static GstAllocationParams params = { 0, 1, 0, 0, };
 567
 568   /* Create a buffer for the tone */
 569   tone_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
 570
 571   buffer = gst_buffer_new_allocate (NULL, tone_size, &params);
 572
 573   gst_buffer_map (buffer, &map, GST_MAP_READWRITE);
 574   p = (gint16 *) map.data;
 575
 576   volume_factor = pow (10, (-event->volume) / 20);
 577
 578   /*
 579    * For each sample point we calculate 'x' as the
 580    * the amplitude value.
 581    */
 582   for (i = 0; i < (tone_size / (SAMPLE_SIZE / 8)); i++) {
 583     /*
 584      * We add the fundamental frequencies together.
 585      */
 586     f1 = sin (2 * M_PI * key.low_frequency * (event->sample / sample_rate));
 587     f2 = sin (2 * M_PI * key.high_frequency * (event->sample / sample_rate));
 588
 589     amplitude = (f1 + f2) / 2;
 590
 591     /* Adjust the volume */
 592     amplitude *= volume_factor;
 593
 594     /* Make the [-1:1] interval into a [-32767:32767] interval */
 595     amplitude *= 32767;
 596
 597     /* Store it in the data buffer */
 598     *(p++) = (gint16) amplitude;
 599
 600     (event->sample)++;
 601   }
 602
 603   gst_buffer_unmap (buffer, &map);
 604
 605   return buffer;
 606 }
 607
 608
 609
 610 static GstBuffer *
 611 gst_dtmf_src_create_next_tone_packet (GstDTMFSrc * dtmfsrc,
 612     GstDTMFSrcEvent * event)
 613 {
 614   GstBuffer *buf = NULL;
 615   gboolean send_silence = FALSE;
 616
 617   GST_LOG_OBJECT (dtmfsrc, "Creating buffer for tone %s",
 618       DTMF_KEYS[event->event_number].event_name);
 619
 620   if (event->packet_count * dtmfsrc->interval < MIN_INTER_DIGIT_INTERVAL) {
 621     send_silence = TRUE;
 622   }
 623
 624   if (send_silence) {
 625     GST_LOG_OBJECT (dtmfsrc, "Generating silence");
 626     buf = gst_dtmf_src_generate_silence (dtmfsrc->interval,
 627         dtmfsrc->sample_rate);
 628   } else {
 629     GST_LOG_OBJECT (dtmfsrc, "Generating tone");
 630     buf = gst_dtmf_src_generate_tone (event, DTMF_KEYS[event->event_number],
 631         dtmfsrc->interval, dtmfsrc->sample_rate);
 632   }
 633   event->packet_count++;
 634
 635
 636   /* timestamp and duration of GstBuffer */
 637   GST_BUFFER_DURATION (buf) = dtmfsrc->interval * GST_MSECOND;
 638   GST_BUFFER_TIMESTAMP (buf) = dtmfsrc->timestamp;
 639
 640   GST_LOG_OBJECT (dtmfsrc, "Creating new buffer with event %u duration "
 641       " gst: %" GST_TIME_FORMAT " at %" GST_TIME_FORMAT,
 642       event->event_number, GST_TIME_ARGS (GST_BUFFER_DURATION (buf)),
 643       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
 644
 645   dtmfsrc->timestamp += GST_BUFFER_DURATION (buf);
 646
 647   return buf;
 648 }
 649
 650 static void
 651 gst_dtmf_src_post_message (GstDTMFSrc * dtmfsrc, const gchar * message_name,
 652     GstDTMFSrcEvent * event)
 653 {
 654   GstStructure *s = NULL;
 655
 656   switch (event->event_type) {
 657     case DTMF_EVENT_TYPE_START:
 658       s = gst_structure_new (message_name,
 659           "type", G_TYPE_INT, 1,
 660           "method", G_TYPE_INT, 2,
 661           "start", G_TYPE_BOOLEAN, TRUE,
 662           "number", G_TYPE_INT, event->event_number,
 663           "volume", G_TYPE_INT, event->volume, NULL);
 664       break;
 665     case DTMF_EVENT_TYPE_STOP:
 666       s = gst_structure_new (message_name,
 667           "type", G_TYPE_INT, 1, "method", G_TYPE_INT, 2,
 668           "start", G_TYPE_BOOLEAN, FALSE, NULL);
 669       break;
 670     case DTMF_EVENT_TYPE_PAUSE_TASK:
 671       return;
 672   }
 673
 674   if (s)
 675     gst_element_post_message (GST_ELEMENT (dtmfsrc),
 676         gst_message_new_element (GST_OBJECT (dtmfsrc), s));
 677 }
 678
 679 static GstFlowReturn
 680 gst_dtmf_src_create (GstBaseSrc * basesrc, guint64 offset,
 681     guint length, GstBuffer ** buffer)
 682 {
 683   GstBuffer *buf = NULL;
 684   GstDTMFSrcEvent *event;
 685   GstDTMFSrc *dtmfsrc;
 686   GstClock *clock;
 687   GstClockID *clockid;
 688   GstClockReturn clockret;
 689
 690   dtmfsrc = GST_DTMF_SRC (basesrc);
 691
 692   do {
 693
 694     if (dtmfsrc->last_event == NULL) {
 695       GST_DEBUG_OBJECT (dtmfsrc, "popping");
 696       event = g_async_queue_pop (dtmfsrc->event_queue);
 697
 698       GST_DEBUG_OBJECT (dtmfsrc, "popped %d", event->event_type);
 699
 700       switch (event->event_type) {
 701         case DTMF_EVENT_TYPE_STOP:
 702           GST_WARNING_OBJECT (dtmfsrc,
 703               "Received a DTMF stop event when already stopped");
 704           gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 705           break;
 706         case DTMF_EVENT_TYPE_START:
 707           gst_dtmf_prepare_timestamps (dtmfsrc);
 708
 709           event->packet_count = 0;
 710           dtmfsrc->last_event = event;
 711           event = NULL;
 712           gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed",
 713               dtmfsrc->last_event);
 714           break;
 715         case DTMF_EVENT_TYPE_PAUSE_TASK:
 716           /*
 717            * We're pushing it back because it has to stay in there until
 718            * the task is really paused (and the queue will then be flushed)
 719            */
 720           GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");
 721           GST_OBJECT_LOCK (dtmfsrc);
 722           if (dtmfsrc->paused) {
 723             g_async_queue_push (dtmfsrc->event_queue, event);
 724             goto paused_locked;
 725           }
 726           GST_OBJECT_UNLOCK (dtmfsrc);
 727           break;
 728       }
 729       if (event)
 730         g_slice_free (GstDTMFSrcEvent, event);
 731     } else if (dtmfsrc->last_event->packet_count * dtmfsrc->interval >=
 732         MIN_DUTY_CYCLE) {
 733       event = g_async_queue_try_pop (dtmfsrc->event_queue);
 734
 735       if (event != NULL) {
 736
 737         switch (event->event_type) {
 738           case DTMF_EVENT_TYPE_START:
 739             GST_WARNING_OBJECT (dtmfsrc,
 740                 "Received two consecutive DTMF start events");
 741             gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 742             break;
 743           case DTMF_EVENT_TYPE_STOP:
 744             g_slice_free (GstDTMFSrcEvent, dtmfsrc->last_event);
 745             dtmfsrc->last_event = NULL;
 746             gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed", event);
 747             break;
 748           case DTMF_EVENT_TYPE_PAUSE_TASK:
 749             /*
 750              * We're pushing it back because it has to stay in there until
 751              * the task is really paused (and the queue will then be flushed)
 752              */
 753             GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");
 754
 755             GST_OBJECT_LOCK (dtmfsrc);
 756             if (dtmfsrc->paused) {
 757               g_async_queue_push (dtmfsrc->event_queue, event);
 758               goto paused_locked;
 759             }
 760             GST_OBJECT_UNLOCK (dtmfsrc);
 761
 762             break;
 763         }
 764         g_slice_free (GstDTMFSrcEvent, event);
 765       }
 766     }
 767   } while (dtmfsrc->last_event == NULL);
 768
 769   GST_LOG_OBJECT (dtmfsrc, "end event check, now wait for the proper time");
 770
 771   clock = gst_element_get_clock (GST_ELEMENT (basesrc));
 772
 773   clockid = gst_clock_new_single_shot_id (clock, dtmfsrc->timestamp +
 774       gst_element_get_base_time (GST_ELEMENT (dtmfsrc)));
 775   gst_object_unref (clock);
 776
 777   GST_OBJECT_LOCK (dtmfsrc);
 778   if (!dtmfsrc->paused) {
 779     dtmfsrc->clockid = clockid;
 780     GST_OBJECT_UNLOCK (dtmfsrc);
 781
 782     clockret = gst_clock_id_wait (clockid, NULL);
 783
 784     GST_OBJECT_LOCK (dtmfsrc);
 785     if (dtmfsrc->paused)
 786       clockret = GST_CLOCK_UNSCHEDULED;
 787   } else {
 788     clockret = GST_CLOCK_UNSCHEDULED;
 789   }
 790   gst_clock_id_unref (clockid);
 791   dtmfsrc->clockid = NULL;
 792   GST_OBJECT_UNLOCK (dtmfsrc);
 793
 794   if (clockret == GST_CLOCK_UNSCHEDULED) {
 795     goto paused;
 796   }
 797
 798   buf = gst_dtmf_src_create_next_tone_packet (dtmfsrc, dtmfsrc->last_event);
 799
 800   GST_LOG_OBJECT (dtmfsrc, "Created buffer of size %" G_GSIZE_FORMAT,
 801       gst_buffer_get_size (buf));
 802   *buffer = buf;
 803
 804   return GST_FLOW_OK;
 805
 806 paused_locked:
 807   GST_OBJECT_UNLOCK (dtmfsrc);
 808
 809 paused:
 810
 811   if (dtmfsrc->last_event) {
 812     GST_DEBUG_OBJECT (dtmfsrc, "Stopping current event");
 813     /* Don't forget to release the stream lock */
 814     g_slice_free (GstDTMFSrcEvent, dtmfsrc->last_event);
 815     dtmfsrc->last_event = NULL;
 816   }
 817
 818   return GST_FLOW_FLUSHING;
 819
 820 }
 821
 822 static gboolean
 823 gst_dtmf_src_unlock (GstBaseSrc * src)
 824 {
 825   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
 826   GstDTMFSrcEvent *event = NULL;
 827
 828   GST_DEBUG_OBJECT (dtmfsrc, "Called unlock");
 829
 830   GST_OBJECT_LOCK (dtmfsrc);
 831   dtmfsrc->paused = TRUE;
 832   if (dtmfsrc->clockid) {
 833     gst_clock_id_unschedule (dtmfsrc->clockid);
 834   }
 835   GST_OBJECT_UNLOCK (dtmfsrc);
 836
 837   GST_DEBUG_OBJECT (dtmfsrc, "Pushing the PAUSE_TASK event on unlock request");
 838   event = g_slice_new0 (GstDTMFSrcEvent);
 839   event->event_type = DTMF_EVENT_TYPE_PAUSE_TASK;
 840   g_async_queue_push (dtmfsrc->event_queue, event);
 841
 842   return TRUE;
 843 }
 844
 845
 846 static gboolean
 847 gst_dtmf_src_unlock_stop (GstBaseSrc * src)
 848 {
 849   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
 850
 851   GST_DEBUG_OBJECT (dtmfsrc, "Unlock stopped");
 852
 853   GST_OBJECT_LOCK (dtmfsrc);
 854   dtmfsrc->paused = FALSE;
 855   GST_OBJECT_UNLOCK (dtmfsrc);
 856
 857   return TRUE;
 858 }
 859
 860
 861 static gboolean
 862 gst_dtmf_src_negotiate (GstBaseSrc * basesrc)
 863 {
 864   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
 865   GstCaps *caps;
 866   GstStructure *s;
 867   gboolean ret;
 868
 869   caps = gst_pad_get_allowed_caps (GST_BASE_SRC_PAD (basesrc));
 870
 871   if (!caps)
 872     caps = gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD (basesrc));
 873
 874   if (gst_caps_is_empty (caps)) {
 875     gst_caps_unref (caps);
 876     return FALSE;
 877   }
 878
 879   caps = gst_caps_truncate (caps);
 880
 881   caps = gst_caps_make_writable (caps);
 882   s = gst_caps_get_structure (caps, 0);
 883
 884   gst_structure_fixate_field_nearest_int (s, "rate", DEFAULT_SAMPLE_RATE);
 885
 886   if (!gst_structure_get_int (s, "rate", &dtmfsrc->sample_rate)) {
 887     GST_ERROR_OBJECT (dtmfsrc, "Could not get rate");
 888     gst_caps_unref (caps);
 889     return FALSE;
 890   }
 891
 892   ret = gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps);
 893
 894   gst_caps_unref (caps);
 895
 896   return ret;
 897 }
 898
 899 static gboolean
 900 gst_dtmf_src_query (GstBaseSrc * basesrc, GstQuery * query)
 901 {
 902   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
 903   gboolean res = FALSE;
 904
 905   switch (GST_QUERY_TYPE (query)) {
 906     case GST_QUERY_LATENCY:
 907     {
 908       GstClockTime latency;
 909
 910       latency = dtmfsrc->interval * GST_MSECOND;
 911       gst_query_set_latency (query, gst_base_src_is_live (basesrc), latency,
 912           GST_CLOCK_TIME_NONE);
 913       GST_DEBUG_OBJECT (dtmfsrc, "Reporting latency of %" GST_TIME_FORMAT,
 914           GST_TIME_ARGS (latency));
 915       res = TRUE;
 916     }
 917       break;
 918     default:
 919       res = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
 920       break;
 921   }
 922
 923   return res;
 924 }
 925
 926 static GstStateChangeReturn
 927 gst_dtmf_src_change_state (GstElement * element, GstStateChange transition)
 928 {
 929   GstDTMFSrc *dtmfsrc;
 930   GstStateChangeReturn result;
 931   gboolean no_preroll = FALSE;
 932   GstDTMFSrcEvent *event = NULL;
 933
 934   dtmfsrc = GST_DTMF_SRC (element);
 935
 936   switch (transition) {
 937     case GST_STATE_CHANGE_READY_TO_PAUSED:
 938       /* Flushing the event queue */
 939       event = g_async_queue_try_pop (dtmfsrc->event_queue);
 940
 941       while (event != NULL) {
 942         gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 943         g_slice_free (GstDTMFSrcEvent, event);
 944         event = g_async_queue_try_pop (dtmfsrc->event_queue);
 945       }
 946       dtmfsrc->last_event_was_start = FALSE;
 947       dtmfsrc->timestamp = 0;
 948       no_preroll = TRUE;
 949       break;
 950     default:
 951       break;
 952   }
 953
 954   if ((result =
 955           GST_ELEMENT_CLASS (gst_dtmf_src_parent_class)->change_state (element,
 956               transition)) == GST_STATE_CHANGE_FAILURE)
 957     goto failure;
 958
 959   switch (transition) {
 960     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 961       no_preroll = TRUE;
 962       break;
 963     case GST_STATE_CHANGE_PAUSED_TO_READY:
 964       GST_DEBUG_OBJECT (dtmfsrc, "Flushing event queue");
 965       /* Flushing the event queue */
 966       event = g_async_queue_try_pop (dtmfsrc->event_queue);
 967
 968       while (event != NULL) {
 969         gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 970         g_slice_free (GstDTMFSrcEvent, event);
 971         event = g_async_queue_try_pop (dtmfsrc->event_queue);
 972       }
 973       dtmfsrc->last_event_was_start = FALSE;
 974
 975       break;
 976     default:
 977       break;
 978   }
 979
 980   if (no_preroll && result == GST_STATE_CHANGE_SUCCESS)
 981     result = GST_STATE_CHANGE_NO_PREROLL;
 982
 983   return result;
 984
 985   /* ERRORS */
 986 failure:
 987   {
 988     GST_ERROR_OBJECT (dtmfsrc, "parent failed state change");
 989     return result;
 990   }
 991 }
 992
 993 gboolean
 994 gst_dtmf_src_plugin_init (GstPlugin * plugin)
 995 {
 996   return gst_element_register (plugin, "dtmfsrc",
 997       GST_RANK_NONE, GST_TYPE_DTMF_SRC);
 998 }