gst/gstindexfactory.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstindexfactory.h: Header for GstIndexFactory, base class to handle efficient
   6  *                    storage or caching of seeking information.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __GST_INDEX_FACTORY_H__
  25 #define __GST_INDEX_FACTORY_H__
  26
  27 #include <gst/gstobject.h>
  28 #include <gst/gstformat.h>
  29 #include <gst/gstpluginfeature.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GST_TYPE_INDEX_FACTORY                  (gst_index_factory_get_type())
  34 #define GST_INDEX_FACTORY(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_INDEX_FACTORY, GstIndexFactory))
  35 #define GST_IS_INDEX_FACTORY(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_INDEX_FACTORY))
  36 #define GST_INDEX_FACTORY_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_INDEX_FACTORY, GstIndexFactoryClass))
  37 #define GST_IS_INDEX_FACTORY_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_INDEX_FACTORY))
  38 #define GST_INDEX_FACTORY_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_INDEX_FACTORY, GstIndexFactoryClass))
  39
  40 typedef struct _GstIndexFactory GstIndexFactory;
  41 typedef struct _GstIndexFactoryClass GstIndexFactoryClass;
  42
  43 /**
  44  * GstIndexFactory:
  45  *
  46  * The GstIndexFactory object
  47  */
  48 struct _GstIndexFactory {
  49   GstPluginFeature feature;
  50
  51   gchar *longdesc;            /* long description of the index (well, don't overdo it..) */
  52   GType type;                 /* unique GType of the index */
  53
  54   gpointer _gst_reserved[GST_PADDING];
  55 };
  56
  57 struct _GstIndexFactoryClass {
  58   GstPluginFeatureClass parent;
  59
  60   gpointer _gst_reserved[GST_PADDING];
  61 };
  62
  63 GType                   gst_index_factory_get_type      (void);
  64
  65 GstIndexFactory*        gst_index_factory_new           (const gchar *name,
  66                                                          const gchar *longdesc, GType type) G_GNUC_MALLOC;
  67 void                    gst_index_factory_destroy       (GstIndexFactory *factory);
  68
  69 GstIndexFactory*        gst_index_factory_find          (const gchar *name);
  70
  71 GstIndex*               gst_index_factory_create        (GstIndexFactory *factory) G_GNUC_MALLOC;
  72 GstIndex*               gst_index_factory_make          (const gchar *name) G_GNUC_MALLOC;
  73
  74 G_END_DECLS
  75
  76 #endif /* __GST_INDEX_FACTORY_H__ */