git.sesse.net Git - vlc/blob - src/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h: Internal libvlc generic/misc declaration
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_LIBVLC_H
  26 # define LIBVLC_LIBVLC_H 1
  27
  28 extern const char vlc_usage[];
  29
  30 /* Hotkey stuff */
  31 extern const struct hotkey libvlc_hotkeys[];
  32 extern const size_t libvlc_hotkeys_size;
  33 extern int vlc_key_to_action (vlc_object_t *, const char *,
  34                               vlc_value_t, vlc_value_t, void *);
  35
  36 /*
  37  * OS-specific initialization
  38  */
  39 void system_Init      ( libvlc_int_t *, int *, const char *[] );
  40 void system_Configure ( libvlc_int_t *, int *, const char *[] );
  41 void system_End       ( libvlc_int_t * );
  42
  43 /*
  44  * Threads subsystem
  45  */
  46 int vlc_threads_init( void );
  47 void vlc_threads_end( void );
  48
  49 /* Hopefully, no need to export this. There is a new thread API instead. */
  50 void vlc_thread_cancel (vlc_object_t *);
  51
  52
  53 /*
  54  * CPU capabilities
  55  */
  56 extern uint32_t cpu_flags;
  57 uint32_t CPUCapabilities( void );
  58
  59 /*
  60  * Message/logging stuff
  61  */
  62
  63 typedef struct msg_queue_t
  64 {
  65     /** Message queue lock */
  66     vlc_mutex_t             lock;
  67     bool              b_overflow;
  68
  69     /* Message queue */
  70     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  71     int i_start;
  72     int i_stop;
  73
  74     /* Subscribers */
  75     int i_sub;
  76     msg_subscription_t **pp_sub;
  77
  78     /* Logfile for WinCE */
  79 #ifdef UNDER_CE
  80     FILE *logfile;
  81 #endif
  82 } msg_queue_t;
  83
  84 /**
  85  * Store all data required by messages interfaces.
  86  */
  87 typedef struct msg_bank_t
  88 {
  89     vlc_mutex_t             lock;
  90     msg_queue_t             queue;
  91 } msg_bank_t;
  92
  93 void msg_Create  (libvlc_int_t *);
  94 void msg_Flush   (libvlc_int_t *);
  95 void msg_Destroy (libvlc_int_t *);
  96
  97 /** Internal message stack context */
  98 typedef struct
  99 {
 100     int i_code;
 101     char * psz_message;
 102 } msg_context_t;
 103
 104 void msg_StackSet ( int, const char*, ... );
 105 void msg_StackAdd ( const char*, ... );
 106 const char* msg_StackMsg ( void );
 107 /** The global thread var for msg stack context
 108  *  We store this as a static global variable so we don't need a vlc_object_t
 109  *  everywhere.
 110  *  This key is created in vlc_threads_init and is therefore ready to use at
 111  *  the very beginning of the universe */
 112 extern vlc_threadvar_t msg_context_global_key;
 113 void msg_StackDestroy (void *);
 114
 115 /*
 116  * Unicode stuff
 117  */
 118 char *vlc_fix_readdir (const char *);
 119
 120 /*
 121  * LibVLC objects stuff
 122  */
 123
 124 /**
 125  * Creates a VLC object.
 126  *
 127  * Note that because the object name pointer must remain valid, potentially
 128  * even after the destruction of the object (through the message queues), this
 129  * function CANNOT be exported to plugins as is. In this case, the old
 130  * vlc_object_create() must be used instead.
 131  *
 132  * @param p_this an existing VLC object
 133  * @param i_size byte size of the object structure
 134  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 135  * @param psz_type object type name
 136  * @return the created object, or NULL.
 137  */
 138 extern void *
 139 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 140                      const char *psz_type);
 141 #define vlc_custom_create(o, s, t, n) \
 142         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 143
 144 /**
 145  * libvlc_global_data_t (global variable)
 146  *
 147  * This structure has an unique instance, statically allocated in libvlc and
 148  * never accessed from the outside. It stores process-wide VLC variables,
 149  * mostly process-wide locks, and (currently) the module bank and objects tree.
 150  */
 151 typedef struct libvlc_global_data_t
 152 {
 153     VLC_COMMON_MEMBERS
 154
 155     module_bank_t *        p_module_bank; ///< The module bank
 156
 157     char *                 psz_vlcpath;
 158 } libvlc_global_data_t;
 159
 160
 161 libvlc_global_data_t *vlc_global (void);
 162
 163 /**
 164  * Private LibVLC data for each object.
 165  */
 166 struct vlc_object_internals_t
 167 {
 168     /* Object variables */
 169     variable_t *    p_vars;
 170     vlc_mutex_t     var_lock;
 171     int             i_vars;
 172
 173     /* Thread properties, if any */
 174     vlc_thread_t    thread_id;
 175     bool            b_thread;
 176
 177     /* Objects thread synchronization */
 178     vlc_mutex_t     lock;
 179     vlc_cond_t      wait;
 180     int             pipes[2];
 181     vlc_spinlock_t  spin;
 182
 183     /* Objects management */
 184     vlc_spinlock_t   ref_spin;
 185     unsigned         i_refcount;
 186     vlc_destructor_t pf_destructor;
 187
 188     /* Objects tree structure */
 189     vlc_object_t    *prev, *next;
 190     vlc_object_t   **pp_children;
 191     int              i_children;
 192 };
 193
 194 #define ZOOM_SECTION N_("Zoom")
 195 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 196 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 197 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 198 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 199
 200 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 201
 202 /**
 203  * Private LibVLC instance data.
 204  */
 205 typedef struct libvlc_priv_t
 206 {
 207     libvlc_int_t       public_data;
 208
 209     /* Configuration */
 210     vlc_mutex_t        config_lock; ///< config file lock
 211     char *             psz_configfile;   ///< location of config file
 212
 213     /* There is no real reason to keep a list of items, but not to break
 214      * everything, let's keep it */
 215     input_item_array_t input_items; ///< Array of all created input items
 216     int                i_last_input_id ; ///< Last id of input item
 217
 218     /* Messages */
 219     msg_bank_t         msg_bank;    ///< The message bank
 220     int                i_verbose;   ///< info messages
 221     bool               b_color;     ///< color messages?
 222
 223     /* Timer stats */
 224     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 225     counter_t        **pp_timers;   ///< Array of all timers
 226     int                i_timers;    ///< Number of timers
 227     bool               b_stats;     ///< Whether to collect stats
 228
 229     void              *p_stats_computer;  ///< Input thread computing stats
 230                                           /// (needs cleanup)
 231
 232     /* Singleton objects */
 233     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 234     playlist_t        *p_playlist; //< the playlist singleton
 235     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 236     interaction_t     *p_interaction;    ///< interface interaction object
 237     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 238
 239     /* Private playlist data (FIXME - playlist_t is too public...) */
 240     sout_instance_t   *p_sout; ///< kept sout instance (for playlist)
 241 } libvlc_priv_t;
 242
 243 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 244 {
 245     return (libvlc_priv_t *)libvlc;
 246 }
 247
 248 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 249
 250 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 251
 252 /**
 253  * LibVLC "main module" configuration settings array.
 254  */
 255 extern module_config_t libvlc_config[];
 256 extern const size_t libvlc_config_count;
 257
 258 /*
 259  * Variables stuff
 260  */
 261 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 262
 263 /*
 264  * Replacement functions
 265  */
 266 # ifndef HAVE_DIRENT_H
 267 typedef void DIR;
 268 #  ifndef FILENAME_MAX
 269 #      define FILENAME_MAX (260)
 270 #  endif
 271 struct dirent
 272 {
 273     long            d_ino;          /* Always zero. */
 274     unsigned short  d_reclen;       /* Always zero. */
 275     unsigned short  d_namlen;       /* Length of name in d_name. */
 276     char            d_name[FILENAME_MAX]; /* File name. */
 277 };
 278 #  define opendir vlc_opendir
 279 #  define readdir vlc_readdir
 280 #  define closedir vlc_closedir
 281 #  define rewinddir vlc_rewindir
 282 void *vlc_opendir (const char *);
 283 void *vlc_readdir (void *);
 284 int   vlc_closedir(void *);
 285 void  vlc_rewinddir(void *);
 286 # endif
 287
 288 #if defined (WIN32)
 289 #   include <dirent.h>
 290 void *vlc_wopendir (const wchar_t *);
 291 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 292 struct _wdirent *vlc_wreaddir (void *);
 293 void vlc_rewinddir (void *);
 294 #   define _wopendir vlc_wopendir
 295 #   define _wreaddir vlc_wreaddir
 296 #   define _wclosedir vlc_wclosedir
 297 #   define rewinddir vlc_rewinddir
 298 #endif
 299
 300 #endif