gst/gst_private.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gst_private.h: Private header for within libgst
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #ifndef __GST_PRIVATE_H__
  24 #define __GST_PRIVATE_H__
  25
  26 #ifdef HAVE_CONFIG_H
  27 # ifndef GST_LICENSE   /* don't include config.h twice, it has no guards */
  28 #  include "config.h"
  29 # endif
  30 #endif
  31
  32 /* This needs to be before glib.h, since it might be used in inline
  33  * functions */
  34 extern const char             g_log_domain_gstreamer[];
  35
  36 #include <glib.h>
  37
  38 #include <stdlib.h>
  39 #include <string.h>
  40
  41 /* Needed for GST_EXPORT */
  42 #include "gstconfig.h"
  43
  44 /* Needed for GstRegistry * */
  45 #include "gstregistry.h"
  46 #include "gststructure.h"
  47
  48 /* we need this in pretty much all files */
  49 #include "gstinfo.h"
  50
  51 /* for the flags in the GstPluginDep structure below */
  52 #include "gstplugin.h"
  53
  54 /* for the pad cache */
  55 #include "gstpad.h"
  56
  57 /* for GstElement */
  58 #include "gstelement.h"
  59
  60 /* for GstDeviceProvider */
  61 #include "gstdeviceprovider.h"
  62
  63 /* for GstToc */
  64 #include "gsttoc.h"
  65
  66 #include "gstdatetime.h"
  67
  68 #include "gsttracerutils.h"
  69
  70 G_BEGIN_DECLS
  71
  72 /* used by gstparse.c and grammar.y */
  73 struct _GstParseContext {
  74   GList * missing_elements;
  75 };
  76
  77 /* used by gstplugin.c and gstregistrybinary.c */
  78 typedef struct {
  79   /* details registered via gst_plugin_add_dependency() */
  80   GstPluginDependencyFlags  flags;
  81   gchar **env_vars;
  82   gchar **paths;
  83   gchar **names;
  84
  85   /* information saved from the last time the plugin was loaded (-1 = unset) */
  86   guint   env_hash;  /* hash of content of environment variables in env_vars */
  87   guint   stat_hash; /* hash of stat() on all relevant files and directories */
  88 } GstPluginDep;
  89
  90 struct _GstPluginPrivate {
  91   GList *deps;    /* list of GstPluginDep structures */
  92   GstStructure *cache_data;
  93 };
  94
  95 /* FIXME: could rename all priv_gst_* functions to __gst_* now */
  96 G_GNUC_INTERNAL  gboolean priv_gst_plugin_loading_have_whitelist (void);
  97
  98 G_GNUC_INTERNAL  guint32  priv_gst_plugin_loading_get_whitelist_hash (void);
  99
 100 G_GNUC_INTERNAL  gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
 101                                                                const gchar   * filename);
 102
 103 G_GNUC_INTERNAL  gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
 104
 105 G_GNUC_INTERNAL  gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
 106
 107 G_GNUC_INTERNAL  gboolean _priv_gst_in_valgrind (void);
 108
 109 /* init functions called from gst_init(). */
 110 G_GNUC_INTERNAL  void  _priv_gst_quarks_initialize (void);
 111 G_GNUC_INTERNAL  void  _priv_gst_mini_object_initialize (void);
 112 G_GNUC_INTERNAL  void  _priv_gst_memory_initialize (void);
 113 G_GNUC_INTERNAL  void  _priv_gst_allocator_initialize (void);
 114 G_GNUC_INTERNAL  void  _priv_gst_buffer_initialize (void);
 115 G_GNUC_INTERNAL  void  _priv_gst_buffer_list_initialize (void);
 116 G_GNUC_INTERNAL  void  _priv_gst_structure_initialize (void);
 117 G_GNUC_INTERNAL  void  _priv_gst_caps_initialize (void);
 118 G_GNUC_INTERNAL  void  _priv_gst_caps_features_initialize (void);
 119 G_GNUC_INTERNAL  void  _priv_gst_event_initialize (void);
 120 G_GNUC_INTERNAL  void  _priv_gst_format_initialize (void);
 121 G_GNUC_INTERNAL  void  _priv_gst_message_initialize (void);
 122 G_GNUC_INTERNAL  void  _priv_gst_meta_initialize (void);
 123 G_GNUC_INTERNAL  void  _priv_gst_plugin_initialize (void);
 124 G_GNUC_INTERNAL  void  _priv_gst_query_initialize (void);
 125 G_GNUC_INTERNAL  void  _priv_gst_sample_initialize (void);
 126 G_GNUC_INTERNAL  void  _priv_gst_tag_initialize (void);
 127 G_GNUC_INTERNAL  void  _priv_gst_value_initialize (void);
 128 G_GNUC_INTERNAL  void  _priv_gst_debug_init (void);
 129 G_GNUC_INTERNAL  void  _priv_gst_context_initialize (void);
 130 G_GNUC_INTERNAL  void  _priv_gst_toc_initialize (void);
 131 G_GNUC_INTERNAL  void  _priv_gst_date_time_initialize (void);
 132
 133 /* cleanup functions called from gst_deinit(). */
 134 G_GNUC_INTERNAL  void  _priv_gst_allocator_cleanup (void);
 135 G_GNUC_INTERNAL  void  _priv_gst_caps_features_cleanup (void);
 136 G_GNUC_INTERNAL  void  _priv_gst_caps_cleanup (void);
 137
 138 /* Private registry functions */
 139 G_GNUC_INTERNAL
 140 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
 141
 142 G_GNUC_INTERNAL  void _priv_gst_registry_cleanup (void);
 143
 144 gboolean _gst_plugin_loader_client_run (void);
 145
 146 G_GNUC_INTERNAL  GstPlugin * _priv_gst_plugin_load_file_for_registry (const gchar *filename,
 147                                                                       GstRegistry * registry,
 148                                                                       GError** error);
 149
 150 /* Used in GstBin for manual state handling */
 151 G_GNUC_INTERNAL  void _priv_gst_element_state_changed (GstElement *element,
 152                       GstState oldstate, GstState newstate, GstState pending);
 153
 154 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
 155 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + gst_structure_n_fields(s) * 22)
 156 #define FEATURES_ESTIMATED_STRING_LEN(s) (16 + gst_caps_features_get_size(s) * 14)
 157
 158 G_GNUC_INTERNAL
 159 gboolean  priv_gst_structure_append_to_gstring (const GstStructure * structure,
 160                                                 GString            * s);
 161 G_GNUC_INTERNAL
 162 gboolean priv__gst_structure_append_template_to_gstring (GQuark field_id,
 163                                                         const GValue *value,
 164                                                         gpointer user_data);
 165
 166 G_GNUC_INTERNAL
 167 void priv_gst_caps_features_append_to_gstring (const GstCapsFeatures * features, GString *s);
 168
 169 G_GNUC_INTERNAL
 170 gboolean priv_gst_structure_parse_name (gchar * str, gchar **start, gchar ** end, gchar ** next);
 171 G_GNUC_INTERNAL
 172 gboolean priv_gst_structure_parse_fields (gchar *str, gchar ** end, GstStructure *structure);
 173
 174 /* used in gstvalue.c and gststructure.c */
 175
 176 #define GST_WRAPPED_PTR_FORMAT     "p\aa"
 177
 178 G_GNUC_INTERNAL
 179 gchar *priv_gst_string_take_and_wrap (gchar * s);
 180
 181 /* registry cache backends */
 182 G_GNUC_INTERNAL
 183 gboolean                priv_gst_registry_binary_read_cache     (GstRegistry * registry, const char *location);
 184
 185 G_GNUC_INTERNAL
 186 gboolean                priv_gst_registry_binary_write_cache    (GstRegistry * registry, GList * plugins, const char *location);
 187
 188
 189 G_GNUC_INTERNAL
 190 void      __gst_element_factory_add_static_pad_template (GstElementFactory    * elementfactory,
 191                                                          GstStaticPadTemplate * templ);
 192
 193 G_GNUC_INTERNAL
 194 void      __gst_element_factory_add_interface           (GstElementFactory    * elementfactory,
 195                                                          const gchar          * interfacename);
 196
 197 /* used in gstvalue.c and gststructure.c */
 198 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
 199     ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
 200     ((c) == '.'))
 201
 202 /* This is only meant for internal uses */
 203 G_GNUC_INTERNAL
 204 gint __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2);
 205
 206 G_GNUC_INTERNAL
 207 gchar * __gst_date_time_serialize (GstDateTime * datetime, gboolean with_usecs);
 208
 209 /* Non-static, for access from the testsuite, but not for external use */
 210 gboolean
 211 _priv_gst_do_linear_regression (GstClockTime *times, guint n,
 212     GstClockTime * m_num, GstClockTime * m_denom, GstClockTime * b,
 213     GstClockTime * xbase, gdouble * r_squared);
 214
 215 /* For use in gstdebugutils */
 216 G_GNUC_INTERNAL
 217 GstCapsFeatures * __gst_caps_get_features_unchecked (const GstCaps * caps, guint idx);
 218
 219 #ifndef GST_DISABLE_REGISTRY
 220 /* Secret variable to initialise gst without registry cache */
 221 GST_EXPORT gboolean _gst_disable_registry_cache;
 222 #endif
 223
 224 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
 225 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
 226 static inline ret_type                                                  \
 227 gst_g_value_get_##name_type##_unchecked (const GValue *value)           \
 228 {                                                                       \
 229   return value->data[0].v_field;                                        \
 230 }
 231
 232 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
 233 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
 234 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
 235 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
 236 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
 237 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
 238 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
 239 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
 240
 241
 242 /*** debugging categories *****************************************************/
 243
 244 #ifndef GST_REMOVE_GST_DEBUG
 245
 246 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
 247 GST_EXPORT GstDebugCategory *GST_CAT_MEMORY;
 248 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
 249 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
 250 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
 251 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
 252 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
 253 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
 254 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
 255 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
 256 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
 257 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
 258 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
 259 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
 260 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
 261 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
 262 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
 263 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
 264 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
 265 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
 266 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
 267 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
 268 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
 269 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
 270 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
 271 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
 272 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
 273 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
 274 GST_EXPORT GstDebugCategory *GST_CAT_META;
 275 GST_EXPORT GstDebugCategory *GST_CAT_LOCKING;
 276 GST_EXPORT GstDebugCategory *GST_CAT_CONTEXT;
 277
 278 /* Categories that should be completely private to
 279  * libgstreamer should be done like this: */
 280 #define GST_CAT_POLL _priv_GST_CAT_POLL
 281 extern GstDebugCategory *_priv_GST_CAT_POLL;
 282
 283 #define GST_CAT_PROTECTION _priv_GST_CAT_PROTECTION
 284 extern GstDebugCategory *_priv_GST_CAT_PROTECTION;
 285
 286 extern GstClockTime _priv_gst_start_time;
 287
 288 #else
 289
 290 #define GST_CAT_GST_INIT         NULL
 291 #define GST_CAT_AUTOPLUG         NULL
 292 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
 293 #define GST_CAT_PARENTAGE        NULL
 294 #define GST_CAT_STATES           NULL
 295 #define GST_CAT_SCHEDULING       NULL
 296 #define GST_CAT_DATAFLOW         NULL
 297 #define GST_CAT_BUFFER           NULL
 298 #define GST_CAT_BUFFER_LIST      NULL
 299 #define GST_CAT_BUS              NULL
 300 #define GST_CAT_CAPS             NULL
 301 #define GST_CAT_CLOCK            NULL
 302 #define GST_CAT_ELEMENT_PADS     NULL
 303 #define GST_CAT_PADS             NULL
 304 #define GST_CAT_PERFORMANCE      NULL
 305 #define GST_CAT_PIPELINE         NULL
 306 #define GST_CAT_PLUGIN_LOADING   NULL
 307 #define GST_CAT_PLUGIN_INFO      NULL
 308 #define GST_CAT_PROPERTIES       NULL
 309 #define GST_CAT_NEGOTIATION      NULL
 310 #define GST_CAT_REFCOUNTING      NULL
 311 #define GST_CAT_ERROR_SYSTEM     NULL
 312 #define GST_CAT_EVENT            NULL
 313 #define GST_CAT_MESSAGE          NULL
 314 #define GST_CAT_PARAMS           NULL
 315 #define GST_CAT_CALL_TRACE       NULL
 316 #define GST_CAT_SIGNAL           NULL
 317 #define GST_CAT_PROBE            NULL
 318 #define GST_CAT_REGISTRY         NULL
 319 #define GST_CAT_QOS              NULL
 320 #define GST_CAT_TYPES            NULL
 321 #define GST_CAT_POLL             NULL
 322 #define GST_CAT_META             NULL
 323 #define GST_CAT_LOCKING          NULL
 324 #define GST_CAT_CONTEXT          NULL
 325 #define GST_CAT_PROTECTION       NULL
 326
 327 #endif
 328
 329 #ifdef GST_DISABLE_GST_DEBUG
 330 /* for _gst_element_error_printf */
 331 #define __gst_vasprintf __gst_info_fallback_vasprintf
 332 int __gst_vasprintf (char **result, char const *format, va_list args);
 333 #endif
 334
 335 /**** objects made opaque until the private bits have been made private ****/
 336
 337 #include <gmodule.h>
 338 #include <time.h> /* time_t */
 339 #include <sys/types.h> /* off_t */
 340 #include <sys/stat.h> /* off_t */
 341
 342 typedef struct _GstPluginPrivate GstPluginPrivate;
 343
 344 struct _GstPlugin {
 345   GstObject       object;
 346
 347   /*< private >*/
 348   GstPluginDesc desc;
 349
 350   GstPluginDesc *orig_desc;
 351
 352   gchar *       filename;
 353   gchar *       basename;       /* base name (non-dir part) of plugin path */
 354
 355   GModule *     module;         /* contains the module if plugin is loaded */
 356
 357   off_t         file_size;
 358   time_t        file_mtime;
 359   gboolean      registered;     /* TRUE when the registry has seen a filename
 360                                  * that matches the plugin's basename */
 361
 362   GstPluginPrivate *priv;
 363
 364   gpointer _gst_reserved[GST_PADDING];
 365 };
 366
 367 struct _GstPluginClass {
 368   GstObjectClass  object_class;
 369
 370   /*< private >*/
 371   gpointer _gst_reserved[GST_PADDING];
 372 };
 373
 374 struct _GstPluginFeature {
 375   GstObject      object;
 376
 377   /*< private >*/
 378   gboolean       loaded;
 379   guint          rank;
 380
 381   const gchar   *plugin_name;
 382   GstPlugin     *plugin;      /* weak ref */
 383
 384   /*< private >*/
 385   gpointer _gst_reserved[GST_PADDING];
 386 };
 387
 388 struct _GstPluginFeatureClass {
 389   GstObjectClass        parent_class;
 390
 391   /*< private >*/
 392   gpointer _gst_reserved[GST_PADDING];
 393 };
 394
 395 #include "gsttypefind.h"
 396
 397 struct _GstTypeFindFactory {
 398   GstPluginFeature              feature;
 399   /* <private> */
 400
 401   GstTypeFindFunction           function;
 402   gchar **                      extensions;
 403   GstCaps *                     caps;
 404
 405   gpointer                      user_data;
 406   GDestroyNotify                user_data_notify;
 407
 408   gpointer _gst_reserved[GST_PADDING];
 409 };
 410
 411 struct _GstTypeFindFactoryClass {
 412   GstPluginFeatureClass         parent;
 413   /* <private> */
 414
 415   gpointer _gst_reserved[GST_PADDING];
 416 };
 417
 418 struct _GstTracerFactory {
 419   GstPluginFeature              feature;
 420   /* <private> */
 421
 422   GType                         type;
 423
 424   /*
 425   gpointer                      user_data;
 426   GDestroyNotify                user_data_notify;
 427   */
 428
 429   gpointer _gst_reserved[GST_PADDING];
 430 };
 431
 432 struct _GstTracerFactoryClass {
 433   GstPluginFeatureClass         parent;
 434   /* <private> */
 435
 436   gpointer _gst_reserved[GST_PADDING];
 437 };
 438
 439 struct _GstElementFactory {
 440   GstPluginFeature      parent;
 441
 442   GType                 type;                   /* unique GType of element or 0 if not loaded */
 443
 444   gpointer              metadata;
 445
 446   GList *               staticpadtemplates;     /* GstStaticPadTemplate list */
 447   guint                 numpadtemplates;
 448
 449   /* URI interface stuff */
 450   GstURIType            uri_type;
 451   gchar **              uri_protocols;
 452
 453   GList *               interfaces;             /* interface type names this element implements */
 454
 455   /*< private >*/
 456   gpointer _gst_reserved[GST_PADDING];
 457 };
 458
 459 struct _GstElementFactoryClass {
 460   GstPluginFeatureClass parent_class;
 461
 462   gpointer _gst_reserved[GST_PADDING];
 463 };
 464
 465 struct _GstDeviceProviderFactory {
 466   GstPluginFeature           feature;
 467   /* <private> */
 468
 469   GType                      type;              /* unique GType the device factory or 0 if not loaded */
 470
 471   volatile GstDeviceProvider *provider;
 472   gpointer                   metadata;
 473
 474   gpointer _gst_reserved[GST_PADDING];
 475 };
 476
 477 struct _GstDeviceProviderFactoryClass {
 478   GstPluginFeatureClass         parent;
 479   /* <private> */
 480
 481   gpointer _gst_reserved[GST_PADDING];
 482 };
 483
 484 /* privat flag used by GstBus / GstMessage */
 485 #define GST_MESSAGE_FLAG_ASYNC_DELIVERY (GST_MINI_OBJECT_FLAG_LAST << 0)
 486
 487 G_END_DECLS
 488 #endif /* __GST_PRIVATE_H__ */