diff options
Diffstat (limited to 'include/gst/gstparse.h')
| -rw-r--r-- | include/gst/gstparse.h | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/include/gst/gstparse.h b/include/gst/gstparse.h new file mode 100644 index 0000000000..8dfe8e5d3a --- /dev/null +++ b/include/gst/gstparse.h @@ -0,0 +1,138 @@ +/* GStreamer + * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu> + * 2000 Wim Taymans <wtay@chello.be> + * + * gstparse.h: get a pipeline from a text pipeline description + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with this library; if not, write to the + * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + +#ifndef __GST_PARSE_H__ +#define __GST_PARSE_H__ + +#include <gst/gstelement.h> + +G_BEGIN_DECLS + +GST_API +GQuark gst_parse_error_quark (void); +/** + * GST_PARSE_ERROR: + * + * Get access to the error quark of the parse subsystem. + */ +#define GST_PARSE_ERROR gst_parse_error_quark () + +/* FIXME 2.0: rename to GstParseLaunchError, this is not only related to + *parsing */ +/** + * GstParseError: + * @GST_PARSE_ERROR_SYNTAX: A syntax error occurred. + * @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element + * @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property + * @GST_PARSE_ERROR_LINK: There was an error linking two pads. + * @GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY: There was an error setting a property + * @GST_PARSE_ERROR_EMPTY_BIN: An empty bin was specified. + * @GST_PARSE_ERROR_EMPTY: An empty description was specified + * @GST_PARSE_ERROR_DELAYED_LINK: A delayed link did not get resolved. + * + * The different parsing errors that can occur. + */ +typedef enum +{ + GST_PARSE_ERROR_SYNTAX, + GST_PARSE_ERROR_NO_SUCH_ELEMENT, + GST_PARSE_ERROR_NO_SUCH_PROPERTY, + GST_PARSE_ERROR_LINK, + GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY, + GST_PARSE_ERROR_EMPTY_BIN, + GST_PARSE_ERROR_EMPTY, + GST_PARSE_ERROR_DELAYED_LINK +} GstParseError; + +/** + * GstParseFlags: + * @GST_PARSE_FLAG_NONE: Do not use any special parsing options. + * @GST_PARSE_FLAG_FATAL_ERRORS: Always return %NULL when an error occurs + * (default behaviour is to return partially constructed bins or elements + * in some cases) + * @GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS: If a bin only has a single element, + * just return the element. + * @GST_PARSE_FLAG_PLACE_IN_BIN: If more than one toplevel element is described + * by the pipeline description string, put them in a #GstBin instead of a + * #GstPipeline. (Since: 1.10) + * + * Parsing options. + */ +typedef enum +{ + GST_PARSE_FLAG_NONE = 0, + GST_PARSE_FLAG_FATAL_ERRORS = (1 << 0), + GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS = (1 << 1), + GST_PARSE_FLAG_PLACE_IN_BIN = (1 << 2) +} GstParseFlags; + +#define GST_TYPE_PARSE_CONTEXT (gst_parse_context_get_type()) + +/** + * GstParseContext: + * + * Opaque structure. + */ +typedef struct _GstParseContext GstParseContext; + +/* create, process and free a parse context */ + +GST_API +GType gst_parse_context_get_type (void); + +GST_API +GstParseContext * gst_parse_context_new (void) G_GNUC_MALLOC; + +GST_API +gchar ** gst_parse_context_get_missing_elements (GstParseContext * context) G_GNUC_MALLOC; + +GST_API +void gst_parse_context_free (GstParseContext * context); + +GST_API +GstParseContext * gst_parse_context_copy (const GstParseContext * context); + + +/* parse functions */ + +GST_API +GstElement * gst_parse_launch (const gchar * pipeline_description, + GError ** error) G_GNUC_MALLOC; +GST_API +GstElement * gst_parse_launchv (const gchar ** argv, + GError ** error) G_GNUC_MALLOC; +GST_API +GstElement * gst_parse_launch_full (const gchar * pipeline_description, + GstParseContext * context, + GstParseFlags flags, + GError ** error) G_GNUC_MALLOC; +GST_API +GstElement * gst_parse_launchv_full (const gchar ** argv, + GstParseContext * context, + GstParseFlags flags, + GError ** error) G_GNUC_MALLOC; + +G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstParseContext, gst_parse_context_free) + +G_END_DECLS + +#endif /* __GST_PARSE_H__ */ |