gst/rtp/gstrtpamrdepay.c

   1 /* GStreamer
   2  * Copyright (C) <2005> Wim Taymans <wim.taymans@gmail.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 details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #endif
  23
  24 #include <gst/rtp/gstrtpbuffer.h>
  25
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include "gstrtpamrdepay.h"
  29
  30 GST_DEBUG_CATEGORY_STATIC (rtpamrdepay_debug);
  31 #define GST_CAT_DEFAULT (rtpamrdepay_debug)
  32
  33 /* references:
  34  *
  35  * RFC 3267 - Real-Time Transport Protocol (RTP) Payload Format and File
  36  * Storage Format for the Adaptive Multi-Rate (AMR) and Adaptive Multi-Rate
  37  * Wideband (AMR-WB) Audio Codecs.
  38  */
  39
  40 /* elementfactory information */
  41 static const GstElementDetails gst_rtp_amrdepay_details =
  42 GST_ELEMENT_DETAILS ("RTP AMR depayloader",
  43     "Codec/Depayloader/Network",
  44     "Extracts AMR or AMR-WB audio from RTP packets (RFC 3267)",
  45     "Wim Taymans <wim.taymans@gmail.com>");
  46
  47 /* RtpAMRDepay signals and args */
  48 enum
  49 {
  50   /* FILL ME */
  51   LAST_SIGNAL
  52 };
  53
  54 enum
  55 {
  56   ARG_0
  57 };
  58
  59 /* input is an RTP packet
  60  *
  61  * params see RFC 3267, section 8.1
  62  */
  63 static GstStaticPadTemplate gst_rtp_amr_depay_sink_template =
  64     GST_STATIC_PAD_TEMPLATE ("sink",
  65     GST_PAD_SINK,
  66     GST_PAD_ALWAYS,
  67     GST_STATIC_CAPS ("application/x-rtp, "
  68         "media = (string) \"audio\", "
  69         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
  70         "clock-rate = (int) 8000, "
  71         "encoding-name = (string) \"AMR\", "
  72         "encoding-params = (string) \"1\", "
  73         /* NOTE that all values must be strings in orde to be able to do SDP <->
  74          * GstCaps mapping. */
  75         "octet-align = (string) \"1\", "
  76         "crc = (string) { \"0\", \"1\" }, "
  77         "robust-sorting = (string) \"0\", " "interleaving = (string) \"0\";"
  78         /* following options are not needed for a decoder
  79          *
  80          "mode-set = (int) [ 0, 7 ], "
  81          "mode-change-period = (int) [ 1, MAX ], "
  82          "mode-change-neighbor = (boolean) { TRUE, FALSE }, "
  83          "maxptime = (int) [ 20, MAX ], "
  84          "ptime = (int) [ 20, MAX ]"
  85          */
  86         "application/x-rtp, "
  87         "media = (string) \"audio\", "
  88         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
  89         "clock-rate = (int) 16000, "
  90         "encoding-name = (string) \"AMR-WB\", "
  91         "encoding-params = (string) \"1\", "
  92         /* NOTE that all values must be strings in orde to be able to do SDP <->
  93          * GstCaps mapping. */
  94         "octet-align = (string) \"1\", "
  95         "crc = (string) { \"0\", \"1\" }, "
  96         "robust-sorting = (string) \"0\", " "interleaving = (string) \"0\""
  97         /* following options are not needed for a decoder
  98          *
  99          "mode-set = (int) [ 0, 7 ], "
 100          "mode-change-period = (int) [ 1, MAX ], "
 101          "mode-change-neighbor = (boolean) { TRUE, FALSE }, "
 102          "maxptime = (int) [ 20, MAX ], "
 103          "ptime = (int) [ 20, MAX ]"
 104          */
 105     )
 106     );
 107
 108 static GstStaticPadTemplate gst_rtp_amr_depay_src_template =
 109     GST_STATIC_PAD_TEMPLATE ("src",
 110     GST_PAD_SRC,
 111     GST_PAD_ALWAYS,
 112     GST_STATIC_CAPS ("audio/AMR, " "channels = (int) 1," "rate = (int) 8000;"
 113         "audio/AMR-WB, " "channels = (int) 1," "rate = (int) 16000")
 114     );
 115
 116 static gboolean gst_rtp_amr_depay_setcaps (GstBaseRTPDepayload * depayload,
 117     GstCaps * caps);
 118 static GstBuffer *gst_rtp_amr_depay_process (GstBaseRTPDepayload * depayload,
 119     GstBuffer * buf);
 120
 121 GST_BOILERPLATE (GstRtpAMRDepay, gst_rtp_amr_depay, GstBaseRTPDepayload,
 122     GST_TYPE_BASE_RTP_DEPAYLOAD);
 123
 124 static void
 125 gst_rtp_amr_depay_base_init (gpointer klass)
 126 {
 127   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 128
 129   gst_element_class_add_pad_template (element_class,
 130       gst_static_pad_template_get (&gst_rtp_amr_depay_src_template));
 131   gst_element_class_add_pad_template (element_class,
 132       gst_static_pad_template_get (&gst_rtp_amr_depay_sink_template));
 133
 134   gst_element_class_set_details (element_class, &gst_rtp_amrdepay_details);
 135 }
 136
 137 static void
 138 gst_rtp_amr_depay_class_init (GstRtpAMRDepayClass * klass)
 139 {
 140   GstBaseRTPDepayloadClass *gstbasertpdepayload_class;
 141
 142   gstbasertpdepayload_class = (GstBaseRTPDepayloadClass *) klass;
 143
 144   parent_class = g_type_class_peek_parent (klass);
 145
 146   gstbasertpdepayload_class->process = gst_rtp_amr_depay_process;
 147   gstbasertpdepayload_class->set_caps = gst_rtp_amr_depay_setcaps;
 148
 149   GST_DEBUG_CATEGORY_INIT (rtpamrdepay_debug, "rtpamrdepay", 0,
 150       "AMR/AMR-WB RTP Depayloader");
 151 }
 152
 153 static void
 154 gst_rtp_amr_depay_init (GstRtpAMRDepay * rtpamrdepay,
 155     GstRtpAMRDepayClass * klass)
 156 {
 157   GstBaseRTPDepayload *depayload;
 158
 159   depayload = GST_BASE_RTP_DEPAYLOAD (rtpamrdepay);
 160
 161   gst_pad_use_fixed_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload));
 162 }
 163
 164 static gboolean
 165 gst_rtp_amr_depay_setcaps (GstBaseRTPDepayload * depayload, GstCaps * caps)
 166 {
 167   GstStructure *structure;
 168   GstCaps *srccaps;
 169   GstRtpAMRDepay *rtpamrdepay;
 170   const gchar *params;
 171   const gchar *str, *type;
 172   gint clock_rate, need_clock_rate;
 173   gboolean res;
 174
 175   rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
 176
 177   structure = gst_caps_get_structure (caps, 0);
 178
 179   /* figure out the mode first and set the clock rates */
 180   if ((str = gst_structure_get_string (structure, "encoding-name"))) {
 181     if (strcmp (str, "AMR") == 0) {
 182       rtpamrdepay->mode = GST_RTP_AMR_DP_MODE_NB;
 183       need_clock_rate = 8000;
 184       type = "audio/AMR";
 185     } else if (strcmp (str, "AMR-WB") == 0) {
 186       rtpamrdepay->mode = GST_RTP_AMR_DP_MODE_WB;
 187       need_clock_rate = 16000;
 188       type = "audio/AMR-WB";
 189     } else
 190       goto invalid_mode;
 191   } else
 192     goto invalid_mode;
 193
 194   if (!(str = gst_structure_get_string (structure, "octet-align")))
 195     rtpamrdepay->octet_align = FALSE;
 196   else
 197     rtpamrdepay->octet_align = (atoi (str) == 1);
 198
 199   if (!(str = gst_structure_get_string (structure, "crc")))
 200     rtpamrdepay->crc = FALSE;
 201   else
 202     rtpamrdepay->crc = (atoi (str) == 1);
 203
 204   if (rtpamrdepay->crc) {
 205     /* crc mode implies octet aligned mode */
 206     rtpamrdepay->octet_align = TRUE;
 207   }
 208
 209   if (!(str = gst_structure_get_string (structure, "robust-sorting")))
 210     rtpamrdepay->robust_sorting = FALSE;
 211   else
 212     rtpamrdepay->robust_sorting = (atoi (str) == 1);
 213
 214   if (rtpamrdepay->robust_sorting) {
 215     /* robust_sorting mode implies octet aligned mode */
 216     rtpamrdepay->octet_align = TRUE;
 217   }
 218
 219   if (!(str = gst_structure_get_string (structure, "interleaving")))
 220     rtpamrdepay->interleaving = FALSE;
 221   else
 222     rtpamrdepay->interleaving = (atoi (str) == 1);
 223
 224   if (rtpamrdepay->interleaving) {
 225     /* interleaving mode implies octet aligned mode */
 226     rtpamrdepay->octet_align = TRUE;
 227   }
 228
 229   if (!(params = gst_structure_get_string (structure, "encoding-params")))
 230     rtpamrdepay->channels = 1;
 231   else {
 232     rtpamrdepay->channels = atoi (params);
 233   }
 234
 235   if (!gst_structure_get_int (structure, "clock-rate", &clock_rate))
 236     clock_rate = need_clock_rate;
 237   depayload->clock_rate = clock_rate;
 238
 239   /* we require 1 channel, 8000 Hz, octet aligned, no CRC,
 240    * no robust sorting, no interleaving for now */
 241   if (rtpamrdepay->channels != 1)
 242     return FALSE;
 243   if (clock_rate != need_clock_rate)
 244     return FALSE;
 245   if (rtpamrdepay->octet_align != TRUE)
 246     return FALSE;
 247   if (rtpamrdepay->robust_sorting != FALSE)
 248     return FALSE;
 249   if (rtpamrdepay->interleaving != FALSE)
 250     return FALSE;
 251
 252   srccaps = gst_caps_new_simple (type,
 253       "channels", G_TYPE_INT, rtpamrdepay->channels,
 254       "rate", G_TYPE_INT, clock_rate, NULL);
 255   res = gst_pad_set_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload), srccaps);
 256   gst_caps_unref (srccaps);
 257
 258   return res;
 259
 260   /* ERRORS */
 261 invalid_mode:
 262   {
 263     GST_ERROR_OBJECT (rtpamrdepay, "invalid encoding-name");
 264     return FALSE;
 265   }
 266 }
 267
 268 /* -1 is invalid */
 269 static gint nb_frame_size[16] = {
 270   12, 13, 15, 17, 19, 20, 26, 31,
 271   5, -1, -1, -1, -1, -1, -1, 0
 272 };
 273 static gint wb_frame_size[16] = {
 274   17, 23, 32, 36, 40, 46, 50, 58,
 275   60, -1, -1, -1, -1, -1, -1, 0
 276 };
 277
 278 static GstBuffer *
 279 gst_rtp_amr_depay_process (GstBaseRTPDepayload * depayload, GstBuffer * buf)
 280 {
 281   GstRtpAMRDepay *rtpamrdepay;
 282   GstBuffer *outbuf = NULL;
 283   gint payload_len;
 284   gint *frame_size;
 285
 286   rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
 287
 288   /* setup frame size pointer */
 289   if (rtpamrdepay->mode == GST_RTP_AMR_DP_MODE_NB)
 290     frame_size = nb_frame_size;
 291   else
 292     frame_size = wb_frame_size;
 293
 294   /* when we get here, 1 channel, 8000/16000 Hz, octet aligned, no CRC,
 295    * no robust sorting, no interleaving data is to be depayloaded */
 296   {
 297     guint8 *payload, *p, *dp;
 298     guint8 CMR;
 299     gint i, num_packets, num_nonempty_packets;
 300     gint amr_len;
 301     gint ILL, ILP;
 302     gboolean marker;
 303
 304     marker = gst_rtp_buffer_get_marker (buf);
 305     payload_len = gst_rtp_buffer_get_payload_len (buf);
 306
 307     /* need at least 2 bytes for the header */
 308     if (payload_len < 2)
 309       goto too_small;
 310
 311     payload = gst_rtp_buffer_get_payload (buf);
 312
 313     /* depay CMR. The CMR is used by the sender to request
 314      * a new encoding mode.
 315      *
 316      *  0 1 2 3 4 5 6 7
 317      * +-+-+-+-+-+-+-+-+
 318      * | CMR   |R|R|R|R|
 319      * +-+-+-+-+-+-+-+-+
 320      */
 321     CMR = (payload[0] & 0xf0) >> 4;
 322
 323     /* strip CMR header now, pack FT and the data for the decoder */
 324     payload_len -= 1;
 325     payload += 1;
 326
 327     GST_DEBUG_OBJECT (rtpamrdepay, "payload len %d", payload_len);
 328
 329     if (rtpamrdepay->interleaving) {
 330       ILL = (payload[0] & 0xf0) >> 4;
 331       ILP = (payload[0] & 0x0f);
 332
 333       payload_len -= 1;
 334       payload += 1;
 335
 336       if (ILP > ILL)
 337         goto wrong_interleaving;
 338     }
 339
 340     /*
 341      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
 342      * +-+-+-+-+-+-+-+-+..
 343      * |F|  FT   |Q|P|P| more FT..
 344      * +-+-+-+-+-+-+-+-+..
 345      */
 346     /* count number of packets by counting the FTs. Also
 347      * count number of amr data bytes and number of non-empty
 348      * packets (this is also the number of CRCs if present). */
 349     amr_len = 0;
 350     num_nonempty_packets = 0;
 351     num_packets = 0;
 352     for (i = 0; i < payload_len; i++) {
 353       gint fr_size;
 354       guint8 FT;
 355
 356       FT = (payload[i] & 0x78) >> 3;
 357
 358       fr_size = frame_size[FT];
 359       GST_DEBUG_OBJECT (rtpamrdepay, "frame size %d", fr_size);
 360       if (fr_size == -1)
 361         goto wrong_framesize;
 362
 363       if (fr_size > 0) {
 364         amr_len += fr_size;
 365         num_nonempty_packets++;
 366       }
 367       num_packets++;
 368
 369       if ((payload[i] & 0x80) == 0)
 370         break;
 371     }
 372
 373     if (rtpamrdepay->crc) {
 374       /* data len + CRC len + header bytes should be smaller than payload_len */
 375       if (num_packets + num_nonempty_packets + amr_len > payload_len)
 376         goto wrong_length_1;
 377     } else {
 378       /* data len + header bytes should be smaller than payload_len */
 379       if (num_packets + amr_len > payload_len)
 380         goto wrong_length_2;
 381     }
 382
 383     outbuf = gst_buffer_new_and_alloc (payload_len);
 384
 385     /* point to destination */
 386     p = GST_BUFFER_DATA (outbuf);
 387     /* point to first data packet */
 388     dp = payload + num_packets;
 389     if (rtpamrdepay->crc) {
 390       /* skip CRC if present */
 391       dp += num_nonempty_packets;
 392     }
 393
 394     for (i = 0; i < num_packets; i++) {
 395       gint fr_size;
 396
 397       /* copy FT, clear F bit */
 398       *p++ = payload[i] & 0x7f;
 399
 400       fr_size = frame_size[(payload[i] & 0x78) >> 3];
 401       if (fr_size > 0) {
 402         /* copy data packet, FIXME, calc CRC here. */
 403         memcpy (p, dp, fr_size);
 404
 405         p += fr_size;
 406         dp += fr_size;
 407       }
 408     }
 409     /* we can set the duration because each packet is 20 milliseconds */
 410     GST_BUFFER_DURATION (outbuf) = num_packets * 20 * GST_MSECOND;
 411
 412     if (marker) {
 413       /* marker bit marks a discont buffer after a talkspurt. */
 414       GST_DEBUG_OBJECT (depayload, "marker bit was set");
 415       GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
 416       marker = FALSE;
 417     }
 418
 419     GST_DEBUG_OBJECT (depayload, "pushing buffer of size %d",
 420         GST_BUFFER_SIZE (outbuf));
 421   }
 422   return outbuf;
 423
 424   /* ERRORS */
 425 too_small:
 426   {
 427     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 428         (NULL), ("AMR RTP payload too small (%d)", payload_len));
 429     goto bad_packet;
 430   }
 431 wrong_interleaving:
 432   {
 433     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 434         (NULL), ("AMR RTP wrong interleaving"));
 435     goto bad_packet;
 436   }
 437 wrong_framesize:
 438   {
 439     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 440         (NULL), ("AMR RTP frame size == -1"));
 441     goto bad_packet;
 442   }
 443 wrong_length_1:
 444   {
 445     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 446         (NULL), ("AMR RTP wrong length 1"));
 447     goto bad_packet;
 448   }
 449 wrong_length_2:
 450   {
 451     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 452         (NULL), ("AMR RTP wrong length 2"));
 453     goto bad_packet;
 454   }
 455 bad_packet:
 456   {
 457     /* no fatal error */
 458     return NULL;
 459   }
 460 }
 461
 462 gboolean
 463 gst_rtp_amr_depay_plugin_init (GstPlugin * plugin)
 464 {
 465   return gst_element_register (plugin, "rtpamrdepay",
 466       GST_RANK_MARGINAL, GST_TYPE_RTP_AMR_DEPAY);
 467 }