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
 238   if (!src->buffer)
 239     goto no_buffer;
 240
 241   /* This is only correct because GstBaseSrc already clips size for us to be no
 242    * larger than the max. available size if a segment at the end is requested */
 243   if (offset + size > GST_BUFFER_SIZE (src->buffer)) {
 244     ret = GST_FLOW_UNEXPECTED;
 245   } else {
 246     ret = GST_FLOW_OK;
 247     *buf = gst_buffer_create_sub (src->buffer, offset, size);
 248     gst_buffer_set_caps (*buf, GST_BUFFER_CAPS (src->buffer));
 249   }
 250
 251   GST_OBJECT_UNLOCK (src);
 252
 253   return ret;
 254
 255 /* ERRORS */
 256 no_buffer:
 257   {
 258     GST_OBJECT_UNLOCK (src);
 259     GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND, (NULL), (NULL));
 260     return GST_FLOW_NOT_NEGOTIATED;
 261   }
 262 }
 263
 264 static gboolean
 265 gst_data_uri_src_check_get_range (GstBaseSrc * basesrc)
 266 {
 267   return TRUE;
 268 }
 269
 270 static void
 271 gst_data_uri_src_handler_init (gpointer g_iface, gpointer iface_data)
 272 {
 273   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 274
 275   iface->get_type = gst_data_uri_src_get_uri_type;
 276   iface->get_protocols = gst_data_uri_src_get_protocols;
 277   iface->get_uri = gst_data_uri_src_get_uri;
 278   iface->set_uri = gst_data_uri_src_set_uri;
 279 }
 280
 281 static GstURIType
 282 gst_data_uri_src_get_uri_type (void)
 283 {
 284   return GST_URI_SRC;
 285 }
 286
 287 static gchar **
 288 gst_data_uri_src_get_protocols (void)
 289 {
 290   static gchar *protocols[] = { "data", 0 };
 291
 292   return protocols;
 293 }
 294
 295 static const gchar *
 296 gst_data_uri_src_get_uri (GstURIHandler * handler)
 297 {
 298   GstDataURISrc *src = GST_DATA_URI_SRC (handler);
 299
 300   return src->uri;
 301 }
 302
 303 static gboolean
 304 gst_data_uri_src_set_uri (GstURIHandler * handler, const gchar * uri)
 305 {
 306   GstDataURISrc *src = GST_DATA_URI_SRC (handler);
 307   gboolean ret = FALSE;
 308   gchar *mimetype = NULL;
 309   const gchar *parameters_start;
 310   const gchar *data_start;
 311   GstCaps *caps;
 312   gboolean base64 = FALSE;
 313   gchar *charset = NULL;
 314
 315   GST_OBJECT_LOCK (src);
 316   if (GST_STATE (src) >= GST_STATE_PAUSED)
 317     goto wrong_state;
 318
 319   /* uri must be an URI as defined in RFC 2397
 320    * data:[<mediatype>][;base64],<data>
 321    */
 322   if (strncmp ("data:", uri, 5) != 0)
 323     goto invalid_uri;
 324
 325   uri += 5;
 326
 327   parameters_start = strchr (uri, ';');
 328   data_start = strchr (uri, ',');
 329   if (data_start == NULL)
 330     goto invalid_uri;
 331
 332   if (data_start != uri && parameters_start != uri)
 333     mimetype =
 334         g_strndup (uri,
 335         (parameters_start ? parameters_start : data_start) - uri);
 336   else
 337     mimetype = g_strdup ("text/plain");
 338
 339   GST_DEBUG_OBJECT (src, "Mimetype: %s", mimetype);
 340
 341   if (parameters_start != NULL) {
 342     gchar **walk;
 343     gchar *parameters =
 344         g_strndup (parameters_start + 1, data_start - parameters_start - 1);
 345     gchar **parameters_strv;
 346
 347     parameters_strv = g_strsplit (parameters, ";", -1);
 348
 349     GST_DEBUG_OBJECT (src, "Parameters: ");
 350     walk = parameters_strv;
 351     while (*walk) {
 352       GST_DEBUG_OBJECT (src, "\t %s", *walk);
 353       if (strcmp ("base64", *walk) == 0) {
 354         base64 = TRUE;
 355       } else if (strncmp ("charset=", *walk, 8) == 0) {
 356         charset = g_strdup (*walk + 8);
 357       }
 358       walk++;
 359     }
 360     g_free (parameters);
 361     g_strfreev (parameters_strv);
 362   }
 363
 364   /* Skip comma */
 365   data_start += 1;
 366   if (base64) {
 367     gsize bsize;
 368
 369     src->buffer = gst_buffer_new ();
 370     GST_BUFFER_DATA (src->buffer) =
 371         (guint8 *) g_base64_decode (data_start, &bsize);
 372     GST_BUFFER_MALLOCDATA (src->buffer) = GST_BUFFER_DATA (src->buffer);
 373     GST_BUFFER_SIZE (src->buffer) = bsize;
 374   } else {
 375     gchar *data;
 376
 377     /* URI encoded, i.e. "percent" encoding */
 378     data = g_uri_unescape_string (data_start, NULL);
 379     if (data == NULL)
 380       goto invalid_uri_encoded_data;
 381
 382     src->buffer = gst_buffer_new ();
 383     GST_BUFFER_DATA (src->buffer) = (guint8 *) data;
 384     GST_BUFFER_MALLOCDATA (src->buffer) = GST_BUFFER_DATA (src->buffer);
 385     GST_BUFFER_SIZE (src->buffer) = strlen (data) + 1;
 386   }
 387
 388   /* Convert to UTF8 */
 389   if (strcmp ("text/plain", mimetype) == 0 &&
 390       charset && strcasecmp ("US-ASCII", charset) != 0
 391       && strcasecmp ("UTF-8", charset) != 0) {
 392     gsize read;
 393     gsize written;
 394     gchar *old_data = (gchar *) GST_BUFFER_DATA (src->buffer);
 395     gchar *data;
 396
 397     data =
 398         g_convert_with_fallback (old_data, -1, "UTF-8", charset, "*", &read,
 399         &written, NULL);
 400     g_free (old_data);
 401     GST_BUFFER_DATA (src->buffer) = GST_BUFFER_MALLOCDATA (src->buffer) =
 402         (guint8 *) data;
 403     GST_BUFFER_SIZE (src->buffer) = written;
 404   }
 405
 406   caps = gst_type_find_helper_for_buffer (GST_OBJECT (src), src->buffer, NULL);
 407   if (!caps)
 408     caps = gst_caps_new_simple (mimetype, NULL);
 409   gst_buffer_set_caps (src->buffer, caps);
 410   gst_caps_unref (caps);
 411
 412   ret = TRUE;
 413   GST_OBJECT_UNLOCK (src);
 414 out:
 415   g_free (mimetype);
 416   g_free (charset);
 417
 418
 419   return ret;
 420
 421 invalid_uri:
 422   {
 423     GST_OBJECT_UNLOCK (src);
 424     GST_ELEMENT_ERROR (src, STREAM, FORMAT, (NULL), (NULL));
 425   }
 426   goto out;
 427 wrong_state:
 428   {
 429     GST_OBJECT_UNLOCK (src);
 430     GST_ELEMENT_ERROR (src, CORE, FAILED, (NULL), (NULL));
 431   }
 432   goto out;
 433 invalid_uri_encoded_data:
 434   {
 435     GST_OBJECT_UNLOCK (src);
 436     GST_ELEMENT_ERROR (src, STREAM, FORMAT, (NULL), (NULL));
 437   }
 438   goto out;
 439 }
 440
 441 static gboolean
 442 plugin_init (GstPlugin * plugin)
 443 {
 444   return gst_element_register (plugin, "dataurisrc",
 445       GST_RANK_PRIMARY, GST_TYPE_DATA_URI_SRC);
 446 }
 447
 448 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 449     GST_VERSION_MINOR,
 450     "dataurisrc",
 451     "data: URI source",
 452     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);