2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttypefindfactory.c: typefinding subsystem
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * SECTION:gsttypefindfactory
24 * @short_description: Information about registered typefind functions
26 * These functions allow querying informations about registered typefind
27 * functions. How to create and register these functions is described in
28 * the section <link linkend="gstreamer-Writing-typefind-functions">
29 * "Writing typefind functions"</link>.
31 * The following example shows how to write a very simple typefinder that
32 * identifies the given data. You can get quite a bit more complicated than
42 * my_peek (gpointer data, gint64 offset, guint size)
44 * MyTypeFind *find = (MyTypeFind *) data;
45 * if (offset >= 0 && offset + size <= find->size) {
46 * return find->data + offset;
51 * my_suggest (gpointer data, guint probability, GstCaps *caps)
53 * MyTypeFind *find = (MyTypeFind *) data;
54 * if (probability > find->probability) {
55 * find->probability = probability;
56 * gst_caps_replace (&find->caps, caps);
60 * find_type (guint8 *data, guint size)
62 * GList *walk, *type_list;
63 * MyTypeFind find = {data, size, 0, NULL};
64 * GstTypeFind gst_find = {my_peek, my_suggest, &find, };
65 * walk = type_list = gst_type_find_factory_get_list ();
67 * GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data);
68 * walk = g_list_next (walk)
69 * gst_type_find_factory_call_function (factory, &gst_find);
71 * g_list_free (type_list);
77 #include "gst_private.h"
79 #include "gsttypefind.h"
80 #include "gsttypefindfactory.h"
81 #include "gstregistry.h"
83 GST_DEBUG_CATEGORY (type_find_debug);
84 #define GST_CAT_DEFAULT type_find_debug
86 static void gst_type_find_factory_dispose (GObject * object);
90 GST_DEBUG_CATEGORY_INIT (type_find_debug, "GST_TYPEFIND", \
91 GST_DEBUG_FG_GREEN, "typefinding subsystem"); \
94 #define gst_type_find_factory_parent_class parent_class
95 G_DEFINE_TYPE_WITH_CODE (GstTypeFindFactory, gst_type_find_factory,
96 GST_TYPE_PLUGIN_FEATURE, _do_init);
99 gst_type_find_factory_class_init (GstTypeFindFactoryClass * klass)
101 GObjectClass *object_class = G_OBJECT_CLASS (klass);
103 object_class->dispose = gst_type_find_factory_dispose;
107 gst_type_find_factory_init (GstTypeFindFactory * factory)
109 factory->user_data = factory;
110 factory->user_data_notify = NULL;
114 gst_type_find_factory_dispose (GObject * object)
116 GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (object);
119 gst_caps_unref (factory->caps);
120 factory->caps = NULL;
122 if (factory->extensions) {
123 g_strfreev (factory->extensions);
124 factory->extensions = NULL;
126 if (factory->user_data_notify && factory->user_data) {
127 factory->user_data_notify (factory->user_data);
128 factory->user_data = NULL;
131 G_OBJECT_CLASS (parent_class)->dispose (object);
135 * gst_type_find_factory_get_list:
137 * Gets the list of all registered typefind factories. You must free the
138 * list using gst_plugin_feature_list_free().
140 * The returned factories are sorted by highest rank first, and then by
143 * Free-function: gst_plugin_feature_list_free
145 * Returns: (transfer full) (element-type Gst.TypeFindFactory): the list of all
146 * registered #GstTypeFindFactory.
149 gst_type_find_factory_get_list (void)
151 return gst_registry_get_feature_list (gst_registry_get (),
152 GST_TYPE_TYPE_FIND_FACTORY);
156 * gst_type_find_factory_get_caps:
157 * @factory: A #GstTypeFindFactory
159 * Gets the #GstCaps associated with a typefind factory.
161 * Returns: (transfer none): the #GstCaps associated with this factory
164 gst_type_find_factory_get_caps (GstTypeFindFactory * factory)
166 g_return_val_if_fail (GST_IS_TYPE_FIND_FACTORY (factory), NULL);
168 return factory->caps;
172 * gst_type_find_factory_get_extensions:
173 * @factory: A #GstTypeFindFactory
175 * Gets the extensions associated with a #GstTypeFindFactory. The returned
176 * array should not be changed. If you need to change stuff in it, you should
177 * copy it using g_strdupv(). This function may return %NULL to indicate
180 * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): a
181 * %NULL-terminated array of extensions associated with this factory
184 gst_type_find_factory_get_extensions (GstTypeFindFactory * factory)
186 g_return_val_if_fail (GST_IS_TYPE_FIND_FACTORY (factory), NULL);
188 return (const gchar * const *) factory->extensions;
192 * gst_type_find_factory_call_function:
193 * @factory: A #GstTypeFindFactory
194 * @find: (transfer none): a properly setup #GstTypeFind entry. The get_data
195 * and suggest_type members must be set.
197 * Calls the #GstTypeFindFunction associated with this factory.
200 gst_type_find_factory_call_function (GstTypeFindFactory * factory,
203 GstTypeFindFactory *new_factory;
205 g_return_if_fail (GST_IS_TYPE_FIND_FACTORY (factory));
206 g_return_if_fail (find != NULL);
207 g_return_if_fail (find->peek != NULL);
208 g_return_if_fail (find->suggest != NULL);
211 GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
214 if (new_factory->function)
215 new_factory->function (find, new_factory->user_data);
216 gst_object_unref (new_factory);
221 * gst_type_find_factory_has_function:
222 * @factory: A #GstTypeFindFactory
224 * Check whether the factory has a typefind function. Typefind factories
225 * without typefind functions are a last-effort fallback mechanism to
226 * e.g. assume a certain media type based on the file extension.
228 * Returns: %TRUE if the factory has a typefind functions set, otherwise %FALSE
231 gst_type_find_factory_has_function (GstTypeFindFactory * factory)
233 g_return_val_if_fail (GST_IS_TYPE_FIND_FACTORY (factory), FALSE);
235 return (factory->function != NULL);