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 void vlc_trace (const char *fn, const char *file, unsigned line);
  53 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  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 void msg_StackSet ( int, const char*, ... );
 101 void msg_StackAdd ( const char*, ... );
 102 const char* msg_StackMsg ( void );
 103 void msg_StackDestroy (void *);
 104
 105 /*
 106  * Unicode stuff
 107  */
 108 char *vlc_fix_readdir (const char *);
 109
 110 /*
 111  * LibVLC objects stuff
 112  */
 113
 114 /**
 115  * Creates a VLC object.
 116  *
 117  * Note that because the object name pointer must remain valid, potentially
 118  * even after the destruction of the object (through the message queues), this
 119  * function CANNOT be exported to plugins as is. In this case, the old
 120  * vlc_object_create() must be used instead.
 121  *
 122  * @param p_this an existing VLC object
 123  * @param i_size byte size of the object structure
 124  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 125  * @param psz_type object type name
 126  * @return the created object, or NULL.
 127  */
 128 extern void *
 129 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 130                      const char *psz_type);
 131 #define vlc_custom_create(o, s, t, n) \
 132         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 133
 134 /**
 135  * libvlc_global_data_t (global variable)
 136  *
 137  * This structure has an unique instance, statically allocated in libvlc and
 138  * never accessed from the outside. It stores process-wide VLC variables,
 139  * mostly process-wide locks, and (currently) the module bank and objects tree.
 140  */
 141 typedef struct libvlc_global_data_t
 142 {
 143     VLC_COMMON_MEMBERS
 144
 145     char *                 psz_vlcpath;
 146 } libvlc_global_data_t;
 147
 148 /**
 149  * The module bank
 150  */
 151 extern module_bank_t *p_module_bank;
 152
 153 libvlc_global_data_t *vlc_global (void);
 154
 155 /**
 156  * Private LibVLC data for each object.
 157  */
 158 struct vlc_object_internals_t
 159 {
 160     /* Object variables */
 161     variable_t *    p_vars;
 162     vlc_mutex_t     var_lock;
 163     int             i_vars;
 164
 165     /* Thread properties, if any */
 166     vlc_thread_t    thread_id;
 167     bool            b_thread;
 168
 169     /* Objects thread synchronization */
 170     vlc_mutex_t     lock;
 171     vlc_cond_t      wait;
 172     int             pipes[2];
 173     vlc_spinlock_t  spin;
 174
 175     /* Objects management */
 176     vlc_spinlock_t   ref_spin;
 177     unsigned         i_refcount;
 178     vlc_destructor_t pf_destructor;
 179
 180     /* Objects tree structure */
 181     vlc_object_t    *prev, *next;
 182     vlc_object_t   **pp_children;
 183     int              i_children;
 184 };
 185
 186 #define ZOOM_SECTION N_("Zoom")
 187 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 188 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 189 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 190 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 191
 192 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 193
 194 /**
 195  * Private LibVLC instance data.
 196  */
 197 typedef struct libvlc_priv_t
 198 {
 199     libvlc_int_t       public_data;
 200
 201     /* Configuration */
 202     vlc_mutex_t        config_lock; ///< config file lock
 203     char *             psz_configfile;   ///< location of config file
 204
 205     /* There is no real reason to keep a list of items, but not to break
 206      * everything, let's keep it */
 207     input_item_array_t input_items; ///< Array of all created input items
 208     int                i_last_input_id ; ///< Last id of input item
 209
 210     /* Messages */
 211     msg_bank_t         msg_bank;    ///< The message bank
 212     int                i_verbose;   ///< info messages
 213     bool               b_color;     ///< color messages?
 214     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 215     bool               msg_all_objects_enabled; ///< Should we print all objects?
 216
 217     /* Timer stats */
 218     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 219     counter_t        **pp_timers;   ///< Array of all timers
 220     int                i_timers;    ///< Number of timers
 221     bool               b_stats;     ///< Whether to collect stats
 222
 223     void              *p_stats_computer;  ///< Input thread computing stats
 224                                           /// (needs cleanup)
 225
 226     /* Singleton objects */
 227     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 228     playlist_t        *p_playlist; //< the playlist singleton
 229     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 230     interaction_t     *p_interaction;    ///< interface interaction object
 231     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 232 } libvlc_priv_t;
 233
 234 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 235 {
 236     return (libvlc_priv_t *)libvlc;
 237 }
 238
 239 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 240
 241 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 242
 243 /**
 244  * LibVLC "main module" configuration settings array.
 245  */
 246 extern module_config_t libvlc_config[];
 247 extern const size_t libvlc_config_count;
 248
 249 /*
 250  * Variables stuff
 251  */
 252 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 253
 254 /*
 255  * Replacement functions
 256  */
 257 # ifndef HAVE_DIRENT_H
 258 typedef void DIR;
 259 #  ifndef FILENAME_MAX
 260 #      define FILENAME_MAX (260)
 261 #  endif
 262 struct dirent
 263 {
 264     long            d_ino;          /* Always zero. */
 265     unsigned short  d_reclen;       /* Always zero. */
 266     unsigned short  d_namlen;       /* Length of name in d_name. */
 267     char            d_name[FILENAME_MAX]; /* File name. */
 268 };
 269 #  define opendir vlc_opendir
 270 #  define readdir vlc_readdir
 271 #  define closedir vlc_closedir
 272 #  define rewinddir vlc_rewindir
 273 void *vlc_opendir (const char *);
 274 void *vlc_readdir (void *);
 275 int   vlc_closedir(void *);
 276 void  vlc_rewinddir(void *);
 277 # endif
 278
 279 #if defined (WIN32)
 280 #   include <dirent.h>
 281 void *vlc_wopendir (const wchar_t *);
 282 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 283 struct _wdirent *vlc_wreaddir (void *);
 284 void vlc_rewinddir (void *);
 285 #   define _wopendir vlc_wopendir
 286 #   define _wreaddir vlc_wreaddir
 287 #   define _wclosedir vlc_wclosedir
 288 #   define rewinddir vlc_rewinddir
 289 #endif
 290
 291 #endif