gst/rtp/gstrtpac3pay.c

   1 /* GStreamer
   2  * Copyright (C) <2010> 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., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 /**
  21  * SECTION:element-rtpac3pay
  22  * @see_also: rtpac3depay
  23  *
  24  * Payload AC3 audio into RTP packets according to RFC 4184.
  25  * For detailed information see: http://www.rfc-editor.org/rfc/rfc4184.txt
  26  *
  27  * <refsect2>
  28  * <title>Example pipeline</title>
  29  * |[
  30  * gst-launch-1.0 -v audiotestsrc ! avenc_ac3 ! rtpac3pay ! udpsink
  31  * ]| This example pipeline will encode and payload AC3 stream. Refer to
  32  * the rtpac3depay example to depayload and decode the RTP stream.
  33  * </refsect2>
  34  */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #  include "config.h"
  38 #endif
  39
  40 #include <string.h>
  41
  42 #include <gst/rtp/gstrtpbuffer.h>
  43 #include <gst/audio/audio.h>
  44
  45 #include "gstrtpac3pay.h"
  46 #include "gstrtputils.h"
  47
  48 GST_DEBUG_CATEGORY_STATIC (rtpac3pay_debug);
  49 #define GST_CAT_DEFAULT (rtpac3pay_debug)
  50
  51 static GstStaticPadTemplate gst_rtp_ac3_pay_sink_template =
  52     GST_STATIC_PAD_TEMPLATE ("sink",
  53     GST_PAD_SINK,
  54     GST_PAD_ALWAYS,
  55     GST_STATIC_CAPS ("audio/ac3; " "audio/x-ac3; ")
  56     );
  57
  58 static GstStaticPadTemplate gst_rtp_ac3_pay_src_template =
  59 GST_STATIC_PAD_TEMPLATE ("src",
  60     GST_PAD_SRC,
  61     GST_PAD_ALWAYS,
  62     GST_STATIC_CAPS ("application/x-rtp, "
  63         "media = (string) \"audio\", "
  64         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
  65         "clock-rate = (int) { 32000, 44100, 48000 }, "
  66         "encoding-name = (string) \"AC3\"")
  67     );
  68
  69 static void gst_rtp_ac3_pay_finalize (GObject * object);
  70
  71 static GstStateChangeReturn gst_rtp_ac3_pay_change_state (GstElement * element,
  72     GstStateChange transition);
  73
  74 static gboolean gst_rtp_ac3_pay_setcaps (GstRTPBasePayload * payload,
  75     GstCaps * caps);
  76 static gboolean gst_rtp_ac3_pay_sink_event (GstRTPBasePayload * payload,
  77     GstEvent * event);
  78 static GstFlowReturn gst_rtp_ac3_pay_flush (GstRtpAC3Pay * rtpac3pay);
  79 static GstFlowReturn gst_rtp_ac3_pay_handle_buffer (GstRTPBasePayload * payload,
  80     GstBuffer * buffer);
  81
  82 #define gst_rtp_ac3_pay_parent_class parent_class
  83 G_DEFINE_TYPE (GstRtpAC3Pay, gst_rtp_ac3_pay, GST_TYPE_RTP_BASE_PAYLOAD);
  84
  85 static void
  86 gst_rtp_ac3_pay_class_init (GstRtpAC3PayClass * klass)
  87 {
  88   GObjectClass *gobject_class;
  89   GstElementClass *gstelement_class;
  90   GstRTPBasePayloadClass *gstrtpbasepayload_class;
  91
  92   GST_DEBUG_CATEGORY_INIT (rtpac3pay_debug, "rtpac3pay", 0,
  93       "AC3 Audio RTP Depayloader");
  94
  95   gobject_class = (GObjectClass *) klass;
  96   gstelement_class = (GstElementClass *) klass;
  97   gstrtpbasepayload_class = (GstRTPBasePayloadClass *) klass;
  98
  99   gobject_class->finalize = gst_rtp_ac3_pay_finalize;
 100
 101   gstelement_class->change_state = gst_rtp_ac3_pay_change_state;
 102
 103   gst_element_class_add_static_pad_template (gstelement_class,
 104       &gst_rtp_ac3_pay_src_template);
 105   gst_element_class_add_static_pad_template (gstelement_class,
 106       &gst_rtp_ac3_pay_sink_template);
 107
 108   gst_element_class_set_static_metadata (gstelement_class,
 109       "RTP AC3 audio payloader", "Codec/Payloader/Network/RTP",
 110       "Payload AC3 audio as RTP packets (RFC 4184)",
 111       "Wim Taymans <wim.taymans@gmail.com>");
 112
 113   gstrtpbasepayload_class->set_caps = gst_rtp_ac3_pay_setcaps;
 114   gstrtpbasepayload_class->sink_event = gst_rtp_ac3_pay_sink_event;
 115   gstrtpbasepayload_class->handle_buffer = gst_rtp_ac3_pay_handle_buffer;
 116 }
 117
 118 static void
 119 gst_rtp_ac3_pay_init (GstRtpAC3Pay * rtpac3pay)
 120 {
 121   rtpac3pay->adapter = gst_adapter_new ();
 122 }
 123
 124 static void
 125 gst_rtp_ac3_pay_finalize (GObject * object)
 126 {
 127   GstRtpAC3Pay *rtpac3pay;
 128
 129   rtpac3pay = GST_RTP_AC3_PAY (object);
 130
 131   g_object_unref (rtpac3pay->adapter);
 132
 133   G_OBJECT_CLASS (parent_class)->finalize (object);
 134 }
 135
 136 static void
 137 gst_rtp_ac3_pay_reset (GstRtpAC3Pay * pay)
 138 {
 139   pay->first_ts = -1;
 140   pay->duration = 0;
 141   gst_adapter_clear (pay->adapter);
 142   GST_DEBUG_OBJECT (pay, "reset depayloader");
 143 }
 144
 145 static gboolean
 146 gst_rtp_ac3_pay_setcaps (GstRTPBasePayload * payload, GstCaps * caps)
 147 {
 148   gboolean res;
 149   gint rate;
 150   GstStructure *structure;
 151
 152   structure = gst_caps_get_structure (caps, 0);
 153
 154   if (!gst_structure_get_int (structure, "rate", &rate))
 155     rate = 90000;               /* default */
 156
 157   gst_rtp_base_payload_set_options (payload, "audio", TRUE, "AC3", rate);
 158   res = gst_rtp_base_payload_set_outcaps (payload, NULL);
 159
 160   return res;
 161 }
 162
 163 static gboolean
 164 gst_rtp_ac3_pay_sink_event (GstRTPBasePayload * payload, GstEvent * event)
 165 {
 166   gboolean res;
 167   GstRtpAC3Pay *rtpac3pay;
 168
 169   rtpac3pay = GST_RTP_AC3_PAY (payload);
 170
 171   switch (GST_EVENT_TYPE (event)) {
 172     case GST_EVENT_EOS:
 173       /* make sure we push the last packets in the adapter on EOS */
 174       gst_rtp_ac3_pay_flush (rtpac3pay);
 175       break;
 176     case GST_EVENT_FLUSH_STOP:
 177       gst_rtp_ac3_pay_reset (rtpac3pay);
 178       break;
 179     default:
 180       break;
 181   }
 182
 183   res = GST_RTP_BASE_PAYLOAD_CLASS (parent_class)->sink_event (payload, event);
 184
 185   return res;
 186 }
 187
 188 struct frmsize_s
 189 {
 190   guint16 bit_rate;
 191   guint16 frm_size[3];
 192 };
 193
 194 static const struct frmsize_s frmsizecod_tbl[] = {
 195   {32, {64, 69, 96}},
 196   {32, {64, 70, 96}},
 197   {40, {80, 87, 120}},
 198   {40, {80, 88, 120}},
 199   {48, {96, 104, 144}},
 200   {48, {96, 105, 144}},
 201   {56, {112, 121, 168}},
 202   {56, {112, 122, 168}},
 203   {64, {128, 139, 192}},
 204   {64, {128, 140, 192}},
 205   {80, {160, 174, 240}},
 206   {80, {160, 175, 240}},
 207   {96, {192, 208, 288}},
 208   {96, {192, 209, 288}},
 209   {112, {224, 243, 336}},
 210   {112, {224, 244, 336}},
 211   {128, {256, 278, 384}},
 212   {128, {256, 279, 384}},
 213   {160, {320, 348, 480}},
 214   {160, {320, 349, 480}},
 215   {192, {384, 417, 576}},
 216   {192, {384, 418, 576}},
 217   {224, {448, 487, 672}},
 218   {224, {448, 488, 672}},
 219   {256, {512, 557, 768}},
 220   {256, {512, 558, 768}},
 221   {320, {640, 696, 960}},
 222   {320, {640, 697, 960}},
 223   {384, {768, 835, 1152}},
 224   {384, {768, 836, 1152}},
 225   {448, {896, 975, 1344}},
 226   {448, {896, 976, 1344}},
 227   {512, {1024, 1114, 1536}},
 228   {512, {1024, 1115, 1536}},
 229   {576, {1152, 1253, 1728}},
 230   {576, {1152, 1254, 1728}},
 231   {640, {1280, 1393, 1920}},
 232   {640, {1280, 1394, 1920}}
 233 };
 234
 235 static GstFlowReturn
 236 gst_rtp_ac3_pay_flush (GstRtpAC3Pay * rtpac3pay)
 237 {
 238   guint avail, FT, NF, mtu;
 239   GstBuffer *outbuf;
 240   GstFlowReturn ret;
 241
 242   /* the data available in the adapter is either smaller
 243    * than the MTU or bigger. In the case it is smaller, the complete
 244    * adapter contents can be put in one packet. In the case the
 245    * adapter has more than one MTU, we need to split the AC3 data
 246    * over multiple packets. */
 247   avail = gst_adapter_available (rtpac3pay->adapter);
 248
 249   ret = GST_FLOW_OK;
 250
 251   FT = 0;
 252   /* number of frames */
 253   NF = rtpac3pay->NF;
 254
 255   mtu = GST_RTP_BASE_PAYLOAD_MTU (rtpac3pay);
 256
 257   GST_LOG_OBJECT (rtpac3pay, "flushing %u bytes", avail);
 258
 259   while (avail > 0) {
 260     guint towrite;
 261     guint8 *payload;
 262     guint payload_len;
 263     guint packet_len;
 264     GstRTPBuffer rtp = { NULL, };
 265     GstBuffer *payload_buffer;
 266
 267     /* this will be the total length of the packet */
 268     packet_len = gst_rtp_buffer_calc_packet_len (2 + avail, 0, 0);
 269
 270     /* fill one MTU or all available bytes */
 271     towrite = MIN (packet_len, mtu);
 272
 273     /* this is the payload length */
 274     payload_len = gst_rtp_buffer_calc_payload_len (towrite, 0, 0);
 275
 276     /* create buffer to hold the payload */
 277     outbuf = gst_rtp_buffer_new_allocate (2, 0, 0);
 278
 279     if (FT == 0) {
 280       /* check if it all fits */
 281       if (towrite < packet_len) {
 282         guint maxlen;
 283
 284         GST_LOG_OBJECT (rtpac3pay, "we need to fragment");
 285         /* check if we will be able to put at least 5/8th of the total
 286          * frame in this first frame. */
 287         if ((avail * 5) / 8 >= (payload_len - 2))
 288           FT = 1;
 289         else
 290           FT = 2;
 291         /* check how many fragments we will need */
 292         maxlen = gst_rtp_buffer_calc_payload_len (mtu - 2, 0, 0);
 293         NF = (avail + maxlen - 1) / maxlen;
 294       }
 295     } else if (FT != 3) {
 296       /* remaining fragment */
 297       FT = 3;
 298     }
 299
 300     /*
 301      *  0                   1
 302      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
 303      * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 304      * |    MBZ    | FT|       NF      |
 305      * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 306      *
 307      * FT: 0: one or more complete frames
 308      *     1: initial 5/8 fragment
 309      *     2: initial fragment not 5/8
 310      *     3: other fragment
 311      * NF: amount of frames if FT = 0, else number of fragments.
 312      */
 313     gst_rtp_buffer_map (outbuf, GST_MAP_WRITE, &rtp);
 314     GST_LOG_OBJECT (rtpac3pay, "FT %u, NF %u", FT, NF);
 315     payload = gst_rtp_buffer_get_payload (&rtp);
 316     payload[0] = (FT & 3);
 317     payload[1] = NF;
 318     payload_len -= 2;
 319
 320     if (avail == payload_len)
 321       gst_rtp_buffer_set_marker (&rtp, TRUE);
 322     gst_rtp_buffer_unmap (&rtp);
 323
 324     payload_buffer =
 325         gst_adapter_take_buffer_fast (rtpac3pay->adapter, payload_len);
 326
 327     gst_rtp_copy_audio_meta (rtpac3pay, outbuf, payload_buffer);
 328
 329     outbuf = gst_buffer_append (outbuf, payload_buffer);
 330
 331     avail -= payload_len;
 332
 333     GST_BUFFER_PTS (outbuf) = rtpac3pay->first_ts;
 334     GST_BUFFER_DURATION (outbuf) = rtpac3pay->duration;
 335
 336     ret = gst_rtp_base_payload_push (GST_RTP_BASE_PAYLOAD (rtpac3pay), outbuf);
 337   }
 338
 339   return ret;
 340 }
 341
 342 static GstFlowReturn
 343 gst_rtp_ac3_pay_handle_buffer (GstRTPBasePayload * basepayload,
 344     GstBuffer * buffer)
 345 {
 346   GstRtpAC3Pay *rtpac3pay;
 347   GstFlowReturn ret;
 348   gsize avail, left, NF;
 349   GstMapInfo map;
 350   guint8 *p;
 351   guint packet_len;
 352   GstClockTime duration, timestamp;
 353
 354   rtpac3pay = GST_RTP_AC3_PAY (basepayload);
 355
 356   gst_buffer_map (buffer, &map, GST_MAP_READ);
 357   duration = GST_BUFFER_DURATION (buffer);
 358   timestamp = GST_BUFFER_PTS (buffer);
 359
 360   if (GST_BUFFER_IS_DISCONT (buffer)) {
 361     GST_DEBUG_OBJECT (rtpac3pay, "DISCONT");
 362     gst_rtp_ac3_pay_reset (rtpac3pay);
 363   }
 364
 365   /* count the amount of incomming packets */
 366   NF = 0;
 367   left = map.size;
 368   p = map.data;
 369   while (TRUE) {
 370     guint bsid, fscod, frmsizecod, frame_size;
 371
 372     if (left < 6)
 373       break;
 374
 375     if (p[0] != 0x0b || p[1] != 0x77)
 376       break;
 377
 378     bsid = p[5] >> 3;
 379     if (bsid > 8)
 380       break;
 381
 382     frmsizecod = p[4] & 0x3f;
 383     fscod = p[4] >> 6;
 384
 385     GST_DEBUG_OBJECT (rtpac3pay, "fscod %u, %u", fscod, frmsizecod);
 386
 387     if (fscod >= 3 || frmsizecod >= 38)
 388       break;
 389
 390     frame_size = frmsizecod_tbl[frmsizecod].frm_size[fscod] * 2;
 391     if (frame_size > left)
 392       break;
 393
 394     NF++;
 395     GST_DEBUG_OBJECT (rtpac3pay, "found frame %" G_GSIZE_FORMAT " of size %u",
 396         NF, frame_size);
 397
 398     p += frame_size;
 399     left -= frame_size;
 400   }
 401   gst_buffer_unmap (buffer, &map);
 402   if (NF == 0)
 403     goto no_frames;
 404
 405   avail = gst_adapter_available (rtpac3pay->adapter);
 406
 407   /* get packet length of previous data and this new data,
 408    * payload length includes a 4 byte header */
 409   packet_len = gst_rtp_buffer_calc_packet_len (2 + avail + map.size, 0, 0);
 410
 411   /* if this buffer is going to overflow the packet, flush what we
 412    * have. */
 413   if (gst_rtp_base_payload_is_filled (basepayload,
 414           packet_len, rtpac3pay->duration + duration)) {
 415     ret = gst_rtp_ac3_pay_flush (rtpac3pay);
 416     avail = 0;
 417   } else {
 418     ret = GST_FLOW_OK;
 419   }
 420
 421   if (avail == 0) {
 422     GST_DEBUG_OBJECT (rtpac3pay,
 423         "first packet, save timestamp %" GST_TIME_FORMAT,
 424         GST_TIME_ARGS (timestamp));
 425     rtpac3pay->first_ts = timestamp;
 426     rtpac3pay->duration = 0;
 427     rtpac3pay->NF = 0;
 428   }
 429
 430   gst_adapter_push (rtpac3pay->adapter, buffer);
 431   rtpac3pay->duration += duration;
 432   rtpac3pay->NF += NF;
 433
 434   return ret;
 435
 436   /* ERRORS */
 437 no_frames:
 438   {
 439     GST_WARNING_OBJECT (rtpac3pay, "no valid AC3 frames found");
 440     return GST_FLOW_OK;
 441   }
 442 }
 443
 444 static GstStateChangeReturn
 445 gst_rtp_ac3_pay_change_state (GstElement * element, GstStateChange transition)
 446 {
 447   GstRtpAC3Pay *rtpac3pay;
 448   GstStateChangeReturn ret;
 449
 450   rtpac3pay = GST_RTP_AC3_PAY (element);
 451
 452   switch (transition) {
 453     case GST_STATE_CHANGE_READY_TO_PAUSED:
 454       gst_rtp_ac3_pay_reset (rtpac3pay);
 455       break;
 456     default:
 457       break;
 458   }
 459
 460   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 461
 462   switch (transition) {
 463     case GST_STATE_CHANGE_PAUSED_TO_READY:
 464       gst_rtp_ac3_pay_reset (rtpac3pay);
 465       break;
 466     default:
 467       break;
 468   }
 469   return ret;
 470 }
 471
 472 gboolean
 473 gst_rtp_ac3_pay_plugin_init (GstPlugin * plugin)
 474 {
 475   return gst_element_register (plugin, "rtpac3pay",
 476       GST_RANK_SECONDARY, GST_TYPE_RTP_AC3_PAY);
 477 }