core: Add g_autoptr() support to all types
[platform/upstream/gstreamer.git] / gst / gstparse.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstparse.h: get a pipeline from a text pipeline description
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 #ifndef __GST_PARSE_H__
24 #define __GST_PARSE_H__
25
26 #include <gst/gstelement.h>
27
28 G_BEGIN_DECLS
29
30 GQuark gst_parse_error_quark (void);
31 /**
32  * GST_PARSE_ERROR:
33  *
34  * Get access to the error quark of the parse subsystem.
35  */
36 #define GST_PARSE_ERROR gst_parse_error_quark ()
37
38 /**
39  * GstParseError:
40  * @GST_PARSE_ERROR_SYNTAX: A syntax error occurred.
41  * @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element
42  * @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property
43  * @GST_PARSE_ERROR_LINK: There was an error linking two pads.
44  * @GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY: There was an error setting a property
45  * @GST_PARSE_ERROR_EMPTY_BIN: An empty bin was specified.
46  * @GST_PARSE_ERROR_EMPTY: An empty description was specified
47  *
48  * The different parsing errors that can occur.
49  */
50 typedef enum
51 {
52   GST_PARSE_ERROR_SYNTAX,
53   GST_PARSE_ERROR_NO_SUCH_ELEMENT,
54   GST_PARSE_ERROR_NO_SUCH_PROPERTY,
55   GST_PARSE_ERROR_LINK,
56   GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY,
57   GST_PARSE_ERROR_EMPTY_BIN,
58   GST_PARSE_ERROR_EMPTY
59 } GstParseError;
60
61 /**
62  * GstParseFlags:
63  * @GST_PARSE_FLAG_NONE: Do not use any special parsing options.
64  * @GST_PARSE_FLAG_FATAL_ERRORS: Always return %NULL when an error occurs
65  *     (default behaviour is to return partially constructed bins or elements
66  *      in some cases)
67  * @GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS: If a bin only has a single element,
68  *     just return the element.
69  *
70  * Parsing options.
71  */
72 typedef enum
73 {
74   GST_PARSE_FLAG_NONE = 0,
75   GST_PARSE_FLAG_FATAL_ERRORS = (1 << 0),
76   GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS = (1 << 1)
77 } GstParseFlags;
78
79 #define GST_TYPE_PARSE_CONTEXT (gst_parse_context_get_type())
80
81 /**
82  * GstParseContext:
83  *
84  * Opaque structure.
85  */
86 typedef struct _GstParseContext GstParseContext;
87
88 /* create, process and free a parse context */
89
90 GType             gst_parse_context_get_type (void);
91 GstParseContext * gst_parse_context_new (void) G_GNUC_MALLOC;
92
93 gchar          ** gst_parse_context_get_missing_elements (GstParseContext * context) G_GNUC_MALLOC;
94
95 void              gst_parse_context_free (GstParseContext * context);
96
97
98 /* parse functions */
99
100 GstElement      * gst_parse_launch       (const gchar      * pipeline_description,
101                                           GError          ** error) G_GNUC_MALLOC;
102
103 GstElement      * gst_parse_launchv      (const gchar     ** argv,
104                                           GError          ** error) G_GNUC_MALLOC;
105
106 GstElement      * gst_parse_launch_full  (const gchar      * pipeline_description,
107                                           GstParseContext  * context,
108                                           GstParseFlags      flags,
109                                           GError          ** error) G_GNUC_MALLOC;
110
111 GstElement      * gst_parse_launchv_full (const gchar     ** argv,
112                                           GstParseContext  * context,
113                                           GstParseFlags      flags,
114                                           GError          ** error) G_GNUC_MALLOC;
115
116 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
117 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstParseContext, gst_parse_context_free)
118 #endif
119
120 G_END_DECLS
121
122 #endif /* __GST_PARSE_H__ */