gst/gsttypefind.h

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttypefind.h: 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 #ifndef __GST_TYPE_FIND_H__
  24 #define __GST_TYPE_FIND_H__
  25
  26 #include <gst/gstcaps.h>
  27 #include <gst/gstplugin.h>
  28 #include <gst/gstpluginfeature.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_TYPE_FIND      (gst_type_find_get_type())
  33
  34 typedef struct _GstTypeFind GstTypeFind;
  35
  36 /**
  37  * GstTypeFindFunction:
  38  * @find: A #GstTypeFind structure
  39  * @data: optionnal data to pass to the function
  40  *
  41  * A function that will be called by typefinding.
  42  */
  43 typedef void (* GstTypeFindFunction) (GstTypeFind *find, gpointer data);
  44
  45 /**
  46  * GstTypeFindProbability:
  47  * @GST_TYPE_FIND_MINIMUM: unlikely typefind
  48  * @GST_TYPE_FIND_POSSIBLE: possible type detected
  49  * @GST_TYPE_FIND_LIKELY: likely a type was detected
  50  * @GST_TYPE_FIND_NEARLY_CERTAIN: nearly certain that a type was detected
  51  * @GST_TYPE_FIND_MAXIMUM: very certain a type was detected.
  52  *
  53  * The probability of the typefind function. Higher values have more certainty
  54  * in doing a reliable typefind.
  55  */
  56 typedef enum {
  57   GST_TYPE_FIND_MINIMUM = 1,
  58   GST_TYPE_FIND_POSSIBLE = 50,
  59   GST_TYPE_FIND_LIKELY = 80,
  60   GST_TYPE_FIND_NEARLY_CERTAIN = 99,
  61   GST_TYPE_FIND_MAXIMUM = 100
  62 } GstTypeFindProbability;
  63
  64 /**
  65  * GstTypeFind:
  66  * @peek: Method to peek data.
  67  * @suggest: Method to suggest #GstCaps with a given probability.
  68  * @data: The data used by the caller of the typefinding function.
  69  * @get_length: Returns the length of current data.
  70  *
  71  * Object that stores typefind callbacks. To use with #GstTypeFindFactory.
  72  */
  73 struct _GstTypeFind {
  74   /* private to the caller of the typefind function */
  75   guint8 *      (* peek)        (gpointer               data,
  76                                  gint64                 offset,
  77                                  guint                  size);
  78   void          (* suggest)     (gpointer               data,
  79                                  guint                  probability,
  80                                  const GstCaps *        caps);
  81
  82   gpointer      data;
  83
  84   /* optional */
  85   guint64       (* get_length)  (gpointer               data);
  86
  87   /* <private> */
  88   gpointer _gst_reserved[GST_PADDING];
  89 };
  90
  91 GType           gst_type_find_get_type                  (void);
  92
  93 /* typefind function interface */
  94 guint8 *        gst_type_find_peek                      (GstTypeFind *          find,
  95                                                          gint64                 offset,
  96                                                          guint                  size);
  97 void            gst_type_find_suggest                   (GstTypeFind *          find,
  98                                                          guint                  probability,
  99                                                          const GstCaps *        caps);
 100 guint64         gst_type_find_get_length                (GstTypeFind *          find);
 101
 102 /* registration interface */
 103 gboolean        gst_type_find_register                  (GstPlugin *            plugin,
 104                                                          const gchar *          name,
 105                                                          guint                  rank,
 106                                                          GstTypeFindFunction    func,
 107                                                          gchar **               extensions,
 108                                                          const GstCaps *        possible_caps,
 109                                                          gpointer               data,
 110                                                          GDestroyNotify         data_notify);
 111
 112 G_END_DECLS
 113
 114 #endif /* __GST_TYPE_FIND_H__ */