gst/dtmf/gstrtpdtmfdepay.c

   1 /* GstRtpDtmfDepay
   2  *
   3  * Copyright (C) 2008 Collabora Limited
   4  * Copyright (C) 2008 Nokia Corporation
   5  *   Contact: Youness Alaoui <youness.alaoui@collabora.co.uk>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22 /**
  23  * SECTION:element-rtpdtmfdepay
  24  * @see_also: rtpdtmfsrc, rtpdtmfmux
  25  *
  26  * This element takes RTP DTMF packets and produces sound. It also emits a
  27  * message on the #GstBus.
  28  *
  29  * The message is called "dtmf-event" and has the following fields
  30  * <informaltable>
  31  * <tgroup cols='4'>
  32  * <colspec colname='Name' />
  33  * <colspec colname='Type' />
  34  * <colspec colname='Possible values' />
  35  * <colspec colname='Purpose' />
  36  * <thead>
  37  * <row>
  38  * <entry>Name</entry>
  39  * <entry>GType</entry>
  40  * <entry>Possible values</entry>
  41  * <entry>Purpose</entry>
  42  * </row>
  43  * </thead>
  44  * <tbody>
  45  * <row>
  46  * <entry>type</entry>
  47  * <entry>G_TYPE_INT</entry>
  48  * <entry>0-1</entry>
  49  * <entry>Which of the two methods
  50  * specified in RFC 2833 to use. The value should be 0 for tones and 1 for
  51  * named events. Tones are specified by their frequencies and events are specied
  52  * by their number. This element currently only recognizes events.
  53  * Do not confuse with "method" which specified the output.
  54  * </entry>
  55  * </row>
  56  * <row>
  57  * <entry>number</entry>
  58  * <entry>G_TYPE_INT</entry>
  59  * <entry>0-16</entry>
  60  * <entry>The event number.</entry>
  61  * </row>
  62  * <row>
  63  * <entry>volume</entry>
  64  * <entry>G_TYPE_INT</entry>
  65  * <entry>0-36</entry>
  66  * <entry>This field describes the power level of the tone, expressed in dBm0
  67  * after dropping the sign. Power levels range from 0 to -63 dBm0. The range of
  68  * valid DTMF is from 0 to -36 dBm0.
  69  * </entry>
  70  * </row>
  71  * <row>
  72  * <entry>method</entry>
  73  * <entry>G_TYPE_INT</entry>
  74  * <entry>1</entry>
  75  * <entry>This field will always been 1 (ie RTP event) from this element.
  76  * </entry>
  77  * </row>
  78  * </tbody>
  79  * </tgroup>
  80  * </informaltable>
  81  */
  82
  83 #ifdef HAVE_CONFIG_H
  84 #include "config.h"
  85 #endif
  86
  87 #include "gstrtpdtmfdepay.h"
  88
  89 #include <string.h>
  90 #include <math.h>
  91
  92 #include <gst/audio/audio.h>
  93 #include <gst/rtp/gstrtpbuffer.h>
  94
  95 #define DEFAULT_PACKET_INTERVAL  50     /* ms */
  96 #define MIN_PACKET_INTERVAL      10     /* ms */
  97 #define MAX_PACKET_INTERVAL      50     /* ms */
  98 #define SAMPLE_RATE              8000
  99 #define SAMPLE_SIZE              16
 100 #define CHANNELS                 1
 101 #define MIN_DUTY_CYCLE           (MIN_INTER_DIGIT_INTERVAL + MIN_PULSE_DURATION)
 102
 103 #define MIN_UNIT_TIME            0
 104 #define MAX_UNIT_TIME            1000
 105 #define DEFAULT_UNIT_TIME        0
 106
 107 #define DEFAULT_MAX_DURATION     0
 108
 109 typedef struct st_dtmf_key
 110 {
 111   float low_frequency;
 112   float high_frequency;
 113 } DTMF_KEY;
 114
 115 static const DTMF_KEY DTMF_KEYS[] = {
 116   {941, 1336},
 117   {697, 1209},
 118   {697, 1336},
 119   {697, 1477},
 120   {770, 1209},
 121   {770, 1336},
 122   {770, 1477},
 123   {852, 1209},
 124   {852, 1336},
 125   {852, 1477},
 126   {941, 1209},
 127   {941, 1477},
 128   {697, 1633},
 129   {770, 1633},
 130   {852, 1633},
 131   {941, 1633},
 132 };
 133
 134 #define MAX_DTMF_EVENTS 16
 135
 136 enum
 137 {
 138   DTMF_KEY_EVENT_1 = 1,
 139   DTMF_KEY_EVENT_2 = 2,
 140   DTMF_KEY_EVENT_3 = 3,
 141   DTMF_KEY_EVENT_4 = 4,
 142   DTMF_KEY_EVENT_5 = 5,
 143   DTMF_KEY_EVENT_6 = 6,
 144   DTMF_KEY_EVENT_7 = 7,
 145   DTMF_KEY_EVENT_8 = 8,
 146   DTMF_KEY_EVENT_9 = 9,
 147   DTMF_KEY_EVENT_0 = 0,
 148   DTMF_KEY_EVENT_STAR = 10,
 149   DTMF_KEY_EVENT_POUND = 11,
 150   DTMF_KEY_EVENT_A = 12,
 151   DTMF_KEY_EVENT_B = 13,
 152   DTMF_KEY_EVENT_C = 14,
 153   DTMF_KEY_EVENT_D = 15,
 154 };
 155
 156 GST_DEBUG_CATEGORY_STATIC (gst_rtp_dtmf_depay_debug);
 157 #define GST_CAT_DEFAULT gst_rtp_dtmf_depay_debug
 158
 159 enum
 160 {
 161
 162
 163   /* FILL ME */
 164   LAST_SIGNAL
 165 };
 166
 167 enum
 168 {
 169   PROP_0,
 170   PROP_UNIT_TIME,
 171   PROP_MAX_DURATION
 172 };
 173
 174 enum
 175 {
 176   ARG_0
 177 };
 178
 179 static GstStaticPadTemplate gst_rtp_dtmf_depay_src_template =
 180 GST_STATIC_PAD_TEMPLATE ("src",
 181     GST_PAD_SRC,
 182     GST_PAD_ALWAYS,
 183     GST_STATIC_CAPS ("audio/x-raw, "
 184         "format = (string) \"" GST_AUDIO_NE (S16) "\", "
 185         "rate = " GST_AUDIO_RATE_RANGE ", " "channels = (int) 1")
 186     );
 187
 188 static GstStaticPadTemplate gst_rtp_dtmf_depay_sink_template =
 189 GST_STATIC_PAD_TEMPLATE ("sink",
 190     GST_PAD_SINK,
 191     GST_PAD_ALWAYS,
 192     GST_STATIC_CAPS ("application/x-rtp, "
 193         "media = (string) \"audio\", "
 194         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
 195         "clock-rate = (int) [ 0, MAX ], "
 196         "encoding-name = (string) \"TELEPHONE-EVENT\"")
 197     );
 198
 199 G_DEFINE_TYPE (GstRtpDTMFDepay, gst_rtp_dtmf_depay,
 200     GST_TYPE_RTP_BASE_DEPAYLOAD);
 201
 202 static void gst_rtp_dtmf_depay_set_property (GObject * object, guint prop_id,
 203     const GValue * value, GParamSpec * pspec);
 204 static void gst_rtp_dtmf_depay_get_property (GObject * object, guint prop_id,
 205     GValue * value, GParamSpec * pspec);
 206 static GstBuffer *gst_rtp_dtmf_depay_process (GstRTPBaseDepayload * depayload,
 207     GstBuffer * buf);
 208 gboolean gst_rtp_dtmf_depay_setcaps (GstRTPBaseDepayload * filter,
 209     GstCaps * caps);
 210
 211 static void
 212 gst_rtp_dtmf_depay_class_init (GstRtpDTMFDepayClass * klass)
 213 {
 214   GObjectClass *gobject_class;
 215   GstElementClass *gstelement_class;
 216   GstRTPBaseDepayloadClass *gstrtpbasedepayload_class;
 217
 218   gobject_class = G_OBJECT_CLASS (klass);
 219   gstelement_class = GST_ELEMENT_CLASS (klass);
 220   gstrtpbasedepayload_class = GST_RTP_BASE_DEPAYLOAD_CLASS (klass);
 221
 222   gst_element_class_add_pad_template (gstelement_class,
 223       gst_static_pad_template_get (&gst_rtp_dtmf_depay_src_template));
 224   gst_element_class_add_pad_template (gstelement_class,
 225       gst_static_pad_template_get (&gst_rtp_dtmf_depay_sink_template));
 226
 227   GST_DEBUG_CATEGORY_INIT (gst_rtp_dtmf_depay_debug,
 228       "rtpdtmfdepay", 0, "rtpdtmfdepay element");
 229   gst_element_class_set_static_metadata (gstelement_class,
 230       "RTP DTMF packet depayloader", "Codec/Depayloader/Network",
 231       "Generates DTMF Sound from telephone-event RTP packets",
 232       "Youness Alaoui <youness.alaoui@collabora.co.uk>");
 233
 234   gobject_class->set_property =
 235       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_set_property);
 236   gobject_class->get_property =
 237       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_get_property);
 238
 239   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_UNIT_TIME,
 240       g_param_spec_uint ("unit-time", "Duration unittime",
 241           "The smallest unit (ms) the duration must be a multiple of (0 disables it)",
 242           MIN_UNIT_TIME, MAX_UNIT_TIME, DEFAULT_UNIT_TIME,
 243           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 244
 245   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MAX_DURATION,
 246       g_param_spec_uint ("max-duration", "Maximum duration",
 247           "The maxumimum duration (ms) of the outgoing soundpacket. "
 248           "(0 = no limit)", 0, G_MAXUINT, DEFAULT_MAX_DURATION,
 249           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 250
 251   gstrtpbasedepayload_class->process =
 252       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_process);
 253   gstrtpbasedepayload_class->set_caps =
 254       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_setcaps);
 255
 256 }
 257
 258 static void
 259 gst_rtp_dtmf_depay_init (GstRtpDTMFDepay * rtpdtmfdepay)
 260 {
 261   rtpdtmfdepay->unit_time = DEFAULT_UNIT_TIME;
 262 }
 263
 264 static void
 265 gst_rtp_dtmf_depay_set_property (GObject * object, guint prop_id,
 266     const GValue * value, GParamSpec * pspec)
 267 {
 268   GstRtpDTMFDepay *rtpdtmfdepay;
 269
 270   rtpdtmfdepay = GST_RTP_DTMF_DEPAY (object);
 271
 272   switch (prop_id) {
 273     case PROP_UNIT_TIME:
 274       rtpdtmfdepay->unit_time = g_value_get_uint (value);
 275       break;
 276     case PROP_MAX_DURATION:
 277       rtpdtmfdepay->max_duration = g_value_get_uint (value);
 278       break;
 279     default:
 280       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 281       break;
 282   }
 283 }
 284
 285 static void
 286 gst_rtp_dtmf_depay_get_property (GObject * object, guint prop_id,
 287     GValue * value, GParamSpec * pspec)
 288 {
 289   GstRtpDTMFDepay *rtpdtmfdepay;
 290
 291   rtpdtmfdepay = GST_RTP_DTMF_DEPAY (object);
 292
 293   switch (prop_id) {
 294     case PROP_UNIT_TIME:
 295       g_value_set_uint (value, rtpdtmfdepay->unit_time);
 296       break;
 297     case PROP_MAX_DURATION:
 298       g_value_set_uint (value, rtpdtmfdepay->max_duration);
 299       break;
 300     default:
 301       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 302       break;
 303   }
 304 }
 305
 306 gboolean
 307 gst_rtp_dtmf_depay_setcaps (GstRTPBaseDepayload * filter, GstCaps * caps)
 308 {
 309   GstCaps *filtercaps, *srccaps;
 310   GstStructure *structure = gst_caps_get_structure (caps, 0);
 311   gint clock_rate = 8000;       /* default */
 312
 313   gst_structure_get_int (structure, "clock-rate", &clock_rate);
 314   filter->clock_rate = clock_rate;
 315
 316   filtercaps =
 317       gst_pad_get_pad_template_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (filter));
 318
 319   filtercaps = gst_caps_make_writable (filtercaps);
 320   gst_caps_set_simple (filtercaps, "rate", G_TYPE_INT, clock_rate, NULL);
 321
 322   srccaps = gst_pad_peer_query_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (filter),
 323       filtercaps);
 324   gst_caps_unref (filtercaps);
 325
 326   gst_pad_set_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (filter), srccaps);
 327   gst_caps_unref (srccaps);
 328
 329   return TRUE;
 330 }
 331
 332 static GstBuffer *
 333 gst_dtmf_src_generate_tone (GstRtpDTMFDepay * rtpdtmfdepay,
 334     GstRTPDTMFPayload payload)
 335 {
 336   GstBuffer *buf;
 337   GstMapInfo map;
 338   gint16 *p;
 339   gint tone_size;
 340   double i = 0;
 341   double amplitude, f1, f2;
 342   double volume_factor;
 343   DTMF_KEY key = DTMF_KEYS[payload.event];
 344   guint32 clock_rate;
 345   GstRTPBaseDepayload *depayload = GST_RTP_BASE_DEPAYLOAD (rtpdtmfdepay);
 346   gint volume;
 347   static GstAllocationParams params = { 0, 1, 0, 0, };
 348
 349   clock_rate = depayload->clock_rate;
 350
 351   /* Create a buffer for the tone */
 352   tone_size = (payload.duration * SAMPLE_SIZE * CHANNELS) / 8;
 353   buf = gst_buffer_new_allocate (NULL, tone_size, &params);
 354   GST_BUFFER_DURATION (buf) = payload.duration * GST_SECOND / clock_rate;
 355   volume = payload.volume;
 356
 357   gst_buffer_map (buf, &map, GST_MAP_WRITE);
 358   p = (gint16 *) map.data;
 359
 360   volume_factor = pow (10, (-volume) / 20);
 361
 362   /*
 363    * For each sample point we calculate 'x' as the
 364    * the amplitude value.
 365    */
 366   for (i = 0; i < (tone_size / (SAMPLE_SIZE / 8)); i++) {
 367     /*
 368      * We add the fundamental frequencies together.
 369      */
 370     f1 = sin (2 * M_PI * key.low_frequency * (rtpdtmfdepay->sample /
 371             clock_rate));
 372     f2 = sin (2 * M_PI * key.high_frequency * (rtpdtmfdepay->sample /
 373             clock_rate));
 374
 375     amplitude = (f1 + f2) / 2;
 376
 377     /* Adjust the volume */
 378     amplitude *= volume_factor;
 379
 380     /* Make the [-1:1] interval into a [-32767:32767] interval */
 381     amplitude *= 32767;
 382
 383     /* Store it in the data buffer */
 384     *(p++) = (gint16) amplitude;
 385
 386     (rtpdtmfdepay->sample)++;
 387   }
 388
 389   gst_buffer_unmap (buf, &map);
 390
 391   return buf;
 392 }
 393
 394
 395 static GstBuffer *
 396 gst_rtp_dtmf_depay_process (GstRTPBaseDepayload * depayload, GstBuffer * buf)
 397 {
 398
 399   GstRtpDTMFDepay *rtpdtmfdepay = NULL;
 400   GstBuffer *outbuf = NULL;
 401   gint payload_len;
 402   guint8 *payload = NULL;
 403   guint32 timestamp;
 404   GstRTPDTMFPayload dtmf_payload;
 405   gboolean marker;
 406   GstStructure *structure = NULL;
 407   GstMessage *dtmf_message = NULL;
 408   GstRTPBuffer rtpbuffer = GST_RTP_BUFFER_INIT;
 409
 410   rtpdtmfdepay = GST_RTP_DTMF_DEPAY (depayload);
 411
 412   gst_rtp_buffer_map (buf, GST_MAP_READ, &rtpbuffer);
 413
 414   payload_len = gst_rtp_buffer_get_payload_len (&rtpbuffer);
 415   payload = gst_rtp_buffer_get_payload (&rtpbuffer);
 416
 417   if (payload_len != sizeof (GstRTPDTMFPayload))
 418     goto bad_packet;
 419
 420   memcpy (&dtmf_payload, payload, sizeof (GstRTPDTMFPayload));
 421
 422   if (dtmf_payload.event > MAX_EVENT)
 423     goto bad_packet;
 424
 425   marker = gst_rtp_buffer_get_marker (&rtpbuffer);
 426
 427   timestamp = gst_rtp_buffer_get_timestamp (&rtpbuffer);
 428
 429   dtmf_payload.duration = g_ntohs (dtmf_payload.duration);
 430
 431   /* clip to whole units of unit_time */
 432   if (rtpdtmfdepay->unit_time) {
 433     guint unit_time_clock =
 434         (rtpdtmfdepay->unit_time * depayload->clock_rate) / 1000;
 435     if (dtmf_payload.duration % unit_time_clock) {
 436       /* Make sure we don't overflow the duration */
 437       if (dtmf_payload.duration < G_MAXUINT16 - unit_time_clock)
 438         dtmf_payload.duration += unit_time_clock -
 439             (dtmf_payload.duration % unit_time_clock);
 440       else
 441         dtmf_payload.duration -= dtmf_payload.duration % unit_time_clock;
 442     }
 443   }
 444
 445   /* clip to max duration */
 446   if (rtpdtmfdepay->max_duration) {
 447     guint max_duration_clock =
 448         (rtpdtmfdepay->max_duration * depayload->clock_rate) / 1000;
 449
 450     if (max_duration_clock < G_MAXUINT16 &&
 451         dtmf_payload.duration > max_duration_clock)
 452       dtmf_payload.duration = max_duration_clock;
 453   }
 454
 455   GST_DEBUG_OBJECT (depayload, "Received new RTP DTMF packet : "
 456       "marker=%d - timestamp=%u - event=%d - duration=%d",
 457       marker, timestamp, dtmf_payload.event, dtmf_payload.duration);
 458
 459   GST_DEBUG_OBJECT (depayload,
 460       "Previous information : timestamp=%u - duration=%d",
 461       rtpdtmfdepay->previous_ts, rtpdtmfdepay->previous_duration);
 462
 463   /* First packet */
 464   if (marker || rtpdtmfdepay->previous_ts != timestamp) {
 465     rtpdtmfdepay->sample = 0;
 466     rtpdtmfdepay->previous_ts = timestamp;
 467     rtpdtmfdepay->previous_duration = dtmf_payload.duration;
 468     rtpdtmfdepay->first_gst_ts = GST_BUFFER_PTS (buf);
 469
 470     structure = gst_structure_new ("dtmf-event",
 471         "number", G_TYPE_INT, dtmf_payload.event,
 472         "volume", G_TYPE_INT, dtmf_payload.volume,
 473         "type", G_TYPE_INT, 1, "method", G_TYPE_INT, 1, NULL);
 474     if (structure) {
 475       dtmf_message =
 476           gst_message_new_element (GST_OBJECT (depayload), structure);
 477       if (dtmf_message) {
 478         if (!gst_element_post_message (GST_ELEMENT (depayload), dtmf_message)) {
 479           GST_ERROR_OBJECT (depayload,
 480               "Unable to send dtmf-event message to bus");
 481         }
 482       } else {
 483         GST_ERROR_OBJECT (depayload, "Unable to create dtmf-event message");
 484       }
 485     } else {
 486       GST_ERROR_OBJECT (depayload, "Unable to create dtmf-event structure");
 487     }
 488   } else {
 489     guint16 duration = dtmf_payload.duration;
 490     dtmf_payload.duration -= rtpdtmfdepay->previous_duration;
 491     /* If late buffer, ignore */
 492     if (duration > rtpdtmfdepay->previous_duration)
 493       rtpdtmfdepay->previous_duration = duration;
 494   }
 495
 496   GST_DEBUG_OBJECT (depayload, "new previous duration : %d - new duration : %d"
 497       " - diff  : %d - clock rate : %d - timestamp : %" G_GUINT64_FORMAT,
 498       rtpdtmfdepay->previous_duration, dtmf_payload.duration,
 499       (rtpdtmfdepay->previous_duration - dtmf_payload.duration),
 500       depayload->clock_rate, GST_BUFFER_TIMESTAMP (buf));
 501
 502   /* If late or duplicate packet (like the redundant end packet). Ignore */
 503   if (dtmf_payload.duration > 0) {
 504     outbuf = gst_dtmf_src_generate_tone (rtpdtmfdepay, dtmf_payload);
 505
 506
 507     GST_BUFFER_PTS (outbuf) = rtpdtmfdepay->first_gst_ts +
 508         (rtpdtmfdepay->previous_duration - dtmf_payload.duration) *
 509         GST_SECOND / depayload->clock_rate;
 510     GST_BUFFER_OFFSET (outbuf) =
 511         (rtpdtmfdepay->previous_duration - dtmf_payload.duration) *
 512         GST_SECOND / depayload->clock_rate;
 513     GST_BUFFER_OFFSET_END (outbuf) = rtpdtmfdepay->previous_duration *
 514         GST_SECOND / depayload->clock_rate;
 515
 516     GST_DEBUG_OBJECT (depayload,
 517         "timestamp : %" G_GUINT64_FORMAT " - time %" GST_TIME_FORMAT,
 518         GST_BUFFER_TIMESTAMP (buf), GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
 519
 520   }
 521
 522   gst_rtp_buffer_unmap (&rtpbuffer);
 523
 524   return outbuf;
 525
 526 bad_packet:
 527   GST_ELEMENT_WARNING (rtpdtmfdepay, STREAM, DECODE,
 528       ("Packet did not validate"), (NULL));
 529
 530   if (rtpbuffer.buffer != NULL)
 531     gst_rtp_buffer_unmap (&rtpbuffer);
 532
 533   return NULL;
 534 }
 535
 536 gboolean
 537 gst_rtp_dtmf_depay_plugin_init (GstPlugin * plugin)
 538 {
 539   return gst_element_register (plugin, "rtpdtmfdepay",
 540       GST_RANK_MARGINAL, GST_TYPE_RTP_DTMF_DEPAY);
 541 }