LGPL
[vlc.git] / include / vlc_interface.h
1 /*****************************************************************************
2  * vlc_interface.h: interface access for other threads
3  * This library provides basic functions for threads to interact with user
4  * interface, such as message output.
5  *****************************************************************************
6  * Copyright (C) 1999, 2000 VLC authors and VideoLAN
7  * $Id$
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 #ifndef VLC_INTF_H_
27 #define VLC_INTF_H_
28
29 # ifdef __cplusplus
30 extern "C" {
31 # endif
32
33 typedef struct intf_dialog_args_t intf_dialog_args_t;
34
35 /**
36  * \file
37  * This file contains structures and function prototypes for
38  * interface management in vlc
39  */
40
41 /**
42  * \defgroup vlc_interface Interface
43  * These functions and structures are for interface management
44  * @{
45  */
46
47 typedef struct intf_sys_t intf_sys_t;
48
49 /** Describe all interface-specific data of the interface thread */
50 typedef struct intf_thread_t
51 {
52     VLC_COMMON_MEMBERS
53
54     struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
55     vlc_thread_t thread; /** LibVLC thread */
56     /* Thread properties and locks */
57 #if defined( __APPLE__ )
58     bool          b_should_run_on_first_thread;
59 #endif
60
61     /* Specific interfaces */
62     intf_sys_t *        p_sys;                          /** system interface */
63
64     /** Interface module */
65     module_t *   p_module;
66     void      ( *pf_run )    ( struct intf_thread_t * ); /** Run function */
67
68     /** Specific for dialogs providers */
69     void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
70                                intf_dialog_args_t * );
71
72     config_chain_t *p_cfg;
73 } intf_thread_t;
74
75 /** \brief Arguments passed to a dialogs provider
76  *  This describes the arguments passed to the dialogs provider. They are
77  *  mainly used with INTF_DIALOG_FILE_GENERIC.
78  */
79 struct intf_dialog_args_t
80 {
81     intf_thread_t *p_intf;
82     char *psz_title;
83
84     char **psz_results;
85     int  i_results;
86
87     void (*pf_callback) ( intf_dialog_args_t * );
88     void *p_arg;
89
90     /* Specifically for INTF_DIALOG_FILE_GENERIC */
91     char *psz_extensions;
92     bool b_save;
93     bool b_multiple;
94
95     /* Specific to INTF_DIALOG_INTERACTION */
96     struct interaction_dialog_t *p_dialog;
97 };
98
99 /*****************************************************************************
100  * Prototypes
101  *****************************************************************************/
102 VLC_API int intf_Create( vlc_object_t *, const char * );
103 #define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
104
105 VLC_API void libvlc_Quit( libvlc_int_t * );
106
107 /*@}*/
108
109 /*****************************************************************************
110  * Macros
111  *****************************************************************************/
112 #if defined( WIN32 ) && !defined( UNDER_CE )
113 #    define CONSOLE_INTRO_MSG \
114          if( !getenv( "PWD" ) ) /* detect Cygwin shell or Wine */ \
115          { \
116          AllocConsole(); \
117          freopen( "CONOUT$", "w", stdout ); \
118          freopen( "CONOUT$", "w", stderr ); \
119          freopen( "CONIN$", "r", stdin ); \
120          } \
121          msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \
122          msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
123          msg_Info( p_intf, _("\nWarning: if you cannot access the GUI " \
124                              "anymore, open a command-line window, go to the " \
125                              "directory where you installed VLC and run " \
126                              "\"vlc -I qt\"\n") )
127 #else
128 #    define CONSOLE_INTRO_MSG (void)0
129 #endif
130
131 /* Interface dialog ids for dialog providers */
132 typedef enum vlc_dialog {
133     INTF_DIALOG_FILE_SIMPLE = 1,
134     INTF_DIALOG_FILE,
135     INTF_DIALOG_DISC,
136     INTF_DIALOG_NET,
137     INTF_DIALOG_CAPTURE,
138     INTF_DIALOG_SAT,
139     INTF_DIALOG_DIRECTORY,
140
141     INTF_DIALOG_STREAMWIZARD,
142     INTF_DIALOG_WIZARD,
143
144     INTF_DIALOG_PLAYLIST,
145     INTF_DIALOG_MESSAGES,
146     INTF_DIALOG_FILEINFO,
147     INTF_DIALOG_PREFS,
148     INTF_DIALOG_BOOKMARKS,
149     INTF_DIALOG_EXTENDED,
150
151     INTF_DIALOG_POPUPMENU = 20,
152     INTF_DIALOG_AUDIOPOPUPMENU,
153     INTF_DIALOG_VIDEOPOPUPMENU,
154     INTF_DIALOG_MISCPOPUPMENU,
155
156     INTF_DIALOG_FILE_GENERIC = 30,
157     INTF_DIALOG_INTERACTION = 50,
158
159     INTF_DIALOG_UPDATEVLC = 90,
160     INTF_DIALOG_VLM,
161
162     INTF_DIALOG_EXIT = 99
163 } vlc_dialog_t;
164
165 /* Useful text messages shared by interfaces */
166 #define INTF_ABOUT_MSG LICENSE_MSG
167
168 #define EXTENSIONS_AUDIO_CSV "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
169                          "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3",\
170                          "oga", "ogg", "oma", "s3m", "spx" \
171                          "wav", "wma", "wv", "xm"
172
173 #define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "dv", "f4v", "flv", "gxf", "iso", \
174                              "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
175                              "mp2", "mp4", "mpeg", "mpeg1", \
176                              "mpeg2", "mpeg4", "mpg", "mts", "mtv", "mxf", "nuv", \
177                              "ogg", "ogm", "ogv", "ogx", "ps", \
178                              "rec", "rm", "rmvb", "ts", "vob", "wmv"
179
180 #define EXTENSIONS_AUDIO \
181     "*.a52;" \
182     "*.aac;" \
183     "*.ac3;" \
184     "*.adt;" \
185     "*.adts;" \
186     "*.aif;"\
187     "*.aifc;"\
188     "*.aiff;"\
189     "*.amr;" \
190     "*.aob;" \
191     "*.ape;" \
192     "*.awb;" \
193     "*.caf;" \
194     "*.cda;" \
195     "*.dts;" \
196     "*.flac;"\
197     "*.it;"  \
198     "*.m4a;" \
199     "*.m4p;" \
200     "*.mid;" \
201     "*.mka;" \
202     "*.mlp;" \
203     "*.mod;" \
204     "*.mp1;" \
205     "*.mp2;" \
206     "*.mp3;" \
207     "*.mpc;" \
208     "*.oga;" \
209     "*.ogg;" \
210     "*.oma;" \
211     "*.rmi;" \
212     "*.s3m;" \
213     "*.spx;" \
214     "*.tta;" \
215     "*.voc;" \
216     "*.vqf;" \
217     "*.w64;" \
218     "*.wav;" \
219     "*.wma;" \
220     "*.wv;"  \
221     "*.xa;"  \
222     "*.xm"
223
224 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.dv;*f4v;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
225                          "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
226                          "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.nsv;*.nuv;" \
227                          "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
228                          "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wmv"
229
230 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.zip"
231
232 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
233                           EXTENSIONS_PLAYLIST
234
235 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
236                             "*.sub;*.utf;*.ass;" \
237                             "*.ssa;*.aqt;" \
238                             "*.jss;*.psb;" \
239                             "*.rt;*.smi;*.txt;" \
240                             "*.smil;*.stl;*.usf" \
241                             "*.dks;*.pjs;*.mpl2"
242
243 /** \defgroup vlc_interaction Interaction
244  * \ingroup vlc_interface
245  * Interaction between user and modules
246  * @{
247  */
248
249 /**
250  * This structure describes a piece of interaction with the user
251  */
252 typedef struct interaction_dialog_t
253 {
254     int             i_type;             ///< Type identifier
255     char           *psz_title;          ///< Title
256     char           *psz_description;    ///< Descriptor string
257     char           *psz_default_button;  ///< default button title (~OK)
258     char           *psz_alternate_button;///< alternate button title (~NO)
259     /// other button title (optional,~Cancel)
260     char           *psz_other_button;
261
262     char           *psz_returned[1];    ///< returned responses from the user
263
264     vlc_value_t     val;                ///< value coming from core for dialogue
265     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
266     bool      b_cancelled;        ///< was the dialogue cancelled ?
267
268     void *          p_private;          ///< Private interface data
269
270     int             i_status;           ///< Dialog status;
271     int             i_action;           ///< Action to perform;
272     int             i_flags;            ///< Misc flags
273     int             i_return;           ///< Return status
274
275     vlc_object_t   *p_parent;           ///< The vlc object that asked
276                                         //for interaction
277     intf_thread_t  *p_interface;
278     vlc_mutex_t    *p_lock;
279 } interaction_dialog_t;
280
281 /**
282  * Possible flags . Dialog types
283  */
284 #define DIALOG_GOT_ANSWER           0x01
285 #define DIALOG_YES_NO_CANCEL        0x02
286 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
287 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
288 #define DIALOG_BLOCKING_ERROR       0x10
289 #define DIALOG_NONBLOCKING_ERROR    0x20
290 #define DIALOG_USER_PROGRESS        0x80
291 #define DIALOG_INTF_PROGRESS        0x100
292
293 /** Possible return codes */
294 enum
295 {
296     DIALOG_OK_YES,
297     DIALOG_NO,
298     DIALOG_CANCELLED
299 };
300
301 /** Possible status  */
302 enum
303 {
304     ANSWERED_DIALOG,            ///< Got "answer"
305     DESTROYED_DIALOG,           ///< Interface has destroyed it
306 };
307
308 /** Possible actions */
309 enum
310 {
311     INTERACT_NEW,
312     INTERACT_UPDATE,
313     INTERACT_HIDE,
314     INTERACT_DESTROY
315 };
316
317 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
318 #define interaction_Register( t ) (t, VLC_EGENERIC)
319 #define interaction_Unregister( t ) (t, VLC_EGENERIC)
320
321
322 /** @} */
323 /** @} */
324
325 # ifdef __cplusplus
326 }
327 # endif
328 #endif