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