gst/gstxml.h

   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
   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  */
  22
  23 #ifndef __GST_XML_H__
  24 #define __GST_XML_H__
  25
  26 #include <gst/gstconfig.h>
  27
  28 #ifndef GST_DISABLE_LOADSAVE
  29
  30 #include <gst/gstelement.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GST_TYPE_XML            (gst_xml_get_type ())
  35 #define GST_XML(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_XML, GstXML))
  36 #define GST_IS_XML(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_XML))
  37 #define GST_XML_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_XML, GstXMLClass))
  38 #define GST_IS_XML_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_XML))
  39
  40 #define GST_XML_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_XML, GstXMLClass))
  41
  42 typedef struct _GstXML GstXML;
  43 typedef struct _GstXMLClass GstXMLClass;
  44
  45 struct _GstXML {
  46   GstObject object;
  47
  48   GList      *topelements;
  49
  50   xmlNsPtr ns;
  51
  52   gpointer _gst_reserved[GST_PADDING];
  53 };
  54
  55 typedef struct _GstXMLNs GstXMLNs;
  56
  57 struct _GstXMLClass {
  58   GstObjectClass parent_class;
  59
  60   /* signal callbacks */
  61   void (*object_loaded)         (GstXML *xml, GstObject *object, xmlNodePtr self);
  62   void (*object_saved)          (GstXML *xml, GstObject *object, xmlNodePtr self);
  63
  64   gpointer _gst_reserved[GST_PADDING];
  65 };
  66
  67 GType           gst_xml_get_type        (void);
  68
  69
  70 /* create an XML document out of a pipeline */
  71 xmlDocPtr       gst_xml_write           (GstElement *element);
  72
  73 /* write a formatted representation of a pipeline to an open file */
  74 gint            gst_xml_write_file      (GstElement *element, FILE *out);
  75
  76 GstXML*         gst_xml_new             (void);
  77
  78 gboolean        gst_xml_parse_doc       (GstXML *xml, xmlDocPtr doc, const guchar *root);
  79 gboolean        gst_xml_parse_file      (GstXML *xml, const guchar *fname, const guchar *root);
  80 gboolean        gst_xml_parse_memory    (GstXML *xml, guchar *buffer, guint size, const gchar *root);
  81
  82
  83 GstElement*     gst_xml_get_element     (GstXML *xml, const guchar *name);
  84 GList*          gst_xml_get_topelements (GstXML *xml);
  85
  86 GstElement*     gst_xml_make_element    (xmlNodePtr cur, GstObject *parent);
  87
  88 G_END_DECLS
  89
  90 #else /* GST_DISABLE_LOADSAVE */
  91
  92 #pragma GCC poison gst_xml_write
  93 #pragma GCC poison gst_xml_new
  94 #pragma GCC poison gst_xml_parse_doc
  95 #pragma GCC poison gst_xml_parse_file
  96 #pragma GCC poison gst_xml_parse_memory
  97 #pragma GCC poison gst_xml_get_element
  98 #pragma GCC poison gst_xml_get_topelements
  99
 100 #endif /* GST_DISABLE_LOADSAVE */
 101
 102 #endif /* __GST_XML_H__ */