gst/gsttypefind.c

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttypefind.h: typefinding subsystem
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #include "gstinfo.h"
  23 #include "gsttypefind.h"
  24 #include "gstregistrypool.h"
  25
  26 GST_DEBUG_CATEGORY_STATIC (gst_type_find_debug);
  27 #define GST_CAT_DEFAULT gst_type_find_debug
  28
  29 static void             gst_type_find_factory_class_init        (gpointer               g_class,
  30                                                                  gpointer               class_data);
  31 static void             gst_type_find_factory_init              (GTypeInstance *        instance,
  32                                                                  gpointer               g_class);
  33 static void             gst_type_find_factory_dispose           (GObject *              object);
  34
  35 static void             gst_type_find_factory_unload_thyself    (GstPluginFeature *     feature);
  36
  37 static void             gst_type_find_load_plugin               (GstTypeFind *          find,
  38                                                                  gpointer               data);
  39
  40 static GstPluginFeatureClass *parent_class = NULL;
  41
  42 GType
  43 gst_type_find_factory_get_type (void)
  44 {
  45   static GType typefind_type = 0;
  46
  47   if (!typefind_type) {
  48     static const GTypeInfo typefind_info = {
  49       sizeof (GstTypeFindFactoryClass),
  50       NULL,
  51       NULL,
  52       gst_type_find_factory_class_init,
  53       NULL,
  54       NULL,
  55       sizeof (GstTypeFindFactory),
  56       0,
  57       gst_type_find_factory_init,
  58       NULL
  59     };
  60     typefind_type = g_type_register_static (GST_TYPE_PLUGIN_FEATURE,
  61                                             "GstTypeFindFactory",
  62                                             &typefind_info, 0);
  63     GST_DEBUG_CATEGORY_INIT (gst_type_find_debug, "GST_TYPEFIND",
  64                              GST_DEBUG_FG_GREEN, "typefinding subsystem");
  65   }
  66
  67   return typefind_type;
  68 }
  69 static void
  70 gst_type_find_factory_class_init (gpointer g_class, gpointer class_data)
  71 {
  72   GstPluginFeatureClass *gstpluginfeature_class = GST_PLUGIN_FEATURE_CLASS (g_class);
  73   GObjectClass *object_class = G_OBJECT_CLASS (g_class);
  74
  75   parent_class = g_type_class_peek_parent (g_class);
  76
  77   object_class->dispose = gst_type_find_factory_dispose;
  78
  79   gstpluginfeature_class->unload_thyself = GST_DEBUG_FUNCPTR (gst_type_find_factory_unload_thyself);
  80 }
  81 static void
  82 gst_type_find_factory_init (GTypeInstance *instance, gpointer g_class)
  83 {
  84   GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (instance);
  85
  86   factory->user_data = factory;
  87   factory->function = gst_type_find_load_plugin;
  88 }
  89 static void
  90 gst_type_find_factory_dispose (GObject *object)
  91 {
  92   GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (object);
  93
  94   if (factory->caps) {
  95     gst_caps_free (factory->caps);
  96     factory->caps = NULL;
  97   }
  98   if (factory->extensions) {
  99     g_strfreev (factory->extensions);
 100     factory->extensions = NULL;
 101   }
 102 }
 103 static void
 104 gst_type_find_factory_unload_thyself (GstPluginFeature *feature)
 105 {
 106   GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (feature);
 107
 108   factory->function = gst_type_find_load_plugin;
 109   factory->user_data = factory;
 110 }
 111 static void
 112 gst_type_find_load_plugin (GstTypeFind *find, gpointer data)
 113 {
 114   GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (data);
 115
 116   GST_DEBUG_OBJECT (factory, "need to load typefind function %s",  GST_PLUGIN_FEATURE_NAME (factory));
 117
 118   if (gst_plugin_feature_ensure_loaded (GST_PLUGIN_FEATURE (factory))) {
 119     if (factory->function == gst_type_find_load_plugin) {
 120       /* looks like we didn't get a real typefind function */
 121       g_warning ("could not load valid typefind function for feature '%s'\n", GST_PLUGIN_FEATURE_NAME (factory));
 122     } else {
 123       g_assert (factory->function);
 124       gst_type_find_factory_call_function (factory, find);
 125     }
 126   }
 127 }
 128 /**
 129  * gst_type_find_factory_get_list:
 130  *
 131  * Gets the list of all registered typefind factories. You must free the
 132  * list using g_list_free.
 133  *
 134  * Returns: the list of all registered typefind factories
 135  */
 136 GList *
 137 gst_type_find_factory_get_list (void)
 138 {
 139   return gst_registry_pool_feature_list (GST_TYPE_TYPE_FIND_FACTORY);
 140 }
 141 /**
 142  * gst_type_find_factory_get_caps:
 143  * @factory: a factory
 144  *
 145  * Gets the caps associated with a typefind factory.
 146  *
 147  * Returns: the #GstCaps associated with this factory
 148  */
 149 const GstCaps *
 150 gst_type_find_factory_get_caps (const GstTypeFindFactory *factory)
 151 {
 152   g_return_val_if_fail (GST_IS_TYPE_FIND_FACTORY (factory), NULL);
 153
 154   return factory->caps;
 155 }
 156 /**
 157  * gst_type_find_factory_get_extensions:
 158  * @factory: a factory
 159  *
 160  * Gets the extensions associated with a typefind factory. The returned
 161  * array should not be changed. If you need to change stuff in it, you should
 162  * copy it using g_stdupv().  This function may return NULL to indicate
 163  * a 0-length list.
 164  *
 165  * Returns: a NULL-terminated array of extensions associated with this factory
 166  */
 167 gchar **
 168 gst_type_find_factory_get_extensions (const GstTypeFindFactory *factory)
 169 {
 170   g_return_val_if_fail (GST_IS_TYPE_FIND_FACTORY (factory), NULL);
 171
 172   return factory->extensions;
 173 }
 174 /**
 175  * gst_type_find_factory_call_function:
 176  * @factory: a factory
 177  * @find: a properly setup #GstTypeFind entry. The get_data and suggest_type
 178  *        members must be set.
 179  *
 180  * Calls the typefinding function associated with this factory.
 181  */
 182 void
 183 gst_type_find_factory_call_function (const GstTypeFindFactory *factory, GstTypeFind *find)
 184 {
 185   g_return_if_fail (GST_IS_TYPE_FIND_FACTORY (factory));
 186   g_return_if_fail (find != NULL);
 187   g_return_if_fail (find->peek != NULL);
 188   g_return_if_fail (find->suggest != NULL);
 189
 190   /* should never happen */
 191   g_assert (factory->function != NULL);
 192
 193   factory->function (find, factory->user_data);
 194 }
 195 /**
 196  * gst_type_find_register:
 197  * @plugin: the GstPlugin to register with
 198  * @name: the name for registering
 199  * @rank: rank (or importance) of this typefind function
 200  * @func: the function to use for typefinding
 201  * @extensions: optional extensions that could belong to this type
 202  * @possible_caps: optionally the caps that could be returned when typefinding succeeds
 203  * @data: optional user data. This user data must be available until the plugin
 204  *        is unloaded.
 205  *
 206  * Registers a new typefind function to be used for typefinding. After
 207  * registering this function will be available for typefinding.
 208  * This function is typically called during an element's plugin initialization.
 209  *
 210  * Returns: TRUE on success, FALSE otherwise
 211  */
 212 gboolean
 213 gst_type_find_register (GstPlugin *plugin, const gchar *name, guint rank,
 214                         GstTypeFindFunction func, gchar **extensions,
 215                         const GstCaps *possible_caps, gpointer data)
 216 {
 217   GstTypeFindFactory *factory;
 218
 219   g_return_val_if_fail (plugin != NULL, FALSE);
 220   g_return_val_if_fail (name != NULL, FALSE);
 221   g_return_val_if_fail (func != NULL, FALSE);
 222
 223   GST_INFO ("registering typefind function for %s", name);
 224   factory = GST_TYPE_FIND_FACTORY (gst_registry_pool_find_feature (name, GST_TYPE_TYPE_FIND_FACTORY));
 225   if (!factory) {
 226     factory = g_object_new (GST_TYPE_TYPE_FIND_FACTORY, NULL);
 227     GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
 228     g_assert (GST_IS_TYPE_FIND_FACTORY (factory));
 229     gst_plugin_feature_set_name (GST_PLUGIN_FEATURE (factory), name);
 230   } else {
 231     GST_DEBUG_OBJECT (factory, "using old typefind factory for %s", name);
 232   }
 233
 234   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE (factory), rank);
 235   if (factory->extensions)
 236     g_strfreev (factory->extensions);
 237
 238   factory->extensions = g_strdupv (extensions);
 239   gst_caps_replace (&factory->caps, gst_caps_copy(possible_caps));
 240   factory->function = func;
 241   factory->user_data = data;
 242
 243   gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
 244
 245   return TRUE;
 246 }
 247
 248 /*** typefind function interface **********************************************/
 249
 250 /**
 251  * gst_type_find_peek:
 252  * @find: the find object the function was called with
 253  * @offset: the offset
 254  * @size: the number of bytes to return
 255  *
 256  * Returns size bytes of the stream to identify beginning at offset. If offset
 257  * is a positive number, the offset is relative to the beginning of the stream,
 258  * if offset is a negative number the offset is relative to the end of the
 259  * stream. The returned memory is valid until the typefinding function returns
 260  * and must not be freed.
 261  * If NULL is returned, that data is not available.
 262  *
 263  * Returns: the requested data or NULL if that data is not available.
 264  */
 265 guint8 *
 266 gst_type_find_peek (GstTypeFind *find, gint64 offset, guint size)
 267 {
 268   g_return_val_if_fail (find->peek != NULL, NULL);
 269
 270   return find->peek (find->data, offset, size);
 271 }
 272 /**
 273  * gst_type_find_suggest:
 274  * @find: the find object the function was called with
 275  * @probability: the probability in percent that the suggestion is right
 276  * @caps: the fixed caps to suggest
 277  *
 278  * If a typefind function calls this function it suggests the caps with the
 279  * given probability. A typefind function may supply different suggestions
 280  * in one call.
 281  * It is up to the caller of the typefind function to interpret these values.
 282  */
 283 void
 284 gst_type_find_suggest (GstTypeFind *find, guint probability, const GstCaps *caps)
 285 {
 286   g_return_if_fail (find->suggest != NULL);
 287   g_return_if_fail (probability <= 100);
 288   g_return_if_fail (caps != NULL);
 289   g_return_if_fail (gst_caps_is_fixed (caps));
 290
 291   find->suggest (find->data, probability, caps);
 292 }
 293 /**
 294  * gst_type_find_get_length:
 295  * @find: the find object the function was called with
 296  *
 297  * Get the length of the data stream.
 298  *
 299  * Returns: the length of the data stream or 0 if it is not available.
 300  */
 301 guint64
 302 gst_type_find_get_length (GstTypeFind *find)
 303 {
 304   if (find->get_length == NULL)
 305     return 0;
 306
 307   return find->get_length(find->data);
 308 }
 309