fix doc build fix autogen
[platform/upstream/gstreamer.git] / 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 #include <string.h>
25
26 #include "gst_private.h"
27
28 #include "gstparse.h"
29 #include "gstinfo.h"
30
31 extern GstElement *_gst_parse_launch (const gchar *, GError **);
32
33 GQuark 
34 gst_parse_error_quark (void)
35 {
36   static GQuark quark = 0;
37   if (!quark)
38     quark = g_quark_from_static_string ("gst_parse_error");
39   return quark;
40 }
41
42 static gchar *_gst_parse_escape (const gchar *str)
43 {
44   GString *gstr = NULL;
45   
46   g_return_val_if_fail (str != NULL, NULL);
47   
48   gstr = g_string_sized_new (strlen (str));
49   
50   while (*str) {
51     if (*str == ' ')
52       g_string_append_c (gstr, '\\');
53     g_string_append_c (gstr, *str);
54     str++;
55   }
56   
57   return gstr->str;
58 }
59 /**
60  * gst_parse_launchv:
61  * @argv: null-terminated array of arguments
62  * @error: pointer to a #GError
63  *
64  * Create a new element based on command line syntax.
65  * #error will contain an error message if an erroneuos pipeline is specified.
66  * An error does not mean that the pipeline could not be constructed.
67  *
68  * Returns: a new element on success and NULL on failure.
69  */
70 GstElement *
71 gst_parse_launchv (const gchar **argv, GError **error)
72 {
73   GstElement *element;
74   GString *str;
75   const gchar **argvp, *arg;
76   gchar *tmp;
77
78   g_return_val_if_fail (argv != NULL, NULL);
79
80   /* let's give it a nice size. */
81   str = g_string_sized_new (1024);
82
83   argvp = argv;
84   while (*argvp) {
85     arg = *argvp;
86     tmp = _gst_parse_escape (arg);
87     g_string_append (str, tmp);
88     g_free (tmp);
89     g_string_append (str, " ");
90     argvp++;
91   }
92   
93   element = gst_parse_launch (str->str, error);
94
95   g_string_free (str, TRUE);
96
97   return element;
98 }
99
100 /**
101  * gst_parse_launch:
102  * @pipeline_description: the command line describing the pipeline
103  * @error: the error message in case of an erroneous pipeline.
104  *
105  * Create a new pipeline based on command line syntax.
106  * Please note that you might get a return value that is not NULL even though
107  * the error is set. In this case there was a recoverable parsing error and you
108  * can try to play the pipeline.
109  *
110  * Returns: a new element on success, NULL on failure. If more than one toplevel
111  * element is specified by the pipeline_description, all elements are put into
112  * a #GstPipeline ant that is returned.
113  */
114 GstElement *
115 gst_parse_launch (const gchar * pipeline_description, GError **error)
116 {
117   GstElement *element;
118   static GStaticMutex flex_lock = G_STATIC_MUTEX_INIT;
119
120   g_return_val_if_fail (pipeline_description != NULL, NULL);
121
122   GST_CAT_INFO (GST_CAT_PIPELINE, "parsing pipeline description %s",
123             pipeline_description);
124
125   /* the need for the mutex will go away with flex 2.5.6 */
126   g_static_mutex_lock (&flex_lock);
127   element = _gst_parse_launch (pipeline_description, error);
128   g_static_mutex_unlock (&flex_lock);
129
130   return element;
131 }