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., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, 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
  30 #include "gst_private.h"
  31 #include "gstinfo.h"
  32 #include "gsttypefind.h"
  33 #include "gstregistry.h"
  34 #include "gsttypefindfactory.h"
  35
  36 GST_DEBUG_CATEGORY_EXTERN (type_find_debug);
  37 #define GST_CAT_DEFAULT type_find_debug
  38
  39 G_DEFINE_POINTER_TYPE (GstTypeFind, gst_type_find);
  40
  41 /**
  42  * gst_type_find_register:
  43  * @plugin: (allow-none): A #GstPlugin, or %NULL for a static typefind function
  44  * @name: The name for registering
  45  * @rank: The rank (or importance) of this typefind function
  46  * @func: The #GstTypeFindFunction to use
  47  * @extensions: (allow-none): Optional comma-separated list of extensions
  48  *     that could belong to this type
  49  * @possible_caps: Optionally the caps that could be returned when typefinding
  50  *                 succeeds
  51  * @data: Optional user data. This user data must be available until the plugin
  52  *        is unloaded.
  53  * @data_notify: a #GDestroyNotify that will be called on @data when the plugin
  54  *        is unloaded.
  55  *
  56  * Registers a new typefind function to be used for typefinding. After
  57  * registering this function will be available for typefinding.
  58  * This function is typically called during an element's plugin initialization.
  59  *
  60  * Returns: %TRUE on success, %FALSE otherwise
  61  */
  62 gboolean
  63 gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank,
  64     GstTypeFindFunction func, const gchar * extensions,
  65     GstCaps * possible_caps, gpointer data, GDestroyNotify data_notify)
  66 {
  67   GstTypeFindFactory *factory;
  68
  69   g_return_val_if_fail (name != NULL, FALSE);
  70
  71   GST_INFO ("registering typefind function for %s", name);
  72
  73   factory = g_object_newv (GST_TYPE_TYPE_FIND_FACTORY, 0, NULL);
  74   GST_DEBUG_OBJECT (factory, "using new typefind factory for %s", name);
  75   g_assert (GST_IS_TYPE_FIND_FACTORY (factory));
  76
  77   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
  78   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory), rank);
  79
  80   if (factory->extensions) {
  81     g_strfreev (factory->extensions);
  82     factory->extensions = NULL;
  83   }
  84   if (extensions)
  85     factory->extensions = g_strsplit (extensions, ",", -1);
  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, 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_suggest_simple:
 157  * @find: The #GstTypeFind object the function was called with
 158  * @probability: The probability in percent that the suggestion is right
 159  * @media_type: the media type of the suggested caps
 160  * @fieldname: (allow-none): first field of the suggested caps, or %NULL
 161  * @...: additional arguments to the suggested caps in the same format as the
 162  *     arguments passed to gst_structure_new() (ie. triplets of field name,
 163  *     field GType and field value)
 164  *
 165  * If a #GstTypeFindFunction calls this function it suggests the caps with the
 166  * given probability. A #GstTypeFindFunction may supply different suggestions
 167  * in one call. It is up to the caller of the #GstTypeFindFunction to interpret
 168  * these values.
 169  *
 170  * This function is similar to gst_type_find_suggest(), only that instead of
 171  * passing a #GstCaps argument you can create the caps on the fly in the same
 172  * way as you can with gst_caps_new_simple().
 173  *
 174  * Make sure you terminate the list of arguments with a %NULL argument and that
 175  * the values passed have the correct type (in terms of width in bytes when
 176  * passed to the vararg function - this applies particularly to gdouble and
 177  * guint64 arguments).
 178  */
 179 void
 180 gst_type_find_suggest_simple (GstTypeFind * find, guint probability,
 181     const char *media_type, const char *fieldname, ...)
 182 {
 183   GstStructure *structure;
 184   va_list var_args;
 185   GstCaps *caps;
 186
 187   g_return_if_fail (find->suggest != NULL);
 188   g_return_if_fail (probability <= 100);
 189   g_return_if_fail (media_type != NULL);
 190
 191   caps = gst_caps_new_empty ();
 192
 193   va_start (var_args, fieldname);
 194   structure = gst_structure_new_valist (media_type, fieldname, var_args);
 195   va_end (var_args);
 196
 197   gst_caps_append_structure (caps, structure);
 198   g_return_if_fail (gst_caps_is_fixed (caps));
 199
 200   find->suggest (find->data, probability, caps);
 201   gst_caps_unref (caps);
 202 }
 203
 204 /**
 205  * gst_type_find_get_length:
 206  * @find: The #GstTypeFind the function was called with
 207  *
 208  * Get the length of the data stream.
 209  *
 210  * Returns: The length of the data stream, or 0 if it is not available.
 211  */
 212 guint64
 213 gst_type_find_get_length (GstTypeFind * find)
 214 {
 215   if (find->get_length == NULL)
 216     return 0;
 217
 218   return find->get_length (find->data);
 219 }