2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gst_private.h: Private header for within libgst
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.
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.
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.
23 #ifndef __GST_PRIVATE_H__
24 #define __GST_PRIVATE_H__
27 # ifndef GST_LICENSE /* don't include config.h twice, it has no guards */
32 /* This needs to be before glib.h, since it might be used in inline
34 extern const char g_log_domain_gstreamer[];
41 /* Needed for GstRegistry * */
42 #include "gstregistry.h"
43 #include "gststructure.h"
45 /* we need this in pretty much all files */
48 /* for the flags in the GstPluginDep structure below */
49 #include "gstplugin.h"
51 /* for the pad cache */
55 #include "gstelement.h"
60 #include "gstdatetime.h"
64 /* used by gstparse.c and grammar.y */
65 struct _GstParseContext {
66 GList * missing_elements;
69 /* used by gstplugin.c and gstregistrybinary.c */
71 /* details registered via gst_plugin_add_dependency() */
72 GstPluginDependencyFlags flags;
77 /* information saved from the last time the plugin was loaded (-1 = unset) */
78 guint env_hash; /* hash of content of environment variables in env_vars */
79 guint stat_hash; /* hash of stat() on all relevant files and directories */
82 struct _GstPluginPrivate {
83 GList *deps; /* list of GstPluginDep structures */
84 GstStructure *cache_data;
87 /* FIXME: could rename all priv_gst_* functions to __gst_* now */
88 gboolean priv_gst_plugin_loading_have_whitelist (void);
90 guint32 priv_gst_plugin_loading_get_whitelist_hash (void);
92 gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
93 const gchar * filename);
95 gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
96 gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
98 gboolean _priv_gst_in_valgrind (void);
100 /* init functions called from gst_init(). */
101 void _priv_gst_quarks_initialize (void);
102 void _priv_gst_mini_object_initialize (void);
103 void _priv_gst_buffer_initialize (void);
104 void _priv_gst_buffer_list_initialize (void);
105 void _priv_gst_structure_initialize (void);
106 void _priv_gst_caps_initialize (void);
107 void _priv_gst_event_initialize (void);
108 void _priv_gst_format_initialize (void);
109 void _priv_gst_message_initialize (void);
110 void _priv_gst_memory_initialize (void);
111 void _priv_gst_meta_initialize (void);
112 void _priv_gst_plugin_initialize (void);
113 void _priv_gst_query_initialize (void);
114 void _priv_gst_sample_initialize (void);
115 void _priv_gst_tag_initialize (void);
116 void _priv_gst_value_initialize (void);
117 void _priv_gst_debug_init (void);
119 /* Private registry functions */
120 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
121 void _priv_gst_registry_cleanup (void);
122 gboolean _gst_plugin_loader_client_run (void);
124 /* Used in GstBin for manual state handling */
125 void _priv_gst_element_state_changed (GstElement *element, GstState oldstate,
126 GstState newstate, GstState pending);
128 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
129 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + gst_structure_n_fields(s) * 22)
131 gboolean priv_gst_structure_append_to_gstring (const GstStructure * structure,
133 /* registry cache backends */
134 gboolean priv_gst_registry_binary_read_cache (GstRegistry * registry, const char *location);
135 gboolean priv_gst_registry_binary_write_cache (GstRegistry * registry, GList * plugins, const char *location);
137 void __gst_element_factory_add_static_pad_template (GstElementFactory * elementfactory,
138 GstStaticPadTemplate * templ);
140 void __gst_element_factory_add_interface (GstElementFactory * elementfactory,
141 const gchar * interfacename);
143 /* used in gstvalue.c and gststructure.c */
144 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
145 ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
148 /* This is only meant for internal uses */
149 gint __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2);
151 #ifndef GST_DISABLE_REGISTRY
152 /* Secret variable to initialise gst without registry cache */
153 GST_EXPORT gboolean _gst_disable_registry_cache;
156 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
157 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
158 static inline ret_type \
159 gst_g_value_get_##name_type##_unchecked (const GValue *value) \
161 return value->data[0].v_field; \
164 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
165 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
166 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
167 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
168 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
169 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
170 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
171 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
174 /*** debugging categories *****************************************************/
176 #ifndef GST_REMOVE_GST_DEBUG
178 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
179 GST_EXPORT GstDebugCategory *GST_CAT_MEMORY;
180 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
181 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
182 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
183 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
184 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
185 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
186 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
187 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
188 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
189 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
190 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
191 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
192 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
193 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
194 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
195 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
196 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
197 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
198 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
199 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
200 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
201 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
202 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
203 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
204 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
205 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
206 GST_EXPORT GstDebugCategory *GST_CAT_META;
207 GST_EXPORT GstDebugCategory *GST_CAT_LOCKING;
209 /* Categories that should be completely private to
210 * libgstreamer should be done like this: */
211 #define GST_CAT_POLL _priv_GST_CAT_POLL
212 extern GstDebugCategory *_priv_GST_CAT_POLL;
216 #define GST_CAT_GST_INIT NULL
217 #define GST_CAT_AUTOPLUG NULL
218 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
219 #define GST_CAT_PARENTAGE NULL
220 #define GST_CAT_STATES NULL
221 #define GST_CAT_SCHEDULING NULL
222 #define GST_CAT_DATAFLOW NULL
223 #define GST_CAT_BUFFER NULL
224 #define GST_CAT_BUFFER_LIST NULL
225 #define GST_CAT_BUS NULL
226 #define GST_CAT_CAPS NULL
227 #define GST_CAT_CLOCK NULL
228 #define GST_CAT_ELEMENT_PADS NULL
229 #define GST_CAT_PADS NULL
230 #define GST_CAT_PERFORMANCE NULL
231 #define GST_CAT_PIPELINE NULL
232 #define GST_CAT_PLUGIN_LOADING NULL
233 #define GST_CAT_PLUGIN_INFO NULL
234 #define GST_CAT_PROPERTIES NULL
235 #define GST_CAT_NEGOTIATION NULL
236 #define GST_CAT_REFCOUNTING NULL
237 #define GST_CAT_ERROR_SYSTEM NULL
238 #define GST_CAT_EVENT NULL
239 #define GST_CAT_MESSAGE NULL
240 #define GST_CAT_PARAMS NULL
241 #define GST_CAT_CALL_TRACE NULL
242 #define GST_CAT_SIGNAL NULL
243 #define GST_CAT_PROBE NULL
244 #define GST_CAT_REGISTRY NULL
245 #define GST_CAT_QOS NULL
246 #define GST_CAT_TYPES NULL
247 #define GST_CAT_POLL NULL
248 #define GST_CAT_META NULL
249 #define GST_CAT_LOCKING NULL
254 /**** objects made opaque until the private bits have been made private ****/
257 #include <time.h> /* time_t */
258 #include <sys/types.h> /* off_t */
259 #include <sys/stat.h> /* off_t */
261 typedef struct _GstPluginPrivate GstPluginPrivate;
269 GstPluginDesc *orig_desc;
272 gchar * basename; /* base name (non-dir part) of plugin path */
274 GModule * module; /* contains the module if plugin is loaded */
278 gboolean registered; /* TRUE when the registry has seen a filename
279 * that matches the plugin's basename */
281 GstPluginPrivate *priv;
283 gpointer _gst_reserved[GST_PADDING];
286 struct _GstPluginClass {
287 GstObjectClass object_class;
290 gpointer _gst_reserved[GST_PADDING];
293 struct _GstPluginFeature {
300 const gchar *plugin_name;
301 GstPlugin *plugin; /* weak ref */
304 gpointer _gst_reserved[GST_PADDING];
307 struct _GstPluginFeatureClass {
308 GstObjectClass parent_class;
311 gpointer _gst_reserved[GST_PADDING];
314 #include "gsttypefind.h"
316 struct _GstTypeFindFactory {
317 GstPluginFeature feature;
320 GstTypeFindFunction function;
322 GstCaps * caps; /* FIXME: not yet saved in registry */
325 GDestroyNotify user_data_notify;
327 gpointer _gst_reserved[GST_PADDING];
330 struct _GstTypeFindFactoryClass {
331 GstPluginFeatureClass parent;
334 gpointer _gst_reserved[GST_PADDING];
337 struct _GstElementFactory {
338 GstPluginFeature parent;
340 GType type; /* unique GType of element or 0 if not loaded */
344 GList * staticpadtemplates; /* GstStaticPadTemplate list */
345 guint numpadtemplates;
347 /* URI interface stuff */
349 gchar ** uri_protocols;
351 GList * interfaces; /* interface type names this element implements */
354 gpointer _gst_reserved[GST_PADDING];
357 struct _GstElementFactoryClass {
358 GstPluginFeatureClass parent_class;
360 gpointer _gst_reserved[GST_PADDING];
364 #endif /* __GST_PRIVATE_H__ */