2 * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
4 * gststructure.c: lists of { GQuark, GValue } tuples
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * SECTION:gststructure
24 * @title: GstStructure
25 * @short_description: Generic structure containing fields of names and values
26 * @see_also: #GstCaps, #GstMessage, #GstEvent, #GstQuery
28 * A #GstStructure is a collection of key/value pairs. The keys are expressed
29 * as GQuarks and the values can be of any GType.
31 * In addition to the key/value pairs, a #GstStructure also has a name. The name
32 * starts with a letter and can be filled by letters, numbers and any of "/-_.:".
34 * #GstStructure is used by various GStreamer subsystems to store information
35 * in a flexible and extensible way. A #GstStructure does not have a refcount
36 * because it usually is part of a higher level object such as #GstCaps,
37 * #GstMessage, #GstEvent, #GstQuery. It provides a means to enforce mutability
38 * using the refcount of the parent with the gst_structure_set_parent_refcount()
41 * A #GstStructure can be created with gst_structure_new_empty() or
42 * gst_structure_new(), which both take a name and an optional set of
43 * key/value pairs along with the types of the values.
45 * Field values can be changed with gst_structure_set_value() or
46 * gst_structure_set().
48 * Field values can be retrieved with gst_structure_get_value() or the more
49 * convenient gst_structure_get_*() functions.
51 * Fields can be removed with gst_structure_remove_field() or
52 * gst_structure_remove_fields().
54 * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
55 * not allowed. Strings may be %NULL however.
57 * Be aware that the current #GstCaps / #GstStructure serialization into string
58 * has limited support for nested #GstCaps / #GstStructure fields. It can only
59 * support one level of nesting. Using more levels will lead to unexpected
60 * behavior when using serialization features, such as gst_caps_to_string() or
61 * gst_value_serialize() and their counterparts.
68 /* FIXME 2.0: suppress warnings for deprecated API such as GValueArray
69 * with newer GLib versions (>= 2.31.0) */
70 #define GLIB_DISABLE_DEPRECATION_WARNINGS
74 #include "gst_private.h"
77 #include <gobject/gvaluecollector.h>
79 GST_DEBUG_CATEGORY_STATIC (gst_structure_debug);
80 #define GST_CAT_DEFAULT gst_structure_debug
82 typedef struct _GstStructureField GstStructureField;
84 struct _GstStructureField
94 /* owned by parent structure, NULL if no parent */
95 gint *parent_refcount;
100 #define GST_STRUCTURE_REFCOUNT(s) (((GstStructureImpl*)(s))->parent_refcount)
101 #define GST_STRUCTURE_FIELDS(s) (((GstStructureImpl*)(s))->fields)
103 #define GST_STRUCTURE_FIELD(structure, index) \
104 &g_array_index(GST_STRUCTURE_FIELDS(structure), GstStructureField, (index))
106 #define IS_MUTABLE(structure) \
107 (!GST_STRUCTURE_REFCOUNT(structure) || \
108 g_atomic_int_get (GST_STRUCTURE_REFCOUNT(structure)) == 1)
110 #define IS_TAGLIST(structure) \
111 (structure->name == GST_QUARK (TAGLIST))
113 static void gst_structure_set_field (GstStructure * structure,
114 GstStructureField * field);
115 static GstStructureField *gst_structure_get_field (const GstStructure *
116 structure, const gchar * fieldname);
117 static GstStructureField *gst_structure_id_get_field (const GstStructure *
118 structure, GQuark field);
119 static void gst_structure_transform_to_string (const GValue * src_value,
120 GValue * dest_value);
121 static GstStructure *gst_structure_copy_conditional (const GstStructure *
124 GType _gst_structure_type = 0;
127 G_DEFINE_BOXED_TYPE (GstStructure, gst_structure,
128 gst_structure_copy_conditional, gst_structure_free);
131 _priv_gst_structure_initialize (void)
133 _gst_structure_type = gst_structure_get_type ();
135 g_value_register_transform_func (_gst_structure_type, G_TYPE_STRING,
136 gst_structure_transform_to_string);
138 GST_DEBUG_CATEGORY_INIT (gst_structure_debug, "structure", 0,
139 "GstStructure debug");
142 static GstStructure *
143 gst_structure_new_id_empty_with_size (GQuark quark, guint prealloc)
145 GstStructureImpl *structure;
147 structure = g_slice_new (GstStructureImpl);
148 ((GstStructure *) structure)->type = _gst_structure_type;
149 ((GstStructure *) structure)->name = quark;
150 GST_STRUCTURE_REFCOUNT (structure) = NULL;
151 GST_STRUCTURE_FIELDS (structure) =
152 g_array_sized_new (FALSE, FALSE, sizeof (GstStructureField), prealloc);
154 GST_TRACE ("created structure %p", structure);
156 return GST_STRUCTURE_CAST (structure);
160 * gst_structure_new_id_empty:
161 * @quark: name of new structure
163 * Creates a new, empty #GstStructure with the given name as a GQuark.
165 * Free-function: gst_structure_free
167 * Returns: (transfer full): a new, empty #GstStructure
170 gst_structure_new_id_empty (GQuark quark)
172 g_return_val_if_fail (quark != 0, NULL);
174 return gst_structure_new_id_empty_with_size (quark, 0);
177 #ifndef G_DISABLE_CHECKS
179 gst_structure_validate_name (const gchar * name)
183 g_return_val_if_fail (name != NULL, FALSE);
185 if (G_UNLIKELY (!g_ascii_isalpha (*name))) {
186 GST_WARNING ("Invalid character '%c' at offset 0 in structure name: %s",
191 /* FIXME: test name string more */
193 while (*s && (g_ascii_isalnum (*s) || strchr ("/-_.:+", *s) != NULL))
195 if (G_UNLIKELY (*s != '\0')) {
196 GST_WARNING ("Invalid character '%c' at offset %" G_GUINTPTR_FORMAT " in"
197 " structure name: %s", *s, ((guintptr) s - (guintptr) name), name);
201 if (strncmp (name, "video/x-raw-", 12) == 0) {
202 g_warning ("0.10-style raw video caps are being created. Should be "
203 "video/x-raw,format=(string).. now.");
204 } else if (strncmp (name, "audio/x-raw-", 12) == 0) {
205 g_warning ("0.10-style raw audio caps are being created. Should be "
206 "audio/x-raw,format=(string).. now.");
214 * gst_structure_new_empty:
215 * @name: name of new structure
217 * Creates a new, empty #GstStructure with the given @name.
219 * See gst_structure_set_name() for constraints on the @name parameter.
221 * Free-function: gst_structure_free
223 * Returns: (transfer full): a new, empty #GstStructure
226 gst_structure_new_empty (const gchar * name)
228 g_return_val_if_fail (gst_structure_validate_name (name), NULL);
230 return gst_structure_new_id_empty_with_size (g_quark_from_string (name), 0);
235 * @name: name of new structure
236 * @firstfield: name of first field to set
237 * @...: additional arguments
239 * Creates a new #GstStructure with the given name. Parses the
240 * list of variable arguments and sets fields to the values listed.
241 * Variable arguments should be passed as field name, field type,
242 * and value. Last variable argument should be %NULL.
244 * Free-function: gst_structure_free
246 * Returns: (transfer full): a new #GstStructure
249 gst_structure_new (const gchar * name, const gchar * firstfield, ...)
251 GstStructure *structure;
254 va_start (varargs, firstfield);
255 structure = gst_structure_new_valist (name, firstfield, varargs);
262 * gst_structure_new_valist:
263 * @name: name of new structure
264 * @firstfield: name of first field to set
265 * @varargs: variable argument list
267 * Creates a new #GstStructure with the given @name. Structure fields
268 * are set according to the varargs in a manner similar to
269 * gst_structure_new().
271 * See gst_structure_set_name() for constraints on the @name parameter.
273 * Free-function: gst_structure_free
275 * Returns: (transfer full): a new #GstStructure
278 gst_structure_new_valist (const gchar * name,
279 const gchar * firstfield, va_list varargs)
281 GstStructure *structure;
283 structure = gst_structure_new_empty (name);
286 gst_structure_set_valist (structure, firstfield, varargs);
292 * gst_structure_set_parent_refcount:
293 * @structure: a #GstStructure
294 * @refcount: (in): a pointer to the parent's refcount
296 * Sets the parent_refcount field of #GstStructure. This field is used to
297 * determine whether a structure is mutable or not. This function should only be
298 * called by code implementing parent objects of #GstStructure, as described in
299 * the MT Refcounting section of the design documents.
301 * Returns: %TRUE if the parent refcount could be set.
304 gst_structure_set_parent_refcount (GstStructure * structure, gint * refcount)
306 g_return_val_if_fail (structure != NULL, FALSE);
308 /* if we have a parent_refcount already, we can only clear
309 * if with a NULL refcount */
310 if (GST_STRUCTURE_REFCOUNT (structure)) {
311 if (refcount != NULL) {
312 g_return_val_if_fail (refcount == NULL, FALSE);
316 if (refcount == NULL) {
317 g_return_val_if_fail (refcount != NULL, FALSE);
322 GST_STRUCTURE_REFCOUNT (structure) = refcount;
328 * gst_structure_copy:
329 * @structure: a #GstStructure to duplicate
331 * Duplicates a #GstStructure and all its fields and values.
333 * Free-function: gst_structure_free
335 * Returns: (transfer full): a new #GstStructure.
338 gst_structure_copy (const GstStructure * structure)
340 GstStructure *new_structure;
341 GstStructureField *field;
344 g_return_val_if_fail (structure != NULL, NULL);
346 len = GST_STRUCTURE_FIELDS (structure)->len;
347 new_structure = gst_structure_new_id_empty_with_size (structure->name, len);
349 for (i = 0; i < len; i++) {
350 GstStructureField new_field = { 0 };
352 field = GST_STRUCTURE_FIELD (structure, i);
354 new_field.name = field->name;
355 gst_value_init_and_copy (&new_field.value, &field->value);
356 g_array_append_val (GST_STRUCTURE_FIELDS (new_structure), new_field);
358 GST_CAT_TRACE (GST_CAT_PERFORMANCE, "doing copy %p -> %p",
359 structure, new_structure);
361 return new_structure;
365 * gst_structure_free:
366 * @structure: (in) (transfer full): the #GstStructure to free
368 * Frees a #GstStructure and all its fields and values. The structure must not
369 * have a parent when this function is called.
372 gst_structure_free (GstStructure * structure)
374 GstStructureField *field;
377 g_return_if_fail (structure != NULL);
378 g_return_if_fail (GST_STRUCTURE_REFCOUNT (structure) == NULL);
380 len = GST_STRUCTURE_FIELDS (structure)->len;
381 for (i = 0; i < len; i++) {
382 field = GST_STRUCTURE_FIELD (structure, i);
384 if (G_IS_VALUE (&field->value)) {
385 g_value_unset (&field->value);
388 g_array_free (GST_STRUCTURE_FIELDS (structure), TRUE);
390 memset (structure, 0xff, sizeof (GstStructure));
392 GST_TRACE ("free structure %p", structure);
394 g_slice_free1 (sizeof (GstStructureImpl), structure);
398 * gst_structure_get_name:
399 * @structure: a #GstStructure
401 * Get the name of @structure as a string.
403 * Returns: the name of the structure.
406 gst_structure_get_name (const GstStructure * structure)
408 g_return_val_if_fail (structure != NULL, NULL);
410 return g_quark_to_string (structure->name);
414 * gst_structure_has_name:
415 * @structure: a #GstStructure
416 * @name: structure name to check for
418 * Checks if the structure has the given name
420 * Returns: %TRUE if @name matches the name of the structure.
423 gst_structure_has_name (const GstStructure * structure, const gchar * name)
425 const gchar *structure_name;
427 g_return_val_if_fail (structure != NULL, FALSE);
428 g_return_val_if_fail (name != NULL, FALSE);
430 /* getting the string is cheap and comparing short strings is too
431 * should be faster than getting the quark for name and comparing the quarks
433 structure_name = g_quark_to_string (structure->name);
435 return (structure_name && strcmp (structure_name, name) == 0);
439 * gst_structure_get_name_id:
440 * @structure: a #GstStructure
442 * Get the name of @structure as a GQuark.
444 * Returns: the quark representing the name of the structure.
447 gst_structure_get_name_id (const GstStructure * structure)
449 g_return_val_if_fail (structure != NULL, 0);
451 return structure->name;
455 * gst_structure_set_name:
456 * @structure: a #GstStructure
457 * @name: the new name of the structure
459 * Sets the name of the structure to the given @name. The string
460 * provided is copied before being used. It must not be empty, start with a
461 * letter and can be followed by letters, numbers and any of "/-_.:".
464 gst_structure_set_name (GstStructure * structure, const gchar * name)
466 g_return_if_fail (structure != NULL);
467 g_return_if_fail (IS_MUTABLE (structure));
468 g_return_if_fail (gst_structure_validate_name (name));
470 structure->name = g_quark_from_string (name);
474 gst_structure_id_set_value_internal (GstStructure * structure, GQuark field,
475 const GValue * value)
477 GstStructureField gsfield = { 0, {0,} };
479 gsfield.name = field;
480 gst_value_init_and_copy (&gsfield.value, value);
482 gst_structure_set_field (structure, &gsfield);
486 * gst_structure_id_set_value:
487 * @structure: a #GstStructure
488 * @field: a #GQuark representing a field
489 * @value: the new value of the field
491 * Sets the field with the given GQuark @field to @value. If the field
492 * does not exist, it is created. If the field exists, the previous
493 * value is replaced and freed.
496 gst_structure_id_set_value (GstStructure * structure,
497 GQuark field, const GValue * value)
500 g_return_if_fail (structure != NULL);
501 g_return_if_fail (G_IS_VALUE (value));
502 g_return_if_fail (IS_MUTABLE (structure));
504 gst_structure_id_set_value_internal (structure, field, value);
508 * gst_structure_set_value:
509 * @structure: a #GstStructure
510 * @fieldname: the name of the field to set
511 * @value: the new value of the field
513 * Sets the field with the given name @field to @value. If the field
514 * does not exist, it is created. If the field exists, the previous
515 * value is replaced and freed.
518 gst_structure_set_value (GstStructure * structure,
519 const gchar * fieldname, const GValue * value)
521 g_return_if_fail (structure != NULL);
522 g_return_if_fail (fieldname != NULL);
523 g_return_if_fail (G_IS_VALUE (value));
524 g_return_if_fail (IS_MUTABLE (structure));
526 gst_structure_id_set_value_internal (structure,
527 g_quark_from_string (fieldname), value);
531 gst_structure_id_take_value_internal (GstStructure * structure, GQuark field,
534 GstStructureField gsfield = { 0, {0,} };
536 gsfield.name = field;
537 gsfield.value = *value;
539 gst_structure_set_field (structure, &gsfield);
541 /* we took ownership */
543 memset (value, 0, sizeof (GValue));
545 value->g_type = G_TYPE_INVALID;
550 * gst_structure_id_take_value:
551 * @structure: a #GstStructure
552 * @field: a #GQuark representing a field
553 * @value: (transfer full): the new value of the field
555 * Sets the field with the given GQuark @field to @value. If the field
556 * does not exist, it is created. If the field exists, the previous
557 * value is replaced and freed.
560 gst_structure_id_take_value (GstStructure * structure, GQuark field,
563 g_return_if_fail (structure != NULL);
564 g_return_if_fail (G_IS_VALUE (value));
565 g_return_if_fail (IS_MUTABLE (structure));
567 gst_structure_id_take_value_internal (structure, field, value);
571 * gst_structure_take_value:
572 * @structure: a #GstStructure
573 * @fieldname: the name of the field to set
574 * @value: (transfer full): the new value of the field
576 * Sets the field with the given name @field to @value. If the field
577 * does not exist, it is created. If the field exists, the previous
578 * value is replaced and freed. The function will take ownership of @value.
581 gst_structure_take_value (GstStructure * structure, const gchar * fieldname,
584 g_return_if_fail (structure != NULL);
585 g_return_if_fail (fieldname != NULL);
586 g_return_if_fail (G_IS_VALUE (value));
587 g_return_if_fail (IS_MUTABLE (structure));
589 gst_structure_id_take_value_internal (structure,
590 g_quark_from_string (fieldname), value);
594 gst_structure_set_valist_internal (GstStructure * structure,
595 const gchar * fieldname, va_list varargs)
601 GstStructureField field = { 0 };
603 field.name = g_quark_from_string (fieldname);
605 type = va_arg (varargs, GType);
607 G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
608 if (G_UNLIKELY (err)) {
609 g_critical ("%s", err);
612 gst_structure_set_field (structure, &field);
614 fieldname = va_arg (varargs, gchar *);
620 * @structure: a #GstStructure
621 * @fieldname: the name of the field to set
622 * @...: variable arguments
624 * Parses the variable arguments and sets fields accordingly. Fields that
625 * weren't already part of the structure are added as needed.
626 * Variable arguments should be in the form field name, field type
627 * (as a GType), value(s). The last variable argument should be %NULL.
630 gst_structure_set (GstStructure * structure, const gchar * field, ...)
634 g_return_if_fail (structure != NULL);
635 g_return_if_fail (IS_MUTABLE (structure) || field == NULL);
637 va_start (varargs, field);
638 gst_structure_set_valist_internal (structure, field, varargs);
643 * gst_structure_set_valist:
644 * @structure: a #GstStructure
645 * @fieldname: the name of the field to set
646 * @varargs: variable arguments
648 * va_list form of gst_structure_set().
651 gst_structure_set_valist (GstStructure * structure,
652 const gchar * fieldname, va_list varargs)
654 g_return_if_fail (structure != NULL);
655 g_return_if_fail (IS_MUTABLE (structure));
657 gst_structure_set_valist_internal (structure, fieldname, varargs);
661 gst_structure_id_set_valist_internal (GstStructure * structure,
662 GQuark fieldname, va_list varargs)
668 GstStructureField field = { 0 };
670 field.name = fieldname;
671 type = va_arg (varargs, GType);
673 G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
674 if (G_UNLIKELY (err)) {
675 g_critical ("%s", err);
678 gst_structure_set_field (structure, &field);
680 fieldname = va_arg (varargs, GQuark);
685 * gst_structure_id_set:
686 * @structure: a #GstStructure
687 * @fieldname: the GQuark for the name of the field to set
688 * @...: variable arguments
690 * Identical to gst_structure_set, except that field names are
691 * passed using the GQuark for the field name. This allows more efficient
692 * setting of the structure if the caller already knows the associated
694 * The last variable argument must be %NULL.
697 gst_structure_id_set (GstStructure * structure, GQuark field, ...)
701 g_return_if_fail (structure != NULL);
703 va_start (varargs, field);
704 gst_structure_id_set_valist_internal (structure, field, varargs);
709 * gst_structure_id_set_valist:
710 * @structure: a #GstStructure
711 * @fieldname: the name of the field to set
712 * @varargs: variable arguments
714 * va_list form of gst_structure_id_set().
717 gst_structure_id_set_valist (GstStructure * structure,
718 GQuark fieldname, va_list varargs)
720 g_return_if_fail (structure != NULL);
721 g_return_if_fail (IS_MUTABLE (structure));
723 gst_structure_id_set_valist_internal (structure, fieldname, varargs);
727 * gst_structure_new_id:
728 * @name_quark: name of new structure
729 * @field_quark: the GQuark for the name of the field to set
730 * @...: variable arguments
732 * Creates a new #GstStructure with the given name as a GQuark, followed by
733 * fieldname quark, GType, argument(s) "triplets" in the same format as
734 * gst_structure_id_set(). Basically a convenience wrapper around
735 * gst_structure_new_id_empty() and gst_structure_id_set().
737 * The last variable argument must be %NULL (or 0).
739 * Free-function: gst_structure_free
741 * Returns: (transfer full): a new #GstStructure
744 gst_structure_new_id (GQuark name_quark, GQuark field_quark, ...)
749 g_return_val_if_fail (name_quark != 0, NULL);
750 g_return_val_if_fail (field_quark != 0, NULL);
752 s = gst_structure_new_id_empty (name_quark);
754 va_start (varargs, field_quark);
755 gst_structure_id_set_valist_internal (s, field_quark, varargs);
761 #if GST_VERSION_NANO == 1
762 #define GIT_G_WARNING g_warning
764 #define GIT_G_WARNING GST_WARNING
767 /* If the structure currently contains a field with the same name, it is
768 * replaced with the provided field. Otherwise, the field is added to the
769 * structure. The field's value is not deeply copied.
772 gst_structure_set_field (GstStructure * structure, GstStructureField * field)
774 GstStructureField *f;
775 GType field_value_type;
778 len = GST_STRUCTURE_FIELDS (structure)->len;
780 field_value_type = G_VALUE_TYPE (&field->value);
781 if (field_value_type == G_TYPE_STRING) {
784 s = g_value_get_string (&field->value);
785 /* only check for NULL strings in taglists, as they are allowed in message
786 * structs, e.g. error message debug strings */
787 if (G_UNLIKELY (IS_TAGLIST (structure) && (s == NULL || *s == '\0'))) {
789 GIT_G_WARNING ("Trying to set NULL string on field '%s' on taglist. "
790 "Please file a bug.", g_quark_to_string (field->name));
791 g_value_unset (&field->value);
794 /* empty strings never make sense */
795 GIT_G_WARNING ("Trying to set empty string on taglist field '%s'. "
796 "Please file a bug.", g_quark_to_string (field->name));
797 g_value_unset (&field->value);
800 } else if (G_UNLIKELY (s != NULL && !g_utf8_validate (s, -1, NULL))) {
801 g_warning ("Trying to set string on %s field '%s', but string is not "
802 "valid UTF-8. Please file a bug.",
803 IS_TAGLIST (structure) ? "taglist" : "structure",
804 g_quark_to_string (field->name));
805 g_value_unset (&field->value);
808 } else if (G_UNLIKELY (field_value_type == G_TYPE_DATE)) {
811 d = g_value_get_boxed (&field->value);
812 /* only check for NULL GDates in taglists, as they might make sense
813 * in other, generic structs */
814 if (G_UNLIKELY ((IS_TAGLIST (structure) && d == NULL))) {
815 GIT_G_WARNING ("Trying to set NULL GDate on field '%s' on taglist. "
816 "Please file a bug.", g_quark_to_string (field->name));
817 g_value_unset (&field->value);
819 } else if (G_UNLIKELY (d != NULL && !g_date_valid (d))) {
821 ("Trying to set invalid GDate on %s field '%s'. Please file a bug.",
822 IS_TAGLIST (structure) ? "taglist" : "structure",
823 g_quark_to_string (field->name));
824 g_value_unset (&field->value);
829 for (i = 0; i < len; i++) {
830 f = GST_STRUCTURE_FIELD (structure, i);
832 if (G_UNLIKELY (f->name == field->name)) {
833 g_value_unset (&f->value);
834 memcpy (f, field, sizeof (GstStructureField));
839 g_array_append_val (GST_STRUCTURE_FIELDS (structure), *field);
842 /* If there is no field with the given ID, NULL is returned.
844 static GstStructureField *
845 gst_structure_id_get_field (const GstStructure * structure, GQuark field_id)
847 GstStructureField *field;
850 len = GST_STRUCTURE_FIELDS (structure)->len;
852 for (i = 0; i < len; i++) {
853 field = GST_STRUCTURE_FIELD (structure, i);
855 if (G_UNLIKELY (field->name == field_id))
862 /* If there is no field with the given ID, NULL is returned.
864 static GstStructureField *
865 gst_structure_get_field (const GstStructure * structure,
866 const gchar * fieldname)
868 g_return_val_if_fail (structure != NULL, NULL);
869 g_return_val_if_fail (fieldname != NULL, NULL);
871 return gst_structure_id_get_field (structure,
872 g_quark_from_string (fieldname));
876 * gst_structure_get_value:
877 * @structure: a #GstStructure
878 * @fieldname: the name of the field to get
880 * Get the value of the field with name @fieldname.
882 * Returns: the #GValue corresponding to the field with the given name.
885 gst_structure_get_value (const GstStructure * structure,
886 const gchar * fieldname)
888 GstStructureField *field;
890 g_return_val_if_fail (structure != NULL, NULL);
891 g_return_val_if_fail (fieldname != NULL, NULL);
893 field = gst_structure_get_field (structure, fieldname);
897 return &field->value;
901 * gst_structure_id_get_value:
902 * @structure: a #GstStructure
903 * @field: the #GQuark of the field to get
905 * Get the value of the field with GQuark @field.
907 * Returns: the #GValue corresponding to the field with the given name
911 gst_structure_id_get_value (const GstStructure * structure, GQuark field)
913 GstStructureField *gsfield;
915 g_return_val_if_fail (structure != NULL, NULL);
917 gsfield = gst_structure_id_get_field (structure, field);
921 return &gsfield->value;
925 * gst_structure_remove_field:
926 * @structure: a #GstStructure
927 * @fieldname: the name of the field to remove
929 * Removes the field with the given name. If the field with the given
930 * name does not exist, the structure is unchanged.
933 gst_structure_remove_field (GstStructure * structure, const gchar * fieldname)
935 GstStructureField *field;
939 g_return_if_fail (structure != NULL);
940 g_return_if_fail (fieldname != NULL);
941 g_return_if_fail (IS_MUTABLE (structure));
943 id = g_quark_from_string (fieldname);
944 len = GST_STRUCTURE_FIELDS (structure)->len;
946 for (i = 0; i < len; i++) {
947 field = GST_STRUCTURE_FIELD (structure, i);
949 if (field->name == id) {
950 if (G_IS_VALUE (&field->value)) {
951 g_value_unset (&field->value);
953 GST_STRUCTURE_FIELDS (structure) =
954 g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
961 * gst_structure_remove_fields:
962 * @structure: a #GstStructure
963 * @fieldname: the name of the field to remove
964 * @...: %NULL-terminated list of more fieldnames to remove
966 * Removes the fields with the given names. If a field does not exist, the
967 * argument is ignored.
970 gst_structure_remove_fields (GstStructure * structure,
971 const gchar * fieldname, ...)
975 g_return_if_fail (structure != NULL);
976 g_return_if_fail (fieldname != NULL);
977 /* mutability checked in remove_field */
979 va_start (varargs, fieldname);
980 gst_structure_remove_fields_valist (structure, fieldname, varargs);
985 * gst_structure_remove_fields_valist:
986 * @structure: a #GstStructure
987 * @fieldname: the name of the field to remove
988 * @varargs: %NULL-terminated list of more fieldnames to remove
990 * va_list form of gst_structure_remove_fields().
993 gst_structure_remove_fields_valist (GstStructure * structure,
994 const gchar * fieldname, va_list varargs)
996 gchar *field = (gchar *) fieldname;
998 g_return_if_fail (structure != NULL);
999 g_return_if_fail (fieldname != NULL);
1000 /* mutability checked in remove_field */
1003 gst_structure_remove_field (structure, field);
1004 field = va_arg (varargs, char *);
1009 * gst_structure_remove_all_fields:
1010 * @structure: a #GstStructure
1012 * Removes all fields in a GstStructure.
1015 gst_structure_remove_all_fields (GstStructure * structure)
1017 GstStructureField *field;
1020 g_return_if_fail (structure != NULL);
1021 g_return_if_fail (IS_MUTABLE (structure));
1023 for (i = GST_STRUCTURE_FIELDS (structure)->len - 1; i >= 0; i--) {
1024 field = GST_STRUCTURE_FIELD (structure, i);
1026 if (G_IS_VALUE (&field->value)) {
1027 g_value_unset (&field->value);
1029 GST_STRUCTURE_FIELDS (structure) =
1030 g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
1035 * gst_structure_get_field_type:
1036 * @structure: a #GstStructure
1037 * @fieldname: the name of the field
1039 * Finds the field with the given name, and returns the type of the
1040 * value it contains. If the field is not found, G_TYPE_INVALID is
1043 * Returns: the #GValue of the field
1046 gst_structure_get_field_type (const GstStructure * structure,
1047 const gchar * fieldname)
1049 GstStructureField *field;
1051 g_return_val_if_fail (structure != NULL, G_TYPE_INVALID);
1052 g_return_val_if_fail (fieldname != NULL, G_TYPE_INVALID);
1054 field = gst_structure_get_field (structure, fieldname);
1056 return G_TYPE_INVALID;
1058 return G_VALUE_TYPE (&field->value);
1062 * gst_structure_n_fields:
1063 * @structure: a #GstStructure
1065 * Get the number of fields in the structure.
1067 * Returns: the number of fields in the structure
1070 gst_structure_n_fields (const GstStructure * structure)
1072 g_return_val_if_fail (structure != NULL, 0);
1074 return GST_STRUCTURE_FIELDS (structure)->len;
1078 * gst_structure_nth_field_name:
1079 * @structure: a #GstStructure
1080 * @index: the index to get the name of
1082 * Get the name of the given field number, counting from 0 onwards.
1084 * Returns: the name of the given field number
1087 gst_structure_nth_field_name (const GstStructure * structure, guint index)
1089 GstStructureField *field;
1091 g_return_val_if_fail (structure != NULL, NULL);
1092 g_return_val_if_fail (index < GST_STRUCTURE_FIELDS (structure)->len, NULL);
1094 field = GST_STRUCTURE_FIELD (structure, index);
1096 return g_quark_to_string (field->name);
1100 * gst_structure_foreach:
1101 * @structure: a #GstStructure
1102 * @func: (scope call): a function to call for each field
1103 * @user_data: (closure): private data
1105 * Calls the provided function once for each field in the #GstStructure. The
1106 * function must not modify the fields. Also see gst_structure_map_in_place()
1107 * and gst_structure_filter_and_map_in_place().
1109 * Returns: %TRUE if the supplied function returns %TRUE For each of the fields,
1113 gst_structure_foreach (const GstStructure * structure,
1114 GstStructureForeachFunc func, gpointer user_data)
1117 GstStructureField *field;
1120 g_return_val_if_fail (structure != NULL, FALSE);
1121 g_return_val_if_fail (func != NULL, FALSE);
1123 len = GST_STRUCTURE_FIELDS (structure)->len;
1125 for (i = 0; i < len; i++) {
1126 field = GST_STRUCTURE_FIELD (structure, i);
1128 ret = func (field->name, &field->value, user_data);
1129 if (G_UNLIKELY (!ret))
1137 * gst_structure_map_in_place:
1138 * @structure: a #GstStructure
1139 * @func: (scope call): a function to call for each field
1140 * @user_data: (closure): private data
1142 * Calls the provided function once for each field in the #GstStructure. In
1143 * contrast to gst_structure_foreach(), the function may modify but not delete the
1144 * fields. The structure must be mutable.
1146 * Returns: %TRUE if the supplied function returns %TRUE For each of the fields,
1150 gst_structure_map_in_place (GstStructure * structure,
1151 GstStructureMapFunc func, gpointer user_data)
1154 GstStructureField *field;
1157 g_return_val_if_fail (structure != NULL, FALSE);
1158 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
1159 g_return_val_if_fail (func != NULL, FALSE);
1160 len = GST_STRUCTURE_FIELDS (structure)->len;
1162 for (i = 0; i < len; i++) {
1163 field = GST_STRUCTURE_FIELD (structure, i);
1165 ret = func (field->name, &field->value, user_data);
1174 * gst_structure_filter_and_map_in_place:
1175 * @structure: a #GstStructure
1176 * @func: (scope call): a function to call for each field
1177 * @user_data: (closure): private data
1179 * Calls the provided function once for each field in the #GstStructure. In
1180 * contrast to gst_structure_foreach(), the function may modify the fields.
1181 * In contrast to gst_structure_map_in_place(), the field is removed from
1182 * the structure if %FALSE is returned from the function.
1183 * The structure must be mutable.
1188 gst_structure_filter_and_map_in_place (GstStructure * structure,
1189 GstStructureFilterMapFunc func, gpointer user_data)
1192 GstStructureField *field;
1195 g_return_if_fail (structure != NULL);
1196 g_return_if_fail (IS_MUTABLE (structure));
1197 g_return_if_fail (func != NULL);
1198 len = GST_STRUCTURE_FIELDS (structure)->len;
1200 for (i = 0; i < len;) {
1201 field = GST_STRUCTURE_FIELD (structure, i);
1203 ret = func (field->name, &field->value, user_data);
1206 if (G_IS_VALUE (&field->value)) {
1207 g_value_unset (&field->value);
1209 GST_STRUCTURE_FIELDS (structure) =
1210 g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
1211 len = GST_STRUCTURE_FIELDS (structure)->len;
1219 * gst_structure_id_has_field:
1220 * @structure: a #GstStructure
1221 * @field: #GQuark of the field name
1223 * Check if @structure contains a field named @field.
1225 * Returns: %TRUE if the structure contains a field with the given name
1228 gst_structure_id_has_field (const GstStructure * structure, GQuark field)
1230 GstStructureField *f;
1232 g_return_val_if_fail (structure != NULL, FALSE);
1233 g_return_val_if_fail (field != 0, FALSE);
1235 f = gst_structure_id_get_field (structure, field);
1241 * gst_structure_has_field:
1242 * @structure: a #GstStructure
1243 * @fieldname: the name of a field
1245 * Check if @structure contains a field named @fieldname.
1247 * Returns: %TRUE if the structure contains a field with the given name
1250 gst_structure_has_field (const GstStructure * structure,
1251 const gchar * fieldname)
1253 g_return_val_if_fail (structure != NULL, FALSE);
1254 g_return_val_if_fail (fieldname != NULL, FALSE);
1256 return gst_structure_id_has_field (structure,
1257 g_quark_from_string (fieldname));
1261 * gst_structure_id_has_field_typed:
1262 * @structure: a #GstStructure
1263 * @field: #GQuark of the field name
1264 * @type: the type of a value
1266 * Check if @structure contains a field named @field and with GType @type.
1268 * Returns: %TRUE if the structure contains a field with the given name and type
1271 gst_structure_id_has_field_typed (const GstStructure * structure,
1272 GQuark field, GType type)
1274 GstStructureField *f;
1276 g_return_val_if_fail (structure != NULL, FALSE);
1277 g_return_val_if_fail (field != 0, FALSE);
1279 f = gst_structure_id_get_field (structure, field);
1283 return (G_VALUE_TYPE (&f->value) == type);
1287 * gst_structure_has_field_typed:
1288 * @structure: a #GstStructure
1289 * @fieldname: the name of a field
1290 * @type: the type of a value
1292 * Check if @structure contains a field named @fieldname and with GType @type.
1294 * Returns: %TRUE if the structure contains a field with the given name and type
1297 gst_structure_has_field_typed (const GstStructure * structure,
1298 const gchar * fieldname, GType type)
1300 g_return_val_if_fail (structure != NULL, FALSE);
1301 g_return_val_if_fail (fieldname != NULL, FALSE);
1303 return gst_structure_id_has_field_typed (structure,
1304 g_quark_from_string (fieldname), type);
1307 /* utility functions */
1310 * gst_structure_get_boolean:
1311 * @structure: a #GstStructure
1312 * @fieldname: the name of a field
1313 * @value: (out): a pointer to a #gboolean to set
1315 * Sets the boolean pointed to by @value corresponding to the value of the
1316 * given field. Caller is responsible for making sure the field exists
1317 * and has the correct type.
1319 * Returns: %TRUE if the value could be set correctly. If there was no field
1320 * with @fieldname or the existing field did not contain a boolean, this
1321 * function returns %FALSE.
1324 gst_structure_get_boolean (const GstStructure * structure,
1325 const gchar * fieldname, gboolean * value)
1327 GstStructureField *field;
1329 g_return_val_if_fail (structure != NULL, FALSE);
1330 g_return_val_if_fail (fieldname != NULL, FALSE);
1332 field = gst_structure_get_field (structure, fieldname);
1334 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_BOOLEAN)
1337 *value = gst_g_value_get_boolean_unchecked (&field->value);
1343 * gst_structure_get_int:
1344 * @structure: a #GstStructure
1345 * @fieldname: the name of a field
1346 * @value: (out): a pointer to an int to set
1348 * Sets the int pointed to by @value corresponding to the value of the
1349 * given field. Caller is responsible for making sure the field exists
1350 * and has the correct type.
1352 * Returns: %TRUE if the value could be set correctly. If there was no field
1353 * with @fieldname or the existing field did not contain an int, this function
1357 gst_structure_get_int (const GstStructure * structure,
1358 const gchar * fieldname, gint * value)
1360 GstStructureField *field;
1362 g_return_val_if_fail (structure != NULL, FALSE);
1363 g_return_val_if_fail (fieldname != NULL, FALSE);
1364 g_return_val_if_fail (value != NULL, FALSE);
1366 field = gst_structure_get_field (structure, fieldname);
1368 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_INT)
1371 *value = gst_g_value_get_int_unchecked (&field->value);
1377 * gst_structure_get_uint:
1378 * @structure: a #GstStructure
1379 * @fieldname: the name of a field
1380 * @value: (out): a pointer to a uint to set
1382 * Sets the uint pointed to by @value corresponding to the value of the
1383 * given field. Caller is responsible for making sure the field exists
1384 * and has the correct type.
1386 * Returns: %TRUE if the value could be set correctly. If there was no field
1387 * with @fieldname or the existing field did not contain a uint, this function
1391 gst_structure_get_uint (const GstStructure * structure,
1392 const gchar * fieldname, guint * value)
1394 GstStructureField *field;
1396 g_return_val_if_fail (structure != NULL, FALSE);
1397 g_return_val_if_fail (fieldname != NULL, FALSE);
1398 g_return_val_if_fail (value != NULL, FALSE);
1400 field = gst_structure_get_field (structure, fieldname);
1402 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_UINT)
1405 *value = gst_g_value_get_uint_unchecked (&field->value);
1411 * gst_structure_get_int64:
1412 * @structure: a #GstStructure
1413 * @fieldname: the name of a field
1414 * @value: (out): a pointer to a #gint64 to set
1416 * Sets the #gint64 pointed to by @value corresponding to the value of the
1417 * given field. Caller is responsible for making sure the field exists
1418 * and has the correct type.
1420 * Returns: %TRUE if the value could be set correctly. If there was no field
1421 * with @fieldname or the existing field did not contain a #gint64, this function
1427 gst_structure_get_int64 (const GstStructure * structure,
1428 const gchar * fieldname, gint64 * value)
1430 GstStructureField *field;
1432 g_return_val_if_fail (structure != NULL, FALSE);
1433 g_return_val_if_fail (fieldname != NULL, FALSE);
1434 g_return_val_if_fail (value != NULL, FALSE);
1436 field = gst_structure_get_field (structure, fieldname);
1438 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_INT64)
1441 *value = gst_g_value_get_int64_unchecked (&field->value);
1447 * gst_structure_get_uint64:
1448 * @structure: a #GstStructure
1449 * @fieldname: the name of a field
1450 * @value: (out): a pointer to a #guint64 to set
1452 * Sets the #guint64 pointed to by @value corresponding to the value of the
1453 * given field. Caller is responsible for making sure the field exists
1454 * and has the correct type.
1456 * Returns: %TRUE if the value could be set correctly. If there was no field
1457 * with @fieldname or the existing field did not contain a #guint64, this function
1463 gst_structure_get_uint64 (const GstStructure * structure,
1464 const gchar * fieldname, guint64 * value)
1466 GstStructureField *field;
1468 g_return_val_if_fail (structure != NULL, FALSE);
1469 g_return_val_if_fail (fieldname != NULL, FALSE);
1470 g_return_val_if_fail (value != NULL, FALSE);
1472 field = gst_structure_get_field (structure, fieldname);
1474 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_UINT64)
1477 *value = gst_g_value_get_uint64_unchecked (&field->value);
1483 * gst_structure_get_date:
1484 * @structure: a #GstStructure
1485 * @fieldname: the name of a field
1486 * @value: (out callee-allocates): a pointer to a #GDate to set
1488 * Sets the date pointed to by @value corresponding to the date of the
1489 * given field. Caller is responsible for making sure the field exists
1490 * and has the correct type.
1492 * On success @value will point to a newly-allocated copy of the date which
1493 * should be freed with g_date_free() when no longer needed (note: this is
1494 * inconsistent with e.g. gst_structure_get_string() which doesn't return a
1495 * copy of the string).
1497 * Returns: %TRUE if the value could be set correctly. If there was no field
1498 * with @fieldname or the existing field did not contain a data, this function
1502 gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
1505 GstStructureField *field;
1507 g_return_val_if_fail (structure != NULL, FALSE);
1508 g_return_val_if_fail (fieldname != NULL, FALSE);
1509 g_return_val_if_fail (value != NULL, FALSE);
1511 field = gst_structure_get_field (structure, fieldname);
1513 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_DATE)
1516 /* FIXME: 2.0 g_value_dup_boxed() -> g_value_get_boxed() */
1517 *value = g_value_dup_boxed (&field->value);
1523 * gst_structure_get_date_time:
1524 * @structure: a #GstStructure
1525 * @fieldname: the name of a field
1526 * @value: (out callee-allocates): a pointer to a #GstDateTime to set
1528 * Sets the datetime pointed to by @value corresponding to the datetime of the
1529 * given field. Caller is responsible for making sure the field exists
1530 * and has the correct type.
1532 * On success @value will point to a reference of the datetime which
1533 * should be unreffed with gst_date_time_unref() when no longer needed
1534 * (note: this is inconsistent with e.g. gst_structure_get_string()
1535 * which doesn't return a copy of the string).
1537 * Returns: %TRUE if the value could be set correctly. If there was no field
1538 * with @fieldname or the existing field did not contain a data, this function
1542 gst_structure_get_date_time (const GstStructure * structure,
1543 const gchar * fieldname, GstDateTime ** value)
1545 GstStructureField *field;
1547 g_return_val_if_fail (structure != NULL, FALSE);
1548 g_return_val_if_fail (fieldname != NULL, FALSE);
1549 g_return_val_if_fail (value != NULL, FALSE);
1551 field = gst_structure_get_field (structure, fieldname);
1555 if (!GST_VALUE_HOLDS_DATE_TIME (&field->value))
1558 /* FIXME 2.0: g_value_dup_boxed() -> g_value_get_boxed() */
1559 *value = g_value_dup_boxed (&field->value);
1565 * gst_structure_get_clock_time:
1566 * @structure: a #GstStructure
1567 * @fieldname: the name of a field
1568 * @value: (out): a pointer to a #GstClockTime to set
1570 * Sets the clock time pointed to by @value corresponding to the clock time
1571 * of the given field. Caller is responsible for making sure the field exists
1572 * and has the correct type.
1574 * Returns: %TRUE if the value could be set correctly. If there was no field
1575 * with @fieldname or the existing field did not contain a #GstClockTime, this
1576 * function returns %FALSE.
1579 gst_structure_get_clock_time (const GstStructure * structure,
1580 const gchar * fieldname, GstClockTime * value)
1582 return gst_structure_get_uint64 (structure, fieldname, value);
1586 * gst_structure_get_double:
1587 * @structure: a #GstStructure
1588 * @fieldname: the name of a field
1589 * @value: (out): a pointer to a gdouble to set
1591 * Sets the double pointed to by @value corresponding to the value of the
1592 * given field. Caller is responsible for making sure the field exists
1593 * and has the correct type.
1595 * Returns: %TRUE if the value could be set correctly. If there was no field
1596 * with @fieldname or the existing field did not contain a double, this
1597 * function returns %FALSE.
1600 gst_structure_get_double (const GstStructure * structure,
1601 const gchar * fieldname, gdouble * value)
1603 GstStructureField *field;
1605 g_return_val_if_fail (structure != NULL, FALSE);
1606 g_return_val_if_fail (fieldname != NULL, FALSE);
1607 g_return_val_if_fail (value != NULL, FALSE);
1609 field = gst_structure_get_field (structure, fieldname);
1611 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_DOUBLE)
1614 *value = gst_g_value_get_double_unchecked (&field->value);
1620 * gst_structure_get_string:
1621 * @structure: a #GstStructure
1622 * @fieldname: the name of a field
1624 * Finds the field corresponding to @fieldname, and returns the string
1625 * contained in the field's value. Caller is responsible for making
1626 * sure the field exists and has the correct type.
1628 * The string should not be modified, and remains valid until the next
1629 * call to a gst_structure_*() function with the given structure.
1631 * Returns: (nullable): a pointer to the string or %NULL when the
1632 * field did not exist or did not contain a string.
1635 gst_structure_get_string (const GstStructure * structure,
1636 const gchar * fieldname)
1638 GstStructureField *field;
1640 g_return_val_if_fail (structure != NULL, NULL);
1641 g_return_val_if_fail (fieldname != NULL, NULL);
1643 field = gst_structure_get_field (structure, fieldname);
1645 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_STRING)
1648 return gst_g_value_get_string_unchecked (&field->value);
1652 * gst_structure_get_enum:
1653 * @structure: a #GstStructure
1654 * @fieldname: the name of a field
1655 * @enumtype: the enum type of a field
1656 * @value: (out): a pointer to an int to set
1658 * Sets the int pointed to by @value corresponding to the value of the
1659 * given field. Caller is responsible for making sure the field exists,
1660 * has the correct type and that the enumtype is correct.
1662 * Returns: %TRUE if the value could be set correctly. If there was no field
1663 * with @fieldname or the existing field did not contain an enum of the given
1664 * type, this function returns %FALSE.
1667 gst_structure_get_enum (const GstStructure * structure,
1668 const gchar * fieldname, GType enumtype, gint * value)
1670 GstStructureField *field;
1672 g_return_val_if_fail (structure != NULL, FALSE);
1673 g_return_val_if_fail (fieldname != NULL, FALSE);
1674 g_return_val_if_fail (enumtype != G_TYPE_INVALID, FALSE);
1675 g_return_val_if_fail (value != NULL, FALSE);
1677 field = gst_structure_get_field (structure, fieldname);
1681 if (!G_TYPE_CHECK_VALUE_TYPE (&field->value, enumtype))
1684 *value = g_value_get_enum (&field->value);
1690 * gst_structure_get_fraction:
1691 * @structure: a #GstStructure
1692 * @fieldname: the name of a field
1693 * @value_numerator: (out): a pointer to an int to set
1694 * @value_denominator: (out): a pointer to an int to set
1696 * Sets the integers pointed to by @value_numerator and @value_denominator
1697 * corresponding to the value of the given field. Caller is responsible
1698 * for making sure the field exists and has the correct type.
1700 * Returns: %TRUE if the values could be set correctly. If there was no field
1701 * with @fieldname or the existing field did not contain a GstFraction, this
1702 * function returns %FALSE.
1705 gst_structure_get_fraction (const GstStructure * structure,
1706 const gchar * fieldname, gint * value_numerator, gint * value_denominator)
1708 GstStructureField *field;
1710 g_return_val_if_fail (structure != NULL, FALSE);
1711 g_return_val_if_fail (fieldname != NULL, FALSE);
1712 g_return_val_if_fail (value_numerator != NULL, FALSE);
1713 g_return_val_if_fail (value_denominator != NULL, FALSE);
1715 field = gst_structure_get_field (structure, fieldname);
1717 if (field == NULL || G_VALUE_TYPE (&field->value) != GST_TYPE_FRACTION)
1720 *value_numerator = gst_value_get_fraction_numerator (&field->value);
1721 *value_denominator = gst_value_get_fraction_denominator (&field->value);
1727 * gst_structure_get_flagset:
1728 * @structure: a #GstStructure
1729 * @fieldname: the name of a field
1730 * @value_flags: (out) (allow-none): a pointer to a guint for the flags field
1731 * @value_mask: (out) (allow-none): a pointer to a guint for the mask field
1733 * Read the GstFlagSet flags and mask out of the structure into the
1734 * provided pointers.
1736 * Returns: %TRUE if the values could be set correctly. If there was no field
1737 * with @fieldname or the existing field did not contain a GstFlagSet, this
1738 * function returns %FALSE.
1743 gst_structure_get_flagset (const GstStructure * structure,
1744 const gchar * fieldname, guint * value_flags, guint * value_mask)
1746 GstStructureField *field;
1748 g_return_val_if_fail (structure != NULL, FALSE);
1749 g_return_val_if_fail (fieldname != NULL, FALSE);
1751 field = gst_structure_get_field (structure, fieldname);
1753 if (field == NULL || !GST_VALUE_HOLDS_FLAG_SET (&field->value))
1757 *value_flags = gst_value_get_flagset_flags (&field->value);
1759 *value_mask = gst_value_get_flagset_mask (&field->value);
1765 gst_structure_value_get_generic_type (const GValue * val)
1767 if (G_VALUE_TYPE (val) == GST_TYPE_LIST
1768 || G_VALUE_TYPE (val) == GST_TYPE_ARRAY) {
1769 GArray *array = g_value_peek_pointer (val);
1771 if (array->len > 0) {
1772 GValue *value = &g_array_index (array, GValue, 0);
1774 return gst_structure_value_get_generic_type (value);
1778 } else if (G_VALUE_TYPE (val) == GST_TYPE_INT_RANGE) {
1780 } else if (G_VALUE_TYPE (val) == GST_TYPE_INT64_RANGE) {
1781 return G_TYPE_INT64;
1782 } else if (G_VALUE_TYPE (val) == GST_TYPE_DOUBLE_RANGE) {
1783 return G_TYPE_DOUBLE;
1784 } else if (G_VALUE_TYPE (val) == GST_TYPE_FRACTION_RANGE) {
1785 return GST_TYPE_FRACTION;
1787 return G_VALUE_TYPE (val);
1791 priv_gst_structure_append_to_gstring (const GstStructure * structure,
1794 GstStructureField *field;
1797 g_return_val_if_fail (s != NULL, FALSE);
1799 len = GST_STRUCTURE_FIELDS (structure)->len;
1800 for (i = 0; i < len; i++) {
1804 field = GST_STRUCTURE_FIELD (structure, i);
1806 if (G_VALUE_TYPE (&field->value) == GST_TYPE_ARRAY) {
1807 t = _priv_gst_value_serialize_any_list (&field->value, "< ", " >", FALSE);
1808 } else if (G_VALUE_TYPE (&field->value) == GST_TYPE_LIST) {
1809 t = _priv_gst_value_serialize_any_list (&field->value, "{ ", " }", FALSE);
1811 t = gst_value_serialize (&field->value);
1814 type = gst_structure_value_get_generic_type (&field->value);
1816 g_string_append_len (s, ", ", 2);
1817 /* FIXME: do we need to escape fieldnames? */
1818 g_string_append (s, g_quark_to_string (field->name));
1819 g_string_append_len (s, "=(", 2);
1820 g_string_append (s, _priv_gst_value_gtype_to_abbr (type));
1821 g_string_append_c (s, ')');
1823 g_string_append (s, t);
1826 if (!G_TYPE_CHECK_VALUE_TYPE (&field->value, G_TYPE_STRING) &&
1827 !(G_TYPE_CHECK_VALUE_TYPE (&field->value, G_TYPE_POINTER) &&
1828 g_value_get_pointer (&field->value) == NULL))
1829 GST_WARNING ("No value transform to serialize field '%s' of type '%s'",
1830 g_quark_to_string (field->name),
1831 _priv_gst_value_gtype_to_abbr (type));
1832 /* TODO(ensonic): don't print NULL if field->value is not empty */
1833 g_string_append (s, "NULL");
1837 g_string_append_c (s, ';');
1842 priv__gst_structure_append_template_to_gstring (GQuark field_id,
1843 const GValue * value, gpointer user_data)
1845 GType type = gst_structure_value_get_generic_type (value);
1846 GString *s = (GString *) user_data;
1848 g_string_append_len (s, ", ", 2);
1849 /* FIXME: do we need to escape fieldnames? */
1850 g_string_append (s, g_quark_to_string (field_id));
1851 g_string_append_len (s, "=(", 2);
1852 g_string_append (s, _priv_gst_value_gtype_to_abbr (type));
1853 g_string_append_c (s, ')');
1855 //TODO(ensonic): table like GstStructureAbbreviation (or extend it)
1856 if (type == G_TYPE_INT) {
1857 g_string_append_len (s, "%i", 2);
1858 } else if (type == G_TYPE_UINT) {
1859 g_string_append_len (s, "%u", 2);
1860 } else if (type == G_TYPE_FLOAT) {
1861 g_string_append_len (s, "%f", 2);
1862 } else if (type == G_TYPE_DOUBLE) {
1863 g_string_append_len (s, "%lf", 3);
1864 } else if (type == G_TYPE_STRING) {
1865 g_string_append_len (s, "%s", 2);
1866 } else if (type == G_TYPE_BOOLEAN) {
1867 /* we normally store this as a string, but can parse it also from an int */
1868 g_string_append_len (s, "%i", 2);
1869 } else if (type == G_TYPE_INT64) {
1870 g_string_append (s, "%" G_GINT64_FORMAT);
1871 } else if (type == G_TYPE_UINT64) {
1872 g_string_append (s, "%" G_GUINT64_FORMAT);
1873 } else if (type == GST_TYPE_STRUCTURE) {
1874 g_string_append (s, "%" GST_WRAPPED_PTR_FORMAT);
1875 } else if (g_type_is_a (type, G_TYPE_ENUM)
1876 || g_type_is_a (type, G_TYPE_FLAGS)) {
1877 g_string_append_len (s, "%i", 2);
1878 } else if (type == G_TYPE_GTYPE) {
1879 g_string_append_len (s, "%s", 2);
1880 } else if (type == G_TYPE_POINTER) {
1881 g_string_append_len (s, "%p", 2);
1883 GST_WARNING ("unhandled type: %s", g_type_name (type));
1884 g_string_append (s, "%" GST_WRAPPED_PTR_FORMAT);
1891 * gst_structure_to_string:
1892 * @structure: a #GstStructure
1894 * Converts @structure to a human-readable string representation.
1896 * For debugging purposes its easier to do something like this:
1897 * |[<!-- language="C" -->
1898 * GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
1900 * This prints the structure in human readable form.
1902 * The current implementation of serialization will lead to unexpected results
1903 * when there are nested #GstCaps / #GstStructure deeper than one level.
1905 * Free-function: g_free
1907 * Returns: (transfer full): a pointer to string allocated by g_malloc().
1908 * g_free() after usage.
1911 gst_structure_to_string (const GstStructure * structure)
1915 /* NOTE: This function is potentially called by the debug system,
1916 * so any calls to gst_log() (and GST_DEBUG(), GST_LOG(), etc.)
1917 * should be careful to avoid recursion. This includes any functions
1918 * called by gst_structure_to_string. In particular, calls should
1919 * not use the GST_PTR_FORMAT extension. */
1921 g_return_val_if_fail (structure != NULL, NULL);
1923 /* we estimate a minimum size based on the number of fields in order to
1924 * avoid unnecessary reallocs within GString */
1925 s = g_string_sized_new (STRUCTURE_ESTIMATED_STRING_LEN (structure));
1926 g_string_append (s, g_quark_to_string (structure->name));
1927 priv_gst_structure_append_to_gstring (structure, s);
1928 return g_string_free (s, FALSE);
1932 gst_structure_parse_field (gchar * str,
1933 gchar ** after, GstStructureField * field)
1942 while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
1945 if (G_UNLIKELY (!_priv_gst_value_parse_simple_string (s, &name_end))) {
1946 GST_WARNING ("failed to parse simple string, str=%s", str);
1951 while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
1954 if (G_UNLIKELY (*s != '=')) {
1955 GST_WARNING ("missing assignment operator in the field, str=%s", str);
1962 field->name = g_quark_from_string (name);
1963 GST_DEBUG ("trying field name '%s'", name);
1966 if (G_UNLIKELY (!_priv_gst_value_parse_value (s, &s, &field->value,
1968 GST_WARNING ("failed to parse value %s", str);
1977 priv_gst_structure_parse_name (gchar * str, gchar ** start, gchar ** end,
1985 /* skip spaces (FIXME: _isspace treats tabs and newlines as space!) */
1986 while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
1987 && g_ascii_isspace (r[1]))))
1992 if (G_UNLIKELY (!_priv_gst_value_parse_string (r, &w, &r, TRUE))) {
1993 GST_WARNING ("Failed to parse structure string '%s'", str);
2004 priv_gst_structure_parse_fields (gchar * str, gchar ** end,
2005 GstStructure * structure)
2008 GstStructureField field;
2013 while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2014 && g_ascii_isspace (r[1]))))
2017 /* end of structure, get the next char and finish */
2022 /* accept \0 as end delimiter */
2025 if (G_UNLIKELY (*r != ',')) {
2026 GST_WARNING ("Failed to find delimiter, r=%s", r);
2030 while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2031 && g_ascii_isspace (r[1]))))
2034 memset (&field, 0, sizeof (field));
2035 if (G_UNLIKELY (!gst_structure_parse_field (r, &r, &field))) {
2036 GST_WARNING ("Failed to parse field, r=%s", r);
2039 gst_structure_set_field (structure, &field);
2048 * gst_structure_new_from_string:
2049 * @string: a string representation of a #GstStructure
2051 * Creates a #GstStructure from a string representation.
2052 * If end is not %NULL, a pointer to the place inside the given string
2053 * where parsing ended will be returned.
2055 * The current implementation of serialization will lead to unexpected results
2056 * when there are nested #GstCaps / #GstStructure deeper than one level.
2058 * Free-function: gst_structure_free
2060 * Returns: (transfer full) (nullable): a new #GstStructure or %NULL
2061 * when the string could not be parsed. Free with
2062 * gst_structure_free() after use.
2067 gst_structure_new_from_string (const gchar * string)
2069 return gst_structure_from_string (string, NULL);
2073 * gst_structure_from_string:
2074 * @string: a string representation of a #GstStructure.
2075 * @end: (out) (allow-none) (transfer none) (skip): pointer to store the end of the string in.
2077 * Creates a #GstStructure from a string representation.
2078 * If end is not %NULL, a pointer to the place inside the given string
2079 * where parsing ended will be returned.
2081 * Free-function: gst_structure_free
2083 * Returns: (transfer full) (nullable): a new #GstStructure or %NULL
2084 * when the string could not be parsed. Free with
2085 * gst_structure_free() after use.
2088 gst_structure_from_string (const gchar * string, gchar ** end)
2095 GstStructure *structure = NULL;
2097 g_return_val_if_fail (string != NULL, NULL);
2099 copy = g_strdup (string);
2102 if (!priv_gst_structure_parse_name (r, &name, &w, &r))
2107 structure = gst_structure_new_empty (name);
2110 if (G_UNLIKELY (structure == NULL))
2113 if (!priv_gst_structure_parse_fields (r, &r, structure))
2117 *end = (char *) string + (r - copy);
2119 g_warning ("gst_structure_from_string did not consume whole string,"
2120 " but caller did not provide end pointer (\"%s\")", string);
2127 gst_structure_free (structure);
2133 gst_structure_transform_to_string (const GValue * src_value,
2134 GValue * dest_value)
2136 g_return_if_fail (src_value != NULL);
2137 g_return_if_fail (dest_value != NULL);
2139 dest_value->data[0].v_pointer =
2140 gst_structure_to_string (src_value->data[0].v_pointer);
2143 static GstStructure *
2144 gst_structure_copy_conditional (const GstStructure * structure)
2147 return gst_structure_copy (structure);
2151 /* fixate utility functions */
2154 * gst_structure_fixate_field_nearest_int:
2155 * @structure: a #GstStructure
2156 * @field_name: a field in @structure
2157 * @target: the target value of the fixation
2159 * Fixates a #GstStructure by changing the given field to the nearest
2160 * integer to @target that is a subset of the existing field.
2162 * Returns: %TRUE if the structure could be fixated
2165 gst_structure_fixate_field_nearest_int (GstStructure * structure,
2166 const char *field_name, int target)
2168 const GValue *value;
2170 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2171 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2173 value = gst_structure_get_value (structure, field_name);
2175 if (G_VALUE_TYPE (value) == G_TYPE_INT) {
2178 } else if (G_VALUE_TYPE (value) == GST_TYPE_INT_RANGE) {
2181 x = gst_value_get_int_range_min (value);
2184 x = gst_value_get_int_range_max (value);
2187 gst_structure_set (structure, field_name, G_TYPE_INT, target, NULL);
2189 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2190 const GValue *list_value;
2193 int best_index = -1;
2195 n = gst_value_list_get_size (value);
2196 for (i = 0; i < n; i++) {
2197 list_value = gst_value_list_get_value (value, i);
2198 if (G_VALUE_TYPE (list_value) == G_TYPE_INT) {
2199 int x = gst_g_value_get_int_unchecked (list_value);
2201 if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2207 if (best_index != -1) {
2208 gst_structure_set (structure, field_name, G_TYPE_INT, best, NULL);
2218 * gst_structure_fixate_field_nearest_double:
2219 * @structure: a #GstStructure
2220 * @field_name: a field in @structure
2221 * @target: the target value of the fixation
2223 * Fixates a #GstStructure by changing the given field to the nearest
2224 * double to @target that is a subset of the existing field.
2226 * Returns: %TRUE if the structure could be fixated
2229 gst_structure_fixate_field_nearest_double (GstStructure * structure,
2230 const char *field_name, double target)
2232 const GValue *value;
2234 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2235 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2237 value = gst_structure_get_value (structure, field_name);
2239 if (G_VALUE_TYPE (value) == G_TYPE_DOUBLE) {
2242 } else if (G_VALUE_TYPE (value) == GST_TYPE_DOUBLE_RANGE) {
2245 x = gst_value_get_double_range_min (value);
2248 x = gst_value_get_double_range_max (value);
2251 gst_structure_set (structure, field_name, G_TYPE_DOUBLE, target, NULL);
2253 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2254 const GValue *list_value;
2257 int best_index = -1;
2259 n = gst_value_list_get_size (value);
2260 for (i = 0; i < n; i++) {
2261 list_value = gst_value_list_get_value (value, i);
2262 if (G_VALUE_TYPE (list_value) == G_TYPE_DOUBLE) {
2263 double x = gst_g_value_get_double_unchecked (list_value);
2265 if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2271 if (best_index != -1) {
2272 gst_structure_set (structure, field_name, G_TYPE_DOUBLE, best, NULL);
2283 * gst_structure_fixate_field_boolean:
2284 * @structure: a #GstStructure
2285 * @field_name: a field in @structure
2286 * @target: the target value of the fixation
2288 * Fixates a #GstStructure by changing the given @field_name field to the given
2289 * @target boolean if that field is not fixed yet.
2291 * Returns: %TRUE if the structure could be fixated
2294 gst_structure_fixate_field_boolean (GstStructure * structure,
2295 const char *field_name, gboolean target)
2297 const GValue *value;
2299 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2300 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2302 value = gst_structure_get_value (structure, field_name);
2304 if (G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
2307 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2308 const GValue *list_value;
2311 int best_index = -1;
2313 n = gst_value_list_get_size (value);
2314 for (i = 0; i < n; i++) {
2315 list_value = gst_value_list_get_value (value, i);
2316 if (G_VALUE_TYPE (list_value) == G_TYPE_BOOLEAN) {
2317 gboolean x = gst_g_value_get_boolean_unchecked (list_value);
2319 if (best_index == -1 || x == target) {
2325 if (best_index != -1) {
2326 gst_structure_set (structure, field_name, G_TYPE_BOOLEAN, best, NULL);
2336 * gst_structure_fixate_field_string:
2337 * @structure: a #GstStructure
2338 * @field_name: a field in @structure
2339 * @target: the target value of the fixation
2341 * Fixates a #GstStructure by changing the given @field_name field to the given
2342 * @target string if that field is not fixed yet.
2344 * Returns: %TRUE if the structure could be fixated
2347 gst_structure_fixate_field_string (GstStructure * structure,
2348 const gchar * field_name, const gchar * target)
2350 const GValue *value;
2352 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2353 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2355 value = gst_structure_get_value (structure, field_name);
2357 if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
2360 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2361 const GValue *list_value;
2363 const gchar *best = NULL;
2364 int best_index = -1;
2366 n = gst_value_list_get_size (value);
2367 for (i = 0; i < n; i++) {
2368 list_value = gst_value_list_get_value (value, i);
2369 if (G_VALUE_TYPE (list_value) == G_TYPE_STRING) {
2370 const gchar *x = g_value_get_string (list_value);
2372 if (best_index == -1 || g_str_equal (x, target)) {
2378 if (best_index != -1) {
2379 gst_structure_set (structure, field_name, G_TYPE_STRING, best, NULL);
2389 * gst_structure_fixate_field_nearest_fraction:
2390 * @structure: a #GstStructure
2391 * @field_name: a field in @structure
2392 * @target_numerator: The numerator of the target value of the fixation
2393 * @target_denominator: The denominator of the target value of the fixation
2395 * Fixates a #GstStructure by changing the given field to the nearest
2396 * fraction to @target_numerator/@target_denominator that is a subset
2397 * of the existing field.
2399 * Returns: %TRUE if the structure could be fixated
2402 gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
2403 const char *field_name, const gint target_numerator,
2404 const gint target_denominator)
2406 const GValue *value;
2408 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2409 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2410 g_return_val_if_fail (target_denominator != 0, FALSE);
2412 value = gst_structure_get_value (structure, field_name);
2414 if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION) {
2417 } else if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION_RANGE) {
2418 const GValue *x, *new_value;
2419 GValue target = { 0 };
2420 g_value_init (&target, GST_TYPE_FRACTION);
2421 gst_value_set_fraction (&target, target_numerator, target_denominator);
2423 new_value = ⌖
2424 x = gst_value_get_fraction_range_min (value);
2425 if (gst_value_compare (&target, x) == GST_VALUE_LESS_THAN)
2427 x = gst_value_get_fraction_range_max (value);
2428 if (gst_value_compare (&target, x) == GST_VALUE_GREATER_THAN)
2431 gst_structure_set_value (structure, field_name, new_value);
2432 g_value_unset (&target);
2434 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2435 const GValue *list_value;
2437 const GValue *best = NULL;
2440 gdouble best_diff = G_MAXDOUBLE;
2442 target = (gdouble) target_numerator / (gdouble) target_denominator;
2444 GST_DEBUG ("target %g, best %g", target, best_diff);
2448 n = gst_value_list_get_size (value);
2449 for (i = 0; i < n; i++) {
2450 list_value = gst_value_list_get_value (value, i);
2451 if (G_VALUE_TYPE (list_value) == GST_TYPE_FRACTION) {
2453 gdouble list_double;
2455 num = gst_value_get_fraction_numerator (list_value);
2456 denom = gst_value_get_fraction_denominator (list_value);
2458 list_double = ((gdouble) num / (gdouble) denom);
2459 cur_diff = target - list_double;
2461 GST_DEBUG ("curr diff %g, list %g", cur_diff, list_double);
2464 cur_diff = -cur_diff;
2466 if (!best || cur_diff < best_diff) {
2467 GST_DEBUG ("new best %g", list_double);
2469 best_diff = cur_diff;
2474 gst_structure_set_value (structure, field_name, best);
2483 default_fixate (GQuark field_id, const GValue * value, gpointer data)
2485 GstStructure *s = data;
2488 if (gst_value_fixate (&v, value)) {
2489 gst_structure_id_take_value (s, field_id, &v);
2495 * gst_structure_fixate_field:
2496 * @structure: a #GstStructure
2497 * @field_name: a field in @structure
2499 * Fixates a #GstStructure by changing the given field with its fixated value.
2501 * Returns: %TRUE if the structure field could be fixated
2504 gst_structure_fixate_field (GstStructure * structure, const char *field_name)
2506 GstStructureField *field;
2508 g_return_val_if_fail (structure != NULL, FALSE);
2509 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2511 if (!(field = gst_structure_get_field (structure, field_name)))
2514 return default_fixate (field->name, &field->value, structure);
2517 /* our very own version of G_VALUE_LCOPY that allows NULL return locations
2518 * (useful for message parsing functions where the return location is user
2519 * supplied and the user may pass %NULL if the value isn't of interest) */
2520 #define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname) \
2522 const GValue *_value = (value); \
2523 guint _flags = (flags); \
2524 GType _value_type = G_VALUE_TYPE (_value); \
2525 GTypeValueTable *_vtable = g_type_value_table_peek (_value_type); \
2526 const gchar *_lcopy_format = _vtable->lcopy_format; \
2527 GTypeCValue _cvalues[G_VALUE_COLLECT_FORMAT_MAX_LENGTH] = { { 0, }, }; \
2528 guint _n_values = 0; \
2530 while (*_lcopy_format != '\0') { \
2531 g_assert (*_lcopy_format == G_VALUE_COLLECT_POINTER); \
2532 _cvalues[_n_values++].v_pointer = va_arg ((var_args), gpointer); \
2535 if (_n_values == 2 && !!_cvalues[0].v_pointer != !!_cvalues[1].v_pointer) { \
2536 *(__error) = g_strdup_printf ("either all or none of the return " \
2537 "locations for field '%s' need to be NULL", fieldname); \
2538 } else if (_cvalues[0].v_pointer != NULL) { \
2539 *(__error) = _vtable->lcopy_value (_value, _n_values, _cvalues, _flags); \
2544 * gst_structure_get_valist:
2545 * @structure: a #GstStructure
2546 * @first_fieldname: the name of the first field to read
2547 * @args: variable arguments
2549 * Parses the variable arguments and reads fields from @structure accordingly.
2550 * valist-variant of gst_structure_get(). Look at the documentation of
2551 * gst_structure_get() for more details.
2553 * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields
2556 gst_structure_get_valist (const GstStructure * structure,
2557 const char *first_fieldname, va_list args)
2559 const char *field_name;
2560 GType expected_type = G_TYPE_INVALID;
2562 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2563 g_return_val_if_fail (first_fieldname != NULL, FALSE);
2565 field_name = first_fieldname;
2566 while (field_name) {
2567 const GValue *val = NULL;
2570 expected_type = va_arg (args, GType);
2572 val = gst_structure_get_value (structure, field_name);
2577 if (G_VALUE_TYPE (val) != expected_type)
2580 GST_VALUE_LCOPY (val, args, 0, &err, field_name);
2582 g_warning ("%s: %s", G_STRFUNC, err);
2587 field_name = va_arg (args, const gchar *);
2595 GST_INFO ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2596 field_name, structure);
2601 GST_INFO ("Expected field '%s' in structure to be of type '%s', but "
2602 "field was of type '%s': %" GST_PTR_FORMAT, field_name,
2603 GST_STR_NULL (g_type_name (expected_type)),
2604 G_VALUE_TYPE_NAME (gst_structure_get_value (structure, field_name)),
2611 * gst_structure_id_get_valist:
2612 * @structure: a #GstStructure
2613 * @first_field_id: the quark of the first field to read
2614 * @args: variable arguments
2616 * Parses the variable arguments and reads fields from @structure accordingly.
2617 * valist-variant of gst_structure_id_get(). Look at the documentation of
2618 * gst_structure_id_get() for more details.
2620 * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields
2623 gst_structure_id_get_valist (const GstStructure * structure,
2624 GQuark first_field_id, va_list args)
2627 GType expected_type = G_TYPE_INVALID;
2629 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2630 g_return_val_if_fail (first_field_id != 0, FALSE);
2632 field_id = first_field_id;
2634 const GValue *val = NULL;
2637 expected_type = va_arg (args, GType);
2639 val = gst_structure_id_get_value (structure, field_id);
2644 if (G_VALUE_TYPE (val) != expected_type)
2647 GST_VALUE_LCOPY (val, args, 0, &err, g_quark_to_string (field_id));
2649 g_warning ("%s: %s", G_STRFUNC, err);
2654 field_id = va_arg (args, GQuark);
2662 GST_DEBUG ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2663 GST_STR_NULL (g_quark_to_string (field_id)), structure);
2668 GST_DEBUG ("Expected field '%s' in structure to be of type '%s', but "
2669 "field was of type '%s': %" GST_PTR_FORMAT,
2670 g_quark_to_string (field_id),
2671 GST_STR_NULL (g_type_name (expected_type)),
2672 G_VALUE_TYPE_NAME (gst_structure_id_get_value (structure, field_id)),
2679 * gst_structure_get:
2680 * @structure: a #GstStructure
2681 * @first_fieldname: the name of the first field to read
2682 * @...: variable arguments
2684 * Parses the variable arguments and reads fields from @structure accordingly.
2685 * Variable arguments should be in the form field name, field type
2686 * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2687 * The last variable argument should be %NULL.
2689 * For refcounted (mini)objects you will receive a new reference which
2690 * you must release with a suitable _unref() when no longer needed. For
2691 * strings and boxed types you will receive a copy which you will need to
2692 * release with either g_free() or the suitable function for the boxed type.
2694 * Returns: %FALSE if there was a problem reading any of the fields (e.g.
2695 * because the field requested did not exist, or was of a type other
2696 * than the type specified), otherwise %TRUE.
2699 gst_structure_get (const GstStructure * structure, const char *first_fieldname,
2705 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2706 g_return_val_if_fail (first_fieldname != NULL, FALSE);
2708 va_start (args, first_fieldname);
2709 ret = gst_structure_get_valist (structure, first_fieldname, args);
2716 * gst_structure_id_get:
2717 * @structure: a #GstStructure
2718 * @first_field_id: the quark of the first field to read
2719 * @...: variable arguments
2721 * Parses the variable arguments and reads fields from @structure accordingly.
2722 * Variable arguments should be in the form field id quark, field type
2723 * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2724 * The last variable argument should be %NULL (technically it should be a
2725 * 0 quark, but we require %NULL so compilers that support it can check for
2726 * the %NULL terminator and warn if it's not there).
2728 * This function is just like gst_structure_get() only that it is slightly
2729 * more efficient since it saves the string-to-quark lookup in the global
2732 * For refcounted (mini)objects you will receive a new reference which
2733 * you must release with a suitable _unref() when no longer needed. For
2734 * strings and boxed types you will receive a copy which you will need to
2735 * release with either g_free() or the suitable function for the boxed type.
2737 * Returns: %FALSE if there was a problem reading any of the fields (e.g.
2738 * because the field requested did not exist, or was of a type other
2739 * than the type specified), otherwise %TRUE.
2742 gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
2748 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2749 g_return_val_if_fail (first_field_id != 0, FALSE);
2751 va_start (args, first_field_id);
2752 ret = gst_structure_id_get_valist (structure, first_field_id, args);
2759 gst_structure_is_equal_foreach (GQuark field_id, const GValue * val2,
2762 const GstStructure *struct1 = (const GstStructure *) data;
2763 const GValue *val1 = gst_structure_id_get_value (struct1, field_id);
2765 if (G_UNLIKELY (val1 == NULL))
2767 if (gst_value_compare (val1, val2) == GST_VALUE_EQUAL) {
2775 * gst_structure_is_equal:
2776 * @structure1: a #GstStructure.
2777 * @structure2: a #GstStructure.
2779 * Tests if the two #GstStructure are equal.
2781 * Returns: %TRUE if the two structures have the same name and field.
2784 gst_structure_is_equal (const GstStructure * structure1,
2785 const GstStructure * structure2)
2787 g_return_val_if_fail (GST_IS_STRUCTURE (structure1), FALSE);
2788 g_return_val_if_fail (GST_IS_STRUCTURE (structure2), FALSE);
2790 if (G_UNLIKELY (structure1 == structure2))
2793 if (structure1->name != structure2->name) {
2796 if (GST_STRUCTURE_FIELDS (structure1)->len !=
2797 GST_STRUCTURE_FIELDS (structure2)->len) {
2801 return gst_structure_foreach (structure1, gst_structure_is_equal_foreach,
2802 (gpointer) structure2);
2809 const GstStructure *intersect;
2814 gst_structure_intersect_field1 (GQuark id, const GValue * val1, gpointer data)
2816 IntersectData *idata = (IntersectData *) data;
2817 const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
2819 if (G_UNLIKELY (val2 == NULL)) {
2820 gst_structure_id_set_value (idata->dest, id, val1);
2822 GValue dest_value = { 0 };
2823 if (gst_value_intersect (&dest_value, val1, val2)) {
2824 gst_structure_id_take_value (idata->dest, id, &dest_value);
2833 gst_structure_intersect_field2 (GQuark id, const GValue * val1, gpointer data)
2835 IntersectData *idata = (IntersectData *) data;
2836 const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
2838 if (G_UNLIKELY (val2 == NULL)) {
2839 gst_structure_id_set_value (idata->dest, id, val1);
2845 * gst_structure_intersect:
2846 * @struct1: a #GstStructure
2847 * @struct2: a #GstStructure
2849 * Intersects @struct1 and @struct2 and returns the intersection.
2851 * Returns: Intersection of @struct1 and @struct2
2854 gst_structure_intersect (const GstStructure * struct1,
2855 const GstStructure * struct2)
2859 g_assert (struct1 != NULL);
2860 g_assert (struct2 != NULL);
2862 if (G_UNLIKELY (struct1->name != struct2->name))
2865 /* copy fields from struct1 which we have not in struct2 to target
2866 * intersect if we have the field in both */
2867 data.dest = gst_structure_new_id_empty (struct1->name);
2868 data.intersect = struct2;
2869 if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct1,
2870 gst_structure_intersect_field1, &data)))
2873 /* copy fields from struct2 which we have not in struct1 to target */
2874 data.intersect = struct1;
2875 if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct2,
2876 gst_structure_intersect_field2, &data)))
2882 gst_structure_free (data.dest);
2887 gst_caps_structure_can_intersect_field (GQuark id, const GValue * val1,
2890 GstStructure *other = (GstStructure *) data;
2891 const GValue *val2 = gst_structure_id_get_value (other, id);
2893 if (G_LIKELY (val2)) {
2894 if (!gst_value_can_intersect (val1, val2)) {
2897 gint eq = gst_value_compare (val1, val2);
2899 if (eq == GST_VALUE_UNORDERED) {
2900 /* we need to try interseting */
2901 if (!gst_value_intersect (NULL, val1, val2)) {
2904 } else if (eq != GST_VALUE_EQUAL) {
2913 * gst_structure_can_intersect:
2914 * @struct1: a #GstStructure
2915 * @struct2: a #GstStructure
2917 * Tries intersecting @struct1 and @struct2 and reports whether the result
2918 * would not be empty.
2920 * Returns: %TRUE if intersection would not be empty
2923 gst_structure_can_intersect (const GstStructure * struct1,
2924 const GstStructure * struct2)
2926 g_return_val_if_fail (GST_IS_STRUCTURE (struct1), FALSE);
2927 g_return_val_if_fail (GST_IS_STRUCTURE (struct2), FALSE);
2929 if (G_UNLIKELY (struct1->name != struct2->name))
2932 /* tries to intersect if we have the field in both */
2933 return gst_structure_foreach ((GstStructure *) struct1,
2934 gst_caps_structure_can_intersect_field, (gpointer) struct2);
2938 gst_caps_structure_is_superset_field (GQuark field_id, const GValue * value,
2941 GstStructure *subset = user_data;
2942 const GValue *other;
2945 if (!(other = gst_structure_id_get_value (subset, field_id)))
2946 /* field is missing in the subset => no subset */
2949 comparison = gst_value_compare (value, other);
2951 /* equal values are subset */
2952 if (comparison == GST_VALUE_EQUAL)
2955 /* ordered, but unequal, values are not */
2956 if (comparison != GST_VALUE_UNORDERED)
2959 return gst_value_is_subset (other, value);
2963 * gst_structure_is_subset:
2964 * @subset: a #GstStructure
2965 * @superset: a potentially greater #GstStructure
2967 * Checks if @subset is a subset of @superset, i.e. has the same
2968 * structure name and for all fields that are existing in @superset,
2969 * @subset has a value that is a subset of the value in @superset.
2971 * Returns: %TRUE if @subset is a subset of @superset
2974 gst_structure_is_subset (const GstStructure * subset,
2975 const GstStructure * superset)
2977 if ((superset->name != subset->name) ||
2978 (gst_structure_n_fields (superset) > gst_structure_n_fields (subset)))
2981 return gst_structure_foreach ((GstStructure *) superset,
2982 gst_caps_structure_is_superset_field, (gpointer) subset);
2987 * gst_structure_fixate:
2988 * @structure: a #GstStructure
2990 * Fixate all values in @structure using gst_value_fixate().
2991 * @structure will be modified in-place and should be writable.
2994 gst_structure_fixate (GstStructure * structure)
2996 g_return_if_fail (GST_IS_STRUCTURE (structure));
2998 gst_structure_foreach (structure, default_fixate, structure);
3002 _gst_structure_get_any_list (GstStructure * structure, GType type,
3003 const gchar * fieldname, GValueArray ** array)
3005 GstStructureField *field;
3006 GValue val = G_VALUE_INIT;
3008 g_return_val_if_fail (structure != NULL, FALSE);
3009 g_return_val_if_fail (fieldname != NULL, FALSE);
3010 g_return_val_if_fail (array != NULL, FALSE);
3012 field = gst_structure_get_field (structure, fieldname);
3014 if (field == NULL || G_VALUE_TYPE (&field->value) != type)
3017 g_value_init (&val, G_TYPE_VALUE_ARRAY);
3019 if (g_value_transform (&field->value, &val)) {
3020 *array = g_value_get_boxed (&val);
3024 g_value_unset (&val);
3029 * gst_structure_get_array:
3030 * @structure: a #GstStructure
3031 * @fieldname: the name of a field
3032 * @array: (out): a pointer to a #GValueArray
3034 * This is useful in language bindings where unknown #GValue types are not
3035 * supported. This function will convert the %GST_TYPE_ARRAY and
3036 * %GST_TYPE_LIST into a newly allocated #GValueArray and return it through
3037 * @array. Be aware that this is slower then getting the #GValue directly.
3039 * Returns: %TRUE if the value could be set correctly. If there was no field
3040 * with @fieldname or the existing field did not contain an int, this function
3044 gst_structure_get_array (GstStructure * structure, const gchar * fieldname,
3045 GValueArray ** array)
3047 return _gst_structure_get_any_list (structure, GST_TYPE_ARRAY, fieldname,
3052 * gst_structure_get_list:
3053 * @structure: a #GstStructure
3054 * @fieldname: the name of a field
3055 * @array: (out): a pointer to a #GValueArray
3057 * This is useful in language bindings where unknown #GValue types are not
3058 * supported. This function will convert the %GST_TYPE_ARRAY and
3059 * %GST_TYPE_LIST into a newly allocated GValueArray and return it through
3060 * @array. Be aware that this is slower then getting the #GValue directly.
3062 * Returns: %TRUE if the value could be set correctly. If there was no field
3063 * with @fieldname or the existing field did not contain an int, this function
3069 gst_structure_get_list (GstStructure * structure, const gchar * fieldname,
3070 GValueArray ** array)
3072 return _gst_structure_get_any_list (structure, GST_TYPE_LIST, fieldname,
3077 _gst_structure_set_any_list (GstStructure * structure, GType type,
3078 const gchar * fieldname, const GValueArray * array)
3080 GValue arval = G_VALUE_INIT;
3081 GValue value = G_VALUE_INIT;
3083 g_return_if_fail (structure != NULL);
3084 g_return_if_fail (fieldname != NULL);
3085 g_return_if_fail (array != NULL);
3086 g_return_if_fail (IS_MUTABLE (structure));
3088 g_value_init (&value, type);
3089 g_value_init (&arval, G_TYPE_VALUE_ARRAY);
3090 g_value_set_static_boxed (&arval, array);
3092 if (g_value_transform (&arval, &value)) {
3093 gst_structure_id_set_value_internal (structure,
3094 g_quark_from_string (fieldname), &value);
3096 g_warning ("Failed to convert a GValueArray");
3099 g_value_unset (&arval);
3100 g_value_unset (&value);
3104 * gst_structure_set_array:
3105 * @structure: a #GstStructure
3106 * @fieldname: the name of a field
3107 * @array: a pointer to a #GValueArray
3109 * This is useful in language bindings where unknown GValue types are not
3110 * supported. This function will convert a @array to %GST_TYPE_ARRAY and set
3111 * the field specified by @fieldname. Be aware that this is slower then using
3112 * %GST_TYPE_ARRAY in a #GValue directly.
3117 gst_structure_set_array (GstStructure * structure, const gchar * fieldname,
3118 const GValueArray * array)
3120 _gst_structure_set_any_list (structure, GST_TYPE_ARRAY, fieldname, array);
3124 * gst_structure_set_list:
3125 * @structure: a #GstStructure
3126 * @fieldname: the name of a field
3127 * @array: a pointer to a #GValueArray
3129 * This is useful in language bindings where unknown GValue types are not
3130 * supported. This function will convert a @array to %GST_TYPE_ARRAY and set
3131 * the field specified by @fieldname. Be aware that this is slower then using
3132 * %GST_TYPE_ARRAY in a #GValue directly.
3137 gst_structure_set_list (GstStructure * structure, const gchar * fieldname,
3138 const GValueArray * array)
3140 _gst_structure_set_any_list (structure, GST_TYPE_LIST, fieldname, array);