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