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 (type_find_debug);
  39 #define GST_CAT_DEFAULT type_find_debug
  40
  41 GType
  42 gst_type_find_get_type (void)
  43 {
  44   static GType typefind_type = 0;
  45
  46   if (G_UNLIKELY (typefind_type == 0)) {
  47     typefind_type = g_pointer_type_register_static ("GstTypeFind");
  48   }
  49   return typefind_type;
  50 }
  51
  52 /**
  53  * gst_type_find_register:
  54  * @plugin: A #GstPlugin.
  55  * @name: The name for registering
  56  * @rank: The rank (or importance) of this typefind function
  57  * @func: The #GstTypeFindFunction to use
  58  * @extensions: Optional extensions that could belong to this type
  59  * @possible_caps: Optionally the caps that could be returned when typefinding
  60  *                 succeeds
  61  * @data: Optional user data. This user data must be available until the plugin
  62  *        is unloaded.
  63  * @data_notify: a #GDestroyNotify that will be called on @data when the plugin
  64  *        is unloaded.
  65  *
  66  * Registers a new typefind function to be used for typefinding. After
  67  * registering this function will be available for typefinding.
  68  * This function is typically called during an element's plugin initialization.
  69  *
  70  * Returns: TRUE on success, FALSE otherwise
  71  */
  72 gboolean
  73 gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank,
  74     GstTypeFindFunction func, gchar ** extensions,
  75     const GstCaps * possible_caps, gpointer data, GDestroyNotify data_notify)
  76 {
  77   GstTypeFindFactory *factory;
  78
  79   g_return_val_if_fail (plugin != NULL, FALSE);
  80   g_return_val_if_fail (name != NULL, FALSE);
  81   g_return_val_if_fail (func != NULL, FALSE);
  82
  83   GST_INFO ("registering typefind function for %s", name);
  84
  85   factory = g_object_new (GST_TYPE_TYPE_FIND_FACTORY, NULL);
  86   GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
  87   g_assert (GST_IS_TYPE_FIND_FACTORY (factory));
  88   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE (factory), name);
  89
  90   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE (factory), rank);
  91   if (factory->extensions)
  92     g_strfreev (factory->extensions);
  93
  94   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   GST_PLUGIN_FEATURE (factory)->plugin_name = plugin->desc.name;        /* interned string */
 100   GST_PLUGIN_FEATURE (factory)->loaded = TRUE;
 101
 102   gst_registry_add_feature (gst_registry_get_default (),
 103       GST_PLUGIN_FEATURE (factory));
 104
 105   return TRUE;
 106 }
 107
 108 /*** typefind function interface **********************************************/
 109
 110 /**
 111  * gst_type_find_peek:
 112  * @find: The #GstTypeFind object the function was called with
 113  * @offset: The offset
 114  * @size: The number of bytes to return
 115  *
 116  * Returns the @size bytes of the stream to identify beginning at offset. If
 117  * offset is a positive number, the offset is relative to the beginning of the
 118  * stream, if offset is a negative number the offset is relative to the end of
 119  * the stream. The returned memory is valid until the typefinding function
 120  * returns and must not be freed.
 121  *
 122  * Returns: the requested data, or NULL if that data is not available.
 123  */
 124 guint8 *
 125 gst_type_find_peek (GstTypeFind * find, gint64 offset, guint size)
 126 {
 127   g_return_val_if_fail (find->peek != NULL, NULL);
 128
 129   return find->peek (find->data, offset, size);
 130 }
 131
 132 /**
 133  * gst_type_find_suggest:
 134  * @find: The #GstTypeFind object the function was called with
 135  * @probability: The probability in percent that the suggestion is right
 136  * @caps: The fixed #GstCaps to suggest
 137  *
 138  * If a #GstTypeFindFunction calls this function it suggests the caps with the
 139  * given probability. A #GstTypeFindFunction may supply different suggestions
 140  * in one call.
 141  * It is up to the caller of the #GstTypeFindFunction to interpret these values.
 142  */
 143 void
 144 gst_type_find_suggest (GstTypeFind * find, guint probability,
 145     const GstCaps * caps)
 146 {
 147   g_return_if_fail (find->suggest != NULL);
 148   g_return_if_fail (probability <= 100);
 149   g_return_if_fail (caps != NULL);
 150   g_return_if_fail (gst_caps_is_fixed (caps));
 151
 152   find->suggest (find->data, probability, caps);
 153 }
 154
 155 /**
 156  * gst_type_find_get_length:
 157  * @find: The #GstTypeFind the function was called with
 158  *
 159  * Get the length of the data stream.
 160  *
 161  * Returns: The length of the data stream, or 0 if it is not available.
 162  */
 163 guint64
 164 gst_type_find_get_length (GstTypeFind * find)
 165 {
 166   if (find->get_length == NULL)
 167     return 0;
 168
 169   return find->get_length (find->data);
 170 }