vlc_interface.h 10.4 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_interface.h: interface access for other threads
Michel Kaempf's avatar
Michel Kaempf committed
3 4
 * This library provides basic functions for threads to interact with user
 * interface, such as message output.
5
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
6
 * Copyright (C) 1999, 2000 VLC authors and VideoLAN
7
 * $Id$
8
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
11 12 13
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
14
 * (at your option) any later version.
15
 *
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
21 22 23
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 25
 *****************************************************************************/

26 27
#ifndef VLC_INTF_H_
#define VLC_INTF_H_
Clément Stenac's avatar
Clément Stenac committed
28 29 30 31

# ifdef __cplusplus
extern "C" {
# endif
32

Gildas Bazin's avatar
 
Gildas Bazin committed
33 34
typedef struct intf_dialog_args_t intf_dialog_args_t;

Clément Stenac's avatar
Clément Stenac committed
35 36
/**
 * \file
Clément Stenac's avatar
Clément Stenac committed
37 38
 * This file contains structures and function prototypes for
 * interface management in vlc
Clément Stenac's avatar
Clément Stenac committed
39 40 41 42 43 44 45
 */

/**
 * \defgroup vlc_interface Interface
 * These functions and structures are for interface management
 * @{
 */
Clément Stenac's avatar
Clément Stenac committed
46

47 48
typedef struct intf_sys_t intf_sys_t;

Clément Stenac's avatar
Clément Stenac committed
49
/** Describe all interface-specific data of the interface thread */
50
typedef struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
51
{
52 53
    VLC_COMMON_MEMBERS

54
    struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
55
    vlc_thread_t thread; /** LibVLC thread */
56
    /* Thread properties and locks */
Michel Kaempf's avatar
Michel Kaempf committed
57

58
    /* Specific interfaces */
Gildas Bazin's avatar
 
Gildas Bazin committed
59
    intf_sys_t *        p_sys;                          /** system interface */
60

Clément Stenac's avatar
Clément Stenac committed
61
    /** Interface module */
62
    module_t *   p_module;
63
    void      ( *pf_run )    ( struct intf_thread_t * ); /** Run function */
64

Clément Stenac's avatar
Clément Stenac committed
65
    /** Specific for dialogs providers */
66
    void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
Gildas Bazin's avatar
 
Gildas Bazin committed
67
                               intf_dialog_args_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
68

69
    config_chain_t *p_cfg;
70
} intf_thread_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
71

Clément Stenac's avatar
Clément Stenac committed
72 73
/** \brief Arguments passed to a dialogs provider
 *  This describes the arguments passed to the dialogs provider. They are
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
74
 *  mainly used with INTF_DIALOG_FILE_GENERIC.
Clément Stenac's avatar
Clément Stenac committed
75
 */
Gildas Bazin's avatar
 
Gildas Bazin committed
76 77
struct intf_dialog_args_t
{
78
    intf_thread_t *p_intf;
Gildas Bazin's avatar
 
Gildas Bazin committed
79 80 81 82 83 84 85 86 87 88
    char *psz_title;

    char **psz_results;
    int  i_results;

    void (*pf_callback) ( intf_dialog_args_t * );
    void *p_arg;

    /* Specifically for INTF_DIALOG_FILE_GENERIC */
    char *psz_extensions;
89 90
    bool b_save;
    bool b_multiple;
91 92

    /* Specific to INTF_DIALOG_INTERACTION */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
93
    struct interaction_dialog_t *p_dialog;
Gildas Bazin's avatar
 
Gildas Bazin committed
94 95
};

96
VLC_API int intf_Create( vlc_object_t *, const char * );
97
#define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
Vincent Seguin's avatar
Vincent Seguin committed
98

99
VLC_API void libvlc_Quit( libvlc_int_t * );
100

101 102 103 104 105 106 107 108 109 110 111 112 113
/**
 * \defgroup vlc_subscription Log messages subscription
 * These functions deal with log messages.
 * @{
 */

/**
 * Message logging callback signature.
 * Accepts one private data pointer, the message, and an overrun counter.
 */
typedef void (*msg_callback_t) (void *, int, const msg_item_t *,
                                const char *, va_list);

114 115 116 117 118 119 120 121 122 123 124
/**
 * Used by interface plugins which subscribe to the message bank.
 */
typedef struct msg_subscription
{
    struct msg_subscription *prev, *next;
    msg_callback_t func;
    void *opaque;
} msg_subscription_t;

VLC_API void vlc_Subscribe(msg_subscription_t *, msg_callback_t, void *);
125 126
VLC_API void vlc_Unsubscribe(msg_subscription_t *);

Clément Stenac's avatar
Clément Stenac committed
127 128
/*@}*/

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
129
#if defined( WIN32 )
Gildas Bazin's avatar
 
Gildas Bazin committed
130
#    define CONSOLE_INTRO_MSG \
131
         if( !getenv( "PWD" ) ) /* detect Cygwin shell or Wine */ \
132
         { \
Gildas Bazin's avatar
 
Gildas Bazin committed
133 134 135 136
         AllocConsole(); \
         freopen( "CONOUT$", "w", stdout ); \
         freopen( "CONOUT$", "w", stderr ); \
         freopen( "CONIN$", "r", stdin ); \
137
         } \
138
         msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \
139
         msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
140
         msg_Info( p_intf, _("\nWarning: if you cannot access the GUI " \
141
                             "anymore, open a command-line window, go to the " \
Gildas Bazin's avatar
 
Gildas Bazin committed
142
                             "directory where you installed VLC and run " \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
143
                             "\"vlc -I qt\"\n") )
Gildas Bazin's avatar
 
Gildas Bazin committed
144
#else
145
#    define CONSOLE_INTRO_MSG (void)0
Gildas Bazin's avatar
 
Gildas Bazin committed
146
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
147 148

/* Interface dialog ids for dialog providers */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
149
typedef enum vlc_dialog {
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    INTF_DIALOG_FILE_SIMPLE = 1,
    INTF_DIALOG_FILE,
    INTF_DIALOG_DISC,
    INTF_DIALOG_NET,
    INTF_DIALOG_CAPTURE,
    INTF_DIALOG_SAT,
    INTF_DIALOG_DIRECTORY,

    INTF_DIALOG_STREAMWIZARD,
    INTF_DIALOG_WIZARD,

    INTF_DIALOG_PLAYLIST,
    INTF_DIALOG_MESSAGES,
    INTF_DIALOG_FILEINFO,
    INTF_DIALOG_PREFS,
    INTF_DIALOG_BOOKMARKS,
    INTF_DIALOG_EXTENDED,

    INTF_DIALOG_POPUPMENU = 20,
    INTF_DIALOG_AUDIOPOPUPMENU,
    INTF_DIALOG_VIDEOPOPUPMENU,
    INTF_DIALOG_MISCPOPUPMENU,

    INTF_DIALOG_FILE_GENERIC = 30,
    INTF_DIALOG_INTERACTION = 50,

    INTF_DIALOG_UPDATEVLC = 90,
    INTF_DIALOG_VLM,

    INTF_DIALOG_EXIT = 99
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
180
} vlc_dialog_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
181 182

/* Useful text messages shared by interfaces */
183
#define INTF_ABOUT_MSG LICENSE_MSG
184

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
185
#define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
186
                         "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3", "mpc", "mpga", \
187
                         "oga", "ogg", "opus", "oma", "qcp", "ra", "rmi", "s3m", "spx", "thd", "tta", \
188 189
                         "wav", "wma", "wv", "xm"

190
#define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "drc", "dv", "f4v", "flv", "gvi", "gxf", "iso", \
191 192
                             "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
                             "mp2", "mp4", "mpeg", "mpeg1", \
Sébastien Escudier's avatar
Sébastien Escudier committed
193
                             "mpeg2", "mpeg4", "mpg", "mts", "mtv", "mxf", "mxg", "nuv", \
194
                             "ogg", "ogm", "ogv", "ogx", "ps", \
195
                             "rec", "rm", "rmvb", "ts", "vob", "wm", "wmv", "wtv", "xesc"
196

197
#define EXTENSIONS_AUDIO \
Julien Humbert's avatar
Julien Humbert committed
198
    "*.3ga;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
199
    "*.669;" \
200 201 202
    "*.a52;" \
    "*.aac;" \
    "*.ac3;" \
203 204 205 206
    "*.adt;" \
    "*.adts;" \
    "*.aif;"\
    "*.aifc;"\
207
    "*.aiff;"\
208
    "*.amr;" \
209 210
    "*.aob;" \
    "*.ape;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
211
    "*.awb;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
212
    "*.caf;" \
213
    "*.cda;" \
214 215 216 217 218 219 220 221 222 223 224 225 226
    "*.dts;" \
    "*.flac;"\
    "*.it;"  \
    "*.m4a;" \
    "*.m4p;" \
    "*.mid;" \
    "*.mka;" \
    "*.mlp;" \
    "*.mod;" \
    "*.mp1;" \
    "*.mp2;" \
    "*.mp3;" \
    "*.mpc;" \
227
    "*.mpga;" \
228 229 230
    "*.oga;" \
    "*.ogg;" \
    "*.oma;" \
.'s avatar
. committed
231
    "*.opus;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
232
    "*.qcp;" \
233
    "*.ra;" \
234 235 236
    "*.rmi;" \
    "*.s3m;" \
    "*.spx;" \
237
    "*.thd;" \
238
    "*.tta;" \
239 240 241 242 243 244 245 246
    "*.voc;" \
    "*.vqf;" \
    "*.w64;" \
    "*.wav;" \
    "*.wma;" \
    "*.wv;"  \
    "*.xa;"  \
    "*.xm"
247

248
#define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.drc;*.dv;*f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
249
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
Sébastien Escudier's avatar
Sébastien Escudier committed
250
                         "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
251
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
252
                         "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
253

254
#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wvx;*.zip;*.conf"
255

256 257 258
#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
                          EXTENSIONS_PLAYLIST

259 260 261 262 263
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
                            "*.sub;*.utf;*.ass;" \
                            "*.ssa;*.aqt;" \
                            "*.jss;*.psb;" \
                            "*.rt;*.smi;*.txt;" \
264
                            "*.smil;*.stl;*.usf;" \
265
                            "*.dks;*.pjs;*.mpl2"
Clément Stenac's avatar
Clément Stenac committed
266 267 268 269 270 271 272 273 274 275

/** \defgroup vlc_interaction Interaction
 * \ingroup vlc_interface
 * Interaction between user and modules
 * @{
 */

/**
 * This structure describes a piece of interaction with the user
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
276
typedef struct interaction_dialog_t
Clément Stenac's avatar
Clément Stenac committed
277 278 279 280 281 282 283 284 285 286 287 288 289
{
    int             i_type;             ///< Type identifier
    char           *psz_title;          ///< Title
    char           *psz_description;    ///< Descriptor string
    char           *psz_default_button;  ///< default button title (~OK)
    char           *psz_alternate_button;///< alternate button title (~NO)
    /// other button title (optional,~Cancel)
    char           *psz_other_button;

    char           *psz_returned[1];    ///< returned responses from the user

    vlc_value_t     val;                ///< value coming from core for dialogue
    int             i_timeToGo;         ///< time (in sec) until shown progress is finished
290
    bool      b_cancelled;        ///< was the dialogue cancelled ?
Clément Stenac's avatar
Clément Stenac committed
291 292 293 294 295 296 297 298 299 300

    void *          p_private;          ///< Private interface data

    int             i_status;           ///< Dialog status;
    int             i_action;           ///< Action to perform;
    int             i_flags;            ///< Misc flags
    int             i_return;           ///< Return status

    vlc_object_t   *p_parent;           ///< The vlc object that asked
                                        //for interaction
301
    intf_thread_t  *p_interface;
302
    vlc_mutex_t    *p_lock;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
303
} interaction_dialog_t;
304

Clément Stenac's avatar
Clément Stenac committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
/**
 * Possible flags . Dialog types
 */
#define DIALOG_GOT_ANSWER           0x01
#define DIALOG_YES_NO_CANCEL        0x02
#define DIALOG_LOGIN_PW_OK_CANCEL   0x04
#define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
#define DIALOG_BLOCKING_ERROR       0x10
#define DIALOG_NONBLOCKING_ERROR    0x20
#define DIALOG_USER_PROGRESS        0x80
#define DIALOG_INTF_PROGRESS        0x100

/** Possible return codes */
enum
{
    DIALOG_OK_YES,
    DIALOG_NO,
    DIALOG_CANCELLED
};

/** Possible status  */
enum
{
    ANSWERED_DIALOG,            ///< Got "answer"
    DESTROYED_DIALOG,           ///< Interface has destroyed it
};

/** Possible actions */
enum
{
    INTERACT_NEW,
    INTERACT_UPDATE,
    INTERACT_HIDE,
    INTERACT_DESTROY
};

341
#define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
342
#define interaction_Register( t ) (t, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
343 344
#define interaction_Unregister( t ) (t, VLC_EGENERIC)

Clément Stenac's avatar
Clément Stenac committed
345 346 347 348 349 350 351 352

/** @} */
/** @} */

# ifdef __cplusplus
}
# endif
#endif