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