structure: add function to fixate
[platform/upstream/gstreamer.git] / gst / gststructure.h
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 <glib-object.h>
25 #include <gst/gstclock.h>
26 #include <gst/gstdatetime.h>
27 #include <gst/glib-compat.h>
28
29 G_BEGIN_DECLS
30
31 extern GType _gst_structure_type;
32
33 typedef struct _GstStructure GstStructure;
34
35 #define GST_TYPE_STRUCTURE             (_gst_structure_type)
36 #define GST_IS_STRUCTURE(object)       ((object) && (GST_STRUCTURE(object)->type == GST_TYPE_STRUCTURE))
37 #define GST_STRUCTURE_CAST(object)     ((GstStructure *)(object))
38 #define GST_STRUCTURE(object)          (GST_STRUCTURE_CAST(object))
39
40
41 /**
42  * GstStructureForeachFunc:
43  * @field_id: the #GQuark of the field name
44  * @value: the #GValue of the field
45  * @user_data: user data
46  *
47  * A function that will be called in gst_structure_foreach(). The function may
48  * not modify @value.
49  *
50  * Returns: TRUE if the foreach operation should continue, FALSE if
51  * the foreach operation should stop with FALSE.
52  */
53 typedef gboolean (*GstStructureForeachFunc) (GQuark   field_id,
54                                              const GValue * value,
55                                              gpointer user_data);
56
57 /**
58  * GstStructureMapFunc:
59  * @field_id: the #GQuark of the field name
60  * @value: the #GValue of the field
61  * @user_data: user data
62  *
63  * A function that will be called in gst_structure_map_in_place(). The function
64  * may modify @value.
65  *
66  * Returns: TRUE if the map operation should continue, FALSE if
67  * the map operation should stop with FALSE.
68  */
69 typedef gboolean (*GstStructureMapFunc)     (GQuark   field_id,
70                                              GValue * value,
71                                              gpointer user_data);
72
73 /**
74  * GstStructure:
75  * @type: the GType of a structure
76  *
77  * The GstStructure object. Most fields are private.
78  */
79 struct _GstStructure {
80   GType type;
81
82   /*< private >*/
83   GQuark name;
84 };
85
86 GstStructure *          gst_structure_empty_new            (const gchar *            name);
87 GstStructure *          gst_structure_id_empty_new         (GQuark                   quark);
88 GstStructure *          gst_structure_new                  (const gchar *            name,
89                                                             const gchar *            firstfield,
90                                                             ...);
91 GstStructure *          gst_structure_new_valist           (const gchar *            name,
92                                                             const gchar *            firstfield,
93                                                             va_list                  varargs);
94 GstStructure *          gst_structure_id_new               (GQuark                   name_quark,
95                                                             GQuark                   field_quark,
96                                                             ...);
97 GstStructure *          gst_structure_copy                 (const GstStructure      *structure);
98 gboolean                gst_structure_set_parent_refcount  (GstStructure            *structure,
99                                                             gint                    *refcount);
100 void                    gst_structure_free                 (GstStructure            *structure);
101
102 const gchar *           gst_structure_get_name             (const GstStructure      *structure);
103 GQuark                  gst_structure_get_name_id          (const GstStructure      *structure);
104 gboolean                gst_structure_has_name             (const GstStructure      *structure,
105                                                             const gchar             *name);
106 void                    gst_structure_set_name             (GstStructure            *structure,
107                                                             const gchar             *name);
108
109 void                    gst_structure_id_set_value         (GstStructure            *structure,
110                                                             GQuark                   field,
111                                                             const GValue            *value);
112 void                    gst_structure_set_value            (GstStructure            *structure,
113                                                             const gchar             *fieldname,
114                                                             const GValue            *value);
115 void                    gst_structure_id_take_value         (GstStructure            *structure,
116                                                             GQuark                   field,
117                                                             GValue                  *value);
118 void                    gst_structure_take_value            (GstStructure            *structure,
119                                                             const gchar             *fieldname,
120                                                             GValue                  *value);
121 void                    gst_structure_set                  (GstStructure            *structure,
122                                                             const gchar             *fieldname,
123                                                             ...) G_GNUC_NULL_TERMINATED;
124
125 void                    gst_structure_set_valist           (GstStructure            *structure,
126                                                             const gchar             *fieldname,
127                                                             va_list varargs);
128
129 void                    gst_structure_id_set                (GstStructure            *structure,
130                                                             GQuark                   fieldname,
131                                                             ...) G_GNUC_NULL_TERMINATED;
132
133 void                    gst_structure_id_set_valist         (GstStructure            *structure,
134                                                             GQuark                   fieldname,
135                                                             va_list varargs);
136
137 gboolean                gst_structure_get_valist           (const GstStructure      *structure,
138                                                             const char              *first_fieldname,
139                                                             va_list                  args);
140
141 gboolean                gst_structure_get                  (const GstStructure      *structure,
142                                                             const char              *first_fieldname,
143                                                             ...) G_GNUC_NULL_TERMINATED;
144
145 gboolean                gst_structure_id_get_valist        (const GstStructure      *structure,
146                                                             GQuark                   first_field_id,
147                                                             va_list                  args);
148
149 gboolean                gst_structure_id_get               (const GstStructure      *structure,
150                                                             GQuark                   first_field_id,
151                                                             ...) G_GNUC_NULL_TERMINATED;
152
153 const GValue *          gst_structure_id_get_value         (const GstStructure      *structure,
154                                                             GQuark                   field);
155 const GValue *          gst_structure_get_value            (const GstStructure      *structure,
156                                                             const gchar             *fieldname);
157 void                    gst_structure_remove_field         (GstStructure            *structure,
158                                                             const gchar             *fieldname);
159 void                    gst_structure_remove_fields        (GstStructure            *structure,
160                                                              const gchar            *fieldname,
161                                                             ...) G_GNUC_NULL_TERMINATED;
162 void                    gst_structure_remove_fields_valist (GstStructure             *structure,
163                                                             const gchar             *fieldname,
164                                                             va_list                  varargs);
165 void                    gst_structure_remove_all_fields    (GstStructure            *structure);
166
167 GType                   gst_structure_get_field_type       (const GstStructure      *structure,
168                                                             const gchar             *fieldname);
169 gboolean                gst_structure_foreach              (const GstStructure      *structure,
170                                                             GstStructureForeachFunc  func,
171                                                             gpointer                 user_data);
172 gboolean                gst_structure_map_in_place         (GstStructure            *structure,
173                                                             GstStructureMapFunc      func,
174                                                             gpointer                 user_data);
175 gint                    gst_structure_n_fields             (const GstStructure      *structure);
176 const gchar *           gst_structure_nth_field_name       (const GstStructure      *structure, guint index);
177 gboolean                gst_structure_id_has_field         (const GstStructure      *structure,
178                                                             GQuark                   field);
179 gboolean                gst_structure_id_has_field_typed   (const GstStructure      *structure,
180                                                             GQuark                   field,
181                                                             GType                    type);
182 gboolean                gst_structure_has_field            (const GstStructure      *structure,
183                                                             const gchar             *fieldname);
184 gboolean                gst_structure_has_field_typed      (const GstStructure      *structure,
185                                                             const gchar             *fieldname,
186                                                             GType                    type);
187
188 /* utility functions */
189 gboolean                gst_structure_get_boolean          (const GstStructure      *structure,
190                                                             const gchar             *fieldname,
191                                                             gboolean                *value);
192 gboolean                gst_structure_get_int              (const GstStructure      *structure,
193                                                             const gchar             *fieldname,
194                                                             gint                    *value);
195 gboolean                gst_structure_get_uint             (const GstStructure      *structure,
196                                                             const gchar             *fieldname,
197                                                             guint                   *value);
198 gboolean                gst_structure_get_fourcc           (const GstStructure      *structure,
199                                                             const gchar             *fieldname,
200                                                             guint32                 *value);
201 gboolean                gst_structure_get_double           (const GstStructure      *structure,
202                                                             const gchar             *fieldname,
203                                                             gdouble                 *value);
204 gboolean                gst_structure_get_date             (const GstStructure      *structure,
205                                                             const gchar             *fieldname,
206                                                             GDate                  **value);
207 gboolean                gst_structure_get_date_time        (const GstStructure      *structure,
208                                                             const gchar             *fieldname,
209                                                             GstDateTime              **value);
210 gboolean                gst_structure_get_clock_time       (const GstStructure      *structure,
211                                                             const gchar             *fieldname,
212                                                             GstClockTime            *value);
213 const gchar *           gst_structure_get_string           (const GstStructure      *structure,
214                                                             const gchar             *fieldname);
215 gboolean                gst_structure_get_enum             (const GstStructure      *structure,
216                                                             const gchar             *fieldname,
217                                                             GType                    enumtype,
218                                                             gint                    *value);
219 gboolean                gst_structure_get_fraction         (const GstStructure      *structure,
220                                                             const gchar             *fieldname,
221                                                             gint *value_numerator,
222                                                             gint *value_denominator);
223
224 gchar *                 gst_structure_to_string            (const GstStructure      *structure);
225 GstStructure *          gst_structure_from_string          (const gchar             *string,
226                                                             gchar                  **end);
227
228 gboolean                 gst_structure_fixate_field_nearest_int    (GstStructure *structure,
229                                                                          const char   *field_name,
230                                                                          int           target);
231 gboolean                 gst_structure_fixate_field_nearest_double (GstStructure *structure,
232                                                                          const char   *field_name,
233                                                                          double        target);
234
235 gboolean                 gst_structure_fixate_field_boolean (GstStructure *structure,
236                                                                          const char   *field_name,
237                                                                          gboolean        target);
238 gboolean                 gst_structure_fixate_field_string (GstStructure *structure,
239                                                                          const char   *field_name,
240                                                                          const gchar  *target);
241 gboolean                 gst_structure_fixate_field_nearest_fraction (GstStructure *structure,
242                                                                          const char   *field_name,
243                                                                          const gint target_numerator,
244                                                                          const gint target_denominator);
245
246 gboolean                 gst_structure_is_equal(const GstStructure *structure1,
247                                                 const GstStructure *structure2);
248 gboolean                 gst_structure_is_subset(const GstStructure *subset,
249                                                  const GstStructure *superset);
250 gboolean                 gst_structure_can_intersect(const GstStructure *struct1,
251                                                      const GstStructure *struct2);
252 GstStructure*            gst_structure_intersect (const GstStructure *struct1,
253                                                   const GstStructure *struct2);
254 void                     gst_structure_fixate    (GstStructure *structure);
255
256 G_END_DECLS
257
258 #endif
259