1 /* GStreamer DTMF source
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>
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.
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.
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.
29 * SECTION:element-dtmfsrc
30 * @see_also: rtpdtmsrc, rtpdtmfmuxx
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
41 * <colspec colname='Name' />
42 * <colspec colname='Type' />
43 * <colspec colname='Possible values' />
44 * <colspec colname='Purpose' />
48 * <entry>GType</entry>
49 * <entry>Possible values</entry>
50 * <entry>Purpose</entry>
56 * <entry>G_TYPE_INT</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.
66 * <entry>number</entry>
67 * <entry>G_TYPE_INT</entry>
69 * <entry>The event number.</entry>
72 * <entry>volume</entry>
73 * <entry>G_TYPE_INT</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.
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>
87 * <entry>method</entry>
88 * <entry>G_TYPE_INT</entry>
90 * <entry>The method used for sending event, this element will react if this
91 * field is absent or 2.
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:
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);
109 * event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure);
110 * gst_element_send_event (pipeline, event);
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.
131 #include "gstdtmfcommon.h"
133 #include "gstdtmfsrc.h"
135 #include <gst/audio/audio.h>
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
144 #define MIN_DUTY_CYCLE (MIN_INTER_DIGIT_INTERVAL + MIN_PULSE_DURATION)
147 typedef struct st_dtmf_key
149 const char *event_name;
152 float high_frequency;
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},
174 #define MAX_DTMF_EVENTS 16
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,
196 GST_DEBUG_CATEGORY_STATIC (gst_dtmf_src_debug);
197 #define GST_CAT_DEFAULT gst_dtmf_src_debug
205 static GstStaticPadTemplate gst_dtmf_src_template =
206 GST_STATIC_PAD_TEMPLATE ("src",
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")
215 #define parent_class gst_dtmf_src_parent_class
216 G_DEFINE_TYPE (GstDTMFSrc, gst_dtmf_src, GST_TYPE_BASE_SRC);
218 static void gst_dtmf_src_finalize (GObject * object);
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);
234 static gboolean gst_dtmf_src_unlock (GstBaseSrc * src);
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);
242 gst_dtmf_src_class_init (GstDTMFSrcClass * klass)
244 GObjectClass *gobject_class;
245 GstBaseSrcClass *gstbasesrc_class;
246 GstElementClass *gstelement_class;
248 gobject_class = G_OBJECT_CLASS (klass);
249 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
250 gstelement_class = GST_ELEMENT_CLASS (klass);
253 GST_DEBUG_CATEGORY_INIT (gst_dtmf_src_debug, "dtmfsrc", 0, "dtmfsrc element");
255 gst_element_class_add_static_pad_template (gstelement_class,
256 &gst_dtmf_src_template);
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>");
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;
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));
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);
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);
286 event_free (GstDTMFSrcEvent * event)
289 g_slice_free (GstDTMFSrcEvent, event);
293 gst_dtmf_src_init (GstDTMFSrc * dtmfsrc)
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);
299 dtmfsrc->interval = DEFAULT_PACKET_INTERVAL;
301 dtmfsrc->event_queue = g_async_queue_new_full ((GDestroyNotify) event_free);
302 dtmfsrc->last_event = NULL;
304 dtmfsrc->sample_rate = DEFAULT_SAMPLE_RATE;
306 GST_DEBUG_OBJECT (dtmfsrc, "init done");
310 gst_dtmf_src_finalize (GObject * object)
314 dtmfsrc = GST_DTMF_SRC (object);
316 if (dtmfsrc->event_queue) {
317 g_async_queue_unref (dtmfsrc->event_queue);
318 dtmfsrc->event_queue = NULL;
321 G_OBJECT_CLASS (gst_dtmf_src_parent_class)->finalize (object);
325 gst_dtmf_src_handle_dtmf_event (GstDTMFSrc * dtmfsrc, GstEvent * event)
327 const GstStructure *event_structure;
328 GstStateChangeReturn sret;
333 GstClockTime last_stop;
336 gboolean correct_order;
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");
344 event_structure = gst_event_get_structure (event);
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))
351 if (gst_structure_get_int (event_structure, "method", &method)) {
358 if (!gst_structure_get_int (event_structure, "number", &event_number) ||
359 !gst_structure_get_int (event_structure, "volume", &event_volume))
363 GST_OBJECT_LOCK (dtmfsrc);
364 if (gst_structure_get_clock_time (event_structure, "last-stop", &last_stop))
365 dtmfsrc->last_stop = last_stop;
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);
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);
382 GST_DEBUG_OBJECT (dtmfsrc, "Received stop event");
383 gst_dtmf_src_add_stop_event (dtmfsrc);
392 gst_dtmf_src_handle_event (GstBaseSrc * src, GstEvent * event)
395 gboolean result = FALSE;
397 dtmfsrc = GST_DTMF_SRC (src);
399 GST_LOG_OBJECT (dtmfsrc, "Received an %s event on the src pad",
400 GST_EVENT_TYPE_NAME (event));
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);
410 result = GST_BASE_SRC_CLASS (parent_class)->event (src, event);
419 gst_dtmf_src_send_event (GstElement * element, GstEvent * event)
421 GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (element);
424 GST_LOG_OBJECT (dtmfsrc, "Received an %s event via send_event",
425 GST_EVENT_TYPE_NAME (event));
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);
439 ret = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
447 gst_dtmf_src_set_property (GObject * object, guint prop_id,
448 const GValue * value, GParamSpec * pspec)
452 dtmfsrc = GST_DTMF_SRC (object);
456 dtmfsrc->interval = g_value_get_uint (value);
459 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
465 gst_dtmf_src_get_property (GObject * object, guint prop_id, GValue * value,
470 dtmfsrc = GST_DTMF_SRC (object);
474 g_value_set_uint (value, dtmfsrc->interval);
477 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
483 gst_dtmf_prepare_timestamps (GstDTMFSrc * dtmfsrc)
485 GstClockTime last_stop;
486 GstClockTime timestamp;
488 GST_OBJECT_LOCK (dtmfsrc);
489 last_stop = dtmfsrc->last_stop;
490 GST_OBJECT_UNLOCK (dtmfsrc);
492 if (GST_CLOCK_TIME_IS_VALID (last_stop)) {
493 timestamp = last_stop;
497 /* If there is no valid start time, lets use now as the start time */
499 clock = gst_element_get_clock (GST_ELEMENT (dtmfsrc));
501 timestamp = gst_clock_get_time (clock)
502 - gst_element_get_base_time (GST_ELEMENT (dtmfsrc));
503 gst_object_unref (clock);
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;
513 /* Make sure the timestamp always goes forward */
514 if (timestamp > dtmfsrc->timestamp)
515 dtmfsrc->timestamp = timestamp;
519 gst_dtmf_src_add_start_event (GstDTMFSrc * dtmfsrc, gint event_number,
523 GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
524 event->event_type = DTMF_EVENT_TYPE_START;
526 event->event_number = CLAMP (event_number, MIN_EVENT, MAX_EVENT);
527 event->volume = CLAMP (event_volume, MIN_VOLUME, MAX_VOLUME);
529 g_async_queue_push (dtmfsrc->event_queue, event);
533 gst_dtmf_src_add_stop_event (GstDTMFSrc * dtmfsrc)
536 GstDTMFSrcEvent *event = g_slice_new0 (GstDTMFSrcEvent);
537 event->event_type = DTMF_EVENT_TYPE_STOP;
539 event->event_number = 0;
542 g_async_queue_push (dtmfsrc->event_queue, event);
546 gst_dtmf_src_generate_silence (float duration, gint sample_rate)
550 /* Create a buffer with data set to 0 */
551 buf_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
553 return gst_buffer_new_wrapped (g_malloc0 (buf_size), buf_size);
557 gst_dtmf_src_generate_tone (GstDTMFSrcEvent * event, DTMF_KEY key,
558 float duration, gint sample_rate)
565 double amplitude, f1, f2;
566 double volume_factor;
567 static GstAllocationParams params = { 0, 1, 0, 0, };
569 /* Create a buffer for the tone */
570 tone_size = ((duration / 1000) * sample_rate * SAMPLE_SIZE * CHANNELS) / 8;
572 buffer = gst_buffer_new_allocate (NULL, tone_size, ¶ms);
574 gst_buffer_map (buffer, &map, GST_MAP_READWRITE);
575 p = (gint16 *) map.data;
577 volume_factor = pow (10, (-event->volume) / 20);
580 * For each sample point we calculate 'x' as the
581 * the amplitude value.
583 for (i = 0; i < (tone_size / (SAMPLE_SIZE / 8)); i++) {
585 * We add the fundamental frequencies together.
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));
590 amplitude = (f1 + f2) / 2;
592 /* Adjust the volume */
593 amplitude *= volume_factor;
595 /* Make the [-1:1] interval into a [-32767:32767] interval */
598 /* Store it in the data buffer */
599 *(p++) = (gint16) amplitude;
604 gst_buffer_unmap (buffer, &map);
612 gst_dtmf_src_create_next_tone_packet (GstDTMFSrc * dtmfsrc,
613 GstDTMFSrcEvent * event)
615 GstBuffer *buf = NULL;
616 gboolean send_silence = FALSE;
618 GST_LOG_OBJECT (dtmfsrc, "Creating buffer for tone %s",
619 DTMF_KEYS[event->event_number].event_name);
621 if (event->packet_count * dtmfsrc->interval < MIN_INTER_DIGIT_INTERVAL) {
626 GST_LOG_OBJECT (dtmfsrc, "Generating silence");
627 buf = gst_dtmf_src_generate_silence (dtmfsrc->interval,
628 dtmfsrc->sample_rate);
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);
634 event->packet_count++;
637 /* timestamp and duration of GstBuffer */
638 GST_BUFFER_DURATION (buf) = dtmfsrc->interval * GST_MSECOND;
639 GST_BUFFER_TIMESTAMP (buf) = dtmfsrc->timestamp;
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)));
646 dtmfsrc->timestamp += GST_BUFFER_DURATION (buf);
652 gst_dtmf_src_post_message (GstDTMFSrc * dtmfsrc, const gchar * message_name,
653 GstDTMFSrcEvent * event)
655 GstStructure *s = NULL;
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);
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);
671 case DTMF_EVENT_TYPE_PAUSE_TASK:
676 gst_element_post_message (GST_ELEMENT (dtmfsrc),
677 gst_message_new_element (GST_OBJECT (dtmfsrc), s));
681 gst_dtmf_src_create (GstBaseSrc * basesrc, guint64 offset,
682 guint length, GstBuffer ** buffer)
684 GstBuffer *buf = NULL;
685 GstDTMFSrcEvent *event;
689 GstClockReturn clockret;
691 dtmfsrc = GST_DTMF_SRC (basesrc);
695 if (dtmfsrc->last_event == NULL) {
696 GST_DEBUG_OBJECT (dtmfsrc, "popping");
697 event = g_async_queue_pop (dtmfsrc->event_queue);
699 GST_DEBUG_OBJECT (dtmfsrc, "popped %d", event->event_type);
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);
707 case DTMF_EVENT_TYPE_START:
708 gst_dtmf_prepare_timestamps (dtmfsrc);
710 event->packet_count = 0;
711 dtmfsrc->last_event = event;
713 gst_dtmf_src_post_message (dtmfsrc, "dtmf-event-processed",
714 dtmfsrc->last_event);
716 case DTMF_EVENT_TYPE_PAUSE_TASK:
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)
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);
727 GST_OBJECT_UNLOCK (dtmfsrc);
731 g_slice_free (GstDTMFSrcEvent, event);
732 } else if (dtmfsrc->last_event->packet_count * dtmfsrc->interval >=
734 event = g_async_queue_try_pop (dtmfsrc->event_queue);
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);
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);
749 case DTMF_EVENT_TYPE_PAUSE_TASK:
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)
754 GST_DEBUG_OBJECT (dtmfsrc, "pushing pause_task...");
756 GST_OBJECT_LOCK (dtmfsrc);
757 if (dtmfsrc->paused) {
758 g_async_queue_push (dtmfsrc->event_queue, event);
761 GST_OBJECT_UNLOCK (dtmfsrc);
765 g_slice_free (GstDTMFSrcEvent, event);
768 } while (dtmfsrc->last_event == NULL);
770 GST_LOG_OBJECT (dtmfsrc, "end event check, now wait for the proper time");
772 clock = gst_element_get_clock (GST_ELEMENT (basesrc));
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);
778 GST_OBJECT_LOCK (dtmfsrc);
779 if (!dtmfsrc->paused) {
780 dtmfsrc->clockid = clockid;
781 GST_OBJECT_UNLOCK (dtmfsrc);
783 clockret = gst_clock_id_wait (clockid, NULL);
785 GST_OBJECT_LOCK (dtmfsrc);
787 clockret = GST_CLOCK_UNSCHEDULED;
789 clockret = GST_CLOCK_UNSCHEDULED;
791 gst_clock_id_unref (clockid);
792 dtmfsrc->clockid = NULL;
793 GST_OBJECT_UNLOCK (dtmfsrc);
795 if (clockret == GST_CLOCK_UNSCHEDULED) {
799 buf = gst_dtmf_src_create_next_tone_packet (dtmfsrc, dtmfsrc->last_event);
801 GST_LOG_OBJECT (dtmfsrc, "Created buffer of size %" G_GSIZE_FORMAT,
802 gst_buffer_get_size (buf));
808 GST_OBJECT_UNLOCK (dtmfsrc);
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;
819 return GST_FLOW_FLUSHING;
824 gst_dtmf_src_unlock (GstBaseSrc * src)
826 GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
827 GstDTMFSrcEvent *event = NULL;
829 GST_DEBUG_OBJECT (dtmfsrc, "Called unlock");
831 GST_OBJECT_LOCK (dtmfsrc);
832 dtmfsrc->paused = TRUE;
833 if (dtmfsrc->clockid) {
834 gst_clock_id_unschedule (dtmfsrc->clockid);
836 GST_OBJECT_UNLOCK (dtmfsrc);
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);
848 gst_dtmf_src_unlock_stop (GstBaseSrc * src)
850 GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (src);
852 GST_DEBUG_OBJECT (dtmfsrc, "Unlock stopped");
854 GST_OBJECT_LOCK (dtmfsrc);
855 dtmfsrc->paused = FALSE;
856 GST_OBJECT_UNLOCK (dtmfsrc);
863 gst_dtmf_src_negotiate (GstBaseSrc * basesrc)
865 GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
870 caps = gst_pad_get_allowed_caps (GST_BASE_SRC_PAD (basesrc));
873 caps = gst_pad_get_pad_template_caps (GST_BASE_SRC_PAD (basesrc));
875 if (gst_caps_is_empty (caps)) {
876 gst_caps_unref (caps);
880 caps = gst_caps_truncate (caps);
882 caps = gst_caps_make_writable (caps);
883 s = gst_caps_get_structure (caps, 0);
885 gst_structure_fixate_field_nearest_int (s, "rate", DEFAULT_SAMPLE_RATE);
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);
893 ret = gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps);
895 gst_caps_unref (caps);
901 gst_dtmf_src_query (GstBaseSrc * basesrc, GstQuery * query)
903 GstDTMFSrc *dtmfsrc = GST_DTMF_SRC (basesrc);
904 gboolean res = FALSE;
906 switch (GST_QUERY_TYPE (query)) {
907 case GST_QUERY_LATENCY:
909 GstClockTime latency;
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));
920 res = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
927 static GstStateChangeReturn
928 gst_dtmf_src_change_state (GstElement * element, GstStateChange transition)
931 GstStateChangeReturn result;
932 gboolean no_preroll = FALSE;
933 GstDTMFSrcEvent *event = NULL;
935 dtmfsrc = GST_DTMF_SRC (element);
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);
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);
947 dtmfsrc->last_event_was_start = FALSE;
948 dtmfsrc->timestamp = 0;
956 GST_ELEMENT_CLASS (gst_dtmf_src_parent_class)->change_state (element,
957 transition)) == GST_STATE_CHANGE_FAILURE)
960 switch (transition) {
961 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
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);
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);
974 dtmfsrc->last_event_was_start = FALSE;
981 if (no_preroll && result == GST_STATE_CHANGE_SUCCESS)
982 result = GST_STATE_CHANGE_NO_PREROLL;
989 GST_ERROR_OBJECT (dtmfsrc, "parent failed state change");
995 gst_dtmf_src_plugin_init (GstPlugin * plugin)
997 return gst_element_register (plugin, "dtmfsrc",
998 GST_RANK_NONE, GST_TYPE_DTMF_SRC);