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