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/gstbuffer.h>
  27 #include <gst/gstcaps.h>
  28 #include <gst/gstplugin.h>
  29 #include <gst/gstpluginfeature.h>
  30 #include <gst/gsttypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GST_TYPE_TYPE_FIND_FACTORY                 (gst_type_find_factory_get_type())
  35 #define GST_TYPE_FIND_FACTORY(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactory))
  36 #define GST_IS_TYPE_FIND_FACTORY(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_TYPE_FIND_FACTORY))
  37 #define GST_TYPE_FIND_FACTORY_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactoryClass))
  38 #define GST_IS_TYPE_FIND_FACTORY_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_TYPE_FIND_FACTORY))
  39 #define GST_TYPE_FIND_FACTORY_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_TYPE_FIND_FACTORY, GstTypeFindFactoryClass))
  40
  41 typedef struct _GstTypeFind GstTypeFind;
  42 typedef struct _GstTypeFindFactory GstTypeFindFactory;
  43 typedef struct _GstTypeFindFactoryClass GstTypeFindFactoryClass;
  44
  45 typedef void (* GstTypeFindFunction) (GstTypeFind *find, gpointer data);
  46
  47 typedef enum {
  48   GST_TYPE_FIND_MINIMUM = 1,
  49   GST_TYPE_FIND_POSSIBLE = 50,
  50   GST_TYPE_FIND_LIKELY = 80,
  51   GST_TYPE_FIND_NEARLY_CERTAIN = 99,
  52   GST_TYPE_FIND_MAXIMUM = 100,
  53 } GstTypeFindProbability;
  54
  55 struct _GstTypeFind {
  56   /* private to the caller of the typefind function */
  57   guint8 *              (* peek)                        (gpointer               data,
  58                                                          gint64                 offset,
  59                                                          guint                  size);
  60   void                  (* suggest)                     (gpointer               data,
  61                                                          guint                  probability,
  62                                                          const GstCaps *                caps);
  63
  64   gpointer                      data;
  65
  66   /* optional */
  67   guint64               (* get_length)                  (gpointer               data);
  68
  69   /* <private> */
  70   gpointer _gst_reserved[GST_PADDING];
  71 };
  72
  73 struct _GstTypeFindFactory {
  74   GstPluginFeature              feature;
  75   /* <private> */
  76
  77   GstTypeFindFunction           function;
  78   gchar **                      extensions;
  79   GstCaps *                     caps; /* FIXME: not yet saved in registry */
  80
  81   gpointer                      user_data;
  82
  83   gpointer _gst_reserved[GST_PADDING];
  84 };
  85
  86 struct _GstTypeFindFactoryClass {
  87   GstPluginFeatureClass         parent;
  88   /* <private> */
  89
  90   gpointer _gst_reserved[GST_PADDING];
  91 };
  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
 111 /* typefinding interface */
 112
 113 GType           gst_type_find_factory_get_type          (void);
 114
 115 GList *         gst_type_find_factory_get_list          (void);
 116
 117 gchar **        gst_type_find_factory_get_extensions    (const GstTypeFindFactory *factory);
 118 const GstCaps * gst_type_find_factory_get_caps          (const GstTypeFindFactory *factory);
 119 void            gst_type_find_factory_call_function     (const GstTypeFindFactory *factory,
 120                                                          GstTypeFind *find);
 121
 122
 123 G_END_DECLS
 124
 125 #endif /* __GST_TYPE_FIND_H__ */