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