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 /**
  42  * gst_parse_error_quark:
  43  *
  44  * Get the error quark used by the parsing subsystem.
  45  *
  46  * Returns: the quark of the parse errors.
  47  */
  48 GQuark
  49 gst_parse_error_quark (void)
  50 {
  51   static GQuark quark = 0;
  52
  53   if (!quark)
  54     quark = g_quark_from_static_string ("gst_parse_error");
  55   return quark;
  56 }
  57
  58 static gchar *
  59 _gst_parse_escape (const gchar * str)
  60 {
  61   GString *gstr = NULL;
  62   gchar *newstr = NULL;
  63
  64   g_return_val_if_fail (str != NULL, NULL);
  65
  66   gstr = g_string_sized_new (strlen (str));
  67
  68   while (*str) {
  69     if (*str == ' ')
  70       g_string_append_c (gstr, '\\');
  71     g_string_append_c (gstr, *str);
  72     str++;
  73   }
  74
  75   newstr = gstr->str;
  76   g_string_free (gstr, FALSE);
  77
  78   return newstr;
  79 }
  80
  81 /**
  82  * gst_parse_launchv:
  83  * @argv: null-terminated array of arguments
  84  * @error: pointer to a #GError
  85  *
  86  * Create a new element based on command line syntax.
  87  * @error will contain an error message if an erroneuos pipeline is specified.
  88  * An error does not mean that the pipeline could not be constructed.
  89  *
  90  * Returns: a new element on success and %NULL on failure.
  91  */
  92 GstElement *
  93 gst_parse_launchv (const gchar ** argv, GError ** error)
  94 {
  95   GstElement *element;
  96   GString *str;
  97   const gchar **argvp, *arg;
  98   gchar *tmp;
  99
 100   g_return_val_if_fail (argv != NULL, NULL);
 101
 102   /* let's give it a nice size. */
 103   str = g_string_sized_new (1024);
 104
 105   argvp = argv;
 106   while (*argvp) {
 107     arg = *argvp;
 108     tmp = _gst_parse_escape (arg);
 109     g_string_append (str, tmp);
 110     g_free (tmp);
 111     g_string_append (str, " ");
 112     argvp++;
 113   }
 114
 115   element = gst_parse_launch (str->str, error);
 116
 117   g_string_free (str, TRUE);
 118
 119   return element;
 120 }
 121
 122 /**
 123  * gst_parse_launch:
 124  * @pipeline_description: the command line describing the pipeline
 125  * @error: the error message in case of an erroneous pipeline.
 126  *
 127  * Create a new pipeline based on command line syntax.
 128  * Please note that you might get a return value that is not %NULL even though
 129  * the @error is set. In this case there was a recoverable parsing error and you
 130  * can try to play the pipeline.
 131  *
 132  * Returns: a new element on success, %NULL on failure. If more than one toplevel
 133  * element is specified by the @pipeline_description, all elements are put into
 134  * a #GstPipeline, which than is returned.
 135  */
 136 GstElement *
 137 gst_parse_launch (const gchar * pipeline_description, GError ** error)
 138 {
 139   GstElement *element;
 140   static GStaticMutex flex_lock = G_STATIC_MUTEX_INIT;
 141
 142   g_return_val_if_fail (pipeline_description != NULL, NULL);
 143
 144   GST_CAT_INFO (GST_CAT_PIPELINE, "parsing pipeline description %s",
 145       pipeline_description);
 146
 147   /* the need for the mutex will go away with flex 2.5.6 */
 148   g_static_mutex_lock (&flex_lock);
 149   element = _gst_parse_launch (pipeline_description, error);
 150   g_static_mutex_unlock (&flex_lock);
 151
 152   return element;
 153 }