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