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   gst_pad_use_fixed_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload));
 140 }
 141
 142 static gboolean
 143 gst_rtp_amr_depay_setcaps (GstBaseRTPDepayload * depayload, GstCaps * caps)
 144 {
 145   GstStructure *structure;
 146   GstCaps *srccaps;
 147   GstRtpAMRDepay *rtpamrdepay;
 148   const gchar *params;
 149   const gchar *str;
 150   gint clock_rate = 8000;       /* default */
 151
 152   rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
 153
 154   structure = gst_caps_get_structure (caps, 0);
 155
 156   if (!(str = gst_structure_get_string (structure, "octet-align")))
 157     rtpamrdepay->octet_align = FALSE;
 158   else
 159     rtpamrdepay->octet_align = (atoi (str) == 1);
 160
 161   if (!(str = gst_structure_get_string (structure, "crc")))
 162     rtpamrdepay->crc = FALSE;
 163   else
 164     rtpamrdepay->crc = (atoi (str) == 1);
 165
 166   if (rtpamrdepay->crc) {
 167     /* crc mode implies octet aligned mode */
 168     rtpamrdepay->octet_align = TRUE;
 169   }
 170
 171   if (!(str = gst_structure_get_string (structure, "robust-sorting")))
 172     rtpamrdepay->robust_sorting = FALSE;
 173   else
 174     rtpamrdepay->robust_sorting = (atoi (str) == 1);
 175
 176   if (rtpamrdepay->robust_sorting) {
 177     /* robust_sorting mode implies octet aligned mode */
 178     rtpamrdepay->octet_align = TRUE;
 179   }
 180
 181   if (!(str = gst_structure_get_string (structure, "interleaving")))
 182     rtpamrdepay->interleaving = FALSE;
 183   else
 184     rtpamrdepay->interleaving = (atoi (str) == 1);
 185
 186   if (rtpamrdepay->interleaving) {
 187     /* interleaving mode implies octet aligned mode */
 188     rtpamrdepay->octet_align = TRUE;
 189   }
 190
 191   if (!(params = gst_structure_get_string (structure, "encoding-params")))
 192     rtpamrdepay->channels = 1;
 193   else {
 194     rtpamrdepay->channels = atoi (params);
 195   }
 196
 197   gst_structure_get_int (structure, "clock-rate", &clock_rate);
 198   depayload->clock_rate = clock_rate;
 199
 200   /* we require 1 channel, 8000 Hz, octet aligned, no CRC,
 201    * no robust sorting, no interleaving for now */
 202   if (rtpamrdepay->channels != 1)
 203     return FALSE;
 204   if (clock_rate != 8000)
 205     return FALSE;
 206   if (rtpamrdepay->octet_align != TRUE)
 207     return FALSE;
 208   if (rtpamrdepay->robust_sorting != FALSE)
 209     return FALSE;
 210   if (rtpamrdepay->interleaving != FALSE)
 211     return FALSE;
 212
 213   srccaps = gst_caps_new_simple ("audio/AMR",
 214       "channels", G_TYPE_INT, rtpamrdepay->channels,
 215       "rate", G_TYPE_INT, clock_rate, NULL);
 216   gst_pad_set_caps (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload), srccaps);
 217   gst_caps_unref (srccaps);
 218
 219   rtpamrdepay->negotiated = TRUE;
 220
 221   return TRUE;
 222 }
 223
 224 /* -1 is invalid */
 225 static gint frame_size[16] = {
 226   12, 13, 15, 17, 19, 20, 26, 31,
 227   5, -1, -1, -1, -1, -1, -1, 0
 228 };
 229
 230 static GstBuffer *
 231 gst_rtp_amr_depay_process (GstBaseRTPDepayload * depayload, GstBuffer * buf)
 232 {
 233   GstRtpAMRDepay *rtpamrdepay;
 234   GstBuffer *outbuf = NULL;
 235   gint payload_len;
 236
 237   rtpamrdepay = GST_RTP_AMR_DEPAY (depayload);
 238
 239   if (!rtpamrdepay->negotiated)
 240     goto not_negotiated;
 241
 242   if (!gst_rtp_buffer_validate (buf))
 243     goto invalid_packet;
 244
 245   /* when we get here, 1 channel, 8000 Hz, octet aligned, no CRC,
 246    * no robust sorting, no interleaving data is to be depayloaded */
 247   {
 248     guint8 *payload, *p, *dp;
 249     guint8 CMR;
 250     gint i, num_packets, num_nonempty_packets;
 251     gint amr_len;
 252     gint ILL, ILP;
 253
 254     payload_len = gst_rtp_buffer_get_payload_len (buf);
 255
 256     /* need at least 2 bytes for the header */
 257     if (payload_len < 2)
 258       goto too_small;
 259
 260     payload = gst_rtp_buffer_get_payload (buf);
 261
 262     /* depay CMR. The CMR is used by the sender to request
 263      * a new encoding mode.
 264      *
 265      *  0 1 2 3 4 5 6 7
 266      * +-+-+-+-+-+-+-+-+
 267      * | CMR   |R|R|R|R|
 268      * +-+-+-+-+-+-+-+-+
 269      */
 270     CMR = (payload[0] & 0xf0) >> 4;
 271
 272     /* strip CMR header now, pack FT and the data for the decoder */
 273     payload_len -= 1;
 274     payload += 1;
 275
 276     GST_DEBUG_OBJECT (rtpamrdepay, "payload len %d", payload_len);
 277
 278     if (rtpamrdepay->interleaving) {
 279       ILL = (payload[0] & 0xf0) >> 4;
 280       ILP = (payload[0] & 0x0f);
 281
 282       payload_len -= 1;
 283       payload += 1;
 284
 285       if (ILP > ILL)
 286         goto wrong_interleaving;
 287     }
 288
 289     /*
 290      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
 291      * +-+-+-+-+-+-+-+-+..
 292      * |F|  FT   |Q|P|P| more FT..
 293      * +-+-+-+-+-+-+-+-+..
 294      */
 295     /* count number of packets by counting the FTs. Also
 296      * count number of amr data bytes and number of non-empty
 297      * packets (this is also the number of CRCs if present). */
 298     amr_len = 0;
 299     num_nonempty_packets = 0;
 300     num_packets = 0;
 301     for (i = 0; i < payload_len; i++) {
 302       gint fr_size;
 303       guint8 FT;
 304
 305       FT = (payload[i] & 0x78) >> 3;
 306
 307       fr_size = frame_size[FT];
 308       GST_DEBUG_OBJECT (rtpamrdepay, "frame size %d", fr_size);
 309       if (fr_size == -1)
 310         goto wrong_framesize;
 311
 312       if (fr_size > 0) {
 313         amr_len += fr_size;
 314         num_nonempty_packets++;
 315       }
 316       num_packets++;
 317
 318       if ((payload[i] & 0x80) == 0)
 319         break;
 320     }
 321
 322     if (rtpamrdepay->crc) {
 323       /* data len + CRC len + header bytes should be smaller than payload_len */
 324       if (num_packets + num_nonempty_packets + amr_len > payload_len)
 325         goto wrong_length_1;
 326     } else {
 327       /* data len + header bytes should be smaller than payload_len */
 328       if (num_packets + amr_len > payload_len)
 329         goto wrong_length_2;
 330     }
 331
 332     outbuf = gst_buffer_new_and_alloc (payload_len);
 333
 334     /* point to destination */
 335     p = GST_BUFFER_DATA (outbuf);
 336     /* point to first data packet */
 337     dp = payload + num_packets;
 338     if (rtpamrdepay->crc) {
 339       /* skip CRC if present */
 340       dp += num_nonempty_packets;
 341     }
 342
 343     for (i = 0; i < num_packets; i++) {
 344       gint fr_size;
 345
 346       /* copy FT, clear F bit */
 347       *p++ = payload[i] & 0x7f;
 348
 349       fr_size = frame_size[(payload[i] & 0x78) >> 3];
 350       if (fr_size > 0) {
 351         /* copy data packet, FIXME, calc CRC here. */
 352         memcpy (p, dp, fr_size);
 353
 354         p += fr_size;
 355         dp += fr_size;
 356       }
 357     }
 358     gst_buffer_set_caps (outbuf,
 359         GST_PAD_CAPS (GST_BASE_RTP_DEPAYLOAD_SRCPAD (depayload)));
 360
 361     GST_DEBUG ("gst_rtp_amr_depay_chain: pushing buffer of size %d",
 362         GST_BUFFER_SIZE (outbuf));
 363   }
 364   return outbuf;
 365
 366   /* ERRORS */
 367 invalid_packet:
 368   {
 369     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 370         (NULL), ("AMR RTP packet did not validate"));
 371     goto bad_packet;
 372   }
 373 not_negotiated:
 374   {
 375     GST_ELEMENT_ERROR (rtpamrdepay, STREAM, NOT_IMPLEMENTED,
 376         (NULL), ("not negotiated"));
 377     return NULL;
 378   }
 379 too_small:
 380   {
 381     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 382         (NULL), ("AMR RTP payload too small (%d)", payload_len));
 383     goto bad_packet;
 384   }
 385 wrong_interleaving:
 386   {
 387     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 388         (NULL), ("AMR RTP wrong interleaving"));
 389     goto bad_packet;
 390   }
 391 wrong_framesize:
 392   {
 393     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 394         (NULL), ("AMR RTP frame size == -1"));
 395     goto bad_packet;
 396   }
 397 wrong_length_1:
 398   {
 399     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 400         (NULL), ("AMR RTP wrong length 1"));
 401     goto bad_packet;
 402   }
 403 wrong_length_2:
 404   {
 405     GST_ELEMENT_WARNING (rtpamrdepay, STREAM, DECODE,
 406         (NULL), ("AMR RTP wrong length 2"));
 407     goto bad_packet;
 408   }
 409 bad_packet:
 410   {
 411     /* no fatal error */
 412     return NULL;
 413   }
 414 }
 415
 416 gboolean
 417 gst_rtp_amr_depay_plugin_init (GstPlugin * plugin)
 418 {
 419   return gst_element_register (plugin, "rtpamrdepay",
 420       GST_RANK_MARGINAL, GST_TYPE_RTP_AMR_DEPAY);
 421 }