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
 274 static gint wb_frame_size[16] = {
 275   17, 23, 32, 36, 40, 46, 50, 58,
 276   60, -1, -1, -1, -1, -1, -1, 0
 277 };
 278
 279 static GstBuffer *
 280 gst_rtp_amr_depay_process (GstBaseRTPDepayload * depayload, GstBuffer * buf)
 281 {
 282   GstRtpAMRDepay *rtpamrdepay;
 283   GstBuffer *outbuf = NULL;
 284   gint payload_len;
 285   gint *frame_size;
 286
 287   rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
 288
 289   /* setup frame size pointer */
 290   if (rtpamrdepay->mode == GST_RTP_AMR_DP_MODE_NB)
 291     frame_size = nb_frame_size;
 292   else
 293     frame_size = wb_frame_size;
 294
 295   /* when we get here, 1 channel, 8000/16000 Hz, octet aligned, no CRC,
 296    * no robust sorting, no interleaving data is to be depayloaded */
 297   {
 298     guint8 *payload, *p, *dp;
 299     guint8 CMR;
 300     gint i, num_packets, num_nonempty_packets;
 301     gint amr_len;
 302     gint ILL, ILP;
 303
 304     payload_len = gst_rtp_buffer_get_payload_len (buf);
 305
 306     /* need at least 2 bytes for the header */
 307     if (payload_len < 2)
 308       goto too_small;
 309
 310     payload = gst_rtp_buffer_get_payload (buf);
 311
 312     /* depay CMR. The CMR is used by the sender to request
 313      * a new encoding mode.
 314      *
 315      *  0 1 2 3 4 5 6 7
 316      * +-+-+-+-+-+-+-+-+
 317      * | CMR   |R|R|R|R|
 318      * +-+-+-+-+-+-+-+-+
 319      */
 320     CMR = (payload[0] & 0xf0) >> 4;
 321
 322     /* strip CMR header now, pack FT and the data for the decoder */
 323     payload_len -= 1;
 324     payload += 1;
 325
 326     GST_DEBUG_OBJECT (rtpamrdepay, "payload len %d", payload_len);
 327
 328     if (rtpamrdepay->interleaving) {
 329       ILL = (payload[0] & 0xf0) >> 4;
 330       ILP = (payload[0] & 0x0f);
 331
 332       payload_len -= 1;
 333       payload += 1;
 334
 335       if (ILP > ILL)
 336         goto wrong_interleaving;
 337     }
 338
 339     /*
 340      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
 341      * +-+-+-+-+-+-+-+-+..
 342      * |F|  FT   |Q|P|P| more FT..
 343      * +-+-+-+-+-+-+-+-+..
 344      */
 345     /* count number of packets by counting the FTs. Also
 346      * count number of amr data bytes and number of non-empty
 347      * packets (this is also the number of CRCs if present). */
 348     amr_len = 0;
 349     num_nonempty_packets = 0;
 350     num_packets = 0;
 351     for (i = 0; i < payload_len; i++) {
 352       gint fr_size;
 353       guint8 FT;
 354
 355       FT = (payload[i] & 0x78) >> 3;
 356
 357       fr_size = frame_size[FT];
 358       GST_DEBUG_OBJECT (rtpamrdepay, "frame size %d", fr_size);
 359       if (fr_size == -1)
 360         goto wrong_framesize;
 361
 362       if (fr_size > 0) {
 363         amr_len += fr_size;
 364         num_nonempty_packets++;
 365       }
 366       num_packets++;
 367
 368       if ((payload[i] & 0x80) == 0)
 369         break;
 370     }
 371
 372     if (rtpamrdepay->crc) {
 373       /* data len + CRC len + header bytes should be smaller than payload_len */
 374       if (num_packets + num_nonempty_packets + amr_len > payload_len)
 375         goto wrong_length_1;
 376     } else {
 377       /* data len + header bytes should be smaller than payload_len */
 378       if (num_packets + amr_len > payload_len)
 379         goto wrong_length_2;
 380     }
 381
 382     outbuf = gst_buffer_new_and_alloc (payload_len);
 383
 384     /* point to destination */
 385     p = GST_BUFFER_DATA (outbuf);
 386     /* point to first data packet */
 387     dp = payload + num_packets;
 388     if (rtpamrdepay->crc) {
 389       /* skip CRC if present */
 390       dp += num_nonempty_packets;
 391     }
 392
 393     for (i = 0; i < num_packets; i++) {
 394       gint fr_size;
 395
 396       /* copy FT, clear F bit */
 397       *p++ = payload[i] & 0x7f;
 398
 399       fr_size = frame_size[(payload[i] & 0x78) >> 3];
 400       if (fr_size > 0) {
 401         /* copy data packet, FIXME, calc CRC here. */
 402         memcpy (p, dp, fr_size);
 403
 404         p += fr_size;
 405         dp += fr_size;
 406       }
 407     }
 408     /* we can set the duration because each packet is 20 milliseconds */
 409     GST_BUFFER_DURATION (outbuf) = num_packets * 20 * GST_MSECOND;
 410
 411     if (gst_rtp_buffer_get_marker (buf)) {
 412       /* marker bit marks a discont buffer after a talkspurt. */
 413       GST_DEBUG_OBJECT (depayload, "marker bit was set");
 414       GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
 415     }
 416
 417     GST_DEBUG_OBJECT (depayload, "pushing buffer of size %d",
 418         GST_BUFFER_SIZE (outbuf));
 419   }
 420   return outbuf;
 421
 422   /* ERRORS */
 423 too_small:
 424   {
 425     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 426         (NULL), ("AMR RTP payload too small (%d)", payload_len));
 427     goto bad_packet;
 428   }
 429 wrong_interleaving:
 430   {
 431     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 432         (NULL), ("AMR RTP wrong interleaving"));
 433     goto bad_packet;
 434   }
 435 wrong_framesize:
 436   {
 437     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 438         (NULL), ("AMR RTP frame size == -1"));
 439     goto bad_packet;
 440   }
 441 wrong_length_1:
 442   {
 443     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 444         (NULL), ("AMR RTP wrong length 1"));
 445     goto bad_packet;
 446   }
 447 wrong_length_2:
 448   {
 449     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 450         (NULL), ("AMR RTP wrong length 2"));
 451     goto bad_packet;
 452   }
 453 bad_packet:
 454   {
 455     /* no fatal error */
 456     return NULL;
 457   }
 458 }
 459
 460 gboolean
 461 gst_rtp_amr_depay_plugin_init (GstPlugin * plugin)
 462 {
 463   return gst_element_register (plugin, "rtpamrdepay",
 464       GST_RANK_MARGINAL, GST_TYPE_RTP_AMR_DEPAY);
 465 }