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 G_DEFINE_POINTER_TYPE (GstTypeFind, gst_type_find);
  42
  43 /**
  44  * gst_type_find_register:
  45  * @plugin: A #GstPlugin, or NULL for a static typefind function (note that
  46  *    passing NULL only works in GStreamer 0.10.16 and later)
  47  * @name: The name for registering
  48  * @rank: The rank (or importance) of this typefind function
  49  * @func: The #GstTypeFindFunction to use
  50  * @extensions: (transfer none) (array zero-terminated=1) (element-type utf8):
  51  *     Optional extensions that could belong to this type
  52  * @possible_caps: Optionally the caps that could be returned when typefinding
  53  *                 succeeds
  54  * @data: Optional user data. This user data must be available until the plugin
  55  *        is unloaded.
  56  * @data_notify: a #GDestroyNotify that will be called on @data when the plugin
  57  *        is unloaded.
  58  *
  59  * Registers a new typefind function to be used for typefinding. After
  60  * registering this function will be available for typefinding.
  61  * This function is typically called during an element's plugin initialization.
  62  *
  63  * Returns: TRUE on success, FALSE otherwise
  64  */
  65 gboolean
  66 gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank,
  67     GstTypeFindFunction func, gchar ** extensions,
  68     GstCaps * possible_caps, gpointer data, GDestroyNotify data_notify)
  69 {
  70   GstTypeFindFactory *factory;
  71
  72   g_return_val_if_fail (name != NULL, FALSE);
  73
  74   GST_INFO ("registering typefind function for %s", name);
  75
  76   factory = g_object_newv (GST_TYPE_TYPE_FIND_FACTORY, 0, NULL);
  77   GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
  78   g_assert (GST_IS_TYPE_FIND_FACTORY (factory));
  79
  80   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
  81   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
  82
  83   if (factory->extensions)
  84     g_strfreev (factory->extensions);
  85   factory->extensions = g_strdupv (extensions);
  86
  87   gst_caps_replace (&factory->caps, possible_caps);
  88   factory->function = func;
  89   factory->user_data = data;
  90   factory->user_data_notify = data_notify;
  91   if (plugin && plugin->desc.name) {
  92     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name; /* interned string */
  93     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
  94     g_object_add_weak_pointer ((GObject *) plugin,
  95         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
  96   } else {
  97     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
  98     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
  99   }
 100   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 101
 102   gst_registry_add_feature (gst_registry_get (),
 103       GST_PLUGIN_FEATURE_CAST (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: (transfer none) (array length=size): the requested data, or NULL
 123  *     if that data is not available.
 124  */
 125 const guint8 *
 126 gst_type_find_peek (GstTypeFind * find, gint64 offset, guint size)
 127 {
 128   g_return_val_if_fail (find->peek != NULL, NULL);
 129
 130   return find->peek (find->data, offset, size);
 131 }
 132
 133 /**
 134  * gst_type_find_suggest:
 135  * @find: The #GstTypeFind object the function was called with
 136  * @probability: The probability in percent that the suggestion is right
 137  * @caps: The fixed #GstCaps to suggest
 138  *
 139  * If a #GstTypeFindFunction calls this function it suggests the caps with the
 140  * given probability. A #GstTypeFindFunction may supply different suggestions
 141  * in one call.
 142  * It is up to the caller of the #GstTypeFindFunction to interpret these values.
 143  */
 144 void
 145 gst_type_find_suggest (GstTypeFind * find, guint probability,
 146     const GstCaps * caps)
 147 {
 148   g_return_if_fail (find->suggest != NULL);
 149   g_return_if_fail (probability <= 100);
 150   g_return_if_fail (caps != NULL);
 151   g_return_if_fail (gst_caps_is_fixed (caps));
 152
 153   find->suggest (find->data, probability, caps);
 154 }
 155
 156 /**
 157  * gst_type_find_suggest_simple:
 158  * @find: The #GstTypeFind object the function was called with
 159  * @probability: The probability in percent that the suggestion is right
 160  * @media_type: the media type of the suggested caps
 161  * @fieldname: first field of the suggested caps, or NULL
 162  * @...: additional arguments to the suggested caps in the same format as the
 163  *     arguments passed to gst_structure_new() (ie. triplets of field name,
 164  *     field GType and field value)
 165  *
 166  * If a #GstTypeFindFunction calls this function it suggests the caps with the
 167  * given probability. A #GstTypeFindFunction may supply different suggestions
 168  * in one call. It is up to the caller of the #GstTypeFindFunction to interpret
 169  * these values.
 170  *
 171  * This function is similar to gst_type_find_suggest(), only that instead of
 172  * passing a #GstCaps argument you can create the caps on the fly in the same
 173  * way as you can with gst_caps_new_simple().
 174  *
 175  * Make sure you terminate the list of arguments with a NULL argument and that
 176  * the values passed have the correct type (in terms of width in bytes when
 177  * passed to the vararg function - this applies particularly to gdouble and
 178  * guint64 arguments).
 179  *
 180  * Since: 0.10.20
 181  */
 182 void
 183 gst_type_find_suggest_simple (GstTypeFind * find, guint probability,
 184     const char *media_type, const char *fieldname, ...)
 185 {
 186   GstStructure *structure;
 187   va_list var_args;
 188   GstCaps *caps;
 189
 190   g_return_if_fail (find->suggest != NULL);
 191   g_return_if_fail (probability <= 100);
 192   g_return_if_fail (media_type != NULL);
 193
 194   caps = gst_caps_new_empty ();
 195
 196   va_start (var_args, fieldname);
 197   structure = gst_structure_new_valist (media_type, fieldname, var_args);
 198   va_end (var_args);
 199
 200   gst_caps_append_structure (caps, structure);
 201   g_return_if_fail (gst_caps_is_fixed (caps));
 202
 203   find->suggest (find->data, probability, caps);
 204   gst_caps_unref (caps);
 205 }
 206
 207 /**
 208  * gst_type_find_get_length:
 209  * @find: The #GstTypeFind the function was called with
 210  *
 211  * Get the length of the data stream.
 212  *
 213  * Returns: The length of the data stream, or 0 if it is not available.
 214  */
 215 guint64
 216 gst_type_find_get_length (GstTypeFind * find)
 217 {
 218   if (find->get_length == NULL)
 219     return 0;
 220
 221   return find->get_length (find->data);
 222 }