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 /* 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);
 139
 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)
 143
 144 G_GNUC_INTERNAL
 145 gboolean  priv_gst_structure_append_to_gstring (const GstStructure * structure,
 146                                                 GString            * s);
 147 G_GNUC_INTERNAL
 148 void priv_gst_caps_features_append_to_gstring (const GstCapsFeatures * features, GString *s);
 149
 150 G_GNUC_INTERNAL
 151 gboolean priv_gst_structure_parse_name (gchar * str, gchar **start, gchar ** end, gchar ** next);
 152 G_GNUC_INTERNAL
 153 gboolean priv_gst_structure_parse_fields (gchar *str, gchar ** end, GstStructure *structure);
 154
 155 /* registry cache backends */
 156 G_GNUC_INTERNAL
 157 gboolean                priv_gst_registry_binary_read_cache     (GstRegistry * registry, const char *location);
 158
 159 G_GNUC_INTERNAL
 160 gboolean                priv_gst_registry_binary_write_cache    (GstRegistry * registry, GList * plugins, const char *location);
 161
 162
 163 G_GNUC_INTERNAL
 164 void      __gst_element_factory_add_static_pad_template (GstElementFactory    * elementfactory,
 165                                                          GstStaticPadTemplate * templ);
 166
 167 G_GNUC_INTERNAL
 168 void      __gst_element_factory_add_interface           (GstElementFactory    * elementfactory,
 169                                                          const gchar          * interfacename);
 170
 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) == ':') || \
 174     ((c) == '.'))
 175
 176 /* This is only meant for internal uses */
 177 G_GNUC_INTERNAL
 178 gint __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2);
 179
 180 G_GNUC_INTERNAL
 181 gchar * __gst_date_time_serialize (GstDateTime * datetime, gboolean with_usecs);
 182
 183 /* Non-static, for access from the testsuite, but not for external use */
 184 gboolean
 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);
 188
 189 /* For use in gstdebugutils */
 190 G_GNUC_INTERNAL
 191 GstCapsFeatures * __gst_caps_get_features_unchecked (const GstCaps * caps, guint idx);
 192
 193 #ifndef GST_DISABLE_REGISTRY
 194 /* Secret variable to initialise gst without registry cache */
 195 GST_EXPORT gboolean _gst_disable_registry_cache;
 196 #endif
 197
 198 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
 199 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
 200 static inline ret_type                                                  \
 201 gst_g_value_get_##name_type##_unchecked (const GValue *value)           \
 202 {                                                                       \
 203   return value->data[0].v_field;                                        \
 204 }
 205
 206 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
 207 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
 208 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
 209 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
 210 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
 211 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
 212 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
 213 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
 214
 215
 216 /*** debugging categories *****************************************************/
 217
 218 #ifndef GST_REMOVE_GST_DEBUG
 219
 220 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
 221 GST_EXPORT GstDebugCategory *GST_CAT_MEMORY;
 222 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
 223 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
 224 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
 225 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
 226 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
 227 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
 228 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
 229 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
 230 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
 231 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
 232 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
 233 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
 234 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
 235 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
 236 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
 237 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
 238 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
 239 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
 240 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
 241 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
 242 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
 243 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
 244 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
 245 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
 246 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
 247 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
 248 GST_EXPORT GstDebugCategory *GST_CAT_META;
 249 GST_EXPORT GstDebugCategory *GST_CAT_LOCKING;
 250 GST_EXPORT GstDebugCategory *GST_CAT_CONTEXT;
 251
 252 /* Categories that should be completely private to
 253  * libgstreamer should be done like this: */
 254 #define GST_CAT_POLL _priv_GST_CAT_POLL
 255 extern GstDebugCategory *_priv_GST_CAT_POLL;
 256
 257 extern GstClockTime _priv_gst_info_start_time;
 258
 259 #else
 260
 261 #define GST_CAT_GST_INIT         NULL
 262 #define GST_CAT_AUTOPLUG         NULL
 263 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
 264 #define GST_CAT_PARENTAGE        NULL
 265 #define GST_CAT_STATES           NULL
 266 #define GST_CAT_SCHEDULING       NULL
 267 #define GST_CAT_DATAFLOW         NULL
 268 #define GST_CAT_BUFFER           NULL
 269 #define GST_CAT_BUFFER_LIST      NULL
 270 #define GST_CAT_BUS              NULL
 271 #define GST_CAT_CAPS             NULL
 272 #define GST_CAT_CLOCK            NULL
 273 #define GST_CAT_ELEMENT_PADS     NULL
 274 #define GST_CAT_PADS             NULL
 275 #define GST_CAT_PERFORMANCE      NULL
 276 #define GST_CAT_PIPELINE         NULL
 277 #define GST_CAT_PLUGIN_LOADING   NULL
 278 #define GST_CAT_PLUGIN_INFO      NULL
 279 #define GST_CAT_PROPERTIES       NULL
 280 #define GST_CAT_NEGOTIATION      NULL
 281 #define GST_CAT_REFCOUNTING      NULL
 282 #define GST_CAT_ERROR_SYSTEM     NULL
 283 #define GST_CAT_EVENT            NULL
 284 #define GST_CAT_MESSAGE          NULL
 285 #define GST_CAT_PARAMS           NULL
 286 #define GST_CAT_CALL_TRACE       NULL
 287 #define GST_CAT_SIGNAL           NULL
 288 #define GST_CAT_PROBE            NULL
 289 #define GST_CAT_REGISTRY         NULL
 290 #define GST_CAT_QOS              NULL
 291 #define GST_CAT_TYPES            NULL
 292 #define GST_CAT_POLL             NULL
 293 #define GST_CAT_META             NULL
 294 #define GST_CAT_LOCKING          NULL
 295 #define GST_CAT_CONTEXT          NULL
 296
 297 #endif
 298
 299 #ifdef GST_DISABLE_GST_DEBUG
 300 /* for _gst_element_error_printf */
 301 #define __gst_vasprintf __gst_info_fallback_vasprintf
 302 int __gst_vasprintf (char **result, char const *format, va_list args);
 303 #endif
 304
 305 /**** objects made opaque until the private bits have been made private ****/
 306
 307 #include <gmodule.h>
 308 #include <time.h> /* time_t */
 309 #include <sys/types.h> /* off_t */
 310 #include <sys/stat.h> /* off_t */
 311
 312 typedef struct _GstPluginPrivate GstPluginPrivate;
 313
 314 struct _GstPlugin {
 315   GstObject       object;
 316
 317   /*< private >*/
 318   GstPluginDesc desc;
 319
 320   GstPluginDesc *orig_desc;
 321
 322   gchar *       filename;
 323   gchar *       basename;       /* base name (non-dir part) of plugin path */
 324
 325   GModule *     module;         /* contains the module if plugin is loaded */
 326
 327   off_t         file_size;
 328   time_t        file_mtime;
 329   gboolean      registered;     /* TRUE when the registry has seen a filename
 330                                  * that matches the plugin's basename */
 331
 332   GstPluginPrivate *priv;
 333
 334   gpointer _gst_reserved[GST_PADDING];
 335 };
 336
 337 struct _GstPluginClass {
 338   GstObjectClass  object_class;
 339
 340   /*< private >*/
 341   gpointer _gst_reserved[GST_PADDING];
 342 };
 343
 344 struct _GstPluginFeature {
 345   GstObject      object;
 346
 347   /*< private >*/
 348   gboolean       loaded;
 349   guint          rank;
 350
 351   const gchar   *plugin_name;
 352   GstPlugin     *plugin;      /* weak ref */
 353
 354   /*< private >*/
 355   gpointer _gst_reserved[GST_PADDING];
 356 };
 357
 358 struct _GstPluginFeatureClass {
 359   GstObjectClass        parent_class;
 360
 361   /*< private >*/
 362   gpointer _gst_reserved[GST_PADDING];
 363 };
 364
 365 #include "gsttypefind.h"
 366
 367 struct _GstTypeFindFactory {
 368   GstPluginFeature              feature;
 369   /* <private> */
 370
 371   GstTypeFindFunction           function;
 372   gchar **                      extensions;
 373   GstCaps *                     caps;
 374
 375   gpointer                      user_data;
 376   GDestroyNotify                user_data_notify;
 377
 378   gpointer _gst_reserved[GST_PADDING];
 379 };
 380
 381 struct _GstTypeFindFactoryClass {
 382   GstPluginFeatureClass         parent;
 383   /* <private> */
 384
 385   gpointer _gst_reserved[GST_PADDING];
 386 };
 387
 388 struct _GstElementFactory {
 389   GstPluginFeature      parent;
 390
 391   GType                 type;                   /* unique GType of element or 0 if not loaded */
 392
 393   gpointer              metadata;
 394
 395   GList *               staticpadtemplates;     /* GstStaticPadTemplate list */
 396   guint                 numpadtemplates;
 397
 398   /* URI interface stuff */
 399   GstURIType            uri_type;
 400   gchar **              uri_protocols;
 401
 402   GList *               interfaces;             /* interface type names this element implements */
 403
 404   /*< private >*/
 405   gpointer _gst_reserved[GST_PADDING];
 406 };
 407
 408 struct _GstElementFactoryClass {
 409   GstPluginFeatureClass parent_class;
 410
 411   gpointer _gst_reserved[GST_PADDING];
 412 };
 413
 414 struct _GstDeviceProviderFactory {
 415   GstPluginFeature           feature;
 416   /* <private> */
 417
 418   GType                      type;              /* unique GType the device factory or 0 if not loaded */
 419
 420   volatile GstDeviceProvider *provider;
 421   gpointer                   metadata;
 422
 423   gpointer _gst_reserved[GST_PADDING];
 424 };
 425
 426 struct _GstDeviceProviderFactoryClass {
 427   GstPluginFeatureClass         parent;
 428   /* <private> */
 429
 430   gpointer _gst_reserved[GST_PADDING];
 431 };
 432
 433 /* privat flag used by GstBus / GstMessage */
 434 #define GST_MESSAGE_FLAG_ASYNC_DELIVERY (GST_MINI_OBJECT_FLAG_LAST << 0)
 435
 436 G_END_DECLS
 437 #endif /* __GST_PRIVATE_H__ */