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