gst/gdp/gstgdpdepay.c

   1 /* GStreamer
   2  * Copyright (C) 2006 Thomas Vander Stichele <thomas at apestaart dot org>
   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 /**
  21  * SECTION:element-gdpdepay
  22  * @see_also: gdppay
  23  *
  24  * <refsect2>
  25  * <para>
  26  * This element depayloads GStreamer Data Protocol buffers back to deserialized
  27  * buffers and events.
  28  * </para>
  29  * <para>
  30  * <programlisting>
  31  * gst-launch -v -m filesrc location=test.gdp ! gdpdepay ! xvimagesink
  32  * </programlisting>
  33  * This pipeline plays back a serialized video stream as created in the
  34  * example for gdppay.
  35  * </para>
  36  * </refsect2>
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include <string.h>
  44
  45 #include <gst/dataprotocol/dataprotocol.h>
  46
  47 #include "gstgdpdepay.h"
  48
  49 /* elementfactory information */
  50 static const GstElementDetails gdp_depay_details =
  51 GST_ELEMENT_DETAILS ("GDP Depayloader",
  52     "GDP/Depayloader",
  53     "Depayloads GStreamer Data Protocol buffers",
  54     "Thomas Vander Stichele <thomas at apestaart dot org>");
  55
  56 enum
  57 {
  58   PROP_0,
  59   /* FILL ME */
  60 };
  61
  62 static GstStaticPadTemplate gdp_depay_sink_template =
  63 GST_STATIC_PAD_TEMPLATE ("sink",
  64     GST_PAD_SINK,
  65     GST_PAD_ALWAYS,
  66     GST_STATIC_CAPS ("application/x-gdp"));
  67
  68 static GstStaticPadTemplate gdp_depay_src_template =
  69 GST_STATIC_PAD_TEMPLATE ("src",
  70     GST_PAD_SRC,
  71     GST_PAD_ALWAYS,
  72     GST_STATIC_CAPS_ANY);
  73
  74 GST_DEBUG_CATEGORY_STATIC (gst_gdp_depay_debug);
  75 #define GST_CAT_DEFAULT gst_gdp_depay_debug
  76
  77 #define _do_init(x) \
  78     GST_DEBUG_CATEGORY_INIT (gst_gdp_depay_debug, "gdpdepay", 0, \
  79     "GDP depayloader");
  80
  81 GST_BOILERPLATE_FULL (GstGDPDepay, gst_gdp_depay, GstElement,
  82     GST_TYPE_ELEMENT, _do_init);
  83
  84 static GstFlowReturn gst_gdp_depay_chain (GstPad * pad, GstBuffer * buffer);
  85 static GstStateChangeReturn gst_gdp_depay_change_state (GstElement *
  86     element, GstStateChange transition);
  87
  88 static void gst_gdp_depay_finalize (GObject * object);
  89
  90 static void
  91 gst_gdp_depay_base_init (gpointer g_class)
  92 {
  93   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
  94
  95   gst_element_class_set_details (element_class, &gdp_depay_details);
  96
  97   gst_element_class_add_pad_template (element_class,
  98       gst_static_pad_template_get (&gdp_depay_sink_template));
  99   gst_element_class_add_pad_template (element_class,
 100       gst_static_pad_template_get (&gdp_depay_src_template));
 101 }
 102
 103 static void
 104 gst_gdp_depay_class_init (GstGDPDepayClass * klass)
 105 {
 106   GObjectClass *gobject_class;
 107   GstElementClass *gstelement_class;
 108
 109   gobject_class = (GObjectClass *) klass;
 110   gstelement_class = (GstElementClass *) klass;
 111
 112   gstelement_class->change_state =
 113       GST_DEBUG_FUNCPTR (gst_gdp_depay_change_state);
 114   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_gdp_depay_finalize);
 115 }
 116
 117 static void
 118 gst_gdp_depay_init (GstGDPDepay * gdpdepay, GstGDPDepayClass * g_class)
 119 {
 120   gdpdepay->sinkpad =
 121       gst_pad_new_from_static_template (&gdp_depay_sink_template, "sink");
 122   gst_pad_set_chain_function (gdpdepay->sinkpad,
 123       GST_DEBUG_FUNCPTR (gst_gdp_depay_chain));
 124   gst_element_add_pad (GST_ELEMENT (gdpdepay), gdpdepay->sinkpad);
 125
 126   gdpdepay->srcpad =
 127       gst_pad_new_from_static_template (&gdp_depay_src_template, "src");
 128   gst_element_add_pad (GST_ELEMENT (gdpdepay), gdpdepay->srcpad);
 129
 130   /* our caps will always be decided by the incoming GDP caps buffers */
 131   gst_pad_use_fixed_caps (gdpdepay->srcpad);
 132
 133   gdpdepay->adapter = gst_adapter_new ();
 134 }
 135
 136 static void
 137 gst_gdp_depay_finalize (GObject * gobject)
 138 {
 139   GstGDPDepay *this;
 140
 141   this = GST_GDP_DEPAY (gobject);
 142   if (this->caps)
 143     gst_caps_unref (this->caps);
 144   if (this->header)
 145     g_free (this->header);
 146   gst_adapter_clear (this->adapter);
 147   g_object_unref (this->adapter);
 148
 149   GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (gobject));
 150 }
 151
 152 static GstFlowReturn
 153 gst_gdp_depay_chain (GstPad * pad, GstBuffer * buffer)
 154 {
 155   GstGDPDepay *this;
 156   GstFlowReturn ret = GST_FLOW_OK;
 157   GstCaps *caps;
 158   GstBuffer *buf;
 159   GstEvent *event;
 160   guint8 *header = NULL;
 161   guint8 *payload = NULL;
 162   guint available;
 163   gboolean running = TRUE;
 164
 165   this = GST_GDP_DEPAY (gst_pad_get_parent (pad));
 166
 167   gst_adapter_push (this->adapter, buffer);
 168
 169   while (running) {
 170     switch (this->state) {
 171       case GST_GDP_DEPAY_STATE_HEADER:
 172         available = gst_adapter_available (this->adapter);
 173         if (available < GST_DP_HEADER_LENGTH) {
 174           running = FALSE;
 175           break;
 176         }
 177
 178         if (this->header)
 179           g_free (this->header);
 180         GST_LOG_OBJECT (this, "reading GDP header from adapter");
 181         header = gst_adapter_take (this->adapter, GST_DP_HEADER_LENGTH);
 182         if (!gst_dp_validate_header (GST_DP_HEADER_LENGTH, header))
 183           goto header_validate_error;
 184
 185         this->payload_length = gst_dp_header_payload_length (header);
 186         this->payload_type = gst_dp_header_payload_type (header);
 187         this->header = header;
 188         GST_LOG_OBJECT (this,
 189             "read GDP header, payload size %d, switching to state PAYLOAD",
 190             this->payload_length);
 191         this->state = GST_GDP_DEPAY_STATE_PAYLOAD;
 192         break;
 193
 194       case GST_GDP_DEPAY_STATE_PAYLOAD:
 195         available = gst_adapter_available (this->adapter);
 196         if (available < this->payload_length) {
 197           running = FALSE;
 198           break;
 199         }
 200
 201         /* change state based on type */
 202         if (this->payload_type == GST_DP_PAYLOAD_BUFFER) {
 203           GST_LOG_OBJECT (this, "switching to state BUFFER");
 204           this->state = GST_GDP_DEPAY_STATE_BUFFER;
 205         } else if (this->payload_type == GST_DP_PAYLOAD_CAPS) {
 206           GST_LOG_OBJECT (this, "switching to state CAPS");
 207           this->state = GST_GDP_DEPAY_STATE_CAPS;
 208         } else if (this->payload_type >= GST_DP_PAYLOAD_EVENT_NONE) {
 209           GST_LOG_OBJECT (this, "switching to state EVENT");
 210           this->state = GST_GDP_DEPAY_STATE_EVENT;
 211         } else
 212           goto wrong_type;
 213         break;
 214
 215       case GST_GDP_DEPAY_STATE_BUFFER:
 216         if (!this->caps) {
 217           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 218               ("Received a buffer without first receiving caps"));
 219           ret = GST_FLOW_NOT_NEGOTIATED;
 220           goto done;
 221         }
 222
 223         GST_LOG_OBJECT (this, "reading GDP buffer from adapter");
 224         buf = gst_dp_buffer_from_header (GST_DP_HEADER_LENGTH, this->header);
 225         if (!buf) {
 226           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 227               ("could not create buffer from GDP packet"));
 228           ret = GST_FLOW_ERROR;
 229           goto done;
 230         }
 231
 232         payload = gst_adapter_take (this->adapter, this->payload_length);
 233         memcpy (GST_BUFFER_DATA (buf), payload, this->payload_length);
 234         g_free (payload);
 235         payload = NULL;
 236
 237         gst_buffer_set_caps (buf, this->caps);
 238         ret = gst_pad_push (this->srcpad, buf);
 239         if (ret != GST_FLOW_OK) {
 240           GST_WARNING_OBJECT (this, "pushing depayloaded buffer returned %d",
 241               ret);
 242           goto done;
 243         }
 244
 245         GST_LOG_OBJECT (this, "switching to state HEADER");
 246         this->state = GST_GDP_DEPAY_STATE_HEADER;
 247         break;
 248
 249       case GST_GDP_DEPAY_STATE_CAPS:
 250         GST_LOG_OBJECT (this, "reading GDP caps from adapter");
 251         payload = gst_adapter_take (this->adapter, this->payload_length);
 252         caps = gst_dp_caps_from_packet (GST_DP_HEADER_LENGTH, this->header,
 253             payload);
 254         g_free (payload);
 255         payload = NULL;
 256         if (!caps) {
 257           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 258               ("could not create caps from GDP packet"));
 259           ret = GST_FLOW_ERROR;
 260           goto done;
 261         }
 262         GST_DEBUG_OBJECT (this, "read caps %" GST_PTR_FORMAT, caps);
 263         gst_caps_replace (&(this->caps), caps);
 264         gst_pad_set_caps (this->srcpad, caps);
 265         /* drop the creation ref we still have */
 266         gst_caps_unref (caps);
 267
 268         GST_LOG_OBJECT (this, "switching to state HEADER");
 269         this->state = GST_GDP_DEPAY_STATE_HEADER;
 270         break;
 271
 272       case GST_GDP_DEPAY_STATE_EVENT:
 273         GST_LOG_OBJECT (this, "reading GDP event from adapter");
 274         /* adapter doesn't like 0 length payload */
 275         if (this->payload_length > 0)
 276           payload = gst_adapter_take (this->adapter, this->payload_length);
 277         event = gst_dp_event_from_packet (GST_DP_HEADER_LENGTH, this->header,
 278             payload);
 279         if (payload) {
 280           g_free (payload);
 281           payload = NULL;
 282         }
 283         if (!event) {
 284           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 285               ("could not create event from GDP packet"));
 286           ret = GST_FLOW_ERROR;
 287           goto done;
 288         }
 289         /* FIXME: set me as source ? */
 290         GST_DEBUG_OBJECT (this, "sending deserialized event %p of type %s",
 291             event, gst_event_type_get_name (event->type));
 292         gst_pad_push_event (this->srcpad, event);
 293
 294         GST_LOG_OBJECT (this, "switching to state HEADER");
 295         this->state = GST_GDP_DEPAY_STATE_HEADER;
 296         break;
 297     }
 298   }
 299   goto done;
 300
 301 header_validate_error:
 302   GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 303       ("GDP packet header does not validate"));
 304   g_free (header);
 305   ret = GST_FLOW_ERROR;
 306   goto done;
 307
 308 wrong_type:
 309   GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 310       ("GDP packet header is of wrong type"));
 311   g_free (header);
 312   ret = GST_FLOW_ERROR;
 313   goto done;
 314
 315 done:
 316   gst_object_unref (this);
 317   return ret;
 318 }
 319
 320 static GstStateChangeReturn
 321 gst_gdp_depay_change_state (GstElement * element, GstStateChange transition)
 322 {
 323   GstStateChangeReturn ret;
 324   GstGDPDepay *this = GST_GDP_DEPAY (element);
 325
 326   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 327
 328   switch (transition) {
 329     case GST_STATE_CHANGE_READY_TO_NULL:
 330       if (this->caps) {
 331         gst_caps_unref (this->caps);
 332         this->caps = NULL;
 333       }
 334       break;
 335     default:
 336       break;
 337   }
 338
 339   return ret;
 340 }
 341
 342 gboolean
 343 gst_gdp_depay_plugin_init (GstPlugin * plugin)
 344 {
 345   if (!gst_element_register (plugin, "gdpdepay", GST_RANK_NONE,
 346           GST_TYPE_GDP_DEPAY))
 347     return FALSE;
 348
 349   return TRUE;
 350 }