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