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/gstobject.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_PLUGIN_FEATURE                 (gst_plugin_feature_get_type())
  33 #define GST_PLUGIN_FEATURE(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeature))
  34 #define GST_IS_PLUGIN_FEATURE(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLUGIN_FEATURE))
  35 #define GST_PLUGIN_FEATURE_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
  36 #define GST_IS_PLUGIN_FEATURE_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLUGIN_FEATURE))
  37 #define GST_PLUGIN_FEATURE_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PLUGIN_FEATURE, GstPluginFeatureClass))
  38 #define GST_PLUGIN_FEATURE_CAST(obj)            ((GstPluginFeature*)(obj))
  39
  40 /**
  41  * GST_PLUGIN_FEATURE_NAME:
  42  * @feature: The feature to query
  43  *
  44  * Get the name of the feature
  45  */
  46 #define GST_PLUGIN_FEATURE_NAME(feature)  (GST_PLUGIN_FEATURE (feature)->name)
  47
  48 typedef struct _GstPluginFeature GstPluginFeature;
  49 typedef struct _GstPluginFeatureClass GstPluginFeatureClass;
  50
  51 /**
  52  * GstRank:
  53  * @GST_RANK_NONE: will be chosen last or not at all
  54  * @GST_RANK_MARGINAL: unlikly to be chosen
  55  * @GST_RANK_SECONDARY: likely to be chosen
  56  * @GST_RANK_PRIMARY: will be chosen first
  57  *
  58  * Element priority ranks. Defines the order in which the autoplugger (or
  59  * similar rank-picking mechanisms, such as e.g. gst_element_make_from_uri())
  60  * will choose this element over an alternative one with the same function.
  61  *
  62  * These constants serve as a rough guidance for defining the rank of a
  63  * #GstPluginFeature. Any value is valid, including values bigger than
  64  * @GST_RANK_PRIMARY.
  65  */
  66 typedef enum {
  67   GST_RANK_NONE                 = 0,
  68   GST_RANK_MARGINAL             = 64,
  69   GST_RANK_SECONDARY            = 128,
  70   GST_RANK_PRIMARY              = 256
  71 } GstRank;
  72
  73 /**
  74  * GstPluginFeature:
  75  *
  76  * Opaque #GstPluginFeature structure.
  77  */
  78 struct _GstPluginFeature {
  79   GstObject      object;
  80
  81   /*< private >*/
  82   gboolean       loaded;
  83   gchar         *name;
  84   guint          rank;
  85
  86   const gchar   *plugin_name;
  87
  88   /*< private >*/
  89   gpointer _gst_reserved[GST_PADDING];
  90 };
  91
  92 struct _GstPluginFeatureClass {
  93   GstObjectClass        parent_class;
  94
  95   /*< private >*/
  96   gpointer _gst_reserved[GST_PADDING];
  97 };
  98
  99 /**
 100  * GstTypeNameData:
 101  * @name: a name
 102  * @type: a GType
 103  *
 104  * Structure used for filtering based on @name and @type.
 105  */
 106 typedef struct {
 107   const gchar   *name;
 108   GType          type;
 109 } GstTypeNameData;
 110
 111 /**
 112  * GstPluginFeatureFilter:
 113  * @feature: the pluginfeature to check
 114  * @user_data: the user_data that has been passed on e.g.
 115  *  gst_registry_feature_filter()
 116  *
 117  * A function that can be used with e.g. gst_registry_feature_filter()
 118  * to get a list of pluginfeature that match certain criteria.
 119  *
 120  * Returns: %TRUE for a positive match, %FALSE otherwise
 121  */
 122 typedef gboolean        (*GstPluginFeatureFilter)       (GstPluginFeature *feature,
 123                                                          gpointer user_data);
 124
 125 /* normal GObject stuff */
 126 GType           gst_plugin_feature_get_type             (void);
 127
 128 GstPluginFeature *
 129                 gst_plugin_feature_load                 (GstPluginFeature *feature);
 130
 131 gboolean        gst_plugin_feature_type_name_filter     (GstPluginFeature *feature,
 132                                                          GstTypeNameData *data);
 133
 134 void            gst_plugin_feature_set_rank             (GstPluginFeature *feature, guint rank);
 135 void            gst_plugin_feature_set_name             (GstPluginFeature *feature, const gchar *name);
 136 guint           gst_plugin_feature_get_rank             (GstPluginFeature *feature);
 137 G_CONST_RETURN gchar *gst_plugin_feature_get_name       (GstPluginFeature *feature);
 138
 139 void            gst_plugin_feature_list_free            (GList *list);
 140 GList          *gst_plugin_feature_list_copy            (GList *list);
 141 void            gst_plugin_feature_list_debug           (GList *list);
 142
 143 #ifndef GST_DISABLE_GST_DEBUG
 144 #define GST_PLUGIN_FEATURE_LIST_DEBUG(list) gst_plugin_feature_list_debug(list)
 145 #else
 146 #define GST_PLUGIN_FEATURE_LIST_DEBUG(list)
 147 #endif
 148
 149 gboolean        gst_plugin_feature_check_version        (GstPluginFeature *feature,
 150                                                          guint             min_major,
 151                                                          guint             min_minor,
 152                                                          guint             min_micro);
 153 gint            gst_plugin_feature_rank_compare_func    (gconstpointer p1,
 154                                                          gconstpointer p2);
 155
 156 G_END_DECLS
 157
 158
 159 #endif /* __GST_PLUGIN_FEATURE_H__ */
 160