gstdtmfsrc.c 27.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/* GStreamer DTMF source
 *
 * gstdtmfsrc.c:
 *
 * Copyright (C) <2007> Collabora.
 *   Contact: Youness Alaoui <youness.alaoui@collabora.co.uk>
 * Copyright (C) <2007> Nokia Corporation.
 *   Contact: Zeeshan Ali <zeeshan.ali@nokia.com>
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *               2000,2005 Wim Taymans <wim@fluendo.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
24
25
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
26
27
28
29
 */

/**
 * SECTION:element-dtmfsrc
Olivier Crête's avatar
Olivier Crête committed
30
 * @see_also: rtpdtmsrc, rtpdtmfmuxx
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 *
 * The DTMFSrc element generates DTMF (ITU-T Q.23 Specification) tone packets on request
 * from application. The application communicates the beginning and end of a
 * DTMF event using custom upstream gstreamer events. To report a DTMF event, an
 * application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a
 * structure of name "dtmf-event" with fields set according to the following
 * table:
 *
 * <informaltable>
 * <tgroup cols='4'>
 * <colspec colname='Name' />
 * <colspec colname='Type' />
 * <colspec colname='Possible values' />
 * <colspec colname='Purpose' />
 * <thead>
 * <row>
 * <entry>Name</entry>
 * <entry>GType</entry>
 * <entry>Possible values</entry>
 * <entry>Purpose</entry>
 * </row>
 * </thead>
 * <tbody>
 * <row>
 * <entry>type</entry>
 * <entry>G_TYPE_INT</entry>
 * <entry>0-1</entry>
 * <entry>The application uses this field to specify which of the two methods
 * specified in RFC 2833 to use. The value should be 0 for tones and 1 for
60
61
62
 * named events. Tones are specified by their frequencies and events are specied
 * by their number. This element can only take events as input. Do not confuse
 * with "method" which specified the output.
63
64
65
66
67
 * </entry>
 * </row>
 * <row>
 * <entry>number</entry>
 * <entry>G_TYPE_INT</entry>
Olivier Crête's avatar
Olivier Crête committed
68
 * <entry>0-15</entry>
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 * <entry>The event number.</entry>
 * </row>
 * <row>
 * <entry>volume</entry>
 * <entry>G_TYPE_INT</entry>
 * <entry>0-36</entry>
 * <entry>This field describes the power level of the tone, expressed in dBm0
 * after dropping the sign. Power levels range from 0 to -63 dBm0. The range of
 * valid DTMF is from 0 to -36 dBm0. Can be omitted if start is set to FALSE.
 * </entry>
 * </row>
 * <row>
 * <entry>start</entry>
 * <entry>G_TYPE_BOOLEAN</entry>
 * <entry>True or False</entry>
 * <entry>Whether the event is starting or ending.</entry>
 * </row>
 * <row>
 * <entry>method</entry>
 * <entry>G_TYPE_INT</entry>
89
90
91
 * <entry>2</entry>
 * <entry>The method used for sending event, this element will react if this
 * field is absent or 2.
92
93
94
95
96
97
 * </entry>
 * </row>
 * </tbody>
 * </tgroup>
 * </informaltable>
 *
98
 * For example, the following code informs the pipeline (and in turn, the
99
100
101
102
103
 * DTMFSrc element inside the pipeline) about the start of a DTMF named
 * event '1' of volume -25 dBm0:
 *
 * <programlisting>
 * structure = gst_structure_new ("dtmf-event",
104
 *                    "type", G_TYPE_INT, 1,
105
106
107
108
109
110
111
112
 *                    "number", G_TYPE_INT, 1,
 *                    "volume", G_TYPE_INT, 25,
 *                    "start", G_TYPE_BOOLEAN, TRUE, NULL);
 *
 * event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure);
 * gst_element_send_event (pipeline, event);
 * </programlisting>
 *
113
114
115
116
117
118
 * When a DTMF tone actually starts or stop, a "dtmf-event-processed"
 * element #GstMessage with the same fields as the "dtmf-event"
 * #GstEvent that was used to request the event. Also, if any event
 * has not been processed when the element goes from the PAUSED to the
 * READY state, then a "dtmf-event-dropped" message is posted on the
 * #GstBus in the order that they were received.
119
120
121
 */

#ifdef HAVE_CONFIG_H
122
#include "config.h"
123
124
125
126
127
128
#endif

#include <stdlib.h>
#include <string.h>
#include <math.h>

129
130
#include <glib.h>

131
#include "gstdtmfcommon.h"
132
133
134

#include "gstdtmfsrc.h"

Olivier Crête's avatar
Olivier Crête committed
135
136
#include <gst/audio/audio.h>

137
#define GST_TONE_DTMF_TYPE_EVENT 1
Olivier Crête's avatar
Olivier Crête committed
138
139
140
#define DEFAULT_PACKET_INTERVAL  50     /* ms */
#define MIN_PACKET_INTERVAL      10     /* ms */
#define MAX_PACKET_INTERVAL      50     /* ms */
141
#define DEFAULT_SAMPLE_RATE      8000
142
143
#define SAMPLE_SIZE              16
#define CHANNELS                 1
144
#define MIN_DUTY_CYCLE           (MIN_INTER_DIGIT_INTERVAL + MIN_PULSE_DURATION)
145
146


Olivier Crête's avatar
Olivier Crête committed
147
148
typedef struct st_dtmf_key
{
Benjamin Otte's avatar
Benjamin Otte committed
149
  const char *event_name;
Olivier Crête's avatar
Olivier Crête committed
150
151
152
  int event_encoding;
  float low_frequency;
  float high_frequency;
153
154
155
} DTMF_KEY;

static const DTMF_KEY DTMF_KEYS[] = {
Olivier Crête's avatar
Olivier Crête committed
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
  {"DTMF_KEY_EVENT_0", 0, 941, 1336},
  {"DTMF_KEY_EVENT_1", 1, 697, 1209},
  {"DTMF_KEY_EVENT_2", 2, 697, 1336},
  {"DTMF_KEY_EVENT_3", 3, 697, 1477},
  {"DTMF_KEY_EVENT_4", 4, 770, 1209},
  {"DTMF_KEY_EVENT_5", 5, 770, 1336},
  {"DTMF_KEY_EVENT_6", 6, 770, 1477},
  {"DTMF_KEY_EVENT_7", 7, 852, 1209},
  {"DTMF_KEY_EVENT_8", 8, 852, 1336},
  {"DTMF_KEY_EVENT_9", 9, 852, 1477},
  {"DTMF_KEY_EVENT_S", 10, 941, 1209},
  {"DTMF_KEY_EVENT_P", 11, 941, 1477},
  {"DTMF_KEY_EVENT_A", 12, 697, 1633},
  {"DTMF_KEY_EVENT_B", 13, 770, 1633},
  {"DTMF_KEY_EVENT_C", 14, 852, 1633},
  {"DTMF_KEY_EVENT_D", 15, 941, 1633},
172
173
174
175
};

#define MAX_DTMF_EVENTS 16

Olivier Crête's avatar
Olivier Crête committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
enum
{
  DTMF_KEY_EVENT_1 = 1,
  DTMF_KEY_EVENT_2 = 2,
  DTMF_KEY_EVENT_3 = 3,
  DTMF_KEY_EVENT_4 = 4,
  DTMF_KEY_EVENT_5 = 5,
  DTMF_KEY_EVENT_6 = 6,
  DTMF_KEY_EVENT_7 = 7,
  DTMF_KEY_EVENT_8 = 8,
  DTMF_KEY_EVENT_9 = 9,
  DTMF_KEY_EVENT_0 = 0,
  DTMF_KEY_EVENT_STAR = 10,
  DTMF_KEY_EVENT_POUND = 11,
  DTMF_KEY_EVENT_A = 12,
  DTMF_KEY_EVENT_B = 13,
  DTMF_KEY_EVENT_C = 14,
  DTMF_KEY_EVENT_D = 15,
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
};

GST_DEBUG_CATEGORY_STATIC (gst_dtmf_src_debug);
#define GST_CAT_DEFAULT gst_dtmf_src_debug

enum
{
  PROP_0,
  PROP_INTERVAL,
};

static GstStaticPadTemplate gst_dtmf_src_template =
GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
Olivier Crête's avatar
Olivier Crête committed
209
210
    GST_STATIC_CAPS ("audio/x-raw, "
        "format = (string) \"" GST_AUDIO_NE (S16) "\", "
211
212
        "rate = " GST_AUDIO_RATE_RANGE ", " "channels = (int) 1, "
        "layout = (string)interleaved")
213
214
    );

215
#define parent_class gst_dtmf_src_parent_class
Olivier Crête's avatar
Olivier Crête committed
216
G_DEFINE_TYPE (GstDTMFSrc, gst_dtmf_src, GST_TYPE_BASE_SRC);
217
218
219
220
221
222
223

static void gst_dtmf_src_finalize (GObject * object);

static void gst_dtmf_src_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec);
static void gst_dtmf_src_get_property (GObject * object, guint prop_id,
    GValue * value, GParamSpec * pspec);
Olivier Crête's avatar
Olivier Crête committed
224
static gboolean gst_dtmf_src_handle_event (GstBaseSrc * src, GstEvent * event);
225
static gboolean gst_dtmf_src_send_event (GstElement * src, GstEvent * event);
226
227
static GstStateChangeReturn gst_dtmf_src_change_state (GstElement * element,
    GstStateChange transition);
228
229
static GstFlowReturn gst_dtmf_src_create (GstBaseSrc * basesrc,
    guint64 offset, guint length, GstBuffer ** buffer);
Olivier Crête's avatar
Olivier Crête committed
230
static void gst_dtmf_src_add_start_event (GstDTMFSrc * dtmfsrc,
231
    gint event_number, gint event_volume);
Olivier Crête's avatar
Olivier Crête committed
232
static void gst_dtmf_src_add_stop_event (GstDTMFSrc * dtmfsrc);
233

Olivier Crête's avatar
Olivier Crête committed
234
static gboolean gst_dtmf_src_unlock (GstBaseSrc * src);
235

Olivier Crête's avatar
Olivier Crête committed
236
static gboolean gst_dtmf_src_unlock_stop (GstBaseSrc * src);
237
static gboolean gst_dtmf_src_negotiate (GstBaseSrc * basesrc);
238
static gboolean gst_dtmf_src_query (GstBaseSrc * basesrc, GstQuery * query);
239

240
241
242
243
244

static void
gst_dtmf_src_class_init (GstDTMFSrcClass * klass)
{
  GObjectClass *gobject_class;
245
  GstBaseSrcClass *gstbasesrc_class;
246
247
248
  GstElementClass *gstelement_class;

  gobject_class = G_OBJECT_CLASS (klass);
249
  gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
250
251
252
  gstelement_class = GST_ELEMENT_CLASS (klass);


Olivier Crête's avatar
Olivier Crête committed
253
254
  GST_DEBUG_CATEGORY_INIT (gst_dtmf_src_debug, "dtmfsrc", 0, "dtmfsrc element");

255
256
  gst_element_class_add_static_pad_template (gstelement_class,
      &gst_dtmf_src_template);
Olivier Crête's avatar
Olivier Crête committed
257

258
259
  gst_element_class_set_static_metadata (gstelement_class,
      "DTMF tone generator", "Source/Audio", "Generates DTMF tones",
Olivier Crête's avatar
Olivier Crête committed
260
261
262
      "Youness Alaoui <youness.alaoui@collabora.co.uk>");


263
264
265
  gobject_class->finalize = gst_dtmf_src_finalize;
  gobject_class->set_property = gst_dtmf_src_set_property;
  gobject_class->get_property = gst_dtmf_src_get_property;
266
267

  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_INTERVAL,
268
      g_param_spec_uint ("interval", "Interval between tone packets",
269
          "Interval in ms between two tone packets", MIN_PACKET_INTERVAL,
270
271
          MAX_PACKET_INTERVAL, DEFAULT_PACKET_INTERVAL,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
272
273
274

  gstelement_class->change_state =
      GST_DEBUG_FUNCPTR (gst_dtmf_src_change_state);
275
  gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_dtmf_src_send_event);
Olivier Crête's avatar
Olivier Crête committed
276
277
278
279
280
281
  gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_dtmf_src_unlock);
  gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_dtmf_src_unlock_stop);

  gstbasesrc_class->event = GST_DEBUG_FUNCPTR (gst_dtmf_src_handle_event);
  gstbasesrc_class->create = GST_DEBUG_FUNCPTR (gst_dtmf_src_create);
  gstbasesrc_class->negotiate = GST_DEBUG_FUNCPTR (gst_dtmf_src_negotiate);
282
  gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_dtmf_src_query);
283
284
}

285
286
287
288
289
290
static void
event_free (GstDTMFSrcEvent * event)
{
  if (event)
    g_slice_free (GstDTMFSrcEvent, event);
}
291

292
static void
Olivier Crête's avatar
Olivier Crête committed
293
gst_dtmf_src_init (GstDTMFSrc * dtmfsrc)
294
{
295
296
297
  /* we operate in time */
  gst_base_src_set_format (GST_BASE_SRC (dtmfsrc), GST_FORMAT_TIME);
  gst_base_src_set_live (GST_BASE_SRC (dtmfsrc), TRUE);
298
299
300

  dtmfsrc->interval = DEFAULT_PACKET_INTERVAL;

301
  dtmfsrc->event_queue = g_async_queue_new_full ((GDestroyNotify) event_free);
302
  dtmfsrc->last_event = NULL;
303

304
305
  dtmfsrc->sample_rate = DEFAULT_SAMPLE_RATE;

306
307
308
309
310
311
312
313
314
315
  GST_DEBUG_OBJECT (dtmfsrc, "init done");
}

static void
gst_dtmf_src_finalize (GObject * object)
{
  GstDTMFSrc *dtmfsrc;

  dtmfsrc = GST_DTMF_SRC (object);

316
317
318
319
320
  if (dtmfsrc->event_queue) {
    g_async_queue_unref (dtmfsrc->event_queue);
    dtmfsrc->event_queue = NULL;
  }

Olivier Crête's avatar
Olivier Crête committed
321
  G_OBJECT_CLASS (gst_dtmf_src_parent_class)->finalize (object);
322
323
324
}

static gboolean
325
gst_dtmf_src_handle_dtmf_event (GstDTMFSrc * dtmfsrc, GstEvent * event)
326
{
327
328
329
  const GstStructure *event_structure;
  GstStateChangeReturn sret;
  GstState state;
330
331
332
  gint event_type;
  gboolean start;
  gint method;
333
  GstClockTime last_stop;
334
335
336
  gint event_number;
  gint event_volume;
  gboolean correct_order;
337

338
339
340
341
342
343
344
345
  sret = gst_element_get_state (GST_ELEMENT (dtmfsrc), &state, NULL, 0);
  if (sret != GST_STATE_CHANGE_SUCCESS || state != GST_STATE_PLAYING) {
    GST_DEBUG_OBJECT (dtmfsrc, "dtmf-event, but not in PLAYING state");
    goto failure;
  }

  event_structure = gst_event_get_structure (event);

346
347
348
349
350
351
352
353
354
355
356
  if (!gst_structure_get_int (event_structure, "type", &event_type) ||
      !gst_structure_get_boolean (event_structure, "start", &start) ||
      (start == TRUE && event_type != GST_TONE_DTMF_TYPE_EVENT))
    goto failure;

  if (gst_structure_get_int (event_structure, "method", &method)) {
    if (method != 2) {
      goto failure;
    }
  }

357
358
359
360
361
  if (start)
    if (!gst_structure_get_int (event_structure, "number", &event_number) ||
        !gst_structure_get_int (event_structure, "volume", &event_volume))
      goto failure;

362
363
364
365
366
367

  GST_OBJECT_LOCK (dtmfsrc);
  if (gst_structure_get_clock_time (event_structure, "last-stop", &last_stop))
    dtmfsrc->last_stop = last_stop;
  else
    dtmfsrc->last_stop = GST_CLOCK_TIME_NONE;
368
369
  correct_order = (start != dtmfsrc->last_event_was_start);
  dtmfsrc->last_event_was_start = start;
370
371
  GST_OBJECT_UNLOCK (dtmfsrc);

372
373
  if (!correct_order)
    goto failure;
374

375
  if (start) {
376
    GST_DEBUG_OBJECT (dtmfsrc, "Received start event %d with volume %d",
Olivier Crête's avatar
Olivier Crête committed
377
        event_number, event_volume);
378
    gst_dtmf_src_add_start_event (dtmfsrc, event_number, event_volume);
379
380
381
382
  }

  else {
    GST_DEBUG_OBJECT (dtmfsrc, "Received stop event");
383
    gst_dtmf_src_add_stop_event (dtmfsrc);
384
385
386
387
388
389
390
391
  }

  return TRUE;
failure:
  return FALSE;
}

static gboolean
392
gst_dtmf_src_handle_event (GstBaseSrc * src, GstEvent * event)
393
394
395
{
  GstDTMFSrc *dtmfsrc;
  gboolean result = FALSE;
396
397

  dtmfsrc = GST_DTMF_SRC (src);
398

399
400
401
402
403
404
405
406
407
408
409
410
411
  GST_LOG_OBJECT (dtmfsrc, "Received an %s event on the src pad",
      GST_EVENT_TYPE_NAME (event));

  switch (GST_EVENT_TYPE (event)) {
    case GST_EVENT_CUSTOM_UPSTREAM:
      if (gst_event_has_name (event, "dtmf-event")) {
        result = gst_dtmf_src_handle_dtmf_event (dtmfsrc, event);
        break;
      }
      /* fall through */
    default:
      result = GST_BASE_SRC_CLASS (parent_class)->event (src, event);
      break;
412
413
414
415
416
  }

  return result;
}

417
418
419
420

static gboolean
gst_dtmf_src_send_event (GstElement * element, GstEvent * event)
{
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
  GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (element);
  gboolean ret;

  GST_LOG_OBJECT (dtmfsrc, "Received an %s event via send_event",
      GST_EVENT_TYPE_NAME (event));

  switch (GST_EVENT_TYPE (event)) {
    case GST_EVENT_CUSTOM_BOTH:
    case GST_EVENT_CUSTOM_BOTH_OOB:
    case GST_EVENT_CUSTOM_UPSTREAM:
    case GST_EVENT_CUSTOM_DOWNSTREAM:
    case GST_EVENT_CUSTOM_DOWNSTREAM_OOB:
      if (gst_event_has_name (event, "dtmf-event")) {
        ret = gst_dtmf_src_handle_dtmf_event (dtmfsrc, event);
        break;
      }
      /* fall through */
    default:
      ret = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
      break;
  }
442

443
  return ret;
444
445
}

446
447
448
449
450
451
452
453
454
455
static void
gst_dtmf_src_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec)
{
  GstDTMFSrc *dtmfsrc;

  dtmfsrc = GST_DTMF_SRC (object);

  switch (prop_id) {
    case PROP_INTERVAL:
456
      dtmfsrc->interval = g_value_get_uint (value);
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
gst_dtmf_src_get_property (GObject * object, guint prop_id, GValue * value,
    GParamSpec * pspec)
{
  GstDTMFSrc *dtmfsrc;

  dtmfsrc = GST_DTMF_SRC (object);

  switch (prop_id) {
    case PROP_INTERVAL:
      g_value_set_uint (value, dtmfsrc->interval);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
Olivier Crête's avatar
Olivier Crête committed
483
gst_dtmf_prepare_timestamps (GstDTMFSrc * dtmfsrc)
484
{
485
486
  GstClockTime last_stop;
  GstClockTime timestamp;
487

488
489
490
491
492
493
  GST_OBJECT_LOCK (dtmfsrc);
  last_stop = dtmfsrc->last_stop;
  GST_OBJECT_UNLOCK (dtmfsrc);

  if (GST_CLOCK_TIME_IS_VALID (last_stop)) {
    timestamp = last_stop;
494
  } else {
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
    GstClock *clock;

    /* If there is no valid start time, lets use now as the start time */

    clock = gst_element_get_clock (GST_ELEMENT (dtmfsrc));
    if (clock != NULL) {
      timestamp = gst_clock_get_time (clock)
          - gst_element_get_base_time (GST_ELEMENT (dtmfsrc));
      gst_object_unref (clock);
    } else {
      gchar *dtmf_name = gst_element_get_name (dtmfsrc);
      GST_ERROR_OBJECT (dtmfsrc, "No clock set for element %s", dtmf_name);
      dtmfsrc->timestamp = GST_CLOCK_TIME_NONE;
      g_free (dtmf_name);
      return;
    }
511
  }
512
513
514
515

  /* Make sure the timestamp always goes forward */
  if (timestamp > dtmfsrc->timestamp)
    dtmfsrc->timestamp = timestamp;
516
517
518
}

static void
Olivier Crête's avatar
Olivier Crête committed
519
gst_dtmf_src_add_start_event (GstDTMFSrc * dtmfsrc, gint event_number,
520
521
522
    gint event_volume)
{

523
  GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
524
525
526
527
528
529
530
531
532
  event->event_type = DTMF_EVENT_TYPE_START;
  event->sample = 0;
  event->event_number = CLAMP (event_number, MIN_EVENT, MAX_EVENT);
  event->volume = CLAMP (event_volume, MIN_VOLUME, MAX_VOLUME);

  g_async_queue_push (dtmfsrc->event_queue, event);
}

static void
Olivier Crête's avatar
Olivier Crête committed
533
gst_dtmf_src_add_stop_event (GstDTMFSrc * dtmfsrc)
534
535
{

536
  GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
537
538
539
540
541
542
543
544
  event->event_type = DTMF_EVENT_TYPE_STOP;
  event->sample = 0;
  event->event_number = 0;
  event->volume = 0;

  g_async_queue_push (dtmfsrc->event_queue, event);
}

Olivier Crête's avatar
Olivier Crête committed
545
546
static GstBuffer *
gst_dtmf_src_generate_silence (float duration, gint sample_rate)
547
548
549
550
{
  gint buf_size;

  /* Create a buffer with data set to 0 */
Olivier Crête's avatar
Olivier Crête committed
551
  buf_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
552

Olivier Crête's avatar
Olivier Crête committed
553
  return gst_buffer_new_wrapped (g_malloc0 (buf_size), buf_size);
554
555
}

Olivier Crête's avatar
Olivier Crête committed
556
static GstBuffer *
Olivier Crête's avatar
Olivier Crête committed
557
gst_dtmf_src_generate_tone (GstDTMFSrcEvent * event, DTMF_KEY key,
Olivier Crête's avatar
Olivier Crête committed
558
    float duration, gint sample_rate)
559
{
Olivier Crête's avatar
Olivier Crête committed
560
  GstBuffer *buffer;
Wim Taymans's avatar
Wim Taymans committed
561
  GstMapInfo map;
562
563
564
565
  gint16 *p;
  gint tone_size;
  double i = 0;
  double amplitude, f1, f2;
566
  double volume_factor;
567
  static GstAllocationParams params = { 0, 1, 0, 0, };
568
569

  /* Create a buffer for the tone */
Olivier Crête's avatar
Olivier Crête committed
570
  tone_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
571

Wim Taymans's avatar
Wim Taymans committed
572
  buffer = gst_buffer_new_allocate (NULL, tone_size, &params);
Olivier Crête's avatar
Olivier Crête committed
573

Wim Taymans's avatar
Wim Taymans committed
574
575
  gst_buffer_map (buffer, &map, GST_MAP_READWRITE);
  p = (gint16 *) map.data;
576

577
578
  volume_factor = pow (10, (-event->volume) / 20);

579
580
581
582
  /*
   * For each sample point we calculate 'x' as the
   * the amplitude value.
   */
Olivier Crête's avatar
Olivier Crête committed
583
  for (i = 0; i < (tone_size / (SAMPLE_SIZE / 8)); i++) {
584
585
586
    /*
     * We add the fundamental frequencies together.
     */
Olivier Crête's avatar
Olivier Crête committed
587
588
    f1 = sin (2 * M_PI * key.low_frequency * (event->sample / sample_rate));
    f2 = sin (2 * M_PI * key.high_frequency * (event->sample / sample_rate));
589
590
591

    amplitude = (f1 + f2) / 2;

592
593
594
    /* Adjust the volume */
    amplitude *= volume_factor;

595
596
597
598
599
600
    /* Make the [-1:1] interval into a [-32767:32767] interval */
    amplitude *= 32767;

    /* Store it in the data buffer */
    *(p++) = (gint16) amplitude;

601
    (event->sample)++;
602
  }
Olivier Crête's avatar
Olivier Crête committed
603

Wim Taymans's avatar
Wim Taymans committed
604
  gst_buffer_unmap (buffer, &map);
Olivier Crête's avatar
Olivier Crête committed
605
606

  return buffer;
607
608
609
610
611
}



static GstBuffer *
Olivier Crête's avatar
Olivier Crête committed
612
613
gst_dtmf_src_create_next_tone_packet (GstDTMFSrc * dtmfsrc,
    GstDTMFSrcEvent * event)
614
615
{
  GstBuffer *buf = NULL;
616
  gboolean send_silence = FALSE;
617

618
  GST_LOG_OBJECT (dtmfsrc, "Creating buffer for tone %s",
619
      DTMF_KEYS[event->event_number].event_name);
620

621
622
623
624
625
  if (event->packet_count * dtmfsrc->interval < MIN_INTER_DIGIT_INTERVAL) {
    send_silence = TRUE;
  }

  if (send_silence) {
626
    GST_LOG_OBJECT (dtmfsrc, "Generating silence");
Olivier Crête's avatar
Olivier Crête committed
627
    buf = gst_dtmf_src_generate_silence (dtmfsrc->interval,
628
        dtmfsrc->sample_rate);
629
  } else {
630
    GST_LOG_OBJECT (dtmfsrc, "Generating tone");
Olivier Crête's avatar
Olivier Crête committed
631
632
    buf = gst_dtmf_src_generate_tone (event, DTMF_KEYS[event->event_number],
        dtmfsrc->interval, dtmfsrc->sample_rate);
633
634
  }
  event->packet_count++;
635
636
637


  /* timestamp and duration of GstBuffer */
638
  GST_BUFFER_DURATION (buf) = dtmfsrc->interval * GST_MSECOND;
639
  GST_BUFFER_TIMESTAMP (buf) = dtmfsrc->timestamp;
Olivier Crête's avatar
Olivier Crête committed
640
641
642
643
644
645

  GST_LOG_OBJECT (dtmfsrc, "Creating new buffer with event %u duration "
      " gst: %" GST_TIME_FORMAT " at %" GST_TIME_FORMAT,
      event->event_number, GST_TIME_ARGS (GST_BUFFER_DURATION (buf)),
      GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));

646
  dtmfsrc->timestamp += GST_BUFFER_DURATION (buf);
647
648
649
650

  return buf;
}

651
652
653
654
static void
gst_dtmf_src_post_message (GstDTMFSrc * dtmfsrc, const gchar * message_name,
    GstDTMFSrcEvent * event)
{
655
  GstStructure *s = NULL;
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674

  switch (event->event_type) {
    case DTMF_EVENT_TYPE_START:
      s = gst_structure_new (message_name,
          "type", G_TYPE_INT, 1,
          "method", G_TYPE_INT, 2,
          "start", G_TYPE_BOOLEAN, TRUE,
          "number", G_TYPE_INT, event->event_number,
          "volume", G_TYPE_INT, event->volume, NULL);
      break;
    case DTMF_EVENT_TYPE_STOP:
      s = gst_structure_new (message_name,
          "type", G_TYPE_INT, 1, "method", G_TYPE_INT, 2,
          "start", G_TYPE_BOOLEAN, FALSE, NULL);
      break;
    case DTMF_EVENT_TYPE_PAUSE_TASK:
      return;
  }

675
676
677
  if (s)
    gst_element_post_message (GST_ELEMENT (dtmfsrc),
        gst_message_new_element (GST_OBJECT (dtmfsrc), s));
678
679
}

680
681
682
static GstFlowReturn
gst_dtmf_src_create (GstBaseSrc * basesrc, guint64 offset,
    guint length, GstBuffer ** buffer)
683
684
{
  GstBuffer *buf = NULL;
685
  GstDTMFSrcEvent *event;
Olivier Crête's avatar
Olivier Crête committed
686
  GstDTMFSrc *dtmfsrc;
687
688
689
  GstClock *clock;
  GstClockID *clockid;
  GstClockReturn clockret;
690
691

  dtmfsrc = GST_DTMF_SRC (basesrc);
692

693
694
695
696
697
698
699
  do {

    if (dtmfsrc->last_event == NULL) {
      GST_DEBUG_OBJECT (dtmfsrc, "popping");
      event = g_async_queue_pop (dtmfsrc->event_queue);

      GST_DEBUG_OBJECT (dtmfsrc, "popped %d", event->event_type);
700

701
702
      switch (event->event_type) {
        case DTMF_EVENT_TYPE_STOP:
703
          GST_WARNING_OBJECT (dtmfsrc,
704
              "Received a DTMF stop event when already stopped");
705
          gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
706
707
708
709
710
711
          break;
        case DTMF_EVENT_TYPE_START:
          gst_dtmf_prepare_timestamps (dtmfsrc);

          event->packet_count = 0;
          dtmfsrc->last_event = event;
712
          event = NULL;
713
714
          gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed",
              dtmfsrc->last_event);
715
716
          break;
        case DTMF_EVENT_TYPE_PAUSE_TASK:
717
718
719
720
721
          /*
           * We're pushing it back because it has to stay in there until
           * the task is really paused (and the queue will then be flushed)
           */
          GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");
722
          GST_OBJECT_LOCK (dtmfsrc);
723
724
          if (dtmfsrc->paused) {
            g_async_queue_push (dtmfsrc->event_queue, event);
725
            goto paused_locked;
726
          }
727
728
729
          GST_OBJECT_UNLOCK (dtmfsrc);
          break;
      }
730
      if (event)
731
        g_slice_free (GstDTMFSrcEvent, event);
Olivier Crête's avatar
Olivier Crête committed
732
    } else if (dtmfsrc->last_event->packet_count * dtmfsrc->interval >=
733
734
735
736
737
738
739
740
741
        MIN_DUTY_CYCLE) {
      event = g_async_queue_try_pop (dtmfsrc->event_queue);

      if (event != NULL) {

        switch (event->event_type) {
          case DTMF_EVENT_TYPE_START:
            GST_WARNING_OBJECT (dtmfsrc,
                "Received two consecutive DTMF start events");
742
            gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
743
744
            break;
          case DTMF_EVENT_TYPE_STOP:
745
            g_slice_free (GstDTMFSrcEvent, dtmfsrc->last_event);
746
            dtmfsrc->last_event = NULL;
747
            gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed", event);
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
            break;
          case DTMF_EVENT_TYPE_PAUSE_TASK:
            /*
             * We're pushing it back because it has to stay in there until
             * the task is really paused (and the queue will then be flushed)
             */
            GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");

            GST_OBJECT_LOCK (dtmfsrc);
            if (dtmfsrc->paused) {
              g_async_queue_push (dtmfsrc->event_queue, event);
              goto paused_locked;
            }
            GST_OBJECT_UNLOCK (dtmfsrc);

            break;
764
        }
765
        g_slice_free (GstDTMFSrcEvent, event);
766
767
      }
    }
768
769
  } while (dtmfsrc->last_event == NULL);

770
  GST_LOG_OBJECT (dtmfsrc, "end event check, now wait for the proper time");
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787

  clock = gst_element_get_clock (GST_ELEMENT (basesrc));

  clockid = gst_clock_new_single_shot_id (clock, dtmfsrc->timestamp +
      gst_element_get_base_time (GST_ELEMENT (dtmfsrc)));
  gst_object_unref (clock);

  GST_OBJECT_LOCK (dtmfsrc);
  if (!dtmfsrc->paused) {
    dtmfsrc->clockid = clockid;
    GST_OBJECT_UNLOCK (dtmfsrc);

    clockret = gst_clock_id_wait (clockid, NULL);

    GST_OBJECT_LOCK (dtmfsrc);
    if (dtmfsrc->paused)
      clockret = GST_CLOCK_UNSCHEDULED;
Olivier Crête's avatar
Olivier Crête committed
788
  } else {
789
    clockret = GST_CLOCK_UNSCHEDULED;
790
  }
791
792
793
  gst_clock_id_unref (clockid);
  dtmfsrc->clockid = NULL;
  GST_OBJECT_UNLOCK (dtmfsrc);
794

795
796
797
  if (clockret == GST_CLOCK_UNSCHEDULED) {
    goto paused;
  }
798

799
  buf = gst_dtmf_src_create_next_tone_packet (dtmfsrc, dtmfsrc->last_event);
800

Matej's avatar
Matej committed
801
  GST_LOG_OBJECT (dtmfsrc, "Created buffer of size %" G_GSIZE_FORMAT,
Olivier Crête's avatar
Olivier Crête committed
802
      gst_buffer_get_size (buf));
803
804
805
806
  *buffer = buf;

  return GST_FLOW_OK;

Olivier Crête's avatar
Olivier Crête committed
807
paused_locked:
808
809
  GST_OBJECT_UNLOCK (dtmfsrc);

Olivier Crête's avatar
Olivier Crête committed
810
paused:
811
812
813
814

  if (dtmfsrc->last_event) {
    GST_DEBUG_OBJECT (dtmfsrc, "Stopping current event");
    /* Don't forget to release the stream lock */
815
    g_slice_free (GstDTMFSrcEvent, dtmfsrc->last_event);
816
    dtmfsrc->last_event = NULL;
817
  }
818

819
  return GST_FLOW_FLUSHING;
820

821
822
}

823
static gboolean
Olivier Crête's avatar
Olivier Crête committed
824
825
gst_dtmf_src_unlock (GstBaseSrc * src)
{
826
827
828
  GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
  GstDTMFSrcEvent *event = NULL;

829
830
831
832
833
834
835
836
837
838
  GST_DEBUG_OBJECT (dtmfsrc, "Called unlock");

  GST_OBJECT_LOCK (dtmfsrc);
  dtmfsrc->paused = TRUE;
  if (dtmfsrc->clockid) {
    gst_clock_id_unschedule (dtmfsrc->clockid);
  }
  GST_OBJECT_UNLOCK (dtmfsrc);

  GST_DEBUG_OBJECT (dtmfsrc, "Pushing the PAUSE_TASK event on unlock request");
839
  event = g_slice_new0 (GstDTMFSrcEvent);
840
841
842
843
844
845
  event->event_type = DTMF_EVENT_TYPE_PAUSE_TASK;
  g_async_queue_push (dtmfsrc->event_queue, event);

  return TRUE;
}

846
847

static gboolean
Olivier Crête's avatar
Olivier Crête committed
848
849
gst_dtmf_src_unlock_stop (GstBaseSrc * src)
{
850
851
852
853
854
855
856
857
858
859
860
  GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);

  GST_DEBUG_OBJECT (dtmfsrc, "Unlock stopped");

  GST_OBJECT_LOCK (dtmfsrc);
  dtmfsrc->paused = FALSE;
  GST_OBJECT_UNLOCK (dtmfsrc);

  return TRUE;
}

861

862
863
864
865
static gboolean
gst_dtmf_src_negotiate (GstBaseSrc * basesrc)
{
  GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
866
867
868
  GstCaps *caps;
  GstStructure *s;
  gboolean ret;
869

870
  caps = gst_pad_get_allowed_caps (GST_BASE_SRC_PAD (basesrc));
871

872
  if (!caps)
Wim Taymans's avatar
Wim Taymans committed
873
    caps = gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD (basesrc));
874

Wim Taymans's avatar
Wim Taymans committed
875
876
  if (gst_caps_is_empty (caps)) {
    gst_caps_unref (caps);
Olivier Crête's avatar
Olivier Crête committed
877
    return FALSE;
Wim Taymans's avatar
Wim Taymans committed
878
879
880
  }

  caps = gst_caps_truncate (caps);
Olivier Crête's avatar
Olivier Crête committed
881

Wim Taymans's avatar
Wim Taymans committed
882
  caps = gst_caps_make_writable (caps);
883
  s = gst_caps_get_structure (caps, 0);
884

885
  gst_structure_fixate_field_nearest_int (s, "rate", DEFAULT_SAMPLE_RATE);
886

887
888
889
890
  if (!gst_structure_get_int (s, "rate", &dtmfsrc->sample_rate)) {
    GST_ERROR_OBJECT (dtmfsrc, "Could not get rate");
    gst_caps_unref (caps);
    return FALSE;
891
892
  }

893
  ret = gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps);
894

895
  gst_caps_unref (caps);
896
897
898
899

  return ret;
}

900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
static gboolean
gst_dtmf_src_query (GstBaseSrc * basesrc, GstQuery * query)
{
  GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
  gboolean res = FALSE;

  switch (GST_QUERY_TYPE (query)) {
    case GST_QUERY_LATENCY:
    {
      GstClockTime latency;

      latency = dtmfsrc->interval * GST_MSECOND;
      gst_query_set_latency (query, gst_base_src_is_live (basesrc), latency,
          GST_CLOCK_TIME_NONE);
      GST_DEBUG_OBJECT (dtmfsrc, "Reporting latency of %" GST_TIME_FORMAT,
          GST_TIME_ARGS (latency));
      res = TRUE;
    }
      break;
    default:
      res = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
      break;
  }

  return res;
}

927
928
929
930
931
932
static GstStateChangeReturn
gst_dtmf_src_change_state (GstElement * element, GstStateChange transition)
{
  GstDTMFSrc *dtmfsrc;
  GstStateChangeReturn result;
  gboolean no_preroll = FALSE;
933
  GstDTMFSrcEvent *event = NULL;
934
935
936

  dtmfsrc = GST_DTMF_SRC (element);

937
938
939
940
941
942
  switch (transition) {
    case GST_STATE_CHANGE_READY_TO_PAUSED:
      /* Flushing the event queue */
      event = g_async_queue_try_pop (dtmfsrc->event_queue);

      while (event != NULL) {
943
        gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
944
        g_slice_free (GstDTMFSrcEvent, event);
945
946
        event = g_async_queue_try_pop (dtmfsrc->event_queue);
      }
947
      dtmfsrc->last_event_was_start = FALSE;
948
      dtmfsrc->timestamp = 0;
949
      no_preroll = TRUE;
950
951
952
953
954
      break;
    default:
      break;
  }

955
  if ((result =
Olivier Crête's avatar
Olivier Crête committed
956
          GST_ELEMENT_CLASS (gst_dtmf_src_parent_class)->change_state (element,
957
958
959
960
              transition)) == GST_STATE_CHANGE_FAILURE)
    goto failure;

  switch (transition) {
961
962
963
    case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
      no_preroll = TRUE;
      break;
964
    case GST_STATE_CHANGE_PAUSED_TO_READY:
965
      GST_DEBUG_OBJECT (dtmfsrc, "Flushing event queue");
966
967
      /* Flushing the event queue */
      event = g_async_queue_try_pop (dtmfsrc->event_queue);
968

969
      while (event != NULL) {
970
        gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-dropped", event);
971
        g_slice_free (GstDTMFSrcEvent, event);
972
        event = g_async_queue_try_pop (dtmfsrc->event_queue);
973
      }
974
      dtmfsrc->last_event_was_start = FALSE;
975

976
      break;
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
    default:
      break;
  }

  if (no_preroll && result == GST_STATE_CHANGE_SUCCESS)
    result = GST_STATE_CHANGE_NO_PREROLL;

  return result;

  /* ERRORS */
failure:
  {
    GST_ERROR_OBJECT (dtmfsrc, "parent failed state change");
    return result;
  }
}

gboolean
gst_dtmf_src_plugin_init (GstPlugin * plugin)
{
  return gst_element_register (plugin, "dtmfsrc",
      GST_RANK_NONE, GST_TYPE_DTMF_SRC);
}