gst/gstindex.c

   1 /* GStreamer
   2  * Copyright (C) 2001 RidgeRun (http://www.ridgerun.com/)
   3  * Written by Erik Walthinsen <omega@ridgerun.com>
   4  *
   5  * gstindex.c: Index for mappings and other data
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstindex
  25  * @short_description: Generate indexes on objects
  26  * @see_also: #GstIndexFactory
  27  *
  28  * GstIndex is used to generate a stream index of one or more elements
  29  * in a pipeline.
  30  */
  31
  32 #include "gst_private.h"
  33
  34 #include "gstinfo.h"
  35 #include "gstindex.h"
  36 #include "gstindexfactory.h"
  37 #include "gstmarshal.h"
  38 #include "gstregistry.h"
  39 /* for constructing an entry name */
  40 #include "gstelement.h"
  41 #include "gstpad.h"
  42
  43 /* Index signals and args */
  44 enum
  45 {
  46   ENTRY_ADDED,
  47   LAST_SIGNAL
  48 };
  49
  50 enum
  51 {
  52   ARG_0,
  53   ARG_RESOLVER
  54       /* FILL ME */
  55 };
  56
  57 static void gst_index_class_init (GstIndexClass * klass);
  58 static void gst_index_init (GstIndex * index);
  59
  60 static void gst_index_set_property (GObject * object, guint prop_id,
  61     const GValue * value, GParamSpec * pspec);
  62 static void gst_index_get_property (GObject * object, guint prop_id,
  63     GValue * value, GParamSpec * pspec);
  64
  65 static GstIndexGroup *gst_index_group_new (guint groupnum);
  66
  67 static gboolean gst_index_path_resolver (GstIndex * index, GstObject * writer,
  68     gchar ** writer_string, gpointer data);
  69 static gboolean gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
  70     gchar ** writer_string, gpointer data);
  71 static void gst_index_add_entry (GstIndex * index, GstIndexEntry * entry);
  72
  73 static GstObject *parent_class = NULL;
  74 static guint gst_index_signals[LAST_SIGNAL] = { 0 };
  75
  76 typedef struct
  77 {
  78   GstIndexResolverMethod method;
  79   GstIndexResolver resolver;
  80   gpointer user_data;
  81 }
  82 ResolverEntry;
  83
  84 static const ResolverEntry resolvers[] = {
  85   {GST_INDEX_RESOLVER_CUSTOM, NULL, NULL},
  86   {GST_INDEX_RESOLVER_GTYPE, gst_index_gtype_resolver, NULL},
  87   {GST_INDEX_RESOLVER_PATH, gst_index_path_resolver, NULL},
  88 };
  89
  90 #define GST_TYPE_INDEX_RESOLVER (gst_index_resolver_get_type())
  91 static GType
  92 gst_index_resolver_get_type (void)
  93 {
  94   static GType index_resolver_type = 0;
  95   static const GEnumValue index_resolver[] = {
  96     {GST_INDEX_RESOLVER_CUSTOM, "GST_INDEX_RESOLVER_CUSTOM",
  97         "Use a custom resolver"},
  98     {GST_INDEX_RESOLVER_GTYPE, "GST_INDEX_RESOLVER_GTYPE",
  99         "Resolve an object to its GType[.padname]"},
 100     {GST_INDEX_RESOLVER_PATH, "GST_INDEX_RESOLVER_PATH",
 101         "Resolve an object to its path in the pipeline"},
 102     {0, NULL, NULL},
 103   };
 104
 105   if (!index_resolver_type) {
 106     index_resolver_type =
 107         g_enum_register_static ("GstIndexResolver", index_resolver);
 108   }
 109   return index_resolver_type;
 110 }
 111
 112 GType
 113 gst_index_entry_get_type (void)
 114 {
 115   static GType index_entry_type = 0;
 116
 117   if (!index_entry_type) {
 118     index_entry_type = g_boxed_type_register_static ("GstIndexEntry",
 119         (GBoxedCopyFunc) gst_index_entry_copy,
 120         (GBoxedFreeFunc) gst_index_entry_free);
 121   }
 122   return index_entry_type;
 123 }
 124
 125
 126 GType
 127 gst_index_get_type (void)
 128 {
 129   static GType index_type = 0;
 130
 131   if (!index_type) {
 132     static const GTypeInfo index_info = {
 133       sizeof (GstIndexClass),
 134       NULL,
 135       NULL,
 136       (GClassInitFunc) gst_index_class_init,
 137       NULL,
 138       NULL,
 139       sizeof (GstIndex),
 140       0,
 141       (GInstanceInitFunc) gst_index_init,
 142       NULL
 143     };
 144
 145     index_type =
 146         g_type_register_static (GST_TYPE_OBJECT, "GstIndex", &index_info, 0);
 147   }
 148   return index_type;
 149 }
 150
 151 static void
 152 gst_index_class_init (GstIndexClass * klass)
 153 {
 154   GObjectClass *gobject_class;
 155
 156   gobject_class = G_OBJECT_CLASS (klass);
 157
 158   parent_class = g_type_class_peek_parent (klass);
 159
 160   /**
 161    * GstIndex::entry-added
 162    * @gstindex: the object which received the signal.
 163    * @arg1: The entry added to the index.
 164    *
 165    * Is emitted when a new entry is added to the index.
 166    */
 167   gst_index_signals[ENTRY_ADDED] =
 168       g_signal_new ("entry-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 169       G_STRUCT_OFFSET (GstIndexClass, entry_added), NULL, NULL,
 170       gst_marshal_VOID__BOXED, G_TYPE_NONE, 1, GST_TYPE_INDEX_ENTRY);
 171
 172   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_index_set_property);
 173   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_index_get_property);
 174
 175   g_object_class_install_property (gobject_class, ARG_RESOLVER,
 176       g_param_spec_enum ("resolver", "Resolver",
 177           "Select a predefined object to string mapper",
 178           GST_TYPE_INDEX_RESOLVER, GST_INDEX_RESOLVER_PATH, G_PARAM_READWRITE));
 179 }
 180
 181 static void
 182 gst_index_init (GstIndex * index)
 183 {
 184   index->curgroup = gst_index_group_new (0);
 185   index->maxgroup = 0;
 186   index->groups = g_list_prepend (NULL, index->curgroup);
 187
 188   index->writers = g_hash_table_new (NULL, NULL);
 189   index->last_id = 0;
 190
 191   index->method = GST_INDEX_RESOLVER_PATH;
 192   index->resolver = resolvers[index->method].resolver;
 193   index->resolver_user_data = resolvers[index->method].user_data;
 194
 195   GST_OBJECT_FLAG_SET (index, GST_INDEX_WRITABLE);
 196   GST_OBJECT_FLAG_SET (index, GST_INDEX_READABLE);
 197
 198   GST_DEBUG ("created new index");
 199 }
 200
 201 static void
 202 gst_index_set_property (GObject * object, guint prop_id,
 203     const GValue * value, GParamSpec * pspec)
 204 {
 205   GstIndex *index;
 206
 207   index = GST_INDEX (object);
 208
 209   switch (prop_id) {
 210     case ARG_RESOLVER:
 211       index->method = g_value_get_enum (value);
 212       index->resolver = resolvers[index->method].resolver;
 213       index->resolver_user_data = resolvers[index->method].user_data;
 214       break;
 215     default:
 216       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 217       break;
 218   }
 219 }
 220
 221 static void
 222 gst_index_get_property (GObject * object, guint prop_id,
 223     GValue * value, GParamSpec * pspec)
 224 {
 225   GstIndex *index;
 226
 227   index = GST_INDEX (object);
 228
 229   switch (prop_id) {
 230     case ARG_RESOLVER:
 231       g_value_set_enum (value, index->method);
 232       break;
 233     default:
 234       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 235       break;
 236   }
 237 }
 238
 239 static GstIndexGroup *
 240 gst_index_group_new (guint groupnum)
 241 {
 242   GstIndexGroup *indexgroup = g_new (GstIndexGroup, 1);
 243
 244   indexgroup->groupnum = groupnum;
 245   indexgroup->entries = NULL;
 246   indexgroup->certainty = GST_INDEX_UNKNOWN;
 247   indexgroup->peergroup = -1;
 248
 249   GST_DEBUG ("created new index group %d", groupnum);
 250
 251   return indexgroup;
 252 }
 253
 254 /**
 255  * gst_index_new:
 256  *
 257  * Create a new tileindex object
 258  *
 259  * Returns: a new index object
 260  */
 261 GstIndex *
 262 gst_index_new (void)
 263 {
 264   GstIndex *index;
 265
 266   index = g_object_new (gst_index_get_type (), NULL);
 267
 268   return index;
 269 }
 270
 271 /**
 272  * gst_index_commit:
 273  * @index: the index to commit
 274  * @id: the writer that commited the index
 275  *
 276  * Tell the index that the writer with the given id is done
 277  * with this index and is not going to write any more entries
 278  * to it.
 279  */
 280 void
 281 gst_index_commit (GstIndex * index, gint id)
 282 {
 283   GstIndexClass *iclass;
 284
 285   iclass = GST_INDEX_GET_CLASS (index);
 286
 287   if (iclass->commit)
 288     iclass->commit (index, id);
 289 }
 290
 291
 292 /**
 293  * gst_index_get_group:
 294  * @index: the index to get the current group from
 295  *
 296  * Get the id of the current group.
 297  *
 298  * Returns: the id of the current group.
 299  */
 300 gint
 301 gst_index_get_group (GstIndex * index)
 302 {
 303   return index->curgroup->groupnum;
 304 }
 305
 306 /**
 307  * gst_index_new_group:
 308  * @index: the index to create the new group in
 309  *
 310  * Create a new group for the given index. It will be
 311  * set as the current group.
 312  *
 313  * Returns: the id of the newly created group.
 314  */
 315 gint
 316 gst_index_new_group (GstIndex * index)
 317 {
 318   index->curgroup = gst_index_group_new (++index->maxgroup);
 319   index->groups = g_list_append (index->groups, index->curgroup);
 320   GST_DEBUG ("created new group %d in index", index->maxgroup);
 321   return index->maxgroup;
 322 }
 323
 324 /**
 325  * gst_index_set_group:
 326  * @index: the index to set the new group in
 327  * @groupnum: the groupnumber to set
 328  *
 329  * Set the current groupnumber to the given argument.
 330  *
 331  * Returns: TRUE if the operation succeeded, FALSE if the group
 332  * did not exist.
 333  */
 334 gboolean
 335 gst_index_set_group (GstIndex * index, gint groupnum)
 336 {
 337   GList *list;
 338   GstIndexGroup *indexgroup;
 339
 340   /* first check for null change */
 341   if (groupnum == index->curgroup->groupnum)
 342     return TRUE;
 343
 344   /* else search for the proper group */
 345   list = index->groups;
 346   while (list) {
 347     indexgroup = (GstIndexGroup *) (list->data);
 348     list = g_list_next (list);
 349     if (indexgroup->groupnum == groupnum) {
 350       index->curgroup = indexgroup;
 351       GST_DEBUG ("switched to index group %d", indexgroup->groupnum);
 352       return TRUE;
 353     }
 354   }
 355
 356   /* couldn't find the group in question */
 357   GST_DEBUG ("couldn't find index group %d", groupnum);
 358   return FALSE;
 359 }
 360
 361 /**
 362  * gst_index_set_certainty:
 363  * @index: the index to set the certainty on
 364  * @certainty: the certainty to set
 365  *
 366  * Set the certainty of the given index.
 367  */
 368 void
 369 gst_index_set_certainty (GstIndex * index, GstIndexCertainty certainty)
 370 {
 371   index->curgroup->certainty = certainty;
 372 }
 373
 374 /**
 375  * gst_index_get_certainty:
 376  * @index: the index to get the certainty of
 377  *
 378  * Get the certainty of the given index.
 379  *
 380  * Returns: the certainty of the index.
 381  */
 382 GstIndexCertainty
 383 gst_index_get_certainty (GstIndex * index)
 384 {
 385   return index->curgroup->certainty;
 386 }
 387
 388 /**
 389  * gst_index_set_filter:
 390  * @index: the index to register the filter on
 391  * @filter: the filter to register
 392  * @user_data: data passed to the filter function
 393  *
 394  * Lets the app register a custom filter function so that
 395  * it can select what entries should be stored in the index.
 396  */
 397 void
 398 gst_index_set_filter (GstIndex * index,
 399     GstIndexFilter filter, gpointer user_data)
 400 {
 401   g_return_if_fail (GST_IS_INDEX (index));
 402
 403   gst_index_set_filter_full (index, filter, user_data, NULL);
 404 }
 405
 406 /**
 407  * gst_index_set_filter_full:
 408  * @index: the index to register the filter on
 409  * @filter: the filter to register
 410  * @user_data: data passed to the filter function
 411  * @user_data_destroy: function to call when @user_data is unset
 412  *
 413  * Lets the app register a custom filter function so that
 414  * it can select what entries should be stored in the index.
 415  */
 416 void
 417 gst_index_set_filter_full (GstIndex * index,
 418     GstIndexFilter filter, gpointer user_data, GDestroyNotify user_data_destroy)
 419 {
 420   g_return_if_fail (GST_IS_INDEX (index));
 421
 422   if (index->filter_user_data && index->filter_user_data_destroy)
 423     index->filter_user_data_destroy (index->filter_user_data);
 424
 425   index->filter = filter;
 426   index->filter_user_data = user_data;
 427   index->filter_user_data_destroy = user_data_destroy;
 428 }
 429
 430 /**
 431  * gst_index_set_resolver:
 432  * @index: the index to register the resolver on
 433  * @resolver: the resolver to register
 434  * @user_data: data passed to the resolver function
 435  *
 436  * Lets the app register a custom function to map index
 437  * ids to writer descriptions.
 438  */
 439 void
 440 gst_index_set_resolver (GstIndex * index,
 441     GstIndexResolver resolver, gpointer user_data)
 442 {
 443   g_return_if_fail (GST_IS_INDEX (index));
 444
 445   index->resolver = resolver;
 446   index->resolver_user_data = user_data;
 447   index->method = GST_INDEX_RESOLVER_CUSTOM;
 448 }
 449
 450 /**
 451  * gst_index_entry_copy:
 452  * @entry: the entry to copy
 453  *
 454  * Copies an entry and returns the result.
 455  *
 456  * Returns: a newly allocated #GstIndexEntry.
 457  */
 458 GstIndexEntry *
 459 gst_index_entry_copy (GstIndexEntry * entry)
 460 {
 461   return g_memdup (entry, sizeof (*entry));
 462 }
 463
 464 /**
 465  * gst_index_entry_free:
 466  * @entry: the entry to free
 467  *
 468  * Free the memory used by the given entry.
 469  */
 470 void
 471 gst_index_entry_free (GstIndexEntry * entry)
 472 {
 473   g_free (entry);
 474 }
 475
 476 /**
 477  * gst_index_add_format:
 478  * @index: the index to add the entry to
 479  * @id: the id of the index writer
 480  * @format: the format to add to the index
 481  *
 482  * Adds a format entry into the index. This function is
 483  * used to map dynamic GstFormat ids to their original
 484  * format key.
 485  *
 486  * Returns: a pointer to the newly added entry in the index.
 487  */
 488 GstIndexEntry *
 489 gst_index_add_format (GstIndex * index, gint id, GstFormat format)
 490 {
 491   GstIndexEntry *entry;
 492   const GstFormatDefinition *def;
 493
 494   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 495   g_return_val_if_fail (format != 0, NULL);
 496
 497   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 498     return NULL;
 499
 500   entry = g_new0 (GstIndexEntry, 1);
 501   entry->type = GST_INDEX_ENTRY_FORMAT;
 502   entry->id = id;
 503   entry->data.format.format = format;
 504
 505   def = gst_format_get_details (format);
 506   entry->data.format.key = def->nick;
 507
 508   gst_index_add_entry (index, entry);
 509
 510   return entry;
 511 }
 512
 513 /**
 514  * gst_index_add_id:
 515  * @index: the index to add the entry to
 516  * @id: the id of the index writer
 517  * @description: the description of the index writer
 518  *
 519  * Add an id entry into the index.
 520  *
 521  * Returns: a pointer to the newly added entry in the index.
 522  */
 523 GstIndexEntry *
 524 gst_index_add_id (GstIndex * index, gint id, gchar * description)
 525 {
 526   GstIndexEntry *entry;
 527
 528   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 529   g_return_val_if_fail (description != NULL, NULL);
 530
 531   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 532     return NULL;
 533
 534   entry = g_new0 (GstIndexEntry, 1);
 535   entry->type = GST_INDEX_ENTRY_ID;
 536   entry->id = id;
 537   entry->data.id.description = description;
 538
 539   gst_index_add_entry (index, entry);
 540
 541   return entry;
 542 }
 543
 544 static gboolean
 545 gst_index_path_resolver (GstIndex * index, GstObject * writer,
 546     gchar ** writer_string, gpointer data)
 547 {
 548   *writer_string = gst_object_get_path_string (writer);
 549
 550   return TRUE;
 551 }
 552
 553 static gboolean
 554 gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
 555     gchar ** writer_string, gpointer data)
 556 {
 557   if (GST_IS_PAD (writer)) {
 558     GstElement *element =
 559         (GstElement *) gst_object_get_parent (GST_OBJECT (writer));
 560     gchar *name;
 561
 562     name = gst_object_get_name (writer);
 563     *writer_string = g_strdup_printf ("%s.%s",
 564         g_type_name (G_OBJECT_TYPE (element)), name);
 565
 566     gst_object_unref (element);
 567     g_free (name);
 568
 569   } else {
 570     *writer_string =
 571         g_strdup_printf ("%s", g_type_name (G_OBJECT_TYPE (writer)));
 572   }
 573
 574   return TRUE;
 575 }
 576
 577 /**
 578  * gst_index_get_writer_id:
 579  * @index: the index to get a unique write id for
 580  * @writer: the GstObject to allocate an id for
 581  * @id: a pointer to a gint to hold the id
 582  *
 583  * Before entries can be added to the index, a writer
 584  * should obtain a unique id. The methods to add new entries
 585  * to the index require this id as an argument.
 586  *
 587  * The application can implement a custom function to map the writer object
 588  * to a string. That string will be used to register or look up an id
 589  * in the index.
 590  *
 591  * Returns: TRUE if the writer would be mapped to an id.
 592  */
 593 gboolean
 594 gst_index_get_writer_id (GstIndex * index, GstObject * writer, gint * id)
 595 {
 596   gchar *writer_string = NULL;
 597   GstIndexEntry *entry;
 598   GstIndexClass *iclass;
 599   gboolean success = FALSE;
 600
 601   g_return_val_if_fail (GST_IS_INDEX (index), FALSE);
 602   g_return_val_if_fail (GST_IS_OBJECT (writer), FALSE);
 603   g_return_val_if_fail (id, FALSE);
 604
 605   *id = -1;
 606
 607   /* first try to get a previously cached id */
 608   entry = g_hash_table_lookup (index->writers, writer);
 609   if (entry == NULL) {
 610
 611     iclass = GST_INDEX_GET_CLASS (index);
 612
 613     /* let the app make a string */
 614     if (index->resolver) {
 615       gboolean res;
 616
 617       res =
 618           index->resolver (index, writer, &writer_string,
 619           index->resolver_user_data);
 620       if (!res)
 621         return FALSE;
 622     } else {
 623       g_warning ("no resolver found");
 624       return FALSE;
 625     }
 626
 627     /* if the index has a resolver, make it map this string to an id */
 628     if (iclass->get_writer_id) {
 629       success = iclass->get_writer_id (index, id, writer_string);
 630     }
 631     /* if the index could not resolve, we allocate one ourselves */
 632     if (!success) {
 633       *id = ++index->last_id;
 634     }
 635
 636     entry = gst_index_add_id (index, *id, writer_string);
 637     if (!entry) {
 638       /* index is probably not writable, make an entry anyway
 639        * to keep it in our cache */
 640       entry = g_new0 (GstIndexEntry, 1);
 641       entry->type = GST_INDEX_ENTRY_ID;
 642       entry->id = *id;
 643       entry->data.id.description = writer_string;
 644     }
 645     g_hash_table_insert (index->writers, writer, entry);
 646   } else {
 647     *id = entry->id;
 648   }
 649
 650   return TRUE;
 651 }
 652
 653 static void
 654 gst_index_add_entry (GstIndex * index, GstIndexEntry * entry)
 655 {
 656   GstIndexClass *iclass;
 657
 658   iclass = GST_INDEX_GET_CLASS (index);
 659
 660   if (iclass->add_entry) {
 661     iclass->add_entry (index, entry);
 662   }
 663
 664   g_signal_emit (G_OBJECT (index), gst_index_signals[ENTRY_ADDED], 0, entry);
 665 }
 666
 667 /**
 668  * gst_index_add_associationv:
 669  * @index: the index to add the entry to
 670  * @id: the id of the index writer
 671  * @flags: optinal flags for this entry
 672  * @n: number of associations
 673  * @list: list of associations
 674  *
 675  * Associate given format/value pairs with each other.
 676  *
 677  * Returns: a pointer to the newly added entry in the index.
 678  */
 679 GstIndexEntry *
 680 gst_index_add_associationv (GstIndex * index, gint id, GstAssocFlags flags,
 681     gint n, const GstIndexAssociation * list)
 682 {
 683   GstIndexEntry *entry;
 684
 685   g_return_val_if_fail (n > 0, NULL);
 686   g_return_val_if_fail (list != NULL, NULL);
 687   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 688
 689   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 690     return NULL;
 691
 692   entry = g_malloc (sizeof (GstIndexEntry));
 693
 694   entry->type = GST_INDEX_ENTRY_ASSOCIATION;
 695   entry->id = id;
 696   entry->data.assoc.flags = flags;
 697   entry->data.assoc.assocs = g_memdup (list, sizeof (GstIndexAssociation) * n);
 698   entry->data.assoc.nassocs = n;
 699
 700   gst_index_add_entry (index, entry);
 701
 702   return entry;
 703 }
 704
 705 /**
 706  * gst_index_add_association:
 707  * @index: the index to add the entry to
 708  * @id: the id of the index writer
 709  * @flags: optinal flags for this entry
 710  * @format: the format of the value
 711  * @value: the value
 712  * @...: other format/value pairs or 0 to end the list
 713  *
 714  * Associate given format/value pairs with each other.
 715  * Be sure to pass gint64 values to this functions varargs,
 716  * you might want to use a gint64 cast to be sure.
 717  *
 718  * Returns: a pointer to the newly added entry in the index.
 719  */
 720 GstIndexEntry *
 721 gst_index_add_association (GstIndex * index, gint id, GstAssocFlags flags,
 722     GstFormat format, gint64 value, ...)
 723 {
 724   va_list args;
 725   GstIndexEntry *entry;
 726   GstIndexAssociation *list;
 727   gint n_assocs = 0;
 728   GstFormat cur_format;
 729   GArray *array;
 730
 731   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 732   g_return_val_if_fail (format != 0, NULL);
 733
 734   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 735     return NULL;
 736
 737   array = g_array_new (FALSE, FALSE, sizeof (GstIndexAssociation));
 738
 739   va_start (args, value);
 740
 741   cur_format = format;
 742   n_assocs = 0;
 743   while (cur_format) {
 744     GstIndexAssociation a;
 745
 746     n_assocs++;
 747     cur_format = va_arg (args, GstFormat);
 748     if (cur_format) {
 749       a.format = cur_format;
 750       a.value = va_arg (args, gint64);
 751
 752       g_array_append_val (array, a);
 753     }
 754   }
 755   va_end (args);
 756
 757   list = (GstIndexAssociation *) g_array_free (array, FALSE);
 758
 759   entry = gst_index_add_associationv (index, id, flags, n_assocs, list);
 760   g_free (list);
 761
 762   return entry;
 763 }
 764
 765 /**
 766  * gst_index_add_object:
 767  * @index: the index to add the object to
 768  * @id: the id of the index writer
 769  * @key: a key for the object
 770  * @type: the GType of the object
 771  * @object: a pointer to the object to add
 772  *
 773  * Add the given object to the index with the given key.
 774  *
 775  * This function is not yet implemented.
 776  *
 777  * Returns: a pointer to the newly added entry in the index.
 778  */
 779 GstIndexEntry *
 780 gst_index_add_object (GstIndex * index, gint id, gchar * key,
 781     GType type, gpointer object)
 782 {
 783   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 784     return NULL;
 785
 786   return NULL;
 787 }
 788
 789 static gint
 790 gst_index_compare_func (gconstpointer a, gconstpointer b, gpointer user_data)
 791 {
 792   if (a < b)
 793     return -1;
 794   if (a > b)
 795     return 1;
 796   return 0;
 797 }
 798
 799 /**
 800  * gst_index_get_assoc_entry:
 801  * @index: the index to search
 802  * @id: the id of the index writer
 803  * @method: The lookup method to use
 804  * @flags: Flags for the entry
 805  * @format: the format of the value
 806  * @value: the value to find
 807  *
 808  * Finds the given format/value in the index
 809  *
 810  * Returns: the entry associated with the value or NULL if the
 811  *   value was not found.
 812  */
 813 GstIndexEntry *
 814 gst_index_get_assoc_entry (GstIndex * index, gint id,
 815     GstIndexLookupMethod method, GstAssocFlags flags,
 816     GstFormat format, gint64 value)
 817 {
 818   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 819
 820   if (id == -1)
 821     return NULL;
 822
 823   return gst_index_get_assoc_entry_full (index, id, method, flags, format,
 824       value, gst_index_compare_func, NULL);
 825 }
 826
 827 /**
 828  * gst_index_get_assoc_entry_full:
 829  * @index: the index to search
 830  * @id: the id of the index writer
 831  * @method: The lookup method to use
 832  * @flags: Flags for the entry
 833  * @format: the format of the value
 834  * @value: the value to find
 835  * @func: the function used to compare entries
 836  * @user_data: user data passed to the compare function
 837  *
 838  * Finds the given format/value in the index with the given
 839  * compare function and user_data.
 840  *
 841  * Returns: the entry associated with the value or NULL if the
 842  *   value was not found.
 843  */
 844 GstIndexEntry *
 845 gst_index_get_assoc_entry_full (GstIndex * index, gint id,
 846     GstIndexLookupMethod method, GstAssocFlags flags,
 847     GstFormat format, gint64 value, GCompareDataFunc func, gpointer user_data)
 848 {
 849   GstIndexClass *iclass;
 850
 851   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 852
 853   if (id == -1)
 854     return NULL;
 855
 856   iclass = GST_INDEX_GET_CLASS (index);
 857
 858   if (iclass->get_assoc_entry)
 859     return iclass->get_assoc_entry (index, id, method, flags, format, value,
 860         func, user_data);
 861
 862   return NULL;
 863 }
 864
 865 /**
 866  * gst_index_entry_assoc_map:
 867  * @entry: the index to search
 868  * @format: the format of the value the find
 869  * @value: a pointer to store the value
 870  *
 871  * Gets alternative formats associated with the indexentry.
 872  *
 873  * Returns: TRUE if there was a value associated with the given
 874  * format.
 875  */
 876 gboolean
 877 gst_index_entry_assoc_map (GstIndexEntry * entry,
 878     GstFormat format, gint64 * value)
 879 {
 880   gint i;
 881
 882   g_return_val_if_fail (entry != NULL, FALSE);
 883   g_return_val_if_fail (value != NULL, FALSE);
 884
 885   for (i = 0; i < GST_INDEX_NASSOCS (entry); i++) {
 886     if (GST_INDEX_ASSOC_FORMAT (entry, i) == format) {
 887       *value = GST_INDEX_ASSOC_VALUE (entry, i);
 888       return TRUE;
 889     }
 890   }
 891   return FALSE;
 892 }