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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, 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 G_GNUC_INTERNAL gboolean priv_gst_plugin_loading_have_whitelist (void);
90 G_GNUC_INTERNAL guint32 priv_gst_plugin_loading_get_whitelist_hash (void);
92 G_GNUC_INTERNAL gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
93 const gchar * filename);
95 G_GNUC_INTERNAL gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
97 G_GNUC_INTERNAL gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
99 G_GNUC_INTERNAL gboolean _priv_gst_in_valgrind (void);
101 /* init functions called from gst_init(). */
102 G_GNUC_INTERNAL void _priv_gst_quarks_initialize (void);
103 G_GNUC_INTERNAL void _priv_gst_mini_object_initialize (void);
104 G_GNUC_INTERNAL void _priv_gst_buffer_initialize (void);
105 G_GNUC_INTERNAL void _priv_gst_buffer_list_initialize (void);
106 G_GNUC_INTERNAL void _priv_gst_structure_initialize (void);
107 G_GNUC_INTERNAL void _priv_gst_caps_initialize (void);
108 G_GNUC_INTERNAL void _priv_gst_event_initialize (void);
109 G_GNUC_INTERNAL void _priv_gst_format_initialize (void);
110 G_GNUC_INTERNAL void _priv_gst_message_initialize (void);
111 G_GNUC_INTERNAL void _priv_gst_memory_initialize (void);
112 G_GNUC_INTERNAL void _priv_gst_meta_initialize (void);
113 G_GNUC_INTERNAL void _priv_gst_plugin_initialize (void);
114 G_GNUC_INTERNAL void _priv_gst_query_initialize (void);
115 G_GNUC_INTERNAL void _priv_gst_sample_initialize (void);
116 G_GNUC_INTERNAL void _priv_gst_tag_initialize (void);
117 G_GNUC_INTERNAL void _priv_gst_value_initialize (void);
118 G_GNUC_INTERNAL void _priv_gst_debug_init (void);
120 /* Private registry functions */
122 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
124 G_GNUC_INTERNAL void _priv_gst_registry_cleanup (void);
126 gboolean _gst_plugin_loader_client_run (void);
128 /* Used in GstBin for manual state handling */
129 G_GNUC_INTERNAL void _priv_gst_element_state_changed (GstElement *element,
130 GstState oldstate, GstState newstate, GstState pending);
132 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
133 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + gst_structure_n_fields(s) * 22)
136 gboolean priv_gst_structure_append_to_gstring (const GstStructure * structure,
138 /* registry cache backends */
140 gboolean priv_gst_registry_binary_read_cache (GstRegistry * registry, const char *location);
143 gboolean priv_gst_registry_binary_write_cache (GstRegistry * registry, GList * plugins, const char *location);
147 void __gst_element_factory_add_static_pad_template (GstElementFactory * elementfactory,
148 GstStaticPadTemplate * templ);
151 void __gst_element_factory_add_interface (GstElementFactory * elementfactory,
152 const gchar * interfacename);
154 /* used in gstvalue.c and gststructure.c */
155 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
156 ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
159 /* This is only meant for internal uses */
161 gint __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2);
164 gchar * __gst_date_time_serialize (GstDateTime * datetime, gboolean with_usecs);
166 #ifndef GST_DISABLE_REGISTRY
167 /* Secret variable to initialise gst without registry cache */
168 GST_EXPORT gboolean _gst_disable_registry_cache;
171 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
172 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
173 static inline ret_type \
174 gst_g_value_get_##name_type##_unchecked (const GValue *value) \
176 return value->data[0].v_field; \
179 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
180 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
181 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
182 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
183 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
184 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
185 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
186 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
189 /*** debugging categories *****************************************************/
191 #ifndef GST_REMOVE_GST_DEBUG
193 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
194 GST_EXPORT GstDebugCategory *GST_CAT_MEMORY;
195 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
196 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
197 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
198 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
199 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
200 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
201 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
202 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
203 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
204 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
205 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
206 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
207 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
208 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
209 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
210 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
211 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
212 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
213 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
214 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
215 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
216 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
217 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
218 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
219 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
220 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
221 GST_EXPORT GstDebugCategory *GST_CAT_META;
222 GST_EXPORT GstDebugCategory *GST_CAT_LOCKING;
224 /* Categories that should be completely private to
225 * libgstreamer should be done like this: */
226 #define GST_CAT_POLL _priv_GST_CAT_POLL
227 extern GstDebugCategory *_priv_GST_CAT_POLL;
231 #define GST_CAT_GST_INIT NULL
232 #define GST_CAT_AUTOPLUG NULL
233 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
234 #define GST_CAT_PARENTAGE NULL
235 #define GST_CAT_STATES NULL
236 #define GST_CAT_SCHEDULING NULL
237 #define GST_CAT_DATAFLOW NULL
238 #define GST_CAT_BUFFER NULL
239 #define GST_CAT_BUFFER_LIST NULL
240 #define GST_CAT_BUS NULL
241 #define GST_CAT_CAPS NULL
242 #define GST_CAT_CLOCK NULL
243 #define GST_CAT_ELEMENT_PADS NULL
244 #define GST_CAT_PADS NULL
245 #define GST_CAT_PERFORMANCE NULL
246 #define GST_CAT_PIPELINE NULL
247 #define GST_CAT_PLUGIN_LOADING NULL
248 #define GST_CAT_PLUGIN_INFO NULL
249 #define GST_CAT_PROPERTIES NULL
250 #define GST_CAT_NEGOTIATION NULL
251 #define GST_CAT_REFCOUNTING NULL
252 #define GST_CAT_ERROR_SYSTEM NULL
253 #define GST_CAT_EVENT NULL
254 #define GST_CAT_MESSAGE NULL
255 #define GST_CAT_PARAMS NULL
256 #define GST_CAT_CALL_TRACE NULL
257 #define GST_CAT_SIGNAL NULL
258 #define GST_CAT_PROBE NULL
259 #define GST_CAT_REGISTRY NULL
260 #define GST_CAT_QOS NULL
261 #define GST_CAT_TYPES NULL
262 #define GST_CAT_POLL NULL
263 #define GST_CAT_META NULL
264 #define GST_CAT_LOCKING NULL
269 /**** objects made opaque until the private bits have been made private ****/
272 #include <time.h> /* time_t */
273 #include <sys/types.h> /* off_t */
274 #include <sys/stat.h> /* off_t */
276 typedef struct _GstPluginPrivate GstPluginPrivate;
284 GstPluginDesc *orig_desc;
287 gchar * basename; /* base name (non-dir part) of plugin path */
289 GModule * module; /* contains the module if plugin is loaded */
293 gboolean registered; /* TRUE when the registry has seen a filename
294 * that matches the plugin's basename */
296 GstPluginPrivate *priv;
298 gpointer _gst_reserved[GST_PADDING];
301 struct _GstPluginClass {
302 GstObjectClass object_class;
305 gpointer _gst_reserved[GST_PADDING];
308 struct _GstPluginFeature {
315 const gchar *plugin_name;
316 GstPlugin *plugin; /* weak ref */
319 gpointer _gst_reserved[GST_PADDING];
322 struct _GstPluginFeatureClass {
323 GstObjectClass parent_class;
326 gpointer _gst_reserved[GST_PADDING];
329 #include "gsttypefind.h"
331 struct _GstTypeFindFactory {
332 GstPluginFeature feature;
335 GstTypeFindFunction function;
337 GstCaps * caps; /* FIXME: not yet saved in registry */
340 GDestroyNotify user_data_notify;
342 gpointer _gst_reserved[GST_PADDING];
345 struct _GstTypeFindFactoryClass {
346 GstPluginFeatureClass parent;
349 gpointer _gst_reserved[GST_PADDING];
352 struct _GstElementFactory {
353 GstPluginFeature parent;
355 GType type; /* unique GType of element or 0 if not loaded */
359 GList * staticpadtemplates; /* GstStaticPadTemplate list */
360 guint numpadtemplates;
362 /* URI interface stuff */
364 gchar ** uri_protocols;
366 GList * interfaces; /* interface type names this element implements */
369 gpointer _gst_reserved[GST_PADDING];
372 struct _GstElementFactoryClass {
373 GstPluginFeatureClass parent_class;
375 gpointer _gst_reserved[GST_PADDING];
379 #endif /* __GST_PRIVATE_H__ */