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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include <string.h>
  28 #include <math.h>
  29
  30 #include <gst/rtp/gstrtpbuffer.h>
  31 #include "gstrtpdtmfdepay.h"
  32
  33 #ifndef M_PI
  34 # define M_PI           3.14159265358979323846  /* pi */
  35 #endif
  36
  37
  38 #define DEFAULT_PACKET_INTERVAL  50     /* ms */
  39 #define MIN_PACKET_INTERVAL      10     /* ms */
  40 #define MAX_PACKET_INTERVAL      50     /* ms */
  41 #define SAMPLE_RATE              8000
  42 #define SAMPLE_SIZE              16
  43 #define CHANNELS                 1
  44 #define MIN_EVENT                0
  45 #define MAX_EVENT                16
  46 #define MIN_VOLUME               0
  47 #define MAX_VOLUME               36
  48 #define MIN_INTER_DIGIT_INTERVAL 100
  49 #define MIN_PULSE_DURATION       250
  50 #define MIN_DUTY_CYCLE           (MIN_INTER_DIGIT_INTERVAL + MIN_PULSE_DURATION)
  51
  52 #define MIN_UNIT_TIME            0
  53 #define MAX_UNIT_TIME            1000
  54 #define DEFAULT_UNIT_TIME        0
  55
  56 #define DEFAULT_MAX_DURATION     0
  57
  58 typedef struct st_dtmf_key
  59 {
  60   char *event_name;
  61   int event_encoding;
  62   float low_frequency;
  63   float high_frequency;
  64 } DTMF_KEY;
  65
  66 static const DTMF_KEY DTMF_KEYS[] = {
  67   {"DTMF_KEY_EVENT_0", 0, 941, 1336},
  68   {"DTMF_KEY_EVENT_1", 1, 697, 1209},
  69   {"DTMF_KEY_EVENT_2", 2, 697, 1336},
  70   {"DTMF_KEY_EVENT_3", 3, 697, 1477},
  71   {"DTMF_KEY_EVENT_4", 4, 770, 1209},
  72   {"DTMF_KEY_EVENT_5", 5, 770, 1336},
  73   {"DTMF_KEY_EVENT_6", 6, 770, 1477},
  74   {"DTMF_KEY_EVENT_7", 7, 852, 1209},
  75   {"DTMF_KEY_EVENT_8", 8, 852, 1336},
  76   {"DTMF_KEY_EVENT_9", 9, 852, 1477},
  77   {"DTMF_KEY_EVENT_S", 10, 941, 1209},
  78   {"DTMF_KEY_EVENT_P", 11, 941, 1477},
  79   {"DTMF_KEY_EVENT_A", 12, 697, 1633},
  80   {"DTMF_KEY_EVENT_B", 13, 770, 1633},
  81   {"DTMF_KEY_EVENT_C", 14, 852, 1633},
  82   {"DTMF_KEY_EVENT_D", 15, 941, 1633},
  83 };
  84
  85 #define MAX_DTMF_EVENTS 16
  86
  87 enum
  88 {
  89   DTMF_KEY_EVENT_1 = 1,
  90   DTMF_KEY_EVENT_2 = 2,
  91   DTMF_KEY_EVENT_3 = 3,
  92   DTMF_KEY_EVENT_4 = 4,
  93   DTMF_KEY_EVENT_5 = 5,
  94   DTMF_KEY_EVENT_6 = 6,
  95   DTMF_KEY_EVENT_7 = 7,
  96   DTMF_KEY_EVENT_8 = 8,
  97   DTMF_KEY_EVENT_9 = 9,
  98   DTMF_KEY_EVENT_0 = 0,
  99   DTMF_KEY_EVENT_STAR = 10,
 100   DTMF_KEY_EVENT_POUND = 11,
 101   DTMF_KEY_EVENT_A = 12,
 102   DTMF_KEY_EVENT_B = 13,
 103   DTMF_KEY_EVENT_C = 14,
 104   DTMF_KEY_EVENT_D = 15,
 105 };
 106
 107 /* elementfactory information */
 108 static const GstElementDetails gst_rtp_dtmfdepay_details =
 109 GST_ELEMENT_DETAILS ("RTP DTMF packet depayloader",
 110     "Codec/Depayloader/Network",
 111     "Generates DTMF Sound from telephone-event RTP packets",
 112     "Youness Alaoui <youness.alaoui@collabora.co.uk>");
 113
 114 GST_DEBUG_CATEGORY_STATIC (gst_rtp_dtmf_depay_debug);
 115 #define GST_CAT_DEFAULT gst_rtp_dtmf_depay_debug
 116
 117 enum
 118 {
 119
 120
 121   /* FILL ME */
 122   LAST_SIGNAL
 123 };
 124
 125 enum
 126 {
 127   PROP_0,
 128   PROP_UNIT_TIME,
 129   PROP_MAX_DURATION
 130 };
 131
 132 enum
 133 {
 134   ARG_0
 135 };
 136
 137 static GstStaticPadTemplate gst_rtp_dtmf_depay_src_template =
 138 GST_STATIC_PAD_TEMPLATE ("src",
 139     GST_PAD_SRC,
 140     GST_PAD_ALWAYS,
 141     GST_STATIC_CAPS ("audio/x-raw-int, "
 142         "width = (int) 16, "
 143         "depth = (int) 16, "
 144         "endianness = (int) " G_STRINGIFY (G_BYTE_ORDER) ", "
 145         "signed = (boolean) true, "
 146         "rate = (int) [0, MAX], " "channels = (int) 1")
 147     );
 148
 149 static GstStaticPadTemplate gst_rtp_dtmf_depay_sink_template =
 150 GST_STATIC_PAD_TEMPLATE ("sink",
 151     GST_PAD_SINK,
 152     GST_PAD_ALWAYS,
 153     GST_STATIC_CAPS ("application/x-rtp, "
 154         "media = (string) \"audio\", "
 155         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
 156         "clock-rate = (int) [ 0, MAX ], "
 157         "encoding-name = (string) \"TELEPHONE-EVENT\"")
 158     );
 159
 160 GST_BOILERPLATE (GstRtpDTMFDepay, gst_rtp_dtmf_depay, GstBaseRTPDepayload,
 161     GST_TYPE_BASE_RTP_DEPAYLOAD);
 162
 163 static void gst_rtp_dtmf_depay_set_property (GObject * object, guint prop_id,
 164     const GValue * value, GParamSpec * pspec);
 165 static void gst_rtp_dtmf_depay_get_property (GObject * object, guint prop_id,
 166     GValue * value, GParamSpec * pspec);
 167 static GstBuffer *gst_rtp_dtmf_depay_process (GstBaseRTPDepayload * depayload,
 168     GstBuffer * buf);
 169 gboolean gst_rtp_dtmf_depay_setcaps (GstBaseRTPDepayload * filter,
 170     GstCaps * caps);
 171
 172 static void
 173 gst_rtp_dtmf_depay_base_init (gpointer klass)
 174 {
 175   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 176
 177   gst_element_class_add_pad_template (element_class,
 178       gst_static_pad_template_get (&gst_rtp_dtmf_depay_src_template));
 179   gst_element_class_add_pad_template (element_class,
 180       gst_static_pad_template_get (&gst_rtp_dtmf_depay_sink_template));
 181
 182
 183   GST_DEBUG_CATEGORY_INIT (gst_rtp_dtmf_depay_debug,
 184       "rtpdtmfdepay", 0, "rtpdtmfdepay element");
 185   gst_element_class_set_details (element_class, &gst_rtp_dtmfdepay_details);
 186 }
 187
 188 static void
 189 gst_rtp_dtmf_depay_class_init (GstRtpDTMFDepayClass * klass)
 190 {
 191   GObjectClass *gobject_class;
 192   GstElementClass *gstelement_class;
 193   GstBaseRTPDepayloadClass *gstbasertpdepayload_class;
 194
 195   gobject_class = (GObjectClass *) klass;
 196   gstelement_class = (GstElementClass *) klass;
 197   gstbasertpdepayload_class = (GstBaseRTPDepayloadClass *) klass;
 198
 199   parent_class = g_type_class_peek_parent (klass);
 200
 201   gobject_class->set_property =
 202       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_set_property);
 203   gobject_class->get_property =
 204       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_get_property);
 205
 206   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_UNIT_TIME,
 207       g_param_spec_uint ("unit-time", "Duration unittime",
 208           "The smallest unit (ms) the duration must be a multiple of (0 disables it)",
 209           MIN_UNIT_TIME, MAX_UNIT_TIME, DEFAULT_UNIT_TIME, G_PARAM_READWRITE));
 210
 211   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MAX_DURATION,
 212       g_param_spec_uint ("max-duration", "Maximum duration",
 213           "The maxumimum duration (ms) of the outgoing soundpacket. "
 214           "(0 = no limit)", 0, G_MAXUINT, DEFAULT_MAX_DURATION,
 215           G_PARAM_READWRITE));
 216
 217   gstbasertpdepayload_class->process =
 218       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_process);
 219   gstbasertpdepayload_class->set_caps =
 220       GST_DEBUG_FUNCPTR (gst_rtp_dtmf_depay_setcaps);
 221
 222 }
 223
 224 static void
 225 gst_rtp_dtmf_depay_init (GstRtpDTMFDepay * rtpdtmfdepay,
 226     GstRtpDTMFDepayClass * klass)
 227 {
 228   rtpdtmfdepay->unit_time = DEFAULT_UNIT_TIME;
 229 }
 230
 231 static void
 232 gst_rtp_dtmf_depay_set_property (GObject * object, guint prop_id,
 233     const GValue * value, GParamSpec * pspec)
 234 {
 235   GstRtpDTMFDepay *rtpdtmfdepay;
 236
 237   rtpdtmfdepay = GST_RTP_DTMF_DEPAY (object);
 238
 239   switch (prop_id) {
 240     case PROP_UNIT_TIME:
 241       rtpdtmfdepay->unit_time = g_value_get_uint (value);
 242       break;
 243     case PROP_MAX_DURATION:
 244       rtpdtmfdepay->max_duration = g_value_get_uint (value);
 245       break;
 246     default:
 247       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 248       break;
 249   }
 250 }
 251
 252 static void
 253 gst_rtp_dtmf_depay_get_property (GObject * object, guint prop_id,
 254     GValue * value, GParamSpec * pspec)
 255 {
 256   GstRtpDTMFDepay *rtpdtmfdepay;
 257
 258   rtpdtmfdepay = GST_RTP_DTMF_DEPAY (object);
 259
 260   switch (prop_id) {
 261     case PROP_UNIT_TIME:
 262       g_value_set_uint (value, rtpdtmfdepay->unit_time);
 263       break;
 264     case PROP_MAX_DURATION:
 265       g_value_set_uint (value, rtpdtmfdepay->max_duration);
 266       break;
 267     default:
 268       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 269       break;
 270   }
 271 }
 272
 273 gboolean
 274 gst_rtp_dtmf_depay_setcaps (GstBaseRTPDepayload * filter, GstCaps * caps)
 275 {
 276   GstCaps *srccaps;
 277   GstStructure *structure = gst_caps_get_structure (caps, 0);
 278   gint clock_rate = 8000;       /* default */
 279
 280   gst_structure_get_int (structure, "clock-rate", &clock_rate);
 281   filter->clock_rate = clock_rate;
 282
 283   srccaps = gst_caps_new_simple ("audio/x-raw-int",
 284       "width", G_TYPE_INT, 16,
 285       "depth", G_TYPE_INT, 16,
 286       "endianness", G_TYPE_INT, G_BYTE_ORDER,
 287       "signed", G_TYPE_BOOLEAN, TRUE,
 288       "channels", G_TYPE_INT, 1, "rate", G_TYPE_INT, clock_rate, NULL);
 289   gst_pad_set_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (filter), srccaps);
 290   gst_caps_unref (srccaps);
 291
 292   return TRUE;
 293 }
 294
 295 static void
 296 gst_dtmf_src_generate_tone (GstRtpDTMFDepay * rtpdtmfdepay,
 297     GstRTPDTMFPayload payload, GstBuffer * buffer)
 298 {
 299   gint16 *p;
 300   gint tone_size;
 301   double i = 0;
 302   double amplitude, f1, f2;
 303   double volume_factor;
 304   DTMF_KEY key = DTMF_KEYS[payload.event];
 305   guint32 clock_rate = 8000 /* default */ ;
 306   GstBaseRTPDepayload *depayload = GST_BASE_RTP_DEPAYLOAD (rtpdtmfdepay);
 307   gint volume;
 308
 309   clock_rate = depayload->clock_rate;
 310
 311   /* Create a buffer for the tone */
 312   tone_size = (payload.duration * SAMPLE_SIZE * CHANNELS) / 8;
 313   GST_BUFFER_SIZE (buffer) = tone_size;
 314   GST_BUFFER_MALLOCDATA (buffer) = g_malloc (tone_size);
 315   GST_BUFFER_DATA (buffer) = GST_BUFFER_MALLOCDATA (buffer);
 316   GST_BUFFER_DURATION (buffer) = payload.duration * GST_SECOND / clock_rate;
 317   volume = payload.volume;
 318
 319   p = (gint16 *) GST_BUFFER_MALLOCDATA (buffer);
 320
 321   volume_factor = pow (10, (-volume) / 20);
 322
 323   /*
 324    * For each sample point we calculate 'x' as the
 325    * the amplitude value.
 326    */
 327   for (i = 0; i < (tone_size / (SAMPLE_SIZE / 8)); i++) {
 328     /*
 329      * We add the fundamental frequencies together.
 330      */
 331     f1 = sin (2 * M_PI * key.low_frequency * (rtpdtmfdepay->sample /
 332             clock_rate));
 333     f2 = sin (2 * M_PI * key.high_frequency * (rtpdtmfdepay->sample /
 334             clock_rate));
 335
 336     amplitude = (f1 + f2) / 2;
 337
 338     /* Adjust the volume */
 339     amplitude *= volume_factor;
 340
 341     /* Make the [-1:1] interval into a [-32767:32767] interval */
 342     amplitude *= 32767;
 343
 344     /* Store it in the data buffer */
 345     *(p++) = (gint16) amplitude;
 346
 347     (rtpdtmfdepay->sample)++;
 348   }
 349 }
 350
 351
 352 static GstBuffer *
 353 gst_rtp_dtmf_depay_process (GstBaseRTPDepayload * depayload, GstBuffer * buf)
 354 {
 355
 356   GstRtpDTMFDepay *rtpdtmfdepay = NULL;
 357   GstBuffer *outbuf = NULL;
 358   gint payload_len;
 359   guint8 *payload = NULL;
 360   guint32 timestamp;
 361   GstRTPDTMFPayload dtmf_payload;
 362   gboolean marker;
 363   GstStructure *structure = NULL;
 364   GstMessage *dtmf_message = NULL;
 365
 366   rtpdtmfdepay = GST_RTP_DTMF_DEPAY (depayload);
 367
 368   if (!gst_rtp_buffer_validate (buf))
 369     goto bad_packet;
 370
 371   payload_len = gst_rtp_buffer_get_payload_len (buf);
 372   payload = gst_rtp_buffer_get_payload (buf);
 373
 374   if (payload_len != sizeof (GstRTPDTMFPayload))
 375     goto bad_packet;
 376
 377   memcpy (&dtmf_payload, payload, sizeof (GstRTPDTMFPayload));
 378
 379   if (dtmf_payload.event > MAX_EVENT)
 380     goto bad_packet;
 381
 382
 383   marker = gst_rtp_buffer_get_marker (buf);
 384
 385   timestamp = gst_rtp_buffer_get_timestamp (buf);
 386
 387   dtmf_payload.duration = g_ntohs (dtmf_payload.duration);
 388
 389   /* clip to whole units of unit_time */
 390   if (rtpdtmfdepay->unit_time) {
 391     guint unit_time_clock =
 392         (rtpdtmfdepay->unit_time * depayload->clock_rate) / 1000;
 393     if (dtmf_payload.duration % unit_time_clock) {
 394       /* Make sure we don't overflow the duration */
 395       if (dtmf_payload.duration < G_MAXUINT16 - unit_time_clock)
 396         dtmf_payload.duration += unit_time_clock -
 397             (dtmf_payload.duration % unit_time_clock);
 398       else
 399         dtmf_payload.duration -= dtmf_payload.duration % unit_time_clock;
 400     }
 401   }
 402
 403   /* clip to max duration */
 404   if (rtpdtmfdepay->max_duration) {
 405     guint max_duration_clock =
 406         (rtpdtmfdepay->max_duration * depayload->clock_rate) / 1000;
 407
 408     if (max_duration_clock < G_MAXUINT16 &&
 409         dtmf_payload.duration > max_duration_clock)
 410       dtmf_payload.duration = max_duration_clock;
 411   }
 412
 413   GST_DEBUG_OBJECT (depayload, "Received new RTP DTMF packet : "
 414       "marker=%d - timestamp=%u - event=%d - duration=%d",
 415       marker, timestamp, dtmf_payload.event, dtmf_payload.duration);
 416
 417   GST_DEBUG_OBJECT (depayload,
 418       "Previous information : timestamp=%u - duration=%d",
 419       rtpdtmfdepay->previous_ts, rtpdtmfdepay->previous_duration);
 420
 421   /* First packet */
 422   if (marker || rtpdtmfdepay->previous_ts != timestamp) {
 423     rtpdtmfdepay->sample = 0;
 424     rtpdtmfdepay->previous_ts = timestamp;
 425     rtpdtmfdepay->previous_duration = dtmf_payload.duration;
 426     rtpdtmfdepay->first_gst_ts = GST_BUFFER_TIMESTAMP (buf);
 427
 428     structure = gst_structure_new ("dtmf-event",
 429         "number", G_TYPE_INT, dtmf_payload.event,
 430         "volume", G_TYPE_INT, dtmf_payload.volume,
 431         "type", G_TYPE_INT, 1, "method", G_TYPE_INT, 1, NULL);
 432     if (structure) {
 433       dtmf_message =
 434           gst_message_new_element (GST_OBJECT (depayload), structure);
 435       if (dtmf_message) {
 436         if (!gst_element_post_message (GST_ELEMENT (depayload), dtmf_message)) {
 437           GST_ERROR_OBJECT (depayload,
 438               "Unable to send dtmf-event message to bus");
 439         }
 440       } else {
 441         GST_ERROR_OBJECT (depayload, "Unable to create dtmf-event message");
 442       }
 443     } else {
 444       GST_ERROR_OBJECT (depayload, "Unable to create dtmf-event structure");
 445     }
 446   } else {
 447     guint16 duration = dtmf_payload.duration;
 448     dtmf_payload.duration -= rtpdtmfdepay->previous_duration;
 449     /* If late buffer, ignore */
 450     if (duration > rtpdtmfdepay->previous_duration)
 451       rtpdtmfdepay->previous_duration = duration;
 452   }
 453
 454   GST_DEBUG_OBJECT (depayload, "new previous duration : %d - new duration : %d"
 455       " - diff  : %d - clock rate : %d - timestamp : %llu",
 456       rtpdtmfdepay->previous_duration, dtmf_payload.duration,
 457       (rtpdtmfdepay->previous_duration - dtmf_payload.duration),
 458       depayload->clock_rate, GST_BUFFER_TIMESTAMP (buf));
 459
 460   /* If late or duplicate packet (like the redundant end packet). Ignore */
 461   if (dtmf_payload.duration > 0) {
 462     outbuf = gst_buffer_new ();
 463     gst_dtmf_src_generate_tone (rtpdtmfdepay, dtmf_payload, outbuf);
 464
 465
 466     GST_BUFFER_TIMESTAMP (outbuf) = rtpdtmfdepay->first_gst_ts +
 467         (rtpdtmfdepay->previous_duration - dtmf_payload.duration) *
 468         GST_SECOND / depayload->clock_rate;
 469     GST_BUFFER_OFFSET (outbuf) =
 470         (rtpdtmfdepay->previous_duration - dtmf_payload.duration) *
 471         GST_SECOND / depayload->clock_rate;
 472     GST_BUFFER_OFFSET_END (outbuf) = rtpdtmfdepay->previous_duration *
 473         GST_SECOND / depayload->clock_rate;
 474
 475     GST_DEBUG_OBJECT (depayload, "timestamp : %llu - time %" GST_TIME_FORMAT,
 476         GST_BUFFER_TIMESTAMP (buf), GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
 477
 478   }
 479
 480   return outbuf;
 481
 482
 483 bad_packet:
 484   GST_ELEMENT_WARNING (rtpdtmfdepay, STREAM, DECODE,
 485       ("Packet did not validate"), (NULL));
 486   return NULL;
 487 }
 488
 489 gboolean
 490 gst_rtp_dtmf_depay_plugin_init (GstPlugin * plugin)
 491 {
 492   return gst_element_register (plugin, "rtpdtmfdepay",
 493       GST_RANK_MARGINAL, GST_TYPE_RTP_DTMF_DEPAY);
 494 }