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"
59 /* used by gstparse.c and grammar.y */
60 struct _GstParseContext {
61 GList * missing_elements;
64 /* used by gstplugin.c and gstregistrybinary.c */
66 /* details registered via gst_plugin_add_dependency() */
67 GstPluginDependencyFlags flags;
72 /* information saved from the last time the plugin was loaded (-1 = unset) */
73 guint env_hash; /* hash of content of environment variables in env_vars */
74 guint stat_hash; /* hash of stat() on all relevant files and directories */
77 struct _GstPluginPrivate {
78 GList *deps; /* list of GstPluginDep structures */
79 GstStructure *cache_data;
82 gboolean priv_gst_plugin_loading_have_whitelist (void);
84 guint32 priv_gst_plugin_loading_get_whitelist_hash (void);
86 gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
87 const gchar * filename);
89 gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
90 gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
92 gboolean _priv_gst_in_valgrind (void);
94 /* Initialize GStreamer private quark storage */
95 void _priv_gst_quarks_initialize (void);
97 /* Other init functions called from gst_init().
98 * FIXME 0.11: rename to _priv_gst_foo_init() so they don't get exported
99 * (can't do this now because these functions used to be in our public
100 * headers, so at least the symbols need to continue to be available unless
101 * we want enterprise edition packagers dancing on our heads) */
102 void _gst_buffer_initialize (void);
103 void _gst_buffer_list_initialize (void);
104 void _gst_structure_initialize (void);
105 void _gst_caps_initialize (void);
106 void _gst_event_initialize (void);
107 void _gst_format_initialize (void);
108 void _gst_message_initialize (void);
109 void _gst_plugin_initialize (void);
110 void _gst_query_initialize (void);
111 void _gst_tag_initialize (void);
112 void _gst_value_initialize (void);
114 /* Private registry functions */
115 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
116 void _priv_gst_registry_cleanup (void);
117 gboolean _gst_plugin_loader_client_run (void);
119 void _priv_gst_pad_invalidate_cache (GstPad *pad);
121 /* Used in GstBin for manual state handling */
122 void _priv_gst_element_state_changed (GstElement *element, GstState oldstate,
123 GstState newstate, GstState pending);
125 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
126 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + gst_structure_n_fields(s) * 22)
128 gboolean priv_gst_structure_append_to_gstring (const GstStructure * structure,
130 /* registry cache backends */
131 /* FIXME 0.11: use priv_ prefix */
132 gboolean gst_registry_binary_read_cache (GstRegistry * registry, const char *location);
133 gboolean gst_registry_binary_write_cache (GstRegistry * registry, const char *location);
135 /* used in gstvalue.c and gststructure.c */
136 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
137 ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
140 /* This is only meant for internal uses */
141 gint priv_gst_date_time_compare (gconstpointer dt1, gconstpointer dt2);
143 #ifndef GST_DISABLE_REGISTRY
144 /* Secret variable to initialise gst without registry cache */
145 extern gboolean _gst_disable_registry_cache;
148 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
149 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
150 static inline ret_type \
151 gst_g_value_get_##name_type##_unchecked (const GValue *value) \
153 return value->data[0].v_field; \
156 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
157 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
158 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
159 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
160 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
161 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
162 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
163 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
166 /*** debugging categories *****************************************************/
168 #ifndef GST_REMOVE_GST_DEBUG
170 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
171 GST_EXPORT GstDebugCategory *GST_CAT_AUTOPLUG; /* FIXME 0.11: remove? */
172 GST_EXPORT GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT; /* FIXME 0.11: remove? */
173 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
174 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
175 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
176 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
177 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
178 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
179 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
180 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
181 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
182 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
183 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
184 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
185 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
186 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
187 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
188 GST_EXPORT GstDebugCategory *GST_CAT_XML;
189 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
190 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
191 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
192 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
193 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
194 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
195 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
196 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
197 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
198 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
199 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
200 GST_EXPORT GstDebugCategory *GST_CAT_TYPES; /* FIXME 0.11: remove? */
202 /* Categories that should be completely private to
203 * libgstreamer should be done like this: */
204 #define GST_CAT_POLL _priv_GST_CAT_POLL
205 extern GstDebugCategory *_priv_GST_CAT_POLL;
209 #define GST_CAT_GST_INIT NULL
210 #define GST_CAT_AUTOPLUG NULL
211 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
212 #define GST_CAT_PARENTAGE NULL
213 #define GST_CAT_STATES NULL
214 #define GST_CAT_SCHEDULING NULL
215 #define GST_CAT_DATAFLOW NULL
216 #define GST_CAT_BUFFER NULL
217 #define GST_CAT_BUFFER_LIST NULL
218 #define GST_CAT_BUS NULL
219 #define GST_CAT_CAPS NULL
220 #define GST_CAT_CLOCK NULL
221 #define GST_CAT_ELEMENT_PADS NULL
222 #define GST_CAT_PADS NULL
223 #define GST_CAT_PERFORMANCE NULL
224 #define GST_CAT_PIPELINE NULL
225 #define GST_CAT_PLUGIN_LOADING NULL
226 #define GST_CAT_PLUGIN_INFO NULL
227 #define GST_CAT_PROPERTIES NULL
228 #define GST_CAT_XML NULL
229 #define GST_CAT_NEGOTIATION NULL
230 #define GST_CAT_REFCOUNTING NULL
231 #define GST_CAT_ERROR_SYSTEM NULL
232 #define GST_CAT_EVENT NULL
233 #define GST_CAT_MESSAGE NULL
234 #define GST_CAT_PARAMS NULL
235 #define GST_CAT_CALL_TRACE NULL
236 #define GST_CAT_SIGNAL NULL
237 #define GST_CAT_PROBE NULL
238 #define GST_CAT_REGISTRY NULL
239 #define GST_CAT_QOS NULL
240 #define GST_CAT_TYPES NULL
241 #define GST_CAT_POLL NULL
247 #endif /* __GST_PRIVATE_H__ */