gst/gstparse.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2002 Andy Wingo <wingo@pobox.com>
   5  *                    2008 Tim-Philipp Müller <tim centricular net>
   6  *
   7  * gstparse.c: get a pipeline from a text pipeline description
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 /**
  26  * SECTION:gstparse
  27  * @short_description: Get a pipeline from a text pipeline description
  28  *
  29  * These function allow to create a pipeline based on the syntax used in the
  30  * gst-launch-1.0 utility (see man-page for syntax documentation).
  31  *
  32  * Please note that these functions take several measures to create
  33  * somewhat dynamic pipelines. Due to that such pipelines are not always
  34  * reusable (set the state to NULL and back to PLAYING).
  35  */
  36
  37 #include "gst_private.h"
  38 #include <string.h>
  39
  40 #include "gstparse.h"
  41 #include "gsterror.h"
  42 #include "gstinfo.h"
  43 #ifndef GST_DISABLE_PARSE
  44 #include "parse/types.h"
  45 #endif
  46
  47 static GstParseContext *
  48 gst_parse_context_copy (const GstParseContext * context)
  49 {
  50   GstParseContext *ret = NULL;
  51 #ifndef GST_DISABLE_PARSE
  52
  53   ret = gst_parse_context_new ();
  54   if (context) {
  55     GQueue missing_copy = G_QUEUE_INIT;
  56     GList *l;
  57
  58     for (l = context->missing_elements; l != NULL; l = l->next)
  59       g_queue_push_tail (&missing_copy, g_strdup ((const gchar *) l->data));
  60
  61     ret->missing_elements = missing_copy.head;
  62   }
  63 #endif
  64   return ret;
  65 }
  66
  67 G_DEFINE_BOXED_TYPE (GstParseContext, gst_parse_context,
  68     (GBoxedCopyFunc) gst_parse_context_copy,
  69     (GBoxedFreeFunc) gst_parse_context_free);
  70
  71 /**
  72  * gst_parse_error_quark:
  73  *
  74  * Get the error quark used by the parsing subsystem.
  75  *
  76  * Returns: the quark of the parse errors.
  77  */
  78 GQuark
  79 gst_parse_error_quark (void)
  80 {
  81   static GQuark quark = 0;
  82
  83   if (!quark)
  84     quark = g_quark_from_static_string ("gst_parse_error");
  85   return quark;
  86 }
  87
  88
  89 /**
  90  * gst_parse_context_new:
  91  *
  92  * Allocates a parse context for use with gst_parse_launch_full() or
  93  * gst_parse_launchv_full().
  94  *
  95  * Free-function: gst_parse_context_free
  96  *
  97  * Returns: (transfer full): a newly-allocated parse context. Free with
  98  *     gst_parse_context_free() when no longer needed.
  99  */
 100 GstParseContext *
 101 gst_parse_context_new (void)
 102 {
 103 #ifndef GST_DISABLE_PARSE
 104   GstParseContext *ctx;
 105
 106   ctx = g_slice_new (GstParseContext);
 107   ctx->missing_elements = NULL;
 108
 109   return ctx;
 110 #else
 111   return NULL;
 112 #endif
 113 }
 114
 115 /**
 116  * gst_parse_context_free:
 117  * @context: (transfer full): a #GstParseContext
 118  *
 119  * Frees a parse context previously allocated with gst_parse_context_new().
 120  */
 121 void
 122 gst_parse_context_free (GstParseContext * context)
 123 {
 124 #ifndef GST_DISABLE_PARSE
 125   if (context) {
 126     g_list_foreach (context->missing_elements, (GFunc) g_free, NULL);
 127     g_list_free (context->missing_elements);
 128     g_slice_free (GstParseContext, context);
 129   }
 130 #endif
 131 }
 132
 133 /**
 134  * gst_parse_context_get_missing_elements:
 135  * @context: a #GstParseContext
 136  *
 137  * Retrieve missing elements from a previous run of gst_parse_launch_full()
 138  * or gst_parse_launchv_full(). Will only return results if an error code
 139  * of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned.
 140  *
 141  * Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): a
 142  *     %NULL-terminated array of element factory name strings of missing
 143  *     elements. Free with g_strfreev() when no longer needed.
 144  */
 145 gchar **
 146 gst_parse_context_get_missing_elements (GstParseContext * context)
 147 {
 148 #ifndef GST_DISABLE_PARSE
 149   gchar **arr;
 150   GList *l;
 151   guint len, i;
 152
 153   g_return_val_if_fail (context != NULL, NULL);
 154
 155   len = g_list_length (context->missing_elements);
 156
 157   if (G_UNLIKELY (len == 0))
 158     return NULL;
 159
 160   arr = g_new (gchar *, len + 1);
 161
 162   for (i = 0, l = context->missing_elements; l != NULL; l = l->next, ++i)
 163     arr[i] = g_strdup (l->data);
 164
 165   arr[i] = NULL;
 166
 167   return arr;
 168 #else
 169   return NULL;
 170 #endif
 171 }
 172
 173 #ifndef GST_DISABLE_PARSE
 174 static gchar *
 175 _gst_parse_escape (const gchar * str)
 176 {
 177   GString *gstr = NULL;
 178   gboolean in_quotes;
 179
 180   g_return_val_if_fail (str != NULL, NULL);
 181
 182   gstr = g_string_sized_new (strlen (str));
 183
 184   in_quotes = FALSE;
 185
 186   while (*str) {
 187     if (*str == '"' && (!in_quotes || (in_quotes && *(str - 1) != '\\')))
 188       in_quotes = !in_quotes;
 189
 190     if (*str == ' ' && !in_quotes)
 191       g_string_append_c (gstr, '\\');
 192
 193     g_string_append_c (gstr, *str);
 194     str++;
 195   }
 196
 197   return g_string_free (gstr, FALSE);
 198 }
 199 #endif /* !GST_DISABLE_PARSE */
 200
 201 /**
 202  * gst_parse_launchv:
 203  * @argv: (in) (array zero-terminated=1): null-terminated array of arguments
 204  * @error: pointer to a #GError
 205  *
 206  * Create a new element based on command line syntax.
 207  * @error will contain an error message if an erroneous pipeline is specified.
 208  * An error does not mean that the pipeline could not be constructed.
 209  *
 210  * Returns: (transfer floating): a new element on success and %NULL on failure.
 211  */
 212 GstElement *
 213 gst_parse_launchv (const gchar ** argv, GError ** error)
 214 {
 215   return gst_parse_launchv_full (argv, NULL, GST_PARSE_FLAG_NONE, error);
 216 }
 217
 218 /**
 219  * gst_parse_launchv_full:
 220  * @argv: (in) (array zero-terminated=1): null-terminated array of arguments
 221  * @context: (allow-none): a parse context allocated with
 222  *     gst_parse_context_new(), or %NULL
 223  * @flags: parsing options, or #GST_PARSE_FLAG_NONE
 224  * @error: pointer to a #GError (which must be initialised to %NULL)
 225  *
 226  * Create a new element based on command line syntax.
 227  * @error will contain an error message if an erroneous pipeline is specified.
 228  * An error does not mean that the pipeline could not be constructed.
 229  *
 230  * Returns: (transfer floating): a new element on success; on failure, either %NULL
 231  *   or a partially-constructed bin or element will be returned and @error will
 232  *   be set (unless you passed #GST_PARSE_FLAG_FATAL_ERRORS in @flags, then
 233  *   %NULL will always be returned on failure)
 234  */
 235 GstElement *
 236 gst_parse_launchv_full (const gchar ** argv, GstParseContext * context,
 237     GstParseFlags flags, GError ** error)
 238 {
 239 #ifndef GST_DISABLE_PARSE
 240   GstElement *element;
 241   GString *str;
 242   const gchar **argvp, *arg;
 243   gchar *tmp;
 244
 245   g_return_val_if_fail (argv != NULL, NULL);
 246   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 247
 248   /* let's give it a nice size. */
 249   str = g_string_sized_new (1024);
 250
 251   argvp = argv;
 252   while (*argvp) {
 253     arg = *argvp;
 254     GST_DEBUG ("escaping argument %s", arg);
 255     tmp = _gst_parse_escape (arg);
 256     g_string_append (str, tmp);
 257     g_free (tmp);
 258     g_string_append_c (str, ' ');
 259     argvp++;
 260   }
 261
 262   element = gst_parse_launch_full (str->str, context, flags, error);
 263
 264   g_string_free (str, TRUE);
 265
 266   return element;
 267 #else
 268   /* gst_parse_launch_full() will set a GST_CORE_ERROR_DISABLED error for us */
 269   return gst_parse_launch_full ("", NULL, 0, error);
 270 #endif
 271 }
 272
 273 /**
 274  * gst_parse_launch:
 275  * @pipeline_description: the command line describing the pipeline
 276  * @error: the error message in case of an erroneous pipeline.
 277  *
 278  * Create a new pipeline based on command line syntax.
 279  * Please note that you might get a return value that is not %NULL even though
 280  * the @error is set. In this case there was a recoverable parsing error and you
 281  * can try to play the pipeline.
 282  *
 283  * Returns: (transfer floating): a new element on success, %NULL on failure. If
 284  *    more than one toplevel element is specified by the @pipeline_description,
 285  *   all elements are put into a #GstPipeline, which than is returned.
 286  */
 287 GstElement *
 288 gst_parse_launch (const gchar * pipeline_description, GError ** error)
 289 {
 290   return gst_parse_launch_full (pipeline_description, NULL, GST_PARSE_FLAG_NONE,
 291       error);
 292 }
 293
 294 /**
 295  * gst_parse_launch_full:
 296  * @pipeline_description: the command line describing the pipeline
 297  * @context: (allow-none): a parse context allocated with
 298  *      gst_parse_context_new(), or %NULL
 299  * @flags: parsing options, or #GST_PARSE_FLAG_NONE
 300  * @error: the error message in case of an erroneous pipeline.
 301  *
 302  * Create a new pipeline based on command line syntax.
 303  * Please note that you might get a return value that is not %NULL even though
 304  * the @error is set. In this case there was a recoverable parsing error and you
 305  * can try to play the pipeline.
 306  *
 307  * Returns: (transfer floating): a new element on success, %NULL on failure. If
 308  *    more than one toplevel element is specified by the @pipeline_description,
 309  *    all elements are put into a #GstPipeline, which then is returned (unless
 310  *    the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in which case they are put
 311  *    in a #GstBin instead).
 312  */
 313 GstElement *
 314 gst_parse_launch_full (const gchar * pipeline_description,
 315     GstParseContext * context, GstParseFlags flags, GError ** error)
 316 {
 317 #ifndef GST_DISABLE_PARSE
 318   GstElement *element;
 319   GError *myerror = NULL;
 320
 321   g_return_val_if_fail (pipeline_description != NULL, NULL);
 322   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 323
 324   GST_CAT_INFO (GST_CAT_PIPELINE, "parsing pipeline description '%s'",
 325       pipeline_description);
 326
 327   element = priv_gst_parse_launch (pipeline_description, &myerror, context,
 328       flags);
 329
 330   /* don't return partially constructed pipeline if FATAL_ERRORS was given */
 331   if (G_UNLIKELY (myerror != NULL && element != NULL)) {
 332     if ((flags & GST_PARSE_FLAG_FATAL_ERRORS)) {
 333       gst_object_unref (element);
 334       element = NULL;
 335     }
 336   }
 337
 338   if (myerror)
 339     g_propagate_error (error, myerror);
 340
 341   return element;
 342 #else
 343   gchar *msg;
 344
 345   GST_WARNING ("Disabled API called");
 346
 347   msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
 348   g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
 349   g_free (msg);
 350
 351   return NULL;
 352 #endif
 353 }