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., 59 Temple Place - Suite 330,
  25  * Boston, MA 02111-1307, 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
 238
 239 static void
 240 gst_dtmf_src_class_init (GstDTMFSrcClass * klass)
 241 {
 242   GObjectClass *gobject_class;
 243   GstBaseSrcClass *gstbasesrc_class;
 244   GstElementClass *gstelement_class;
 245
 246   gobject_class = G_OBJECT_CLASS (klass);
 247   gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
 248   gstelement_class = GST_ELEMENT_CLASS (klass);
 249
 250
 251   GST_DEBUG_CATEGORY_INIT (gst_dtmf_src_debug, "dtmfsrc", 0, "dtmfsrc element");
 252
 253   gst_element_class_add_pad_template (gstelement_class,
 254       gst_static_pad_template_get (&gst_dtmf_src_template));
 255
 256   gst_element_class_set_details_simple (gstelement_class, "DTMF tone generator",
 257       "Source/Audio",
 258       "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 }
 282
 283 static void
 284 event_free (GstDTMFSrcEvent * event)
 285 {
 286   if (event)
 287     g_slice_free (GstDTMFSrcEvent, event);
 288 }
 289
 290 static void
 291 gst_dtmf_src_init (GstDTMFSrc * dtmfsrc)
 292 {
 293   /* we operate in time */
 294   gst_base_src_set_format (GST_BASE_SRC (dtmfsrc), GST_FORMAT_TIME);
 295   gst_base_src_set_live (GST_BASE_SRC (dtmfsrc), TRUE);
 296
 297   dtmfsrc->interval = DEFAULT_PACKET_INTERVAL;
 298
 299   dtmfsrc->event_queue = g_async_queue_new_full ((GDestroyNotify) event_free);
 300   dtmfsrc->last_event = NULL;
 301
 302   dtmfsrc->sample_rate = DEFAULT_SAMPLE_RATE;
 303
 304   GST_DEBUG_OBJECT (dtmfsrc, "init done");
 305 }
 306
 307 static void
 308 gst_dtmf_src_finalize (GObject * object)
 309 {
 310   GstDTMFSrc *dtmfsrc;
 311
 312   dtmfsrc = GST_DTMF_SRC (object);
 313
 314   if (dtmfsrc->event_queue) {
 315     g_async_queue_unref (dtmfsrc->event_queue);
 316     dtmfsrc->event_queue = NULL;
 317   }
 318
 319   G_OBJECT_CLASS (gst_dtmf_src_parent_class)->finalize (object);
 320 }
 321
 322 static gboolean
 323 gst_dtmf_src_handle_dtmf_event (GstDTMFSrc * dtmfsrc, GstEvent * event)
 324 {
 325   const GstStructure *event_structure;
 326   GstStateChangeReturn sret;
 327   GstState state;
 328   gint event_type;
 329   gboolean start;
 330   gint method;
 331   GstClockTime last_stop;
 332   gint event_number;
 333   gint event_volume;
 334   gboolean correct_order;
 335
 336   sret = gst_element_get_state (GST_ELEMENT (dtmfsrc), &state, NULL, 0);
 337   if (sret != GST_STATE_CHANGE_SUCCESS || state != GST_STATE_PLAYING) {
 338     GST_DEBUG_OBJECT (dtmfsrc, "dtmf-event, but not in PLAYING state");
 339     goto failure;
 340   }
 341
 342   event_structure = gst_event_get_structure (event);
 343
 344   if (!gst_structure_get_int (event_structure, "type", &event_type) ||
 345       !gst_structure_get_boolean (event_structure, "start", &start) ||
 346       (start == TRUE && event_type != GST_TONE_DTMF_TYPE_EVENT))
 347     goto failure;
 348
 349   if (gst_structure_get_int (event_structure, "method", &method)) {
 350     if (method != 2) {
 351       goto failure;
 352     }
 353   }
 354
 355   if (start)
 356     if (!gst_structure_get_int (event_structure, "number", &event_number) ||
 357         !gst_structure_get_int (event_structure, "volume", &event_volume))
 358       goto failure;
 359
 360
 361   GST_OBJECT_LOCK (dtmfsrc);
 362   if (gst_structure_get_clock_time (event_structure, "last-stop", &last_stop))
 363     dtmfsrc->last_stop = last_stop;
 364   else
 365     dtmfsrc->last_stop = GST_CLOCK_TIME_NONE;
 366   correct_order = (start != dtmfsrc->last_event_was_start);
 367   dtmfsrc->last_event_was_start = start;
 368   GST_OBJECT_UNLOCK (dtmfsrc);
 369
 370   if (!correct_order)
 371     goto failure;
 372
 373   if (start) {
 374     GST_DEBUG_OBJECT (dtmfsrc, "Received start event %d with volume %d",
 375         event_number, event_volume);
 376     gst_dtmf_src_add_start_event (dtmfsrc, event_number, event_volume);
 377   }
 378
 379   else {
 380     GST_DEBUG_OBJECT (dtmfsrc, "Received stop event");
 381     gst_dtmf_src_add_stop_event (dtmfsrc);
 382   }
 383
 384   return TRUE;
 385 failure:
 386   return FALSE;
 387 }
 388
 389 static gboolean
 390 gst_dtmf_src_handle_event (GstBaseSrc * src, GstEvent * event)
 391 {
 392   GstDTMFSrc *dtmfsrc;
 393   gboolean result = FALSE;
 394
 395   dtmfsrc = GST_DTMF_SRC (src);
 396
 397   GST_LOG_OBJECT (dtmfsrc, "Received an %s event on the src pad",
 398       GST_EVENT_TYPE_NAME (event));
 399
 400   switch (GST_EVENT_TYPE (event)) {
 401     case GST_EVENT_CUSTOM_UPSTREAM:
 402       if (gst_event_has_name (event, "dtmf-event")) {
 403         result = gst_dtmf_src_handle_dtmf_event (dtmfsrc, event);
 404         break;
 405       }
 406       /* fall through */
 407     default:
 408       result = GST_BASE_SRC_CLASS (parent_class)->event (src, event);
 409       break;
 410   }
 411
 412   return result;
 413 }
 414
 415
 416 static gboolean
 417 gst_dtmf_src_send_event (GstElement * element, GstEvent * event)
 418 {
 419   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (element);
 420   gboolean ret;
 421
 422   GST_LOG_OBJECT (dtmfsrc, "Received an %s event via send_event",
 423       GST_EVENT_TYPE_NAME (event));
 424
 425   switch (GST_EVENT_TYPE (event)) {
 426     case GST_EVENT_CUSTOM_BOTH:
 427     case GST_EVENT_CUSTOM_BOTH_OOB:
 428     case GST_EVENT_CUSTOM_UPSTREAM:
 429     case GST_EVENT_CUSTOM_DOWNSTREAM:
 430     case GST_EVENT_CUSTOM_DOWNSTREAM_OOB:
 431       if (gst_event_has_name (event, "dtmf-event")) {
 432         ret = gst_dtmf_src_handle_dtmf_event (dtmfsrc, event);
 433         break;
 434       }
 435       /* fall through */
 436     default:
 437       ret = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 438       break;
 439   }
 440
 441   return ret;
 442 }
 443
 444 static void
 445 gst_dtmf_src_set_property (GObject * object, guint prop_id,
 446     const GValue * value, GParamSpec * pspec)
 447 {
 448   GstDTMFSrc *dtmfsrc;
 449
 450   dtmfsrc = GST_DTMF_SRC (object);
 451
 452   switch (prop_id) {
 453     case PROP_INTERVAL:
 454       dtmfsrc->interval = g_value_get_uint (value);
 455       break;
 456     default:
 457       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 458       break;
 459   }
 460 }
 461
 462 static void
 463 gst_dtmf_src_get_property (GObject * object, guint prop_id, GValue * value,
 464     GParamSpec * pspec)
 465 {
 466   GstDTMFSrc *dtmfsrc;
 467
 468   dtmfsrc = GST_DTMF_SRC (object);
 469
 470   switch (prop_id) {
 471     case PROP_INTERVAL:
 472       g_value_set_uint (value, dtmfsrc->interval);
 473       break;
 474     default:
 475       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 476       break;
 477   }
 478 }
 479
 480 static void
 481 gst_dtmf_prepare_timestamps (GstDTMFSrc * dtmfsrc)
 482 {
 483   GstClockTime last_stop;
 484   GstClockTime timestamp;
 485
 486   GST_OBJECT_LOCK (dtmfsrc);
 487   last_stop = dtmfsrc->last_stop;
 488   GST_OBJECT_UNLOCK (dtmfsrc);
 489
 490   if (GST_CLOCK_TIME_IS_VALID (last_stop)) {
 491     timestamp = last_stop;
 492   } else {
 493     GstClock *clock;
 494
 495     /* If there is no valid start time, lets use now as the start time */
 496
 497     clock = gst_element_get_clock (GST_ELEMENT (dtmfsrc));
 498     if (clock != NULL) {
 499       timestamp = gst_clock_get_time (clock)
 500           - gst_element_get_base_time (GST_ELEMENT (dtmfsrc));
 501       gst_object_unref (clock);
 502     } else {
 503       gchar *dtmf_name = gst_element_get_name (dtmfsrc);
 504       GST_ERROR_OBJECT (dtmfsrc, "No clock set for element %s", dtmf_name);
 505       dtmfsrc->timestamp = GST_CLOCK_TIME_NONE;
 506       g_free (dtmf_name);
 507       return;
 508     }
 509   }
 510
 511   /* Make sure the timestamp always goes forward */
 512   if (timestamp > dtmfsrc->timestamp)
 513     dtmfsrc->timestamp = timestamp;
 514 }
 515
 516 static void
 517 gst_dtmf_src_add_start_event (GstDTMFSrc * dtmfsrc, gint event_number,
 518     gint event_volume)
 519 {
 520
 521   GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
 522   event->event_type = DTMF_EVENT_TYPE_START;
 523   event->sample = 0;
 524   event->event_number = CLAMP (event_number, MIN_EVENT, MAX_EVENT);
 525   event->volume = CLAMP (event_volume, MIN_VOLUME, MAX_VOLUME);
 526
 527   g_async_queue_push (dtmfsrc->event_queue, event);
 528 }
 529
 530 static void
 531 gst_dtmf_src_add_stop_event (GstDTMFSrc * dtmfsrc)
 532 {
 533
 534   GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
 535   event->event_type = DTMF_EVENT_TYPE_STOP;
 536   event->sample = 0;
 537   event->event_number = 0;
 538   event->volume = 0;
 539
 540   g_async_queue_push (dtmfsrc->event_queue, event);
 541 }
 542
 543 static GstBuffer *
 544 gst_dtmf_src_generate_silence (float duration, gint sample_rate)
 545 {
 546   gint buf_size;
 547
 548   /* Create a buffer with data set to 0 */
 549   buf_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
 550
 551   return gst_buffer_new_wrapped (g_malloc0 (buf_size), buf_size);
 552 }
 553
 554 static GstBuffer *
 555 gst_dtmf_src_generate_tone (GstDTMFSrcEvent * event, DTMF_KEY key,
 556     float duration, gint sample_rate)
 557 {
 558   GstBuffer *buffer;
 559   GstMapInfo map;
 560   gint16 *p;
 561   gint tone_size;
 562   double i = 0;
 563   double amplitude, f1, f2;
 564   double volume_factor;
 565   static GstAllocationParams params = { 0, 1, 0, 0, };
 566
 567   /* Create a buffer for the tone */
 568   tone_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
 569
 570   buffer = gst_buffer_new_allocate (NULL, tone_size, &params);
 571
 572   gst_buffer_map (buffer, &map, GST_MAP_READWRITE);
 573   p = (gint16 *) map.data;
 574
 575   volume_factor = pow (10, (-event->volume) / 20);
 576
 577   /*
 578    * For each sample point we calculate 'x' as the
 579    * the amplitude value.
 580    */
 581   for (i = 0; i < (tone_size / (SAMPLE_SIZE / 8)); i++) {
 582     /*
 583      * We add the fundamental frequencies together.
 584      */
 585     f1 = sin (2 * M_PI * key.low_frequency * (event->sample / sample_rate));
 586     f2 = sin (2 * M_PI * key.high_frequency * (event->sample / sample_rate));
 587
 588     amplitude = (f1 + f2) / 2;
 589
 590     /* Adjust the volume */
 591     amplitude *= volume_factor;
 592
 593     /* Make the [-1:1] interval into a [-32767:32767] interval */
 594     amplitude *= 32767;
 595
 596     /* Store it in the data buffer */
 597     *(p++) = (gint16) amplitude;
 598
 599     (event->sample)++;
 600   }
 601
 602   gst_buffer_unmap (buffer, &map);
 603
 604   return buffer;
 605 }
 606
 607
 608
 609 static GstBuffer *
 610 gst_dtmf_src_create_next_tone_packet (GstDTMFSrc * dtmfsrc,
 611     GstDTMFSrcEvent * event)
 612 {
 613   GstBuffer *buf = NULL;
 614   gboolean send_silence = FALSE;
 615
 616   GST_LOG_OBJECT (dtmfsrc, "Creating buffer for tone %s",
 617       DTMF_KEYS[event->event_number].event_name);
 618
 619   if (event->packet_count * dtmfsrc->interval < MIN_INTER_DIGIT_INTERVAL) {
 620     send_silence = TRUE;
 621   }
 622
 623   if (send_silence) {
 624     GST_LOG_OBJECT (dtmfsrc, "Generating silence");
 625     buf = gst_dtmf_src_generate_silence (dtmfsrc->interval,
 626         dtmfsrc->sample_rate);
 627   } else {
 628     GST_LOG_OBJECT (dtmfsrc, "Generating tone");
 629     buf = gst_dtmf_src_generate_tone (event, DTMF_KEYS[event->event_number],
 630         dtmfsrc->interval, dtmfsrc->sample_rate);
 631   }
 632   event->packet_count++;
 633
 634
 635   /* timestamp and duration of GstBuffer */
 636   GST_BUFFER_DURATION (buf) = dtmfsrc->interval * GST_MSECOND;
 637   GST_BUFFER_TIMESTAMP (buf) = dtmfsrc->timestamp;
 638
 639   GST_LOG_OBJECT (dtmfsrc, "Creating new buffer with event %u duration "
 640       " gst: %" GST_TIME_FORMAT " at %" GST_TIME_FORMAT,
 641       event->event_number, GST_TIME_ARGS (GST_BUFFER_DURATION (buf)),
 642       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
 643
 644   dtmfsrc->timestamp += GST_BUFFER_DURATION (buf);
 645
 646   return buf;
 647 }
 648
 649 static void
 650 gst_dtmf_src_post_message (GstDTMFSrc * dtmfsrc, const gchar * message_name,
 651     GstDTMFSrcEvent * event)
 652 {
 653   GstStructure *s = NULL;
 654
 655   switch (event->event_type) {
 656     case DTMF_EVENT_TYPE_START:
 657       s = gst_structure_new (message_name,
 658           "type", G_TYPE_INT, 1,
 659           "method", G_TYPE_INT, 2,
 660           "start", G_TYPE_BOOLEAN, TRUE,
 661           "number", G_TYPE_INT, event->event_number,
 662           "volume", G_TYPE_INT, event->volume, NULL);
 663       break;
 664     case DTMF_EVENT_TYPE_STOP:
 665       s = gst_structure_new (message_name,
 666           "type", G_TYPE_INT, 1, "method", G_TYPE_INT, 2,
 667           "start", G_TYPE_BOOLEAN, FALSE, NULL);
 668       break;
 669     case DTMF_EVENT_TYPE_PAUSE_TASK:
 670       return;
 671   }
 672
 673   if (s)
 674     gst_element_post_message (GST_ELEMENT (dtmfsrc),
 675         gst_message_new_element (GST_OBJECT (dtmfsrc), s));
 676 }
 677
 678 static GstFlowReturn
 679 gst_dtmf_src_create (GstBaseSrc * basesrc, guint64 offset,
 680     guint length, GstBuffer ** buffer)
 681 {
 682   GstBuffer *buf = NULL;
 683   GstDTMFSrcEvent *event;
 684   GstDTMFSrc *dtmfsrc;
 685   GstClock *clock;
 686   GstClockID *clockid;
 687   GstClockReturn clockret;
 688
 689   dtmfsrc = GST_DTMF_SRC (basesrc);
 690
 691   do {
 692
 693     if (dtmfsrc->last_event == NULL) {
 694       GST_DEBUG_OBJECT (dtmfsrc, "popping");
 695       event = g_async_queue_pop (dtmfsrc->event_queue);
 696
 697       GST_DEBUG_OBJECT (dtmfsrc, "popped %d", event->event_type);
 698
 699       switch (event->event_type) {
 700         case DTMF_EVENT_TYPE_STOP:
 701           GST_WARNING_OBJECT (dtmfsrc,
 702               "Received a DTMF stop event when already stopped");
 703           gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 704           break;
 705         case DTMF_EVENT_TYPE_START:
 706           gst_dtmf_prepare_timestamps (dtmfsrc);
 707
 708           event->packet_count = 0;
 709           dtmfsrc->last_event = event;
 710           event = NULL;
 711           gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed",
 712               dtmfsrc->last_event);
 713           break;
 714         case DTMF_EVENT_TYPE_PAUSE_TASK:
 715           /*
 716            * We're pushing it back because it has to stay in there until
 717            * the task is really paused (and the queue will then be flushed)
 718            */
 719           GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");
 720           GST_OBJECT_LOCK (dtmfsrc);
 721           if (dtmfsrc->paused) {
 722             g_async_queue_push (dtmfsrc->event_queue, event);
 723             goto paused_locked;
 724           }
 725           GST_OBJECT_UNLOCK (dtmfsrc);
 726           break;
 727       }
 728       if (event)
 729         g_slice_free (GstDTMFSrcEvent, event);
 730     } else if (dtmfsrc->last_event->packet_count * dtmfsrc->interval >=
 731         MIN_DUTY_CYCLE) {
 732       event = g_async_queue_try_pop (dtmfsrc->event_queue);
 733
 734       if (event != NULL) {
 735
 736         switch (event->event_type) {
 737           case DTMF_EVENT_TYPE_START:
 738             GST_WARNING_OBJECT (dtmfsrc,
 739                 "Received two consecutive DTMF start events");
 740             gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 741             break;
 742           case DTMF_EVENT_TYPE_STOP:
 743             g_slice_free (GstDTMFSrcEvent, dtmfsrc->last_event);
 744             dtmfsrc->last_event = NULL;
 745             gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed", event);
 746             break;
 747           case DTMF_EVENT_TYPE_PAUSE_TASK:
 748             /*
 749              * We're pushing it back because it has to stay in there until
 750              * the task is really paused (and the queue will then be flushed)
 751              */
 752             GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");
 753
 754             GST_OBJECT_LOCK (dtmfsrc);
 755             if (dtmfsrc->paused) {
 756               g_async_queue_push (dtmfsrc->event_queue, event);
 757               goto paused_locked;
 758             }
 759             GST_OBJECT_UNLOCK (dtmfsrc);
 760
 761             break;
 762         }
 763         g_slice_free (GstDTMFSrcEvent, event);
 764       }
 765     }
 766   } while (dtmfsrc->last_event == NULL);
 767
 768   GST_LOG_OBJECT (dtmfsrc, "end event check, now wait for the proper time");
 769
 770   clock = gst_element_get_clock (GST_ELEMENT (basesrc));
 771
 772   clockid = gst_clock_new_single_shot_id (clock, dtmfsrc->timestamp +
 773       gst_element_get_base_time (GST_ELEMENT (dtmfsrc)));
 774   gst_object_unref (clock);
 775
 776   GST_OBJECT_LOCK (dtmfsrc);
 777   if (!dtmfsrc->paused) {
 778     dtmfsrc->clockid = clockid;
 779     GST_OBJECT_UNLOCK (dtmfsrc);
 780
 781     clockret = gst_clock_id_wait (clockid, NULL);
 782
 783     GST_OBJECT_LOCK (dtmfsrc);
 784     if (dtmfsrc->paused)
 785       clockret = GST_CLOCK_UNSCHEDULED;
 786   } else {
 787     clockret = GST_CLOCK_UNSCHEDULED;
 788   }
 789   gst_clock_id_unref (clockid);
 790   dtmfsrc->clockid = NULL;
 791   GST_OBJECT_UNLOCK (dtmfsrc);
 792
 793   if (clockret == GST_CLOCK_UNSCHEDULED) {
 794     goto paused;
 795   }
 796
 797   buf = gst_dtmf_src_create_next_tone_packet (dtmfsrc, dtmfsrc->last_event);
 798
 799   GST_LOG_OBJECT (dtmfsrc, "Created buffer of size %" G_GSIZE_FORMAT,
 800       gst_buffer_get_size (buf));
 801   *buffer = buf;
 802
 803   return GST_FLOW_OK;
 804
 805 paused_locked:
 806   GST_OBJECT_UNLOCK (dtmfsrc);
 807
 808 paused:
 809
 810   if (dtmfsrc->last_event) {
 811     GST_DEBUG_OBJECT (dtmfsrc, "Stopping current event");
 812     /* Don't forget to release the stream lock */
 813     g_slice_free (GstDTMFSrcEvent, dtmfsrc->last_event);
 814     dtmfsrc->last_event = NULL;
 815   }
 816
 817   return GST_FLOW_FLUSHING;
 818
 819 }
 820
 821 static gboolean
 822 gst_dtmf_src_unlock (GstBaseSrc * src)
 823 {
 824   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
 825   GstDTMFSrcEvent *event = NULL;
 826
 827   GST_DEBUG_OBJECT (dtmfsrc, "Called unlock");
 828
 829   GST_OBJECT_LOCK (dtmfsrc);
 830   dtmfsrc->paused = TRUE;
 831   if (dtmfsrc->clockid) {
 832     gst_clock_id_unschedule (dtmfsrc->clockid);
 833   }
 834   GST_OBJECT_UNLOCK (dtmfsrc);
 835
 836   GST_DEBUG_OBJECT (dtmfsrc, "Pushing the PAUSE_TASK event on unlock request");
 837   event = g_slice_new0 (GstDTMFSrcEvent);
 838   event->event_type = DTMF_EVENT_TYPE_PAUSE_TASK;
 839   g_async_queue_push (dtmfsrc->event_queue, event);
 840
 841   return TRUE;
 842 }
 843
 844
 845 static gboolean
 846 gst_dtmf_src_unlock_stop (GstBaseSrc * src)
 847 {
 848   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
 849
 850   GST_DEBUG_OBJECT (dtmfsrc, "Unlock stopped");
 851
 852   GST_OBJECT_LOCK (dtmfsrc);
 853   dtmfsrc->paused = FALSE;
 854   GST_OBJECT_UNLOCK (dtmfsrc);
 855
 856   return TRUE;
 857 }
 858
 859
 860 static gboolean
 861 gst_dtmf_src_negotiate (GstBaseSrc * basesrc)
 862 {
 863   GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
 864   GstCaps *caps;
 865   GstStructure *s;
 866   gboolean ret;
 867
 868   caps = gst_pad_get_allowed_caps (GST_BASE_SRC_PAD (basesrc));
 869
 870   if (!caps)
 871     caps = gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD (basesrc));
 872
 873   if (gst_caps_is_empty (caps)) {
 874     gst_caps_unref (caps);
 875     return FALSE;
 876   }
 877
 878   caps = gst_caps_truncate (caps);
 879
 880   caps = gst_caps_make_writable (caps);
 881   s = gst_caps_get_structure (caps, 0);
 882
 883   gst_structure_fixate_field_nearest_int (s, "rate", DEFAULT_SAMPLE_RATE);
 884
 885   if (!gst_structure_get_int (s, "rate", &dtmfsrc->sample_rate)) {
 886     GST_ERROR_OBJECT (dtmfsrc, "Could not get rate");
 887     gst_caps_unref (caps);
 888     return FALSE;
 889   }
 890
 891   ret = gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps);
 892
 893   gst_caps_unref (caps);
 894
 895   return ret;
 896 }
 897
 898 static GstStateChangeReturn
 899 gst_dtmf_src_change_state (GstElement * element, GstStateChange transition)
 900 {
 901   GstDTMFSrc *dtmfsrc;
 902   GstStateChangeReturn result;
 903   gboolean no_preroll = FALSE;
 904   GstDTMFSrcEvent *event = NULL;
 905
 906   dtmfsrc = GST_DTMF_SRC (element);
 907
 908   switch (transition) {
 909     case GST_STATE_CHANGE_READY_TO_PAUSED:
 910       /* Flushing the event queue */
 911       event = g_async_queue_try_pop (dtmfsrc->event_queue);
 912
 913       while (event != NULL) {
 914         gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 915         g_slice_free (GstDTMFSrcEvent, event);
 916         event = g_async_queue_try_pop (dtmfsrc->event_queue);
 917       }
 918       dtmfsrc->last_event_was_start = FALSE;
 919       dtmfsrc->timestamp = 0;
 920       no_preroll = TRUE;
 921       break;
 922     default:
 923       break;
 924   }
 925
 926   if ((result =
 927           GST_ELEMENT_CLASS (gst_dtmf_src_parent_class)->change_state (element,
 928               transition)) == GST_STATE_CHANGE_FAILURE)
 929     goto failure;
 930
 931   switch (transition) {
 932     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 933       no_preroll = TRUE;
 934       break;
 935     case GST_STATE_CHANGE_PAUSED_TO_READY:
 936       GST_DEBUG_OBJECT (dtmfsrc, "Flushing event queue");
 937       /* Flushing the event queue */
 938       event = g_async_queue_try_pop (dtmfsrc->event_queue);
 939
 940       while (event != NULL) {
 941         gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
 942         g_slice_free (GstDTMFSrcEvent, event);
 943         event = g_async_queue_try_pop (dtmfsrc->event_queue);
 944       }
 945       dtmfsrc->last_event_was_start = FALSE;
 946
 947       break;
 948     default:
 949       break;
 950   }
 951
 952   if (no_preroll && result == GST_STATE_CHANGE_SUCCESS)
 953     result = GST_STATE_CHANGE_NO_PREROLL;
 954
 955   return result;
 956
 957   /* ERRORS */
 958 failure:
 959   {
 960     GST_ERROR_OBJECT (dtmfsrc, "parent failed state change");
 961     return result;
 962   }
 963 }
 964
 965 gboolean
 966 gst_dtmf_src_plugin_init (GstPlugin * plugin)
 967 {
 968   return gst_element_register (plugin, "dtmfsrc",
 969       GST_RANK_NONE, GST_TYPE_DTMF_SRC);
 970 }