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"
57 /* for GstDeviceProvider */
58 #include "gstdeviceprovider.h"
63 #include "gstdatetime.h"
67 /* used by gstparse.c and grammar.y */
68 struct _GstParseContext {
69 GList * missing_elements;
72 /* used by gstplugin.c and gstregistrybinary.c */
74 /* details registered via gst_plugin_add_dependency() */
75 GstPluginDependencyFlags flags;
80 /* information saved from the last time the plugin was loaded (-1 = unset) */
81 guint env_hash; /* hash of content of environment variables in env_vars */
82 guint stat_hash; /* hash of stat() on all relevant files and directories */
85 struct _GstPluginPrivate {
86 GList *deps; /* list of GstPluginDep structures */
87 GstStructure *cache_data;
90 /* FIXME: could rename all priv_gst_* functions to __gst_* now */
91 G_GNUC_INTERNAL gboolean priv_gst_plugin_loading_have_whitelist (void);
93 G_GNUC_INTERNAL guint32 priv_gst_plugin_loading_get_whitelist_hash (void);
95 G_GNUC_INTERNAL gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
96 const gchar * filename);
98 G_GNUC_INTERNAL gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
100 G_GNUC_INTERNAL gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
102 G_GNUC_INTERNAL gboolean _priv_gst_in_valgrind (void);
104 /* init functions called from gst_init(). */
105 G_GNUC_INTERNAL void _priv_gst_quarks_initialize (void);
106 G_GNUC_INTERNAL void _priv_gst_mini_object_initialize (void);
107 G_GNUC_INTERNAL void _priv_gst_memory_initialize (void);
108 G_GNUC_INTERNAL void _priv_gst_allocator_initialize (void);
109 G_GNUC_INTERNAL void _priv_gst_buffer_initialize (void);
110 G_GNUC_INTERNAL void _priv_gst_buffer_list_initialize (void);
111 G_GNUC_INTERNAL void _priv_gst_structure_initialize (void);
112 G_GNUC_INTERNAL void _priv_gst_caps_initialize (void);
113 G_GNUC_INTERNAL void _priv_gst_caps_features_initialize (void);
114 G_GNUC_INTERNAL void _priv_gst_event_initialize (void);
115 G_GNUC_INTERNAL void _priv_gst_format_initialize (void);
116 G_GNUC_INTERNAL void _priv_gst_message_initialize (void);
117 G_GNUC_INTERNAL void _priv_gst_meta_initialize (void);
118 G_GNUC_INTERNAL void _priv_gst_plugin_initialize (void);
119 G_GNUC_INTERNAL void _priv_gst_query_initialize (void);
120 G_GNUC_INTERNAL void _priv_gst_sample_initialize (void);
121 G_GNUC_INTERNAL void _priv_gst_tag_initialize (void);
122 G_GNUC_INTERNAL void _priv_gst_value_initialize (void);
123 G_GNUC_INTERNAL void _priv_gst_debug_init (void);
124 G_GNUC_INTERNAL void _priv_gst_context_initialize (void);
125 G_GNUC_INTERNAL void _priv_gst_toc_initialize (void);
126 G_GNUC_INTERNAL void _priv_gst_date_time_initialize (void);
128 /* Private registry functions */
130 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
132 G_GNUC_INTERNAL void _priv_gst_registry_cleanup (void);
134 gboolean _gst_plugin_loader_client_run (void);
136 /* Used in GstBin for manual state handling */
137 G_GNUC_INTERNAL void _priv_gst_element_state_changed (GstElement *element,
138 GstState oldstate, GstState newstate, GstState pending);
140 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
141 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + gst_structure_n_fields(s) * 22)
142 #define FEATURES_ESTIMATED_STRING_LEN(s) (16 + gst_caps_features_get_size(s) * 14)
145 gboolean priv_gst_structure_append_to_gstring (const GstStructure * structure,
148 void priv_gst_caps_features_append_to_gstring (const GstCapsFeatures * features, GString *s);
151 gboolean priv_gst_structure_parse_name (gchar * str, gchar **start, gchar ** end, gchar ** next);
153 gboolean priv_gst_structure_parse_fields (gchar *str, gchar ** end, GstStructure *structure);
155 /* registry cache backends */
157 gboolean priv_gst_registry_binary_read_cache (GstRegistry * registry, const char *location);
160 gboolean priv_gst_registry_binary_write_cache (GstRegistry * registry, GList * plugins, const char *location);
164 void __gst_element_factory_add_static_pad_template (GstElementFactory * elementfactory,
165 GstStaticPadTemplate * templ);
168 void __gst_element_factory_add_interface (GstElementFactory * elementfactory,
169 const gchar * interfacename);
171 /* used in gstvalue.c and gststructure.c */
172 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
173 ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
176 /* This is only meant for internal uses */
178 gint __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2);
181 gchar * __gst_date_time_serialize (GstDateTime * datetime, gboolean with_usecs);
183 /* Non-static, for access from the testsuite, but not for external use */
185 _priv_gst_do_linear_regression (GstClockTime *times, guint n,
186 GstClockTime * m_num, GstClockTime * m_denom, GstClockTime * b,
187 GstClockTime * xbase, gdouble * r_squared);
189 #ifndef GST_DISABLE_REGISTRY
190 /* Secret variable to initialise gst without registry cache */
191 GST_EXPORT gboolean _gst_disable_registry_cache;
194 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
195 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
196 static inline ret_type \
197 gst_g_value_get_##name_type##_unchecked (const GValue *value) \
199 return value->data[0].v_field; \
202 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
203 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
204 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
205 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
206 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
207 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
208 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
209 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
212 /*** debugging categories *****************************************************/
214 #ifndef GST_REMOVE_GST_DEBUG
216 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
217 GST_EXPORT GstDebugCategory *GST_CAT_MEMORY;
218 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
219 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
220 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
221 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
222 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
223 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
224 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
225 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
226 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
227 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
228 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
229 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
230 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
231 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
232 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
233 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
234 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
235 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
236 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
237 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
238 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
239 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
240 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
241 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
242 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
243 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
244 GST_EXPORT GstDebugCategory *GST_CAT_META;
245 GST_EXPORT GstDebugCategory *GST_CAT_LOCKING;
246 GST_EXPORT GstDebugCategory *GST_CAT_CONTEXT;
248 /* Categories that should be completely private to
249 * libgstreamer should be done like this: */
250 #define GST_CAT_POLL _priv_GST_CAT_POLL
251 extern GstDebugCategory *_priv_GST_CAT_POLL;
253 extern GstClockTime _priv_gst_info_start_time;
257 #define GST_CAT_GST_INIT NULL
258 #define GST_CAT_AUTOPLUG NULL
259 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
260 #define GST_CAT_PARENTAGE NULL
261 #define GST_CAT_STATES NULL
262 #define GST_CAT_SCHEDULING NULL
263 #define GST_CAT_DATAFLOW NULL
264 #define GST_CAT_BUFFER NULL
265 #define GST_CAT_BUFFER_LIST NULL
266 #define GST_CAT_BUS NULL
267 #define GST_CAT_CAPS NULL
268 #define GST_CAT_CLOCK NULL
269 #define GST_CAT_ELEMENT_PADS NULL
270 #define GST_CAT_PADS NULL
271 #define GST_CAT_PERFORMANCE NULL
272 #define GST_CAT_PIPELINE NULL
273 #define GST_CAT_PLUGIN_LOADING NULL
274 #define GST_CAT_PLUGIN_INFO NULL
275 #define GST_CAT_PROPERTIES NULL
276 #define GST_CAT_NEGOTIATION NULL
277 #define GST_CAT_REFCOUNTING NULL
278 #define GST_CAT_ERROR_SYSTEM NULL
279 #define GST_CAT_EVENT NULL
280 #define GST_CAT_MESSAGE NULL
281 #define GST_CAT_PARAMS NULL
282 #define GST_CAT_CALL_TRACE NULL
283 #define GST_CAT_SIGNAL NULL
284 #define GST_CAT_PROBE NULL
285 #define GST_CAT_REGISTRY NULL
286 #define GST_CAT_QOS NULL
287 #define GST_CAT_TYPES NULL
288 #define GST_CAT_POLL NULL
289 #define GST_CAT_META NULL
290 #define GST_CAT_LOCKING NULL
291 #define GST_CAT_CONTEXT NULL
295 #ifdef GST_DISABLE_GST_DEBUG
296 /* for _gst_element_error_printf */
297 #define __gst_vasprintf __gst_info_fallback_vasprintf
298 int __gst_vasprintf (char **result, char const *format, va_list args);
301 /**** objects made opaque until the private bits have been made private ****/
304 #include <time.h> /* time_t */
305 #include <sys/types.h> /* off_t */
306 #include <sys/stat.h> /* off_t */
308 typedef struct _GstPluginPrivate GstPluginPrivate;
316 GstPluginDesc *orig_desc;
319 gchar * basename; /* base name (non-dir part) of plugin path */
321 GModule * module; /* contains the module if plugin is loaded */
325 gboolean registered; /* TRUE when the registry has seen a filename
326 * that matches the plugin's basename */
328 GstPluginPrivate *priv;
330 gpointer _gst_reserved[GST_PADDING];
333 struct _GstPluginClass {
334 GstObjectClass object_class;
337 gpointer _gst_reserved[GST_PADDING];
340 struct _GstPluginFeature {
347 const gchar *plugin_name;
348 GstPlugin *plugin; /* weak ref */
351 gpointer _gst_reserved[GST_PADDING];
354 struct _GstPluginFeatureClass {
355 GstObjectClass parent_class;
358 gpointer _gst_reserved[GST_PADDING];
361 #include "gsttypefind.h"
363 struct _GstTypeFindFactory {
364 GstPluginFeature feature;
367 GstTypeFindFunction function;
372 GDestroyNotify user_data_notify;
374 gpointer _gst_reserved[GST_PADDING];
377 struct _GstTypeFindFactoryClass {
378 GstPluginFeatureClass parent;
381 gpointer _gst_reserved[GST_PADDING];
384 struct _GstElementFactory {
385 GstPluginFeature parent;
387 GType type; /* unique GType of element or 0 if not loaded */
391 GList * staticpadtemplates; /* GstStaticPadTemplate list */
392 guint numpadtemplates;
394 /* URI interface stuff */
396 gchar ** uri_protocols;
398 GList * interfaces; /* interface type names this element implements */
401 gpointer _gst_reserved[GST_PADDING];
404 struct _GstElementFactoryClass {
405 GstPluginFeatureClass parent_class;
407 gpointer _gst_reserved[GST_PADDING];
410 struct _GstDeviceProviderFactory {
411 GstPluginFeature feature;
414 GType type; /* unique GType the device factory or 0 if not loaded */
416 volatile GstDeviceProvider *provider;
419 gpointer _gst_reserved[GST_PADDING];
422 struct _GstDeviceProviderFactoryClass {
423 GstPluginFeatureClass parent;
426 gpointer _gst_reserved[GST_PADDING];
429 /* privat flag used by GstBus / GstMessage */
430 #define GST_MESSAGE_FLAG_ASYNC_DELIVERY (GST_MINI_OBJECT_FLAG_LAST << 0)
433 #endif /* __GST_PRIVATE_H__ */