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