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 * @short_description: Generic structure containing fields of names and values
25 * @see_also: #GstCaps, #GstMessage, #GstEvent, #GstQuery
27 * A #GstStructure is a collection of key/value pairs. The keys are expressed
28 * as GQuarks and the values can be of any GType.
30 * In addition to the key/value pairs, a #GstStructure also has a name. The name
31 * starts with a letter and can be filled by letters, numbers and any of "/-_.:".
33 * #GstStructure is used by various GStreamer subsystems to store information
34 * in a flexible and extensible way. A #GstStructure does not have a refcount
35 * because it usually is part of a higher level object such as #GstCaps,
36 * #GstMessage, #GstEvent, #GstQuery. It provides a means to enforce mutability
37 * using the refcount of the parent with the gst_structure_set_parent_refcount()
40 * A #GstStructure can be created with gst_structure_new_empty() or
41 * gst_structure_new(), which both take a name and an optional set of
42 * key/value pairs along with the types of the values.
44 * Field values can be changed with gst_structure_set_value() or
45 * gst_structure_set().
47 * Field values can be retrieved with gst_structure_get_value() or the more
48 * convenient gst_structure_get_*() functions.
50 * Fields can be removed with gst_structure_remove_field() or
51 * gst_structure_remove_fields().
53 * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
54 * not allowed. Strings may be %NULL however.
56 * Be aware that the current #GstCaps / #GstStructure serialization into string
57 * has limited support for nested #GstCaps / #GstStructure fields. It can only
58 * support one level of nesting. Using more levels will lead to unexpected
59 * behavior when using serialization features, such as gst_caps_to_string() or
60 * gst_value_serialize() and their counterparts.
69 #include "gst_private.h"
72 #include <gobject/gvaluecollector.h>
74 GST_DEBUG_CATEGORY_STATIC (gst_structure_debug);
75 #define GST_CAT_DEFAULT gst_structure_debug
77 typedef struct _GstStructureField GstStructureField;
79 struct _GstStructureField
89 /* owned by parent structure, NULL if no parent */
90 gint *parent_refcount;
95 #define GST_STRUCTURE_REFCOUNT(s) (((GstStructureImpl*)(s))->parent_refcount)
96 #define GST_STRUCTURE_FIELDS(s) (((GstStructureImpl*)(s))->fields)
98 #define GST_STRUCTURE_FIELD(structure, index) \
99 &g_array_index(GST_STRUCTURE_FIELDS(structure), GstStructureField, (index))
101 #define IS_MUTABLE(structure) \
102 (!GST_STRUCTURE_REFCOUNT(structure) || \
103 g_atomic_int_get (GST_STRUCTURE_REFCOUNT(structure)) == 1)
105 #define IS_TAGLIST(structure) \
106 (structure->name == GST_QUARK (TAGLIST))
108 static void gst_structure_set_field (GstStructure * structure,
109 GstStructureField * field);
110 static GstStructureField *gst_structure_get_field (const GstStructure *
111 structure, const gchar * fieldname);
112 static GstStructureField *gst_structure_id_get_field (const GstStructure *
113 structure, GQuark field);
114 static void gst_structure_transform_to_string (const GValue * src_value,
115 GValue * dest_value);
116 static GstStructure *gst_structure_copy_conditional (const GstStructure *
118 static gboolean gst_structure_parse_value (gchar * str, gchar ** after,
119 GValue * value, GType default_type);
120 static gboolean gst_structure_parse_simple_string (gchar * s, gchar ** end);
122 GType _gst_structure_type = 0;
125 G_DEFINE_BOXED_TYPE (GstStructure, gst_structure,
126 gst_structure_copy_conditional, gst_structure_free);
129 _priv_gst_structure_initialize (void)
131 _gst_structure_type = gst_structure_get_type ();
133 g_value_register_transform_func (_gst_structure_type, G_TYPE_STRING,
134 gst_structure_transform_to_string);
136 GST_DEBUG_CATEGORY_INIT (gst_structure_debug, "structure", 0,
137 "GstStructure debug");
140 static GstStructure *
141 gst_structure_new_id_empty_with_size (GQuark quark, guint prealloc)
143 GstStructureImpl *structure;
145 structure = g_slice_new (GstStructureImpl);
146 ((GstStructure *) structure)->type = _gst_structure_type;
147 ((GstStructure *) structure)->name = quark;
148 GST_STRUCTURE_REFCOUNT (structure) = NULL;
149 GST_STRUCTURE_FIELDS (structure) =
150 g_array_sized_new (FALSE, FALSE, sizeof (GstStructureField), prealloc);
152 GST_TRACE ("created structure %p", structure);
154 return GST_STRUCTURE_CAST (structure);
158 * gst_structure_new_id_empty:
159 * @quark: name of new structure
161 * Creates a new, empty #GstStructure with the given name as a GQuark.
163 * Free-function: gst_structure_free
165 * Returns: (transfer full): a new, empty #GstStructure
168 gst_structure_new_id_empty (GQuark quark)
170 g_return_val_if_fail (quark != 0, NULL);
172 return gst_structure_new_id_empty_with_size (quark, 0);
175 #ifndef G_DISABLE_CHECKS
177 gst_structure_validate_name (const gchar * name)
181 g_return_val_if_fail (name != NULL, FALSE);
183 if (G_UNLIKELY (!g_ascii_isalpha (*name))) {
184 GST_WARNING ("Invalid character '%c' at offset 0 in structure name: %s",
189 /* FIXME: test name string more */
191 while (*s && (g_ascii_isalnum (*s) || strchr ("/-_.:+", *s) != NULL))
193 if (G_UNLIKELY (*s != '\0')) {
194 GST_WARNING ("Invalid character '%c' at offset %" G_GUINTPTR_FORMAT " in"
195 " structure name: %s", *s, ((guintptr) s - (guintptr) name), name);
199 if (strncmp (name, "video/x-raw-", 12) == 0) {
200 g_warning ("0.10-style raw video caps are being created. Should be "
201 "video/x-raw,format=(string).. now.");
202 } else if (strncmp (name, "audio/x-raw-", 12) == 0) {
203 g_warning ("0.10-style raw audio caps are being created. Should be "
204 "audio/x-raw,format=(string).. now.");
212 * gst_structure_new_empty:
213 * @name: name of new structure
215 * Creates a new, empty #GstStructure with the given @name.
217 * See gst_structure_set_name() for constraints on the @name parameter.
219 * Free-function: gst_structure_free
221 * Returns: (transfer full): a new, empty #GstStructure
224 gst_structure_new_empty (const gchar * name)
226 g_return_val_if_fail (gst_structure_validate_name (name), NULL);
228 return gst_structure_new_id_empty_with_size (g_quark_from_string (name), 0);
233 * @name: name of new structure
234 * @firstfield: name of first field to set
235 * @...: additional arguments
237 * Creates a new #GstStructure with the given name. Parses the
238 * list of variable arguments and sets fields to the values listed.
239 * Variable arguments should be passed as field name, field type,
240 * and value. Last variable argument should be %NULL.
242 * Free-function: gst_structure_free
244 * Returns: (transfer full): a new #GstStructure
247 gst_structure_new (const gchar * name, const gchar * firstfield, ...)
249 GstStructure *structure;
252 va_start (varargs, firstfield);
253 structure = gst_structure_new_valist (name, firstfield, varargs);
260 * gst_structure_new_valist:
261 * @name: name of new structure
262 * @firstfield: name of first field to set
263 * @varargs: variable argument list
265 * Creates a new #GstStructure with the given @name. Structure fields
266 * are set according to the varargs in a manner similar to
267 * gst_structure_new().
269 * See gst_structure_set_name() for constraints on the @name parameter.
271 * Free-function: gst_structure_free
273 * Returns: (transfer full): a new #GstStructure
276 gst_structure_new_valist (const gchar * name,
277 const gchar * firstfield, va_list varargs)
279 GstStructure *structure;
281 structure = gst_structure_new_empty (name);
284 gst_structure_set_valist (structure, firstfield, varargs);
290 * gst_structure_set_parent_refcount:
291 * @structure: a #GstStructure
292 * @refcount: (in): a pointer to the parent's refcount
294 * Sets the parent_refcount field of #GstStructure. This field is used to
295 * determine whether a structure is mutable or not. This function should only be
296 * called by code implementing parent objects of #GstStructure, as described in
297 * the MT Refcounting section of the design documents.
299 * Returns: %TRUE if the parent refcount could be set.
302 gst_structure_set_parent_refcount (GstStructure * structure, gint * refcount)
304 g_return_val_if_fail (structure != NULL, FALSE);
306 /* if we have a parent_refcount already, we can only clear
307 * if with a NULL refcount */
308 if (GST_STRUCTURE_REFCOUNT (structure)) {
309 if (refcount != NULL) {
310 g_return_val_if_fail (refcount == NULL, FALSE);
314 if (refcount == NULL) {
315 g_return_val_if_fail (refcount != NULL, FALSE);
320 GST_STRUCTURE_REFCOUNT (structure) = refcount;
326 * gst_structure_copy:
327 * @structure: a #GstStructure to duplicate
329 * Duplicates a #GstStructure and all its fields and values.
331 * Free-function: gst_structure_free
333 * Returns: (transfer full): a new #GstStructure.
336 gst_structure_copy (const GstStructure * structure)
338 GstStructure *new_structure;
339 GstStructureField *field;
342 g_return_val_if_fail (structure != NULL, NULL);
344 len = GST_STRUCTURE_FIELDS (structure)->len;
345 new_structure = gst_structure_new_id_empty_with_size (structure->name, len);
347 for (i = 0; i < len; i++) {
348 GstStructureField new_field = { 0 };
350 field = GST_STRUCTURE_FIELD (structure, i);
352 new_field.name = field->name;
353 gst_value_init_and_copy (&new_field.value, &field->value);
354 g_array_append_val (GST_STRUCTURE_FIELDS (new_structure), new_field);
356 GST_CAT_TRACE (GST_CAT_PERFORMANCE, "doing copy %p -> %p",
357 structure, new_structure);
359 return new_structure;
363 * gst_structure_free:
364 * @structure: (in) (transfer full): the #GstStructure to free
366 * Frees a #GstStructure and all its fields and values. The structure must not
367 * have a parent when this function is called.
370 gst_structure_free (GstStructure * structure)
372 GstStructureField *field;
375 g_return_if_fail (structure != NULL);
376 g_return_if_fail (GST_STRUCTURE_REFCOUNT (structure) == NULL);
378 len = GST_STRUCTURE_FIELDS (structure)->len;
379 for (i = 0; i < len; i++) {
380 field = GST_STRUCTURE_FIELD (structure, i);
382 if (G_IS_VALUE (&field->value)) {
383 g_value_unset (&field->value);
386 g_array_free (GST_STRUCTURE_FIELDS (structure), TRUE);
388 memset (structure, 0xff, sizeof (GstStructure));
390 GST_TRACE ("free structure %p", structure);
392 g_slice_free1 (sizeof (GstStructureImpl), structure);
396 * gst_structure_get_name:
397 * @structure: a #GstStructure
399 * Get the name of @structure as a string.
401 * Returns: the name of the structure.
404 gst_structure_get_name (const GstStructure * structure)
406 g_return_val_if_fail (structure != NULL, NULL);
408 return g_quark_to_string (structure->name);
412 * gst_structure_has_name:
413 * @structure: a #GstStructure
414 * @name: structure name to check for
416 * Checks if the structure has the given name
418 * Returns: %TRUE if @name matches the name of the structure.
421 gst_structure_has_name (const GstStructure * structure, const gchar * name)
423 const gchar *structure_name;
425 g_return_val_if_fail (structure != NULL, FALSE);
426 g_return_val_if_fail (name != NULL, FALSE);
428 /* getting the string is cheap and comparing short strings is too
429 * should be faster than getting the quark for name and comparing the quarks
431 structure_name = g_quark_to_string (structure->name);
433 return (structure_name && strcmp (structure_name, name) == 0);
437 * gst_structure_get_name_id:
438 * @structure: a #GstStructure
440 * Get the name of @structure as a GQuark.
442 * Returns: the quark representing the name of the structure.
445 gst_structure_get_name_id (const GstStructure * structure)
447 g_return_val_if_fail (structure != NULL, 0);
449 return structure->name;
453 * gst_structure_set_name:
454 * @structure: a #GstStructure
455 * @name: the new name of the structure
457 * Sets the name of the structure to the given @name. The string
458 * provided is copied before being used. It must not be empty, start with a
459 * letter and can be followed by letters, numbers and any of "/-_.:".
462 gst_structure_set_name (GstStructure * structure, const gchar * name)
464 g_return_if_fail (structure != NULL);
465 g_return_if_fail (IS_MUTABLE (structure));
466 g_return_if_fail (gst_structure_validate_name (name));
468 structure->name = g_quark_from_string (name);
472 gst_structure_id_set_value_internal (GstStructure * structure, GQuark field,
473 const GValue * value)
475 GstStructureField gsfield = { 0, {0,} };
477 gsfield.name = field;
478 gst_value_init_and_copy (&gsfield.value, value);
480 gst_structure_set_field (structure, &gsfield);
484 * gst_structure_id_set_value:
485 * @structure: a #GstStructure
486 * @field: a #GQuark representing a field
487 * @value: the new value of the field
489 * Sets the field with the given GQuark @field to @value. If the field
490 * does not exist, it is created. If the field exists, the previous
491 * value is replaced and freed.
494 gst_structure_id_set_value (GstStructure * structure,
495 GQuark field, const GValue * value)
498 g_return_if_fail (structure != NULL);
499 g_return_if_fail (G_IS_VALUE (value));
500 g_return_if_fail (IS_MUTABLE (structure));
502 gst_structure_id_set_value_internal (structure, field, value);
506 * gst_structure_set_value:
507 * @structure: a #GstStructure
508 * @fieldname: the name of the field to set
509 * @value: the new value of the field
511 * Sets the field with the given name @field to @value. If the field
512 * does not exist, it is created. If the field exists, the previous
513 * value is replaced and freed.
516 gst_structure_set_value (GstStructure * structure,
517 const gchar * fieldname, const GValue * value)
519 g_return_if_fail (structure != NULL);
520 g_return_if_fail (fieldname != NULL);
521 g_return_if_fail (G_IS_VALUE (value));
522 g_return_if_fail (IS_MUTABLE (structure));
524 gst_structure_id_set_value_internal (structure,
525 g_quark_from_string (fieldname), value);
529 gst_structure_id_take_value_internal (GstStructure * structure, GQuark field,
532 GstStructureField gsfield = { 0, {0,} };
534 gsfield.name = field;
535 gsfield.value = *value;
537 gst_structure_set_field (structure, &gsfield);
539 /* we took ownership */
541 memset (value, 0, sizeof (GValue));
543 value->g_type = G_TYPE_INVALID;
548 * gst_structure_id_take_value:
549 * @structure: a #GstStructure
550 * @field: a #GQuark representing a field
551 * @value: (transfer full): the new value of the field
553 * Sets the field with the given GQuark @field to @value. If the field
554 * does not exist, it is created. If the field exists, the previous
555 * value is replaced and freed.
558 gst_structure_id_take_value (GstStructure * structure, GQuark field,
561 g_return_if_fail (structure != NULL);
562 g_return_if_fail (G_IS_VALUE (value));
563 g_return_if_fail (IS_MUTABLE (structure));
565 gst_structure_id_take_value_internal (structure, field, value);
569 * gst_structure_take_value:
570 * @structure: a #GstStructure
571 * @fieldname: the name of the field to set
572 * @value: (transfer full): the new value of the field
574 * Sets the field with the given name @field to @value. If the field
575 * does not exist, it is created. If the field exists, the previous
576 * value is replaced and freed. The function will take ownership of @value.
579 gst_structure_take_value (GstStructure * structure, const gchar * fieldname,
582 g_return_if_fail (structure != NULL);
583 g_return_if_fail (fieldname != NULL);
584 g_return_if_fail (G_IS_VALUE (value));
585 g_return_if_fail (IS_MUTABLE (structure));
587 gst_structure_id_take_value_internal (structure,
588 g_quark_from_string (fieldname), value);
592 gst_structure_set_valist_internal (GstStructure * structure,
593 const gchar * fieldname, va_list varargs)
599 GstStructureField field = { 0 };
601 field.name = g_quark_from_string (fieldname);
603 type = va_arg (varargs, GType);
605 G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
606 if (G_UNLIKELY (err)) {
607 g_critical ("%s", err);
610 gst_structure_set_field (structure, &field);
612 fieldname = va_arg (varargs, gchar *);
618 * @structure: a #GstStructure
619 * @fieldname: the name of the field to set
620 * @...: variable arguments
622 * Parses the variable arguments and sets fields accordingly.
623 * Variable arguments should be in the form field name, field type
624 * (as a GType), value(s). The last variable argument should be %NULL.
627 gst_structure_set (GstStructure * structure, const gchar * field, ...)
631 g_return_if_fail (structure != NULL);
632 g_return_if_fail (IS_MUTABLE (structure) || field == NULL);
634 va_start (varargs, field);
635 gst_structure_set_valist_internal (structure, field, varargs);
640 * gst_structure_set_valist:
641 * @structure: a #GstStructure
642 * @fieldname: the name of the field to set
643 * @varargs: variable arguments
645 * va_list form of gst_structure_set().
648 gst_structure_set_valist (GstStructure * structure,
649 const gchar * fieldname, va_list varargs)
651 g_return_if_fail (structure != NULL);
652 g_return_if_fail (IS_MUTABLE (structure));
654 gst_structure_set_valist_internal (structure, fieldname, varargs);
658 gst_structure_id_set_valist_internal (GstStructure * structure,
659 GQuark fieldname, va_list varargs)
665 GstStructureField field = { 0 };
667 field.name = fieldname;
668 type = va_arg (varargs, GType);
670 G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
671 if (G_UNLIKELY (err)) {
672 g_critical ("%s", err);
675 gst_structure_set_field (structure, &field);
677 fieldname = va_arg (varargs, GQuark);
682 * gst_structure_id_set:
683 * @structure: a #GstStructure
684 * @fieldname: the GQuark for the name of the field to set
685 * @...: variable arguments
687 * Identical to gst_structure_set, except that field names are
688 * passed using the GQuark for the field name. This allows more efficient
689 * setting of the structure if the caller already knows the associated
691 * The last variable argument must be %NULL.
694 gst_structure_id_set (GstStructure * structure, GQuark field, ...)
698 g_return_if_fail (structure != NULL);
700 va_start (varargs, field);
701 gst_structure_id_set_valist_internal (structure, field, varargs);
706 * gst_structure_id_set_valist:
707 * @structure: a #GstStructure
708 * @fieldname: the name of the field to set
709 * @varargs: variable arguments
711 * va_list form of gst_structure_id_set().
714 gst_structure_id_set_valist (GstStructure * structure,
715 GQuark fieldname, va_list varargs)
717 g_return_if_fail (structure != NULL);
718 g_return_if_fail (IS_MUTABLE (structure));
720 gst_structure_id_set_valist_internal (structure, fieldname, varargs);
724 * gst_structure_new_id:
725 * @name_quark: name of new structure
726 * @field_quark: the GQuark for the name of the field to set
727 * @...: variable arguments
729 * Creates a new #GstStructure with the given name as a GQuark, followed by
730 * fieldname quark, GType, argument(s) "triplets" in the same format as
731 * gst_structure_id_set(). Basically a convenience wrapper around
732 * gst_structure_new_id_empty() and gst_structure_id_set().
734 * The last variable argument must be %NULL (or 0).
736 * Free-function: gst_structure_free
738 * Returns: (transfer full): a new #GstStructure
741 gst_structure_new_id (GQuark name_quark, GQuark field_quark, ...)
746 g_return_val_if_fail (name_quark != 0, NULL);
747 g_return_val_if_fail (field_quark != 0, NULL);
749 s = gst_structure_new_id_empty (name_quark);
751 va_start (varargs, field_quark);
752 gst_structure_id_set_valist_internal (s, field_quark, varargs);
758 #if GST_VERSION_NANO == 1
759 #define GIT_G_WARNING g_warning
761 #define GIT_G_WARNING GST_WARNING
764 /* If the structure currently contains a field with the same name, it is
765 * replaced with the provided field. Otherwise, the field is added to the
766 * structure. The field's value is not deeply copied.
769 gst_structure_set_field (GstStructure * structure, GstStructureField * field)
771 GstStructureField *f;
772 GType field_value_type;
775 len = GST_STRUCTURE_FIELDS (structure)->len;
777 field_value_type = G_VALUE_TYPE (&field->value);
778 if (field_value_type == G_TYPE_STRING) {
781 s = g_value_get_string (&field->value);
782 /* only check for NULL strings in taglists, as they are allowed in message
783 * structs, e.g. error message debug strings */
784 if (G_UNLIKELY (IS_TAGLIST (structure) && (s == NULL || *s == '\0'))) {
786 GIT_G_WARNING ("Trying to set NULL string on field '%s' on taglist. "
787 "Please file a bug.", g_quark_to_string (field->name));
788 g_value_unset (&field->value);
791 /* empty strings never make sense */
792 GIT_G_WARNING ("Trying to set empty string on taglist field '%s'. "
793 "Please file a bug.", g_quark_to_string (field->name));
794 g_value_unset (&field->value);
797 } else if (G_UNLIKELY (s != NULL && !g_utf8_validate (s, -1, NULL))) {
798 g_warning ("Trying to set string on %s field '%s', but string is not "
799 "valid UTF-8. Please file a bug.",
800 IS_TAGLIST (structure) ? "taglist" : "structure",
801 g_quark_to_string (field->name));
802 g_value_unset (&field->value);
805 } else if (G_UNLIKELY (field_value_type == G_TYPE_DATE)) {
808 d = g_value_get_boxed (&field->value);
809 /* only check for NULL GDates in taglists, as they might make sense
810 * in other, generic structs */
811 if (G_UNLIKELY ((IS_TAGLIST (structure) && d == NULL))) {
812 GIT_G_WARNING ("Trying to set NULL GDate on field '%s' on taglist. "
813 "Please file a bug.", g_quark_to_string (field->name));
814 g_value_unset (&field->value);
816 } else if (G_UNLIKELY (d != NULL && !g_date_valid (d))) {
818 ("Trying to set invalid GDate on %s field '%s'. Please file a bug.",
819 IS_TAGLIST (structure) ? "taglist" : "structure",
820 g_quark_to_string (field->name));
821 g_value_unset (&field->value);
826 for (i = 0; i < len; i++) {
827 f = GST_STRUCTURE_FIELD (structure, i);
829 if (G_UNLIKELY (f->name == field->name)) {
830 g_value_unset (&f->value);
831 memcpy (f, field, sizeof (GstStructureField));
836 g_array_append_val (GST_STRUCTURE_FIELDS (structure), *field);
839 /* If there is no field with the given ID, NULL is returned.
841 static GstStructureField *
842 gst_structure_id_get_field (const GstStructure * structure, GQuark field_id)
844 GstStructureField *field;
847 len = GST_STRUCTURE_FIELDS (structure)->len;
849 for (i = 0; i < len; i++) {
850 field = GST_STRUCTURE_FIELD (structure, i);
852 if (G_UNLIKELY (field->name == field_id))
859 /* If there is no field with the given ID, NULL is returned.
861 static GstStructureField *
862 gst_structure_get_field (const GstStructure * structure,
863 const gchar * fieldname)
865 g_return_val_if_fail (structure != NULL, NULL);
866 g_return_val_if_fail (fieldname != NULL, NULL);
868 return gst_structure_id_get_field (structure,
869 g_quark_from_string (fieldname));
873 * gst_structure_get_value:
874 * @structure: a #GstStructure
875 * @fieldname: the name of the field to get
877 * Get the value of the field with name @fieldname.
879 * Returns: the #GValue corresponding to the field with the given name.
882 gst_structure_get_value (const GstStructure * structure,
883 const gchar * fieldname)
885 GstStructureField *field;
887 g_return_val_if_fail (structure != NULL, NULL);
888 g_return_val_if_fail (fieldname != NULL, NULL);
890 field = gst_structure_get_field (structure, fieldname);
894 return &field->value;
898 * gst_structure_id_get_value:
899 * @structure: a #GstStructure
900 * @field: the #GQuark of the field to get
902 * Get the value of the field with GQuark @field.
904 * Returns: the #GValue corresponding to the field with the given name
908 gst_structure_id_get_value (const GstStructure * structure, GQuark field)
910 GstStructureField *gsfield;
912 g_return_val_if_fail (structure != NULL, NULL);
914 gsfield = gst_structure_id_get_field (structure, field);
918 return &gsfield->value;
922 * gst_structure_remove_field:
923 * @structure: a #GstStructure
924 * @fieldname: the name of the field to remove
926 * Removes the field with the given name. If the field with the given
927 * name does not exist, the structure is unchanged.
930 gst_structure_remove_field (GstStructure * structure, const gchar * fieldname)
932 GstStructureField *field;
936 g_return_if_fail (structure != NULL);
937 g_return_if_fail (fieldname != NULL);
938 g_return_if_fail (IS_MUTABLE (structure));
940 id = g_quark_from_string (fieldname);
941 len = GST_STRUCTURE_FIELDS (structure)->len;
943 for (i = 0; i < len; i++) {
944 field = GST_STRUCTURE_FIELD (structure, i);
946 if (field->name == id) {
947 if (G_IS_VALUE (&field->value)) {
948 g_value_unset (&field->value);
950 GST_STRUCTURE_FIELDS (structure) =
951 g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
958 * gst_structure_remove_fields:
959 * @structure: a #GstStructure
960 * @fieldname: the name of the field to remove
961 * @...: %NULL-terminated list of more fieldnames to remove
963 * Removes the fields with the given names. If a field does not exist, the
964 * argument is ignored.
967 gst_structure_remove_fields (GstStructure * structure,
968 const gchar * fieldname, ...)
972 g_return_if_fail (structure != NULL);
973 g_return_if_fail (fieldname != NULL);
974 /* mutability checked in remove_field */
976 va_start (varargs, fieldname);
977 gst_structure_remove_fields_valist (structure, fieldname, varargs);
982 * gst_structure_remove_fields_valist:
983 * @structure: a #GstStructure
984 * @fieldname: the name of the field to remove
985 * @varargs: %NULL-terminated list of more fieldnames to remove
987 * va_list form of gst_structure_remove_fields().
990 gst_structure_remove_fields_valist (GstStructure * structure,
991 const gchar * fieldname, va_list varargs)
993 gchar *field = (gchar *) fieldname;
995 g_return_if_fail (structure != NULL);
996 g_return_if_fail (fieldname != NULL);
997 /* mutability checked in remove_field */
1000 gst_structure_remove_field (structure, field);
1001 field = va_arg (varargs, char *);
1006 * gst_structure_remove_all_fields:
1007 * @structure: a #GstStructure
1009 * Removes all fields in a GstStructure.
1012 gst_structure_remove_all_fields (GstStructure * structure)
1014 GstStructureField *field;
1017 g_return_if_fail (structure != NULL);
1018 g_return_if_fail (IS_MUTABLE (structure));
1020 for (i = GST_STRUCTURE_FIELDS (structure)->len - 1; i >= 0; i--) {
1021 field = GST_STRUCTURE_FIELD (structure, i);
1023 if (G_IS_VALUE (&field->value)) {
1024 g_value_unset (&field->value);
1026 GST_STRUCTURE_FIELDS (structure) =
1027 g_array_remove_index (GST_STRUCTURE_FIELDS (structure), i);
1032 * gst_structure_get_field_type:
1033 * @structure: a #GstStructure
1034 * @fieldname: the name of the field
1036 * Finds the field with the given name, and returns the type of the
1037 * value it contains. If the field is not found, G_TYPE_INVALID is
1040 * Returns: the #GValue of the field
1043 gst_structure_get_field_type (const GstStructure * structure,
1044 const gchar * fieldname)
1046 GstStructureField *field;
1048 g_return_val_if_fail (structure != NULL, G_TYPE_INVALID);
1049 g_return_val_if_fail (fieldname != NULL, G_TYPE_INVALID);
1051 field = gst_structure_get_field (structure, fieldname);
1053 return G_TYPE_INVALID;
1055 return G_VALUE_TYPE (&field->value);
1059 * gst_structure_n_fields:
1060 * @structure: a #GstStructure
1062 * Get the number of fields in the structure.
1064 * Returns: the number of fields in the structure
1067 gst_structure_n_fields (const GstStructure * structure)
1069 g_return_val_if_fail (structure != NULL, 0);
1071 return GST_STRUCTURE_FIELDS (structure)->len;
1075 * gst_structure_nth_field_name:
1076 * @structure: a #GstStructure
1077 * @index: the index to get the name of
1079 * Get the name of the given field number, counting from 0 onwards.
1081 * Returns: the name of the given field number
1084 gst_structure_nth_field_name (const GstStructure * structure, guint index)
1086 GstStructureField *field;
1088 g_return_val_if_fail (structure != NULL, NULL);
1089 g_return_val_if_fail (index < GST_STRUCTURE_FIELDS (structure)->len, NULL);
1091 field = GST_STRUCTURE_FIELD (structure, index);
1093 return g_quark_to_string (field->name);
1097 * gst_structure_foreach:
1098 * @structure: a #GstStructure
1099 * @func: (scope call): a function to call for each field
1100 * @user_data: (closure): private data
1102 * Calls the provided function once for each field in the #GstStructure. The
1103 * function must not modify the fields. Also see gst_structure_map_in_place().
1105 * Returns: %TRUE if the supplied function returns %TRUE For each of the fields,
1109 gst_structure_foreach (const GstStructure * structure,
1110 GstStructureForeachFunc func, gpointer user_data)
1113 GstStructureField *field;
1116 g_return_val_if_fail (structure != NULL, FALSE);
1117 g_return_val_if_fail (func != NULL, FALSE);
1119 len = GST_STRUCTURE_FIELDS (structure)->len;
1121 for (i = 0; i < len; i++) {
1122 field = GST_STRUCTURE_FIELD (structure, i);
1124 ret = func (field->name, &field->value, user_data);
1125 if (G_UNLIKELY (!ret))
1133 * gst_structure_map_in_place:
1134 * @structure: a #GstStructure
1135 * @func: (scope call): a function to call for each field
1136 * @user_data: (closure): private data
1138 * Calls the provided function once for each field in the #GstStructure. In
1139 * contrast to gst_structure_foreach(), the function may modify but not delete the
1140 * fields. The structure must be mutable.
1142 * Returns: %TRUE if the supplied function returns %TRUE For each of the fields,
1146 gst_structure_map_in_place (GstStructure * structure,
1147 GstStructureMapFunc func, gpointer user_data)
1150 GstStructureField *field;
1153 g_return_val_if_fail (structure != NULL, FALSE);
1154 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
1155 g_return_val_if_fail (func != NULL, FALSE);
1156 len = GST_STRUCTURE_FIELDS (structure)->len;
1158 for (i = 0; i < len; i++) {
1159 field = GST_STRUCTURE_FIELD (structure, i);
1161 ret = func (field->name, &field->value, user_data);
1170 * gst_structure_id_has_field:
1171 * @structure: a #GstStructure
1172 * @field: #GQuark of the field name
1174 * Check if @structure contains a field named @field.
1176 * Returns: %TRUE if the structure contains a field with the given name
1179 gst_structure_id_has_field (const GstStructure * structure, GQuark field)
1181 GstStructureField *f;
1183 g_return_val_if_fail (structure != NULL, FALSE);
1184 g_return_val_if_fail (field != 0, FALSE);
1186 f = gst_structure_id_get_field (structure, field);
1192 * gst_structure_has_field:
1193 * @structure: a #GstStructure
1194 * @fieldname: the name of a field
1196 * Check if @structure contains a field named @fieldname.
1198 * Returns: %TRUE if the structure contains a field with the given name
1201 gst_structure_has_field (const GstStructure * structure,
1202 const gchar * fieldname)
1204 g_return_val_if_fail (structure != NULL, FALSE);
1205 g_return_val_if_fail (fieldname != NULL, FALSE);
1207 return gst_structure_id_has_field (structure,
1208 g_quark_from_string (fieldname));
1212 * gst_structure_id_has_field_typed:
1213 * @structure: a #GstStructure
1214 * @field: #GQuark of the field name
1215 * @type: the type of a value
1217 * Check if @structure contains a field named @field and with GType @type.
1219 * Returns: %TRUE if the structure contains a field with the given name and type
1222 gst_structure_id_has_field_typed (const GstStructure * structure,
1223 GQuark field, GType type)
1225 GstStructureField *f;
1227 g_return_val_if_fail (structure != NULL, FALSE);
1228 g_return_val_if_fail (field != 0, FALSE);
1230 f = gst_structure_id_get_field (structure, field);
1234 return (G_VALUE_TYPE (&f->value) == type);
1238 * gst_structure_has_field_typed:
1239 * @structure: a #GstStructure
1240 * @fieldname: the name of a field
1241 * @type: the type of a value
1243 * Check if @structure contains a field named @fieldname and with GType @type.
1245 * Returns: %TRUE if the structure contains a field with the given name and type
1248 gst_structure_has_field_typed (const GstStructure * structure,
1249 const gchar * fieldname, GType type)
1251 g_return_val_if_fail (structure != NULL, FALSE);
1252 g_return_val_if_fail (fieldname != NULL, FALSE);
1254 return gst_structure_id_has_field_typed (structure,
1255 g_quark_from_string (fieldname), type);
1258 /* utility functions */
1261 * gst_structure_get_boolean:
1262 * @structure: a #GstStructure
1263 * @fieldname: the name of a field
1264 * @value: (out): a pointer to a #gboolean to set
1266 * Sets the boolean pointed to by @value corresponding to the value of the
1267 * given field. Caller is responsible for making sure the field exists
1268 * and has the correct type.
1270 * Returns: %TRUE if the value could be set correctly. If there was no field
1271 * with @fieldname or the existing field did not contain a boolean, this
1272 * function returns %FALSE.
1275 gst_structure_get_boolean (const GstStructure * structure,
1276 const gchar * fieldname, gboolean * value)
1278 GstStructureField *field;
1280 g_return_val_if_fail (structure != NULL, FALSE);
1281 g_return_val_if_fail (fieldname != NULL, FALSE);
1283 field = gst_structure_get_field (structure, fieldname);
1285 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_BOOLEAN)
1288 *value = gst_g_value_get_boolean_unchecked (&field->value);
1294 * gst_structure_get_int:
1295 * @structure: a #GstStructure
1296 * @fieldname: the name of a field
1297 * @value: (out): a pointer to an int to set
1299 * Sets the int pointed to by @value corresponding to the value of the
1300 * given field. Caller is responsible for making sure the field exists
1301 * and has the correct type.
1303 * Returns: %TRUE if the value could be set correctly. If there was no field
1304 * with @fieldname or the existing field did not contain an int, this function
1308 gst_structure_get_int (const GstStructure * structure,
1309 const gchar * fieldname, gint * value)
1311 GstStructureField *field;
1313 g_return_val_if_fail (structure != NULL, FALSE);
1314 g_return_val_if_fail (fieldname != NULL, FALSE);
1315 g_return_val_if_fail (value != NULL, FALSE);
1317 field = gst_structure_get_field (structure, fieldname);
1319 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_INT)
1322 *value = gst_g_value_get_int_unchecked (&field->value);
1328 * gst_structure_get_uint:
1329 * @structure: a #GstStructure
1330 * @fieldname: the name of a field
1331 * @value: (out): a pointer to a uint to set
1333 * Sets the uint pointed to by @value corresponding to the value of the
1334 * given field. Caller is responsible for making sure the field exists
1335 * and has the correct type.
1337 * Returns: %TRUE if the value could be set correctly. If there was no field
1338 * with @fieldname or the existing field did not contain a uint, this function
1342 gst_structure_get_uint (const GstStructure * structure,
1343 const gchar * fieldname, guint * value)
1345 GstStructureField *field;
1347 g_return_val_if_fail (structure != NULL, FALSE);
1348 g_return_val_if_fail (fieldname != NULL, FALSE);
1349 g_return_val_if_fail (value != NULL, FALSE);
1351 field = gst_structure_get_field (structure, fieldname);
1353 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_UINT)
1356 *value = gst_g_value_get_uint_unchecked (&field->value);
1362 * gst_structure_get_int64:
1363 * @structure: a #GstStructure
1364 * @fieldname: the name of a field
1365 * @value: (out): a pointer to a #gint64 to set
1367 * Sets the #gint64 pointed to by @value corresponding to the value of the
1368 * given field. Caller is responsible for making sure the field exists
1369 * and has the correct type.
1371 * Returns: %TRUE if the value could be set correctly. If there was no field
1372 * with @fieldname or the existing field did not contain a #gint64, this function
1378 gst_structure_get_int64 (const GstStructure * structure,
1379 const gchar * fieldname, gint64 * value)
1381 GstStructureField *field;
1383 g_return_val_if_fail (structure != NULL, FALSE);
1384 g_return_val_if_fail (fieldname != NULL, FALSE);
1385 g_return_val_if_fail (value != NULL, FALSE);
1387 field = gst_structure_get_field (structure, fieldname);
1389 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_INT64)
1392 *value = gst_g_value_get_int64_unchecked (&field->value);
1398 * gst_structure_get_uint64:
1399 * @structure: a #GstStructure
1400 * @fieldname: the name of a field
1401 * @value: (out): a pointer to a #guint64 to set
1403 * Sets the #guint64 pointed to by @value corresponding to the value of the
1404 * given field. Caller is responsible for making sure the field exists
1405 * and has the correct type.
1407 * Returns: %TRUE if the value could be set correctly. If there was no field
1408 * with @fieldname or the existing field did not contain a #guint64, this function
1414 gst_structure_get_uint64 (const GstStructure * structure,
1415 const gchar * fieldname, guint64 * value)
1417 GstStructureField *field;
1419 g_return_val_if_fail (structure != NULL, FALSE);
1420 g_return_val_if_fail (fieldname != NULL, FALSE);
1421 g_return_val_if_fail (value != NULL, FALSE);
1423 field = gst_structure_get_field (structure, fieldname);
1425 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_UINT64)
1428 *value = gst_g_value_get_uint64_unchecked (&field->value);
1434 * gst_structure_get_date:
1435 * @structure: a #GstStructure
1436 * @fieldname: the name of a field
1437 * @value: (out callee-allocates): a pointer to a #GDate to set
1439 * Sets the date pointed to by @value corresponding to the date of the
1440 * given field. Caller is responsible for making sure the field exists
1441 * and has the correct type.
1443 * On success @value will point to a newly-allocated copy of the date which
1444 * should be freed with g_date_free() when no longer needed (note: this is
1445 * inconsistent with e.g. gst_structure_get_string() which doesn't return a
1446 * copy of the string).
1448 * Returns: %TRUE if the value could be set correctly. If there was no field
1449 * with @fieldname or the existing field did not contain a data, this function
1453 gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
1456 GstStructureField *field;
1458 g_return_val_if_fail (structure != NULL, FALSE);
1459 g_return_val_if_fail (fieldname != NULL, FALSE);
1460 g_return_val_if_fail (value != NULL, FALSE);
1462 field = gst_structure_get_field (structure, fieldname);
1464 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_DATE)
1467 /* FIXME: 2.0 g_value_dup_boxed() -> g_value_get_boxed() */
1468 *value = g_value_dup_boxed (&field->value);
1474 * gst_structure_get_date_time:
1475 * @structure: a #GstStructure
1476 * @fieldname: the name of a field
1477 * @value: (out callee-allocates): a pointer to a #GstDateTime to set
1479 * Sets the datetime pointed to by @value corresponding to the datetime of the
1480 * given field. Caller is responsible for making sure the field exists
1481 * and has the correct type.
1483 * On success @value will point to a reference of the datetime which
1484 * should be unreffed with gst_date_time_unref() when no longer needed
1485 * (note: this is inconsistent with e.g. gst_structure_get_string()
1486 * which doesn't return a copy of the string).
1488 * Returns: %TRUE if the value could be set correctly. If there was no field
1489 * with @fieldname or the existing field did not contain a data, this function
1493 gst_structure_get_date_time (const GstStructure * structure,
1494 const gchar * fieldname, GstDateTime ** value)
1496 GstStructureField *field;
1498 g_return_val_if_fail (structure != NULL, FALSE);
1499 g_return_val_if_fail (fieldname != NULL, FALSE);
1500 g_return_val_if_fail (value != NULL, FALSE);
1502 field = gst_structure_get_field (structure, fieldname);
1506 if (!GST_VALUE_HOLDS_DATE_TIME (&field->value))
1509 /* FIXME 2.0: g_value_dup_boxed() -> g_value_get_boxed() */
1510 *value = g_value_dup_boxed (&field->value);
1516 * gst_structure_get_clock_time:
1517 * @structure: a #GstStructure
1518 * @fieldname: the name of a field
1519 * @value: (out): a pointer to a #GstClockTime to set
1521 * Sets the clock time pointed to by @value corresponding to the clock time
1522 * of the given field. Caller is responsible for making sure the field exists
1523 * and has the correct type.
1525 * Returns: %TRUE if the value could be set correctly. If there was no field
1526 * with @fieldname or the existing field did not contain a #GstClockTime, this
1527 * function returns %FALSE.
1530 gst_structure_get_clock_time (const GstStructure * structure,
1531 const gchar * fieldname, GstClockTime * value)
1533 return gst_structure_get_uint64 (structure, fieldname, value);
1537 * gst_structure_get_double:
1538 * @structure: a #GstStructure
1539 * @fieldname: the name of a field
1540 * @value: (out): a pointer to a gdouble to set
1542 * Sets the double pointed to by @value corresponding to the value of the
1543 * given field. Caller is responsible for making sure the field exists
1544 * and has the correct type.
1546 * Returns: %TRUE if the value could be set correctly. If there was no field
1547 * with @fieldname or the existing field did not contain a double, this
1548 * function returns %FALSE.
1551 gst_structure_get_double (const GstStructure * structure,
1552 const gchar * fieldname, gdouble * value)
1554 GstStructureField *field;
1556 g_return_val_if_fail (structure != NULL, FALSE);
1557 g_return_val_if_fail (fieldname != NULL, FALSE);
1558 g_return_val_if_fail (value != NULL, FALSE);
1560 field = gst_structure_get_field (structure, fieldname);
1562 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_DOUBLE)
1565 *value = gst_g_value_get_double_unchecked (&field->value);
1571 * gst_structure_get_string:
1572 * @structure: a #GstStructure
1573 * @fieldname: the name of a field
1575 * Finds the field corresponding to @fieldname, and returns the string
1576 * contained in the field's value. Caller is responsible for making
1577 * sure the field exists and has the correct type.
1579 * The string should not be modified, and remains valid until the next
1580 * call to a gst_structure_*() function with the given structure.
1582 * Returns: (nullable): a pointer to the string or %NULL when the
1583 * field did not exist or did not contain a string.
1586 gst_structure_get_string (const GstStructure * structure,
1587 const gchar * fieldname)
1589 GstStructureField *field;
1591 g_return_val_if_fail (structure != NULL, NULL);
1592 g_return_val_if_fail (fieldname != NULL, NULL);
1594 field = gst_structure_get_field (structure, fieldname);
1596 if (field == NULL || G_VALUE_TYPE (&field->value) != G_TYPE_STRING)
1599 return gst_g_value_get_string_unchecked (&field->value);
1603 * gst_structure_get_enum:
1604 * @structure: a #GstStructure
1605 * @fieldname: the name of a field
1606 * @enumtype: the enum type of a field
1607 * @value: (out): a pointer to an int to set
1609 * Sets the int pointed to by @value corresponding to the value of the
1610 * given field. Caller is responsible for making sure the field exists,
1611 * has the correct type and that the enumtype is correct.
1613 * Returns: %TRUE if the value could be set correctly. If there was no field
1614 * with @fieldname or the existing field did not contain an enum of the given
1615 * type, this function returns %FALSE.
1618 gst_structure_get_enum (const GstStructure * structure,
1619 const gchar * fieldname, GType enumtype, gint * value)
1621 GstStructureField *field;
1623 g_return_val_if_fail (structure != NULL, FALSE);
1624 g_return_val_if_fail (fieldname != NULL, FALSE);
1625 g_return_val_if_fail (enumtype != G_TYPE_INVALID, FALSE);
1626 g_return_val_if_fail (value != NULL, FALSE);
1628 field = gst_structure_get_field (structure, fieldname);
1632 if (!G_TYPE_CHECK_VALUE_TYPE (&field->value, enumtype))
1635 *value = g_value_get_enum (&field->value);
1641 * gst_structure_get_fraction:
1642 * @structure: a #GstStructure
1643 * @fieldname: the name of a field
1644 * @value_numerator: (out): a pointer to an int to set
1645 * @value_denominator: (out): a pointer to an int to set
1647 * Sets the integers pointed to by @value_numerator and @value_denominator
1648 * corresponding to the value of the given field. Caller is responsible
1649 * for making sure the field exists and has the correct type.
1651 * Returns: %TRUE if the values could be set correctly. If there was no field
1652 * with @fieldname or the existing field did not contain a GstFraction, this
1653 * function returns %FALSE.
1656 gst_structure_get_fraction (const GstStructure * structure,
1657 const gchar * fieldname, gint * value_numerator, gint * value_denominator)
1659 GstStructureField *field;
1661 g_return_val_if_fail (structure != NULL, FALSE);
1662 g_return_val_if_fail (fieldname != NULL, FALSE);
1663 g_return_val_if_fail (value_numerator != NULL, FALSE);
1664 g_return_val_if_fail (value_denominator != NULL, FALSE);
1666 field = gst_structure_get_field (structure, fieldname);
1668 if (field == NULL || G_VALUE_TYPE (&field->value) != GST_TYPE_FRACTION)
1671 *value_numerator = gst_value_get_fraction_numerator (&field->value);
1672 *value_denominator = gst_value_get_fraction_denominator (&field->value);
1677 typedef struct _GstStructureAbbreviation
1679 const gchar *type_name;
1682 GstStructureAbbreviation;
1684 /* return a copy of an array of GstStructureAbbreviation containing all the
1685 * known type_string, GType maps, including abbreviations for common types */
1686 static GstStructureAbbreviation *
1687 gst_structure_get_abbrs (gint * n_abbrs)
1689 static GstStructureAbbreviation *abbrs = NULL;
1690 static volatile gsize num = 0;
1692 if (g_once_init_enter (&num)) {
1693 /* dynamically generate the array */
1695 GstStructureAbbreviation dyn_abbrs[] = {
1700 {"uint", G_TYPE_UINT}
1704 {"float", G_TYPE_FLOAT}
1708 {"double", G_TYPE_DOUBLE}
1710 {"d", G_TYPE_DOUBLE}
1712 {"buffer", GST_TYPE_BUFFER}
1714 {"fraction", GST_TYPE_FRACTION}
1716 {"boolean", G_TYPE_BOOLEAN}
1718 {"bool", G_TYPE_BOOLEAN}
1720 {"b", G_TYPE_BOOLEAN}
1722 {"string", G_TYPE_STRING}
1724 {"str", G_TYPE_STRING}
1726 {"s", G_TYPE_STRING}
1728 {"structure", GST_TYPE_STRUCTURE}
1730 {"date", G_TYPE_DATE}
1732 {"datetime", GST_TYPE_DATE_TIME}
1734 {"bitmask", GST_TYPE_BITMASK}
1736 {"sample", GST_TYPE_SAMPLE}
1738 {"taglist", GST_TYPE_TAG_LIST}
1740 _num = G_N_ELEMENTS (dyn_abbrs);
1741 /* permanently allocate and copy the array now */
1742 abbrs = g_new0 (GstStructureAbbreviation, _num);
1743 memcpy (abbrs, dyn_abbrs, sizeof (GstStructureAbbreviation) * _num);
1744 g_once_init_leave (&num, _num);
1751 /* given a type_name that could be a type abbreviation or a registered GType,
1752 * return a matching GType */
1754 gst_structure_gtype_from_abbr (const char *type_name)
1757 GstStructureAbbreviation *abbrs;
1760 g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
1762 abbrs = gst_structure_get_abbrs (&n_abbrs);
1764 for (i = 0; i < n_abbrs; i++) {
1765 if (strcmp (type_name, abbrs[i].type_name) == 0) {
1766 return abbrs[i].type;
1770 /* this is the fallback */
1771 return g_type_from_name (type_name);
1775 gst_structure_to_abbr (GType type)
1778 GstStructureAbbreviation *abbrs;
1781 g_return_val_if_fail (type != G_TYPE_INVALID, NULL);
1783 abbrs = gst_structure_get_abbrs (&n_abbrs);
1785 for (i = 0; i < n_abbrs; i++) {
1786 if (type == abbrs[i].type) {
1787 return abbrs[i].type_name;
1791 return g_type_name (type);
1795 gst_structure_value_get_generic_type (GValue * val)
1797 if (G_VALUE_TYPE (val) == GST_TYPE_LIST
1798 || G_VALUE_TYPE (val) == GST_TYPE_ARRAY) {
1799 GArray *array = g_value_peek_pointer (val);
1801 if (array->len > 0) {
1802 GValue *value = &g_array_index (array, GValue, 0);
1804 return gst_structure_value_get_generic_type (value);
1808 } else if (G_VALUE_TYPE (val) == GST_TYPE_INT_RANGE) {
1810 } else if (G_VALUE_TYPE (val) == GST_TYPE_INT64_RANGE) {
1811 return G_TYPE_INT64;
1812 } else if (G_VALUE_TYPE (val) == GST_TYPE_DOUBLE_RANGE) {
1813 return G_TYPE_DOUBLE;
1814 } else if (G_VALUE_TYPE (val) == GST_TYPE_FRACTION_RANGE) {
1815 return GST_TYPE_FRACTION;
1817 return G_VALUE_TYPE (val);
1821 priv_gst_structure_append_to_gstring (const GstStructure * structure,
1824 GstStructureField *field;
1827 g_return_val_if_fail (s != NULL, FALSE);
1829 len = GST_STRUCTURE_FIELDS (structure)->len;
1830 for (i = 0; i < len; i++) {
1834 field = GST_STRUCTURE_FIELD (structure, i);
1836 t = gst_value_serialize (&field->value);
1837 type = gst_structure_value_get_generic_type (&field->value);
1839 g_string_append_len (s, ", ", 2);
1840 /* FIXME: do we need to escape fieldnames? */
1841 g_string_append (s, g_quark_to_string (field->name));
1842 g_string_append_len (s, "=(", 2);
1843 g_string_append (s, gst_structure_to_abbr (type));
1844 g_string_append_c (s, ')');
1845 g_string_append (s, t == NULL ? "NULL" : t);
1849 g_string_append_c (s, ';');
1854 * gst_structure_to_string:
1855 * @structure: a #GstStructure
1857 * Converts @structure to a human-readable string representation.
1859 * For debugging purposes its easier to do something like this:
1861 * GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
1863 * This prints the structure in human readable form.
1865 * The current implementation of serialization will lead to unexpected results
1866 * when there are nested #GstCaps / #GstStructure deeper than one level.
1868 * Free-function: g_free
1870 * Returns: (transfer full): a pointer to string allocated by g_malloc().
1871 * g_free() after usage.
1874 gst_structure_to_string (const GstStructure * structure)
1878 /* NOTE: This function is potentially called by the debug system,
1879 * so any calls to gst_log() (and GST_DEBUG(), GST_LOG(), etc.)
1880 * should be careful to avoid recursion. This includes any functions
1881 * called by gst_structure_to_string. In particular, calls should
1882 * not use the GST_PTR_FORMAT extension. */
1884 g_return_val_if_fail (structure != NULL, NULL);
1886 /* we estimate a minimum size based on the number of fields in order to
1887 * avoid unnecessary reallocs within GString */
1888 s = g_string_sized_new (STRUCTURE_ESTIMATED_STRING_LEN (structure));
1889 g_string_append (s, g_quark_to_string (structure->name));
1890 priv_gst_structure_append_to_gstring (structure, s);
1891 return g_string_free (s, FALSE);
1895 * r will still point to the string. if end == next, the string will not be
1896 * null-terminated. In all other cases it will be.
1897 * end = pointer to char behind end of string, next = pointer to start of
1899 * THIS FUNCTION MODIFIES THE STRING AND DETECTS INSIDE A NONTERMINATED STRING
1902 gst_structure_parse_string (gchar * s, gchar ** end, gchar ** next,
1913 ret = gst_structure_parse_simple_string (s, end);
1923 if (G_UNLIKELY (*s == 0))
1925 if (G_UNLIKELY (*s == '\\'))
1933 /* Find the closing quotes */
1936 if (G_UNLIKELY (*s == 0))
1938 if (G_UNLIKELY (*s == '\\'))
1953 gst_structure_parse_range (gchar * s, gchar ** after, GValue * value,
1956 GValue value1 = { 0 };
1957 GValue value2 = { 0 };
1958 GValue value3 = { 0 };
1960 gboolean ret, have_step = FALSE;
1966 ret = gst_structure_parse_value (s, &s, &value1, type);
1970 while (g_ascii_isspace (*s))
1977 while (g_ascii_isspace (*s))
1980 ret = gst_structure_parse_value (s, &s, &value2, type);
1984 while (g_ascii_isspace (*s))
1987 /* optional step for int and int64 */
1988 if (G_VALUE_TYPE (&value1) == G_TYPE_INT
1989 || G_VALUE_TYPE (&value1) == G_TYPE_INT64) {
1993 while (g_ascii_isspace (*s))
1996 ret = gst_structure_parse_value (s, &s, &value3, type);
2000 while (g_ascii_isspace (*s))
2011 if (G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value2))
2013 if (have_step && G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value3))
2016 if (G_VALUE_TYPE (&value1) == G_TYPE_DOUBLE) {
2017 range_type = GST_TYPE_DOUBLE_RANGE;
2018 g_value_init (value, range_type);
2019 gst_value_set_double_range (value,
2020 gst_g_value_get_double_unchecked (&value1),
2021 gst_g_value_get_double_unchecked (&value2));
2022 } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT) {
2023 range_type = GST_TYPE_INT_RANGE;
2024 g_value_init (value, range_type);
2026 gst_value_set_int_range_step (value,
2027 gst_g_value_get_int_unchecked (&value1),
2028 gst_g_value_get_int_unchecked (&value2),
2029 gst_g_value_get_int_unchecked (&value3));
2031 gst_value_set_int_range (value, gst_g_value_get_int_unchecked (&value1),
2032 gst_g_value_get_int_unchecked (&value2));
2033 } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT64) {
2034 range_type = GST_TYPE_INT64_RANGE;
2035 g_value_init (value, range_type);
2037 gst_value_set_int64_range_step (value,
2038 gst_g_value_get_int64_unchecked (&value1),
2039 gst_g_value_get_int64_unchecked (&value2),
2040 gst_g_value_get_int64_unchecked (&value3));
2042 gst_value_set_int64_range (value,
2043 gst_g_value_get_int64_unchecked (&value1),
2044 gst_g_value_get_int64_unchecked (&value2));
2045 } else if (G_VALUE_TYPE (&value1) == GST_TYPE_FRACTION) {
2046 range_type = GST_TYPE_FRACTION_RANGE;
2047 g_value_init (value, range_type);
2048 gst_value_set_fraction_range (value, &value1, &value2);
2058 gst_structure_parse_any_list (gchar * s, gchar ** after, GValue * value,
2059 GType type, GType list_type, char begin, char end)
2061 GValue list_value = { 0 };
2065 g_value_init (value, list_type);
2066 array = g_value_peek_pointer (value);
2072 while (g_ascii_isspace (*s))
2080 ret = gst_structure_parse_value (s, &s, &list_value, type);
2084 g_array_append_val (array, list_value);
2086 while (g_ascii_isspace (*s))
2094 while (g_ascii_isspace (*s))
2097 memset (&list_value, 0, sizeof (list_value));
2098 ret = gst_structure_parse_value (s, &s, &list_value, type);
2102 g_array_append_val (array, list_value);
2103 while (g_ascii_isspace (*s))
2114 gst_structure_parse_list (gchar * s, gchar ** after, GValue * value, GType type)
2116 return gst_structure_parse_any_list (s, after, value, type, GST_TYPE_LIST,
2121 gst_structure_parse_array (gchar * s, gchar ** after, GValue * value,
2124 return gst_structure_parse_any_list (s, after, value, type,
2125 GST_TYPE_ARRAY, '<', '>');
2129 gst_structure_parse_simple_string (gchar * str, gchar ** end)
2133 while (G_LIKELY (GST_ASCII_IS_STRING (*s))) {
2143 gst_structure_parse_field (gchar * str,
2144 gchar ** after, GstStructureField * field)
2153 while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
2156 if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &name_end))) {
2157 GST_WARNING ("failed to parse simple string, str=%s", str);
2162 while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
2165 if (G_UNLIKELY (*s != '=')) {
2166 GST_WARNING ("missing assignment operator in the field, str=%s", str);
2173 field->name = g_quark_from_string (name);
2174 GST_DEBUG ("trying field name '%s'", name);
2177 if (G_UNLIKELY (!gst_structure_parse_value (s, &s, &field->value,
2179 GST_WARNING ("failed to parse value %s", str);
2188 gst_structure_parse_value (gchar * str,
2189 gchar ** after, GValue * value, GType default_type)
2198 GType type = default_type;
2201 while (g_ascii_isspace (*s))
2204 /* check if there's a (type_name) 'cast' */
2208 while (g_ascii_isspace (*s))
2211 if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &type_end)))
2214 while (g_ascii_isspace (*s))
2216 if (G_UNLIKELY (*s != ')'))
2219 while (g_ascii_isspace (*s))
2224 type = gst_structure_gtype_from_abbr (type_name);
2225 GST_DEBUG ("trying type name '%s'", type_name);
2228 if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2229 GST_WARNING ("invalid type");
2234 while (g_ascii_isspace (*s))
2237 ret = gst_structure_parse_range (s, &s, value, type);
2238 } else if (*s == '{') {
2239 ret = gst_structure_parse_list (s, &s, value, type);
2240 } else if (*s == '<') {
2241 ret = gst_structure_parse_array (s, &s, value, type);
2245 if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2247 { G_TYPE_INT, G_TYPE_DOUBLE, GST_TYPE_FRACTION, G_TYPE_BOOLEAN,
2252 if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s, TRUE)))
2254 /* Set NULL terminator for deserialization */
2258 for (i = 0; i < G_N_ELEMENTS (try_types); i++) {
2259 g_value_init (value, try_types[i]);
2260 ret = gst_value_deserialize (value, value_s);
2263 g_value_unset (value);
2266 g_value_init (value, type);
2268 if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s,
2269 (type != G_TYPE_STRING))))
2271 /* Set NULL terminator for deserialization */
2275 ret = gst_value_deserialize (value, value_s);
2276 if (G_UNLIKELY (!ret))
2277 g_value_unset (value);
2288 priv_gst_structure_parse_name (gchar * str, gchar ** start, gchar ** end,
2296 /* skip spaces (FIXME: _isspace treats tabs and newlines as space!) */
2297 while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2298 && g_ascii_isspace (r[1]))))
2303 if (G_UNLIKELY (!gst_structure_parse_string (r, &w, &r, TRUE))) {
2304 GST_WARNING ("Failed to parse structure string '%s'", str);
2315 priv_gst_structure_parse_fields (gchar * str, gchar ** end,
2316 GstStructure * structure)
2319 GstStructureField field;
2324 while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2325 && g_ascii_isspace (r[1]))))
2328 /* end of structure, get the next char and finish */
2333 /* accept \0 as end delimiter */
2336 if (G_UNLIKELY (*r != ',')) {
2337 GST_WARNING ("Failed to find delimiter, r=%s", r);
2341 while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2342 && g_ascii_isspace (r[1]))))
2345 memset (&field, 0, sizeof (field));
2346 if (G_UNLIKELY (!gst_structure_parse_field (r, &r, &field))) {
2347 GST_WARNING ("Failed to parse field, r=%s", r);
2350 gst_structure_set_field (structure, &field);
2359 * gst_structure_new_from_string:
2360 * @string: a string representation of a #GstStructure
2362 * Creates a #GstStructure from a string representation.
2363 * If end is not %NULL, a pointer to the place inside the given string
2364 * where parsing ended will be returned.
2366 * The current implementation of serialization will lead to unexpected results
2367 * when there are nested #GstCaps / #GstStructure deeper than one level.
2369 * Free-function: gst_structure_free
2371 * Returns: (transfer full) (nullable): a new #GstStructure or %NULL
2372 * when the string could not be parsed. Free with
2373 * gst_structure_free() after use.
2378 gst_structure_new_from_string (const gchar * string)
2380 return gst_structure_from_string (string, NULL);
2384 * gst_structure_from_string:
2385 * @string: a string representation of a #GstStructure.
2386 * @end: (out) (allow-none) (transfer none) (skip): pointer to store the end of the string in.
2388 * Creates a #GstStructure from a string representation.
2389 * If end is not %NULL, a pointer to the place inside the given string
2390 * where parsing ended will be returned.
2392 * Free-function: gst_structure_free
2394 * Returns: (transfer full) (nullable): a new #GstStructure or %NULL
2395 * when the string could not be parsed. Free with
2396 * gst_structure_free() after use.
2399 gst_structure_from_string (const gchar * string, gchar ** end)
2406 GstStructure *structure = NULL;
2408 g_return_val_if_fail (string != NULL, NULL);
2410 copy = g_strdup (string);
2413 if (!priv_gst_structure_parse_name (r, &name, &w, &r))
2418 structure = gst_structure_new_empty (name);
2421 if (G_UNLIKELY (structure == NULL))
2424 if (!priv_gst_structure_parse_fields (r, &r, structure))
2428 *end = (char *) string + (r - copy);
2430 g_warning ("gst_structure_from_string did not consume whole string,"
2431 " but caller did not provide end pointer (\"%s\")", string);
2438 gst_structure_free (structure);
2444 gst_structure_transform_to_string (const GValue * src_value,
2445 GValue * dest_value)
2447 g_return_if_fail (src_value != NULL);
2448 g_return_if_fail (dest_value != NULL);
2450 dest_value->data[0].v_pointer =
2451 gst_structure_to_string (src_value->data[0].v_pointer);
2454 static GstStructure *
2455 gst_structure_copy_conditional (const GstStructure * structure)
2458 return gst_structure_copy (structure);
2462 /* fixate utility functions */
2465 * gst_structure_fixate_field_nearest_int:
2466 * @structure: a #GstStructure
2467 * @field_name: a field in @structure
2468 * @target: the target value of the fixation
2470 * Fixates a #GstStructure by changing the given field to the nearest
2471 * integer to @target that is a subset of the existing field.
2473 * Returns: %TRUE if the structure could be fixated
2476 gst_structure_fixate_field_nearest_int (GstStructure * structure,
2477 const char *field_name, int target)
2479 const GValue *value;
2481 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2482 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2484 value = gst_structure_get_value (structure, field_name);
2486 if (G_VALUE_TYPE (value) == G_TYPE_INT) {
2489 } else if (G_VALUE_TYPE (value) == GST_TYPE_INT_RANGE) {
2492 x = gst_value_get_int_range_min (value);
2495 x = gst_value_get_int_range_max (value);
2498 gst_structure_set (structure, field_name, G_TYPE_INT, target, NULL);
2500 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2501 const GValue *list_value;
2504 int best_index = -1;
2506 n = gst_value_list_get_size (value);
2507 for (i = 0; i < n; i++) {
2508 list_value = gst_value_list_get_value (value, i);
2509 if (G_VALUE_TYPE (list_value) == G_TYPE_INT) {
2510 int x = gst_g_value_get_int_unchecked (list_value);
2512 if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2518 if (best_index != -1) {
2519 gst_structure_set (structure, field_name, G_TYPE_INT, best, NULL);
2529 * gst_structure_fixate_field_nearest_double:
2530 * @structure: a #GstStructure
2531 * @field_name: a field in @structure
2532 * @target: the target value of the fixation
2534 * Fixates a #GstStructure by changing the given field to the nearest
2535 * double to @target that is a subset of the existing field.
2537 * Returns: %TRUE if the structure could be fixated
2540 gst_structure_fixate_field_nearest_double (GstStructure * structure,
2541 const char *field_name, double target)
2543 const GValue *value;
2545 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2546 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2548 value = gst_structure_get_value (structure, field_name);
2550 if (G_VALUE_TYPE (value) == G_TYPE_DOUBLE) {
2553 } else if (G_VALUE_TYPE (value) == GST_TYPE_DOUBLE_RANGE) {
2556 x = gst_value_get_double_range_min (value);
2559 x = gst_value_get_double_range_max (value);
2562 gst_structure_set (structure, field_name, G_TYPE_DOUBLE, target, NULL);
2564 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2565 const GValue *list_value;
2568 int best_index = -1;
2570 n = gst_value_list_get_size (value);
2571 for (i = 0; i < n; i++) {
2572 list_value = gst_value_list_get_value (value, i);
2573 if (G_VALUE_TYPE (list_value) == G_TYPE_DOUBLE) {
2574 double x = gst_g_value_get_double_unchecked (list_value);
2576 if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2582 if (best_index != -1) {
2583 gst_structure_set (structure, field_name, G_TYPE_DOUBLE, best, NULL);
2594 * gst_structure_fixate_field_boolean:
2595 * @structure: a #GstStructure
2596 * @field_name: a field in @structure
2597 * @target: the target value of the fixation
2599 * Fixates a #GstStructure by changing the given @field_name field to the given
2600 * @target boolean if that field is not fixed yet.
2602 * Returns: %TRUE if the structure could be fixated
2605 gst_structure_fixate_field_boolean (GstStructure * structure,
2606 const char *field_name, gboolean target)
2608 const GValue *value;
2610 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2611 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2613 value = gst_structure_get_value (structure, field_name);
2615 if (G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
2618 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2619 const GValue *list_value;
2622 int best_index = -1;
2624 n = gst_value_list_get_size (value);
2625 for (i = 0; i < n; i++) {
2626 list_value = gst_value_list_get_value (value, i);
2627 if (G_VALUE_TYPE (list_value) == G_TYPE_BOOLEAN) {
2628 gboolean x = gst_g_value_get_boolean_unchecked (list_value);
2630 if (best_index == -1 || x == target) {
2636 if (best_index != -1) {
2637 gst_structure_set (structure, field_name, G_TYPE_BOOLEAN, best, NULL);
2647 * gst_structure_fixate_field_string:
2648 * @structure: a #GstStructure
2649 * @field_name: a field in @structure
2650 * @target: the target value of the fixation
2652 * Fixates a #GstStructure by changing the given @field_name field to the given
2653 * @target string if that field is not fixed yet.
2655 * Returns: %TRUE if the structure could be fixated
2658 gst_structure_fixate_field_string (GstStructure * structure,
2659 const gchar * field_name, const gchar * target)
2661 const GValue *value;
2663 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2664 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2666 value = gst_structure_get_value (structure, field_name);
2668 if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
2671 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2672 const GValue *list_value;
2674 const gchar *best = NULL;
2675 int best_index = -1;
2677 n = gst_value_list_get_size (value);
2678 for (i = 0; i < n; i++) {
2679 list_value = gst_value_list_get_value (value, i);
2680 if (G_VALUE_TYPE (list_value) == G_TYPE_STRING) {
2681 const gchar *x = g_value_get_string (list_value);
2683 if (best_index == -1 || g_str_equal (x, target)) {
2689 if (best_index != -1) {
2690 gst_structure_set (structure, field_name, G_TYPE_STRING, best, NULL);
2700 * gst_structure_fixate_field_nearest_fraction:
2701 * @structure: a #GstStructure
2702 * @field_name: a field in @structure
2703 * @target_numerator: The numerator of the target value of the fixation
2704 * @target_denominator: The denominator of the target value of the fixation
2706 * Fixates a #GstStructure by changing the given field to the nearest
2707 * fraction to @target_numerator/@target_denominator that is a subset
2708 * of the existing field.
2710 * Returns: %TRUE if the structure could be fixated
2713 gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
2714 const char *field_name, const gint target_numerator,
2715 const gint target_denominator)
2717 const GValue *value;
2719 g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2720 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2721 g_return_val_if_fail (target_denominator != 0, FALSE);
2723 value = gst_structure_get_value (structure, field_name);
2725 if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION) {
2728 } else if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION_RANGE) {
2729 const GValue *x, *new_value;
2730 GValue target = { 0 };
2731 g_value_init (&target, GST_TYPE_FRACTION);
2732 gst_value_set_fraction (&target, target_numerator, target_denominator);
2734 new_value = ⌖
2735 x = gst_value_get_fraction_range_min (value);
2736 if (gst_value_compare (&target, x) == GST_VALUE_LESS_THAN)
2738 x = gst_value_get_fraction_range_max (value);
2739 if (gst_value_compare (&target, x) == GST_VALUE_GREATER_THAN)
2742 gst_structure_set_value (structure, field_name, new_value);
2743 g_value_unset (&target);
2745 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2746 const GValue *list_value;
2748 const GValue *best = NULL;
2751 gdouble best_diff = G_MAXDOUBLE;
2753 target = (gdouble) target_numerator / (gdouble) target_denominator;
2755 GST_DEBUG ("target %g, best %g", target, best_diff);
2759 n = gst_value_list_get_size (value);
2760 for (i = 0; i < n; i++) {
2761 list_value = gst_value_list_get_value (value, i);
2762 if (G_VALUE_TYPE (list_value) == GST_TYPE_FRACTION) {
2764 gdouble list_double;
2766 num = gst_value_get_fraction_numerator (list_value);
2767 denom = gst_value_get_fraction_denominator (list_value);
2769 list_double = ((gdouble) num / (gdouble) denom);
2770 cur_diff = target - list_double;
2772 GST_DEBUG ("curr diff %g, list %g", cur_diff, list_double);
2775 cur_diff = -cur_diff;
2777 if (!best || cur_diff < best_diff) {
2778 GST_DEBUG ("new best %g", list_double);
2780 best_diff = cur_diff;
2785 gst_structure_set_value (structure, field_name, best);
2794 default_fixate (GQuark field_id, const GValue * value, gpointer data)
2796 GstStructure *s = data;
2799 if (gst_value_fixate (&v, value)) {
2800 gst_structure_id_take_value (s, field_id, &v);
2806 * gst_structure_fixate_field:
2807 * @structure: a #GstStructure
2808 * @field_name: a field in @structure
2810 * Fixates a #GstStructure by changing the given field with its fixated value.
2812 * Returns: %TRUE if the structure field could be fixated
2815 gst_structure_fixate_field (GstStructure * structure, const char *field_name)
2817 GstStructureField *field;
2819 g_return_val_if_fail (structure != NULL, FALSE);
2820 g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2822 if (!(field = gst_structure_get_field (structure, field_name)))
2825 return default_fixate (field->name, &field->value, structure);
2828 /* our very own version of G_VALUE_LCOPY that allows NULL return locations
2829 * (useful for message parsing functions where the return location is user
2830 * supplied and the user may pass %NULL if the value isn't of interest) */
2831 #define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname) \
2833 const GValue *_value = (value); \
2834 guint _flags = (flags); \
2835 GType _value_type = G_VALUE_TYPE (_value); \
2836 GTypeValueTable *_vtable = g_type_value_table_peek (_value_type); \
2837 const gchar *_lcopy_format = _vtable->lcopy_format; \
2838 GTypeCValue _cvalues[G_VALUE_COLLECT_FORMAT_MAX_LENGTH] = { { 0, }, }; \
2839 guint _n_values = 0; \
2841 while (*_lcopy_format != '\0') { \
2842 g_assert (*_lcopy_format == G_VALUE_COLLECT_POINTER); \
2843 _cvalues[_n_values++].v_pointer = va_arg ((var_args), gpointer); \
2846 if (_n_values == 2 && !!_cvalues[0].v_pointer != !!_cvalues[1].v_pointer) { \
2847 *(__error) = g_strdup_printf ("either all or none of the return " \
2848 "locations for field '%s' need to be NULL", fieldname); \
2849 } else if (_cvalues[0].v_pointer != NULL) { \
2850 *(__error) = _vtable->lcopy_value (_value, _n_values, _cvalues, _flags); \
2855 * gst_structure_get_valist:
2856 * @structure: a #GstStructure
2857 * @first_fieldname: the name of the first field to read
2858 * @args: variable arguments
2860 * Parses the variable arguments and reads fields from @structure accordingly.
2861 * valist-variant of gst_structure_get(). Look at the documentation of
2862 * gst_structure_get() for more details.
2864 * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields
2867 gst_structure_get_valist (const GstStructure * structure,
2868 const char *first_fieldname, va_list args)
2870 const char *field_name;
2871 GType expected_type = G_TYPE_INVALID;
2873 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2874 g_return_val_if_fail (first_fieldname != NULL, FALSE);
2876 field_name = first_fieldname;
2877 while (field_name) {
2878 const GValue *val = NULL;
2881 expected_type = va_arg (args, GType);
2883 val = gst_structure_get_value (structure, field_name);
2888 if (G_VALUE_TYPE (val) != expected_type)
2891 GST_VALUE_LCOPY (val, args, 0, &err, field_name);
2893 g_warning ("%s: %s", G_STRFUNC, err);
2898 field_name = va_arg (args, const gchar *);
2906 GST_INFO ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2907 field_name, structure);
2912 GST_INFO ("Expected field '%s' in structure to be of type '%s', but "
2913 "field was of type '%s': %" GST_PTR_FORMAT, field_name,
2914 GST_STR_NULL (g_type_name (expected_type)),
2915 G_VALUE_TYPE_NAME (gst_structure_get_value (structure, field_name)),
2922 * gst_structure_id_get_valist:
2923 * @structure: a #GstStructure
2924 * @first_field_id: the quark of the first field to read
2925 * @args: variable arguments
2927 * Parses the variable arguments and reads fields from @structure accordingly.
2928 * valist-variant of gst_structure_id_get(). Look at the documentation of
2929 * gst_structure_id_get() for more details.
2931 * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields
2934 gst_structure_id_get_valist (const GstStructure * structure,
2935 GQuark first_field_id, va_list args)
2938 GType expected_type = G_TYPE_INVALID;
2940 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2941 g_return_val_if_fail (first_field_id != 0, FALSE);
2943 field_id = first_field_id;
2945 const GValue *val = NULL;
2948 expected_type = va_arg (args, GType);
2950 val = gst_structure_id_get_value (structure, field_id);
2955 if (G_VALUE_TYPE (val) != expected_type)
2958 GST_VALUE_LCOPY (val, args, 0, &err, g_quark_to_string (field_id));
2960 g_warning ("%s: %s", G_STRFUNC, err);
2965 field_id = va_arg (args, GQuark);
2973 GST_DEBUG ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2974 GST_STR_NULL (g_quark_to_string (field_id)), structure);
2979 GST_DEBUG ("Expected field '%s' in structure to be of type '%s', but "
2980 "field was of type '%s': %" GST_PTR_FORMAT,
2981 g_quark_to_string (field_id),
2982 GST_STR_NULL (g_type_name (expected_type)),
2983 G_VALUE_TYPE_NAME (gst_structure_id_get_value (structure, field_id)),
2990 * gst_structure_get:
2991 * @structure: a #GstStructure
2992 * @first_fieldname: the name of the first field to read
2993 * @...: variable arguments
2995 * Parses the variable arguments and reads fields from @structure accordingly.
2996 * Variable arguments should be in the form field name, field type
2997 * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2998 * The last variable argument should be %NULL.
3000 * For refcounted (mini)objects you will receive a new reference which
3001 * you must release with a suitable _unref() when no longer needed. For
3002 * strings and boxed types you will receive a copy which you will need to
3003 * release with either g_free() or the suitable function for the boxed type.
3005 * Returns: %FALSE if there was a problem reading any of the fields (e.g.
3006 * because the field requested did not exist, or was of a type other
3007 * than the type specified), otherwise %TRUE.
3010 gst_structure_get (const GstStructure * structure, const char *first_fieldname,
3016 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
3017 g_return_val_if_fail (first_fieldname != NULL, FALSE);
3019 va_start (args, first_fieldname);
3020 ret = gst_structure_get_valist (structure, first_fieldname, args);
3027 * gst_structure_id_get:
3028 * @structure: a #GstStructure
3029 * @first_field_id: the quark of the first field to read
3030 * @...: variable arguments
3032 * Parses the variable arguments and reads fields from @structure accordingly.
3033 * Variable arguments should be in the form field id quark, field type
3034 * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
3035 * The last variable argument should be %NULL (technically it should be a
3036 * 0 quark, but we require %NULL so compilers that support it can check for
3037 * the %NULL terminator and warn if it's not there).
3039 * This function is just like gst_structure_get() only that it is slightly
3040 * more efficient since it saves the string-to-quark lookup in the global
3043 * For refcounted (mini)objects you will receive a new reference which
3044 * you must release with a suitable _unref() when no longer needed. For
3045 * strings and boxed types you will receive a copy which you will need to
3046 * release with either g_free() or the suitable function for the boxed type.
3048 * Returns: %FALSE if there was a problem reading any of the fields (e.g.
3049 * because the field requested did not exist, or was of a type other
3050 * than the type specified), otherwise %TRUE.
3053 gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
3059 g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
3060 g_return_val_if_fail (first_field_id != 0, FALSE);
3062 va_start (args, first_field_id);
3063 ret = gst_structure_id_get_valist (structure, first_field_id, args);
3070 gst_structure_is_equal_foreach (GQuark field_id, const GValue * val2,
3073 const GstStructure *struct1 = (const GstStructure *) data;
3074 const GValue *val1 = gst_structure_id_get_value (struct1, field_id);
3076 if (G_UNLIKELY (val1 == NULL))
3078 if (gst_value_compare (val1, val2) == GST_VALUE_EQUAL) {
3086 * gst_structure_is_equal:
3087 * @structure1: a #GstStructure.
3088 * @structure2: a #GstStructure.
3090 * Tests if the two #GstStructure are equal.
3092 * Returns: %TRUE if the two structures have the same name and field.
3095 gst_structure_is_equal (const GstStructure * structure1,
3096 const GstStructure * structure2)
3098 g_return_val_if_fail (GST_IS_STRUCTURE (structure1), FALSE);
3099 g_return_val_if_fail (GST_IS_STRUCTURE (structure2), FALSE);
3101 if (G_UNLIKELY (structure1 == structure2))
3104 if (structure1->name != structure2->name) {
3107 if (GST_STRUCTURE_FIELDS (structure1)->len !=
3108 GST_STRUCTURE_FIELDS (structure2)->len) {
3112 return gst_structure_foreach (structure1, gst_structure_is_equal_foreach,
3113 (gpointer) structure2);
3120 const GstStructure *intersect;
3125 gst_structure_intersect_field1 (GQuark id, const GValue * val1, gpointer data)
3127 IntersectData *idata = (IntersectData *) data;
3128 const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
3130 if (G_UNLIKELY (val2 == NULL)) {
3131 gst_structure_id_set_value (idata->dest, id, val1);
3133 GValue dest_value = { 0 };
3134 if (gst_value_intersect (&dest_value, val1, val2)) {
3135 gst_structure_id_take_value (idata->dest, id, &dest_value);
3144 gst_structure_intersect_field2 (GQuark id, const GValue * val1, gpointer data)
3146 IntersectData *idata = (IntersectData *) data;
3147 const GValue *val2 = gst_structure_id_get_value (idata->intersect, id);
3149 if (G_UNLIKELY (val2 == NULL)) {
3150 gst_structure_id_set_value (idata->dest, id, val1);
3156 * gst_structure_intersect:
3157 * @struct1: a #GstStructure
3158 * @struct2: a #GstStructure
3160 * Intersects @struct1 and @struct2 and returns the intersection.
3162 * Returns: Intersection of @struct1 and @struct2
3165 gst_structure_intersect (const GstStructure * struct1,
3166 const GstStructure * struct2)
3170 g_assert (struct1 != NULL);
3171 g_assert (struct2 != NULL);
3173 if (G_UNLIKELY (struct1->name != struct2->name))
3176 /* copy fields from struct1 which we have not in struct2 to target
3177 * intersect if we have the field in both */
3178 data.dest = gst_structure_new_id_empty (struct1->name);
3179 data.intersect = struct2;
3180 if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct1,
3181 gst_structure_intersect_field1, &data)))
3184 /* copy fields from struct2 which we have not in struct1 to target */
3185 data.intersect = struct1;
3186 if (G_UNLIKELY (!gst_structure_foreach ((GstStructure *) struct2,
3187 gst_structure_intersect_field2, &data)))
3193 gst_structure_free (data.dest);
3198 gst_caps_structure_can_intersect_field (GQuark id, const GValue * val1,
3201 GstStructure *other = (GstStructure *) data;
3202 const GValue *val2 = gst_structure_id_get_value (other, id);
3204 if (G_LIKELY (val2)) {
3205 if (!gst_value_can_intersect (val1, val2)) {
3208 gint eq = gst_value_compare (val1, val2);
3210 if (eq == GST_VALUE_UNORDERED) {
3211 /* we need to try interseting */
3212 if (!gst_value_intersect (NULL, val1, val2)) {
3215 } else if (eq != GST_VALUE_EQUAL) {
3224 * gst_structure_can_intersect:
3225 * @struct1: a #GstStructure
3226 * @struct2: a #GstStructure
3228 * Tries intersecting @struct1 and @struct2 and reports whether the result
3229 * would not be empty.
3231 * Returns: %TRUE if intersection would not be empty
3234 gst_structure_can_intersect (const GstStructure * struct1,
3235 const GstStructure * struct2)
3237 g_return_val_if_fail (GST_IS_STRUCTURE (struct1), FALSE);
3238 g_return_val_if_fail (GST_IS_STRUCTURE (struct2), FALSE);
3240 if (G_UNLIKELY (struct1->name != struct2->name))
3243 /* tries to intersect if we have the field in both */
3244 return gst_structure_foreach ((GstStructure *) struct1,
3245 gst_caps_structure_can_intersect_field, (gpointer) struct2);
3249 gst_caps_structure_is_superset_field (GQuark field_id, const GValue * value,
3252 GstStructure *subset = user_data;
3253 const GValue *other;
3256 if (!(other = gst_structure_id_get_value (subset, field_id)))
3257 /* field is missing in the subset => no subset */
3260 comparison = gst_value_compare (value, other);
3262 /* equal values are subset */
3263 if (comparison == GST_VALUE_EQUAL)
3266 /* ordered, but unequal, values are not */
3267 if (comparison != GST_VALUE_UNORDERED)
3270 return gst_value_is_subset (other, value);
3274 * gst_structure_is_subset:
3275 * @subset: a #GstStructure
3276 * @superset: a potentially greater #GstStructure
3278 * Checks if @subset is a subset of @superset, i.e. has the same
3279 * structure name and for all fields that are existing in @superset,
3280 * @subset has a value that is a subset of the value in @superset.
3282 * Returns: %TRUE if @subset is a subset of @superset
3285 gst_structure_is_subset (const GstStructure * subset,
3286 const GstStructure * superset)
3288 if ((superset->name != subset->name) ||
3289 (gst_structure_n_fields (superset) > gst_structure_n_fields (subset)))
3292 return gst_structure_foreach ((GstStructure *) superset,
3293 gst_caps_structure_is_superset_field, (gpointer) subset);
3298 * gst_structure_fixate:
3299 * @structure: a #GstStructure
3301 * Fixate all values in @structure using gst_value_fixate().
3302 * @structure will be modified in-place and should be writable.
3305 gst_structure_fixate (GstStructure * structure)
3307 g_return_if_fail (GST_IS_STRUCTURE (structure));
3309 gst_structure_foreach (structure, default_fixate, structure);