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