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