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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, 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 G_BEGIN_DECLS
  58
  59 /* used by gstparse.c and grammar.y */
  60 struct _GstParseContext {
  61   GList * missing_elements;
  62 };
  63
  64 /* used by gstplugin.c and gstregistrybinary.c */
  65 typedef struct {
  66   /* details registered via gst_plugin_add_dependency() */
  67   GstPluginDependencyFlags  flags;
  68   gchar **env_vars;
  69   gchar **paths;
  70   gchar **names;
  71
  72   /* information saved from the last time the plugin was loaded (-1 = unset) */
  73   guint   env_hash;  /* hash of content of environment variables in env_vars */
  74   guint   stat_hash; /* hash of stat() on all relevant files and directories */
  75 } GstPluginDep;
  76
  77 struct _GstPluginPrivate {
  78   GList *deps;    /* list of GstPluginDep structures */
  79   GstStructure *cache_data;
  80 };
  81
  82 gboolean priv_gst_plugin_loading_have_whitelist (void);
  83
  84 guint32  priv_gst_plugin_loading_get_whitelist_hash (void);
  85
  86 gboolean priv_gst_plugin_desc_is_whitelisted (GstPluginDesc * desc,
  87                                               const gchar   * filename);
  88
  89 gboolean _priv_plugin_deps_env_vars_changed (GstPlugin * plugin);
  90 gboolean _priv_plugin_deps_files_changed (GstPlugin * plugin);
  91
  92 gboolean _priv_gst_in_valgrind (void);
  93
  94 /* Initialize GStreamer private quark storage */
  95 void _priv_gst_quarks_initialize (void);
  96
  97 /* Other init functions called from gst_init().
  98  * FIXME 0.11: rename to _priv_gst_foo_init() so they don't get exported
  99  * (can't do this now because these functions used to be in our public
 100  * headers, so at least the symbols need to continue to be available unless
 101  * we want enterprise edition packagers dancing on our heads) */
 102 void  _gst_buffer_initialize (void);
 103 void  _gst_buffer_list_initialize (void);
 104 void  _gst_event_initialize (void);
 105 void  _gst_format_initialize (void);
 106 void  _gst_message_initialize (void);
 107 void  _gst_plugin_initialize (void);
 108 void  _gst_query_initialize (void);
 109 void  _gst_tag_initialize (void);
 110 void  _gst_value_initialize (void);
 111
 112 /* Private registry functions */
 113 gboolean _priv_gst_registry_remove_cache_plugins (GstRegistry *registry);
 114 void _priv_gst_registry_cleanup (void);
 115 gboolean _gst_plugin_loader_client_run (void);
 116
 117 void _priv_gst_pad_invalidate_cache (GstPad *pad);
 118
 119 /* Used in GstBin for manual state handling */
 120 void _priv_gst_element_state_changed (GstElement *element, GstState oldstate,
 121     GstState newstate, GstState pending);
 122
 123 /* used in both gststructure.c and gstcaps.c; numbers are completely made up */
 124 #define STRUCTURE_ESTIMATED_STRING_LEN(s) (16 + (s)->fields->len * 22)
 125
 126 gboolean  priv_gst_structure_append_to_gstring (const GstStructure * structure,
 127                                                 GString            * s);
 128 /* registry cache backends */
 129 /* FIXME 0.11: use priv_ prefix */
 130 gboolean                gst_registry_binary_read_cache  (GstRegistry * registry, const char *location);
 131 gboolean                gst_registry_binary_write_cache (GstRegistry * registry, const char *location);
 132
 133
 134 /* used in gstvalue.c and gststructure.c */
 135 #define GST_ASCII_IS_STRING(c) (g_ascii_isalnum((c)) || ((c) == '_') || \
 136     ((c) == '-') || ((c) == '+') || ((c) == '/') || ((c) == ':') || \
 137     ((c) == '.'))
 138
 139 /* This is only meant for internal uses */
 140 gint priv_gst_date_time_compare (gconstpointer dt1, gconstpointer dt2);
 141
 142 #ifndef GST_DISABLE_REGISTRY
 143 /* Secret variable to initialise gst without registry cache */
 144 extern gboolean _gst_disable_registry_cache;
 145 #endif
 146
 147 /* provide inline gst_g_value_get_foo_unchecked(), used in gststructure.c */
 148 #define DEFINE_INLINE_G_VALUE_GET_UNCHECKED(ret_type,name_type,v_field) \
 149 static inline ret_type                                                  \
 150 gst_g_value_get_##name_type##_unchecked (const GValue *value)           \
 151 {                                                                       \
 152   return value->data[0].v_field;                                        \
 153 }
 154
 155 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gboolean,boolean,v_int)
 156 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint,int,v_int)
 157 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint,uint,v_uint)
 158 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gint64,int64,v_int64)
 159 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(guint64,uint64,v_uint64)
 160 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gfloat,float,v_float)
 161 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(gdouble,double,v_double)
 162 DEFINE_INLINE_G_VALUE_GET_UNCHECKED(const gchar *,string,v_pointer)
 163
 164
 165 /*** debugging categories *****************************************************/
 166
 167 #ifndef GST_REMOVE_GST_DEBUG
 168
 169 GST_EXPORT GstDebugCategory *GST_CAT_GST_INIT;
 170 GST_EXPORT GstDebugCategory *GST_CAT_AUTOPLUG; /* FIXME 0.11: remove? */
 171 GST_EXPORT GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT; /* FIXME 0.11: remove? */
 172 GST_EXPORT GstDebugCategory *GST_CAT_PARENTAGE;
 173 GST_EXPORT GstDebugCategory *GST_CAT_STATES;
 174 GST_EXPORT GstDebugCategory *GST_CAT_SCHEDULING;
 175 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER;
 176 GST_EXPORT GstDebugCategory *GST_CAT_BUFFER_LIST;
 177 GST_EXPORT GstDebugCategory *GST_CAT_BUS;
 178 GST_EXPORT GstDebugCategory *GST_CAT_CAPS;
 179 GST_EXPORT GstDebugCategory *GST_CAT_CLOCK;
 180 GST_EXPORT GstDebugCategory *GST_CAT_ELEMENT_PADS;
 181 GST_EXPORT GstDebugCategory *GST_CAT_PADS;
 182 GST_EXPORT GstDebugCategory *GST_CAT_PERFORMANCE;
 183 GST_EXPORT GstDebugCategory *GST_CAT_PIPELINE;
 184 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_LOADING;
 185 GST_EXPORT GstDebugCategory *GST_CAT_PLUGIN_INFO;
 186 GST_EXPORT GstDebugCategory *GST_CAT_PROPERTIES;
 187 GST_EXPORT GstDebugCategory *GST_CAT_XML;
 188 GST_EXPORT GstDebugCategory *GST_CAT_NEGOTIATION;
 189 GST_EXPORT GstDebugCategory *GST_CAT_REFCOUNTING;
 190 GST_EXPORT GstDebugCategory *GST_CAT_ERROR_SYSTEM;
 191 GST_EXPORT GstDebugCategory *GST_CAT_EVENT;
 192 GST_EXPORT GstDebugCategory *GST_CAT_MESSAGE;
 193 GST_EXPORT GstDebugCategory *GST_CAT_PARAMS;
 194 GST_EXPORT GstDebugCategory *GST_CAT_CALL_TRACE;
 195 GST_EXPORT GstDebugCategory *GST_CAT_SIGNAL;
 196 GST_EXPORT GstDebugCategory *GST_CAT_PROBE;
 197 GST_EXPORT GstDebugCategory *GST_CAT_REGISTRY;
 198 GST_EXPORT GstDebugCategory *GST_CAT_QOS;
 199 GST_EXPORT GstDebugCategory *GST_CAT_TYPES; /* FIXME 0.11: remove? */
 200
 201 /* Categories that should be completely private to
 202  * libgstreamer should be done like this: */
 203 #define GST_CAT_POLL _priv_GST_CAT_POLL
 204 extern GstDebugCategory *_priv_GST_CAT_POLL;
 205
 206 #else
 207
 208 #define GST_CAT_GST_INIT         NULL
 209 #define GST_CAT_AUTOPLUG         NULL
 210 #define GST_CAT_AUTOPLUG_ATTEMPT NULL
 211 #define GST_CAT_PARENTAGE        NULL
 212 #define GST_CAT_STATES           NULL
 213 #define GST_CAT_SCHEDULING       NULL
 214 #define GST_CAT_DATAFLOW         NULL
 215 #define GST_CAT_BUFFER           NULL
 216 #define GST_CAT_BUFFER_LIST      NULL
 217 #define GST_CAT_BUS              NULL
 218 #define GST_CAT_CAPS             NULL
 219 #define GST_CAT_CLOCK            NULL
 220 #define GST_CAT_ELEMENT_PADS     NULL
 221 #define GST_CAT_PADS             NULL
 222 #define GST_CAT_PERFORMANCE      NULL
 223 #define GST_CAT_PIPELINE         NULL
 224 #define GST_CAT_PLUGIN_LOADING   NULL
 225 #define GST_CAT_PLUGIN_INFO      NULL
 226 #define GST_CAT_PROPERTIES       NULL
 227 #define GST_CAT_XML              NULL
 228 #define GST_CAT_NEGOTIATION      NULL
 229 #define GST_CAT_REFCOUNTING      NULL
 230 #define GST_CAT_ERROR_SYSTEM     NULL
 231 #define GST_CAT_EVENT            NULL
 232 #define GST_CAT_MESSAGE          NULL
 233 #define GST_CAT_PARAMS           NULL
 234 #define GST_CAT_CALL_TRACE       NULL
 235 #define GST_CAT_SIGNAL           NULL
 236 #define GST_CAT_PROBE            NULL
 237 #define GST_CAT_REGISTRY         NULL
 238 #define GST_CAT_QOS              NULL
 239 #define GST_CAT_TYPES            NULL
 240 #define GST_CAT_POLL             NULL
 241
 242 #endif
 243
 244 #ifdef GST_DISABLE_DEPRECATED
 245 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
 246 #endif
 247
 248
 249 G_END_DECLS
 250 #endif /* __GST_PRIVATE_H__ */