| 1 | /* GStreamer |
|---|
| 2 | * Copyright (C) 2003 David A. Schleef <ds@schleef.org> |
|---|
| 3 | * |
|---|
| 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. |
|---|
| 8 | * |
|---|
| 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. |
|---|
| 13 | * |
|---|
| 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. |
|---|
| 18 | */ |
|---|
| 19 | |
|---|
| 20 | #ifndef __GST_STRUCTURE_H__ |
|---|
| 21 | #define __GST_STRUCTURE_H__ |
|---|
| 22 | |
|---|
| 23 | #include <gst/gstconfig.h> |
|---|
| 24 | #include <gst/gsttypes.h> |
|---|
| 25 | #include <glib-object.h> |
|---|
| 26 | |
|---|
| 27 | G_BEGIN_DECLS |
|---|
| 28 | |
|---|
| 29 | #define GST_TYPE_STRUCTURE (gst_structure_get_type ()) |
|---|
| 30 | #define GST_STRUCTURE(object) ((GstStructure *)(object)) |
|---|
| 31 | #define GST_IS_STRUCTURE(object) ((object) && (GST_STRUCTURE(object)->type == GST_TYPE_STRUCTURE)) |
|---|
| 32 | |
|---|
| 33 | typedef struct _GstStructure GstStructure; |
|---|
| 34 | |
|---|
| 35 | typedef gboolean (*GstStructureForeachFunc) (GQuark field_id, |
|---|
| 36 | GValue * value, |
|---|
| 37 | gpointer user_data); |
|---|
| 38 | |
|---|
| 39 | struct _GstStructure { |
|---|
| 40 | GType type; |
|---|
| 41 | |
|---|
| 42 | GQuark name; |
|---|
| 43 | |
|---|
| 44 | GArray *fields; |
|---|
| 45 | |
|---|
| 46 | gpointer _gst_reserved[GST_PADDING]; |
|---|
| 47 | }; |
|---|
| 48 | |
|---|
| 49 | GType gst_structure_get_type (void) G_GNUC_CONST; |
|---|
| 50 | |
|---|
| 51 | GstStructure * gst_structure_empty_new (const gchar * name); |
|---|
| 52 | GstStructure * gst_structure_id_empty_new (GQuark quark); |
|---|
| 53 | GstStructure * gst_structure_new (const gchar * name, |
|---|
| 54 | const gchar * firstfield, |
|---|
| 55 | ...); |
|---|
| 56 | GstStructure * gst_structure_new_valist (const gchar * name, |
|---|
| 57 | const gchar * firstfield, |
|---|
| 58 | va_list varargs); |
|---|
| 59 | GstStructure * gst_structure_copy (const GstStructure *structure); |
|---|
| 60 | void gst_structure_free (GstStructure *structure); |
|---|
| 61 | |
|---|
| 62 | G_CONST_RETURN gchar * gst_structure_get_name (const GstStructure *structure); |
|---|
| 63 | GQuark gst_structure_get_name_id (const GstStructure *structure); |
|---|
| 64 | void gst_structure_set_name (GstStructure *structure, |
|---|
| 65 | const gchar *name); |
|---|
| 66 | |
|---|
| 67 | void gst_structure_id_set_value (GstStructure *structure, |
|---|
| 68 | GQuark field, |
|---|
| 69 | const GValue *value); |
|---|
| 70 | void gst_structure_set_value (GstStructure *structure, |
|---|
| 71 | const gchar *fieldname, |
|---|
| 72 | const GValue *value); |
|---|
| 73 | void gst_structure_set (GstStructure *structure, |
|---|
| 74 | const gchar *fieldname, |
|---|
| 75 | ...); |
|---|
| 76 | void gst_structure_set_valist (GstStructure *structure, |
|---|
| 77 | const gchar *fieldname, |
|---|
| 78 | va_list varargs); |
|---|
| 79 | G_CONST_RETURN GValue * gst_structure_id_get_value (const GstStructure *structure, |
|---|
| 80 | GQuark field); |
|---|
| 81 | G_CONST_RETURN GValue * gst_structure_get_value (const GstStructure *structure, |
|---|
| 82 | const gchar *fieldname); |
|---|
| 83 | void gst_structure_remove_field (GstStructure *structure, |
|---|
| 84 | const gchar *fieldname); |
|---|
| 85 | void gst_structure_remove_fields (GstStructure *structure, |
|---|
| 86 | const gchar *fieldname, |
|---|
| 87 | ...); |
|---|
| 88 | void gst_structure_remove_fields_valist (GstStructure *structure, |
|---|
| 89 | const gchar *fieldname, |
|---|
| 90 | va_list varargs); |
|---|
| 91 | void gst_structure_remove_all_fields (GstStructure *structure); |
|---|
| 92 | |
|---|
| 93 | GType gst_structure_get_field_type (const GstStructure *structure, |
|---|
| 94 | const gchar *fieldname); |
|---|
| 95 | gboolean gst_structure_foreach (GstStructure *structure, |
|---|
| 96 | GstStructureForeachFunc func, |
|---|
| 97 | gpointer user_data); |
|---|
| 98 | gint gst_structure_n_fields (const GstStructure *structure); |
|---|
| 99 | gboolean gst_structure_has_field (const GstStructure *structure, |
|---|
| 100 | const gchar *fieldname); |
|---|
| 101 | gboolean gst_structure_has_field_typed (const GstStructure *structure, |
|---|
| 102 | const gchar *fieldname, |
|---|
| 103 | GType type); |
|---|
| 104 | |
|---|
| 105 | /* utility functions */ |
|---|
| 106 | gboolean gst_structure_get_boolean (const GstStructure *structure, |
|---|
| 107 | const gchar *fieldname, |
|---|
| 108 | gboolean *value); |
|---|
| 109 | gboolean gst_structure_get_int (const GstStructure *structure, |
|---|
| 110 | const gchar *fieldname, |
|---|
| 111 | gint *value); |
|---|
| 112 | gboolean gst_structure_get_fourcc (const GstStructure *structure, |
|---|
| 113 | const gchar *fieldname, |
|---|
| 114 | guint32 *value); |
|---|
| 115 | gboolean gst_structure_get_double (const GstStructure *structure, |
|---|
| 116 | const gchar *fieldname, |
|---|
| 117 | gdouble *value); |
|---|
| 118 | G_CONST_RETURN gchar * gst_structure_get_string (const GstStructure *structure, |
|---|
| 119 | const gchar *fieldname); |
|---|
| 120 | |
|---|
| 121 | gchar * gst_structure_to_string (const GstStructure *structure); |
|---|
| 122 | GstStructure * gst_structure_from_string (const gchar *string, |
|---|
| 123 | gchar **end); |
|---|
| 124 | |
|---|
| 125 | G_END_DECLS |
|---|
| 126 | |
|---|
| 127 | #endif |
|---|
| 128 | |
|---|
