2 * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #ifndef __GST_STRUCTURE_H__
21 #define __GST_STRUCTURE_H__
23 #include <gst/gstconfig.h>
24 #include <glib-object.h>
28 #define GST_TYPE_STRUCTURE (gst_structure_get_type ())
29 #define GST_STRUCTURE(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GST_TYPE_STRUCTURE, GstStructure))
30 #define GST_IS_STRUCTURE(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GST_TYPE_STRUCTURE))
32 typedef struct _GstStructure GstStructure;
34 typedef gboolean (*GstStructureForeachFunc) (GQuark field_id,
38 struct _GstStructure {
45 gpointer _gst_reserved[GST_PADDING];
48 GType gst_structure_get_type (void) G_GNUC_CONST;
50 GstStructure * gst_structure_empty_new (const gchar * name);
51 GstStructure * gst_structure_id_empty_new (GQuark quark);
52 GstStructure * gst_structure_new (const gchar * name,
53 const gchar * firstfield,
55 GstStructure * gst_structure_new_valist (const gchar * name,
56 const gchar * firstfield,
58 GstStructure * gst_structure_copy (const GstStructure *structure);
59 void gst_structure_free (GstStructure *structure);
61 G_CONST_RETURN gchar * gst_structure_get_name (const GstStructure *structure);
62 void gst_structure_set_name (GstStructure *structure,
65 void gst_structure_id_set_value (GstStructure *structure,
68 void gst_structure_set_value (GstStructure *structure,
69 const gchar *fieldname,
71 void gst_structure_set (GstStructure *structure,
72 const gchar *fieldname,
74 void gst_structure_set_valist (GstStructure *structure,
75 const gchar *fieldname,
77 G_CONST_RETURN GValue * gst_structure_id_get_value (const GstStructure *structure,
79 G_CONST_RETURN GValue * gst_structure_get_value (const GstStructure *structure,
80 const gchar *fieldname);
81 void gst_structure_remove_field (GstStructure *structure,
82 const gchar *fieldname);
83 void gst_structure_remove_fields (GstStructure *structure,
84 const gchar *fieldname,
86 void gst_structure_remove_fields_valist (GstStructure *structure,
87 const gchar *fieldname,
89 void gst_structure_remove_all_fields (GstStructure *structure);
91 GType gst_structure_get_field_type (const GstStructure *structure,
92 const gchar *fieldname);
93 gboolean gst_structure_foreach (GstStructure *structure,
94 GstStructureForeachFunc func,
96 gint gst_structure_n_fields (const GstStructure *structure);
97 gboolean gst_structure_has_field (const GstStructure *structure,
98 const gchar *fieldname);
99 gboolean gst_structure_has_field_typed (const GstStructure *structure,
100 const gchar *fieldname,
103 /* utility functions */
104 gboolean gst_structure_get_boolean (const GstStructure *structure,
105 const gchar *fieldname,
107 gboolean gst_structure_get_int (const GstStructure *structure,
108 const gchar *fieldname,
110 gboolean gst_structure_get_fourcc (const GstStructure *structure,
111 const gchar *fieldname,
113 gboolean gst_structure_get_double (const GstStructure *structure,
114 const gchar *fieldname,
116 G_CONST_RETURN gchar * gst_structure_get_string (const GstStructure *structure,
117 const gchar *fieldname);
119 gchar * gst_structure_to_string (const GstStructure *structure);
120 GstStructure * gst_structure_from_string (const gchar *string,