plugins/elements/gstdataurisrc.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2009 Igalia S.L
   4  * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:element-dataurisrc
  24  *
  25  * dataurisrc handles data: URIs, see <ulink url="http://tools.ietf.org/html/rfc2397">RFC 2397</ulink> for more information.
  26  *
  27  * <refsect2>
  28  * <title>Example launch line</title>
  29  * |[
  30  * gst-launch-0.10 -v dataurisrc uri="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAfElEQVQ4je2MwQnAIAxFgziA4EnczIsO4MEROo/gzZWc4xdTbe1R6LGRR74heYS7iKElzfcMiRnt4hf8gk8EayB6luefue/HzlJfCA50XsNjYRxprZmenXNIKSGEsC+QUqK1hhgj521BzhnWWiilUGvdF5RS4L2HMQZCCJy8sHMm2TYdJAAAAABJRU5ErkJggg==" ! pngdec ! ffmpegcolorspace ! freeze ! ffmpegcolorspace ! autovideosink
  31  * ]| This pipeline displays a small 16x16 PNG image from the data URI.
  32  * </refsect2>
  33  */
  34
  35 #ifdef HAVE_CONFIG_H
  36 #include "config.h"
  37 #endif
  38
  39 #include "gstdataurisrc.h"
  40
  41 #include <string.h>
  42 #include <gst/base/gsttypefindhelper.h>
  43
  44 GST_DEBUG_CATEGORY (data_uri_src_debug);
  45 #define GST_CAT_DEFAULT (data_uri_src_debug)
  46
  47 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
  48     GST_PAD_SRC,
  49     GST_PAD_ALWAYS,
  50     GST_STATIC_CAPS_ANY);
  51
  52 enum
  53 {
  54   PROP_0,
  55   PROP_URI,
  56 };
  57
  58 static void gst_data_uri_src_finalize (GObject * object);
  59 static void gst_data_uri_src_set_property (GObject * object,
  60     guint prop_id, const GValue * value, GParamSpec * pspec);
  61 static void gst_data_uri_src_get_property (GObject * object,
  62     guint prop_id, GValue * value, GParamSpec * pspec);
  63
  64 static GstCaps *gst_data_uri_src_get_caps (GstBaseSrc * src);
  65 static gboolean gst_data_uri_src_get_size (GstBaseSrc * src, guint64 * size);
  66 static gboolean gst_data_uri_src_is_seekable (GstBaseSrc * src);
  67 static GstFlowReturn gst_data_uri_src_create (GstBaseSrc * src, guint64 offset,
  68     guint size, GstBuffer ** buf);
  69 static gboolean gst_data_uri_src_check_get_range (GstBaseSrc * src);
  70
  71 static void gst_data_uri_src_handler_init (gpointer g_iface,
  72     gpointer iface_data);
  73 static GstURIType gst_data_uri_src_get_uri_type (void);
  74 static gchar **gst_data_uri_src_get_protocols (void);
  75 static const gchar *gst_data_uri_src_get_uri (GstURIHandler * handler);
  76 static gboolean gst_data_uri_src_set_uri (GstURIHandler * handler,
  77     const gchar * uri);
  78
  79 static void
  80 _do_init (GType gtype)
  81 {
  82   static const GInterfaceInfo urihandler_info = {
  83     gst_data_uri_src_handler_init,
  84     0, 0
  85   };
  86
  87   GST_DEBUG_CATEGORY_INIT (data_uri_src_debug, "dataurisrc", 0,
  88       "data: URI source");
  89   g_type_add_interface_static (gtype, GST_TYPE_URI_HANDLER, &urihandler_info);
  90 }
  91
  92 GST_BOILERPLATE_FULL (GstDataURISrc, gst_data_uri_src, GstBaseSrc,
  93     GST_TYPE_BASE_SRC, _do_init);
  94
  95 static void
  96 gst_data_uri_src_base_init (gpointer klass)
  97 {
  98   GstElementClass *element_class = (GstElementClass *) (klass);
  99
 100   gst_element_class_add_pad_template (element_class,
 101       gst_static_pad_template_get (&src_template));
 102   gst_element_class_set_details_simple (element_class,
 103       "data: URI source element", "Source", "Handles data: uris",
 104       "Philippe Normand <pnormand@igalia.com>, "
 105       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 106
 107 }
 108
 109 static void
 110 gst_data_uri_src_class_init (GstDataURISrcClass * klass)
 111 {
 112   GObjectClass *gobject_class = (GObjectClass *) klass;
 113   GstBaseSrcClass *basesrc_class = (GstBaseSrcClass *) klass;
 114
 115   gobject_class->finalize = gst_data_uri_src_finalize;
 116   gobject_class->set_property = gst_data_uri_src_set_property;
 117   gobject_class->get_property = gst_data_uri_src_get_property;
 118
 119   g_object_class_install_property (gobject_class, PROP_URI,
 120       g_param_spec_string ("uri",
 121           "URI",
 122           "URI that should be used",
 123           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 124
 125   basesrc_class->get_caps = GST_DEBUG_FUNCPTR (gst_data_uri_src_get_caps);
 126   basesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_data_uri_src_get_size);
 127   basesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_data_uri_src_is_seekable);
 128   basesrc_class->create = GST_DEBUG_FUNCPTR (gst_data_uri_src_create);
 129   basesrc_class->check_get_range =
 130       GST_DEBUG_FUNCPTR (gst_data_uri_src_check_get_range);
 131 }
 132
 133 static void
 134 gst_data_uri_src_init (GstDataURISrc * src, GstDataURISrcClass * g_class)
 135 {
 136   gst_base_src_set_format (GST_BASE_SRC (src), GST_FORMAT_BYTES);
 137 }
 138
 139 static void
 140 gst_data_uri_src_finalize (GObject * object)
 141 {
 142   GstDataURISrc *src = GST_DATA_URI_SRC (object);
 143
 144   g_free (src->uri);
 145   src->uri = NULL;
 146
 147   if (src->buffer)
 148     gst_buffer_unref (src->buffer);
 149   src->buffer = NULL;
 150
 151   G_OBJECT_CLASS (parent_class)->finalize (object);
 152 }
 153
 154 static void
 155 gst_data_uri_src_set_property (GObject * object, guint prop_id,
 156     const GValue * value, GParamSpec * pspec)
 157 {
 158   GstDataURISrc *src = GST_DATA_URI_SRC (object);
 159
 160   switch (prop_id) {
 161     case PROP_URI:
 162       gst_data_uri_src_set_uri (GST_URI_HANDLER (src),
 163           g_value_get_string (value));
 164       break;
 165     default:
 166       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 167       break;
 168   }
 169 }
 170
 171 static void
 172 gst_data_uri_src_get_property (GObject * object,
 173     guint prop_id, GValue * value, GParamSpec * pspec)
 174 {
 175   GstDataURISrc *src = GST_DATA_URI_SRC (object);
 176
 177   switch (prop_id) {
 178     case PROP_URI:
 179       g_value_set_string (value,
 180           gst_data_uri_src_get_uri (GST_URI_HANDLER (src)));
 181       break;
 182     default:
 183       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 184       break;
 185   }
 186 }
 187
 188 static GstCaps *
 189 gst_data_uri_src_get_caps (GstBaseSrc * basesrc)
 190 {
 191   GstDataURISrc *src = GST_DATA_URI_SRC (basesrc);
 192   GstCaps *caps;
 193
 194   GST_OBJECT_LOCK (src);
 195   if (!src->buffer || !GST_BUFFER_CAPS (src->buffer))
 196     caps = gst_caps_new_empty ();
 197   else
 198     caps = gst_buffer_get_caps (src->buffer);
 199   GST_OBJECT_UNLOCK (src);
 200
 201   return caps;
 202 }
 203
 204 static gboolean
 205 gst_data_uri_src_get_size (GstBaseSrc * basesrc, guint64 * size)
 206 {
 207   GstDataURISrc *src = GST_DATA_URI_SRC (basesrc);
 208   gboolean ret;
 209
 210   GST_OBJECT_LOCK (src);
 211   if (!src->buffer) {
 212     ret = FALSE;
 213     *size = -1;
 214   } else {
 215     ret = TRUE;
 216     *size = GST_BUFFER_SIZE (src->buffer);
 217   }
 218   GST_OBJECT_UNLOCK (src);
 219
 220   return ret;
 221 }
 222
 223 static gboolean
 224 gst_data_uri_src_is_seekable (GstBaseSrc * basesrc)
 225 {
 226   return TRUE;
 227 }
 228
 229 static GstFlowReturn
 230 gst_data_uri_src_create (GstBaseSrc * basesrc, guint64 offset, guint size,
 231     GstBuffer ** buf)
 232 {
 233   GstDataURISrc *src = GST_DATA_URI_SRC (basesrc);
 234   GstFlowReturn ret;
 235
 236   GST_OBJECT_LOCK (src);
 237   if (!src->buffer) {
 238     ret = GST_FLOW_NOT_NEGOTIATED;
 239     GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND, (NULL), (NULL));
 240   } else if (offset + size > GST_BUFFER_SIZE (src->buffer)) {
 241     ret = GST_FLOW_UNEXPECTED;
 242   } else {
 243     ret = GST_FLOW_OK;
 244     *buf = gst_buffer_create_sub (src->buffer, offset, size);
 245     gst_buffer_set_caps (*buf, GST_BUFFER_CAPS (src->buffer));
 246   }
 247   GST_OBJECT_UNLOCK (src);
 248
 249   return ret;
 250 }
 251
 252 static gboolean
 253 gst_data_uri_src_check_get_range (GstBaseSrc * basesrc)
 254 {
 255   return TRUE;
 256 }
 257
 258 static void
 259 gst_data_uri_src_handler_init (gpointer g_iface, gpointer iface_data)
 260 {
 261   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 262
 263   iface->get_type = gst_data_uri_src_get_uri_type;
 264   iface->get_protocols = gst_data_uri_src_get_protocols;
 265   iface->get_uri = gst_data_uri_src_get_uri;
 266   iface->set_uri = gst_data_uri_src_set_uri;
 267 }
 268
 269 static GstURIType
 270 gst_data_uri_src_get_uri_type (void)
 271 {
 272   return GST_URI_SRC;
 273 }
 274
 275 static gchar **
 276 gst_data_uri_src_get_protocols (void)
 277 {
 278   static gchar *protocols[] = { "data", 0 };
 279
 280   return protocols;
 281 }
 282
 283 static const gchar *
 284 gst_data_uri_src_get_uri (GstURIHandler * handler)
 285 {
 286   GstDataURISrc *src = GST_DATA_URI_SRC (handler);
 287
 288   return src->uri;
 289 }
 290
 291 static gboolean
 292 gst_data_uri_src_set_uri (GstURIHandler * handler, const gchar * uri)
 293 {
 294   GstDataURISrc *src = GST_DATA_URI_SRC (handler);
 295   gboolean ret = FALSE;
 296   gchar *mimetype = NULL;
 297   const gchar *parameters_start;
 298   const gchar *data_start;
 299   GstCaps *caps;
 300   gboolean base64 = FALSE;
 301   gchar *charset = NULL;
 302
 303   GST_OBJECT_LOCK (src);
 304   if (GST_STATE (src) >= GST_STATE_PAUSED)
 305     goto wrong_state;
 306
 307   /* uri must be an URI as defined in RFC 2397
 308    * data:[<mediatype>][;base64],<data>
 309    */
 310   if (strncmp ("data:", uri, 5) != 0)
 311     goto invalid_uri;
 312
 313   uri += 5;
 314
 315   parameters_start = strchr (uri, ';');
 316   data_start = strchr (uri, ',');
 317   if (data_start == NULL)
 318     goto invalid_uri;
 319
 320   if (data_start != uri && parameters_start != uri)
 321     mimetype =
 322         g_strndup (uri,
 323         (parameters_start ? parameters_start : data_start) - uri);
 324   else
 325     mimetype = g_strdup ("text/plain");
 326
 327   GST_DEBUG_OBJECT (src, "Mimetype: %s", mimetype);
 328
 329   if (parameters_start != NULL) {
 330     gchar **walk;
 331     gchar *parameters =
 332         g_strndup (parameters_start + 1, data_start - parameters_start - 1);
 333     gchar **parameters_strv;
 334
 335     parameters_strv = g_strsplit (parameters, ";", -1);
 336
 337     GST_DEBUG_OBJECT (src, "Parameters: ");
 338     walk = parameters_strv;
 339     while (*walk) {
 340       GST_DEBUG_OBJECT (src, "\t %s", *walk);
 341       if (strcmp ("base64", *walk) == 0) {
 342         base64 = TRUE;
 343       } else if (strncmp ("charset=", *walk, 8) == 0) {
 344         charset = g_strdup (*walk + 8);
 345       }
 346       walk++;
 347     }
 348     g_free (parameters);
 349     g_strfreev (parameters_strv);
 350   }
 351
 352   /* Skip comma */
 353   data_start += 1;
 354   if (base64) {
 355     gsize bsize;
 356
 357     src->buffer = gst_buffer_new ();
 358     GST_BUFFER_DATA (src->buffer) =
 359         (guint8 *) g_base64_decode (data_start, &bsize);
 360     GST_BUFFER_MALLOCDATA (src->buffer) = GST_BUFFER_DATA (src->buffer);
 361     GST_BUFFER_SIZE (src->buffer) = bsize;
 362   } else {
 363     gchar *data;
 364
 365     /* URI encoded, i.e. "percent" encoding */
 366     data = g_uri_unescape_string (data_start, NULL);
 367     if (data == NULL)
 368       goto invalid_uri_encoded_data;
 369
 370     src->buffer = gst_buffer_new ();
 371     GST_BUFFER_DATA (src->buffer) = (guint8 *) data;
 372     GST_BUFFER_MALLOCDATA (src->buffer) = GST_BUFFER_DATA (src->buffer);
 373     GST_BUFFER_SIZE (src->buffer) = strlen (data) + 1;
 374   }
 375
 376   /* Convert to UTF8 */
 377   if (strcmp ("text/plain", mimetype) == 0 &&
 378       charset && strcasecmp ("US-ASCII", charset) != 0
 379       && strcasecmp ("UTF-8", charset) != 0) {
 380     gsize read;
 381     gsize written;
 382     gchar *old_data = (gchar *) GST_BUFFER_DATA (src->buffer);
 383     gchar *data;
 384
 385     data =
 386         g_convert_with_fallback (old_data, -1, "UTF-8", charset, "*", &read,
 387         &written, NULL);
 388     g_free (old_data);
 389     GST_BUFFER_DATA (src->buffer) = GST_BUFFER_MALLOCDATA (src->buffer) =
 390         (guint8 *) data;
 391     GST_BUFFER_SIZE (src->buffer) = written;
 392   }
 393
 394   caps = gst_type_find_helper_for_buffer (GST_OBJECT (src), src->buffer, NULL);
 395   if (!caps)
 396     caps = gst_caps_new_simple (mimetype, NULL);
 397   gst_buffer_set_caps (src->buffer, caps);
 398   gst_caps_unref (caps);
 399
 400   ret = TRUE;
 401   GST_OBJECT_UNLOCK (src);
 402 out:
 403   g_free (mimetype);
 404   g_free (charset);
 405
 406
 407   return ret;
 408
 409 invalid_uri:
 410   {
 411     GST_OBJECT_UNLOCK (src);
 412     GST_ELEMENT_ERROR (src, STREAM, FORMAT, (NULL), (NULL));
 413   }
 414   goto out;
 415 wrong_state:
 416   {
 417     GST_OBJECT_UNLOCK (src);
 418     GST_ELEMENT_ERROR (src, CORE, FAILED, (NULL), (NULL));
 419   }
 420   goto out;
 421 invalid_uri_encoded_data:
 422   {
 423     GST_OBJECT_UNLOCK (src);
 424     GST_ELEMENT_ERROR (src, STREAM, FORMAT, (NULL), (NULL));
 425   }
 426   goto out;
 427 }
 428
 429 static gboolean
 430 plugin_init (GstPlugin * plugin)
 431 {
 432   return gst_element_register (plugin, "dataurisrc",
 433       GST_RANK_PRIMARY, GST_TYPE_DATA_URI_SRC);
 434 }
 435
 436 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 437     GST_VERSION_MINOR,
 438     "dataurisrc",
 439     "data: URI source",
 440     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);