gst/gstregistry.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstregistry.h: Header for registry handling
   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_REGISTRY_H__
  25 #define __GST_REGISTRY_H__
  26
  27 #include <gst/gstconfig.h>
  28 #include <gst/gstplugin.h>
  29 #include <gst/gstpluginfeature.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GST_TYPE_REGISTRY               (gst_registry_get_type ())
  34 #define GST_REGISTRY(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_REGISTRY, GstRegistry))
  35 #define GST_IS_REGISTRY(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_REGISTRY))
  36 #define GST_REGISTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_REGISTRY, GstRegistryClass))
  37 #define GST_IS_REGISTRY_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_REGISTRY))
  38 #define GST_REGISTRY_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_REGISTRY, GstRegistryClass))
  39
  40 typedef struct _GstRegistry GstRegistry;
  41 typedef struct _GstRegistryClass GstRegistryClass;
  42 typedef struct _GstRegistryPrivate GstRegistryPrivate;
  43
  44 /**
  45  * GstRegistry:
  46  *
  47  * Opaque #GstRegistry structure.
  48  */
  49 struct _GstRegistry {
  50   GstObject      object;
  51
  52   /*< private >*/
  53   GList *plugins;
  54   GList *features;
  55
  56   GList         *paths;
  57
  58   /* FIXME move these elsewhere */
  59   int            cache_file;
  60
  61   /* hash to speedup _lookup_feature_locked() */
  62   GHashTable *feature_hash;
  63   /* hash to speedup _lookup */
  64   GHashTable *basename_hash;
  65
  66   GstRegistryPrivate *priv;
  67
  68   /*< private >*/
  69   gpointer _gst_reserved[GST_PADDING];
  70 };
  71
  72 struct _GstRegistryClass {
  73   GstObjectClass        parent_class;
  74
  75   /* signals */
  76   void                  (*plugin_added)         (GstRegistry *registry, GstPlugin *plugin);
  77   void                  (*feature_added)        (GstRegistry *registry, GstPluginFeature *feature);
  78
  79   /*< private >*/
  80   gpointer _gst_reserved[GST_PADDING];
  81 };
  82
  83
  84 /* normal GObject stuff */
  85 GType                   gst_registry_get_type           (void);
  86
  87 GstRegistry *           gst_registry_get_default        (void);
  88
  89 gboolean                        gst_registry_scan_path          (GstRegistry *registry, const gchar *path);
  90 void                    gst_registry_add_path           (GstRegistry * registry, const gchar * path);
  91 GList*                  gst_registry_get_path_list      (GstRegistry *registry);
  92
  93 gboolean                gst_registry_add_plugin         (GstRegistry *registry, GstPlugin *plugin);
  94 void                    gst_registry_remove_plugin      (GstRegistry *registry, GstPlugin *plugin);
  95 gboolean                gst_registry_add_feature        (GstRegistry * registry, GstPluginFeature * feature);
  96 void                    gst_registry_remove_feature     (GstRegistry * registry, GstPluginFeature * feature);
  97
  98 GList*                  gst_registry_get_plugin_list    (GstRegistry *registry);
  99 GList*                  gst_registry_plugin_filter      (GstRegistry *registry,
 100                                                          GstPluginFilter filter,
 101                                                          gboolean first,
 102                                                          gpointer user_data);
 103 GList*                  gst_registry_feature_filter     (GstRegistry *registry,
 104                                                          GstPluginFeatureFilter filter,
 105                                                          gboolean first,
 106                                                          gpointer user_data);
 107 GList *                 gst_registry_get_feature_list   (GstRegistry *registry,
 108                                                          GType type);
 109 GList *                 gst_registry_get_feature_list_by_plugin (GstRegistry *registry, const gchar *name);
 110 guint32                 gst_registry_get_feature_list_cookie (GstRegistry *registry);
 111
 112 GstPlugin*              gst_registry_find_plugin        (GstRegistry *registry, const gchar *name);
 113 GstPluginFeature*       gst_registry_find_feature       (GstRegistry *registry, const gchar *name, GType type);
 114
 115 GstPlugin *             gst_registry_lookup             (GstRegistry *registry, const char *filename);
 116 GstPluginFeature *      gst_registry_lookup_feature     (GstRegistry *registry, const char *name);
 117
 118 /* convinience defines for the default registry */
 119
 120 /**
 121  * gst_default_registry_add_plugin:
 122  * @plugin: (transfer full): the plugin to add
 123  *
 124  * Add the plugin to the default registry.
 125  * The plugin-added signal will be emitted.
 126  *
 127  * Returns: TRUE on success.
 128  */
 129 #define gst_default_registry_add_plugin(plugin) \
 130   gst_registry_add_plugin (gst_registry_get_default(), plugin)
 131
 132 /**
 133  * gst_default_registry_add_path:
 134  * @path: the path to add to the registry
 135  *
 136  * Add the given path to the default registry. The syntax of the
 137  * path is specific to the registry. If the path has already been
 138  * added, do nothing.
 139  */
 140 #define gst_default_registry_add_path(path) \
 141   gst_registry_add_path (gst_registry_get_default(), path)
 142
 143 /**
 144  * gst_default_registry_get_path_list:
 145  *
 146  * Get the list of paths for the default registry.
 147  *
 148  * Returns: (transfer container) (element-type char*): a #GList of paths as
 149  *     strings. g_list_free() after use.
 150  */
 151 #define gst_default_registry_get_path_list() \
 152   gst_registry_get_path_list (gst_registry_get_default())
 153
 154 /**
 155  * gst_default_registry_get_plugin_list:
 156  *
 157  * Get a copy of all plugins registered in the default registry.
 158  *
 159  * Returns: (transfer full) (element-type Gst.Plugin): a copy of the list.
 160  *     Free after use.
 161  */
 162 #define gst_default_registry_get_plugin_list() \
 163   gst_registry_get_plugin_list (gst_registry_get_default())
 164
 165 /**
 166  * gst_default_registry_find_feature:
 167  * @name: the pluginfeature name to find
 168  * @type: the pluginfeature type to find
 169  *
 170  * Find the pluginfeature with the given name and type in the default registry.
 171  *
 172  * Returns: (transfer full): the pluginfeature with the given name and type or
 173  *    NULL if the plugin was not found.
 174  */
 175 #define gst_default_registry_find_feature(name,type) \
 176   gst_registry_find_feature (gst_registry_get_default(),name,type)
 177
 178 /**
 179  * gst_default_registry_find_plugin:
 180  * @name: the plugin name to find
 181  *
 182  * Find the plugin with the given name in the default registry.
 183  * The plugin will be reffed; caller is responsible for unreffing.
 184  *
 185  * Returns: (transfer full): The plugin with the given name or NULL if the
 186  *     plugin was not found.
 187  */
 188 #define gst_default_registry_find_plugin(name) \
 189   gst_registry_find_plugin (gst_registry_get_default(),name)
 190
 191 /**
 192  * gst_default_registry_feature_filter:
 193  * @filter: the filter to use
 194  * @first: only return first match
 195  * @user_data: user data passed to the filter function
 196  *
 197  * Runs a filter against all features of the plugins in the default registry
 198  * and returns a GList with the results.
 199  * If the first flag is set, only the first match is
 200  * returned (as a list with a single object).
 201  *
 202  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
 203  *     plugin features, gst_plugin_feature_list_free after use.
 204  */
 205 #define gst_default_registry_feature_filter(filter,first,user_data) \
 206   gst_registry_feature_filter (gst_registry_get_default(),filter,first,user_data)
 207
 208 /**
 209  * gst_default_registry_get_feature_list_cookie:
 210  *
 211  * Returns the default registrys feature list cookie. This changes
 212  * every time a feature is added or removed from the registry.
 213  *
 214  * Returns: the feature list cookie.
 215  *
 216  * Since: 0.10.26
 217  */
 218 #define gst_default_registry_get_feature_list_cookie() \
 219   gst_registry_get_feature_list_cookie (gst_registry_get_default())
 220
 221 gboolean                gst_default_registry_check_feature_version (const gchar *feature_name,
 222                                                                     guint        min_major,
 223                                                                     guint        min_minor,
 224                                                                     guint        min_micro);
 225
 226 G_END_DECLS
 227
 228 #endif /* __GST_REGISTRY_H__ */
 229