]> git.sesse.net Git - vlc/blobdiff - include/main.h
some media descriptor tests
[vlc] / include / main.h
index 8505478d054c3120ec83cb6e69499daa672e57fe..7527d9e6f98a3c44c2a6c91f99128d7a672f8017 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-/*****************************************************************************
- * libvlc_t (global variable)
- *****************************************************************************
- * This structure has an unique instance, statically allocated in main and
- * never accessed from the outside. It store once-initialized data such as
- * the CPU capabilities or the global lock.
- *****************************************************************************/
-struct libvlc_t
-{
-    VLC_COMMON_MEMBERS
-
-    /* Initialization boolean */
-    vlc_bool_t             b_ready;
-
-    /* CPU extensions */
-    uint32_t               i_cpu;
-
-    /* Generic settings */
-    int                    i_verbose;                       /* info messages */
-    vlc_bool_t             b_color;                       /* color messages? */
-
-    /* Object structure data */
-    int                    i_counter;                      /* object counter */
-    int                    i_objects;              /* Attached objects count */
-    vlc_object_t **        pp_objects;               /* Array of all objects */
-
-    /* The message bank */
-    msg_bank_t             msg_bank;
-
-    /* The module bank */
-    module_bank_t *        p_module_bank;
-
-    /* Do stats ? - We keep this boolean to avoid unneeded lookups */
-    vlc_bool_t             b_stats;
-    stats_handler_t       *p_stats;
-
-    /* Arch-specific variables */
-#if !defined( WIN32 )
-    vlc_bool_t             b_daemon;
-#endif
-#if defined( SYS_BEOS )
-    vlc_object_t *         p_appthread;
-    char *                 psz_vlcpath;
-#elif defined( __APPLE__ )
-    char *                 psz_vlcpath;
-    vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
-    vlc_mutex_t            iconv_lock;
-#elif defined( WIN32 ) && !defined( UNDER_CE )
-    SIGNALOBJECTANDWAIT    SignalObjectAndWait;
-    vlc_bool_t             b_fast_mutex;
-    int                    i_win9x_cv;
-    char *                 psz_vlcpath;
-#elif defined( UNDER_CE )
-    char *                 psz_vlcpath;
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
 #endif
-};
 
 /*****************************************************************************
- * vlc_t, p_vlc
+ * libvlc_internal_instance_t
  *****************************************************************************
- * This structure is a LibVLC instance.
+ * This structure is a LibVLC instance, for use by libvlc core and plugins
  *****************************************************************************/
-struct vlc_t
+struct libvlc_int_t
 {
     VLC_COMMON_MEMBERS
 
     /* Global properties */
-    int                    i_argc;           /* command line arguments count */
-    char **                ppsz_argv;              /* command line arguments */
-    char *                 psz_homedir;           /* configuration directory */
-    char *                 psz_userdir;             /* user's home directory */
-    char *                 psz_configfile;        /* location of config file */
+    char *                 psz_homedir;      ///< user's home directory
+    char *                 psz_configdir;    ///< user's configuration directory
+    char *                 psz_datadir;      ///< user's data directory
+    char *                 psz_cachedir;     ///< user's cache directory
+
+    char *                 psz_configfile;   ///< location of config file
+
+    playlist_t            *p_playlist;       ///< playlist object
+
+    /* Messages */
+    msg_bank_t             msg_bank;    ///< The message bank
+    int                    i_verbose;   ///< info messages
+    vlc_bool_t             b_color;     ///< color messages?
 
-    /* Fast memcpy plugin used */
-    module_t *             p_memcpy_module;
-    void* ( *pf_memcpy ) ( void *, const void *, size_t );
-    void* ( *pf_memset ) ( void *, int, size_t );
+    module_t *             p_memcpy_module;  ///< Fast memcpy plugin used
+    void* ( *pf_memcpy ) ( void *, const void *, size_t ); ///< fast memcpy
+    void* ( *pf_memset ) ( void *, int, size_t );          ///< fast memset
 
-    /* Shared data - these structures are accessed directly from p_vlc by
-     * several modules */
+    vlc_bool_t             b_stats;       ///< Should we collect stats ?
+    vlc_mutex_t            timer_lock;    ///< Lock to protect timers
+    int                    i_timers;      ///< Number of timers
+    counter_t            **pp_timers;     ///< Array of all timers
 
-    /* Locks */
-    vlc_mutex_t            config_lock;          /* lock for the config file */
+    vlc_mutex_t            config_lock;    ///< Lock for the config file
 #ifdef __APPLE__
-    vlc_mutex_t            quicktime_lock;          /* QT is not thread safe on OSX */
+    vlc_mutex_t            quicktime_lock; ///< QT is not thread safe on OSX
 #endif
 
     /* Structure storing the action name / key associations */