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   parent_class = g_type_class_peek_parent (klass);
 113
 114   gstelement_class->change_state =
 115       GST_DEBUG_FUNCPTR (gst_gdp_depay_change_state);
 116   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_gdp_depay_finalize);
 117 }
 118
 119 static void
 120 gst_gdp_depay_init (GstGDPDepay * gdpdepay, GstGDPDepayClass * g_class)
 121 {
 122   gdpdepay->sinkpad =
 123       gst_pad_new_from_static_template (&gdp_depay_sink_template, "sink");
 124   gst_pad_set_setcaps_function (gdpdepay->sinkpad,
 125       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 126   gst_pad_set_getcaps_function (gdpdepay->sinkpad,
 127       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 128   gst_pad_set_chain_function (gdpdepay->sinkpad,
 129       GST_DEBUG_FUNCPTR (gst_gdp_depay_chain));
 130   gst_element_add_pad (GST_ELEMENT (gdpdepay), gdpdepay->sinkpad);
 131
 132   gdpdepay->srcpad =
 133       gst_pad_new_from_static_template (&gdp_depay_src_template, "src");
 134   gst_element_add_pad (GST_ELEMENT (gdpdepay), gdpdepay->srcpad);
 135
 136   /* our caps will always be decided by the incoming GDP caps buffers */
 137   gst_pad_use_fixed_caps (gdpdepay->srcpad);
 138
 139   gdpdepay->adapter = gst_adapter_new ();
 140 }
 141
 142 static void
 143 gst_gdp_depay_finalize (GObject * gobject)
 144 {
 145   GstGDPDepay *this;
 146
 147   this = GST_GDP_DEPAY (gobject);
 148   if (this->caps)
 149     gst_caps_unref (this->caps);
 150   if (this->header)
 151     g_free (this->header);
 152   gst_adapter_clear (this->adapter);
 153   g_object_unref (this->adapter);
 154
 155   GST_CALL_PARENT (G_OBJECT_CLASS, finalize, (gobject));
 156 }
 157
 158 static GstFlowReturn
 159 gst_gdp_depay_chain (GstPad * pad, GstBuffer * buffer)
 160 {
 161   GstGDPDepay *this;
 162   GstFlowReturn ret = GST_FLOW_OK;
 163   GstCaps *caps;
 164   GstBuffer *buf;
 165   GstEvent *event;
 166   guint8 *header = NULL;
 167   guint8 *payload = NULL;
 168   guint available;
 169   gboolean running = TRUE;
 170
 171   this = GST_GDP_DEPAY (gst_pad_get_parent (pad));
 172
 173   gst_adapter_push (this->adapter, buffer);
 174
 175   while (running) {
 176     switch (this->state) {
 177       case GST_GDP_DEPAY_STATE_HEADER:
 178         available = gst_adapter_available (this->adapter);
 179         if (available < GST_DP_HEADER_LENGTH) {
 180           running = FALSE;
 181           break;
 182         }
 183
 184         if (this->header)
 185           g_free (this->header);
 186         GST_LOG_OBJECT (this, "reading GDP header from adapter");
 187         header = gst_adapter_take (this->adapter, GST_DP_HEADER_LENGTH);
 188         if (!gst_dp_validate_header (GST_DP_HEADER_LENGTH, header))
 189           goto header_validate_error;
 190
 191         this->payload_length = gst_dp_header_payload_length (header);
 192         this->payload_type = gst_dp_header_payload_type (header);
 193         this->header = header;
 194         GST_LOG_OBJECT (this,
 195             "read GDP header, payload size %d, switching to state PAYLOAD",
 196             this->payload_length);
 197         this->state = GST_GDP_DEPAY_STATE_PAYLOAD;
 198         break;
 199
 200       case GST_GDP_DEPAY_STATE_PAYLOAD:
 201         available = gst_adapter_available (this->adapter);
 202         if (available < this->payload_length) {
 203           running = FALSE;
 204           break;
 205         }
 206
 207         /* change state based on type */
 208         if (this->payload_type == GST_DP_PAYLOAD_BUFFER) {
 209           GST_LOG_OBJECT (this, "switching to state BUFFER");
 210           this->state = GST_GDP_DEPAY_STATE_BUFFER;
 211         } else if (this->payload_type == GST_DP_PAYLOAD_CAPS) {
 212           GST_LOG_OBJECT (this, "switching to state CAPS");
 213           this->state = GST_GDP_DEPAY_STATE_CAPS;
 214         } else if (this->payload_type >= GST_DP_PAYLOAD_EVENT_NONE) {
 215           GST_LOG_OBJECT (this, "switching to state EVENT");
 216           this->state = GST_GDP_DEPAY_STATE_EVENT;
 217         } else
 218           goto wrong_type;
 219         break;
 220
 221       case GST_GDP_DEPAY_STATE_BUFFER:
 222         if (!this->caps) {
 223           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 224               ("Received a buffer without first receiving caps"));
 225           ret = GST_FLOW_NOT_NEGOTIATED;
 226           goto done;
 227         }
 228
 229         GST_LOG_OBJECT (this, "reading GDP buffer from adapter");
 230         buf = gst_dp_buffer_from_header (GST_DP_HEADER_LENGTH, this->header);
 231         if (!buf) {
 232           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 233               ("could not create buffer from GDP packet"));
 234           ret = GST_FLOW_ERROR;
 235           goto done;
 236         }
 237
 238         payload = gst_adapter_take (this->adapter, this->payload_length);
 239         memcpy (GST_BUFFER_DATA (buf), payload, this->payload_length);
 240         g_free (payload);
 241         payload = NULL;
 242
 243         gst_buffer_set_caps (buf, this->caps);
 244         ret = gst_pad_push (this->srcpad, buf);
 245         if (ret != GST_FLOW_OK) {
 246           GST_WARNING_OBJECT (this, "pushing depayloaded buffer returned %d",
 247               ret);
 248           goto done;
 249         }
 250
 251         GST_LOG_OBJECT (this, "switching to state HEADER");
 252         this->state = GST_GDP_DEPAY_STATE_HEADER;
 253         break;
 254
 255       case GST_GDP_DEPAY_STATE_CAPS:
 256         GST_LOG_OBJECT (this, "reading GDP caps from adapter");
 257         payload = gst_adapter_take (this->adapter, this->payload_length);
 258         caps = gst_dp_caps_from_packet (GST_DP_HEADER_LENGTH, this->header,
 259             payload);
 260         g_free (payload);
 261         payload = NULL;
 262         if (!caps) {
 263           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 264               ("could not create caps from GDP packet"));
 265           ret = GST_FLOW_ERROR;
 266           goto done;
 267         }
 268         GST_DEBUG_OBJECT (this, "read caps %" GST_PTR_FORMAT, caps);
 269         gst_caps_replace (&(this->caps), caps);
 270         gst_pad_set_caps (this->srcpad, caps);
 271         /* drop the creation ref we still have */
 272         gst_caps_unref (caps);
 273
 274         GST_LOG_OBJECT (this, "switching to state HEADER");
 275         this->state = GST_GDP_DEPAY_STATE_HEADER;
 276         break;
 277
 278       case GST_GDP_DEPAY_STATE_EVENT:
 279         GST_LOG_OBJECT (this, "reading GDP event from adapter");
 280         /* adapter doesn't like 0 length payload */
 281         if (this->payload_length > 0)
 282           payload = gst_adapter_take (this->adapter, this->payload_length);
 283         event = gst_dp_event_from_packet (GST_DP_HEADER_LENGTH, this->header,
 284             payload);
 285         if (payload) {
 286           g_free (payload);
 287           payload = NULL;
 288         }
 289         if (!event) {
 290           GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 291               ("could not create event from GDP packet"));
 292           ret = GST_FLOW_ERROR;
 293           goto done;
 294         }
 295         /* FIXME: set me as source ? */
 296         GST_DEBUG_OBJECT (this, "sending deserialized event %p of type %s",
 297             event, gst_event_type_get_name (event->type));
 298         gst_pad_push_event (this->srcpad, event);
 299
 300         GST_LOG_OBJECT (this, "switching to state HEADER");
 301         this->state = GST_GDP_DEPAY_STATE_HEADER;
 302         break;
 303     }
 304   }
 305   goto done;
 306
 307 header_validate_error:
 308   GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 309       ("GDP packet header does not validate"));
 310   g_free (header);
 311   ret = GST_FLOW_ERROR;
 312   goto done;
 313
 314 wrong_type:
 315   GST_ELEMENT_ERROR (this, STREAM, DECODE, (NULL),
 316       ("GDP packet header is of wrong type"));
 317   g_free (header);
 318   ret = GST_FLOW_ERROR;
 319   goto done;
 320
 321 done:
 322   gst_object_unref (this);
 323   return ret;
 324 }
 325
 326 static GstStateChangeReturn
 327 gst_gdp_depay_change_state (GstElement * element, GstStateChange transition)
 328 {
 329   GstStateChangeReturn ret;
 330   GstGDPDepay *this = GST_GDP_DEPAY (element);
 331
 332   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 333
 334   switch (transition) {
 335     case GST_STATE_CHANGE_READY_TO_NULL:
 336       if (this->caps) {
 337         gst_caps_unref (this->caps);
 338         this->caps = NULL;
 339       }
 340       break;
 341     default:
 342       break;
 343   }
 344
 345   return ret;
 346 }
 347
 348 gboolean
 349 gst_gdp_depay_plugin_init (GstPlugin * plugin)
 350 {
 351   if (!gst_element_register (plugin, "gdpdepay", GST_RANK_NONE,
 352           GST_TYPE_GDP_DEPAY))
 353     return FALSE;
 354
 355   return TRUE;
 356 }