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  *
   6  * gstparse.c: get a pipeline from a text pipeline description
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstparse
  26  * @short_description: Get a pipeline from a text pipeline description
  27  *
  28  * These function allow to create a pipeline based on the syntax used in the
  29  * gst-launch utillity.
  30  */
  31
  32 #include <string.h>
  33
  34 #include "gst_private.h"
  35
  36 #include "gstparse.h"
  37 #include "gstinfo.h"
  38
  39 extern GstElement *_gst_parse_launch (const gchar *, GError **);
  40
  41 GQuark
  42 gst_parse_error_quark (void)
  43 {
  44   static GQuark quark = 0;
  45
  46   if (!quark)
  47     quark = g_quark_from_static_string ("gst_parse_error");
  48   return quark;
  49 }
  50
  51 static gchar *
  52 _gst_parse_escape (const gchar * str)
  53 {
  54   GString *gstr = NULL;
  55   gchar *newstr = NULL;
  56
  57   g_return_val_if_fail (str != NULL, NULL);
  58
  59   gstr = g_string_sized_new (strlen (str));
  60
  61   while (*str) {
  62     if (*str == ' ')
  63       g_string_append_c (gstr, '\\');
  64     g_string_append_c (gstr, *str);
  65     str++;
  66   }
  67
  68   newstr = gstr->str;
  69   g_string_free (gstr, FALSE);
  70
  71   return newstr;
  72 }
  73
  74 /**
  75  * gst_parse_launchv:
  76  * @argv: null-terminated array of arguments
  77  * @error: pointer to a #GError
  78  *
  79  * Create a new element based on command line syntax.
  80  * @error will contain an error message if an erroneuos pipeline is specified.
  81  * An error does not mean that the pipeline could not be constructed.
  82  *
  83  * Returns: a new element on success and %NULL on failure.
  84  */
  85 GstElement *
  86 gst_parse_launchv (const gchar ** argv, GError ** error)
  87 {
  88   GstElement *element;
  89   GString *str;
  90   const gchar **argvp, *arg;
  91   gchar *tmp;
  92
  93   g_return_val_if_fail (argv != NULL, NULL);
  94
  95   /* let's give it a nice size. */
  96   str = g_string_sized_new (1024);
  97
  98   argvp = argv;
  99   while (*argvp) {
 100     arg = *argvp;
 101     tmp = _gst_parse_escape (arg);
 102     g_string_append (str, tmp);
 103     g_free (tmp);
 104     g_string_append (str, " ");
 105     argvp++;
 106   }
 107
 108   element = gst_parse_launch (str->str, error);
 109
 110   g_string_free (str, TRUE);
 111
 112   return element;
 113 }
 114
 115 /**
 116  * gst_parse_launch:
 117  * @pipeline_description: the command line describing the pipeline
 118  * @error: the error message in case of an erroneous pipeline.
 119  *
 120  * Create a new pipeline based on command line syntax.
 121  * Please note that you might get a return value that is not %NULL even though
 122  * the @error is set. In this case there was a recoverable parsing error and you
 123  * can try to play the pipeline.
 124  *
 125  * Returns: a new element on success, %NULL on failure. If more than one toplevel
 126  * element is specified by the @pipeline_description, all elements are put into
 127  * a #GstPipeline, which than is returned.
 128  */
 129 GstElement *
 130 gst_parse_launch (const gchar * pipeline_description, GError ** error)
 131 {
 132   GstElement *element;
 133   static GStaticMutex flex_lock = G_STATIC_MUTEX_INIT;
 134
 135   g_return_val_if_fail (pipeline_description != NULL, NULL);
 136
 137   GST_CAT_INFO (GST_CAT_PIPELINE, "parsing pipeline description %s",
 138       pipeline_description);
 139
 140   /* the need for the mutex will go away with flex 2.5.6 */
 141   g_static_mutex_lock (&flex_lock);
 142   element = _gst_parse_launch (pipeline_description, error);
 143   g_static_mutex_unlock (&flex_lock);
 144
 145   return element;
 146 }