2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstparse.h: get a pipeline from a text pipeline description
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
23 #ifndef __GST_PARSE_H__
24 #define __GST_PARSE_H__
26 #include <gst/gstelement.h>
30 GQuark gst_parse_error_quark (void);
34 * Get access to the error quark of the parse subsystem.
36 #define GST_PARSE_ERROR gst_parse_error_quark ()
38 /* FIXME 2.0: rename to GstParseLaunchError, this is not only related to
42 * @GST_PARSE_ERROR_SYNTAX: A syntax error occurred.
43 * @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element
44 * @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property
45 * @GST_PARSE_ERROR_LINK: There was an error linking two pads.
46 * @GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY: There was an error setting a property
47 * @GST_PARSE_ERROR_EMPTY_BIN: An empty bin was specified.
48 * @GST_PARSE_ERROR_EMPTY: An empty description was specified
49 * @GST_PARSE_ERROR_DELAYED_LINK: A delayed link did not get resolved.
51 * The different parsing errors that can occur.
55 GST_PARSE_ERROR_SYNTAX,
56 GST_PARSE_ERROR_NO_SUCH_ELEMENT,
57 GST_PARSE_ERROR_NO_SUCH_PROPERTY,
59 GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY,
60 GST_PARSE_ERROR_EMPTY_BIN,
61 GST_PARSE_ERROR_EMPTY,
62 GST_PARSE_ERROR_DELAYED_LINK
67 * @GST_PARSE_FLAG_NONE: Do not use any special parsing options.
68 * @GST_PARSE_FLAG_FATAL_ERRORS: Always return %NULL when an error occurs
69 * (default behaviour is to return partially constructed bins or elements
71 * @GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS: If a bin only has a single element,
72 * just return the element.
73 * @GST_PARSE_FLAG_PLACE_IN_BIN: If more than one toplevel element is described
74 * by the pipeline description string, put them in a #GstBin instead of a
75 * #GstPipeline. (Since 1.10)
81 GST_PARSE_FLAG_NONE = 0,
82 GST_PARSE_FLAG_FATAL_ERRORS = (1 << 0),
83 GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS = (1 << 1),
84 GST_PARSE_FLAG_PLACE_IN_BIN = (1 << 2)
87 #define GST_TYPE_PARSE_CONTEXT (gst_parse_context_get_type())
94 typedef struct _GstParseContext GstParseContext;
96 /* create, process and free a parse context */
98 GType gst_parse_context_get_type (void);
99 GstParseContext * gst_parse_context_new (void) G_GNUC_MALLOC;
101 gchar ** gst_parse_context_get_missing_elements (GstParseContext * context) G_GNUC_MALLOC;
103 void gst_parse_context_free (GstParseContext * context);
106 /* parse functions */
108 GstElement * gst_parse_launch (const gchar * pipeline_description,
109 GError ** error) G_GNUC_MALLOC;
111 GstElement * gst_parse_launchv (const gchar ** argv,
112 GError ** error) G_GNUC_MALLOC;
114 GstElement * gst_parse_launch_full (const gchar * pipeline_description,
115 GstParseContext * context,
117 GError ** error) G_GNUC_MALLOC;
119 GstElement * gst_parse_launchv_full (const gchar ** argv,
120 GstParseContext * context,
122 GError ** error) G_GNUC_MALLOC;
124 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
125 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstParseContext, gst_parse_context_free)
130 #endif /* __GST_PARSE_H__ */