gst/rtp/gstrtpamrdepay.c

   1 /* GStreamer
   2  * Copyright (C) <2005> Wim Taymans <wim@fluendo.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more
  13  */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #  include "config.h"
  17 #endif
  18
  19 #include <gst/rtp/gstrtpbuffer.h>
  20
  21 #include <string.h>
  22 #include "gstrtpamrdec.h"
  23
  24 /* references:
  25  *
  26  * RFC 3267 - Real-Time Transport Protocol (RTP) Payload Format and File Storage Format
  27  *   for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate Wideband (AMR-WB) Audio
  28  *   Codecs.
  29  */
  30
  31 /* elementfactory information */
  32 static GstElementDetails gst_rtp_amrdec_details = {
  33   "RTP packet parser",
  34   "Codec/Parser/Network",
  35   "Extracts AMR audio from RTP packets (RFC 3267)",
  36   "Wim Taymans <wim@fluendo.com>"
  37 };
  38
  39 /* RtpAMRDec signals and args */
  40 enum
  41 {
  42   /* FILL ME */
  43   LAST_SIGNAL
  44 };
  45
  46 enum
  47 {
  48   ARG_0,
  49   ARG_FREQUENCY
  50 };
  51
  52 /* input is an RTP packet
  53  *
  54  * params see RFC 3267, section 8.1
  55  */
  56 static GstStaticPadTemplate gst_rtpamrdec_sink_template =
  57 GST_STATIC_PAD_TEMPLATE ("sink",
  58     GST_PAD_SINK,
  59     GST_PAD_ALWAYS,
  60     GST_STATIC_CAPS ("application/x-rtp, "
  61         "media = (string) \"audio\", "
  62         "payload = (int) [ 96, 255 ], "
  63         "clock-rate = (int) 8000, "
  64         "encoding-name = (string) \"AMR\", "
  65         "encoding-params = (string) \"1\", "
  66         "octet-align = (string) \"1\", "
  67         "crc = (string) { \"0\", \"1\" }, "
  68         "robust-sorting = (string) \"0\", " "interleaving = (string) \"0\""
  69         /* following options are not needed for a decoder
  70          *
  71          "mode-set = (int) [ 0, 7 ], "
  72          "mode-change-period = (int) [ 1, MAX ], "
  73          "mode-change-neighbor = (boolean) { TRUE, FALSE }, "
  74          "maxptime = (int) [ 20, MAX ], "
  75          "ptime = (int) [ 20, MAX ]"
  76          */
  77     )
  78     );
  79
  80 static GstStaticPadTemplate gst_rtpamrdec_src_template =
  81 GST_STATIC_PAD_TEMPLATE ("src",
  82     GST_PAD_SRC,
  83     GST_PAD_ALWAYS,
  84     GST_STATIC_CAPS ("audio/AMR, " "channels = (int) 1," "rate = (int) 8000")
  85     );
  86
  87 static void gst_rtpamrdec_class_init (GstRtpAMRDecClass * klass);
  88 static void gst_rtpamrdec_base_init (GstRtpAMRDecClass * klass);
  89 static void gst_rtpamrdec_init (GstRtpAMRDec * rtpamrdec);
  90
  91 static gboolean gst_rtpamrdec_sink_setcaps (GstPad * pad, GstCaps * caps);
  92 static GstFlowReturn gst_rtpamrdec_chain (GstPad * pad, GstBuffer * buffer);
  93
  94 static void gst_rtpamrdec_set_property (GObject * object, guint prop_id,
  95     const GValue * value, GParamSpec * pspec);
  96 static void gst_rtpamrdec_get_property (GObject * object, guint prop_id,
  97     GValue * value, GParamSpec * pspec);
  98
  99 static GstStateChangeReturn gst_rtpamrdec_change_state (GstElement * element,
 100     GstStateChange transition);
 101
 102 static GstElementClass *parent_class = NULL;
 103
 104 static GType
 105 gst_rtpamrdec_get_type (void)
 106 {
 107   static GType rtpamrdec_type = 0;
 108
 109   if (!rtpamrdec_type) {
 110     static const GTypeInfo rtpamrdec_info = {
 111       sizeof (GstRtpAMRDecClass),
 112       (GBaseInitFunc) gst_rtpamrdec_base_init,
 113       NULL,
 114       (GClassInitFunc) gst_rtpamrdec_class_init,
 115       NULL,
 116       NULL,
 117       sizeof (GstRtpAMRDec),
 118       0,
 119       (GInstanceInitFunc) gst_rtpamrdec_init,
 120     };
 121
 122     rtpamrdec_type =
 123         g_type_register_static (GST_TYPE_ELEMENT, "GstRtpAMRDec",
 124         &rtpamrdec_info, 0);
 125   }
 126   return rtpamrdec_type;
 127 }
 128
 129 static void
 130 gst_rtpamrdec_base_init (GstRtpAMRDecClass * klass)
 131 {
 132   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 133
 134   gst_element_class_add_pad_template (element_class,
 135       gst_static_pad_template_get (&gst_rtpamrdec_src_template));
 136   gst_element_class_add_pad_template (element_class,
 137       gst_static_pad_template_get (&gst_rtpamrdec_sink_template));
 138
 139   gst_element_class_set_details (element_class, &gst_rtp_amrdec_details);
 140 }
 141
 142 static void
 143 gst_rtpamrdec_class_init (GstRtpAMRDecClass * klass)
 144 {
 145   GObjectClass *gobject_class;
 146   GstElementClass *gstelement_class;
 147
 148   gobject_class = (GObjectClass *) klass;
 149   gstelement_class = (GstElementClass *) klass;
 150
 151   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
 152
 153   gobject_class->set_property = gst_rtpamrdec_set_property;
 154   gobject_class->get_property = gst_rtpamrdec_get_property;
 155
 156   gstelement_class->change_state = gst_rtpamrdec_change_state;
 157 }
 158
 159 static void
 160 gst_rtpamrdec_init (GstRtpAMRDec * rtpamrdec)
 161 {
 162   rtpamrdec->srcpad =
 163       gst_pad_new_from_template (gst_static_pad_template_get
 164       (&gst_rtpamrdec_src_template), "src");
 165
 166   gst_element_add_pad (GST_ELEMENT (rtpamrdec), rtpamrdec->srcpad);
 167
 168   rtpamrdec->sinkpad =
 169       gst_pad_new_from_template (gst_static_pad_template_get
 170       (&gst_rtpamrdec_sink_template), "sink");
 171   gst_pad_set_setcaps_function (rtpamrdec->sinkpad, gst_rtpamrdec_sink_setcaps);
 172   gst_pad_set_chain_function (rtpamrdec->sinkpad, gst_rtpamrdec_chain);
 173   gst_element_add_pad (GST_ELEMENT (rtpamrdec), rtpamrdec->sinkpad);
 174 }
 175
 176 static gboolean
 177 gst_rtpamrdec_sink_setcaps (GstPad * pad, GstCaps * caps)
 178 {
 179   GstStructure *structure;
 180   GstCaps *srccaps;
 181   GstRtpAMRDec *rtpamrdec;
 182   const gchar *params;
 183   const gchar *str;
 184
 185   rtpamrdec = GST_RTP_AMR_DEC (GST_OBJECT_PARENT (pad));
 186
 187   structure = gst_caps_get_structure (caps, 0);
 188
 189   if (!(str = gst_structure_get_string (structure, "octet-align")))
 190     rtpamrdec->octet_align = FALSE;
 191   else
 192     rtpamrdec->octet_align = (atoi (str) == 1);
 193
 194   if (!(str = gst_structure_get_string (structure, "crc")))
 195     rtpamrdec->crc = FALSE;
 196   else
 197     rtpamrdec->crc = (atoi (str) == 1);
 198
 199   if (rtpamrdec->crc) {
 200     /* crc mode implies octet aligned mode */
 201     rtpamrdec->octet_align = TRUE;
 202   }
 203
 204   if (!(str = gst_structure_get_string (structure, "robust-sorting")))
 205     rtpamrdec->robust_sorting = FALSE;
 206   else
 207     rtpamrdec->robust_sorting = (atoi (str) == 1);
 208
 209   if (rtpamrdec->robust_sorting) {
 210     /* robust_sorting mode implies octet aligned mode */
 211     rtpamrdec->octet_align = TRUE;
 212   }
 213
 214   if (!(str = gst_structure_get_string (structure, "interleaving")))
 215     rtpamrdec->interleaving = FALSE;
 216   else
 217     rtpamrdec->interleaving = (atoi (str) == 1);
 218
 219   if (rtpamrdec->interleaving) {
 220     /* interleaving mode implies octet aligned mode */
 221     rtpamrdec->octet_align = TRUE;
 222   }
 223
 224   if (!(params = gst_structure_get_string (structure, "encoding-params")))
 225     rtpamrdec->channels = 1;
 226   else {
 227     rtpamrdec->channels = atoi (params);
 228   }
 229
 230   if (!gst_structure_get_int (structure, "clock-rate", &rtpamrdec->rate))
 231     rtpamrdec->rate = 8000;
 232
 233   /* we require 1 channel, 8000 Hz, octet aligned, no CRC,
 234    * no robust sorting, no interleaving for now */
 235   if (rtpamrdec->channels != 1)
 236     return FALSE;
 237   if (rtpamrdec->rate != 8000)
 238     return FALSE;
 239   if (rtpamrdec->octet_align != TRUE)
 240     return FALSE;
 241   if (rtpamrdec->robust_sorting != FALSE)
 242     return FALSE;
 243   if (rtpamrdec->interleaving != FALSE)
 244     return FALSE;
 245
 246   srccaps = gst_caps_new_simple ("audio/AMR",
 247       "channels", G_TYPE_INT, rtpamrdec->channels,
 248       "rate", G_TYPE_INT, rtpamrdec->rate, NULL);
 249   gst_pad_set_caps (rtpamrdec->srcpad, srccaps);
 250   gst_caps_unref (srccaps);
 251
 252   rtpamrdec->negotiated = TRUE;
 253
 254   return TRUE;
 255 }
 256
 257 /* -1 is invalid */
 258 static gint frame_size[16] = {
 259   12, 13, 15, 17, 19, 20, 26, 31,
 260   5, -1, -1, -1, -1, -1, -1, 0
 261 };
 262
 263 static GstFlowReturn
 264 gst_rtpamrdec_chain (GstPad * pad, GstBuffer * buf)
 265 {
 266   GstRtpAMRDec *rtpamrdec;
 267   GstBuffer *outbuf;
 268   GstFlowReturn ret;
 269
 270   rtpamrdec = GST_RTP_AMR_DEC (GST_OBJECT_PARENT (pad));
 271
 272   if (!rtpamrdec->negotiated)
 273     goto not_negotiated;
 274
 275   if (!gst_rtpbuffer_validate (buf))
 276     goto bad_packet;
 277
 278   /* when we get here, 1 channel, 8000 Hz, octet aligned, no CRC,
 279    * no robust sorting, no interleaving data is to be parsed */
 280   {
 281     gint payload_len;
 282     guint8 *payload, *p, *dp;
 283     guint32 timestamp;
 284     guint8 CMR;
 285     gint i, num_packets, num_nonempty_packets;
 286     gint amr_len;
 287     gint ILL, ILP;
 288
 289     payload_len = gst_rtpbuffer_get_payload_len (buf);
 290
 291     /* need at least 2 bytes for the header */
 292     if (payload_len < 2)
 293       goto bad_packet;
 294
 295     payload = gst_rtpbuffer_get_payload (buf);
 296
 297     /* parse CMR. The CMR is used by the sender to request
 298      * a new encoding mode.
 299      *
 300      *  0 1 2 3 4 5 6 7
 301      * +-+-+-+-+-+-+-+-+
 302      * | CMR   |R|R|R|R|
 303      * +-+-+-+-+-+-+-+-+
 304      */
 305     CMR = (payload[0] & 0xf0) >> 4;
 306
 307     /* strip CMR header now, pack FT and the data for the decoder */
 308     payload_len -= 1;
 309     payload += 1;
 310
 311     if (rtpamrdec->interleaving) {
 312       ILL = (payload[0] & 0xf0) >> 4;
 313       ILP = (payload[0] & 0x0f);
 314
 315       payload_len -= 1;
 316       payload += 1;
 317
 318       if (ILP > ILL)
 319         goto bad_packet;
 320     }
 321
 322     /*
 323      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
 324      * +-+-+-+-+-+-+-+-+..
 325      * |F|  FT   |Q|P|P| more FT..
 326      * +-+-+-+-+-+-+-+-+..
 327      */
 328     /* count number of packets by counting the FTs. Also
 329      * count number of amr data bytes and number of non-empty
 330      * packets (this is also the number of CRCs if present). */
 331     amr_len = 0;
 332     num_nonempty_packets = 0;
 333     num_packets = 0;
 334     for (i = 0; i < payload_len; i++) {
 335       gint fr_size;
 336       guint8 FT;
 337
 338       FT = (payload[i] & 0x78) >> 3;
 339
 340       fr_size = frame_size[FT];
 341       if (fr_size == -1)
 342         goto bad_packet;
 343
 344       if (fr_size > 0) {
 345         amr_len += fr_size;
 346         num_nonempty_packets++;
 347       }
 348       num_packets++;
 349
 350       if ((payload[i] & 0x80) == 0)
 351         break;
 352     }
 353
 354     /* this is impossible */
 355     if (num_packets == payload_len)
 356       goto bad_packet;
 357
 358     if (rtpamrdec->crc) {
 359       /* data len + CRC len + header bytes should be smaller than payload_len */
 360       if (num_packets + num_nonempty_packets + amr_len > payload_len)
 361         goto bad_packet;
 362     } else {
 363       /* data len + header bytes should be smaller than payload_len */
 364       if (num_packets + amr_len > payload_len)
 365         goto bad_packet;
 366     }
 367
 368     timestamp = gst_rtpbuffer_get_timestamp (buf);
 369
 370     outbuf = gst_buffer_new_and_alloc (payload_len);
 371     GST_BUFFER_TIMESTAMP (outbuf) = timestamp * GST_SECOND / rtpamrdec->rate;
 372
 373     /* point to destination */
 374     p = GST_BUFFER_DATA (outbuf);
 375     /* point to first data packet */
 376     dp = payload + num_packets;
 377     if (rtpamrdec->crc) {
 378       /* skip CRC if present */
 379       dp += num_nonempty_packets;
 380     }
 381
 382     for (i = 0; i < num_packets; i++) {
 383       gint fr_size;
 384
 385       fr_size = frame_size[(payload[i] & 0x78) >> 3];
 386       if (fr_size > 0) {
 387         /* copy FT */
 388         *p++ = payload[i];
 389         /* copy data packet, FIXME, calc CRC here. */
 390         memcpy (p, dp, fr_size);
 391
 392         p += fr_size;
 393         dp += fr_size;
 394       }
 395     }
 396     gst_buffer_set_caps (outbuf, GST_PAD_CAPS (rtpamrdec->srcpad));
 397
 398     GST_DEBUG ("gst_rtpamrdec_chain: pushing buffer of size %d",
 399         GST_BUFFER_SIZE (outbuf));
 400     ret = gst_pad_push (rtpamrdec->srcpad, outbuf);
 401
 402     gst_buffer_unref (buf);
 403   }
 404
 405   return ret;
 406
 407 not_negotiated:
 408   {
 409     GST_ELEMENT_ERROR (rtpamrdec, STREAM, NOT_IMPLEMENTED,
 410         ("not negotiated"), (NULL));
 411     gst_buffer_unref (buf);
 412     return GST_FLOW_NOT_NEGOTIATED;
 413   }
 414 bad_packet:
 415   {
 416     GST_ELEMENT_WARNING (rtpamrdec, STREAM, DECODE,
 417         ("amr packet did not validate"), (NULL));
 418     gst_buffer_unref (buf);
 419     return GST_FLOW_OK;
 420   }
 421 }
 422
 423 static void
 424 gst_rtpamrdec_set_property (GObject * object, guint prop_id,
 425     const GValue * value, GParamSpec * pspec)
 426 {
 427   GstRtpAMRDec *rtpamrdec;
 428
 429   rtpamrdec = GST_RTP_AMR_DEC (object);
 430
 431   switch (prop_id) {
 432     default:
 433       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 434       break;
 435   }
 436 }
 437
 438 static void
 439 gst_rtpamrdec_get_property (GObject * object, guint prop_id, GValue * value,
 440     GParamSpec * pspec)
 441 {
 442   GstRtpAMRDec *rtpamrdec;
 443
 444   rtpamrdec = GST_RTP_AMR_DEC (object);
 445
 446   switch (prop_id) {
 447     default:
 448       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 449       break;
 450   }
 451 }
 452
 453 static GstStateChangeReturn
 454 gst_rtpamrdec_change_state (GstElement * element, GstStateChange transition)
 455 {
 456   GstRtpAMRDec *rtpamrdec;
 457   GstStateChangeReturn ret;
 458
 459   rtpamrdec = GST_RTP_AMR_DEC (element);
 460
 461   switch (transition) {
 462     case GST_STATE_CHANGE_NULL_TO_READY:
 463       break;
 464     case GST_STATE_CHANGE_READY_TO_PAUSED:
 465       break;
 466     default:
 467       break;
 468   }
 469
 470   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 471
 472   switch (transition) {
 473     case GST_STATE_CHANGE_READY_TO_NULL:
 474       break;
 475     default:
 476       break;
 477   }
 478   return ret;
 479 }
 480
 481 gboolean
 482 gst_rtpamrdec_plugin_init (GstPlugin * plugin)
 483 {
 484   return gst_element_register (plugin, "rtpamrdec",
 485       GST_RANK_NONE, GST_TYPE_RTP_AMR_DEC);
 486 }