gstreamer_core/gst/gstparse.h
author hgs
Wed, 24 Mar 2010 18:04:17 -0500
changeset 16 8e837d1bf446
parent 0 0e761a78d257
child 10 6f340f756486
permissions -rw-r--r--
201009
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     1
/* GStreamer
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     2
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
 *                    2000 Wim Taymans <wtay@chello.be>
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     4
 *
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     5
 * gstparse.h: get a pipeline from a text pipeline description
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     6
 *
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     7
 * This library is free software; you can redistribute it and/or
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     8
 * modify it under the terms of the GNU Library General Public
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
 * License as published by the Free Software Foundation; either
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    10
 * version 2 of the License, or (at your option) any later version.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    11
 *
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    12
 * This library is distributed in the hope that it will be useful,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    15
 * Library General Public License for more details.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    16
 *
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
 * You should have received a copy of the GNU Library General Public
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    18
 * License along with this library; if not, write to the
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    19
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    20
 * Boston, MA 02111-1307, USA.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    21
 */
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    22
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    23
#ifndef __GST_PARSE_H__
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
#define __GST_PARSE_H__
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    26
#include <gst/gstelement.h>
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    27
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    28
G_BEGIN_DECLS
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    29
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    30
GQuark gst_parse_error_quark (void);
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    31
/**
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    32
 * GST_PARSE_ERROR:
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    33
 *
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    34
 * Get access to the error quark of the parse subsystem.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    35
 */
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    36
#define GST_PARSE_ERROR gst_parse_error_quark ()
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    37
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    38
/**
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    39
 * GstParseError:
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    40
 * @GST_PARSE_ERROR_SYNTAX: A syntax error occured.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    41
 * @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    42
 * @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    43
 * @GST_PARSE_ERROR_LINK: There was an error linking two pads.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    44
 * @GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY: There was an error setting a property
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    45
 * @GST_PARSE_ERROR_EMPTY_BIN: An empty bin was specified.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    46
 * @GST_PARSE_ERROR_EMPTY: An empty description was specified
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    47
 *
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    48
 * The different parsing errors that can occur.
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    49
 */
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    50
typedef enum
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    51
{
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    52
  GST_PARSE_ERROR_SYNTAX,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    53
  GST_PARSE_ERROR_NO_SUCH_ELEMENT,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    54
  GST_PARSE_ERROR_NO_SUCH_PROPERTY,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    55
  GST_PARSE_ERROR_LINK,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    56
  GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    57
  GST_PARSE_ERROR_EMPTY_BIN,
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    58
  GST_PARSE_ERROR_EMPTY
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    59
} GstParseError;
16
hgs
parents: 0
diff changeset
    60
hgs
parents: 0
diff changeset
    61
/**
hgs
parents: 0
diff changeset
    62
 * GstParseFlags:
hgs
parents: 0
diff changeset
    63
 * @GST_PARSE_FLAG_NONE: Do not use any special parsing options.
hgs
parents: 0
diff changeset
    64
 * @GST_PARSE_FLAG_FATAL_ERRORS: Always return NULL when an error occurs
hgs
parents: 0
diff changeset
    65
 *     (default behaviour is to return partially constructed bins or elements
hgs
parents: 0
diff changeset
    66
 *      in some cases)
hgs
parents: 0
diff changeset
    67
 *
hgs
parents: 0
diff changeset
    68
 * Parsing options.
hgs
parents: 0
diff changeset
    69
 *
hgs
parents: 0
diff changeset
    70
 * Since: 0.10.20
hgs
parents: 0
diff changeset
    71
 */
hgs
parents: 0
diff changeset
    72
typedef enum
hgs
parents: 0
diff changeset
    73
{
hgs
parents: 0
diff changeset
    74
  GST_PARSE_FLAG_NONE = 0,
hgs
parents: 0
diff changeset
    75
  GST_PARSE_FLAG_FATAL_ERRORS = (1 << 0)
hgs
parents: 0
diff changeset
    76
} GstParseFlags;
hgs
parents: 0
diff changeset
    77
hgs
parents: 0
diff changeset
    78
/**
hgs
parents: 0
diff changeset
    79
 * GstParseContext:
hgs
parents: 0
diff changeset
    80
 *
hgs
parents: 0
diff changeset
    81
 * Opaque structure.
hgs
parents: 0
diff changeset
    82
 *
hgs
parents: 0
diff changeset
    83
 * Since: 0.10.20
hgs
parents: 0
diff changeset
    84
 */
hgs
parents: 0
diff changeset
    85
typedef struct _GstParseContext GstParseContext;
hgs
parents: 0
diff changeset
    86
hgs
parents: 0
diff changeset
    87
/* create, process and free a parse context */
hgs
parents: 0
diff changeset
    88
#ifdef __SYMBIAN32__
hgs
parents: 0
diff changeset
    89
IMPORT_C
hgs
parents: 0
diff changeset
    90
#endif
hgs
parents: 0
diff changeset
    91
hgs
parents: 0
diff changeset
    92
hgs
parents: 0
diff changeset
    93
GstParseContext * gst_parse_context_new (void);
0
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    94
#ifdef __SYMBIAN32__
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    95
IMPORT_C
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    96
#endif
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    97
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    98
16
hgs
parents: 0
diff changeset
    99
gchar          ** gst_parse_context_get_missing_elements (GstParseContext * context);
hgs
parents: 0
diff changeset
   100
#ifdef __SYMBIAN32__
hgs
parents: 0
diff changeset
   101
IMPORT_C
hgs
parents: 0
diff changeset
   102
#endif
0
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   103
16
hgs
parents: 0
diff changeset
   104
hgs
parents: 0
diff changeset
   105
void              gst_parse_context_free (GstParseContext * context);
hgs
parents: 0
diff changeset
   106
hgs
parents: 0
diff changeset
   107
hgs
parents: 0
diff changeset
   108
/* parse functions */
hgs
parents: 0
diff changeset
   109
#ifdef __SYMBIAN32__
hgs
parents: 0
diff changeset
   110
IMPORT_C
hgs
parents: 0
diff changeset
   111
#endif
hgs
parents: 0
diff changeset
   112
hgs
parents: 0
diff changeset
   113
hgs
parents: 0
diff changeset
   114
GstElement      * gst_parse_launch       (const gchar      * pipeline_description,
hgs
parents: 0
diff changeset
   115
                                          GError          ** error);
0
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   116
#ifdef __SYMBIAN32__
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   117
IMPORT_C
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   118
#endif
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   119
16
hgs
parents: 0
diff changeset
   120
hgs
parents: 0
diff changeset
   121
GstElement      * gst_parse_launchv      (const gchar     ** argv,
hgs
parents: 0
diff changeset
   122
                                          GError          ** error);
hgs
parents: 0
diff changeset
   123
#ifdef __SYMBIAN32__
hgs
parents: 0
diff changeset
   124
IMPORT_C
hgs
parents: 0
diff changeset
   125
#endif
hgs
parents: 0
diff changeset
   126
hgs
parents: 0
diff changeset
   127
hgs
parents: 0
diff changeset
   128
GstElement      * gst_parse_launch_full  (const gchar      * pipeline_description,
hgs
parents: 0
diff changeset
   129
                                          GstParseContext  * context,
hgs
parents: 0
diff changeset
   130
                                          GstParseFlags      flags,
hgs
parents: 0
diff changeset
   131
                                          GError          ** error);
hgs
parents: 0
diff changeset
   132
#ifdef __SYMBIAN32__
hgs
parents: 0
diff changeset
   133
IMPORT_C
hgs
parents: 0
diff changeset
   134
#endif
hgs
parents: 0
diff changeset
   135
hgs
parents: 0
diff changeset
   136
hgs
parents: 0
diff changeset
   137
GstElement      * gst_parse_launchv_full (const gchar     ** argv,
hgs
parents: 0
diff changeset
   138
                                          GstParseContext  * context,
hgs
parents: 0
diff changeset
   139
                                          GstParseFlags      flags,
hgs
parents: 0
diff changeset
   140
                                          GError          ** error);
0
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   141
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   142
G_END_DECLS
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   143
0e761a78d257 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   144
#endif /* __GST_PARSE_H__ */