gst/rtp/gstrtpvp8pay.c

   1 /*
   2  * gstrtpvp8pay.c - Source for GstRtpVP8Pay
   3  * Copyright (C) 2011 Sjoerd Simons <sjoerd@luon.net>
   4  * Copyright (C) 2011 Collabora Ltd.
   5  *   Contact: Youness Alaoui <youness.alaoui@collabora.co.uk>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include <gst/base/gstbitreader.h>
  31 #include <gst/rtp/gstrtppayloads.h>
  32 #include <gst/rtp/gstrtpbuffer.h>
  33 #include "dboolhuff.h"
  34 #include "gstrtpvp8pay.h"
  35
  36 GST_DEBUG_CATEGORY_STATIC (gst_rtp_vp8_pay_debug);
  37 #define GST_CAT_DEFAULT gst_rtp_vp8_pay_debug
  38
  39 #define DEFAULT_PICTURE_ID_MODE VP8_PAY_NO_PICTURE_ID
  40
  41 enum
  42 {
  43   PROP_0,
  44   PROP_PICTURE_ID_MODE
  45 };
  46
  47 #define GST_TYPE_RTP_VP8_PAY_PICTURE_ID_MODE (gst_rtp_vp8_pay_picture_id_mode_get_type())
  48 static GType
  49 gst_rtp_vp8_pay_picture_id_mode_get_type (void)
  50 {
  51   static GType mode_type = 0;
  52   static const GEnumValue modes[] = {
  53     {VP8_PAY_NO_PICTURE_ID, "No Picture ID", "none"},
  54     {VP8_PAY_PICTURE_ID_7BITS, "7-bit Picture ID", "7-bit"},
  55     {VP8_PAY_PICTURE_ID_15BITS, "15-bit Picture ID", "15-bit"},
  56     {0, NULL, NULL},
  57   };
  58
  59   if (!mode_type) {
  60     mode_type = g_enum_register_static ("GstVP8RTPPayMode", modes);
  61   }
  62   return mode_type;
  63 }
  64
  65 static void gst_rtp_vp8_pay_get_property (GObject * object, guint prop_id,
  66     GValue * value, GParamSpec * pspec);
  67 static void gst_rtp_vp8_pay_set_property (GObject * object, guint prop_id,
  68     const GValue * value, GParamSpec * pspec);
  69
  70 static GstFlowReturn gst_rtp_vp8_pay_handle_buffer (GstRTPBasePayload * payload,
  71     GstBuffer * buffer);
  72 static gboolean gst_rtp_vp8_pay_sink_event (GstRTPBasePayload * payload,
  73     GstEvent * event);
  74 static gboolean gst_rtp_vp8_pay_set_caps (GstRTPBasePayload * payload,
  75     GstCaps * caps);
  76
  77 G_DEFINE_TYPE (GstRtpVP8Pay, gst_rtp_vp8_pay, GST_TYPE_RTP_BASE_PAYLOAD);
  78
  79 static GstStaticPadTemplate gst_rtp_vp8_pay_src_template =
  80 GST_STATIC_PAD_TEMPLATE ("src",
  81     GST_PAD_SRC,
  82     GST_PAD_ALWAYS,
  83     GST_STATIC_CAPS ("application/x-rtp, "
  84         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ","
  85         "clock-rate = (int) 90000, encoding-name = (string) \"VP8-DRAFT-IETF-01\""));
  86
  87 static GstStaticPadTemplate gst_rtp_vp8_pay_sink_template =
  88 GST_STATIC_PAD_TEMPLATE ("sink",
  89     GST_PAD_SINK,
  90     GST_PAD_ALWAYS,
  91     GST_STATIC_CAPS ("video/x-vp8"));
  92
  93 static void
  94 gst_rtp_vp8_pay_init (GstRtpVP8Pay * obj)
  95 {
  96   obj->picture_id_mode = DEFAULT_PICTURE_ID_MODE;
  97   if (obj->picture_id_mode == VP8_PAY_PICTURE_ID_7BITS)
  98     obj->picture_id = g_random_int_range (0, G_MAXUINT8) & 0x7F;
  99   else if (obj->picture_id_mode == VP8_PAY_PICTURE_ID_15BITS)
 100     obj->picture_id = g_random_int_range (0, G_MAXUINT16) & 0x7FFF;
 101 }
 102
 103 static void
 104 gst_rtp_vp8_pay_class_init (GstRtpVP8PayClass * gst_rtp_vp8_pay_class)
 105 {
 106   GObjectClass *gobject_class = G_OBJECT_CLASS (gst_rtp_vp8_pay_class);
 107   GstElementClass *element_class = GST_ELEMENT_CLASS (gst_rtp_vp8_pay_class);
 108   GstRTPBasePayloadClass *pay_class =
 109       GST_RTP_BASE_PAYLOAD_CLASS (gst_rtp_vp8_pay_class);
 110
 111   gobject_class->set_property = gst_rtp_vp8_pay_set_property;
 112   gobject_class->get_property = gst_rtp_vp8_pay_get_property;
 113
 114   g_object_class_install_property (gobject_class, PROP_PICTURE_ID_MODE,
 115       g_param_spec_enum ("picture-id-mode", "Picture ID Mode",
 116           "The picture ID mode for payloading",
 117           GST_TYPE_RTP_VP8_PAY_PICTURE_ID_MODE, DEFAULT_PICTURE_ID_MODE,
 118           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 119
 120   gst_element_class_add_pad_template (element_class,
 121       gst_static_pad_template_get (&gst_rtp_vp8_pay_sink_template));
 122   gst_element_class_add_pad_template (element_class,
 123       gst_static_pad_template_get (&gst_rtp_vp8_pay_src_template));
 124
 125   gst_element_class_set_static_metadata (element_class, "RTP VP8 payloader",
 126       "Codec/Payloader/Network/RTP",
 127       "Puts VP8 video in RTP packets)", "Sjoerd Simons <sjoerd@luon.net>");
 128
 129   pay_class->handle_buffer = gst_rtp_vp8_pay_handle_buffer;
 130   pay_class->sink_event = gst_rtp_vp8_pay_sink_event;
 131   pay_class->set_caps = gst_rtp_vp8_pay_set_caps;
 132
 133   GST_DEBUG_CATEGORY_INIT (gst_rtp_vp8_pay_debug, "rtpvp8pay", 0,
 134       "VP8 Video RTP Payloader");
 135 }
 136
 137 static void
 138 gst_rtp_vp8_pay_set_property (GObject * object,
 139     guint prop_id, const GValue * value, GParamSpec * pspec)
 140 {
 141   GstRtpVP8Pay *rtpvp8pay = GST_RTP_VP8_PAY (object);
 142
 143   switch (prop_id) {
 144     case PROP_PICTURE_ID_MODE:
 145       rtpvp8pay->picture_id_mode = g_value_get_enum (value);
 146       if (rtpvp8pay->picture_id_mode == VP8_PAY_PICTURE_ID_7BITS)
 147         rtpvp8pay->picture_id = g_random_int_range (0, G_MAXUINT8) & 0x7F;
 148       else if (rtpvp8pay->picture_id_mode == VP8_PAY_PICTURE_ID_15BITS)
 149         rtpvp8pay->picture_id = g_random_int_range (0, G_MAXUINT16) & 0x7FFF;
 150       break;
 151     default:
 152       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 153       break;
 154   }
 155 }
 156
 157 static void
 158 gst_rtp_vp8_pay_get_property (GObject * object,
 159     guint prop_id, GValue * value, GParamSpec * pspec)
 160 {
 161   GstRtpVP8Pay *rtpvp8pay = GST_RTP_VP8_PAY (object);
 162
 163   switch (prop_id) {
 164     case PROP_PICTURE_ID_MODE:
 165       g_value_set_enum (value, rtpvp8pay->picture_id_mode);
 166       break;
 167     default:
 168       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 169       break;
 170   }
 171 }
 172
 173 static gboolean
 174 gst_rtp_vp8_pay_parse_frame (GstRtpVP8Pay * self, GstBuffer * buffer,
 175     gsize buffer_size)
 176 {
 177   GstMapInfo map = GST_MAP_INFO_INIT;
 178   GstBitReader reader;
 179   guint8 *data;
 180   gsize size;
 181   int i;
 182   gboolean keyframe;
 183   guint32 partition0_size;
 184   guint8 version;
 185   guint8 tmp8 = 0;
 186   guint8 partitions;
 187   guint offset;
 188   BOOL_DECODER bc;
 189   guint8 *pdata;
 190
 191   if (G_UNLIKELY (buffer_size < 3))
 192     goto error;
 193
 194   if (!gst_buffer_map (buffer, &map, GST_MAP_READ) || !map.data)
 195     goto error;
 196
 197   data = map.data;
 198   size = map.size;
 199
 200   gst_bit_reader_init (&reader, data, size);
 201
 202   self->is_keyframe = keyframe = ((data[0] & 0x1) == 0);
 203   version = (data[0] >> 1) & 0x7;
 204
 205   if (G_UNLIKELY (version > 3)) {
 206     GST_ERROR_OBJECT (self, "Unknown VP8 version %u", version);
 207     goto error;
 208   }
 209
 210   /* keyframe, version and show_frame use 5 bits */
 211   partition0_size = data[2] << 11 | data[1] << 3 | (data[0] >> 5);
 212
 213   /* Include the uncompressed data blob in the first partition */
 214   offset = keyframe ? 10 : 3;
 215   partition0_size += offset;
 216
 217   if (!gst_bit_reader_skip (&reader, 24))
 218     goto error;
 219
 220   if (keyframe) {
 221     /* check start tag: 0x9d 0x01 0x2a */
 222     if (!gst_bit_reader_get_bits_uint8 (&reader, &tmp8, 8) || tmp8 != 0x9d)
 223       goto error;
 224
 225     if (!gst_bit_reader_get_bits_uint8 (&reader, &tmp8, 8) || tmp8 != 0x01)
 226       goto error;
 227
 228     if (!gst_bit_reader_get_bits_uint8 (&reader, &tmp8, 8) || tmp8 != 0x2a)
 229       goto error;
 230
 231     /* Skip horizontal size code (16 bits) vertical size code (16 bits) */
 232     if (!gst_bit_reader_skip (&reader, 32))
 233       goto error;
 234   }
 235
 236   offset = keyframe ? 10 : 3;
 237   vp8dx_start_decode (&bc, data + offset, size - offset);
 238
 239   if (keyframe) {
 240     /* color space (1 bit) and clamping type (1 bit) */
 241     vp8dx_decode_bool (&bc, 0x80);
 242     vp8dx_decode_bool (&bc, 0x80);
 243   }
 244
 245   /* segmentation_enabled */
 246   if (vp8dx_decode_bool (&bc, 0x80)) {
 247     guint8 update_mb_segmentation_map = vp8dx_decode_bool (&bc, 0x80);
 248     guint8 update_segment_feature_data = vp8dx_decode_bool (&bc, 0x80);
 249
 250     if (update_segment_feature_data) {
 251       /* skip segment feature mode */
 252       vp8dx_decode_bool (&bc, 0x80);
 253
 254       /* quantizer update */
 255       for (i = 0; i < 4; i++) {
 256         /* skip flagged quantizer value (7 bits) and sign (1 bit) */
 257         if (vp8dx_decode_bool (&bc, 0x80))
 258           vp8_decode_value (&bc, 8);
 259       }
 260
 261       /* loop filter update */
 262       for (i = 0; i < 4; i++) {
 263         /* skip flagged lf update value (6 bits) and sign (1 bit) */
 264         if (vp8dx_decode_bool (&bc, 0x80))
 265           vp8_decode_value (&bc, 7);
 266       }
 267     }
 268
 269     if (update_mb_segmentation_map) {
 270       /* segment prob update */
 271       for (i = 0; i < 3; i++) {
 272         /* skip flagged segment prob */
 273         if (vp8dx_decode_bool (&bc, 0x80))
 274           vp8_decode_value (&bc, 8);
 275       }
 276     }
 277   }
 278
 279   /* skip filter type (1 bit), loop filter level (6 bits) and
 280    * sharpness level (3 bits) */
 281   vp8_decode_value (&bc, 1);
 282   vp8_decode_value (&bc, 6);
 283   vp8_decode_value (&bc, 3);
 284
 285   /* loop_filter_adj_enabled */
 286   if (vp8dx_decode_bool (&bc, 0x80)) {
 287
 288     /* delta update */
 289     if (vp8dx_decode_bool (&bc, 0x80)) {
 290
 291       for (i = 0; i < 8; i++) {
 292         /* 8 updates, 1 bit indicate whether there is one and if follow by a
 293          * 7 bit update */
 294         if (vp8dx_decode_bool (&bc, 0x80))
 295           vp8_decode_value (&bc, 7);
 296       }
 297     }
 298   }
 299
 300   if (vp8dx_bool_error (&bc))
 301     goto error;
 302
 303   tmp8 = vp8_decode_value (&bc, 2);
 304
 305   partitions = 1 << tmp8;
 306
 307   /* Check if things are still sensible */
 308   if (partition0_size + (partitions - 1) * 3 >= size)
 309     goto error;
 310
 311   /* partition data is right after the mode partition */
 312   pdata = data + partition0_size;
 313
 314   /* Set up mapping */
 315   self->n_partitions = partitions + 1;
 316   self->partition_offset[0] = 0;
 317   self->partition_size[0] = partition0_size + (partitions - 1) * 3;
 318
 319   self->partition_offset[1] = self->partition_size[0];
 320   for (i = 1; i < partitions; i++) {
 321     guint psize = (pdata[2] << 16 | pdata[1] << 8 | pdata[0]);
 322
 323     pdata += 3;
 324     self->partition_size[i] = psize;
 325     self->partition_offset[i + 1] = self->partition_offset[i] + psize;
 326   }
 327
 328   /* Check that our partition offsets and sizes don't go outsize the buffer
 329    * size. */
 330   if (self->partition_offset[i] >= size)
 331     goto error;
 332
 333   self->partition_size[i] = size - self->partition_offset[i];
 334
 335   self->partition_offset[i + 1] = size;
 336
 337   gst_buffer_unmap (buffer, &map);
 338   return TRUE;
 339
 340 error:
 341   GST_DEBUG ("Failed to parse frame");
 342   if (map.memory != NULL) {
 343     gst_buffer_unmap (buffer, &map);
 344   }
 345   return FALSE;
 346 }
 347
 348 static guint
 349 gst_rtp_vp8_offset_to_partition (GstRtpVP8Pay * self, guint offset)
 350 {
 351   int i;
 352
 353   for (i = 0; i < self->n_partitions; i++) {
 354     if (offset >= self->partition_offset[i] &&
 355         offset < self->partition_offset[i + 1])
 356       return i;
 357   }
 358
 359   return i;
 360 }
 361
 362 static gsize
 363 gst_rtp_vp8_calc_header_len (GstRtpVP8Pay * self)
 364 {
 365   switch (self->picture_id_mode) {
 366     case VP8_PAY_PICTURE_ID_7BITS:
 367       return 3;
 368     case VP8_PAY_PICTURE_ID_15BITS:
 369       return 4;
 370     case VP8_PAY_NO_PICTURE_ID:
 371     default:
 372       return 1;
 373   }
 374 }
 375
 376 /* When growing the vp8 header keep max payload len calculation in sync */
 377 static GstBuffer *
 378 gst_rtp_vp8_create_header_buffer (GstRtpVP8Pay * self, guint8 partid,
 379     gboolean start, gboolean mark, GstBuffer * in)
 380 {
 381   GstBuffer *out;
 382   guint8 *p;
 383   GstRTPBuffer rtpbuffer = GST_RTP_BUFFER_INIT;
 384
 385   out = gst_rtp_buffer_new_allocate (gst_rtp_vp8_calc_header_len (self), 0, 0);
 386   gst_rtp_buffer_map (out, GST_MAP_READWRITE, &rtpbuffer);
 387   p = gst_rtp_buffer_get_payload (&rtpbuffer);
 388   /* X=0,R=0,N=0,S=start,PartID=partid */
 389   p[0] = (start << 4) | partid;
 390   if (self->picture_id_mode != VP8_PAY_NO_PICTURE_ID) {
 391     /* Enable X=1 */
 392     p[0] |= 0x80;
 393     /* X: I=1,L=0,T=0,K=0,RSV=0 */
 394     p[1] = 0x80;
 395     if (self->picture_id_mode == VP8_PAY_PICTURE_ID_7BITS) {
 396       /* I: 7 bit picture_id */
 397       p[2] = self->picture_id & 0x7F;
 398     } else {
 399       /* I: 15 bit picture_id */
 400       p[2] = 0x80 | ((self->picture_id & 0x7FFF) >> 8);
 401       p[3] = self->picture_id & 0xFF;
 402     }
 403   }
 404
 405   gst_rtp_buffer_set_marker (&rtpbuffer, mark);
 406
 407   gst_rtp_buffer_unmap (&rtpbuffer);
 408
 409   GST_BUFFER_DURATION (out) = GST_BUFFER_DURATION (in);
 410   GST_BUFFER_PTS (out) = GST_BUFFER_PTS (in);
 411
 412   return out;
 413 }
 414
 415
 416 static guint
 417 gst_rtp_vp8_payload_next (GstRtpVP8Pay * self, GstBufferList * list,
 418     guint offset, GstBuffer * buffer, gsize buffer_size, gsize max_payload_len)
 419 {
 420   guint partition;
 421   GstBuffer *header;
 422   GstBuffer *sub;
 423   GstBuffer *out;
 424   gboolean mark;
 425   gsize remaining;
 426   gsize available;
 427
 428   remaining = buffer_size - offset;
 429   available = max_payload_len;
 430   if (available > remaining)
 431     available = remaining;
 432
 433   partition = gst_rtp_vp8_offset_to_partition (self, offset);
 434   g_assert (partition < self->n_partitions);
 435
 436   mark = (remaining == available);
 437   /* whole set of partitions, payload them and done */
 438   header = gst_rtp_vp8_create_header_buffer (self, partition,
 439       offset == self->partition_offset[partition], mark, buffer);
 440   sub = gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, offset, available);
 441
 442   out = gst_buffer_append (header, sub);
 443
 444   gst_buffer_list_insert (list, -1, out);
 445
 446   return available;
 447 }
 448
 449
 450 static GstFlowReturn
 451 gst_rtp_vp8_pay_handle_buffer (GstRTPBasePayload * payload, GstBuffer * buffer)
 452 {
 453   GstRtpVP8Pay *self = GST_RTP_VP8_PAY (payload);
 454   GstFlowReturn ret;
 455   GstBufferList *list;
 456   gsize size, max_paylen;
 457   guint offset, mtu, vp8_hdr_len;
 458
 459   size = gst_buffer_get_size (buffer);
 460
 461   if (G_UNLIKELY (!gst_rtp_vp8_pay_parse_frame (self, buffer, size))) {
 462     GST_ELEMENT_ERROR (self, STREAM, ENCODE, (NULL),
 463         ("Failed to parse VP8 frame"));
 464     return GST_FLOW_ERROR;
 465   }
 466
 467   mtu = GST_RTP_BASE_PAYLOAD_MTU (payload);
 468   vp8_hdr_len = gst_rtp_vp8_calc_header_len (self);
 469   max_paylen = gst_rtp_buffer_calc_payload_len (mtu - vp8_hdr_len, 0, 0);
 470
 471   list = gst_buffer_list_new_sized ((size / max_paylen) + 1);
 472
 473   offset = 0;
 474   while (offset < size) {
 475     offset +=
 476         gst_rtp_vp8_payload_next (self, list, offset, buffer, size, max_paylen);
 477   }
 478
 479   ret = gst_rtp_base_payload_push_list (payload, list);
 480
 481   /* Incremenent and wrap the picture id if it overflows */
 482   if ((self->picture_id_mode == VP8_PAY_PICTURE_ID_7BITS &&
 483           ++self->picture_id >= 0x80) ||
 484       (self->picture_id_mode == VP8_PAY_PICTURE_ID_15BITS &&
 485           ++self->picture_id >= 0x8000))
 486     self->picture_id = 0;
 487
 488   gst_buffer_unref (buffer);
 489
 490   return ret;
 491 }
 492
 493 static gboolean
 494 gst_rtp_vp8_pay_sink_event (GstRTPBasePayload * payload, GstEvent * event)
 495 {
 496   GstRtpVP8Pay *self = GST_RTP_VP8_PAY (payload);
 497
 498   if (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_START) {
 499     if (self->picture_id_mode == VP8_PAY_PICTURE_ID_7BITS)
 500       self->picture_id = g_random_int_range (0, G_MAXUINT8) & 0x7F;
 501     else if (self->picture_id_mode == VP8_PAY_PICTURE_ID_15BITS)
 502       self->picture_id = g_random_int_range (0, G_MAXUINT16) & 0x7FFF;
 503   }
 504
 505   return GST_RTP_BASE_PAYLOAD_CLASS (gst_rtp_vp8_pay_parent_class)->sink_event
 506       (payload, event);
 507 }
 508
 509 static gboolean
 510 gst_rtp_vp8_pay_set_caps (GstRTPBasePayload * payload, GstCaps * caps)
 511 {
 512   gst_rtp_base_payload_set_options (payload, "video", TRUE,
 513       "VP8-DRAFT-IETF-01", 90000);
 514   return gst_rtp_base_payload_set_outcaps (payload, NULL);
 515 }
 516
 517 gboolean
 518 gst_rtp_vp8_pay_plugin_init (GstPlugin * plugin)
 519 {
 520   return gst_element_register (plugin, "rtpvp8pay",
 521       GST_RANK_MARGINAL, GST_TYPE_RTP_VP8_PAY);
 522 }