gst/gststructure.c

   1 /* GStreamer
   2  * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
   3  *
   4  * gststructure.c: lists of { GQuark, GValue } tuples
   5  *
   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.
  10  *
  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.
  15  *
  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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:gststructure
  24  * @short_description: Generic structure containing fields of names and values
  25  * @see_also: #GstCaps, #GstMessage, #GstEvent, #GstQuery
  26  *
  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.
  29  *
  30  * In addition to the key/value pairs, a #GstStructure also has a name. The name
  31  * starts with a letter and can be folled by letters, numbers and any of "/-_.:".
  32  *
  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. It
  36  * provides a means to enforce mutability using the refcount of the parent
  37  * with the gst_structure_set_parent_refcount() method.
  38  *
  39  * A #GstStructure can be created with gst_structure_empty_new() or
  40  * gst_structure_new(), which both take a name and an optional set of
  41  * key/value pairs along with the types of the values.
  42  *
  43  * Field values can be changed with gst_structure_set_value() or
  44  * gst_structure_set().
  45  *
  46  * Field values can be retrieved with gst_structure_get_value() or the more
  47  * convenient gst_structure_get_*() functions.
  48  *
  49  * Fields can be removed with gst_structure_remove_field() or
  50  * gst_structure_remove_fields().
  51  *
  52  * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
  53  * not allowed. Strings must not be empty either, but may be NULL.
  54  *
  55  * Last reviewed on 2009-06-08 (0.10.23)
  56  */
  57
  58 #ifdef HAVE_CONFIG_H
  59 #include "config.h"
  60 #endif
  61
  62 #include <string.h>
  63
  64 #include "gst_private.h"
  65 #include "gstquark.h"
  66 #include <gst/gst.h>
  67 #include <gobject/gvaluecollector.h>
  68
  69 typedef struct _GstStructureField GstStructureField;
  70
  71 struct _GstStructureField
  72 {
  73   GQuark name;
  74   GValue value;
  75 };
  76
  77 #define GST_STRUCTURE_FIELD(structure, index) \
  78     &g_array_index((structure)->fields, GstStructureField, (index))
  79
  80 #define IS_MUTABLE(structure) \
  81     (!(structure)->parent_refcount || \
  82      g_atomic_int_get ((structure)->parent_refcount) == 1)
  83
  84 #define IS_TAGLIST(structure) \
  85     (structure->name == GST_QUARK (TAGLIST))
  86
  87 static void gst_structure_set_field (GstStructure * structure,
  88     GstStructureField * field);
  89 static GstStructureField *gst_structure_get_field (const GstStructure *
  90     structure, const gchar * fieldname);
  91 static GstStructureField *gst_structure_id_get_field (const GstStructure *
  92     structure, GQuark field);
  93 static void gst_structure_transform_to_string (const GValue * src_value,
  94     GValue * dest_value);
  95 static GstStructure *gst_structure_copy_conditional (const GstStructure *
  96     structure);
  97 static gboolean gst_structure_parse_value (gchar * str, gchar ** after,
  98     GValue * value, GType default_type);
  99 static gboolean gst_structure_parse_simple_string (gchar * s, gchar ** end);
 100
 101 GType
 102 gst_structure_get_type (void)
 103 {
 104   static GType gst_structure_type = 0;
 105
 106   if (G_UNLIKELY (gst_structure_type == 0)) {
 107     gst_structure_type = g_boxed_type_register_static ("GstStructure",
 108         (GBoxedCopyFunc) gst_structure_copy_conditional,
 109         (GBoxedFreeFunc) gst_structure_free);
 110
 111     g_value_register_transform_func (gst_structure_type, G_TYPE_STRING,
 112         gst_structure_transform_to_string);
 113   }
 114
 115   return gst_structure_type;
 116 }
 117
 118 static GstStructure *
 119 gst_structure_id_empty_new_with_size (GQuark quark, guint prealloc)
 120 {
 121   GstStructure *structure;
 122
 123   structure = g_slice_new (GstStructure);
 124   structure->type = gst_structure_get_type ();
 125   structure->name = quark;
 126   structure->parent_refcount = NULL;
 127   structure->fields =
 128       g_array_sized_new (FALSE, FALSE, sizeof (GstStructureField), prealloc);
 129
 130   return structure;
 131 }
 132
 133 /**
 134  * gst_structure_id_empty_new:
 135  * @quark: name of new structure
 136  *
 137  * Creates a new, empty #GstStructure with the given name as a GQuark.
 138  *
 139  * Returns: a new, empty #GstStructure
 140  */
 141 GstStructure *
 142 gst_structure_id_empty_new (GQuark quark)
 143 {
 144   g_return_val_if_fail (quark != 0, NULL);
 145
 146   return gst_structure_id_empty_new_with_size (quark, 0);
 147 }
 148
 149 #ifndef G_DISABLE_CHECKS
 150 static gboolean
 151 gst_structure_validate_name (const gchar * name)
 152 {
 153   const gchar *s;
 154
 155   g_return_val_if_fail (name != NULL, FALSE);
 156
 157   /* FIXME 0.11: use g_ascii_isalpha() */
 158   if (G_UNLIKELY (!g_ascii_isalnum (*name))) {
 159     GST_WARNING ("Invalid character '%c' at offset 0 in structure name: %s",
 160         *name, name);
 161     return FALSE;
 162   }
 163
 164   /* FIXME 0.11: don't allow spaces */
 165   /* FIXME: test name string more */
 166   s = &name[1];
 167   while (*s && (g_ascii_isalnum (*s) || strchr ("/-_.:+ ", *s) != NULL))
 168     s++;
 169   if (G_UNLIKELY (*s != '\0')) {
 170     GST_WARNING ("Invalid character '%c' at offset %lu in structure name: %s",
 171         *s, ((gulong) s - (gulong) name), name);
 172     return FALSE;
 173   }
 174
 175   return TRUE;
 176 }
 177 #endif
 178
 179 /**
 180  * gst_structure_empty_new:
 181  * @name: name of new structure
 182  *
 183  * Creates a new, empty #GstStructure with the given @name.
 184  *
 185  * See gst_structure_set_name() for constraints on the @name parameter.
 186  *
 187  * Returns: a new, empty #GstStructure
 188  */
 189 GstStructure *
 190 gst_structure_empty_new (const gchar * name)
 191 {
 192   g_return_val_if_fail (gst_structure_validate_name (name), NULL);
 193
 194   return gst_structure_id_empty_new_with_size (g_quark_from_string (name), 0);
 195 }
 196
 197 /**
 198  * gst_structure_new:
 199  * @name: name of new structure
 200  * @firstfield: name of first field to set
 201  * @...: additional arguments
 202  *
 203  * Creates a new #GstStructure with the given name.  Parses the
 204  * list of variable arguments and sets fields to the values listed.
 205  * Variable arguments should be passed as field name, field type,
 206  * and value.  Last variable argument should be NULL.
 207  *
 208  * Returns: a new #GstStructure
 209  */
 210 GstStructure *
 211 gst_structure_new (const gchar * name, const gchar * firstfield, ...)
 212 {
 213   GstStructure *structure;
 214   va_list varargs;
 215
 216   g_return_val_if_fail (name != NULL, NULL);
 217
 218   va_start (varargs, firstfield);
 219   structure = gst_structure_new_valist (name, firstfield, varargs);
 220   va_end (varargs);
 221
 222   return structure;
 223 }
 224
 225 /**
 226  * gst_structure_new_valist:
 227  * @name: name of new structure
 228  * @firstfield: name of first field to set
 229  * @varargs: variable argument list
 230  *
 231  * Creates a new #GstStructure with the given @name.  Structure fields
 232  * are set according to the varargs in a manner similar to
 233  * gst_structure_new().
 234  *
 235  * See gst_structure_set_name() for constraints on the @name parameter.
 236  *
 237  * Returns: a new #GstStructure
 238  */
 239 GstStructure *
 240 gst_structure_new_valist (const gchar * name,
 241     const gchar * firstfield, va_list varargs)
 242 {
 243   GstStructure *structure;
 244
 245   g_return_val_if_fail (name != NULL, NULL);
 246
 247   structure = gst_structure_empty_new (name);
 248
 249   if (structure)
 250     gst_structure_set_valist (structure, firstfield, varargs);
 251
 252   return structure;
 253 }
 254
 255 /**
 256  * gst_structure_set_parent_refcount:
 257  * @structure: a #GstStructure
 258  * @refcount: a pointer to the parent's refcount
 259  *
 260  * Sets the parent_refcount field of #GstStructure. This field is used to
 261  * determine whether a structure is mutable or not. This function should only be
 262  * called by code implementing parent objects of #GstStructure, as described in
 263  * the MT Refcounting section of the design documents.
 264  */
 265 void
 266 gst_structure_set_parent_refcount (GstStructure * structure, gint * refcount)
 267 {
 268   g_return_if_fail (structure != NULL);
 269
 270   /* if we have a parent_refcount already, we can only clear
 271    * if with a NULL refcount */
 272   if (structure->parent_refcount)
 273     g_return_if_fail (refcount == NULL);
 274   else
 275     g_return_if_fail (refcount != NULL);
 276
 277   structure->parent_refcount = refcount;
 278 }
 279
 280 /**
 281  * gst_structure_copy:
 282  * @structure: a #GstStructure to duplicate
 283  *
 284  * Duplicates a #GstStructure and all its fields and values.
 285  *
 286  * Returns: a new #GstStructure.
 287  */
 288 GstStructure *
 289 gst_structure_copy (const GstStructure * structure)
 290 {
 291   GstStructure *new_structure;
 292   GstStructureField *field;
 293   guint i, len;
 294
 295   g_return_val_if_fail (structure != NULL, NULL);
 296
 297   len = structure->fields->len;
 298   new_structure = gst_structure_id_empty_new_with_size (structure->name, len);
 299
 300   for (i = 0; i < len; i++) {
 301     GstStructureField new_field = { 0 };
 302
 303     field = GST_STRUCTURE_FIELD (structure, i);
 304
 305     new_field.name = field->name;
 306     gst_value_init_and_copy (&new_field.value, &field->value);
 307     g_array_append_val (new_structure->fields, new_field);
 308   }
 309
 310   return new_structure;
 311 }
 312
 313 /**
 314  * gst_structure_free:
 315  * @structure: the #GstStructure to free
 316  *
 317  * Frees a #GstStructure and all its fields and values. The structure must not
 318  * have a parent when this function is called.
 319  */
 320 void
 321 gst_structure_free (GstStructure * structure)
 322 {
 323   GstStructureField *field;
 324   guint i, len;
 325
 326   g_return_if_fail (structure != NULL);
 327   g_return_if_fail (structure->parent_refcount == NULL);
 328
 329   len = structure->fields->len;
 330   for (i = 0; i < len; i++) {
 331     field = GST_STRUCTURE_FIELD (structure, i);
 332
 333     if (G_IS_VALUE (&field->value)) {
 334       g_value_unset (&field->value);
 335     }
 336   }
 337   g_array_free (structure->fields, TRUE);
 338 #ifdef USE_POISONING
 339   memset (structure, 0xff, sizeof (GstStructure));
 340 #endif
 341   g_slice_free (GstStructure, structure);
 342 }
 343
 344 /**
 345  * gst_structure_get_name:
 346  * @structure: a #GstStructure
 347  *
 348  * Get the name of @structure as a string.
 349  *
 350  * Returns: the name of the structure.
 351  */
 352 const gchar *
 353 gst_structure_get_name (const GstStructure * structure)
 354 {
 355   g_return_val_if_fail (structure != NULL, NULL);
 356
 357   return g_quark_to_string (structure->name);
 358 }
 359
 360 /**
 361  * gst_structure_has_name:
 362  * @structure: a #GstStructure
 363  * @name: structure name to check for
 364  *
 365  * Checks if the structure has the given name
 366  *
 367  * Returns: TRUE if @name matches the name of the structure.
 368  */
 369 gboolean
 370 gst_structure_has_name (const GstStructure * structure, const gchar * name)
 371 {
 372   const gchar *structure_name;
 373
 374   g_return_val_if_fail (structure != NULL, FALSE);
 375   g_return_val_if_fail (name != NULL, FALSE);
 376
 377   /* getting the string is cheap and comparing short strings is too
 378    * should be faster than getting the quark for name and comparing the quarks
 379    */
 380   structure_name = g_quark_to_string (structure->name);
 381
 382   return (structure_name && strcmp (structure_name, name) == 0);
 383 }
 384
 385 /**
 386  * gst_structure_get_name_id:
 387  * @structure: a #GstStructure
 388  *
 389  * Get the name of @structure as a GQuark.
 390  *
 391  * Returns: the quark representing the name of the structure.
 392  */
 393 GQuark
 394 gst_structure_get_name_id (const GstStructure * structure)
 395 {
 396   g_return_val_if_fail (structure != NULL, 0);
 397
 398   return structure->name;
 399 }
 400
 401 /**
 402  * gst_structure_set_name:
 403  * @structure: a #GstStructure
 404  * @name: the new name of the structure
 405  *
 406  * Sets the name of the structure to the given @name.  The string
 407  * provided is copied before being used. It must not be empty, start with a
 408  * letter and can be followed by letters, numbers and any of "/-_.:".
 409  */
 410 void
 411 gst_structure_set_name (GstStructure * structure, const gchar * name)
 412 {
 413   g_return_if_fail (structure != NULL);
 414   g_return_if_fail (IS_MUTABLE (structure));
 415   g_return_if_fail (gst_structure_validate_name (name));
 416
 417   structure->name = g_quark_from_string (name);
 418 }
 419
 420 /**
 421  * gst_structure_id_set_value:
 422  * @structure: a #GstStructure
 423  * @field: a #GQuark representing a field
 424  * @value: the new value of the field
 425  *
 426  * Sets the field with the given GQuark @field to @value.  If the field
 427  * does not exist, it is created.  If the field exists, the previous
 428  * value is replaced and freed.
 429  */
 430 void
 431 gst_structure_id_set_value (GstStructure * structure,
 432     GQuark field, const GValue * value)
 433 {
 434   GstStructureField gsfield = { 0, {0,} };
 435
 436   g_return_if_fail (structure != NULL);
 437   g_return_if_fail (G_IS_VALUE (value));
 438   g_return_if_fail (IS_MUTABLE (structure));
 439
 440   gsfield.name = field;
 441   gst_value_init_and_copy (&gsfield.value, value);
 442
 443   gst_structure_set_field (structure, &gsfield);
 444 }
 445
 446 /**
 447  * gst_structure_set_value:
 448  * @structure: a #GstStructure
 449  * @fieldname: the name of the field to set
 450  * @value: the new value of the field
 451  *
 452  * Sets the field with the given name @field to @value.  If the field
 453  * does not exist, it is created.  If the field exists, the previous
 454  * value is replaced and freed.
 455  */
 456 void
 457 gst_structure_set_value (GstStructure * structure,
 458     const gchar * fieldname, const GValue * value)
 459 {
 460   g_return_if_fail (structure != NULL);
 461   g_return_if_fail (fieldname != NULL);
 462   g_return_if_fail (G_IS_VALUE (value));
 463   g_return_if_fail (IS_MUTABLE (structure));
 464
 465   gst_structure_id_set_value (structure, g_quark_from_string (fieldname),
 466       value);
 467 }
 468
 469 /**
 470  * gst_structure_set:
 471  * @structure: a #GstStructure
 472  * @fieldname: the name of the field to set
 473  * @...: variable arguments
 474  *
 475  * Parses the variable arguments and sets fields accordingly.
 476  * Variable arguments should be in the form field name, field type
 477  * (as a GType), value(s).  The last variable argument should be NULL.
 478  */
 479 void
 480 gst_structure_set (GstStructure * structure, const gchar * field, ...)
 481 {
 482   va_list varargs;
 483
 484   g_return_if_fail (structure != NULL);
 485
 486   va_start (varargs, field);
 487   gst_structure_set_valist (structure, field, varargs);
 488   va_end (varargs);
 489 }
 490
 491 /**
 492  * gst_structure_set_valist:
 493  * @structure: a #GstStructure
 494  * @fieldname: the name of the field to set
 495  * @varargs: variable arguments
 496  *
 497  * va_list form of gst_structure_set().
 498  */
 499 void
 500 gst_structure_set_valist (GstStructure * structure,
 501     const gchar * fieldname, va_list varargs)
 502 {
 503   gchar *err = NULL;
 504   GType type;
 505
 506   g_return_if_fail (structure != NULL);
 507   g_return_if_fail (IS_MUTABLE (structure));
 508
 509   while (fieldname) {
 510     GstStructureField field = { 0 };
 511
 512     field.name = g_quark_from_string (fieldname);
 513
 514     type = va_arg (varargs, GType);
 515
 516     if (G_UNLIKELY (type == G_TYPE_DATE)) {
 517       g_warning ("Don't use G_TYPE_DATE, use GST_TYPE_DATE instead\n");
 518       type = GST_TYPE_DATE;
 519     }
 520 #if GLIB_CHECK_VERSION(2,23,3)
 521     G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
 522 #else
 523     g_value_init (&field.value, type);
 524     G_VALUE_COLLECT (&field.value, varargs, 0, &err);
 525 #endif
 526     if (G_UNLIKELY (err)) {
 527       g_critical ("%s", err);
 528       return;
 529     }
 530     gst_structure_set_field (structure, &field);
 531
 532     fieldname = va_arg (varargs, gchar *);
 533   }
 534 }
 535
 536 /**
 537  * gst_structure_id_set:
 538  * @structure: a #GstStructure
 539  * @fieldname: the GQuark for the name of the field to set
 540  * @...: variable arguments
 541  *
 542  * Identical to gst_structure_set, except that field names are
 543  * passed using the GQuark for the field name. This allows more efficient
 544  * setting of the structure if the caller already knows the associated
 545  * quark values.
 546  * The last variable argument must be NULL.
 547  *
 548  * Since: 0.10.10
 549  */
 550 void
 551 gst_structure_id_set (GstStructure * structure, GQuark field, ...)
 552 {
 553   va_list varargs;
 554
 555   g_return_if_fail (structure != NULL);
 556
 557   va_start (varargs, field);
 558   gst_structure_id_set_valist (structure, field, varargs);
 559   va_end (varargs);
 560 }
 561
 562 /**
 563  * gst_structure_id_set_valist:
 564  * @structure: a #GstStructure
 565  * @fieldname: the name of the field to set
 566  * @varargs: variable arguments
 567  *
 568  * va_list form of gst_structure_id_set().
 569  *
 570  * Since: 0.10.10
 571  */
 572 void
 573 gst_structure_id_set_valist (GstStructure * structure,
 574     GQuark fieldname, va_list varargs)
 575 {
 576   gchar *err = NULL;
 577   GType type;
 578
 579   g_return_if_fail (structure != NULL);
 580   g_return_if_fail (IS_MUTABLE (structure));
 581
 582   while (fieldname) {
 583     GstStructureField field = { 0 };
 584
 585     field.name = fieldname;
 586
 587     type = va_arg (varargs, GType);
 588
 589     if (G_UNLIKELY (type == G_TYPE_DATE)) {
 590       g_warning ("Don't use G_TYPE_DATE, use GST_TYPE_DATE instead\n");
 591       type = GST_TYPE_DATE;
 592     }
 593 #ifndef G_VALUE_COLLECT_INIT
 594     g_value_init (&field.value, type);
 595     G_VALUE_COLLECT (&field.value, varargs, 0, &err);
 596 #else
 597     G_VALUE_COLLECT_INIT (&field.value, type, varargs, 0, &err);
 598 #endif
 599     if (G_UNLIKELY (err)) {
 600       g_critical ("%s", err);
 601       return;
 602     }
 603     gst_structure_set_field (structure, &field);
 604
 605     fieldname = va_arg (varargs, GQuark);
 606   }
 607 }
 608
 609 /**
 610  * gst_structure_id_new:
 611  * @name_quark: name of new structure
 612  * @field_quark: the GQuark for the name of the field to set
 613  * @...: variable arguments
 614  *
 615  * Creates a new #GstStructure with the given name as a GQuark, followed by
 616  * fieldname quark, GType, argument(s) "triplets" in the same format as
 617  * gst_structure_id_set(). Basically a convenience wrapper around
 618  * gst_structure_id_empty_new() and gst_structure_id_set().
 619  *
 620  * The last variable argument must be NULL (or 0).
 621  *
 622  * Returns: a new #GstStructure
 623  *
 624  * Since: 0.10.24
 625  */
 626 GstStructure *
 627 gst_structure_id_new (GQuark name_quark, GQuark field_quark, ...)
 628 {
 629   GstStructure *s;
 630   va_list varargs;
 631
 632   g_return_val_if_fail (name_quark != 0, NULL);
 633   g_return_val_if_fail (field_quark != 0, NULL);
 634
 635   s = gst_structure_id_empty_new (name_quark);
 636
 637   va_start (varargs, field_quark);
 638   gst_structure_id_set_valist (s, field_quark, varargs);
 639   va_end (varargs);
 640
 641   return s;
 642 }
 643
 644 #if GST_VERSION_NANO == 1
 645 #define GIT_G_WARNING g_warning
 646 #else
 647 #define GIT_G_WARNING GST_WARNING
 648 #endif
 649
 650 /* If the structure currently contains a field with the same name, it is
 651  * replaced with the provided field. Otherwise, the field is added to the
 652  * structure. The field's value is not deeply copied.
 653  */
 654 static void
 655 gst_structure_set_field (GstStructure * structure, GstStructureField * field)
 656 {
 657   GstStructureField *f;
 658   guint i, len = structure->fields->len;
 659
 660   if (G_UNLIKELY (G_VALUE_HOLDS_STRING (&field->value))) {
 661     const gchar *s;
 662
 663     s = g_value_get_string (&field->value);
 664     /* only check for NULL strings in taglists, as they are allowed in message
 665      * structs, e.g. error message debug strings */
 666     if (G_UNLIKELY (IS_TAGLIST (structure) && (s == NULL || *s == '\0'))) {
 667       if (s == NULL) {
 668         GIT_G_WARNING ("Trying to set NULL string on field '%s' on taglist. "
 669             "Please file a bug.", g_quark_to_string (field->name));
 670         g_value_unset (&field->value);
 671         return;
 672       } else {
 673         /* empty strings never make sense */
 674         GIT_G_WARNING ("Trying to set empty string on taglist field '%s'. "
 675             "Please file a bug.", g_quark_to_string (field->name));
 676         g_value_unset (&field->value);
 677         return;
 678       }
 679     } else if (G_UNLIKELY (s != NULL && !g_utf8_validate (s, -1, NULL))) {
 680       g_warning ("Trying to set string on %s field '%s', but string is not "
 681           "valid UTF-8. Please file a bug.",
 682           IS_TAGLIST (structure) ? "taglist" : "structure",
 683           g_quark_to_string (field->name));
 684       g_value_unset (&field->value);
 685       return;
 686     }
 687   }
 688
 689   for (i = 0; i < len; i++) {
 690     f = GST_STRUCTURE_FIELD (structure, i);
 691
 692     if (G_UNLIKELY (f->name == field->name)) {
 693       g_value_unset (&f->value);
 694       memcpy (f, field, sizeof (GstStructureField));
 695       return;
 696     }
 697   }
 698
 699   g_array_append_val (structure->fields, *field);
 700 }
 701
 702 /* If there is no field with the given ID, NULL is returned.
 703  */
 704 static GstStructureField *
 705 gst_structure_id_get_field (const GstStructure * structure, GQuark field_id)
 706 {
 707   GstStructureField *field;
 708   guint i, len;
 709
 710   len = structure->fields->len;
 711
 712   for (i = 0; i < len; i++) {
 713     field = GST_STRUCTURE_FIELD (structure, i);
 714
 715     if (G_UNLIKELY (field->name == field_id))
 716       return field;
 717   }
 718
 719   return NULL;
 720 }
 721
 722 /* If there is no field with the given ID, NULL is returned.
 723  */
 724 static GstStructureField *
 725 gst_structure_get_field (const GstStructure * structure,
 726     const gchar * fieldname)
 727 {
 728   g_return_val_if_fail (structure != NULL, NULL);
 729   g_return_val_if_fail (fieldname != NULL, NULL);
 730
 731   return gst_structure_id_get_field (structure,
 732       g_quark_from_string (fieldname));
 733 }
 734
 735 /**
 736  * gst_structure_get_value:
 737  * @structure: a #GstStructure
 738  * @fieldname: the name of the field to get
 739  *
 740  * Get the value of the field with name @fieldname.
 741  *
 742  * Returns: the #GValue corresponding to the field with the given name.
 743  */
 744 const GValue *
 745 gst_structure_get_value (const GstStructure * structure,
 746     const gchar * fieldname)
 747 {
 748   GstStructureField *field;
 749
 750   g_return_val_if_fail (structure != NULL, NULL);
 751   g_return_val_if_fail (fieldname != NULL, NULL);
 752
 753   field = gst_structure_get_field (structure, fieldname);
 754   if (field == NULL)
 755     return NULL;
 756
 757   return &field->value;
 758 }
 759
 760 /**
 761  * gst_structure_id_get_value:
 762  * @structure: a #GstStructure
 763  * @field: the #GQuark of the field to get
 764  *
 765  * Get the value of the field with GQuark @field.
 766  *
 767  * Returns: the #GValue corresponding to the field with the given name
 768  *          identifier.
 769  */
 770 const GValue *
 771 gst_structure_id_get_value (const GstStructure * structure, GQuark field)
 772 {
 773   GstStructureField *gsfield;
 774
 775   g_return_val_if_fail (structure != NULL, NULL);
 776
 777   gsfield = gst_structure_id_get_field (structure, field);
 778   if (gsfield == NULL)
 779     return NULL;
 780
 781   return &gsfield->value;
 782 }
 783
 784 /**
 785  * gst_structure_remove_field:
 786  * @structure: a #GstStructure
 787  * @fieldname: the name of the field to remove
 788  *
 789  * Removes the field with the given name.  If the field with the given
 790  * name does not exist, the structure is unchanged.
 791  */
 792 void
 793 gst_structure_remove_field (GstStructure * structure, const gchar * fieldname)
 794 {
 795   GstStructureField *field;
 796   GQuark id;
 797   guint i, len;
 798
 799   g_return_if_fail (structure != NULL);
 800   g_return_if_fail (fieldname != NULL);
 801   g_return_if_fail (IS_MUTABLE (structure));
 802
 803   id = g_quark_from_string (fieldname);
 804   len = structure->fields->len;
 805
 806   for (i = 0; i < len; i++) {
 807     field = GST_STRUCTURE_FIELD (structure, i);
 808
 809     if (field->name == id) {
 810       if (G_IS_VALUE (&field->value)) {
 811         g_value_unset (&field->value);
 812       }
 813       structure->fields = g_array_remove_index (structure->fields, i);
 814       return;
 815     }
 816   }
 817 }
 818
 819 /**
 820  * gst_structure_remove_fields:
 821  * @structure: a #GstStructure
 822  * @fieldname: the name of the field to remove
 823  * @...: NULL-terminated list of more fieldnames to remove
 824  *
 825  * Removes the fields with the given names. If a field does not exist, the
 826  * argument is ignored.
 827  */
 828 void
 829 gst_structure_remove_fields (GstStructure * structure,
 830     const gchar * fieldname, ...)
 831 {
 832   va_list varargs;
 833
 834   g_return_if_fail (structure != NULL);
 835   g_return_if_fail (fieldname != NULL);
 836   /* mutability checked in remove_field */
 837
 838   va_start (varargs, fieldname);
 839   gst_structure_remove_fields_valist (structure, fieldname, varargs);
 840   va_end (varargs);
 841 }
 842
 843 /**
 844  * gst_structure_remove_fields_valist:
 845  * @structure: a #GstStructure
 846  * @fieldname: the name of the field to remove
 847  * @varargs: NULL-terminated list of more fieldnames to remove
 848  *
 849  * va_list form of gst_structure_remove_fields().
 850  */
 851 void
 852 gst_structure_remove_fields_valist (GstStructure * structure,
 853     const gchar * fieldname, va_list varargs)
 854 {
 855   gchar *field = (gchar *) fieldname;
 856
 857   g_return_if_fail (structure != NULL);
 858   g_return_if_fail (fieldname != NULL);
 859   /* mutability checked in remove_field */
 860
 861   while (field) {
 862     gst_structure_remove_field (structure, field);
 863     field = va_arg (varargs, char *);
 864   }
 865 }
 866
 867 /**
 868  * gst_structure_remove_all_fields:
 869  * @structure: a #GstStructure
 870  *
 871  * Removes all fields in a GstStructure.
 872  */
 873 void
 874 gst_structure_remove_all_fields (GstStructure * structure)
 875 {
 876   GstStructureField *field;
 877   int i;
 878
 879   g_return_if_fail (structure != NULL);
 880   g_return_if_fail (IS_MUTABLE (structure));
 881
 882   for (i = structure->fields->len - 1; i >= 0; i--) {
 883     field = GST_STRUCTURE_FIELD (structure, i);
 884
 885     if (G_IS_VALUE (&field->value)) {
 886       g_value_unset (&field->value);
 887     }
 888     structure->fields = g_array_remove_index (structure->fields, i);
 889   }
 890 }
 891
 892 /**
 893  * gst_structure_get_field_type:
 894  * @structure: a #GstStructure
 895  * @fieldname: the name of the field
 896  *
 897  * Finds the field with the given name, and returns the type of the
 898  * value it contains.  If the field is not found, G_TYPE_INVALID is
 899  * returned.
 900  *
 901  * Returns: the #GValue of the field
 902  */
 903 GType
 904 gst_structure_get_field_type (const GstStructure * structure,
 905     const gchar * fieldname)
 906 {
 907   GstStructureField *field;
 908
 909   g_return_val_if_fail (structure != NULL, G_TYPE_INVALID);
 910   g_return_val_if_fail (fieldname != NULL, G_TYPE_INVALID);
 911
 912   field = gst_structure_get_field (structure, fieldname);
 913   if (field == NULL)
 914     return G_TYPE_INVALID;
 915
 916   return G_VALUE_TYPE (&field->value);
 917 }
 918
 919 /**
 920  * gst_structure_n_fields:
 921  * @structure: a #GstStructure
 922  *
 923  * Get the number of fields in the structure.
 924  *
 925  * Returns: the number of fields in the structure
 926  */
 927 gint
 928 gst_structure_n_fields (const GstStructure * structure)
 929 {
 930   g_return_val_if_fail (structure != NULL, 0);
 931
 932   return structure->fields->len;
 933 }
 934
 935 /**
 936  * gst_structure_nth_field_name:
 937  * @structure: a #GstStructure
 938  * @index: the index to get the name of
 939  *
 940  * Get the name of the given field number, counting from 0 onwards.
 941  *
 942  * Returns: the name of the given field number
 943  */
 944 const gchar *
 945 gst_structure_nth_field_name (const GstStructure * structure, guint index)
 946 {
 947   GstStructureField *field;
 948
 949   g_return_val_if_fail (structure != NULL, NULL);
 950   g_return_val_if_fail (index < structure->fields->len, NULL);
 951
 952   field = GST_STRUCTURE_FIELD (structure, index);
 953
 954   return g_quark_to_string (field->name);
 955 }
 956
 957 /**
 958  * gst_structure_foreach:
 959  * @structure: a #GstStructure
 960  * @func: a function to call for each field
 961  * @user_data: private data
 962  *
 963  * Calls the provided function once for each field in the #GstStructure. The
 964  * function must not modify the fields. Also see gst_structure_map_in_place().
 965  *
 966  * Returns: TRUE if the supplied function returns TRUE For each of the fields,
 967  * FALSE otherwise.
 968  */
 969 gboolean
 970 gst_structure_foreach (const GstStructure * structure,
 971     GstStructureForeachFunc func, gpointer user_data)
 972 {
 973   guint i, len;
 974   GstStructureField *field;
 975   gboolean ret;
 976
 977   g_return_val_if_fail (structure != NULL, FALSE);
 978   g_return_val_if_fail (func != NULL, FALSE);
 979
 980   len = structure->fields->len;
 981
 982   for (i = 0; i < len; i++) {
 983     field = GST_STRUCTURE_FIELD (structure, i);
 984
 985     ret = func (field->name, &field->value, user_data);
 986     if (G_UNLIKELY (!ret))
 987       return FALSE;
 988   }
 989
 990   return TRUE;
 991 }
 992
 993 /**
 994  * gst_structure_map_in_place:
 995  * @structure: a #GstStructure
 996  * @func: a function to call for each field
 997  * @user_data: private data
 998  *
 999  * Calls the provided function once for each field in the #GstStructure. In
1000  * contrast to gst_structure_foreach(), the function may modify but not delete the
1001  * fields. The structure must be mutable.
1002  *
1003  * Returns: TRUE if the supplied function returns TRUE For each of the fields,
1004  * FALSE otherwise.
1005  */
1006 gboolean
1007 gst_structure_map_in_place (GstStructure * structure,
1008     GstStructureMapFunc func, gpointer user_data)
1009 {
1010   guint i, len;
1011   GstStructureField *field;
1012   gboolean ret;
1013
1014   g_return_val_if_fail (structure != NULL, FALSE);
1015   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
1016   g_return_val_if_fail (func != NULL, FALSE);
1017   len = structure->fields->len;
1018
1019   for (i = 0; i < len; i++) {
1020     field = GST_STRUCTURE_FIELD (structure, i);
1021
1022     ret = func (field->name, &field->value, user_data);
1023     if (!ret)
1024       return FALSE;
1025   }
1026
1027   return TRUE;
1028 }
1029
1030 /**
1031  * gst_structure_id_has_field:
1032  * @structure: a #GstStructure
1033  * @field: #GQuark of the field name
1034  *
1035  * Check if @structure contains a field named @field.
1036  *
1037  * Returns: TRUE if the structure contains a field with the given name
1038  *
1039  * Since: 0.10.26
1040  */
1041 gboolean
1042 gst_structure_id_has_field (const GstStructure * structure, GQuark field)
1043 {
1044   GstStructureField *f;
1045
1046   g_return_val_if_fail (structure != NULL, FALSE);
1047   g_return_val_if_fail (field != 0, FALSE);
1048
1049   f = gst_structure_id_get_field (structure, field);
1050
1051   return (f != NULL);
1052 }
1053
1054 /**
1055  * gst_structure_has_field:
1056  * @structure: a #GstStructure
1057  * @fieldname: the name of a field
1058  *
1059  * Check if @structure contains a field named @fieldname.
1060  *
1061  * Returns: TRUE if the structure contains a field with the given name
1062  */
1063 gboolean
1064 gst_structure_has_field (const GstStructure * structure,
1065     const gchar * fieldname)
1066 {
1067   g_return_val_if_fail (structure != NULL, FALSE);
1068   g_return_val_if_fail (fieldname != NULL, FALSE);
1069
1070   return gst_structure_id_has_field (structure,
1071       g_quark_from_string (fieldname));
1072 }
1073
1074 /**
1075  * gst_structure_id_has_field_typed:
1076  * @structure: a #GstStructure
1077  * @field: #GQuark of the field name
1078  * @type: the type of a value
1079  *
1080  * Check if @structure contains a field named @field and with GType @type.
1081  *
1082  * Returns: TRUE if the structure contains a field with the given name and type
1083  *
1084  * Since: 0.10.26
1085  */
1086 gboolean
1087 gst_structure_id_has_field_typed (const GstStructure * structure,
1088     GQuark field, GType type)
1089 {
1090   GstStructureField *f;
1091
1092   g_return_val_if_fail (structure != NULL, FALSE);
1093   g_return_val_if_fail (field != 0, FALSE);
1094
1095   f = gst_structure_id_get_field (structure, field);
1096   if (f == NULL)
1097     return FALSE;
1098
1099   return (G_VALUE_TYPE (&f->value) == type);
1100 }
1101
1102 /**
1103  * gst_structure_has_field_typed:
1104  * @structure: a #GstStructure
1105  * @fieldname: the name of a field
1106  * @type: the type of a value
1107  *
1108  * Check if @structure contains a field named @fieldname and with GType @type.
1109  *
1110  * Returns: TRUE if the structure contains a field with the given name and type
1111  */
1112 gboolean
1113 gst_structure_has_field_typed (const GstStructure * structure,
1114     const gchar * fieldname, GType type)
1115 {
1116   g_return_val_if_fail (structure != NULL, FALSE);
1117   g_return_val_if_fail (fieldname != NULL, FALSE);
1118
1119   return gst_structure_id_has_field_typed (structure,
1120       g_quark_from_string (fieldname), type);
1121 }
1122
1123 /* utility functions */
1124
1125 /**
1126  * gst_structure_get_boolean:
1127  * @structure: a #GstStructure
1128  * @fieldname: the name of a field
1129  * @value: a pointer to a #gboolean to set
1130  *
1131  * Sets the boolean pointed to by @value corresponding to the value of the
1132  * given field.  Caller is responsible for making sure the field exists
1133  * and has the correct type.
1134  *
1135  * Returns: TRUE if the value could be set correctly. If there was no field
1136  * with @fieldname or the existing field did not contain a boolean, this
1137  * function returns FALSE.
1138  */
1139 gboolean
1140 gst_structure_get_boolean (const GstStructure * structure,
1141     const gchar * fieldname, gboolean * value)
1142 {
1143   GstStructureField *field;
1144
1145   g_return_val_if_fail (structure != NULL, FALSE);
1146   g_return_val_if_fail (fieldname != NULL, FALSE);
1147
1148   field = gst_structure_get_field (structure, fieldname);
1149
1150   if (field == NULL)
1151     return FALSE;
1152   if (!G_VALUE_HOLDS_BOOLEAN (&field->value))
1153     return FALSE;
1154
1155   *value = gst_g_value_get_boolean_unchecked (&field->value);
1156
1157   return TRUE;
1158 }
1159
1160 /**
1161  * gst_structure_get_int:
1162  * @structure: a #GstStructure
1163  * @fieldname: the name of a field
1164  * @value: a pointer to an int to set
1165  *
1166  * Sets the int pointed to by @value corresponding to the value of the
1167  * given field.  Caller is responsible for making sure the field exists
1168  * and has the correct type.
1169  *
1170  * Returns: %TRUE if the value could be set correctly. If there was no field
1171  * with @fieldname or the existing field did not contain an int, this function
1172  * returns %FALSE.
1173  */
1174 gboolean
1175 gst_structure_get_int (const GstStructure * structure,
1176     const gchar * fieldname, gint * value)
1177 {
1178   GstStructureField *field;
1179
1180   g_return_val_if_fail (structure != NULL, FALSE);
1181   g_return_val_if_fail (fieldname != NULL, FALSE);
1182   g_return_val_if_fail (value != NULL, FALSE);
1183
1184   field = gst_structure_get_field (structure, fieldname);
1185
1186   if (field == NULL)
1187     return FALSE;
1188   if (!G_VALUE_HOLDS_INT (&field->value))
1189     return FALSE;
1190
1191   *value = gst_g_value_get_int_unchecked (&field->value);
1192
1193   return TRUE;
1194 }
1195
1196 /**
1197  * gst_structure_get_uint:
1198  * @structure: a #GstStructure
1199  * @fieldname: the name of a field
1200  * @value: a pointer to a uint to set
1201  *
1202  * Sets the uint pointed to by @value corresponding to the value of the
1203  * given field.  Caller is responsible for making sure the field exists
1204  * and has the correct type.
1205  *
1206  * Returns: %TRUE if the value could be set correctly. If there was no field
1207  * with @fieldname or the existing field did not contain a uint, this function
1208  * returns %FALSE.
1209  *
1210  * Since: 0.10.15
1211  */
1212 gboolean
1213 gst_structure_get_uint (const GstStructure * structure,
1214     const gchar * fieldname, guint * value)
1215 {
1216   GstStructureField *field;
1217
1218   g_return_val_if_fail (structure != NULL, FALSE);
1219   g_return_val_if_fail (fieldname != NULL, FALSE);
1220   g_return_val_if_fail (value != NULL, FALSE);
1221
1222   field = gst_structure_get_field (structure, fieldname);
1223
1224   if (field == NULL)
1225     return FALSE;
1226   if (!G_VALUE_HOLDS_UINT (&field->value))
1227     return FALSE;
1228
1229   *value = gst_g_value_get_uint_unchecked (&field->value);
1230
1231   return TRUE;
1232 }
1233
1234 /**
1235  * gst_structure_get_fourcc:
1236  * @structure: a #GstStructure
1237  * @fieldname: the name of a field
1238  * @value: a pointer to a 32bit unsigned int to set
1239  *
1240  * Sets the Fourcc pointed to by @value corresponding to the value of the
1241  * given field.  Caller is responsible for making sure the field exists
1242  * and has the correct type.
1243  *
1244  * Returns: TRUE if the value could be set correctly. If there was no field
1245  * with @fieldname or the existing field did not contain a fourcc, this function
1246  * returns FALSE.
1247  */
1248 gboolean
1249 gst_structure_get_fourcc (const GstStructure * structure,
1250     const gchar * fieldname, guint32 * value)
1251 {
1252   GstStructureField *field;
1253
1254   g_return_val_if_fail (structure != NULL, FALSE);
1255   g_return_val_if_fail (fieldname != NULL, FALSE);
1256   g_return_val_if_fail (value != NULL, FALSE);
1257
1258   field = gst_structure_get_field (structure, fieldname);
1259
1260   if (field == NULL)
1261     return FALSE;
1262   if (!GST_VALUE_HOLDS_FOURCC (&field->value))
1263     return FALSE;
1264
1265   *value = gst_value_get_fourcc (&field->value);
1266
1267   return TRUE;
1268 }
1269
1270 /**
1271  * gst_structure_get_date:
1272  * @structure: a #GstStructure
1273  * @fieldname: the name of a field
1274  * @value: a pointer to a #GDate to set
1275  *
1276  * Sets the date pointed to by @value corresponding to the date of the
1277  * given field.  Caller is responsible for making sure the field exists
1278  * and has the correct type.
1279  *
1280  * On success @value will point to a newly-allocated copy of the date which
1281  * should be freed with g_date_free() when no longer needed (note: this is
1282  * inconsistent with e.g. gst_structure_get_string() which doesn't return a
1283  * copy of the string).
1284  *
1285  * Returns: TRUE if the value could be set correctly. If there was no field
1286  * with @fieldname or the existing field did not contain a data, this function
1287  * returns FALSE.
1288  */
1289 gboolean
1290 gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
1291     GDate ** value)
1292 {
1293   GstStructureField *field;
1294
1295   g_return_val_if_fail (structure != NULL, FALSE);
1296   g_return_val_if_fail (fieldname != NULL, FALSE);
1297   g_return_val_if_fail (value != NULL, FALSE);
1298
1299   field = gst_structure_get_field (structure, fieldname);
1300
1301   if (field == NULL)
1302     return FALSE;
1303   if (!GST_VALUE_HOLDS_DATE (&field->value))
1304     return FALSE;
1305
1306   /* FIXME: 0.11 g_value_dup_boxed() -> g_value_get_boxed() */
1307   *value = g_value_dup_boxed (&field->value);
1308
1309   return TRUE;
1310 }
1311
1312 /**
1313  * gst_structure_get_clock_time:
1314  * @structure: a #GstStructure
1315  * @fieldname: the name of a field
1316  * @value: a pointer to a #GstClockTime to set
1317  *
1318  * Sets the clock time pointed to by @value corresponding to the clock time
1319  * of the given field.  Caller is responsible for making sure the field exists
1320  * and has the correct type.
1321  *
1322  * Returns: TRUE if the value could be set correctly. If there was no field
1323  * with @fieldname or the existing field did not contain a #GstClockTime, this
1324  * function returns FALSE.
1325  */
1326 gboolean
1327 gst_structure_get_clock_time (const GstStructure * structure,
1328     const gchar * fieldname, GstClockTime * value)
1329 {
1330   GstStructureField *field;
1331
1332   g_return_val_if_fail (structure != NULL, FALSE);
1333   g_return_val_if_fail (fieldname != NULL, FALSE);
1334   g_return_val_if_fail (value != NULL, FALSE);
1335
1336   field = gst_structure_get_field (structure, fieldname);
1337
1338   if (field == NULL)
1339     return FALSE;
1340   if (!G_VALUE_HOLDS_UINT64 (&field->value))
1341     return FALSE;
1342
1343   *value = gst_g_value_get_uint64_unchecked (&field->value);
1344
1345   return TRUE;
1346 }
1347
1348 /**
1349  * gst_structure_get_double:
1350  * @structure: a #GstStructure
1351  * @fieldname: the name of a field
1352  * @value: a pointer to a gdouble to set
1353  *
1354  * Sets the double pointed to by @value corresponding to the value of the
1355  * given field.  Caller is responsible for making sure the field exists
1356  * and has the correct type.
1357  *
1358  * Returns: TRUE if the value could be set correctly. If there was no field
1359  * with @fieldname or the existing field did not contain a double, this
1360  * function returns FALSE.
1361  */
1362 gboolean
1363 gst_structure_get_double (const GstStructure * structure,
1364     const gchar * fieldname, gdouble * value)
1365 {
1366   GstStructureField *field;
1367
1368   g_return_val_if_fail (structure != NULL, FALSE);
1369   g_return_val_if_fail (fieldname != NULL, FALSE);
1370   g_return_val_if_fail (value != NULL, FALSE);
1371
1372   field = gst_structure_get_field (structure, fieldname);
1373
1374   if (field == NULL)
1375     return FALSE;
1376   if (!G_VALUE_HOLDS_DOUBLE (&field->value))
1377     return FALSE;
1378
1379   *value = gst_g_value_get_double_unchecked (&field->value);
1380
1381   return TRUE;
1382 }
1383
1384 /**
1385  * gst_structure_get_string:
1386  * @structure: a #GstStructure
1387  * @fieldname: the name of a field
1388  *
1389  * Finds the field corresponding to @fieldname, and returns the string
1390  * contained in the field's value.  Caller is responsible for making
1391  * sure the field exists and has the correct type.
1392  *
1393  * The string should not be modified, and remains valid until the next
1394  * call to a gst_structure_*() function with the given structure.
1395  *
1396  * Returns: a pointer to the string or NULL when the field did not exist
1397  * or did not contain a string.
1398  */
1399 const gchar *
1400 gst_structure_get_string (const GstStructure * structure,
1401     const gchar * fieldname)
1402 {
1403   GstStructureField *field;
1404
1405   g_return_val_if_fail (structure != NULL, NULL);
1406   g_return_val_if_fail (fieldname != NULL, NULL);
1407
1408   field = gst_structure_get_field (structure, fieldname);
1409
1410   if (field == NULL)
1411     return NULL;
1412   if (!G_VALUE_HOLDS_STRING (&field->value))
1413     return NULL;
1414
1415   return gst_g_value_get_string_unchecked (&field->value);
1416 }
1417
1418 /**
1419  * gst_structure_get_enum:
1420  * @structure: a #GstStructure
1421  * @fieldname: the name of a field
1422  * @enumtype: the enum type of a field
1423  * @value: a pointer to an int to set
1424  *
1425  * Sets the int pointed to by @value corresponding to the value of the
1426  * given field.  Caller is responsible for making sure the field exists,
1427  * has the correct type and that the enumtype is correct.
1428  *
1429  * Returns: TRUE if the value could be set correctly. If there was no field
1430  * with @fieldname or the existing field did not contain an enum of the given
1431  * type, this function returns FALSE.
1432  */
1433 gboolean
1434 gst_structure_get_enum (const GstStructure * structure,
1435     const gchar * fieldname, GType enumtype, gint * value)
1436 {
1437   GstStructureField *field;
1438
1439   g_return_val_if_fail (structure != NULL, FALSE);
1440   g_return_val_if_fail (fieldname != NULL, FALSE);
1441   g_return_val_if_fail (enumtype != G_TYPE_INVALID, FALSE);
1442   g_return_val_if_fail (value != NULL, FALSE);
1443
1444   field = gst_structure_get_field (structure, fieldname);
1445
1446   if (field == NULL)
1447     return FALSE;
1448   if (!G_TYPE_CHECK_VALUE_TYPE (&field->value, enumtype))
1449     return FALSE;
1450
1451   *value = g_value_get_enum (&field->value);
1452
1453   return TRUE;
1454 }
1455
1456 /**
1457  * gst_structure_get_fraction:
1458  * @structure: a #GstStructure
1459  * @fieldname: the name of a field
1460  * @value_numerator: a pointer to an int to set
1461  * @value_denominator: a pointer to an int to set
1462  *
1463  * Sets the integers pointed to by @value_numerator and @value_denominator
1464  * corresponding to the value of the given field.  Caller is responsible
1465  * for making sure the field exists and has the correct type.
1466  *
1467  * Returns: TRUE if the values could be set correctly. If there was no field
1468  * with @fieldname or the existing field did not contain a GstFraction, this
1469  * function returns FALSE.
1470  */
1471 gboolean
1472 gst_structure_get_fraction (const GstStructure * structure,
1473     const gchar * fieldname, gint * value_numerator, gint * value_denominator)
1474 {
1475   GstStructureField *field;
1476
1477   g_return_val_if_fail (structure != NULL, FALSE);
1478   g_return_val_if_fail (fieldname != NULL, FALSE);
1479   g_return_val_if_fail (value_numerator != NULL, FALSE);
1480   g_return_val_if_fail (value_denominator != NULL, FALSE);
1481
1482   field = gst_structure_get_field (structure, fieldname);
1483
1484   if (field == NULL)
1485     return FALSE;
1486   if (!GST_VALUE_HOLDS_FRACTION (&field->value))
1487     return FALSE;
1488
1489   *value_numerator = gst_value_get_fraction_numerator (&field->value);
1490   *value_denominator = gst_value_get_fraction_denominator (&field->value);
1491
1492   return TRUE;
1493 }
1494
1495 typedef struct _GstStructureAbbreviation
1496 {
1497   const gchar *type_name;
1498   GType type;
1499 }
1500 GstStructureAbbreviation;
1501
1502 /* return a copy of an array of GstStructureAbbreviation containing all the
1503  * known type_string, GType maps, including abbreviations for common types */
1504 static GstStructureAbbreviation *
1505 gst_structure_get_abbrs (gint * n_abbrs)
1506 {
1507   static GstStructureAbbreviation *abbrs = NULL;
1508   static volatile gsize num = 0;
1509
1510   if (g_once_init_enter (&num)) {
1511     /* dynamically generate the array */
1512     gsize _num;
1513     GstStructureAbbreviation dyn_abbrs[] = {
1514       {"int", G_TYPE_INT}
1515       ,
1516       {"i", G_TYPE_INT}
1517       ,
1518       {"uint", G_TYPE_UINT}
1519       ,
1520       {"u", G_TYPE_UINT}
1521       ,
1522       {"float", G_TYPE_FLOAT}
1523       ,
1524       {"f", G_TYPE_FLOAT}
1525       ,
1526       {"double", G_TYPE_DOUBLE}
1527       ,
1528       {"d", G_TYPE_DOUBLE}
1529       ,
1530       {"buffer", GST_TYPE_BUFFER}
1531       ,
1532       {"fourcc", GST_TYPE_FOURCC}
1533       ,
1534       {"4", GST_TYPE_FOURCC}
1535       ,
1536       {"fraction", GST_TYPE_FRACTION}
1537       ,
1538       {"boolean", G_TYPE_BOOLEAN}
1539       ,
1540       {"bool", G_TYPE_BOOLEAN}
1541       ,
1542       {"b", G_TYPE_BOOLEAN}
1543       ,
1544       {"string", G_TYPE_STRING}
1545       ,
1546       {"str", G_TYPE_STRING}
1547       ,
1548       {"s", G_TYPE_STRING}
1549       ,
1550       {"structure", GST_TYPE_STRUCTURE}
1551     };
1552     _num = G_N_ELEMENTS (dyn_abbrs);
1553     /* permanently allocate and copy the array now */
1554     abbrs = g_new0 (GstStructureAbbreviation, _num);
1555     memcpy (abbrs, dyn_abbrs, sizeof (GstStructureAbbreviation) * _num);
1556     g_once_init_leave (&num, _num);
1557   }
1558   *n_abbrs = num;
1559
1560   return abbrs;
1561 }
1562
1563 /* given a type_name that could be a type abbreviation or a registered GType,
1564  * return a matching GType */
1565 static GType
1566 gst_structure_gtype_from_abbr (const char *type_name)
1567 {
1568   int i;
1569   GstStructureAbbreviation *abbrs;
1570   gint n_abbrs;
1571
1572   g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
1573
1574   abbrs = gst_structure_get_abbrs (&n_abbrs);
1575
1576   for (i = 0; i < n_abbrs; i++) {
1577     if (strcmp (type_name, abbrs[i].type_name) == 0) {
1578       return abbrs[i].type;
1579     }
1580   }
1581
1582   /* this is the fallback */
1583   return g_type_from_name (type_name);
1584 }
1585
1586 static const char *
1587 gst_structure_to_abbr (GType type)
1588 {
1589   int i;
1590   GstStructureAbbreviation *abbrs;
1591   gint n_abbrs;
1592
1593   g_return_val_if_fail (type != G_TYPE_INVALID, NULL);
1594
1595   abbrs = gst_structure_get_abbrs (&n_abbrs);
1596
1597   for (i = 0; i < n_abbrs; i++) {
1598     if (type == abbrs[i].type) {
1599       return abbrs[i].type_name;
1600     }
1601   }
1602
1603   return g_type_name (type);
1604 }
1605
1606 static GType
1607 gst_structure_value_get_generic_type (GValue * val)
1608 {
1609   if (G_VALUE_TYPE (val) == GST_TYPE_LIST
1610       || G_VALUE_TYPE (val) == GST_TYPE_ARRAY) {
1611     GArray *array = g_value_peek_pointer (val);
1612
1613     if (array->len > 0) {
1614       GValue *value = &g_array_index (array, GValue, 0);
1615
1616       return gst_structure_value_get_generic_type (value);
1617     } else {
1618       return G_TYPE_INT;
1619     }
1620   } else if (G_VALUE_TYPE (val) == GST_TYPE_INT_RANGE) {
1621     return G_TYPE_INT;
1622   } else if (G_VALUE_TYPE (val) == GST_TYPE_DOUBLE_RANGE) {
1623     return G_TYPE_DOUBLE;
1624   } else if (G_VALUE_TYPE (val) == GST_TYPE_FRACTION_RANGE) {
1625     return GST_TYPE_FRACTION;
1626   }
1627   return G_VALUE_TYPE (val);
1628 }
1629
1630 gboolean
1631 priv_gst_structure_append_to_gstring (const GstStructure * structure,
1632     GString * s)
1633 {
1634   GstStructureField *field;
1635   guint i, len;
1636
1637   g_return_val_if_fail (s != NULL, FALSE);
1638
1639   g_string_append (s, g_quark_to_string (structure->name));
1640   len = structure->fields->len;
1641   for (i = 0; i < len; i++) {
1642     char *t;
1643     GType type;
1644
1645     field = GST_STRUCTURE_FIELD (structure, i);
1646
1647     t = gst_value_serialize (&field->value);
1648     type = gst_structure_value_get_generic_type (&field->value);
1649
1650     g_string_append_len (s, ", ", 2);
1651     /* FIXME: do we need to escape fieldnames? */
1652     g_string_append (s, g_quark_to_string (field->name));
1653     g_string_append_len (s, "=(", 2);
1654     g_string_append (s, gst_structure_to_abbr (type));
1655     g_string_append_c (s, ')');
1656     g_string_append (s, t == NULL ? "NULL" : t);
1657     g_free (t);
1658   }
1659
1660   g_string_append_c (s, ';');
1661   return TRUE;
1662 }
1663
1664 /**
1665  * gst_structure_to_string:
1666  * @structure: a #GstStructure
1667  *
1668  * Converts @structure to a human-readable string representation.
1669  *
1670  * For debugging purposes its easier to do something like this:
1671  * |[
1672  * GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
1673  * ]|
1674  * This prints the structure in human readble form.
1675  *
1676  * Returns: a pointer to string allocated by g_malloc(). g_free() after
1677  * usage.
1678  */
1679 gchar *
1680 gst_structure_to_string (const GstStructure * structure)
1681 {
1682   GString *s;
1683
1684   /* NOTE:  This function is potentially called by the debug system,
1685    * so any calls to gst_log() (and GST_DEBUG(), GST_LOG(), etc.)
1686    * should be careful to avoid recursion.  This includes any functions
1687    * called by gst_structure_to_string.  In particular, calls should
1688    * not use the GST_PTR_FORMAT extension.  */
1689
1690   g_return_val_if_fail (structure != NULL, NULL);
1691
1692   /* we estimate a minimum size based on the number of fields in order to
1693    * avoid unnecessary reallocs within GString */
1694   s = g_string_sized_new (STRUCTURE_ESTIMATED_STRING_LEN (structure));
1695   priv_gst_structure_append_to_gstring (structure, s);
1696   return g_string_free (s, FALSE);
1697 }
1698
1699 /*
1700  * r will still point to the string. if end == next, the string will not be
1701  * null-terminated. In all other cases it will be.
1702  * end = pointer to char behind end of string, next = pointer to start of
1703  * unread data.
1704  * THIS FUNCTION MODIFIES THE STRING AND DETECTS INSIDE A NONTERMINATED STRING
1705  */
1706 static gboolean
1707 gst_structure_parse_string (gchar * s, gchar ** end, gchar ** next,
1708     gboolean unescape)
1709 {
1710   gchar *w;
1711
1712   if (*s == 0)
1713     return FALSE;
1714
1715   if (*s != '"') {
1716     int ret;
1717
1718     ret = gst_structure_parse_simple_string (s, end);
1719     *next = *end;
1720
1721     return ret;
1722   }
1723
1724   if (unescape) {
1725     w = s;
1726     s++;
1727     while (*s != '"') {
1728       if (G_UNLIKELY (*s == 0))
1729         return FALSE;
1730       if (G_UNLIKELY (*s == '\\'))
1731         s++;
1732       *w = *s;
1733       w++;
1734       s++;
1735     }
1736     s++;
1737   } else {
1738     /* Find the closing quotes */
1739     s++;
1740     while (*s != '"') {
1741       if (G_UNLIKELY (*s == 0))
1742         return FALSE;
1743       if (G_UNLIKELY (*s == '\\'))
1744         s++;
1745       s++;
1746     }
1747     s++;
1748     w = s;
1749   }
1750
1751   *end = w;
1752   *next = s;
1753
1754   return TRUE;
1755 }
1756
1757 static gboolean
1758 gst_structure_parse_range (gchar * s, gchar ** after, GValue * value,
1759     GType type)
1760 {
1761   GValue value1 = { 0 };
1762   GValue value2 = { 0 };
1763   GType range_type;
1764   gboolean ret;
1765
1766   if (*s != '[')
1767     return FALSE;
1768   s++;
1769
1770   ret = gst_structure_parse_value (s, &s, &value1, type);
1771   if (ret == FALSE)
1772     return FALSE;
1773
1774   while (g_ascii_isspace (*s))
1775     s++;
1776
1777   if (*s != ',')
1778     return FALSE;
1779   s++;
1780
1781   while (g_ascii_isspace (*s))
1782     s++;
1783
1784   ret = gst_structure_parse_value (s, &s, &value2, type);
1785   if (ret == FALSE)
1786     return FALSE;
1787
1788   while (g_ascii_isspace (*s))
1789     s++;
1790
1791   if (*s != ']')
1792     return FALSE;
1793   s++;
1794
1795   if (G_VALUE_TYPE (&value1) != G_VALUE_TYPE (&value2))
1796     return FALSE;
1797
1798   if (G_VALUE_TYPE (&value1) == G_TYPE_DOUBLE) {
1799     range_type = GST_TYPE_DOUBLE_RANGE;
1800     g_value_init (value, range_type);
1801     gst_value_set_double_range (value,
1802         gst_g_value_get_double_unchecked (&value1),
1803         gst_g_value_get_double_unchecked (&value2));
1804   } else if (G_VALUE_TYPE (&value1) == G_TYPE_INT) {
1805     range_type = GST_TYPE_INT_RANGE;
1806     g_value_init (value, range_type);
1807     gst_value_set_int_range (value, gst_g_value_get_int_unchecked (&value1),
1808         gst_g_value_get_int_unchecked (&value2));
1809   } else if (G_VALUE_TYPE (&value1) == GST_TYPE_FRACTION) {
1810     range_type = GST_TYPE_FRACTION_RANGE;
1811     g_value_init (value, range_type);
1812     gst_value_set_fraction_range (value, &value1, &value2);
1813   } else {
1814     return FALSE;
1815   }
1816
1817   *after = s;
1818   return TRUE;
1819 }
1820
1821 static gboolean
1822 gst_structure_parse_any_list (gchar * s, gchar ** after, GValue * value,
1823     GType type, GType list_type, char begin, char end)
1824 {
1825   GValue list_value = { 0 };
1826   gboolean ret;
1827   GArray *array;
1828
1829   g_value_init (value, list_type);
1830   array = g_value_peek_pointer (value);
1831
1832   if (*s != begin)
1833     return FALSE;
1834   s++;
1835
1836   while (g_ascii_isspace (*s))
1837     s++;
1838   if (*s == end) {
1839     s++;
1840     *after = s;
1841     return TRUE;
1842   }
1843
1844   ret = gst_structure_parse_value (s, &s, &list_value, type);
1845   if (ret == FALSE)
1846     return FALSE;
1847
1848   g_array_append_val (array, list_value);
1849
1850   while (g_ascii_isspace (*s))
1851     s++;
1852
1853   while (*s != end) {
1854     if (*s != ',')
1855       return FALSE;
1856     s++;
1857
1858     while (g_ascii_isspace (*s))
1859       s++;
1860
1861     memset (&list_value, 0, sizeof (list_value));
1862     ret = gst_structure_parse_value (s, &s, &list_value, type);
1863     if (ret == FALSE)
1864       return FALSE;
1865
1866     g_array_append_val (array, list_value);
1867     while (g_ascii_isspace (*s))
1868       s++;
1869   }
1870
1871   s++;
1872
1873   *after = s;
1874   return TRUE;
1875 }
1876
1877 static gboolean
1878 gst_structure_parse_list (gchar * s, gchar ** after, GValue * value, GType type)
1879 {
1880   return gst_structure_parse_any_list (s, after, value, type, GST_TYPE_LIST,
1881       '{', '}');
1882 }
1883
1884 static gboolean
1885 gst_structure_parse_array (gchar * s, gchar ** after, GValue * value,
1886     GType type)
1887 {
1888   return gst_structure_parse_any_list (s, after, value, type,
1889       GST_TYPE_ARRAY, '<', '>');
1890 }
1891
1892 static gboolean
1893 gst_structure_parse_simple_string (gchar * str, gchar ** end)
1894 {
1895   char *s = str;
1896
1897   while (G_LIKELY (GST_ASCII_IS_STRING (*s))) {
1898     s++;
1899   }
1900
1901   *end = s;
1902
1903   return (s != str);
1904 }
1905
1906 static gboolean
1907 gst_structure_parse_field (gchar * str,
1908     gchar ** after, GstStructureField * field)
1909 {
1910   gchar *name;
1911   gchar *name_end;
1912   gchar *s;
1913   gchar c;
1914
1915   s = str;
1916
1917   while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
1918     s++;
1919   name = s;
1920   if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &name_end))) {
1921     GST_WARNING ("failed to parse simple string, str=%s", str);
1922     return FALSE;
1923   }
1924
1925   s = name_end;
1926   while (g_ascii_isspace (*s) || (s[0] == '\\' && g_ascii_isspace (s[1])))
1927     s++;
1928
1929   if (G_UNLIKELY (*s != '=')) {
1930     GST_WARNING ("missing assignment operator in the field, str=%s", str);
1931     return FALSE;
1932   }
1933   s++;
1934
1935   c = *name_end;
1936   *name_end = '\0';
1937   field->name = g_quark_from_string (name);
1938   GST_DEBUG ("trying field name '%s'", name);
1939   *name_end = c;
1940
1941   if (G_UNLIKELY (!gst_structure_parse_value (s, &s, &field->value,
1942               G_TYPE_INVALID))) {
1943     GST_WARNING ("failed to parse value %s", str);
1944     return FALSE;
1945   }
1946
1947   *after = s;
1948   return TRUE;
1949 }
1950
1951 static gboolean
1952 gst_structure_parse_value (gchar * str,
1953     gchar ** after, GValue * value, GType default_type)
1954 {
1955   gchar *type_name;
1956   gchar *type_end;
1957   gchar *value_s;
1958   gchar *value_end;
1959   gchar *s;
1960   gchar c;
1961   int ret = 0;
1962   GType type = default_type;
1963
1964   s = str;
1965   while (g_ascii_isspace (*s))
1966     s++;
1967
1968   /* check if there's a (type_name) 'cast' */
1969   type_name = NULL;
1970   if (*s == '(') {
1971     s++;
1972     while (g_ascii_isspace (*s))
1973       s++;
1974     type_name = s;
1975     if (G_UNLIKELY (!gst_structure_parse_simple_string (s, &type_end)))
1976       return FALSE;
1977     s = type_end;
1978     while (g_ascii_isspace (*s))
1979       s++;
1980     if (G_UNLIKELY (*s != ')'))
1981       return FALSE;
1982     s++;
1983     while (g_ascii_isspace (*s))
1984       s++;
1985
1986     c = *type_end;
1987     *type_end = 0;
1988     type = gst_structure_gtype_from_abbr (type_name);
1989     GST_DEBUG ("trying type name '%s'", type_name);
1990     *type_end = c;
1991
1992     if (G_UNLIKELY (type == G_TYPE_INVALID)) {
1993       GST_WARNING ("invalid type");
1994       return FALSE;
1995     }
1996   }
1997
1998   while (g_ascii_isspace (*s))
1999     s++;
2000   if (*s == '[') {
2001     ret = gst_structure_parse_range (s, &s, value, type);
2002   } else if (*s == '{') {
2003     ret = gst_structure_parse_list (s, &s, value, type);
2004   } else if (*s == '<') {
2005     ret = gst_structure_parse_array (s, &s, value, type);
2006   } else {
2007     value_s = s;
2008
2009     if (G_UNLIKELY (type == G_TYPE_INVALID)) {
2010       GType try_types[] =
2011           { G_TYPE_INT, G_TYPE_DOUBLE, GST_TYPE_FRACTION, G_TYPE_BOOLEAN,
2012         G_TYPE_STRING
2013       };
2014       int i;
2015
2016       if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s, TRUE)))
2017         return FALSE;
2018       /* Set NULL terminator for deserialization */
2019       c = *value_end;
2020       *value_end = '\0';
2021
2022       for (i = 0; i < G_N_ELEMENTS (try_types); i++) {
2023         g_value_init (value, try_types[i]);
2024         ret = gst_value_deserialize (value, value_s);
2025         if (ret)
2026           break;
2027         g_value_unset (value);
2028       }
2029     } else {
2030       g_value_init (value, type);
2031
2032       if (G_UNLIKELY (!gst_structure_parse_string (s, &value_end, &s,
2033                   (type != G_TYPE_STRING))))
2034         return FALSE;
2035       /* Set NULL terminator for deserialization */
2036       c = *value_end;
2037       *value_end = '\0';
2038
2039       ret = gst_value_deserialize (value, value_s);
2040       if (G_UNLIKELY (!ret))
2041         g_value_unset (value);
2042     }
2043     *value_end = c;
2044   }
2045
2046   *after = s;
2047
2048   return ret;
2049 }
2050
2051 /**
2052  * gst_structure_from_string:
2053  * @string: a string representation of a #GstStructure.
2054  * @end: pointer to store the end of the string in.
2055  *
2056  * Creates a #GstStructure from a string representation.
2057  * If end is not NULL, a pointer to the place inside the given string
2058  * where parsing ended will be returned.
2059  *
2060  * Returns: a new #GstStructure or NULL when the string could not
2061  * be parsed. Free with gst_structure_free() after use.
2062  */
2063 GstStructure *
2064 gst_structure_from_string (const gchar * string, gchar ** end)
2065 {
2066   char *name;
2067   char *copy;
2068   char *w;
2069   char *r;
2070   char save;
2071   GstStructure *structure = NULL;
2072   GstStructureField field;
2073
2074   g_return_val_if_fail (string != NULL, NULL);
2075
2076   copy = g_strdup (string);
2077   r = copy;
2078
2079   /* skip spaces (FIXME: _isspace treats tabs and newlines as space!) */
2080   while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2081               && g_ascii_isspace (r[1]))))
2082     r++;
2083
2084   name = r;
2085   if (G_UNLIKELY (!gst_structure_parse_string (r, &w, &r, TRUE))) {
2086     GST_WARNING ("Failed to parse structure string '%s'", string);
2087     goto error;
2088   }
2089
2090   save = *w;
2091   *w = '\0';
2092   structure = gst_structure_empty_new (name);
2093   *w = save;
2094
2095   if (G_UNLIKELY (structure == NULL))
2096     goto error;
2097
2098   do {
2099     while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2100                 && g_ascii_isspace (r[1]))))
2101       r++;
2102     if (*r == ';') {
2103       /* end of structure, get the next char and finish */
2104       r++;
2105       break;
2106     }
2107     if (*r == '\0') {
2108       /* accept \0 as end delimiter */
2109       break;
2110     }
2111     if (G_UNLIKELY (*r != ',')) {
2112       GST_WARNING ("Failed to find delimiter, r=%s", r);
2113       goto error;
2114     }
2115     r++;
2116     while (*r && (g_ascii_isspace (*r) || (r[0] == '\\'
2117                 && g_ascii_isspace (r[1]))))
2118       r++;
2119
2120     memset (&field, 0, sizeof (field));
2121     if (G_UNLIKELY (!gst_structure_parse_field (r, &r, &field))) {
2122       GST_WARNING ("Failed to parse field, r=%s", r);
2123       goto error;
2124     }
2125     gst_structure_set_field (structure, &field);
2126   } while (TRUE);
2127
2128   if (end)
2129     *end = (char *) string + (r - copy);
2130   else if (*r)
2131     g_warning ("gst_structure_from_string did not consume whole string,"
2132         " but caller did not provide end pointer (\"%s\")", string);
2133
2134   g_free (copy);
2135   return structure;
2136
2137 error:
2138   if (structure)
2139     gst_structure_free (structure);
2140   g_free (copy);
2141   return NULL;
2142 }
2143
2144 static void
2145 gst_structure_transform_to_string (const GValue * src_value,
2146     GValue * dest_value)
2147 {
2148   g_return_if_fail (src_value != NULL);
2149   g_return_if_fail (dest_value != NULL);
2150
2151   dest_value->data[0].v_pointer =
2152       gst_structure_to_string (src_value->data[0].v_pointer);
2153 }
2154
2155 static GstStructure *
2156 gst_structure_copy_conditional (const GstStructure * structure)
2157 {
2158   if (structure)
2159     return gst_structure_copy (structure);
2160   return NULL;
2161 }
2162
2163 /* fixate utility functions */
2164
2165 /**
2166  * gst_structure_fixate_field_nearest_int:
2167  * @structure: a #GstStructure
2168  * @field_name: a field in @structure
2169  * @target: the target value of the fixation
2170  *
2171  * Fixates a #GstStructure by changing the given field to the nearest
2172  * integer to @target that is a subset of the existing field.
2173  *
2174  * Returns: TRUE if the structure could be fixated
2175  */
2176 gboolean
2177 gst_structure_fixate_field_nearest_int (GstStructure * structure,
2178     const char *field_name, int target)
2179 {
2180   const GValue *value;
2181
2182   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2183   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2184
2185   value = gst_structure_get_value (structure, field_name);
2186
2187   if (G_VALUE_TYPE (value) == G_TYPE_INT) {
2188     /* already fixed */
2189     return FALSE;
2190   } else if (G_VALUE_TYPE (value) == GST_TYPE_INT_RANGE) {
2191     int x;
2192
2193     x = gst_value_get_int_range_min (value);
2194     if (target < x)
2195       target = x;
2196     x = gst_value_get_int_range_max (value);
2197     if (target > x)
2198       target = x;
2199     gst_structure_set (structure, field_name, G_TYPE_INT, target, NULL);
2200     return TRUE;
2201   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2202     const GValue *list_value;
2203     int i, n;
2204     int best = 0;
2205     int best_index = -1;
2206
2207     n = gst_value_list_get_size (value);
2208     for (i = 0; i < n; i++) {
2209       list_value = gst_value_list_get_value (value, i);
2210       if (G_VALUE_TYPE (list_value) == G_TYPE_INT) {
2211         int x = gst_g_value_get_int_unchecked (list_value);
2212
2213         if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2214           best_index = i;
2215           best = x;
2216         }
2217       }
2218     }
2219     if (best_index != -1) {
2220       gst_structure_set (structure, field_name, G_TYPE_INT, best, NULL);
2221       return TRUE;
2222     }
2223     return FALSE;
2224   }
2225
2226   return FALSE;
2227 }
2228
2229 /**
2230  * gst_structure_fixate_field_nearest_double:
2231  * @structure: a #GstStructure
2232  * @field_name: a field in @structure
2233  * @target: the target value of the fixation
2234  *
2235  * Fixates a #GstStructure by changing the given field to the nearest
2236  * double to @target that is a subset of the existing field.
2237  *
2238  * Returns: TRUE if the structure could be fixated
2239  */
2240 gboolean
2241 gst_structure_fixate_field_nearest_double (GstStructure * structure,
2242     const char *field_name, double target)
2243 {
2244   const GValue *value;
2245
2246   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2247   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2248
2249   value = gst_structure_get_value (structure, field_name);
2250
2251   if (G_VALUE_TYPE (value) == G_TYPE_DOUBLE) {
2252     /* already fixed */
2253     return FALSE;
2254   } else if (G_VALUE_TYPE (value) == GST_TYPE_DOUBLE_RANGE) {
2255     double x;
2256
2257     x = gst_value_get_double_range_min (value);
2258     if (target < x)
2259       target = x;
2260     x = gst_value_get_double_range_max (value);
2261     if (target > x)
2262       target = x;
2263     gst_structure_set (structure, field_name, G_TYPE_DOUBLE, target, NULL);
2264     return TRUE;
2265   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2266     const GValue *list_value;
2267     int i, n;
2268     double best = 0;
2269     int best_index = -1;
2270
2271     n = gst_value_list_get_size (value);
2272     for (i = 0; i < n; i++) {
2273       list_value = gst_value_list_get_value (value, i);
2274       if (G_VALUE_TYPE (list_value) == G_TYPE_DOUBLE) {
2275         double x = gst_g_value_get_double_unchecked (list_value);
2276
2277         if (best_index == -1 || (ABS (target - x) < ABS (target - best))) {
2278           best_index = i;
2279           best = x;
2280         }
2281       }
2282     }
2283     if (best_index != -1) {
2284       gst_structure_set (structure, field_name, G_TYPE_DOUBLE, best, NULL);
2285       return TRUE;
2286     }
2287     return FALSE;
2288   }
2289
2290   return FALSE;
2291
2292 }
2293
2294 /**
2295  * gst_structure_fixate_field_boolean:
2296  * @structure: a #GstStructure
2297  * @field_name: a field in @structure
2298  * @target: the target value of the fixation
2299  *
2300  * Fixates a #GstStructure by changing the given @field_name field to the given
2301  * @target boolean if that field is not fixed yet.
2302  *
2303  * Returns: TRUE if the structure could be fixated
2304  */
2305 gboolean
2306 gst_structure_fixate_field_boolean (GstStructure * structure,
2307     const char *field_name, gboolean target)
2308 {
2309   const GValue *value;
2310
2311   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2312   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2313
2314   value = gst_structure_get_value (structure, field_name);
2315
2316   if (G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
2317     /* already fixed */
2318     return FALSE;
2319   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2320     const GValue *list_value;
2321     int i, n;
2322     int best = 0;
2323     int best_index = -1;
2324
2325     n = gst_value_list_get_size (value);
2326     for (i = 0; i < n; i++) {
2327       list_value = gst_value_list_get_value (value, i);
2328       if (G_VALUE_TYPE (list_value) == G_TYPE_BOOLEAN) {
2329         gboolean x = gst_g_value_get_boolean_unchecked (list_value);
2330
2331         if (best_index == -1 || x == target) {
2332           best_index = i;
2333           best = x;
2334         }
2335       }
2336     }
2337     if (best_index != -1) {
2338       gst_structure_set (structure, field_name, G_TYPE_BOOLEAN, best, NULL);
2339       return TRUE;
2340     }
2341     return FALSE;
2342   }
2343
2344   return FALSE;
2345 }
2346
2347 /**
2348  * gst_structure_fixate_field_string:
2349  * @structure: a #GstStructure
2350  * @field_name: a field in @structure
2351  * @target: the target value of the fixation
2352  *
2353  * Fixates a #GstStructure by changing the given @field_name field to the given
2354  * @target string if that field is not fixed yet.
2355  *
2356  * Returns: TRUE if the structure could be fixated
2357  *
2358  * Since: 0.10.30
2359  */
2360 gboolean
2361 gst_structure_fixate_field_string (GstStructure * structure,
2362     const gchar * field_name, const gchar * target)
2363 {
2364   const GValue *value;
2365
2366   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2367   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2368
2369   value = gst_structure_get_value (structure, field_name);
2370
2371   if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
2372     /* already fixed */
2373     return FALSE;
2374   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2375     const GValue *list_value;
2376     int i, n;
2377     const gchar *best = NULL;
2378     int best_index = -1;
2379
2380     n = gst_value_list_get_size (value);
2381     for (i = 0; i < n; i++) {
2382       list_value = gst_value_list_get_value (value, i);
2383       if (G_VALUE_TYPE (list_value) == G_TYPE_STRING) {
2384         const gchar *x = g_value_get_string (list_value);
2385
2386         if (best_index == -1 || g_str_equal (x, target)) {
2387           best_index = i;
2388           best = x;
2389         }
2390       }
2391     }
2392     if (best_index != -1) {
2393       gst_structure_set (structure, field_name, G_TYPE_STRING, best, NULL);
2394       return TRUE;
2395     }
2396     return FALSE;
2397   }
2398
2399   return FALSE;
2400 }
2401
2402 /**
2403  * gst_structure_fixate_field_nearest_fraction:
2404  * @structure: a #GstStructure
2405  * @field_name: a field in @structure
2406  * @target_numerator: The numerator of the target value of the fixation
2407  * @target_denominator: The denominator of the target value of the fixation
2408  *
2409  * Fixates a #GstStructure by changing the given field to the nearest
2410  * fraction to @target_numerator/@target_denominator that is a subset
2411  * of the existing field.
2412  *
2413  * Returns: TRUE if the structure could be fixated
2414  */
2415 gboolean
2416 gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
2417     const char *field_name, const gint target_numerator,
2418     const gint target_denominator)
2419 {
2420   const GValue *value;
2421
2422   g_return_val_if_fail (gst_structure_has_field (structure, field_name), FALSE);
2423   g_return_val_if_fail (IS_MUTABLE (structure), FALSE);
2424
2425   value = gst_structure_get_value (structure, field_name);
2426
2427   if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION) {
2428     /* already fixed */
2429     return FALSE;
2430   } else if (G_VALUE_TYPE (value) == GST_TYPE_FRACTION_RANGE) {
2431     const GValue *x, *new_value;
2432     GValue target = { 0 };
2433     g_value_init (&target, GST_TYPE_FRACTION);
2434     gst_value_set_fraction (&target, target_numerator, target_denominator);
2435
2436     new_value = &target;
2437     x = gst_value_get_fraction_range_min (value);
2438     if (gst_value_compare (&target, x) == GST_VALUE_LESS_THAN)
2439       new_value = x;
2440     x = gst_value_get_fraction_range_max (value);
2441     if (gst_value_compare (&target, x) == GST_VALUE_GREATER_THAN)
2442       new_value = x;
2443
2444     gst_structure_set_value (structure, field_name, new_value);
2445     g_value_unset (&target);
2446     return TRUE;
2447   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
2448     const GValue *list_value;
2449     int i, n;
2450     const GValue *best = NULL;
2451     gdouble target;
2452     gdouble cur_diff;
2453     gdouble best_diff = G_MAXDOUBLE;
2454
2455     target = (gdouble) target_numerator / (gdouble) target_denominator;
2456
2457     GST_DEBUG ("target %g, best %g", target, best_diff);
2458
2459     best = NULL;
2460
2461     n = gst_value_list_get_size (value);
2462     for (i = 0; i < n; i++) {
2463       list_value = gst_value_list_get_value (value, i);
2464       if (G_VALUE_TYPE (list_value) == GST_TYPE_FRACTION) {
2465         gint num, denom;
2466         gdouble list_double;
2467
2468         num = gst_value_get_fraction_numerator (list_value);
2469         denom = gst_value_get_fraction_denominator (list_value);
2470
2471         list_double = ((gdouble) num / (gdouble) denom);
2472         cur_diff = target - list_double;
2473
2474         GST_DEBUG ("curr diff %g, list %g", cur_diff, list_double);
2475
2476         if (cur_diff < 0)
2477           cur_diff = -cur_diff;
2478
2479         if (!best || cur_diff < best_diff) {
2480           GST_DEBUG ("new best %g", list_double);
2481           best = list_value;
2482           best_diff = cur_diff;
2483         }
2484       }
2485     }
2486     if (best != NULL) {
2487       gst_structure_set_value (structure, field_name, best);
2488       return TRUE;
2489     }
2490   }
2491
2492   return FALSE;
2493 }
2494
2495 /* our very own version of G_VALUE_LCOPY that allows NULL return locations
2496  * (useful for message parsing functions where the return location is user
2497  * supplied and the user may pass NULL if the value isn't of interest) */
2498 #define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname)           \
2499 G_STMT_START {                                                                \
2500   const GValue *_value = (value);                                             \
2501   guint _flags = (flags);                                                     \
2502   GType _value_type = G_VALUE_TYPE (_value);                                  \
2503   GTypeValueTable *_vtable = g_type_value_table_peek (_value_type);           \
2504   gchar *_lcopy_format = _vtable->lcopy_format;                               \
2505   GTypeCValue _cvalues[G_VALUE_COLLECT_FORMAT_MAX_LENGTH] = { { 0, }, };      \
2506   guint _n_values = 0;                                                        \
2507                                                                               \
2508   while (*_lcopy_format != '\0') {                                            \
2509     g_assert (*_lcopy_format == G_VALUE_COLLECT_POINTER);                     \
2510     _cvalues[_n_values++].v_pointer = va_arg ((var_args), gpointer);          \
2511     _lcopy_format++;                                                          \
2512   }                                                                           \
2513   if (_n_values == 2 && !!_cvalues[0].v_pointer != !!_cvalues[1].v_pointer) { \
2514     *(__error) = g_strdup_printf ("either all or none of the return "         \
2515         "locations for field '%s' need to be NULL", fieldname);               \
2516   } else if (_cvalues[0].v_pointer != NULL) {                                 \
2517     *(__error) = _vtable->lcopy_value (_value, _n_values, _cvalues, _flags);  \
2518   }                                                                           \
2519 } G_STMT_END
2520
2521 /**
2522  * gst_structure_get_valist:
2523  * @structure: a #GstStructure
2524  * @first_fieldname: the name of the first field to read
2525  * @args: variable arguments
2526  *
2527  * Parses the variable arguments and reads fields from @structure accordingly.
2528  * valist-variant of gst_structure_get(). Look at the documentation of
2529  * gst_structure_get() for more details.
2530  *
2531  * Returns: TRUE, or FALSE if there was a problem reading any of the fields
2532  *
2533  * Since: 0.10.24
2534  */
2535 gboolean
2536 gst_structure_get_valist (const GstStructure * structure,
2537     const char *first_fieldname, va_list args)
2538 {
2539   const char *field_name;
2540   GType expected_type = G_TYPE_INVALID;
2541
2542   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2543   g_return_val_if_fail (first_fieldname != NULL, FALSE);
2544
2545   field_name = first_fieldname;
2546   while (field_name) {
2547     const GValue *val = NULL;
2548     gchar *err = NULL;
2549
2550     expected_type = va_arg (args, GType);
2551
2552     val = gst_structure_get_value (structure, field_name);
2553
2554     if (val == NULL)
2555       goto no_such_field;
2556
2557     if (G_VALUE_TYPE (val) != expected_type)
2558       goto wrong_type;
2559
2560     GST_VALUE_LCOPY (val, args, 0, &err, field_name);
2561     if (err) {
2562       g_warning ("%s: %s", G_STRFUNC, err);
2563       g_free (err);
2564       return FALSE;
2565     }
2566
2567     field_name = va_arg (args, const gchar *);
2568   }
2569
2570   return TRUE;
2571
2572 /* ERRORS */
2573 no_such_field:
2574   {
2575     GST_WARNING ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2576         field_name, structure);
2577     return FALSE;
2578   }
2579 wrong_type:
2580   {
2581     GST_WARNING ("Expected field '%s' in structure to be of type '%s', but "
2582         "field was of type '%s': %" GST_PTR_FORMAT, field_name,
2583         GST_STR_NULL (g_type_name (expected_type)),
2584         G_VALUE_TYPE_NAME (gst_structure_get_value (structure, field_name)),
2585         structure);
2586     return FALSE;
2587   }
2588 }
2589
2590 /**
2591  * gst_structure_id_get_valist:
2592  * @structure: a #GstStructure
2593  * @first_field_id: the quark of the first field to read
2594  * @args: variable arguments
2595  *
2596  * Parses the variable arguments and reads fields from @structure accordingly.
2597  * valist-variant of gst_structure_id_get(). Look at the documentation of
2598  * gst_structure_id_get() for more details.
2599  *
2600  * Returns: TRUE, or FALSE if there was a problem reading any of the fields
2601  *
2602  * Since: 0.10.24
2603  */
2604 gboolean
2605 gst_structure_id_get_valist (const GstStructure * structure,
2606     GQuark first_field_id, va_list args)
2607 {
2608   GQuark field_id;
2609   GType expected_type = G_TYPE_INVALID;
2610
2611   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2612   g_return_val_if_fail (first_field_id != 0, FALSE);
2613
2614   field_id = first_field_id;
2615   while (field_id) {
2616     const GValue *val = NULL;
2617     gchar *err = NULL;
2618
2619     expected_type = va_arg (args, GType);
2620
2621     val = gst_structure_id_get_value (structure, field_id);
2622
2623     if (val == NULL)
2624       goto no_such_field;
2625
2626     if (G_VALUE_TYPE (val) != expected_type)
2627       goto wrong_type;
2628
2629     GST_VALUE_LCOPY (val, args, 0, &err, g_quark_to_string (field_id));
2630     if (err) {
2631       g_warning ("%s: %s", G_STRFUNC, err);
2632       g_free (err);
2633       return FALSE;
2634     }
2635
2636     field_id = va_arg (args, GQuark);
2637   }
2638
2639   return TRUE;
2640
2641 /* ERRORS */
2642 no_such_field:
2643   {
2644     GST_WARNING ("Expected field '%s' in structure: %" GST_PTR_FORMAT,
2645         GST_STR_NULL (g_quark_to_string (field_id)), structure);
2646     return FALSE;
2647   }
2648 wrong_type:
2649   {
2650     GST_WARNING ("Expected field '%s' in structure to be of type '%s', but "
2651         "field was of type '%s': %" GST_PTR_FORMAT,
2652         g_quark_to_string (field_id),
2653         GST_STR_NULL (g_type_name (expected_type)),
2654         G_VALUE_TYPE_NAME (gst_structure_id_get_value (structure, field_id)),
2655         structure);
2656     return FALSE;
2657   }
2658 }
2659
2660 /**
2661  * gst_structure_get:
2662  * @structure: a #GstStructure
2663  * @first_fieldname: the name of the first field to read
2664  * @...: variable arguments
2665  *
2666  * Parses the variable arguments and reads fields from @structure accordingly.
2667  * Variable arguments should be in the form field name, field type
2668  * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2669  * The last variable argument should be NULL.
2670  *
2671  * For refcounted (mini)objects you will acquire your own reference which
2672  * you must release with a suitable _unref() when no longer needed. For
2673  * strings and boxed types you will acquire a copy which you will need to
2674  * release with either g_free() or the suiteable function for the boxed type.
2675  *
2676  * Returns: FALSE if there was a problem reading any of the fields (e.g.
2677  *     because the field requested did not exist, or was of a type other
2678  *     than the type specified), otherwise TRUE.
2679  *
2680  * Since: 0.10.24
2681  */
2682 gboolean
2683 gst_structure_get (const GstStructure * structure, const char *first_fieldname,
2684     ...)
2685 {
2686   gboolean ret;
2687   va_list args;
2688
2689   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2690   g_return_val_if_fail (first_fieldname != NULL, FALSE);
2691
2692   va_start (args, first_fieldname);
2693   ret = gst_structure_get_valist (structure, first_fieldname, args);
2694   va_end (args);
2695
2696   return ret;
2697 }
2698
2699 /**
2700  * gst_structure_id_get:
2701  * @structure: a #GstStructure
2702  * @first_field_id: the quark of the first field to read
2703  * @...: variable arguments
2704  *
2705  * Parses the variable arguments and reads fields from @structure accordingly.
2706  * Variable arguments should be in the form field id quark, field type
2707  * (as a GType), pointer(s) to a variable(s) to hold the return value(s).
2708  * The last variable argument should be NULL (technically it should be a
2709  * 0 quark, but we require NULL so compilers that support it can check for
2710  * the NULL terminator and warn if it's not there).
2711  *
2712  * This function is just like gst_structure_get() only that it is slightly
2713  * more efficient since it saves the string-to-quark lookup in the global
2714  * quark hashtable.
2715  *
2716  * For refcounted (mini)objects you will acquire your own reference which
2717  * you must release with a suitable _unref() when no longer needed. For
2718  * strings and boxed types you will acquire a copy which you will need to
2719  * release with either g_free() or the suiteable function for the boxed type.
2720  *
2721  * Returns: FALSE if there was a problem reading any of the fields (e.g.
2722  *     because the field requested did not exist, or was of a type other
2723  *     than the type specified), otherwise TRUE.
2724  *
2725  * Since: 0.10.24
2726  */
2727 gboolean
2728 gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
2729     ...)
2730 {
2731   gboolean ret;
2732   va_list args;
2733
2734   g_return_val_if_fail (GST_IS_STRUCTURE (structure), FALSE);
2735   g_return_val_if_fail (first_field_id != 0, FALSE);
2736
2737   va_start (args, first_field_id);
2738   ret = gst_structure_id_get_valist (structure, first_field_id, args);
2739   va_end (args);
2740
2741   return ret;
2742 }