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/gstplugin.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_REGISTRY               (gst_registry_get_type ())
  32 #define GST_REGISTRY(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_REGISTRY, GstRegistry))
  33 #define GST_IS_REGISTRY(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_REGISTRY))
  34 #define GST_REGISTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_REGISTRY, GstRegistryClass))
  35 #define GST_IS_REGISTRY_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_REGISTRY))
  36 #define GST_REGISTRY_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_REGISTRY, GstRegistryClass))
  37
  38 typedef struct _GstRegistry GstRegistry;
  39 typedef struct _GstRegistryClass GstRegistryClass;
  40
  41 struct _GstRegistry {
  42   GObject        object;
  43
  44   GList         *plugins;
  45
  46   GList         *paths;
  47
  48   /* FIXME move elsewhere */
  49   FILE          *cache_file;
  50
  51   gpointer _gst_reserved[GST_PADDING];
  52 };
  53
  54 struct _GstRegistryClass {
  55   GObjectClass          parent_class;
  56
  57   /* signals */
  58   void                  (*plugin_added)         (GstRegistry *registry, GstPlugin *plugin);
  59
  60   gpointer _gst_reserved[GST_PADDING];
  61 };
  62
  63
  64 /* normal GObject stuff */
  65 GType                   gst_registry_get_type           (void);
  66
  67 GstRegistry *           gst_registry_get_default        (void);
  68
  69 void                    gst_registry_scan_path          (GstRegistry *registry, const gchar *path);
  70 GList*                  gst_registry_get_path_list      (GstRegistry *registry);
  71 void                    gst_registry_clear_paths        (GstRegistry *registry);
  72
  73 gboolean                gst_registry_add_plugin         (GstRegistry *registry, GstPlugin *plugin);
  74 void                    gst_registry_remove_plugin      (GstRegistry *registry, GstPlugin *plugin);
  75
  76 GList*                  gst_registry_get_plugin_list    (GstRegistry *registry);
  77 GList*                  gst_registry_plugin_filter      (GstRegistry *registry,
  78                                                          GstPluginFilter filter,
  79                                                          gboolean first,
  80                                                          gpointer user_data);
  81 GList*                  gst_registry_feature_filter     (GstRegistry *registry,
  82                                                          GstPluginFeatureFilter filter,
  83                                                          gboolean first,
  84                                                          gpointer user_data);
  85 GList *                 gst_registry_get_feature_list   (GstRegistry *registry,
  86                                                          GType type);
  87
  88 GstPlugin*              gst_registry_find_plugin        (GstRegistry *registry, const gchar *name);
  89 GstPluginFeature*       gst_registry_find_feature       (GstRegistry *registry, const gchar *name, GType type);
  90 GstPlugin * gst_registry_lookup (GstRegistry *registry, const char *filename);
  91
  92 gboolean gst_registry_xml_read_cache (GstRegistry * registry, const char *location);
  93 gboolean gst_registry_xml_write_cache (GstRegistry * registry, const char *location);
  94
  95 void gst_registry_scan_paths (GstRegistry *registry);
  96 void _gst_registry_remove_cache_plugins (GstRegistry *registry);
  97
  98 #define gst_default_registry_add_plugin(plugin) \
  99   gst_registry_add_plugin (gst_registry_get_default(), plugin)
 100 #define gst_default_registry_add_path(path) \
 101   gst_registry_add_path (gst_registry_get_default(), path)
 102 #define gst_default_registry_get_path_list() \
 103   gst_registry_get_path_list (gst_registry_get_default())
 104 #define gst_default_registry_get_plugin_list() \
 105   gst_registry_get_plugin_list (gst_registry_get_default())
 106 #define gst_default_registry_find_feature(name,type) \
 107   gst_registry_find_feature (gst_registry_get_default(),name,type)
 108 #define gst_default_registry_find_plugin(name) \
 109   gst_registry_find_plugin (gst_registry_get_default(),name)
 110 #define gst_default_registry_feature_filter(filter,first,user_data) \
 111   gst_registry_feature_filter (gst_registry_get_default(),filter,first,user_data)
 112
 113 G_END_DECLS
 114
 115 #endif /* __GST_REGISTRY_H__ */
 116