2 * Copyright (C) 2001 RidgeRun (http://www.ridgerun.com/)
3 * Written by Erik Walthinsen <omega@ridgerun.com>
5 * gstindex.c: Index for mappings and other data
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.
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.
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.
23 #include "gst_private.h"
26 #include "gstregistrypool.h"
29 #include "gstmarshal.h"
31 /* Index signals and args */
45 static void gst_index_class_init (GstIndexClass * klass);
46 static void gst_index_init (GstIndex * index);
48 static void gst_index_set_property (GObject * object, guint prop_id,
49 const GValue * value, GParamSpec * pspec);
50 static void gst_index_get_property (GObject * object, guint prop_id,
51 GValue * value, GParamSpec * pspec);
53 static GstIndexGroup *gst_index_group_new (guint groupnum);
55 static gboolean gst_index_path_resolver (GstIndex * index, GstObject * writer,
56 gchar ** writer_string, gpointer data);
57 static gboolean gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
58 gchar ** writer_string, gpointer data);
59 static void gst_index_add_entry (GstIndex * index, GstIndexEntry * entry);
61 static GstObject *parent_class = NULL;
62 static guint gst_index_signals[LAST_SIGNAL] = { 0 };
66 GstIndexResolverMethod method;
67 GstIndexResolver resolver;
72 static const ResolverEntry resolvers[] = {
73 {GST_INDEX_RESOLVER_CUSTOM, NULL, NULL},
74 {GST_INDEX_RESOLVER_GTYPE, gst_index_gtype_resolver, NULL},
75 {GST_INDEX_RESOLVER_PATH, gst_index_path_resolver, NULL},
78 #define GST_TYPE_INDEX_RESOLVER (gst_index_resolver_get_type())
80 gst_index_resolver_get_type (void)
82 static GType index_resolver_type = 0;
83 static GEnumValue index_resolver[] = {
84 {GST_INDEX_RESOLVER_CUSTOM, "GST_INDEX_RESOLVER_CUSTOM",
85 "Use a custom resolver"},
86 {GST_INDEX_RESOLVER_GTYPE, "GST_INDEX_RESOLVER_GTYPE",
87 "Resolve an object to its GType[.padname]"},
88 {GST_INDEX_RESOLVER_PATH, "GST_INDEX_RESOLVER_PATH",
89 "Resolve an object to its path in the pipeline"},
93 if (!index_resolver_type) {
95 g_enum_register_static ("GstIndexResolver", index_resolver);
97 return index_resolver_type;
101 gst_index_entry_get_type (void)
103 static GType index_entry_type = 0;
105 if (!index_entry_type) {
106 index_entry_type = g_boxed_type_register_static ("GstIndexEntry",
107 (GBoxedCopyFunc) gst_index_entry_copy,
108 (GBoxedFreeFunc) gst_index_entry_free);
110 return index_entry_type;
115 gst_index_get_type (void)
117 static GType index_type = 0;
120 static const GTypeInfo index_info = {
121 sizeof (GstIndexClass),
124 (GClassInitFunc) gst_index_class_init,
129 (GInstanceInitFunc) gst_index_init,
134 g_type_register_static (GST_TYPE_OBJECT, "GstIndex", &index_info, 0);
140 gst_index_class_init (GstIndexClass * klass)
142 GObjectClass *gobject_class;
143 GstElementClass *gstelement_class;
145 gobject_class = (GObjectClass *) klass;
146 gstelement_class = (GstElementClass *) klass;
148 parent_class = g_type_class_ref (GST_TYPE_OBJECT);
150 gst_index_signals[ENTRY_ADDED] =
151 g_signal_new ("entry-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
152 G_STRUCT_OFFSET (GstIndexClass, entry_added), NULL, NULL,
153 gst_marshal_VOID__BOXED, G_TYPE_NONE, 1, GST_TYPE_INDEX_ENTRY);
155 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_index_set_property);
156 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_index_get_property);
158 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_RESOLVER,
159 g_param_spec_enum ("resolver", "Resolver",
160 "Select a predefined object to string mapper",
161 GST_TYPE_INDEX_RESOLVER, GST_INDEX_RESOLVER_PATH, G_PARAM_READWRITE));
165 gst_index_init (GstIndex * index)
167 index->curgroup = gst_index_group_new (0);
169 index->groups = g_list_prepend (NULL, index->curgroup);
171 index->writers = g_hash_table_new (NULL, NULL);
174 index->method = GST_INDEX_RESOLVER_PATH;
175 index->resolver = resolvers[index->method].resolver;
176 index->resolver_user_data = resolvers[index->method].user_data;
178 GST_FLAG_SET (index, GST_INDEX_WRITABLE);
179 GST_FLAG_SET (index, GST_INDEX_READABLE);
181 GST_DEBUG ("created new index");
185 gst_index_set_property (GObject * object, guint prop_id,
186 const GValue * value, GParamSpec * pspec)
190 index = GST_INDEX (object);
194 index->method = g_value_get_enum (value);
195 index->resolver = resolvers[index->method].resolver;
196 index->resolver_user_data = resolvers[index->method].user_data;
199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
205 gst_index_get_property (GObject * object, guint prop_id,
206 GValue * value, GParamSpec * pspec)
210 index = GST_INDEX (object);
214 g_value_set_enum (value, index->method);
217 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
222 static GstIndexGroup *
223 gst_index_group_new (guint groupnum)
225 GstIndexGroup *indexgroup = g_new (GstIndexGroup, 1);
227 indexgroup->groupnum = groupnum;
228 indexgroup->entries = NULL;
229 indexgroup->certainty = GST_INDEX_UNKNOWN;
230 indexgroup->peergroup = -1;
232 GST_DEBUG ("created new index group %d", groupnum);
240 * Create a new tileindex object
242 * Returns: a new index object
249 index = g_object_new (gst_index_get_type (), NULL);
256 * @index: the index to commit
257 * @id: the writer that commited the index
259 * Tell the index that the writer with the given id is done
260 * with this index and is not going to write any more entries
264 gst_index_commit (GstIndex * index, gint id)
266 GstIndexClass *iclass;
268 iclass = GST_INDEX_GET_CLASS (index);
271 iclass->commit (index, id);
276 * gst_index_get_group:
277 * @index: the index to get the current group from
279 * Get the id of the current group.
281 * Returns: the id of the current group.
284 gst_index_get_group (GstIndex * index)
286 return index->curgroup->groupnum;
290 * gst_index_new_group:
291 * @index: the index to create the new group in
293 * Create a new group for the given index. It will be
294 * set as the current group.
296 * Returns: the id of the newly created group.
299 gst_index_new_group (GstIndex * index)
301 index->curgroup = gst_index_group_new (++index->maxgroup);
302 index->groups = g_list_append (index->groups, index->curgroup);
303 GST_DEBUG ("created new group %d in index", index->maxgroup);
304 return index->maxgroup;
308 * gst_index_set_group:
309 * @index: the index to set the new group in
310 * @groupnum: the groupnumber to set
312 * Set the current groupnumber to the given argument.
314 * Returns: TRUE if the operation succeeded, FALSE if the group
318 gst_index_set_group (GstIndex * index, gint groupnum)
321 GstIndexGroup *indexgroup;
323 /* first check for null change */
324 if (groupnum == index->curgroup->groupnum)
327 /* else search for the proper group */
328 list = index->groups;
330 indexgroup = (GstIndexGroup *) (list->data);
331 list = g_list_next (list);
332 if (indexgroup->groupnum == groupnum) {
333 index->curgroup = indexgroup;
334 GST_DEBUG ("switched to index group %d", indexgroup->groupnum);
339 /* couldn't find the group in question */
340 GST_DEBUG ("couldn't find index group %d", groupnum);
345 * gst_index_set_certainty:
346 * @index: the index to set the certainty on
347 * @certainty: the certainty to set
349 * Set the certainty of the given index.
352 gst_index_set_certainty (GstIndex * index, GstIndexCertainty certainty)
354 index->curgroup->certainty = certainty;
358 * gst_index_get_certainty:
359 * @index: the index to get the certainty of
361 * Get the certainty of the given index.
363 * Returns: the certainty of the index.
366 gst_index_get_certainty (GstIndex * index)
368 return index->curgroup->certainty;
372 * gst_index_set_filter:
373 * @index: the index to register the filter on
374 * @filter: the filter to register
375 * @user_data: data passed to the filter function
377 * Lets the app register a custom filter function so that
378 * it can select what entries should be stored in the index.
381 gst_index_set_filter (GstIndex * index,
382 GstIndexFilter filter, gpointer user_data)
384 g_return_if_fail (GST_IS_INDEX (index));
386 index->filter = filter;
387 index->filter_user_data = user_data;
391 * gst_index_set_resolver:
392 * @index: the index to register the resolver on
393 * @resolver: the resolver to register
394 * @user_data: data passed to the resolver function
396 * Lets the app register a custom function to map index
397 * ids to writer descriptions.
400 gst_index_set_resolver (GstIndex * index,
401 GstIndexResolver resolver, gpointer user_data)
403 g_return_if_fail (GST_IS_INDEX (index));
405 index->resolver = resolver;
406 index->resolver_user_data = user_data;
407 index->method = GST_INDEX_RESOLVER_CUSTOM;
411 * gst_index_entry_copy:
412 * @entry: the entry to copy
414 * Copies an entry and returns the result.
417 gst_index_entry_copy (GstIndexEntry * entry)
419 return g_memdup (entry, sizeof (*entry));
423 * gst_index_entry_free:
424 * @entry: the entry to free
426 * Free the memory used by the given entry.
429 gst_index_entry_free (GstIndexEntry * entry)
435 * gst_index_add_format:
436 * @index: the index to add the entry to
437 * @id: the id of the index writer
438 * @format: the format to add to the index
440 * Adds a format entry into the index. This function is
441 * used to map dynamic GstFormat ids to their original
444 * Returns: a pointer to the newly added entry in the index.
447 gst_index_add_format (GstIndex * index, gint id, GstFormat format)
449 GstIndexEntry *entry;
450 const GstFormatDefinition *def;
452 g_return_val_if_fail (GST_IS_INDEX (index), NULL);
453 g_return_val_if_fail (format != 0, NULL);
455 if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
458 entry = g_new0 (GstIndexEntry, 1);
459 entry->type = GST_INDEX_ENTRY_FORMAT;
461 entry->data.format.format = format;
463 def = gst_format_get_details (format);
464 entry->data.format.key = def->nick;
466 gst_index_add_entry (index, entry);
473 * @index: the index to add the entry to
474 * @id: the id of the index writer
475 * @description: the description of the index writer
477 * Add an id entry into the index.
479 * Returns: a pointer to the newly added entry in the index.
482 gst_index_add_id (GstIndex * index, gint id, gchar * description)
484 GstIndexEntry *entry;
486 g_return_val_if_fail (GST_IS_INDEX (index), NULL);
487 g_return_val_if_fail (description != NULL, NULL);
489 if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
492 entry = g_new0 (GstIndexEntry, 1);
493 entry->type = GST_INDEX_ENTRY_ID;
495 entry->data.id.description = description;
497 gst_index_add_entry (index, entry);
503 gst_index_path_resolver (GstIndex * index, GstObject * writer,
504 gchar ** writer_string, gpointer data)
506 *writer_string = gst_object_get_path_string (writer);
512 gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
513 gchar ** writer_string, gpointer data)
515 if (GST_IS_PAD (writer)) {
516 GstElement *element = gst_pad_get_parent (GST_PAD (writer));
518 *writer_string = g_strdup_printf ("%s.%s",
519 g_type_name (G_OBJECT_TYPE (element)), gst_object_get_name (writer));
522 g_strdup_printf ("%s", g_type_name (G_OBJECT_TYPE (writer)));
529 * gst_index_get_writer_id:
530 * @index: the index to get a unique write id for
531 * @writer: the GstObject to allocate an id for
532 * @id: a pointer to a gint to hold the id
534 * Before entries can be added to the index, a writer
535 * should obtain a unique id. The methods to add new entries
536 * to the index require this id as an argument.
538 * The application can implement a custom function to map the writer object
539 * to a string. That string will be used to register or look up an id
542 * Returns: TRUE if the writer would be mapped to an id.
545 gst_index_get_writer_id (GstIndex * index, GstObject * writer, gint * id)
547 gchar *writer_string = NULL;
548 GstIndexEntry *entry;
549 GstIndexClass *iclass;
550 gboolean success = FALSE;
552 g_return_val_if_fail (GST_IS_INDEX (index), FALSE);
553 g_return_val_if_fail (GST_IS_OBJECT (writer), FALSE);
554 g_return_val_if_fail (id, FALSE);
558 /* first try to get a previously cached id */
559 entry = g_hash_table_lookup (index->writers, writer);
562 iclass = GST_INDEX_GET_CLASS (index);
564 /* let the app make a string */
565 if (index->resolver) {
569 index->resolver (index, writer, &writer_string,
570 index->resolver_user_data);
574 g_warning ("no resolver found");
578 /* if the index has a resolver, make it map this string to an id */
579 if (iclass->get_writer_id) {
580 success = iclass->get_writer_id (index, id, writer_string);
582 /* if the index could not resolve, we allocate one ourselves */
584 *id = ++index->last_id;
587 entry = gst_index_add_id (index, *id, writer_string);
589 /* index is probably not writable, make an entry anyway
590 * to keep it in our cache */
591 entry = g_new0 (GstIndexEntry, 1);
592 entry->type = GST_INDEX_ENTRY_ID;
594 entry->data.id.description = writer_string;
596 g_hash_table_insert (index->writers, writer, entry);
605 gst_index_add_entry (GstIndex * index, GstIndexEntry * entry)
607 GstIndexClass *iclass;
609 iclass = GST_INDEX_GET_CLASS (index);
611 if (iclass->add_entry) {
612 iclass->add_entry (index, entry);
615 g_signal_emit (G_OBJECT (index), gst_index_signals[ENTRY_ADDED], 0, entry);
619 * gst_index_add_associationv:
620 * @index: the index to add the entry to
621 * @id: the id of the index writer
622 * @flags: optinal flags for this entry
623 * @n: number of associations
624 * @list: list of associations
625 * @...: other format/value pairs or 0 to end the list
627 * Associate given format/value pairs with each other.
629 * Returns: a pointer to the newly added entry in the index.
632 gst_index_add_associationv (GstIndex * index, gint id, GstAssocFlags flags,
633 int n, const GstIndexAssociation * list)
635 GstIndexEntry *entry;
637 g_return_val_if_fail (n > 0, NULL);
638 g_return_val_if_fail (list != NULL, NULL);
639 g_return_val_if_fail (GST_IS_INDEX (index), NULL);
641 if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
644 entry = g_malloc (sizeof (GstIndexEntry));
646 entry->type = GST_INDEX_ENTRY_ASSOCIATION;
648 entry->data.assoc.flags = flags;
649 entry->data.assoc.assocs = g_memdup (list, sizeof (GstIndexAssociation) * n);
650 entry->data.assoc.nassocs = n;
652 gst_index_add_entry (index, entry);
658 * gst_index_add_association:
659 * @index: the index to add the entry to
660 * @id: the id of the index writer
661 * @flags: optinal flags for this entry
662 * @format: the format of the value
664 * @...: other format/value pairs or 0 to end the list
666 * Associate given format/value pairs with each other.
667 * Be sure to pass gint64 values to this functions varargs,
668 * you might want to use a gint64 cast to be sure.
670 * Returns: a pointer to the newly added entry in the index.
673 gst_index_add_association (GstIndex * index, gint id, GstAssocFlags flags,
674 GstFormat format, gint64 value, ...)
677 GstIndexEntry *entry;
678 GstIndexAssociation *list;
680 GstFormat cur_format;
683 g_return_val_if_fail (GST_IS_INDEX (index), NULL);
684 g_return_val_if_fail (format != 0, NULL);
686 if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
689 array = g_array_new (FALSE, FALSE, sizeof (GstIndexAssociation));
691 va_start (args, value);
696 GstIndexAssociation a;
699 cur_format = va_arg (args, GstFormat);
701 a.format = cur_format;
702 a.value = va_arg (args, gint64);
704 g_array_append_val (array, a);
709 list = (GstIndexAssociation *) g_array_free (array, FALSE);
711 entry = gst_index_add_associationv (index, id, flags, n_assocs, list);
718 * gst_index_add_object:
719 * @index: the index to add the object to
720 * @id: the id of the index writer
721 * @key: a key for the object
722 * @type: the GType of the object
723 * @object: a pointer to the object to add
725 * Add the given object to the index with the given key.
727 * Returns: a pointer to the newly added entry in the index.
730 gst_index_add_object (GstIndex * index, gint id, gchar * key,
731 GType type, gpointer object)
733 if (!GST_INDEX_IS_WRITABLE (index) || id == -1)
740 gst_index_compare_func (gconstpointer a, gconstpointer b, gpointer user_data)
742 return (gint) a - (gint) b;
746 * gst_index_get_assoc_entry:
747 * @index: the index to search
748 * @id: the id of the index writer
749 * @method: The lookup method to use
750 * @flags: Flags for the entry
751 * @format: the format of the value
752 * @value: the value to find
754 * Finds the given format/value in the index
756 * Returns: the entry associated with the value or NULL if the
757 * value was not found.
760 gst_index_get_assoc_entry (GstIndex * index, gint id,
761 GstIndexLookupMethod method, GstAssocFlags flags,
762 GstFormat format, gint64 value)
764 g_return_val_if_fail (GST_IS_INDEX (index), NULL);
769 return gst_index_get_assoc_entry_full (index, id, method, flags, format,
770 value, gst_index_compare_func, NULL);
774 * gst_index_get_assoc_entry_full:
775 * @index: the index to search
776 * @id: the id of the index writer
777 * @method: The lookup method to use
778 * @flags: Flags for the entry
779 * @format: the format of the value
780 * @value: the value to find
781 * @func: the function used to compare entries
782 * @user_data: user data passed to the compare function
784 * Finds the given format/value in the index with the given
785 * compare function and user_data.
787 * Returns: the entry associated with the value or NULL if the
788 * value was not found.
791 gst_index_get_assoc_entry_full (GstIndex * index, gint id,
792 GstIndexLookupMethod method, GstAssocFlags flags,
793 GstFormat format, gint64 value, GCompareDataFunc func, gpointer user_data)
795 GstIndexClass *iclass;
797 g_return_val_if_fail (GST_IS_INDEX (index), NULL);
802 iclass = GST_INDEX_GET_CLASS (index);
804 if (iclass->get_assoc_entry)
805 return iclass->get_assoc_entry (index, id, method, flags, format, value,
812 * gst_index_entry_assoc_map:
813 * @entry: the index to search
814 * @format: the format of the value the find
815 * @value: a pointer to store the value
817 * Gets alternative formats associated with the indexentry.
819 * Returns: TRUE if there was a value associated with the given
823 gst_index_entry_assoc_map (GstIndexEntry * entry,
824 GstFormat format, gint64 * value)
828 g_return_val_if_fail (entry != NULL, FALSE);
829 g_return_val_if_fail (value != NULL, FALSE);
831 for (i = 0; i < GST_INDEX_NASSOCS (entry); i++) {
832 if (GST_INDEX_ASSOC_FORMAT (entry, i) == format) {
833 *value = GST_INDEX_ASSOC_VALUE (entry, i);
841 static void gst_index_factory_class_init (GstIndexFactoryClass * klass);
842 static void gst_index_factory_init (GstIndexFactory * factory);
844 static GstPluginFeatureClass *factory_parent_class = NULL;
846 /* static guint gst_index_factory_signals[LAST_SIGNAL] = { 0 }; */
849 gst_index_factory_get_type (void)
851 static GType indexfactory_type = 0;
853 if (!indexfactory_type) {
854 static const GTypeInfo indexfactory_info = {
855 sizeof (GstIndexFactoryClass),
858 (GClassInitFunc) gst_index_factory_class_init,
861 sizeof (GstIndexFactory),
863 (GInstanceInitFunc) gst_index_factory_init,
867 indexfactory_type = g_type_register_static (GST_TYPE_PLUGIN_FEATURE,
868 "GstIndexFactory", &indexfactory_info, 0);
870 return indexfactory_type;
874 gst_index_factory_class_init (GstIndexFactoryClass * klass)
876 GObjectClass *gobject_class;
877 GstObjectClass *gstobject_class;
878 GstPluginFeatureClass *gstpluginfeature_class;
880 gobject_class = (GObjectClass *) klass;
881 gstobject_class = (GstObjectClass *) klass;
882 gstpluginfeature_class = (GstPluginFeatureClass *) klass;
884 factory_parent_class = g_type_class_ref (GST_TYPE_PLUGIN_FEATURE);
888 gst_index_factory_init (GstIndexFactory * factory)
893 * gst_index_factory_new:
894 * @name: name of indexfactory to create
895 * @longdesc: long description of indexfactory to create
896 * @type: the GType of the GstIndex element of this factory
898 * Create a new indexfactory with the given parameters
900 * Returns: a new #GstIndexFactory.
903 gst_index_factory_new (const gchar * name, const gchar * longdesc, GType type)
905 GstIndexFactory *factory;
907 g_return_val_if_fail (name != NULL, NULL);
908 factory = gst_index_factory_find (name);
910 factory = GST_INDEX_FACTORY (g_object_new (GST_TYPE_INDEX_FACTORY, NULL));
913 GST_PLUGIN_FEATURE_NAME (factory) = g_strdup (name);
914 if (factory->longdesc)
915 g_free (factory->longdesc);
916 factory->longdesc = g_strdup (longdesc);
917 factory->type = type;
923 * gst_index_factory_destroy:
924 * @factory: factory to destroy
926 * Removes the index from the global list.
929 gst_index_factory_destroy (GstIndexFactory * factory)
931 g_return_if_fail (factory != NULL);
933 /* we don't free the struct bacause someone might have a handle to it.. */
937 * gst_index_factory_find:
938 * @name: name of indexfactory to find
940 * Search for an indexfactory of the given name.
942 * Returns: #GstIndexFactory if found, NULL otherwise
945 gst_index_factory_find (const gchar * name)
947 GstPluginFeature *feature;
949 g_return_val_if_fail (name != NULL, NULL);
951 GST_DEBUG ("gstindex: find \"%s\"", name);
953 feature = gst_registry_pool_find_feature (name, GST_TYPE_INDEX_FACTORY);
955 return GST_INDEX_FACTORY (feature);
961 * gst_index_factory_create:
962 * @factory: the factory used to create the instance
964 * Create a new #GstIndex instance from the
965 * given indexfactory.
967 * Returns: A new #GstIndex instance.
970 gst_index_factory_create (GstIndexFactory * factory)
972 GstIndex *new = NULL;
974 g_return_val_if_fail (factory != NULL, NULL);
976 if (gst_plugin_feature_ensure_loaded (GST_PLUGIN_FEATURE (factory))) {
977 g_return_val_if_fail (factory->type != 0, NULL);
979 new = GST_INDEX (g_object_new (factory->type, NULL));
986 * gst_index_factory_make:
987 * @name: the name of the factory used to create the instance
989 * Create a new #GstIndex instance from the
990 * indexfactory with the given name.
992 * Returns: A new #GstIndex instance.
995 gst_index_factory_make (const gchar * name)
997 GstIndexFactory *factory;
999 g_return_val_if_fail (name != NULL, NULL);
1001 factory = gst_index_factory_find (name);
1003 if (factory == NULL)
1006 return gst_index_factory_create (factory);