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., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Stream type detection
26 * The following functions allow you to detect the media type of an unknown
29 * Last reviewed on 2005-11-09 (0.9.4)
32 #include "gst_private.h"
34 #include "gsttypefind.h"
35 #include "gstregistry.h"
36 #include "gsttypefindfactory.h"
38 GST_DEBUG_CATEGORY_EXTERN (type_find_debug);
39 #define GST_CAT_DEFAULT type_find_debug
42 gst_type_find_get_type (void)
44 static GType typefind_type = 0;
46 if (G_UNLIKELY (typefind_type == 0)) {
47 typefind_type = g_pointer_type_register_static ("GstTypeFind");
53 * gst_type_find_register:
54 * @plugin: A #GstPlugin, or NULL for a static typefind function (note that
55 * passing NULL only works in GStreamer 0.10.16 and later)
56 * @name: The name for registering
57 * @rank: The rank (or importance) of this typefind function
58 * @func: The #GstTypeFindFunction to use
59 * @extensions: Optional extensions that could belong to this type
60 * @possible_caps: Optionally the caps that could be returned when typefinding
62 * @data: Optional user data. This user data must be available until the plugin
64 * @data_notify: a #GDestroyNotify that will be called on @data when the plugin
67 * Registers a new typefind function to be used for typefinding. After
68 * registering this function will be available for typefinding.
69 * This function is typically called during an element's plugin initialization.
71 * Returns: TRUE on success, FALSE otherwise
74 gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank,
75 GstTypeFindFunction func, gchar ** extensions,
76 const GstCaps * possible_caps, gpointer data, GDestroyNotify data_notify)
78 GstTypeFindFactory *factory;
80 g_return_val_if_fail (name != NULL, FALSE);
82 GST_INFO ("registering typefind function for %s", name);
84 factory = g_object_newv (GST_TYPE_TYPE_FIND_FACTORY, 0, NULL);
85 GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
86 g_assert (GST_IS_TYPE_FIND_FACTORY (factory));
88 gst_plugin_feature_set_name (GST_PLUGIN_FEATURE (factory), name);
89 gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE (factory), rank);
91 if (factory->extensions)
92 g_strfreev (factory->extensions);
93 factory->extensions = g_strdupv (extensions);
95 gst_caps_replace (&factory->caps, (GstCaps *) possible_caps);
96 factory->function = func;
97 factory->user_data = data;
98 factory->user_data_notify = data_notify;
99 if (plugin && plugin->desc.name) {
100 GST_PLUGIN_FEATURE (factory)->plugin_name = plugin->desc.name; /* interned string */
102 GST_PLUGIN_FEATURE (factory)->plugin_name = "NULL";
104 GST_PLUGIN_FEATURE (factory)->loaded = TRUE;
106 gst_registry_add_feature (gst_registry_get_default (),
107 GST_PLUGIN_FEATURE (factory));
112 /*** typefind function interface **********************************************/
115 * gst_type_find_peek:
116 * @find: The #GstTypeFind object the function was called with
117 * @offset: The offset
118 * @size: The number of bytes to return
120 * Returns the @size bytes of the stream to identify beginning at offset. If
121 * offset is a positive number, the offset is relative to the beginning of the
122 * stream, if offset is a negative number the offset is relative to the end of
123 * the stream. The returned memory is valid until the typefinding function
124 * returns and must not be freed.
126 * Returns: the requested data, or NULL if that data is not available.
129 gst_type_find_peek (GstTypeFind * find, gint64 offset, guint size)
131 g_return_val_if_fail (find->peek != NULL, NULL);
133 return find->peek (find->data, offset, size);
137 * gst_type_find_suggest:
138 * @find: The #GstTypeFind object the function was called with
139 * @probability: The probability in percent that the suggestion is right
140 * @caps: The fixed #GstCaps to suggest
142 * If a #GstTypeFindFunction calls this function it suggests the caps with the
143 * given probability. A #GstTypeFindFunction may supply different suggestions
145 * It is up to the caller of the #GstTypeFindFunction to interpret these values.
148 gst_type_find_suggest (GstTypeFind * find, guint probability,
149 const GstCaps * caps)
151 g_return_if_fail (find->suggest != NULL);
152 g_return_if_fail (probability <= 100);
153 g_return_if_fail (caps != NULL);
154 g_return_if_fail (gst_caps_is_fixed (caps));
156 find->suggest (find->data, probability, caps);
160 * gst_type_find_suggest_simple:
161 * @find: The #GstTypeFind object the function was called with
162 * @probability: The probability in percent that the suggestion is right
163 * @media_type: the media type of the suggested caps
164 * @fieldname: first field of the suggested caps, or NULL
165 * @...: additional arguments to the suggested caps in the same format as the
166 * arguments passed to gst_structure_new() (ie. triplets of field name,
167 * field GType and field value)
169 * If a #GstTypeFindFunction calls this function it suggests the caps with the
170 * given probability. A #GstTypeFindFunction may supply different suggestions
171 * in one call. It is up to the caller of the #GstTypeFindFunction to interpret
174 * This function is similar to gst_type_find_suggest(), only that instead of
175 * passing a #GstCaps argument you can create the caps on the fly in the same
176 * way as you can with gst_caps_new_simple().
178 * Make sure you terminate the list of arguments with a NULL argument and that
179 * the values passed have the correct type (in terms of width in bytes when
180 * passed to the vararg function - this applies particularly to gdouble and
181 * guint64 arguments).
186 gst_type_find_suggest_simple (GstTypeFind * find, guint probability,
187 const char *media_type, const char *fieldname, ...)
189 GstStructure *structure;
193 g_return_if_fail (find->suggest != NULL);
194 g_return_if_fail (probability <= 100);
195 g_return_if_fail (media_type != NULL);
197 caps = gst_caps_new_empty ();
199 va_start (var_args, fieldname);
200 structure = gst_structure_new_valist (media_type, fieldname, var_args);
203 gst_caps_append_structure (caps, structure);
204 g_return_if_fail (gst_caps_is_fixed (caps));
206 find->suggest (find->data, probability, caps);
207 gst_caps_unref (caps);
211 * gst_type_find_get_length:
212 * @find: The #GstTypeFind the function was called with
214 * Get the length of the data stream.
216 * Returns: The length of the data stream, or 0 if it is not available.
219 gst_type_find_get_length (GstTypeFind * find)
221 if (find->get_length == NULL)
224 return find->get_length (find->data);