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   GstRegistryPrivate *priv;
  54
  55   gpointer _gst_reserved[GST_PADDING];
  56 };
  57
  58 struct _GstRegistryClass {
  59   GstObjectClass        parent_class;
  60
  61   /* signals */
  62   void                  (*plugin_added)         (GstRegistry *registry, GstPlugin *plugin);
  63   void                  (*feature_added)        (GstRegistry *registry, GstPluginFeature *feature);
  64
  65   /*< private >*/
  66   gpointer _gst_reserved[GST_PADDING];
  67 };
  68
  69
  70 /* normal GObject stuff */
  71 GType                   gst_registry_get_type           (void);
  72
  73 GstRegistry *           gst_registry_get_default        (void);
  74
  75 gboolean                gst_registry_scan_path          (GstRegistry *registry, const gchar *path);
  76 void                    gst_registry_add_path           (GstRegistry * registry, const gchar * path);
  77 GList*                  gst_registry_get_path_list      (GstRegistry *registry);
  78
  79 gboolean                gst_registry_add_plugin         (GstRegistry *registry, GstPlugin *plugin);
  80 void                    gst_registry_remove_plugin      (GstRegistry *registry, GstPlugin *plugin);
  81 gboolean                gst_registry_add_feature        (GstRegistry * registry, GstPluginFeature * feature);
  82 void                    gst_registry_remove_feature     (GstRegistry * registry, GstPluginFeature * feature);
  83
  84 GList*                  gst_registry_get_plugin_list    (GstRegistry *registry);
  85 GList*                  gst_registry_plugin_filter      (GstRegistry *registry,
  86                                                          GstPluginFilter filter,
  87                                                          gboolean first,
  88                                                          gpointer user_data);
  89 GList*                  gst_registry_feature_filter     (GstRegistry *registry,
  90                                                          GstPluginFeatureFilter filter,
  91                                                          gboolean first,
  92                                                          gpointer user_data);
  93 GList *                 gst_registry_get_feature_list   (GstRegistry *registry,
  94                                                          GType type);
  95 GList *                 gst_registry_get_feature_list_by_plugin (GstRegistry *registry, const gchar *name);
  96 guint32                 gst_registry_get_feature_list_cookie (GstRegistry *registry);
  97
  98 GstPlugin*              gst_registry_find_plugin        (GstRegistry *registry, const gchar *name);
  99 GstPluginFeature*       gst_registry_find_feature       (GstRegistry *registry, const gchar *name, GType type);
 100
 101 GstPlugin *             gst_registry_lookup             (GstRegistry *registry, const char *filename);
 102 GstPluginFeature *      gst_registry_lookup_feature     (GstRegistry *registry, const char *name);
 103
 104 /* convinience defines for the default registry */
 105
 106 /**
 107  * gst_default_registry_add_plugin:
 108  * @plugin: (transfer full): the plugin to add
 109  *
 110  * Add the plugin to the default registry.
 111  * The plugin-added signal will be emitted.
 112  *
 113  * Returns: TRUE on success.
 114  */
 115 #define gst_default_registry_add_plugin(plugin) \
 116   gst_registry_add_plugin (gst_registry_get_default(), plugin)
 117
 118 /**
 119  * gst_default_registry_add_path:
 120  * @path: the path to add to the registry
 121  *
 122  * Add the given path to the default registry. The syntax of the
 123  * path is specific to the registry. If the path has already been
 124  * added, do nothing.
 125  */
 126 #define gst_default_registry_add_path(path) \
 127   gst_registry_add_path (gst_registry_get_default(), path)
 128
 129 /**
 130  * gst_default_registry_get_path_list:
 131  *
 132  * Get the list of paths for the default registry.
 133  *
 134  * Returns: (transfer container) (element-type char*): a #GList of paths as
 135  *     strings. g_list_free() after use.
 136  */
 137 #define gst_default_registry_get_path_list() \
 138   gst_registry_get_path_list (gst_registry_get_default())
 139
 140 /**
 141  * gst_default_registry_get_plugin_list:
 142  *
 143  * Get a copy of all plugins registered in the default registry.
 144  *
 145  * Returns: (transfer full) (element-type Gst.Plugin): a copy of the list.
 146  *     Free after use.
 147  */
 148 #define gst_default_registry_get_plugin_list() \
 149   gst_registry_get_plugin_list (gst_registry_get_default())
 150
 151 /**
 152  * gst_default_registry_find_feature:
 153  * @name: the pluginfeature name to find
 154  * @type: the pluginfeature type to find
 155  *
 156  * Find the pluginfeature with the given name and type in the default registry.
 157  *
 158  * Returns: (transfer full): the pluginfeature with the given name and type or
 159  *    NULL if the plugin was not found.
 160  */
 161 #define gst_default_registry_find_feature(name,type) \
 162   gst_registry_find_feature (gst_registry_get_default(),name,type)
 163
 164 /**
 165  * gst_default_registry_find_plugin:
 166  * @name: the plugin name to find
 167  *
 168  * Find the plugin with the given name in the default registry.
 169  * The plugin will be reffed; caller is responsible for unreffing.
 170  *
 171  * Returns: (transfer full): The plugin with the given name or NULL if the
 172  *     plugin was not found.
 173  */
 174 #define gst_default_registry_find_plugin(name) \
 175   gst_registry_find_plugin (gst_registry_get_default(),name)
 176
 177 /**
 178  * gst_default_registry_feature_filter:
 179  * @filter: the filter to use
 180  * @first: only return first match
 181  * @user_data: user data passed to the filter function
 182  *
 183  * Runs a filter against all features of the plugins in the default registry
 184  * and returns a GList with the results.
 185  * If the first flag is set, only the first match is
 186  * returned (as a list with a single object).
 187  *
 188  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
 189  *     plugin features, gst_plugin_feature_list_free after use.
 190  */
 191 #define gst_default_registry_feature_filter(filter,first,user_data) \
 192   gst_registry_feature_filter (gst_registry_get_default(),filter,first,user_data)
 193
 194 /**
 195  * gst_default_registry_get_feature_list_cookie:
 196  *
 197  * Returns the default registrys feature list cookie. This changes
 198  * every time a feature is added or removed from the registry.
 199  *
 200  * Returns: the feature list cookie.
 201  *
 202  * Since: 0.10.26
 203  */
 204 #define gst_default_registry_get_feature_list_cookie() \
 205   gst_registry_get_feature_list_cookie (gst_registry_get_default())
 206
 207 gboolean                gst_default_registry_check_feature_version (const gchar *feature_name,
 208                                                                     guint        min_major,
 209                                                                     guint        min_minor,
 210                                                                     guint        min_micro);
 211
 212 G_END_DECLS
 213
 214 #endif /* __GST_REGISTRY_H__ */
 215