gst/gstpluginfeature.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstpluginfeature.h: Header for base GstPluginFeature
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_PLUGIN_FEATURE_H__
  25 #define __GST_PLUGIN_FEATURE_H__
  26
  27 #include <glib-object.h>
  28 #include <gst/gsttypes.h>
  29
  30 G_BEGIN_DECLS
  31 #define GST_TYPE_PLUGIN_FEATURE                 (gst_plugin_feature_get_type())
  32 #define GST_PLUGIN_FEATURE(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeature))
  33 #define GST_IS_PLUGIN_FEATURE(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLUGIN_FEATURE))
  34 #define GST_PLUGIN_FEATURE_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
  35 #define GST_IS_PLUGIN_FEATURE_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLUGIN_FEATURE))
  36 #define GST_PLUGIN_FEATURE_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
  37 #define GST_PLUGIN_FEATURE_NAME(feature)  (GST_PLUGIN_FEATURE (feature)->name)
  38 typedef struct _GstPluginFeature GstPluginFeature;
  39 typedef struct _GstPluginFeatureClass GstPluginFeatureClass;
  40
  41 struct _GstPluginFeature
  42 {
  43   GObject object;
  44
  45   /*< private > */
  46   gchar *name;
  47   guint rank;
  48
  49   gpointer manager;
  50
  51   gpointer _gst_reserved[GST_PADDING];
  52 };
  53
  54 struct _GstPluginFeatureClass
  55 {
  56   GObjectClass parent_class;
  57
  58   void (*unload_thyself) (GstPluginFeature * feature);
  59
  60   gpointer _gst_reserved[GST_PADDING];
  61 };
  62
  63 typedef struct
  64 {
  65   const gchar *name;
  66   GType type;
  67 } GstTypeNameData;
  68
  69 /* filter */
  70 typedef gboolean (*GstPluginFeatureFilter) (GstPluginFeature * feature,
  71     gpointer user_data);
  72
  73 /* normal GObject stuff */
  74 GType gst_plugin_feature_get_type (void);
  75
  76 gboolean gst_plugin_feature_ensure_loaded (GstPluginFeature * feature);
  77 void gst_plugin_feature_unload_thyself (GstPluginFeature * feature);
  78
  79 gboolean gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
  80     GstTypeNameData * data);
  81
  82 void gst_plugin_feature_set_rank (GstPluginFeature * feature, guint rank);
  83 void gst_plugin_feature_set_name (GstPluginFeature * feature,
  84     const gchar * name);
  85 guint gst_plugin_feature_get_rank (GstPluginFeature * feature);
  86 G_CONST_RETURN gchar *gst_plugin_feature_get_name (GstPluginFeature * feature);
  87
  88 G_END_DECLS
  89 #endif /* __GST_PLUGIN_FEATURE_H__ */