libs/gst/base/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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, 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  * Elements will overload the set_index and get_index virtual methods in
  32  * #GstElement. When streaming data, the element will add index entries if it
  33  * has an index set.
  34  *
  35  * Each element that adds to the index will do that using a writer_id. The
  36  * writer_id is obtained from gst_index_get_writer_id().
  37  *
  38  * The application that wants to index the stream will create a new index object
  39  * using gst_index_new() or gst_index_factory_make(). The index is assigned to a
  40  * specific element, a bin or the whole pipeline. This will cause indexable
  41  * elements to add entires to the index while playing.
  42  */
  43
  44 /* FIXME: complete gobject annotations */
  45 /* FIXME-0.11: cleanup API
  46  * - no one seems to use GstIndexGroup, GstIndexCertainty
  47  *
  48  * - the API for application to use the index is mostly missing
  49  *   - apps need to get a list of writers
  50  *   - apps need to be able to iterate over each writers index entry collection
  51  * - gst_index_get_assoc_entry() should pass ownership
  52  *   - the GstIndexEntry structure is large and contains repetitive information
  53  *   - we want to allow Indexers to implement a saner storage and create
  54  *     GstIndexEntries on demand (the app has to free them), might even make
  55  *     sense to ask the app to provide a ptr and fill it.
  56  */
  57
  58 #ifdef HAVE_CONFIG_H
  59 #include "config.h"
  60 #endif
  61
  62 #include <gst/gst.h>
  63
  64 /* Index signals and args */
  65 enum
  66 {
  67   ENTRY_ADDED,
  68   LAST_SIGNAL
  69 };
  70
  71 enum
  72 {
  73   ARG_0,
  74   ARG_RESOLVER
  75       /* FILL ME */
  76 };
  77
  78 #if 0
  79 GST_DEBUG_CATEGORY_STATIC (index_debug);
  80 #define GST_CAT_DEFAULT index_debug
  81 #endif
  82
  83 static void gst_index_finalize (GObject * object);
  84
  85 static void gst_index_set_property (GObject * object, guint prop_id,
  86     const GValue * value, GParamSpec * pspec);
  87 static void gst_index_get_property (GObject * object, guint prop_id,
  88     GValue * value, GParamSpec * pspec);
  89
  90 static GstIndexGroup *gst_index_group_new (guint groupnum);
  91 static void gst_index_group_free (GstIndexGroup * group);
  92
  93 static gboolean gst_index_path_resolver (GstIndex * index, GstObject * writer,
  94     gchar ** writer_string, gpointer data);
  95 static gboolean gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
  96     gchar ** writer_string, gpointer data);
  97 static void gst_index_add_entry (GstIndex * index, GstIndexEntry * entry);
  98
  99 static guint gst_index_signals[LAST_SIGNAL] = { 0 };
 100
 101 typedef struct
 102 {
 103   GstIndexResolverMethod method;
 104   GstIndexResolver resolver;
 105   gpointer user_data;
 106 }
 107 ResolverEntry;
 108
 109 static const ResolverEntry resolvers[] = {
 110   {GST_INDEX_RESOLVER_CUSTOM, NULL, NULL},
 111   {GST_INDEX_RESOLVER_GTYPE, gst_index_gtype_resolver, NULL},
 112   {GST_INDEX_RESOLVER_PATH, gst_index_path_resolver, NULL},
 113 };
 114
 115 #define GST_TYPE_INDEX_RESOLVER (gst_index_resolver_get_type())
 116 static GType
 117 gst_index_resolver_get_type (void)
 118 {
 119   static GType index_resolver_type = 0;
 120   static const GEnumValue index_resolver[] = {
 121     {GST_INDEX_RESOLVER_CUSTOM, "GST_INDEX_RESOLVER_CUSTOM", "custom"},
 122     {GST_INDEX_RESOLVER_GTYPE, "GST_INDEX_RESOLVER_GTYPE", "gtype"},
 123     {GST_INDEX_RESOLVER_PATH, "GST_INDEX_RESOLVER_PATH", "path"},
 124     {0, NULL, NULL},
 125   };
 126
 127   if (!index_resolver_type) {
 128     index_resolver_type =
 129         g_enum_register_static ("GstIndexResolver", index_resolver);
 130   }
 131   return index_resolver_type;
 132 }
 133
 134 G_DEFINE_BOXED_TYPE (GstIndexEntry, gst_index_entry,
 135     (GBoxedCopyFunc) gst_index_entry_copy,
 136     (GBoxedFreeFunc) gst_index_entry_free);
 137
 138 #if 0
 139 #define _do_init \
 140 { \
 141   GST_DEBUG_CATEGORY_INIT (index_debug, "GST_INDEX", GST_DEBUG_BOLD, \
 142       "Generic indexing support"); \
 143 }
 144 #endif
 145
 146 G_DEFINE_TYPE (GstIndex, gst_index, GST_TYPE_OBJECT);
 147
 148 static void
 149 gst_index_class_init (GstIndexClass * klass)
 150 {
 151   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 152
 153   /**
 154    * GstIndex::entry-added
 155    * @gstindex: the object which received the signal.
 156    * @arg1: The entry added to the index.
 157    *
 158    * Is emitted when a new entry is added to the index.
 159    */
 160   gst_index_signals[ENTRY_ADDED] =
 161       g_signal_new ("entry-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 162       G_STRUCT_OFFSET (GstIndexClass, entry_added), NULL, NULL,
 163       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_INDEX_ENTRY);
 164
 165   gobject_class->set_property = gst_index_set_property;
 166   gobject_class->get_property = gst_index_get_property;
 167   gobject_class->finalize = gst_index_finalize;
 168
 169   g_object_class_install_property (gobject_class, ARG_RESOLVER,
 170       g_param_spec_enum ("resolver", "Resolver",
 171           "Select a predefined object to string mapper",
 172           GST_TYPE_INDEX_RESOLVER, GST_INDEX_RESOLVER_PATH,
 173           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 174 }
 175
 176 static void
 177 gst_index_init (GstIndex * index)
 178 {
 179   index->curgroup = gst_index_group_new (0);
 180   index->maxgroup = 0;
 181   index->groups = g_list_prepend (NULL, index->curgroup);
 182
 183   index->writers = g_hash_table_new (NULL, NULL);
 184   index->last_id = 0;
 185
 186   index->method = GST_INDEX_RESOLVER_PATH;
 187   index->resolver = resolvers[index->method].resolver;
 188   index->resolver_user_data = resolvers[index->method].user_data;
 189
 190   GST_OBJECT_FLAG_SET (index, GST_INDEX_WRITABLE);
 191   GST_OBJECT_FLAG_SET (index, GST_INDEX_READABLE);
 192
 193   GST_DEBUG ("created new index");
 194 }
 195
 196 static void
 197 gst_index_free_writer (gpointer key, gpointer value, gpointer user_data)
 198 {
 199   GstIndexEntry *entry = (GstIndexEntry *) value;
 200
 201   if (entry) {
 202     gst_index_entry_free (entry);
 203   }
 204 }
 205
 206 static void
 207 gst_index_finalize (GObject * object)
 208 {
 209   GstIndex *index = GST_INDEX (object);
 210
 211   if (index->groups) {
 212     g_list_foreach (index->groups, (GFunc) gst_index_group_free, NULL);
 213     g_list_free (index->groups);
 214     index->groups = NULL;
 215   }
 216
 217   if (index->writers) {
 218     g_hash_table_foreach (index->writers, gst_index_free_writer, NULL);
 219     g_hash_table_destroy (index->writers);
 220     index->writers = NULL;
 221   }
 222
 223   if (index->filter_user_data && index->filter_user_data_destroy)
 224     index->filter_user_data_destroy (index->filter_user_data);
 225
 226   if (index->resolver_user_data && index->resolver_user_data_destroy)
 227     index->resolver_user_data_destroy (index->resolver_user_data);
 228
 229   G_OBJECT_CLASS (gst_index_parent_class)->finalize (object);
 230 }
 231
 232 static void
 233 gst_index_set_property (GObject * object, guint prop_id,
 234     const GValue * value, GParamSpec * pspec)
 235 {
 236   GstIndex *index;
 237
 238   index = GST_INDEX (object);
 239
 240   switch (prop_id) {
 241     case ARG_RESOLVER:
 242       index->method = (GstIndexResolverMethod) g_value_get_enum (value);
 243       index->resolver = resolvers[index->method].resolver;
 244       index->resolver_user_data = resolvers[index->method].user_data;
 245       break;
 246     default:
 247       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 248       break;
 249   }
 250 }
 251
 252 static void
 253 gst_index_get_property (GObject * object, guint prop_id,
 254     GValue * value, GParamSpec * pspec)
 255 {
 256   GstIndex *index;
 257
 258   index = GST_INDEX (object);
 259
 260   switch (prop_id) {
 261     case ARG_RESOLVER:
 262       g_value_set_enum (value, index->method);
 263       break;
 264     default:
 265       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 266       break;
 267   }
 268 }
 269
 270 static GstIndexGroup *
 271 gst_index_group_new (guint groupnum)
 272 {
 273   GstIndexGroup *indexgroup = g_slice_new (GstIndexGroup);
 274
 275   indexgroup->groupnum = groupnum;
 276   indexgroup->entries = NULL;
 277   indexgroup->certainty = GST_INDEX_UNKNOWN;
 278   indexgroup->peergroup = -1;
 279
 280   GST_DEBUG ("created new index group %d", groupnum);
 281
 282   return indexgroup;
 283 }
 284
 285 static void
 286 gst_index_group_free (GstIndexGroup * group)
 287 {
 288   g_slice_free (GstIndexGroup, group);
 289 }
 290
 291 /* do not resurrect this, add a derived dummy index class instead */
 292 #if 0
 293 /**
 294  * gst_index_new:
 295  *
 296  * Create a new dummy index object. Use gst_element_set_index() to assign that
 297  * to an element or pipeline. This index is not storing anything, but will
 298  * still emit e.g. the #GstIndex::entry-added signal.
 299  *
 300  * Returns: (transfer full): a new index object
 301  */
 302 GstIndex *
 303 gst_index_new (void)
 304 {
 305   GstIndex *index;
 306
 307   index = g_object_newv (gst_index_get_type (), 0, NULL);
 308
 309   return index;
 310 }
 311
 312 /**
 313  * gst_index_commit:
 314  * @index: the index to commit
 315  * @id: the writer that commited the index
 316  *
 317  * Tell the index that the writer with the given id is done
 318  * with this index and is not going to write any more entries
 319  * to it.
 320  */
 321 void
 322 gst_index_commit (GstIndex * index, gint id)
 323 {
 324   GstIndexClass *iclass;
 325
 326   iclass = GST_INDEX_GET_CLASS (index);
 327
 328   if (iclass->commit)
 329     iclass->commit (index, id);
 330 }
 331
 332 /**
 333  * gst_index_get_group:
 334  * @index: the index to get the current group from
 335  *
 336  * Get the id of the current group.
 337  *
 338  * Returns: the id of the current group.
 339  */
 340 gint
 341 gst_index_get_group (GstIndex * index)
 342 {
 343   return index->curgroup->groupnum;
 344 }
 345
 346 /**
 347  * gst_index_new_group:
 348  * @index: the index to create the new group in
 349  *
 350  * Create a new group for the given index. It will be
 351  * set as the current group.
 352  *
 353  * Returns: the id of the newly created group.
 354  */
 355 gint
 356 gst_index_new_group (GstIndex * index)
 357 {
 358   index->curgroup = gst_index_group_new (++index->maxgroup);
 359   index->groups = g_list_append (index->groups, index->curgroup);
 360   GST_DEBUG ("created new group %d in index", index->maxgroup);
 361   return index->maxgroup;
 362 }
 363
 364 /**
 365  * gst_index_set_group:
 366  * @index: the index to set the new group in
 367  * @groupnum: the groupnumber to set
 368  *
 369  * Set the current groupnumber to the given argument.
 370  *
 371  * Returns: %TRUE if the operation succeeded, %FALSE if the group
 372  * did not exist.
 373  */
 374 gboolean
 375 gst_index_set_group (GstIndex * index, gint groupnum)
 376 {
 377   GList *list;
 378   GstIndexGroup *indexgroup;
 379
 380   /* first check for null change */
 381   if (groupnum == index->curgroup->groupnum)
 382     return TRUE;
 383
 384   /* else search for the proper group */
 385   list = index->groups;
 386   while (list) {
 387     indexgroup = (GstIndexGroup *) (list->data);
 388     list = g_list_next (list);
 389     if (indexgroup->groupnum == groupnum) {
 390       index->curgroup = indexgroup;
 391       GST_DEBUG ("switched to index group %d", indexgroup->groupnum);
 392       return TRUE;
 393     }
 394   }
 395
 396   /* couldn't find the group in question */
 397   GST_DEBUG ("couldn't find index group %d", groupnum);
 398   return FALSE;
 399 }
 400 #endif
 401
 402 #if 0
 403 /**
 404  * gst_index_set_certainty:
 405  * @index: the index to set the certainty on
 406  * @certainty: the certainty to set
 407  *
 408  * Set the certainty of the given index.
 409  */
 410 void
 411 gst_index_set_certainty (GstIndex * index, GstIndexCertainty certainty)
 412 {
 413   index->curgroup->certainty = certainty;
 414 }
 415
 416 /**
 417  * gst_index_get_certainty:
 418  * @index: the index to get the certainty of
 419  *
 420  * Get the certainty of the given index.
 421  *
 422  * Returns: the certainty of the index.
 423  */
 424 GstIndexCertainty
 425 gst_index_get_certainty (GstIndex * index)
 426 {
 427   return index->curgroup->certainty;
 428 }
 429 #endif
 430
 431 #if 0
 432 /**
 433  * gst_index_set_filter:
 434  * @index: the index to register the filter on
 435  * @filter: the filter to register
 436  * @user_data: data passed to the filter function
 437  *
 438  * Lets the app register a custom filter function so that
 439  * it can select what entries should be stored in the index.
 440  */
 441 void
 442 gst_index_set_filter (GstIndex * index,
 443     GstIndexFilter filter, gpointer user_data)
 444 {
 445   g_return_if_fail (GST_IS_INDEX (index));
 446
 447   gst_index_set_filter_full (index, filter, user_data, NULL);
 448 }
 449
 450 /**
 451  * gst_index_set_filter_full:
 452  * @index: the index to register the filter on
 453  * @filter: the filter to register
 454  * @user_data: data passed to the filter function
 455  * @user_data_destroy: function to call when @user_data is unset
 456  *
 457  * Lets the app register a custom filter function so that
 458  * it can select what entries should be stored in the index.
 459  */
 460 void
 461 gst_index_set_filter_full (GstIndex * index,
 462     GstIndexFilter filter, gpointer user_data, GDestroyNotify user_data_destroy)
 463 {
 464   g_return_if_fail (GST_IS_INDEX (index));
 465
 466   if (index->filter_user_data && index->filter_user_data_destroy)
 467     index->filter_user_data_destroy (index->filter_user_data);
 468
 469   index->filter = filter;
 470   index->filter_user_data = user_data;
 471   index->filter_user_data_destroy = user_data_destroy;
 472 }
 473
 474 /**
 475  * gst_index_set_resolver:
 476  * @index: the index to register the resolver on
 477  * @resolver: the resolver to register
 478  * @user_data: data passed to the resolver function
 479  *
 480  * Lets the app register a custom function to map index
 481  * ids to writer descriptions.
 482  */
 483 void
 484 gst_index_set_resolver (GstIndex * index,
 485     GstIndexResolver resolver, gpointer user_data)
 486 {
 487   gst_index_set_resolver_full (index, resolver, user_data, NULL);
 488 }
 489
 490 /**
 491  * gst_index_set_resolver_full:
 492  * @index: the index to register the resolver on
 493  * @resolver: the resolver to register
 494  * @user_data: data passed to the resolver function
 495  * @user_data_destroy: destroy function for @user_data
 496  *
 497  * Lets the app register a custom function to map index
 498  * ids to writer descriptions.
 499  */
 500 void
 501 gst_index_set_resolver_full (GstIndex * index, GstIndexResolver resolver,
 502     gpointer user_data, GDestroyNotify user_data_destroy)
 503 {
 504   g_return_if_fail (GST_IS_INDEX (index));
 505
 506   if (index->resolver_user_data && index->resolver_user_data_destroy)
 507     index->resolver_user_data_destroy (index->resolver_user_data);
 508
 509   index->resolver = resolver;
 510   index->resolver_user_data = user_data;
 511   index->resolver_user_data_destroy = user_data_destroy;
 512   index->method = GST_INDEX_RESOLVER_CUSTOM;
 513 }
 514 #endif
 515
 516 /**
 517  * gst_index_entry_copy:
 518  * @entry: the entry to copy
 519  *
 520  * Copies an entry and returns the result.
 521  *
 522  * Free-function: gst_index_entry_free
 523  *
 524  * Returns: (transfer full): a newly allocated #GstIndexEntry.
 525  */
 526 GstIndexEntry *
 527 gst_index_entry_copy (GstIndexEntry * entry)
 528 {
 529   GstIndexEntry *new_entry = g_slice_new (GstIndexEntry);
 530
 531   memcpy (new_entry, entry, sizeof (GstIndexEntry));
 532   return new_entry;
 533 }
 534
 535 /**
 536  * gst_index_entry_free:
 537  * @entry: (transfer full): the entry to free
 538  *
 539  * Free the memory used by the given entry.
 540  */
 541 void
 542 gst_index_entry_free (GstIndexEntry * entry)
 543 {
 544   switch (entry->type) {
 545     case GST_INDEX_ENTRY_ID:
 546       if (entry->data.id.description) {
 547         g_free (entry->data.id.description);
 548         entry->data.id.description = NULL;
 549       }
 550       break;
 551     case GST_INDEX_ENTRY_ASSOCIATION:
 552       if (entry->data.assoc.assocs) {
 553         g_free (entry->data.assoc.assocs);
 554         entry->data.assoc.assocs = NULL;
 555       }
 556       break;
 557     case GST_INDEX_ENTRY_OBJECT:
 558       break;
 559     case GST_INDEX_ENTRY_FORMAT:
 560       break;
 561   }
 562
 563   g_slice_free (GstIndexEntry, entry);
 564 }
 565
 566 #if 0
 567 /**
 568  * gst_index_add_format:
 569  * @index: the index to add the entry to
 570  * @id: the id of the index writer
 571  * @format: the format to add to the index
 572  *
 573  * Adds a format entry into the index. This function is
 574  * used to map dynamic #GstFormat ids to their original
 575  * format key.
 576  *
 577  * Free-function: gst_index_entry_free
 578  *
 579  * Returns: (transfer full): a pointer to the newly added entry in the index.
 580  */
 581 GstIndexEntry *
 582 gst_index_add_format (GstIndex * index, gint id, GstFormat format)
 583 {
 584   GstIndexEntry *entry;
 585   const GstFormatDefinition *def;
 586
 587   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 588   g_return_val_if_fail (format != 0, NULL);
 589
 590   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 591     return NULL;
 592
 593   entry = g_slice_new (GstIndexEntry);
 594   entry->type = GST_INDEX_ENTRY_FORMAT;
 595   entry->id = id;
 596   entry->data.format.format = format;
 597
 598   def = gst_format_get_details (format);
 599   entry->data.format.key = def->nick;
 600
 601   gst_index_add_entry (index, entry);
 602
 603   return entry;
 604 }
 605 #endif
 606
 607 /**
 608  * gst_index_add_id:
 609  * @index: the index to add the entry to
 610  * @id: the id of the index writer
 611  * @description: the description of the index writer
 612  *
 613  * Add an id entry into the index.
 614  *
 615  * Returns: a pointer to the newly added entry in the index.
 616  */
 617 GstIndexEntry *
 618 gst_index_add_id (GstIndex * index, gint id, gchar * description)
 619 {
 620   GstIndexEntry *entry;
 621
 622   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 623   g_return_val_if_fail (description != NULL, NULL);
 624
 625   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 626     return NULL;
 627
 628   entry = g_slice_new (GstIndexEntry);
 629   entry->type = GST_INDEX_ENTRY_ID;
 630   entry->id = id;
 631   entry->data.id.description = description;
 632
 633   gst_index_add_entry (index, entry);
 634
 635   return entry;
 636 }
 637
 638 static gboolean
 639 gst_index_path_resolver (GstIndex * index, GstObject * writer,
 640     gchar ** writer_string, gpointer data)
 641 {
 642   *writer_string = gst_object_get_path_string (writer);
 643
 644   return TRUE;
 645 }
 646
 647 static gboolean
 648 gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
 649     gchar ** writer_string, gpointer data)
 650 {
 651   g_return_val_if_fail (writer != NULL, FALSE);
 652
 653   if (GST_IS_PAD (writer)) {
 654     GstObject *element = gst_object_get_parent (GST_OBJECT (writer));
 655     gchar *name;
 656
 657     name = gst_object_get_name (writer);
 658     if (element) {
 659       *writer_string = g_strdup_printf ("%s.%s",
 660           G_OBJECT_TYPE_NAME (element), name);
 661       gst_object_unref (element);
 662     } else {
 663       *writer_string = name;
 664       name = NULL;
 665     }
 666
 667     g_free (name);
 668
 669   } else {
 670     *writer_string = g_strdup (G_OBJECT_TYPE_NAME (writer));
 671   }
 672
 673   return TRUE;
 674 }
 675
 676 /**
 677  * gst_index_get_writer_id:
 678  * @index: the index to get a unique write id for
 679  * @writer: the #GstObject to allocate an id for
 680  * @id: a pointer to a gint to hold the id
 681  *
 682  * Before entries can be added to the index, a writer
 683  * should obtain a unique id. The methods to add new entries
 684  * to the index require this id as an argument.
 685  *
 686  * The application can implement a custom function to map the writer object
 687  * to a string. That string will be used to register or look up an id
 688  * in the index.
 689  *
 690  * <note>
 691  * The caller must not hold @writer's GST_OBJECT_LOCK(), as the default
 692  * resolver may call functions that take the object lock as well, and
 693  * the lock is not recursive.
 694  * </note>
 695  *
 696  * Returns: %TRUE if the writer would be mapped to an id.
 697  */
 698 gboolean
 699 gst_index_get_writer_id (GstIndex * index, GstObject * writer, gint * id)
 700 {
 701   gchar *writer_string = NULL;
 702   GstIndexEntry *entry;
 703   GstIndexClass *iclass;
 704   gboolean success = FALSE;
 705
 706   g_return_val_if_fail (GST_IS_INDEX (index), FALSE);
 707   g_return_val_if_fail (GST_IS_OBJECT (writer), FALSE);
 708   g_return_val_if_fail (id, FALSE);
 709
 710   *id = -1;
 711
 712   /* first try to get a previously cached id */
 713   entry = g_hash_table_lookup (index->writers, writer);
 714   if (entry == NULL) {
 715
 716     iclass = GST_INDEX_GET_CLASS (index);
 717
 718     /* let the app make a string */
 719     if (index->resolver) {
 720       gboolean res;
 721
 722       res =
 723           index->resolver (index, writer, &writer_string,
 724           index->resolver_user_data);
 725       if (!res)
 726         return FALSE;
 727     } else {
 728       g_warning ("no resolver found");
 729       return FALSE;
 730     }
 731
 732     /* if the index has a resolver, make it map this string to an id */
 733     if (iclass->get_writer_id) {
 734       success = iclass->get_writer_id (index, id, writer_string);
 735     }
 736     /* if the index could not resolve, we allocate one ourselves */
 737     if (!success) {
 738       *id = ++index->last_id;
 739     }
 740
 741     entry = gst_index_add_id (index, *id, writer_string);
 742     if (!entry) {
 743       /* index is probably not writable, make an entry anyway
 744        * to keep it in our cache */
 745       entry = g_slice_new (GstIndexEntry);
 746       entry->type = GST_INDEX_ENTRY_ID;
 747       entry->id = *id;
 748       entry->data.id.description = writer_string;
 749     }
 750     g_hash_table_insert (index->writers, writer, entry);
 751   } else {
 752     *id = entry->id;
 753   }
 754
 755   return TRUE;
 756 }
 757
 758 static void
 759 gst_index_add_entry (GstIndex * index, GstIndexEntry * entry)
 760 {
 761   GstIndexClass *iclass;
 762
 763   iclass = GST_INDEX_GET_CLASS (index);
 764
 765   if (iclass->add_entry) {
 766     iclass->add_entry (index, entry);
 767   }
 768
 769   g_signal_emit (index, gst_index_signals[ENTRY_ADDED], 0, entry);
 770 }
 771
 772 /**
 773  * gst_index_add_associationv:
 774  * @index: the index to add the entry to
 775  * @id: the id of the index writer
 776  * @flags: optinal flags for this entry
 777  * @n: number of associations
 778  * @list: (array length=n): list of associations
 779  *
 780  * Associate given format/value pairs with each other.
 781  *
 782  * Returns: a pointer to the newly added entry in the index.
 783  */
 784 GstIndexEntry *
 785 gst_index_add_associationv (GstIndex * index, gint id,
 786     GstIndexAssociationFlags flags, gint n, const GstIndexAssociation * list)
 787 {
 788   GstIndexEntry *entry;
 789
 790   g_return_val_if_fail (n > 0, NULL);
 791   g_return_val_if_fail (list != NULL, NULL);
 792   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 793
 794   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 795     return NULL;
 796
 797   entry = g_slice_new (GstIndexEntry);
 798
 799   entry->type = GST_INDEX_ENTRY_ASSOCIATION;
 800   entry->id = id;
 801   entry->data.assoc.flags = flags;
 802   entry->data.assoc.assocs = g_memdup (list, sizeof (GstIndexAssociation) * n);
 803   entry->data.assoc.nassocs = n;
 804
 805   gst_index_add_entry (index, entry);
 806
 807   return entry;
 808 }
 809
 810 #if 0
 811 /**
 812  * gst_index_add_association:
 813  * @index: the index to add the entry to
 814  * @id: the id of the index writer
 815  * @flags: optinal flags for this entry
 816  * @format: the format of the value
 817  * @value: the value
 818  * @...: other format/value pairs or 0 to end the list
 819  *
 820  * Associate given format/value pairs with each other.
 821  * Be sure to pass gint64 values to this functions varargs,
 822  * you might want to use a gint64 cast to be sure.
 823  *
 824  * Returns: a pointer to the newly added entry in the index.
 825  */
 826 GstIndexEntry *
 827 gst_index_add_association (GstIndex * index, gint id,
 828     GstIndexAssociationFlags flags, GstFormat format, gint64 value, ...)
 829 {
 830   va_list args;
 831   GstIndexEntry *entry;
 832   GstIndexAssociation *list;
 833   gint n_assocs = 0;
 834   GstFormat cur_format;
 835   GArray *array;
 836
 837   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 838   g_return_val_if_fail (format != 0, NULL);
 839
 840   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 841     return NULL;
 842
 843   array = g_array_new (FALSE, FALSE, sizeof (GstIndexAssociation));
 844
 845   {
 846     GstIndexAssociation a;
 847
 848     a.format = format;
 849     a.value = value;
 850     n_assocs = 1;
 851     g_array_append_val (array, a);
 852   }
 853
 854   va_start (args, value);
 855
 856   while ((cur_format = va_arg (args, GstFormat))) {
 857     GstIndexAssociation a;
 858
 859     a.format = cur_format;
 860     a.value = va_arg (args, gint64);
 861     n_assocs++;
 862     g_array_append_val (array, a);
 863   }
 864
 865   va_end (args);
 866
 867   list = (GstIndexAssociation *) g_array_free (array, FALSE);
 868
 869   entry = gst_index_add_associationv (index, id, flags, n_assocs, list);
 870   g_free (list);
 871
 872   return entry;
 873 }
 874
 875 /**
 876  * gst_index_add_object:
 877  * @index: the index to add the object to
 878  * @id: the id of the index writer
 879  * @key: a key for the object
 880  * @type: the GType of the object
 881  * @object: a pointer to the object to add
 882  *
 883  * Add the given object to the index with the given key.
 884  *
 885  * This function is not yet implemented.
 886  *
 887  * Returns: a pointer to the newly added entry in the index.
 888  */
 889 GstIndexEntry *
 890 gst_index_add_object (GstIndex * index, gint id, gchar * key,
 891     GType type, gpointer object)
 892 {
 893   if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
 894     return NULL;
 895
 896   return NULL;
 897 }
 898 #endif
 899
 900 static gint
 901 gst_index_compare_func (gconstpointer a, gconstpointer b, gpointer user_data)
 902 {
 903   if (a < b)
 904     return -1;
 905   if (a > b)
 906     return 1;
 907   return 0;
 908 }
 909
 910 /**
 911  * gst_index_get_assoc_entry:
 912  * @index: the index to search
 913  * @id: the id of the index writer
 914  * @method: The lookup method to use
 915  * @flags: Flags for the entry
 916  * @format: the format of the value
 917  * @value: the value to find
 918  *
 919  * Finds the given format/value in the index
 920  *
 921  * Returns: (nullable): the entry associated with the value or %NULL if the
 922  *   value was not found.
 923  */
 924 GstIndexEntry *
 925 gst_index_get_assoc_entry (GstIndex * index, gint id,
 926     GstIndexLookupMethod method, GstIndexAssociationFlags flags,
 927     GstFormat format, gint64 value)
 928 {
 929   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 930
 931   if (id == -1)
 932     return NULL;
 933
 934   return gst_index_get_assoc_entry_full (index, id, method, flags, format,
 935       value, gst_index_compare_func, NULL);
 936 }
 937
 938 /**
 939  * gst_index_get_assoc_entry_full:
 940  * @index: the index to search
 941  * @id: the id of the index writer
 942  * @method: The lookup method to use
 943  * @flags: Flags for the entry
 944  * @format: the format of the value
 945  * @value: the value to find
 946  * @func: the function used to compare entries
 947  * @user_data: user data passed to the compare function
 948  *
 949  * Finds the given format/value in the index with the given
 950  * compare function and user_data.
 951  *
 952  * Returns: (nullable): the entry associated with the value or %NULL if the
 953  *   value was not found.
 954  */
 955 GstIndexEntry *
 956 gst_index_get_assoc_entry_full (GstIndex * index, gint id,
 957     GstIndexLookupMethod method, GstIndexAssociationFlags flags,
 958     GstFormat format, gint64 value, GCompareDataFunc func, gpointer user_data)
 959 {
 960   GstIndexClass *iclass;
 961
 962   g_return_val_if_fail (GST_IS_INDEX (index), NULL);
 963
 964   if (id == -1)
 965     return NULL;
 966
 967   iclass = GST_INDEX_GET_CLASS (index);
 968
 969   if (iclass->get_assoc_entry)
 970     return iclass->get_assoc_entry (index, id, method, flags, format, value,
 971         func, user_data);
 972
 973   return NULL;
 974 }
 975
 976 /**
 977  * gst_index_entry_assoc_map:
 978  * @entry: the index to search
 979  * @format: the format of the value the find
 980  * @value: a pointer to store the value
 981  *
 982  * Gets alternative formats associated with the indexentry.
 983  *
 984  * Returns: %TRUE if there was a value associated with the given
 985  * format.
 986  */
 987 gboolean
 988 gst_index_entry_assoc_map (GstIndexEntry * entry,
 989     GstFormat format, gint64 * value)
 990 {
 991   gint i;
 992
 993   g_return_val_if_fail (entry != NULL, FALSE);
 994   g_return_val_if_fail (value != NULL, FALSE);
 995
 996   for (i = 0; i < GST_INDEX_NASSOCS (entry); i++) {
 997     if (GST_INDEX_ASSOC_FORMAT (entry, i) == format) {
 998       *value = GST_INDEX_ASSOC_VALUE (entry, i);
 999       return TRUE;
1000     }
1001   }
1002   return FALSE;
1003 }