1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
/* GStreamer
* Copyright (C) 2003 David A. Schleef <ds@schleef.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_STRUCTURE_H__
#define __GST_STRUCTURE_H__
#include <gst/gstconfig.h>
#include <glib-object.h>
#include <gst/gstclock.h>
#include <gst/gstdatetime.h>
#include <gst/glib-compat.h>
G_BEGIN_DECLS
GST_API GType _gst_structure_type;
typedef struct _GstStructure GstStructure;
/**
* GstSerializeFlags:
* @GST_SERIALIZE_FLAG_NONE: No special flags specified.
* @GST_SERIALIZE_FLAG_BACKWARD_COMPAT: Serialize using the old format for
* nested structures.
*
* Since: 1.20
*/
typedef enum
{
GST_SERIALIZE_FLAG_NONE = 0,
GST_SERIALIZE_FLAG_BACKWARD_COMPAT = (1 << 0),
} GstSerializeFlags;
#define GST_TYPE_STRUCTURE (_gst_structure_type)
#define GST_IS_STRUCTURE(object) ((object) && (GST_STRUCTURE(object)->type == GST_TYPE_STRUCTURE))
#define GST_STRUCTURE_CAST(object) ((GstStructure *)(object))
#define GST_STRUCTURE(object) (GST_STRUCTURE_CAST(object))
/**
* GstStructureForeachFunc:
* @field_id: the #GQuark of the field name
* @value: the #GValue of the field
* @user_data: user data
*
* A function that will be called in gst_structure_foreach(). The function may
* not modify @value.
*
* Returns: %TRUE if the foreach operation should continue, %FALSE if
* the foreach operation should stop with %FALSE.
*/
typedef gboolean (*GstStructureForeachFunc) (GQuark field_id,
const GValue * value,
gpointer user_data);
/**
* GstStructureMapFunc:
* @field_id: the #GQuark of the field name
* @value: the #GValue of the field
* @user_data: user data
*
* A function that will be called in gst_structure_map_in_place(). The function
* may modify @value.
*
* Returns: %TRUE if the map operation should continue, %FALSE if
* the map operation should stop with %FALSE.
*/
typedef gboolean (*GstStructureMapFunc) (GQuark field_id,
GValue * value,
gpointer user_data);
/**
* GstStructureFilterMapFunc:
* @field_id: the #GQuark of the field name
* @value: the #GValue of the field
* @user_data: user data
*
* A function that will be called in gst_structure_filter_and_map_in_place().
* The function may modify @value, and the value will be removed from
* the structure if %FALSE is returned.
*
* Returns: %TRUE if the field should be preserved, %FALSE if it
* should be removed.
*/
typedef gboolean (*GstStructureFilterMapFunc) (GQuark field_id,
GValue * value,
gpointer user_data);
/**
* GstStructure:
* @type: the GType of a structure
*
* The GstStructure object. Most fields are private.
*/
struct _GstStructure {
GType type;
/*< private >*/
GQuark name;
};
GST_API
GType gst_structure_get_type (void);
GST_API
GstStructure * gst_structure_new_empty (const gchar * name) G_GNUC_MALLOC;
GST_API
GstStructure * gst_structure_new_id_empty (GQuark quark) G_GNUC_MALLOC;
GST_API
GstStructure * gst_structure_new (const gchar * name,
const gchar * firstfield,
...) G_GNUC_NULL_TERMINATED G_GNUC_MALLOC;
GST_API
GstStructure * gst_structure_new_valist (const gchar * name,
const gchar * firstfield,
va_list varargs) G_GNUC_MALLOC;
GST_API
GstStructure * gst_structure_new_id (GQuark name_quark,
GQuark field_quark,
...) G_GNUC_MALLOC;
GST_API
GstStructure * gst_structure_new_from_string (const gchar * string);
GST_API
GstStructure * gst_structure_copy (const GstStructure * structure) G_GNUC_MALLOC;
GST_API
gboolean gst_structure_set_parent_refcount (GstStructure * structure,
gint * refcount);
GST_API
void gst_structure_free (GstStructure * structure);
GST_API
void gst_clear_structure (GstStructure **structure_ptr);
#define gst_clear_structure(structure_ptr) g_clear_pointer ((structure_ptr), gst_structure_free)
GST_API
gboolean gst_structure_take (GstStructure ** oldstr_ptr,
GstStructure * newstr);
GST_API
const gchar * gst_structure_get_name (const GstStructure * structure);
GST_API
GQuark gst_structure_get_name_id (const GstStructure * structure);
GST_API
gboolean gst_structure_has_name (const GstStructure * structure,
const gchar * name);
GST_API
void gst_structure_set_name (GstStructure * structure,
const gchar * name);
GST_API
void gst_structure_id_set_value (GstStructure * structure,
GQuark field,
const GValue * value);
GST_API
void gst_structure_set_value (GstStructure * structure,
const gchar * fieldname,
const GValue * value);
GST_API
void gst_structure_set_array (GstStructure * structure,
const gchar * fieldname,
const GValueArray * array);
GST_API
void gst_structure_set_list (GstStructure * structure,
const gchar * fieldname,
const GValueArray * array);
GST_API
void gst_structure_id_take_value (GstStructure * structure,
GQuark field,
GValue * value);
GST_API
void gst_structure_take_value (GstStructure * structure,
const gchar * fieldname,
GValue * value);
GST_API
void gst_structure_set (GstStructure * structure,
const gchar * fieldname,
...) G_GNUC_NULL_TERMINATED;
GST_API
void gst_structure_set_valist (GstStructure * structure,
const gchar * fieldname,
va_list varargs);
GST_API
void gst_structure_id_set (GstStructure * structure,
GQuark fieldname,
...) G_GNUC_NULL_TERMINATED;
GST_API
void gst_structure_id_set_valist (GstStructure * structure,
GQuark fieldname,
va_list varargs);
GST_API
gboolean gst_structure_get_valist (const GstStructure * structure,
const char * first_fieldname,
va_list args);
GST_API
gboolean gst_structure_get (const GstStructure * structure,
const char * first_fieldname,
...) G_GNUC_NULL_TERMINATED;
GST_API
gboolean gst_structure_id_get_valist (const GstStructure * structure,
GQuark first_field_id,
va_list args);
GST_API
gboolean gst_structure_id_get (const GstStructure * structure,
GQuark first_field_id,
...) G_GNUC_NULL_TERMINATED;
GST_API
const GValue * gst_structure_id_get_value (const GstStructure * structure,
GQuark field);
GST_API
const GValue * gst_structure_get_value (const GstStructure * structure,
const gchar * fieldname);
GST_API
void gst_structure_remove_field (GstStructure * structure,
const gchar * fieldname);
GST_API
void gst_structure_remove_fields (GstStructure * structure,
const gchar * fieldname,
...) G_GNUC_NULL_TERMINATED;
GST_API
void gst_structure_remove_fields_valist (GstStructure * structure,
const gchar * fieldname,
va_list varargs);
GST_API
void gst_structure_remove_all_fields (GstStructure * structure);
GST_API
GType gst_structure_get_field_type (const GstStructure * structure,
const gchar * fieldname);
GST_API
gboolean gst_structure_foreach (const GstStructure * structure,
GstStructureForeachFunc func,
gpointer user_data);
GST_API
gboolean gst_structure_map_in_place (GstStructure * structure,
GstStructureMapFunc func,
gpointer user_data);
GST_API
void gst_structure_filter_and_map_in_place (GstStructure * structure,
GstStructureFilterMapFunc func,
gpointer user_data);
GST_API
gint gst_structure_n_fields (const GstStructure * structure);
GST_API
const gchar * gst_structure_nth_field_name (const GstStructure * structure,
guint index);
GST_API
gboolean gst_structure_id_has_field (const GstStructure * structure,
GQuark field);
GST_API
gboolean gst_structure_id_has_field_typed (const GstStructure * structure,
GQuark field,
GType type);
GST_API
gboolean gst_structure_has_field (const GstStructure * structure,
const gchar * fieldname);
GST_API
gboolean gst_structure_has_field_typed (const GstStructure * structure,
const gchar * fieldname,
GType type);
/* utility functions */
GST_API
gboolean gst_structure_get_boolean (const GstStructure * structure,
const gchar * fieldname,
gboolean * value);
GST_API
gboolean gst_structure_get_int (const GstStructure * structure,
const gchar * fieldname,
gint * value);
GST_API
gboolean gst_structure_get_uint (const GstStructure * structure,
const gchar * fieldname,
guint * value);
GST_API
gboolean gst_structure_get_int64 (const GstStructure * structure,
const gchar * fieldname,
gint64 * value);
GST_API
gboolean gst_structure_get_uint64 (const GstStructure * structure,
const gchar * fieldname,
guint64 * value);
GST_API
gboolean gst_structure_get_double (const GstStructure * structure,
const gchar * fieldname,
gdouble * value);
GST_API
gboolean gst_structure_get_date (const GstStructure * structure,
const gchar * fieldname,
GDate ** value);
GST_API
gboolean gst_structure_get_date_time (const GstStructure * structure,
const gchar * fieldname,
GstDateTime ** value);
GST_API
gboolean gst_structure_get_clock_time (const GstStructure * structure,
const gchar * fieldname,
GstClockTime * value);
GST_API
const gchar * gst_structure_get_string (const GstStructure * structure,
const gchar * fieldname);
GST_API
gboolean gst_structure_get_enum (const GstStructure * structure,
const gchar * fieldname,
GType enumtype,
gint * value);
GST_API
gboolean gst_structure_get_fraction (const GstStructure * structure,
const gchar * fieldname,
gint * value_numerator,
gint * value_denominator);
GST_API
gboolean gst_structure_get_flagset (const GstStructure * structure,
const gchar * fieldname,
guint * value_flags,
guint * value_mask);
GST_API
gboolean gst_structure_get_array (GstStructure * structure,
const gchar * fieldname,
GValueArray ** array);
GST_API
gboolean gst_structure_get_list (GstStructure * structure,
const gchar * fieldname,
GValueArray ** array);
GST_API
gchar * gst_structure_to_string (const GstStructure * structure) G_GNUC_MALLOC;
GST_API
gchar * gst_structure_serialize (const GstStructure * structure,
GstSerializeFlags flags) G_GNUC_MALLOC;
GST_API
GstStructure * gst_structure_from_string (const gchar * string,
gchar ** end) G_GNUC_MALLOC;
GST_API
gboolean gst_structure_fixate_field_nearest_int (GstStructure * structure,
const char * field_name,
int target);
GST_API
gboolean gst_structure_fixate_field_nearest_double (GstStructure * structure,
const char * field_name,
double target);
GST_API
gboolean gst_structure_fixate_field_boolean (GstStructure * structure,
const char * field_name,
gboolean target);
GST_API
gboolean gst_structure_fixate_field_string (GstStructure * structure,
const char * field_name,
const gchar * target);
GST_API
gboolean gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
const char * field_name,
const gint target_numerator,
const gint target_denominator);
GST_API
gboolean gst_structure_fixate_field (GstStructure * structure,
const char * field_name);
GST_API
void gst_structure_fixate (GstStructure * structure);
GST_API
gboolean gst_structure_is_equal (const GstStructure * structure1,
const GstStructure * structure2);
GST_API
gboolean gst_structure_is_subset (const GstStructure * subset,
const GstStructure * superset);
GST_API
gboolean gst_structure_can_intersect (const GstStructure * struct1,
const GstStructure * struct2);
GST_API
GstStructure * gst_structure_intersect (const GstStructure * struct1,
const GstStructure * struct2) G_GNUC_MALLOC;
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstStructure, gst_structure_free)
G_END_DECLS
#endif
|
