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 extern const module_config_t libvlc_config[];
  31 extern const size_t libvlc_config_count;
  32
  33 extern const struct hotkey libvlc_hotkeys[];
  34 extern const size_t libvlc_hotkeys_size;
  35
  36
  37 /*
  38  * Threads subsystem
  39  */
  40 int __vlc_threads_init( vlc_object_t * );
  41 int __vlc_threads_end( vlc_object_t * );
  42
  43 /*
  44  * CPU capabilities
  45  */
  46 extern uint32_t cpu_flags;
  47 uint32_t CPUCapabilities( void );
  48
  49
  50 /*
  51  * LibVLC objects stuff
  52  */
  53
  54 extern vlc_object_t *
  55 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
  56                    const char *psz_type);
  57
  58 /*****************************************************************************
  59  * libvlc_global_data_t (global variable)
  60  *****************************************************************************
  61  * This structure has an unique instance, statically allocated in main and
  62  * never accessed from the outside. It stores once-initialized data such as
  63  * the CPU capabilities or the global lock.
  64  *****************************************************************************/
  65 struct libvlc_global_data_t
  66 {
  67     VLC_COMMON_MEMBERS
  68
  69     vlc_bool_t             b_ready;     ///< Initialization boolean
  70
  71    /* Object structure data */
  72     int                    i_counter;   ///< object counter
  73     int                    i_objects;   ///< Attached objects count
  74     vlc_object_t **        pp_objects;  ///< Array of all objects
  75
  76     module_bank_t *        p_module_bank; ///< The module bank
  77     intf_thread_t         *p_probe;       ///< Devices prober
  78
  79     /* Arch-specific variables */
  80 #if !defined( WIN32 )
  81     vlc_bool_t             b_daemon;
  82 #endif
  83 #if defined( SYS_BEOS )
  84     vlc_object_t *         p_appthread;
  85     char *                 psz_vlcpath;
  86 #elif defined( __APPLE__ )
  87     char *                 psz_vlcpath;
  88     vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
  89     vlc_mutex_t            iconv_lock;
  90 #elif defined( WIN32 )
  91     char *                 psz_vlcpath;
  92 #endif
  93 };
  94
  95 libvlc_global_data_t *vlc_global (void);
  96
  97 /* Private LibVLC data for each objects */
  98 struct vlc_object_internals_t
  99 {
 100     /* Object variables */
 101     variable_t *    p_vars;
 102     vlc_mutex_t     var_lock;
 103     int             i_vars;
 104
 105     /* Thread properties, if any */
 106     vlc_thread_t thread_id;
 107     vlc_bool_t   b_thread;
 108 };
 109
 110
 111 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
 112 {
 113     return obj->p_internals;
 114 }
 115
 116 #endif