libvlc.h 8.39 KB
Newer Older
1
/*****************************************************************************
2
 * libvlc.h: Internal libvlc generic/misc declaration
3
 *****************************************************************************
4
 * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
5
 * Copyright © 2006-2007 Rémi Denis-Courmont
6
 * $Id$
7
 *
8 9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *
10 11 12 13 14 15 16 17 18 19 20 21
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

25 26
#ifndef LIBVLC_LIBVLC_H
# define LIBVLC_LIBVLC_H 1
27

28 29
typedef struct variable_t variable_t;

30
extern const char vlc_usage[];
31

32
/* Hotkey stuff */
33 34
extern const struct hotkey libvlc_hotkeys[];
extern const size_t libvlc_hotkeys_size;
35 36
extern int vlc_key_to_action (vlc_object_t *, const char *,
                              vlc_value_t, vlc_value_t, void *);
37

38 39 40 41 42 43 44
/*
 * OS-specific initialization
 */
void system_Init      ( libvlc_int_t *, int *, const char *[] );
void system_Configure ( libvlc_int_t *, int *, const char *[] );
void system_End       ( libvlc_int_t * );

45 46 47
/*
 * Threads subsystem
 */
48 49
int vlc_threads_init( void );
void vlc_threads_end( void );
50

51 52 53
/* Hopefully, no need to export this. There is a new thread API instead. */
void vlc_thread_cancel (vlc_object_t *);

54 55
void vlc_trace (const char *fn, const char *file, unsigned line);
#define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
56

57 58 59 60 61 62
/*
 * CPU capabilities
 */
extern uint32_t cpu_flags;
uint32_t CPUCapabilities( void );

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
/*
 * Message/logging stuff
 */

typedef struct msg_queue_t
{
    /** Message queue lock */
    vlc_mutex_t             lock;
    bool              b_overflow;

    /* Message queue */
    msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
    int i_start;
    int i_stop;

    /* Subscribers */
    int i_sub;
    msg_subscription_t **pp_sub;

    /* Logfile for WinCE */
#ifdef UNDER_CE
    FILE *logfile;
#endif
} msg_queue_t;

/**
89
 * Store all data required by messages interfaces.
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
90 91 92 93
 */
typedef struct msg_bank_t
{
    vlc_mutex_t             lock;
94
    msg_queue_t             queue;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
95 96
} msg_bank_t;

97 98 99 100 101 102 103 104
void msg_Create  (libvlc_int_t *);
void msg_Flush   (libvlc_int_t *);
void msg_Destroy (libvlc_int_t *);

/** Internal message stack context */
void msg_StackSet ( int, const char*, ... );
void msg_StackAdd ( const char*, ... );
const char* msg_StackMsg ( void );
105
void msg_StackDestroy (void *);
106

107 108 109
/*
 * Unicode stuff
 */
110
char *vlc_fix_readdir (const char *);
111 112 113 114 115

/*
 * LibVLC objects stuff
 */

116 117 118 119 120 121 122 123 124 125 126 127 128 129
/**
 * Creates a VLC object.
 *
 * Note that because the object name pointer must remain valid, potentially
 * even after the destruction of the object (through the message queues), this
 * function CANNOT be exported to plugins as is. In this case, the old
 * vlc_object_create() must be used instead.
 *
 * @param p_this an existing VLC object
 * @param i_size byte size of the object structure
 * @param i_type object type, usually VLC_OBJECT_CUSTOM
 * @param psz_type object type name
 * @return the created object, or NULL.
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
130
extern void *
131 132 133 134
__vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
                     const char *psz_type);
#define vlc_custom_create(o, s, t, n) \
        __vlc_custom_create(VLC_OBJECT(o), s, t, n)
135

136
/**
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
137
 * libvlc_global_data_t (global variable)
138 139 140 141 142 143
 *
 * This structure has an unique instance, statically allocated in libvlc and
 * never accessed from the outside. It stores process-wide VLC variables,
 * mostly process-wide locks, and (currently) the module bank and objects tree.
 */
typedef struct libvlc_global_data_t
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
144 145 146 147
{
    VLC_COMMON_MEMBERS

    char *                 psz_vlcpath;
148
} libvlc_global_data_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
149

150 151 152 153
/**
 * The module bank
 */
extern module_bank_t *p_module_bank;
154

155
libvlc_global_data_t *vlc_global (void);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
156

157 158 159
/**
 * Private LibVLC data for each object.
 */
160
typedef struct vlc_object_internals_t
161
{
162
    /* Object variables */
163
    variable_t *    p_vars;
164 165
    vlc_mutex_t     var_lock;
    int             i_vars;
166 167

    /* Thread properties, if any */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
168
    vlc_thread_t    thread_id;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
169
    bool            b_thread;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
170

171
    /* Objects thread synchronization */
172 173
    vlc_mutex_t     lock;
    vlc_cond_t      wait;
174
    int             pipes[2];
175
    vlc_spinlock_t  spin;
176

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
177
    /* Objects management */
178
    vlc_spinlock_t   ref_spin;
179 180
    unsigned         i_refcount;
    vlc_destructor_t pf_destructor;
181

182 183
    /* Objects tree structure */
    vlc_object_t    *prev, *next;
184 185
    vlc_object_t   **pp_children;
    int              i_children;
186
} vlc_object_internals_t;
187

188 189 190 191 192
#define ZOOM_SECTION N_("Zoom")
#define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
#define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
#define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
#define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
193

194
#define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
195

196 197
typedef struct sap_handler_t sap_handler_t;

198 199 200 201 202
/**
 * Private LibVLC instance data.
 */
typedef struct libvlc_priv_t
{
203 204
    libvlc_int_t       public_data;

205
    /* Configuration */
206
    vlc_mutex_t        config_lock; ///< config file lock
207
    char *             psz_configfile;   ///< location of config file
208

209 210
    int                i_last_input_id ; ///< Last id of input item

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
211 212 213 214
    /* Messages */
    msg_bank_t         msg_bank;    ///< The message bank
    int                i_verbose;   ///< info messages
    bool               b_color;     ///< color messages?
215 216
    vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
    bool               msg_all_objects_enabled; ///< Should we print all objects?
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
217 218

    /* Timer stats */
219 220 221 222
    vlc_mutex_t        timer_lock;  ///< Lock to protect timers
    counter_t        **pp_timers;   ///< Array of all timers
    int                i_timers;    ///< Number of timers
    bool               b_stats;     ///< Whether to collect stats
223

224 225 226
    void              *p_stats_computer;  ///< Input thread computing stats
                                          /// (needs cleanup)

227
    /* Singleton objects */
228
    module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
229 230
    playlist_t        *p_playlist; //< the playlist singleton
    vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
231
    interaction_t     *p_interaction;    ///< interface interaction object
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
232
    httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
233 234 235
#ifdef ENABLE_SOUT
    sap_handler_t     *p_sap; ///< SAP SDP advertiser
#endif
236 237 238 239
} libvlc_priv_t;

static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
{
240
    return (libvlc_priv_t *)libvlc;
241 242
}

243 244
void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );

245
#define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
246 247 248 249

/**
 * LibVLC "main module" configuration settings array.
 */
250
extern module_config_t libvlc_config[];
251 252
extern const size_t libvlc_config_count;

253 254 255
/*
 * Variables stuff
 */
256
void var_OptionParse (vlc_object_t *, const char *, bool trusted);
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/*
 * Replacement functions
 */
# ifndef HAVE_DIRENT_H
typedef void DIR;
#  ifndef FILENAME_MAX
#      define FILENAME_MAX (260)
#  endif
struct dirent
{
    long            d_ino;          /* Always zero. */
    unsigned short  d_reclen;       /* Always zero. */
    unsigned short  d_namlen;       /* Length of name in d_name. */
    char            d_name[FILENAME_MAX]; /* File name. */
};
#  define opendir vlc_opendir
#  define readdir vlc_readdir
#  define closedir vlc_closedir
#  define rewinddir vlc_rewindir
void *vlc_opendir (const char *);
void *vlc_readdir (void *);
int   vlc_closedir(void *);
void  vlc_rewinddir(void *);
# endif

283 284 285
#if defined (WIN32)
#   include <dirent.h>
void *vlc_wopendir (const wchar_t *);
286
/* void *vlc_wclosedir (void *); in vlc's exported symbols */
287 288 289 290 291 292 293 294
struct _wdirent *vlc_wreaddir (void *);
void vlc_rewinddir (void *);
#   define _wopendir vlc_wopendir
#   define _wreaddir vlc_wreaddir
#   define _wclosedir vlc_wclosedir
#   define rewinddir vlc_rewinddir
#endif

295
#endif