gst/rtp/gstrtph263ppay.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 <string.h>
  25
  26 #include <gst/rtp/gstrtpbuffer.h>
  27
  28 #include "gstrtph263ppay.h"
  29
  30 #define DEFAULT_FRAGMENTATION_MODE   GST_FRAGMENTATION_MODE_NORMAL
  31
  32 enum
  33 {
  34   PROP_0,
  35   PROP_FRAGMENTATION_MODE
  36 };
  37
  38 #define GST_TYPE_FRAGMENTATION_MODE (gst_fragmentation_mode_get_type())
  39 static GType
  40 gst_fragmentation_mode_get_type (void)
  41 {
  42   static GType fragmentation_mode_type = 0;
  43   static const GEnumValue fragmentation_mode[] = {
  44     {GST_FRAGMENTATION_MODE_NORMAL, "Normal", "normal"},
  45     {GST_FRAGMENTATION_MODE_SYNC, "Fragment at sync points", "sync"},
  46     {0, NULL, NULL},
  47   };
  48
  49   if (!fragmentation_mode_type) {
  50     fragmentation_mode_type =
  51         g_enum_register_static ("GstFragmentationMode", fragmentation_mode);
  52   }
  53   return fragmentation_mode_type;
  54 }
  55
  56
  57 GST_DEBUG_CATEGORY_STATIC (rtph263ppay_debug);
  58 #define GST_CAT_DEFAULT rtph263ppay_debug
  59
  60 /* elementfactory information */
  61 static const GstElementDetails gst_rtp_h263ppay_details =
  62 GST_ELEMENT_DETAILS ("RTP H263 payloader",
  63     "Codec/Payloader/Network",
  64     "Payload-encodes H263/+/++ video in RTP packets (RFC 4629)",
  65     "Wim Taymans <wim.taymans@gmail.com>");
  66
  67 static GstStaticPadTemplate gst_rtp_h263p_pay_sink_template =
  68 GST_STATIC_PAD_TEMPLATE ("sink",
  69     GST_PAD_SINK,
  70     GST_PAD_ALWAYS,
  71     GST_STATIC_CAPS ("video/x-h263, " "variant = (string) \"itu\" ")
  72     );
  73
  74 static GstStaticPadTemplate gst_rtp_h263p_pay_src_template =
  75     GST_STATIC_PAD_TEMPLATE ("src",
  76     GST_PAD_SRC,
  77     GST_PAD_ALWAYS,
  78     GST_STATIC_CAPS ("application/x-rtp, "
  79         "media = (string) \"video\", "
  80         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
  81         "clock-rate = (int) 90000, " "encoding-name = (string) \"H263-1998\"; "
  82         "application/x-rtp, "
  83         "media = (string) \"video\", "
  84         "payload = (int) " GST_RTP_PAYLOAD_DYNAMIC_STRING ", "
  85         "clock-rate = (int) 90000, " "encoding-name = (string) \"H263-2000\"")
  86     );
  87
  88 static void gst_rtp_h263p_pay_class_init (GstRtpH263PPayClass * klass);
  89 static void gst_rtp_h263p_pay_base_init (GstRtpH263PPayClass * klass);
  90 static void gst_rtp_h263p_pay_init (GstRtpH263PPay * rtph263ppay);
  91 static void gst_rtp_h263p_pay_finalize (GObject * object);
  92
  93 static void gst_rtp_h263p_pay_set_property (GObject * object, guint prop_id,
  94     const GValue * value, GParamSpec * pspec);
  95 static void gst_rtp_h263p_pay_get_property (GObject * object, guint prop_id,
  96     GValue * value, GParamSpec * pspec);
  97
  98 static gboolean gst_rtp_h263p_pay_setcaps (GstBaseRTPPayload * payload,
  99     GstCaps * caps);
 100 static GstFlowReturn gst_rtp_h263p_pay_handle_buffer (GstBaseRTPPayload *
 101     payload, GstBuffer * buffer);
 102
 103 static GstBaseRTPPayloadClass *parent_class = NULL;
 104
 105 static GType
 106 gst_rtp_h263p_pay_get_type (void)
 107 {
 108   static GType rtph263ppay_type = 0;
 109
 110   if (!rtph263ppay_type) {
 111     static const GTypeInfo rtph263ppay_info = {
 112       sizeof (GstRtpH263PPayClass),
 113       (GBaseInitFunc) gst_rtp_h263p_pay_base_init,
 114       NULL,
 115       (GClassInitFunc) gst_rtp_h263p_pay_class_init,
 116       NULL,
 117       NULL,
 118       sizeof (GstRtpH263PPay),
 119       0,
 120       (GInstanceInitFunc) gst_rtp_h263p_pay_init,
 121     };
 122
 123     rtph263ppay_type =
 124         g_type_register_static (GST_TYPE_BASE_RTP_PAYLOAD, "GstRtpH263PPay",
 125         &rtph263ppay_info, 0);
 126   }
 127   return rtph263ppay_type;
 128 }
 129
 130 static void
 131 gst_rtp_h263p_pay_base_init (GstRtpH263PPayClass * klass)
 132 {
 133   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 134
 135   gst_element_class_add_pad_template (element_class,
 136       gst_static_pad_template_get (&gst_rtp_h263p_pay_src_template));
 137   gst_element_class_add_pad_template (element_class,
 138       gst_static_pad_template_get (&gst_rtp_h263p_pay_sink_template));
 139
 140   gst_element_class_set_details (element_class, &gst_rtp_h263ppay_details);
 141 }
 142
 143 static void
 144 gst_rtp_h263p_pay_class_init (GstRtpH263PPayClass * klass)
 145 {
 146   GObjectClass *gobject_class;
 147   GstElementClass *gstelement_class;
 148   GstBaseRTPPayloadClass *gstbasertppayload_class;
 149
 150   gobject_class = (GObjectClass *) klass;
 151   gstelement_class = (GstElementClass *) klass;
 152   gstbasertppayload_class = (GstBaseRTPPayloadClass *) klass;
 153
 154   parent_class = g_type_class_peek_parent (klass);
 155
 156   gobject_class->finalize = gst_rtp_h263p_pay_finalize;
 157   gobject_class->set_property = gst_rtp_h263p_pay_set_property;
 158   gobject_class->get_property = gst_rtp_h263p_pay_get_property;
 159
 160   gstbasertppayload_class->set_caps = gst_rtp_h263p_pay_setcaps;
 161   gstbasertppayload_class->handle_buffer = gst_rtp_h263p_pay_handle_buffer;
 162
 163   g_object_class_install_property (G_OBJECT_CLASS (klass),
 164       PROP_FRAGMENTATION_MODE, g_param_spec_enum ("fragmentation-mode",
 165           "Fragmentation Mode",
 166           "Packet Fragmentation Mode", GST_TYPE_FRAGMENTATION_MODE,
 167           DEFAULT_FRAGMENTATION_MODE, G_PARAM_READWRITE));
 168
 169   GST_DEBUG_CATEGORY_INIT (rtph263ppay_debug, "rtph263ppay",
 170       0, "rtph263ppay (RFC 4629)");
 171 }
 172
 173 static void
 174 gst_rtp_h263p_pay_init (GstRtpH263PPay * rtph263ppay)
 175 {
 176   rtph263ppay->adapter = gst_adapter_new ();
 177
 178   rtph263ppay->fragmentation_mode = DEFAULT_FRAGMENTATION_MODE;
 179 }
 180
 181 static void
 182 gst_rtp_h263p_pay_finalize (GObject * object)
 183 {
 184   GstRtpH263PPay *rtph263ppay;
 185
 186   rtph263ppay = GST_RTP_H263P_PAY (object);
 187
 188   g_object_unref (rtph263ppay->adapter);
 189   rtph263ppay->adapter = NULL;
 190
 191   G_OBJECT_CLASS (parent_class)->finalize (object);
 192 }
 193
 194 static gboolean
 195 gst_rtp_h263p_pay_setcaps (GstBaseRTPPayload * payload, GstCaps * caps)
 196 {
 197   gboolean res;
 198
 199   gst_basertppayload_set_options (payload, "video", TRUE, "H263-1998", 90000);
 200   res = gst_basertppayload_set_outcaps (payload, NULL);
 201
 202   return res;
 203 }
 204
 205 static void
 206 gst_rtp_h263p_pay_set_property (GObject * object, guint prop_id,
 207     const GValue * value, GParamSpec * pspec)
 208 {
 209   GstRtpH263PPay *rtph263ppay;
 210
 211   rtph263ppay = GST_RTP_H263P_PAY (object);
 212
 213   switch (prop_id) {
 214     case PROP_FRAGMENTATION_MODE:
 215       rtph263ppay->fragmentation_mode = g_value_get_enum (value);
 216       break;
 217     default:
 218       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 219       break;
 220   }
 221 }
 222
 223 static void
 224 gst_rtp_h263p_pay_get_property (GObject * object, guint prop_id,
 225     GValue * value, GParamSpec * pspec)
 226 {
 227   GstRtpH263PPay *rtph263ppay;
 228
 229   rtph263ppay = GST_RTP_H263P_PAY (object);
 230
 231   switch (prop_id) {
 232     case PROP_FRAGMENTATION_MODE:
 233       g_value_set_enum (value, rtph263ppay->fragmentation_mode);
 234       break;
 235     default:
 236       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 237       break;
 238   }
 239 }
 240
 241 static GstFlowReturn
 242 gst_rtp_h263p_pay_flush (GstRtpH263PPay * rtph263ppay)
 243 {
 244   guint avail;
 245   GstBuffer *outbuf;
 246   GstFlowReturn ret;
 247   gboolean fragmented;
 248
 249   avail = gst_adapter_available (rtph263ppay->adapter);
 250   if (avail == 0)
 251     return GST_FLOW_OK;
 252
 253   fragmented = FALSE;
 254   /* This algorithm assumes the H263/+/++ encoder sends complete frames in each
 255    * buffer */
 256   /* With Fragmentation Mode at GST_FRAGMENTATION_MODE_NORMAL:
 257    *  This algorithm implements the Follow-on packets method for packetization.
 258    *  This assumes low packet loss network.
 259    * With Fragmentation Mode at GST_FRAGMENTATION_MODE_SYNC:
 260    *  This algorithm separates large frames at synchronisation points (Segments)
 261    *  (See RFC 4629 section 6). It would be interesting to have a property such as network
 262    *  quality to select between both packetization methods */
 263   /* TODO Add VRC supprt (See RFC 4629 section 5.2) */
 264
 265   while (avail > 0) {
 266     guint towrite;
 267     guint8 *payload;
 268     guint8 *data;
 269     guint payload_len;
 270     gint header_len;
 271     guint next_gop = 0;
 272     gboolean found_gob = FALSE;
 273
 274     if (rtph263ppay->fragmentation_mode == GST_FRAGMENTATION_MODE_SYNC) {
 275       /* start after 1st gop possible */
 276       guint parsed_len = 3;
 277       const guint8 *parse_data = NULL;
 278
 279       parse_data = gst_adapter_peek (rtph263ppay->adapter, avail);
 280
 281       /* Check if we have a gob or eos , eossbs */
 282       /* FIXME EOS and EOSSBS packets should never contain any gobs and vice-versa */
 283       if (avail >= 3 && *parse_data == 0 && *(parse_data + 1) == 0
 284           && *(parse_data + 2) >= 0x80) {
 285         GST_DEBUG_OBJECT (rtph263ppay, " Found GOB header");
 286         found_gob = TRUE;
 287       }
 288       /* Find next and cut the packet accordingly */
 289       /* TODO we should get as many gobs as possible until MTU is reached, this
 290        * code seems to just get one GOB per packet */
 291       while (parsed_len + 2 < avail) {
 292         if (parse_data[parsed_len] == 0 && parse_data[parsed_len + 1] == 0
 293             && parse_data[parsed_len + 2] >= 0x80) {
 294           next_gop = parsed_len;
 295           GST_DEBUG_OBJECT (rtph263ppay, " Next GOB Detected at :  %d",
 296               next_gop);
 297           break;
 298         }
 299         parsed_len++;
 300       }
 301     }
 302
 303     /* for picture start frames (non-fragmented), we need to remove the first
 304      * two 0x00 bytes and set P=1 */
 305     header_len = (fragmented && !found_gob) ? 2 : 0;
 306
 307     towrite = MIN (avail, gst_rtp_buffer_calc_payload_len
 308         (GST_BASE_RTP_PAYLOAD_MTU (rtph263ppay) - header_len, 0, 0));
 309
 310     if (next_gop > 0)
 311       towrite = MIN (next_gop, towrite);
 312
 313     payload_len = header_len + towrite;
 314
 315     outbuf = gst_rtp_buffer_new_allocate (payload_len, 0, 0);
 316     /* last fragment gets the marker bit set */
 317     gst_rtp_buffer_set_marker (outbuf, avail > towrite ? 0 : 1);
 318
 319     payload = gst_rtp_buffer_get_payload (outbuf);
 320
 321     data = (guint8 *) gst_adapter_peek (rtph263ppay->adapter, towrite);
 322     memcpy (&payload[header_len], data, towrite);
 323
 324     /*  0                   1
 325      *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
 326      * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 327      * |   RR    |P|V|   PLEN    |PEBIT|
 328      * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 329      */
 330     /* if fragmented or gop header , write p bit =1 */
 331     payload[0] = (fragmented && !found_gob) ? 0x00 : 0x04;
 332     payload[1] = 0;
 333
 334     GST_BUFFER_TIMESTAMP (outbuf) = rtph263ppay->first_timestamp;
 335     GST_BUFFER_DURATION (outbuf) = rtph263ppay->first_duration;
 336
 337     gst_adapter_flush (rtph263ppay->adapter, towrite);
 338
 339     ret = gst_basertppayload_push (GST_BASE_RTP_PAYLOAD (rtph263ppay), outbuf);
 340
 341     avail -= towrite;
 342     fragmented = TRUE;
 343   }
 344
 345   return ret;
 346 }
 347
 348 static GstFlowReturn
 349 gst_rtp_h263p_pay_handle_buffer (GstBaseRTPPayload * payload,
 350     GstBuffer * buffer)
 351 {
 352   GstRtpH263PPay *rtph263ppay;
 353   GstFlowReturn ret;
 354   guint size;
 355
 356   rtph263ppay = GST_RTP_H263P_PAY (payload);
 357
 358   size = GST_BUFFER_SIZE (buffer);
 359   rtph263ppay->first_timestamp = GST_BUFFER_TIMESTAMP (buffer);
 360   rtph263ppay->first_duration = GST_BUFFER_DURATION (buffer);
 361
 362   /* we always encode and flush a full picture */
 363   gst_adapter_push (rtph263ppay->adapter, buffer);
 364   ret = gst_rtp_h263p_pay_flush (rtph263ppay);
 365
 366   return ret;
 367 }
 368
 369 gboolean
 370 gst_rtp_h263p_pay_plugin_init (GstPlugin * plugin)
 371 {
 372   return gst_element_register (plugin, "rtph263ppay",
 373       GST_RANK_NONE, GST_TYPE_RTP_H263P_PAY);
 374 }