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  * Unicode stuff
  51  */
  52 int utf8_mkdir( const char *filename );
  53
  54
  55 /*
  56  * LibVLC objects stuff
  57  */
  58
  59 extern vlc_object_t *
  60 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
  61                    const char *psz_type);
  62
  63 /*****************************************************************************
  64  * libvlc_global_data_t (global variable)
  65  *****************************************************************************
  66  * This structure has an unique instance, statically allocated in main and
  67  * never accessed from the outside. It stores once-initialized data such as
  68  * the CPU capabilities or the global lock.
  69  *****************************************************************************/
  70 struct libvlc_global_data_t
  71 {
  72     VLC_COMMON_MEMBERS
  73
  74     vlc_bool_t             b_ready;     ///< Initialization boolean
  75
  76    /* Object structure data */
  77     int                    i_counter;   ///< object counter
  78     int                    i_objects;   ///< Attached objects count
  79     vlc_object_t **        pp_objects;  ///< Array of all objects
  80
  81     module_bank_t *        p_module_bank; ///< The module bank
  82     intf_thread_t         *p_probe;       ///< Devices prober
  83
  84     /* Arch-specific variables */
  85 #if !defined( WIN32 )
  86     vlc_bool_t             b_daemon;
  87 #endif
  88 #if defined( SYS_BEOS )
  89     vlc_object_t *         p_appthread;
  90     char *                 psz_vlcpath;
  91 #elif defined( __APPLE__ )
  92     char *                 psz_vlcpath;
  93     vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
  94     vlc_mutex_t            iconv_lock;
  95 #elif defined( WIN32 )
  96     char *                 psz_vlcpath;
  97 #endif
  98 };
  99
 100
 101 libvlc_global_data_t *vlc_global (void);
 102 libvlc_int_t *vlc_current_object (int i_object);
 103
 104 /* Private LibVLC data for each objects */
 105 struct vlc_object_internals_t
 106 {
 107     /* Object variables */
 108     variable_t *    p_vars;
 109     vlc_mutex_t     var_lock;
 110     int             i_vars;
 111
 112     /* Thread properties, if any */
 113     vlc_thread_t    thread_id;
 114     vlc_bool_t      b_thread;
 115
 116     /* Objects management */
 117     vlc_bool_t      b_attached;
 118 };
 119
 120
 121 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
 122 {
 123     return obj->p_internals;
 124 }
 125
 126 #endif