2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttypefind.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.
24 * @short_description: Stream type detection
26 * The following functions allow you to detect the media type of an unknown
30 #include "gst_private.h"
32 #include "gsttypefind.h"
33 #include "gstregistry.h"
34 #include "gsttypefindfactory.h"
36 GST_DEBUG_CATEGORY_EXTERN (type_find_debug);
37 #define GST_CAT_DEFAULT type_find_debug
39 G_DEFINE_POINTER_TYPE (GstTypeFind, gst_type_find);
42 * gst_type_find_register:
43 * @plugin: (allow-none): A #GstPlugin, or %NULL for a static typefind function
44 * @name: The name for registering
45 * @rank: The rank (or importance) of this typefind function
46 * @func: The #GstTypeFindFunction to use
47 * @extensions: (allow-none): Optional comma-separated list of extensions
48 * that could belong to this type
49 * @possible_caps: Optionally the caps that could be returned when typefinding
51 * @data: Optional user data. This user data must be available until the plugin
53 * @data_notify: a #GDestroyNotify that will be called on @data when the plugin
56 * Registers a new typefind function to be used for typefinding. After
57 * registering this function will be available for typefinding.
58 * This function is typically called during an element's plugin initialization.
60 * Returns: %TRUE on success, %FALSE otherwise
63 gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank,
64 GstTypeFindFunction func, const gchar * extensions,
65 GstCaps * possible_caps, gpointer data, GDestroyNotify data_notify)
67 GstTypeFindFactory *factory;
69 g_return_val_if_fail (name != NULL, FALSE);
71 GST_INFO ("registering typefind function for %s", name);
73 factory = g_object_newv (GST_TYPE_TYPE_FIND_FACTORY, 0, NULL);
74 GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
76 gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
77 gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
80 factory->extensions = g_strsplit (extensions, ",", -1);
82 gst_caps_replace (&factory->caps, possible_caps);
83 factory->function = func;
84 factory->user_data = data;
85 factory->user_data_notify = data_notify;
86 if (plugin && plugin->desc.name) {
87 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name; /* interned string */
88 GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
89 g_object_add_weak_pointer ((GObject *) plugin,
90 (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
92 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
93 GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
95 GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
97 gst_registry_add_feature (gst_registry_get (),
98 GST_PLUGIN_FEATURE_CAST (factory));
103 /*** typefind function interface **********************************************/
106 * gst_type_find_peek:
107 * @find: The #GstTypeFind object the function was called with
108 * @offset: The offset
109 * @size: The number of bytes to return
111 * Returns the @size bytes of the stream to identify beginning at offset. If
112 * offset is a positive number, the offset is relative to the beginning of the
113 * stream, if offset is a negative number the offset is relative to the end of
114 * the stream. The returned memory is valid until the typefinding function
115 * returns and must not be freed.
117 * Returns: (transfer none) (array length=size) (nullable): the
118 * requested data, or %NULL if that data is not available.
121 gst_type_find_peek (GstTypeFind * find, gint64 offset, guint size)
123 g_return_val_if_fail (find->peek != NULL, NULL);
125 return find->peek (find->data, offset, size);
129 * gst_type_find_suggest:
130 * @find: The #GstTypeFind object the function was called with
131 * @probability: The probability in percent that the suggestion is right
132 * @caps: The fixed #GstCaps to suggest
134 * If a #GstTypeFindFunction calls this function it suggests the caps with the
135 * given probability. A #GstTypeFindFunction may supply different suggestions
137 * It is up to the caller of the #GstTypeFindFunction to interpret these values.
140 gst_type_find_suggest (GstTypeFind * find, guint probability, GstCaps * caps)
142 g_return_if_fail (find->suggest != NULL);
143 g_return_if_fail (probability <= 100);
144 g_return_if_fail (caps != NULL);
145 g_return_if_fail (gst_caps_is_fixed (caps));
147 find->suggest (find->data, probability, caps);
151 * gst_type_find_suggest_simple:
152 * @find: The #GstTypeFind object the function was called with
153 * @probability: The probability in percent that the suggestion is right
154 * @media_type: the media type of the suggested caps
155 * @fieldname: (allow-none): first field of the suggested caps, or %NULL
156 * @...: additional arguments to the suggested caps in the same format as the
157 * arguments passed to gst_structure_new() (ie. triplets of field name,
158 * field GType and field value)
160 * If a #GstTypeFindFunction calls this function it suggests the caps with the
161 * given probability. A #GstTypeFindFunction may supply different suggestions
162 * in one call. It is up to the caller of the #GstTypeFindFunction to interpret
165 * This function is similar to gst_type_find_suggest(), only that instead of
166 * passing a #GstCaps argument you can create the caps on the fly in the same
167 * way as you can with gst_caps_new_simple().
169 * Make sure you terminate the list of arguments with a %NULL argument and that
170 * the values passed have the correct type (in terms of width in bytes when
171 * passed to the vararg function - this applies particularly to gdouble and
172 * guint64 arguments).
175 gst_type_find_suggest_simple (GstTypeFind * find, guint probability,
176 const char *media_type, const char *fieldname, ...)
178 GstStructure *structure;
182 g_return_if_fail (find->suggest != NULL);
183 g_return_if_fail (probability <= 100);
184 g_return_if_fail (media_type != NULL);
186 caps = gst_caps_new_empty ();
188 va_start (var_args, fieldname);
189 structure = gst_structure_new_valist (media_type, fieldname, var_args);
192 gst_caps_append_structure (caps, structure);
193 g_return_if_fail (gst_caps_is_fixed (caps));
195 find->suggest (find->data, probability, caps);
196 gst_caps_unref (caps);
200 * gst_type_find_get_length:
201 * @find: The #GstTypeFind the function was called with
203 * Get the length of the data stream.
205 * Returns: The length of the data stream, or 0 if it is not available.
208 gst_type_find_get_length (GstTypeFind * find)
210 if (find->get_length == NULL)
213 return find->get_length (find->data);