gst/gsttypefind.c

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttypefind.c: 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 /**
  23  * SECTION:gsttypefind
  24  * @short_description: Stream type detection
  25  *
  26  * The following functions allow you to detect the media type of an unknown
  27  * stream.
  28  *
  29  * Last reviewed on 2005-11-09 (0.9.4)
  30  */
  31
  32 #include "gst_private.h"
  33 #include "gstinfo.h"
  34 #include "gsttypefind.h"
  35 #include "gstregistry.h"
  36 #include "gsttypefindfactory.h"
  37
  38 GST_DEBUG_CATEGORY_EXTERN (gst_type_find_debug);
  39 #define GST_CAT_DEFAULT gst_type_find_debug
  40
  41 /**
  42  * gst_type_find_register:
  43  * @plugin: A #GstPlugin.
  44  * @name: The name for registering
  45  * @rank: The rank (or importance) of this typefind function
  46  * @func: The #GstTypeFindFunction to use
  47  * @extensions: Optional extensions that could belong to this type
  48  * @possible_caps: Optionally the caps that could be returned when typefinding succeeds
  49  * @data: Optional user data. This user data must be available until the plugin
  50  *        is unloaded.
  51  * @data_notify: a #GDestroyNotify that will be called on @data when the plugin
  52  *        is unloaded.
  53  *
  54  * Registers a new typefind function to be used for typefinding. After
  55  * registering this function will be available for typefinding.
  56  * This function is typically called during an element's plugin initialization.
  57  *
  58  * Returns: TRUE on success, FALSE otherwise
  59  */
  60 gboolean
  61 gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank,
  62     GstTypeFindFunction func, gchar ** extensions,
  63     const GstCaps * possible_caps, gpointer data, GDestroyNotify data_notify)
  64 {
  65   GstTypeFindFactory *factory;
  66
  67   g_return_val_if_fail (plugin != NULL, FALSE);
  68   g_return_val_if_fail (name != NULL, FALSE);
  69   g_return_val_if_fail (func != NULL, FALSE);
  70
  71   GST_INFO ("registering typefind function for %s", name);
  72
  73   factory = g_object_new (GST_TYPE_TYPE_FIND_FACTORY, NULL);
  74   GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
  75   g_assert (GST_IS_TYPE_FIND_FACTORY (factory));
  76   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE (factory), name);
  77
  78   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE (factory), rank);
  79   if (factory->extensions)
  80     g_strfreev (factory->extensions);
  81
  82   factory->extensions = g_strdupv (extensions);
  83   gst_caps_replace (&factory->caps, (GstCaps *) possible_caps);
  84   factory->function = func;
  85   factory->user_data = data;
  86   factory->user_data_notify = data_notify;
  87   GST_PLUGIN_FEATURE (factory)->plugin_name = g_strdup (plugin->desc.name);
  88   GST_PLUGIN_FEATURE (factory)->loaded = TRUE;
  89
  90   gst_registry_add_feature (gst_registry_get_default (),
  91       GST_PLUGIN_FEATURE (factory));
  92
  93   return TRUE;
  94 }
  95
  96 /*** typefind function interface **********************************************/
  97
  98 /**
  99  * gst_type_find_peek:
 100  * @find: The #GstTypeFind object the function was called with
 101  * @offset: The offset
 102  * @size: The number of bytes to return
 103  *
 104  * Returns the @size bytes of the stream to identify beginning at offset. If
 105  * offset is a positive number, the offset is relative to the beginning of the
 106  * stream, if offset is a negative number the offset is relative to the end of
 107  * the stream. The returned memory is valid until the typefinding function
 108  * returns and must not be freed.
 109  *
 110  * Returns: the requested data, or NULL if that data is not available.
 111  */
 112 guint8 *
 113 gst_type_find_peek (GstTypeFind * find, gint64 offset, guint size)
 114 {
 115   g_return_val_if_fail (find->peek != NULL, NULL);
 116
 117   return find->peek (find->data, offset, size);
 118 }
 119
 120 /**
 121  * gst_type_find_suggest:
 122  * @find: The #GstTypeFind object the function was called with
 123  * @probability: The probability in percent that the suggestion is right
 124  * @caps: The fixed #GstCaps to suggest
 125  *
 126  * If a #GstTypeFindFunction calls this function it suggests the caps with the
 127  * given probability. A #GstTypeFindFunction may supply different suggestions
 128  * in one call.
 129  * It is up to the caller of the #GstTypeFindFunction to interpret these values.
 130  */
 131 void
 132 gst_type_find_suggest (GstTypeFind * find, guint probability,
 133     const GstCaps * caps)
 134 {
 135   g_return_if_fail (find->suggest != NULL);
 136   g_return_if_fail (probability <= 100);
 137   g_return_if_fail (caps != NULL);
 138   g_return_if_fail (gst_caps_is_fixed (caps));
 139
 140   find->suggest (find->data, probability, caps);
 141 }
 142
 143 /**
 144  * gst_type_find_get_length:
 145  * @find: The #GstTypeFind the function was called with
 146  *
 147  * Get the length of the data stream.
 148  *
 149  * Returns: The length of the data stream, or 0 if it is not available.
 150  */
 151 guint64
 152 gst_type_find_get_length (GstTypeFind * find)
 153 {
 154   if (find->get_length == NULL)
 155     return 0;
 156
 157   return find->get_length (find->data);
 158 }