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"
62 /* used by gstparse.c and grammar.y */
63 struct _GstParseContext {
64 GList * missing_elements;
67 /* used by gstplugin.c and gstregistrybinary.c */
69 /* details registered via gst_plugin_add_dependency() */
70 GstPluginDependencyFlags flags;
75 /* information saved from the last time the plugin was loaded (-1 = unset) */
76 guint env_hash; /* hash of content of environment variables in env_vars */
77 guint stat_hash; /* hash of stat() on all relevant files and directories */
80 struct _GstPluginPrivate {
81 GList *deps; /* list of GstPluginDep structures */
82 GstStructure *cache_data;
85 /* FIXME: could rename all priv_gst_* functions to __gst_* now */
86 gboolean priv_gst_plugin_loading_have_whitelist (void);
88 guint32 priv_gst_plugin_loading_get_whitelist_hash (void);
90 gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
91 const gchar * filename);
93 gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
94 gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
96 gboolean _priv_gst_in_valgrind (void);
98 /* init functions called from gst_init(). */
99 void _priv_gst_quarks_initialize (void);
100 void _priv_gst_mini_object_initialize (void);
101 void _priv_gst_buffer_initialize (void);
102 void _priv_gst_buffer_list_initialize (void);
103 void _priv_gst_structure_initialize (void);
104 void _priv_gst_caps_initialize (void);
105 void _priv_gst_event_initialize (void);
106 void _priv_gst_format_initialize (void);
107 void _priv_gst_message_initialize (void);
108 void _priv_gst_memory_initialize (void);
109 void _priv_gst_meta_initialize (void);
110 void _priv_gst_plugin_initialize (void);
111 void _priv_gst_query_initialize (void);
112 void _priv_gst_sample_initialize (void);
113 void _priv_gst_tag_initialize (void);
114 void _priv_gst_value_initialize (void);
115 void _priv_gst_debug_init (void);
116 void _priv_gst_toc_initialize (void);
119 /* These functions are used to parse TOC messages, events and queries */
120 GstToc* __gst_toc_from_structure (const GstStructure *toc);
121 GstStructure* __gst_toc_to_structure (const GstToc *toc);
122 gboolean __gst_toc_structure_get_updated (const GstStructure * toc);
123 void __gst_toc_structure_set_updated (GstStructure * toc, gboolean updated);
124 gchar* __gst_toc_structure_get_extend_uid (const GstStructure * toc);
125 void __gst_toc_structure_set_extend_uid (GstStructure * toc, const gchar * extend_uid);
127 /* Private registry functions */
128 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
129 void _priv_gst_registry_cleanup (void);
130 gboolean _gst_plugin_loader_client_run (void);
132 /* Used in GstBin for manual state handling */
133 void _priv_gst_element_state_changed (GstElement *element, GstState oldstate,
134 GstState newstate, GstState pending);
136 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
137 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + gst_structure_n_fields(s) * 22)
139 gboolean priv_gst_structure_append_to_gstring (const GstStructure * structure,
141 /* registry cache backends */
142 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);
145 void __gst_element_factory_add_static_pad_template (GstElementFactory * elementfactory,
146 GstStaticPadTemplate * templ);
148 void __gst_element_factory_add_interface (GstElementFactory * elementfactory,
149 const gchar * interfacename);
151 /* used in gstvalue.c and gststructure.c */
152 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
153 ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
156 /* This is only meant for internal uses */
157 gint priv_gst_date_time_compare (gconstpointer dt1, gconstpointer dt2);
159 #ifndef GST_DISABLE_REGISTRY
160 /* Secret variable to initialise gst without registry cache */
161 GST_EXPORT gboolean _gst_disable_registry_cache;
164 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
165 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
166 static inline ret_type \
167 gst_g_value_get_##name_type##_unchecked (const GValue *value) \
169 return value->data[0].v_field; \
172 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
173 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
174 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
175 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
176 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
177 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
178 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
179 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
182 /*** debugging categories *****************************************************/
184 #ifndef GST_REMOVE_GST_DEBUG
186 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
187 GST_EXPORT GstDebugCategory *GST_CAT_MEMORY;
188 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
189 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
190 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
191 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
192 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
193 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
194 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
195 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
196 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
197 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
198 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
199 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
200 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
201 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
202 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
203 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
204 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
205 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
206 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
207 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
208 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
209 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
210 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
211 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
212 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
213 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
214 GST_EXPORT GstDebugCategory *GST_CAT_META;
216 /* Categories that should be completely private to
217 * libgstreamer should be done like this: */
218 #define GST_CAT_POLL _priv_GST_CAT_POLL
219 extern GstDebugCategory *_priv_GST_CAT_POLL;
223 #define GST_CAT_GST_INIT NULL
224 #define GST_CAT_AUTOPLUG NULL
225 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
226 #define GST_CAT_PARENTAGE NULL
227 #define GST_CAT_STATES NULL
228 #define GST_CAT_SCHEDULING NULL
229 #define GST_CAT_DATAFLOW NULL
230 #define GST_CAT_BUFFER NULL
231 #define GST_CAT_BUFFER_LIST NULL
232 #define GST_CAT_BUS NULL
233 #define GST_CAT_CAPS NULL
234 #define GST_CAT_CLOCK NULL
235 #define GST_CAT_ELEMENT_PADS NULL
236 #define GST_CAT_PADS NULL
237 #define GST_CAT_PERFORMANCE NULL
238 #define GST_CAT_PIPELINE NULL
239 #define GST_CAT_PLUGIN_LOADING NULL
240 #define GST_CAT_PLUGIN_INFO NULL
241 #define GST_CAT_PROPERTIES NULL
242 #define GST_CAT_NEGOTIATION NULL
243 #define GST_CAT_REFCOUNTING NULL
244 #define GST_CAT_ERROR_SYSTEM NULL
245 #define GST_CAT_EVENT NULL
246 #define GST_CAT_MESSAGE NULL
247 #define GST_CAT_PARAMS NULL
248 #define GST_CAT_CALL_TRACE NULL
249 #define GST_CAT_SIGNAL NULL
250 #define GST_CAT_PROBE NULL
251 #define GST_CAT_REGISTRY NULL
252 #define GST_CAT_QOS NULL
253 #define GST_CAT_TYPES NULL
254 #define GST_CAT_POLL NULL
255 #define GST_CAT_META NULL
260 /**** objects made opaque until the private bits have been made private ****/
263 #include <time.h> /* time_t */
264 #include <sys/types.h> /* off_t */
265 #include <sys/stat.h> /* off_t */
267 typedef struct _GstPluginPrivate GstPluginPrivate;
275 GstPluginDesc *orig_desc;
278 gchar * basename; /* base name (non-dir part) of plugin path */
280 GModule * module; /* contains the module if plugin is loaded */
284 gboolean registered; /* TRUE when the registry has seen a filename
285 * that matches the plugin's basename */
287 GstPluginPrivate *priv;
289 gpointer _gst_reserved[GST_PADDING];
292 struct _GstPluginClass {
293 GstObjectClass object_class;
296 gpointer _gst_reserved[GST_PADDING];
301 #endif /* __GST_PRIVATE_H__ */