1 /* GStreamer
2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
4 *
5 * gstxml.h: Header for XML save/restore operations of pipelines
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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
21 */
23 #ifndef __GST_XML_H__
24 #define __GST_XML_H__
26 #include <gst/gstconfig.h>
28 #ifndef GST_DISABLE_DEPRECATED
29 #ifndef GST_DISABLE_LOADSAVE
31 #include <gst/gstelement.h>
33 G_BEGIN_DECLS
35 #define GST_TYPE_XML (gst_xml_get_type ())
36 #define GST_XML(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_XML, GstXML))
37 #define GST_IS_XML(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_XML))
38 #define GST_XML_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_XML, GstXMLClass))
39 #define GST_IS_XML_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_XML))
40 #define GST_XML_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_XML, GstXMLClass))
42 typedef struct _GstXML GstXML;
43 typedef struct _GstXMLClass GstXMLClass;
45 /**
46 * GstXML:
47 * @topelements: list of element nodes
48 * @ns: name space
49 *
50 * XML parser object
51 */
52 struct _GstXML {
53 GstObject object;
55 /*< public >*/
56 GList *topelements;
58 xmlNsPtr ns;
60 /*< private >*/
61 gpointer _gst_reserved[GST_PADDING];
62 };
64 struct _GstXMLClass {
65 GstObjectClass parent_class;
67 /* signal callbacks */
68 void (*object_loaded) (GstXML *xml, GstObject *object, xmlNodePtr self);
69 void (*object_saved) (GstXML *xml, GstObject *object, xmlNodePtr self);
71 gpointer _gst_reserved[GST_PADDING];
72 };
74 GType gst_xml_get_type (void);
77 /* create an XML document out of a pipeline */
78 xmlDocPtr gst_xml_write (GstElement *element);
80 /* write a formatted representation of a pipeline to an open file */
81 gint gst_xml_write_file (GstElement *element, FILE *out);
83 GstXML* gst_xml_new (void);
85 gboolean gst_xml_parse_doc (GstXML *xml, xmlDocPtr doc, const guchar *root);
86 gboolean gst_xml_parse_file (GstXML *xml, const guchar *fname, const guchar *root);
87 gboolean gst_xml_parse_memory (GstXML *xml, guchar *buffer, guint size, const gchar *root);
90 GstElement* gst_xml_get_element (GstXML *xml, const guchar *name);
91 GList* gst_xml_get_topelements (GstXML *xml);
93 GstElement* gst_xml_make_element (xmlNodePtr cur, GstObject *parent);
95 G_END_DECLS
97 #else /* GST_DISABLE_LOADSAVE */
99 #if defined __GNUC__ && __GNUC__ >= 3
100 #pragma GCC poison gst_xml_write
101 #pragma GCC poison gst_xml_new
102 #pragma GCC poison gst_xml_parse_doc
103 #pragma GCC poison gst_xml_parse_file
104 #pragma GCC poison gst_xml_parse_memory
105 #pragma GCC poison gst_xml_get_element
106 #pragma GCC poison gst_xml_get_topelements
107 #endif
109 #endif /* GST_DISABLE_LOADSAVE */
111 #endif
113 #endif /* __GST_XML_H__ */