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 struct hotkey libvlc_hotkeys[];
  31 extern const size_t libvlc_hotkeys_size;
  32
  33
  34 /*
  35  * OS-specific initialization
  36  */
  37 void system_Init      ( libvlc_int_t *, int *, const char *[] );
  38 void system_Configure ( libvlc_int_t *, int *, const char *[] );
  39 void system_End       ( libvlc_int_t * );
  40
  41 #if defined( SYS_BEOS )
  42 /* Nothing at the moment, create beos_specific.h when needed */
  43 #elif defined( __APPLE__ )
  44 /* Nothing at the moment, create darwin_specific.h when needed */
  45 #elif defined( WIN32 ) || defined( UNDER_CE )
  46 VLC_EXPORT( const char * , system_VLCPath, (void));
  47 #else
  48 # define system_Init( a, b, c )      (void)0
  49 # define system_Configure( a, b, c ) (void)0
  50 # define system_End( a )             (void)0
  51 #endif
  52
  53
  54 /*
  55  * Threads subsystem
  56  */
  57 int __vlc_threads_init( vlc_object_t * );
  58 int __vlc_threads_end( vlc_object_t * );
  59
  60 /*
  61  * CPU capabilities
  62  */
  63 extern uint32_t cpu_flags;
  64 uint32_t CPUCapabilities( void );
  65
  66 /*
  67  * Unicode stuff
  68  */
  69
  70 /*
  71  * LibVLC objects stuff
  72  */
  73
  74 /**
  75  * Creates a VLC object.
  76  *
  77  * Note that because the object name pointer must remain valid, potentially
  78  * even after the destruction of the object (through the message queues), this
  79  * function CANNOT be exported to plugins as is. In this case, the old
  80  * vlc_object_create() must be used instead.
  81  *
  82  * @param p_this an existing VLC object
  83  * @param i_size byte size of the object structure
  84  * @param i_type object type, usually VLC_OBJECT_CUSTOM
  85  * @param psz_type object type name
  86  * @return the created object, or NULL.
  87  */
  88 extern vlc_object_t *
  89 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
  90                    const char *psz_type);
  91
  92 /*****************************************************************************
  93  * libvlc_global_data_t (global variable)
  94  *****************************************************************************
  95  * This structure has an unique instance, statically allocated in main and
  96  * never accessed from the outside. It stores once-initialized data such as
  97  * the CPU capabilities or the global lock.
  98  *****************************************************************************/
  99 struct libvlc_global_data_t
 100 {
 101     VLC_COMMON_MEMBERS
 102
 103     vlc_bool_t             b_ready;     ///< Initialization boolean
 104
 105    /* Object structure data */
 106     int                    i_counter;   ///< object counter
 107     int                    i_objects;   ///< Attached objects count
 108     vlc_object_t **        pp_objects;  ///< Array of all objects
 109
 110     module_bank_t *        p_module_bank; ///< The module bank
 111     intf_thread_t         *p_probe;       ///< Devices prober
 112
 113     /* Arch-specific variables */
 114 #if !defined( WIN32 )
 115     vlc_bool_t             b_daemon;
 116 #endif
 117 #if defined( SYS_BEOS )
 118     vlc_object_t *         p_appthread;
 119     char *                 psz_vlcpath;
 120 #elif defined( __APPLE__ )
 121     char *                 psz_vlcpath;
 122     vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
 123     vlc_mutex_t            iconv_lock;
 124 #elif defined( WIN32 )
 125     char *                 psz_vlcpath;
 126 #endif
 127 };
 128
 129
 130 libvlc_global_data_t *vlc_global (void);
 131 libvlc_int_t *vlc_current_object (int i_object);
 132
 133 /* Private LibVLC data for each objects */
 134 struct vlc_object_internals_t
 135 {
 136     /* Object variables */
 137     variable_t *    p_vars;
 138     vlc_mutex_t     var_lock;
 139     int             i_vars;
 140
 141     /* Thread properties, if any */
 142     vlc_thread_t    thread_id;
 143     vlc_bool_t      b_thread;
 144
 145     /* Objects thread synchronization */
 146     int             pipes[2];
 147     vlc_spinlock_t  spin;
 148
 149     /* Objects management */
 150     unsigned         i_refcount;
 151     vlc_destructor_t pf_destructor;
 152     vlc_bool_t       b_attached;
 153 };
 154
 155 #define ZOOM_SECTION N_("Zoom")
 156 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 157 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 158 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 159 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 160
 161 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
 162 {
 163     return obj->p_internals;
 164 }
 165
 166 extern module_config_t libvlc_config[];
 167 extern const size_t libvlc_config_count;
 168
 169 /*
 170  * Variables stuff
 171  */
 172 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 173
 174 #endif