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 vlc_object_t *vlc_threadobj (void);
  49 #ifndef NDEBUG
  50 void vlc_refcheck (vlc_object_t *obj);
  51 #else
  52 # define vlc_refcheck( obj ) (void)0
  53 #endif
  54
  55 /*
  56  * CPU capabilities
  57  */
  58 extern uint32_t cpu_flags;
  59 uint32_t CPUCapabilities( void );
  60
  61 /*
  62  * Message/logging stuff
  63  */
  64
  65 typedef struct msg_queue_t
  66 {
  67     /** Message queue lock */
  68     vlc_mutex_t             lock;
  69     bool              b_overflow;
  70
  71     /* Message queue */
  72     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  73     int i_start;
  74     int i_stop;
  75
  76     /* Subscribers */
  77     int i_sub;
  78     msg_subscription_t **pp_sub;
  79
  80     /* Logfile for WinCE */
  81 #ifdef UNDER_CE
  82     FILE *logfile;
  83 #endif
  84 } msg_queue_t;
  85
  86 /**
  87  * Store all data required by messages interfaces.
  88  */
  89 typedef struct msg_bank_t
  90 {
  91     vlc_mutex_t             lock;
  92     msg_queue_t             queue;
  93 } msg_bank_t;
  94
  95 void msg_Create  (libvlc_int_t *);
  96 void msg_Flush   (libvlc_int_t *);
  97 void msg_Destroy (libvlc_int_t *);
  98
  99 /** Internal message stack context */
 100 typedef struct
 101 {
 102     int i_code;
 103     char * psz_message;
 104 } msg_context_t;
 105
 106 void msg_StackSet ( int, const char*, ... );
 107 void msg_StackAdd ( const char*, ... );
 108 const char* msg_StackMsg ( void );
 109 /** The global thread var for msg stack context
 110  *  We store this as a static global variable so we don't need a vlc_object_t
 111  *  everywhere.
 112  *  This key is created in vlc_threads_init and is therefore ready to use at
 113  *  the very beginning of the universe */
 114 extern vlc_threadvar_t msg_context_global_key;
 115 void msg_StackDestroy (void *);
 116
 117 /*
 118  * Unicode stuff
 119  */
 120 char *vlc_fix_readdir (const char *);
 121 bool vlc_current_charset (char **);
 122
 123 /*
 124  * LibVLC objects stuff
 125  */
 126
 127 /**
 128  * Creates a VLC object.
 129  *
 130  * Note that because the object name pointer must remain valid, potentially
 131  * even after the destruction of the object (through the message queues), this
 132  * function CANNOT be exported to plugins as is. In this case, the old
 133  * vlc_object_create() must be used instead.
 134  *
 135  * @param p_this an existing VLC object
 136  * @param i_size byte size of the object structure
 137  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 138  * @param psz_type object type name
 139  * @return the created object, or NULL.
 140  */
 141 extern void *
 142 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 143                    const char *psz_type);
 144
 145 /**
 146  * libvlc_global_data_t (global variable)
 147  *
 148  * This structure has an unique instance, statically allocated in libvlc and
 149  * never accessed from the outside. It stores process-wide VLC variables,
 150  * mostly process-wide locks, and (currently) the module bank and objects tree.
 151  */
 152 typedef struct libvlc_global_data_t
 153 {
 154     VLC_COMMON_MEMBERS
 155
 156     /* Object structure data */
 157     int                    i_counter;   ///< object counter
 158
 159     module_bank_t *        p_module_bank; ///< The module bank
 160
 161     char *                 psz_vlcpath;
 162 } libvlc_global_data_t;
 163
 164
 165 libvlc_global_data_t *vlc_global (void);
 166
 167 /**
 168  * Private LibVLC data for each object.
 169  */
 170 struct vlc_object_internals_t
 171 {
 172     /* Object variables */
 173     variable_t *    p_vars;
 174     vlc_mutex_t     var_lock;
 175     int             i_vars;
 176
 177     /* Thread properties, if any */
 178     vlc_thread_t    thread_id;
 179     bool            b_thread;
 180
 181     /* Objects thread synchronization */
 182     int             pipes[2];
 183     vlc_spinlock_t  spin;
 184
 185     /* Objects management */
 186     vlc_spinlock_t   ref_spin;
 187     unsigned         i_refcount;
 188     vlc_destructor_t pf_destructor;
 189 #ifndef NDEBUG
 190     vlc_thread_t     creator_id;
 191 #endif
 192
 193     /* Objects tree structure */
 194     vlc_object_t    *prev, *next;
 195     vlc_object_t   **pp_children;
 196     int              i_children;
 197 };
 198
 199 #define ZOOM_SECTION N_("Zoom")
 200 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 201 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 202 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 203 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 204
 205 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 206
 207 /**
 208  * Private LibVLC instance data.
 209  */
 210 typedef struct libvlc_priv_t
 211 {
 212     /* Configuration */
 213     vlc_mutex_t        config_lock; ///< config file lock
 214     char *             psz_configfile;   ///< location of config file
 215
 216     /* There is no real reason to keep a list of items, but not to break
 217      * everything, let's keep it */
 218     input_item_array_t input_items; ///< Array of all created input items
 219     int                i_last_input_id ; ///< Last id of input item
 220
 221     /* Messages */
 222     msg_bank_t         msg_bank;    ///< The message bank
 223     int                i_verbose;   ///< info messages
 224     bool               b_color;     ///< color messages?
 225
 226     /* Timer stats */
 227     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 228     counter_t        **pp_timers;   ///< Array of all timers
 229     int                i_timers;    ///< Number of timers
 230     bool               b_stats;     ///< Whether to collect stats
 231
 232     void              *p_stats_computer;  ///< Input thread computing stats
 233                                           /// (needs cleanup)
 234
 235     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 236     playlist_t        *p_playlist; //< the playlist singleton
 237     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 238     vlc_object_t      *p_interaction;    ///< interface interaction object
 239     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 240 } libvlc_priv_t;
 241
 242 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 243 {
 244     return (libvlc_priv_t *)(libvlc + 1);
 245 }
 246
 247 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 248
 249 /**
 250  * LibVLC "main module" configuration settings array.
 251  */
 252 extern module_config_t libvlc_config[];
 253 extern const size_t libvlc_config_count;
 254
 255 /*
 256  * Variables stuff
 257  */
 258 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 259
 260 /*
 261  * Replacement functions
 262  */
 263 # ifndef HAVE_DIRENT_H
 264 typedef void DIR;
 265 #  ifndef FILENAME_MAX
 266 #      define FILENAME_MAX (260)
 267 #  endif
 268 struct dirent
 269 {
 270     long            d_ino;          /* Always zero. */
 271     unsigned short  d_reclen;       /* Always zero. */
 272     unsigned short  d_namlen;       /* Length of name in d_name. */
 273     char            d_name[FILENAME_MAX]; /* File name. */
 274 };
 275 #  define opendir vlc_opendir
 276 #  define readdir vlc_readdir
 277 #  define closedir vlc_closedir
 278 #  define rewinddir vlc_rewindir
 279 void *vlc_opendir (const char *);
 280 void *vlc_readdir (void *);
 281 int   vlc_closedir(void *);
 282 void  vlc_rewinddir(void *);
 283 # endif
 284
 285 #if defined (WIN32)
 286 #   include <dirent.h>
 287 void *vlc_wopendir (const wchar_t *);
 288 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 289 struct _wdirent *vlc_wreaddir (void *);
 290 void vlc_rewinddir (void *);
 291 #   define _wopendir vlc_wopendir
 292 #   define _wreaddir vlc_wreaddir
 293 #   define _wclosedir vlc_wclosedir
 294 #   define rewinddir vlc_rewinddir
 295 #endif
 296
 297 #endif