vlc_interface.h 8.5 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
 *****************************************************************************
6
 * Copyright (C) 1999, 2000 the VideoLAN team
7
 * $Id$
8
 *
Sam Hocevar's avatar
   
Sam Hocevar committed
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10
11
12
13
14
 *
 * 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.
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
18
19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
20
 *
21
22
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24
25
 *****************************************************************************/

26
27
#ifndef VLC_INTF_H_
#define VLC_INTF_H_
zorglub's avatar
zorglub committed
28
29
30
31

# ifdef __cplusplus
extern "C" {
# endif
32

gbazin's avatar
   
gbazin committed
33
34
typedef struct intf_dialog_args_t intf_dialog_args_t;

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

/**
 * \defgroup vlc_interface Interface
 * These functions and structures are for interface management
 * @{
 */
zorglub's avatar
zorglub committed
46
47

/** Describe all interface-specific data of the interface thread */
48
struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
49
{
50
51
52
    VLC_COMMON_MEMBERS

    /* Thread properties and locks */
53
#if defined( __APPLE__ ) || defined( WIN32 )
54
    bool          b_should_run_on_first_thread;
55
#endif
Michel Kaempf's avatar
Michel Kaempf committed
56

57
    /* Specific interfaces */
gbazin's avatar
   
gbazin committed
58
    intf_sys_t *        p_sys;                          /** system interface */
59
    char *              psz_intf;                    /** intf name specified */
60

zorglub's avatar
zorglub committed
61
    /** Interface module */
62
    module_t *   p_module;
zorglub's avatar
zorglub committed
63
    void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
64

zorglub's avatar
zorglub committed
65
    /** Specific for dialogs providers */
gbazin's avatar
   
gbazin committed
66
67
    void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
                               intf_dialog_args_t * );
gbazin's avatar
   
gbazin committed
68

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

zorglub's avatar
zorglub 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.
zorglub's avatar
zorglub committed
75
 */
gbazin's avatar
   
gbazin committed
76
77
struct intf_dialog_args_t
{
zorglub's avatar
zorglub committed
78
    intf_thread_t *p_intf;
gbazin's avatar
   
gbazin 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;
zorglub's avatar
zorglub committed
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;
gbazin's avatar
   
gbazin committed
94
95
};

96
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
97
 * Prototypes
98
 *****************************************************************************/
99
100
#define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
Sam Hocevar's avatar
Sam Hocevar committed
101
VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
102
VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
Vincent Seguin's avatar
Vincent Seguin committed
103

zorglub's avatar
zorglub committed
104
105
106
#define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );

107
108
VLC_EXPORT( void, libvlc_Quit, ( libvlc_int_t * ) );

zorglub's avatar
zorglub committed
109
110
/*@}*/

gbazin's avatar
   
gbazin committed
111
112
113
/*****************************************************************************
 * Macros
 *****************************************************************************/
114
#if defined( WIN32 ) && !defined( UNDER_CE )
gbazin's avatar
   
gbazin committed
115
#    define CONSOLE_INTRO_MSG \
116
117
         if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
         { \
gbazin's avatar
   
gbazin committed
118
119
120
121
         AllocConsole(); \
         freopen( "CONOUT$", "w", stdout ); \
         freopen( "CONOUT$", "w", stderr ); \
         freopen( "CONIN$", "r", stdin ); \
122
         } \
123
         msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
gbazin's avatar
   
gbazin committed
124
         msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
zorglub's avatar
zorglub committed
125
                             "anymore, open a command-line window, go to the " \
gbazin's avatar
   
gbazin committed
126
                             "directory where you installed VLC and run " \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
127
                             "\"vlc -I qt\"\n") )
gbazin's avatar
   
gbazin committed
128
129
130
#else
#    define CONSOLE_INTRO_MSG
#endif
gbazin's avatar
   
gbazin committed
131
132

/* Interface dialog ids for dialog providers */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
133
typedef enum vlc_dialog {
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
    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
164
} vlc_dialog_t;
gbazin's avatar
   
gbazin committed
165
166

/* Useful text messages shared by interfaces */
167
#define INTF_ABOUT_MSG LICENSE_MSG
168

169
170
171
#define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.ape;*.dts;*.flac;*.it;" \
                         "*.m4a;*.m4p;*.mka;*.mlp;*.mod;*.mp1;*.mp2;*.mp3;" \
                         "*.oga;*.ogg;*.oma;*.s3m;*.spx;" \
172
                         "*.wav;*.wma;*.wv;*.xm"
173

174
#define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
175
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
176
                         "*.mpeg2;*.mpeg4;*.mpg;*.mts;*.mxf;*.nuv;" \
177
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
178
                         "*.rec;*.rm;*.rmvb;*.ts;*.vob;*.wmv"
179

180
#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.ram;*.vlc;*.xspf"
181

182
183
184
#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
                          EXTENSIONS_PLAYLIST

185
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
186
                            "*.jss;*.psb;*.rt;*.smi"
zorglub's avatar
zorglub committed
187
188
189
190
191
192
193
194
195
196

/** \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
197
typedef struct interaction_dialog_t
zorglub's avatar
zorglub committed
198
199
200
201
202
203
204
205
206
207
208
209
210
{
    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
211
    bool      b_cancelled;        ///< was the dialogue cancelled ?
zorglub's avatar
zorglub committed
212
213
214
215
216
217
218
219
220
221

    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
222
    intf_thread_t  *p_interface;
223
    vlc_mutex_t    *p_lock;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
224
} interaction_dialog_t;
225

zorglub's avatar
zorglub committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
/**
 * 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
};

262
#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
263
#define interaction_Register( t ) (t, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
264
265
#define interaction_Unregister( t ) (t, VLC_EGENERIC)

zorglub's avatar
zorglub committed
266
267
268
269
270
271
272
273

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

# ifdef __cplusplus
}
# endif
#endif