Cleanup interaction-capable interface registration
[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 the VideoLAN team
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
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 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 General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, 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 /** Describe all interface-specific data of the interface thread */
48 struct intf_thread_t
49 {
50     VLC_COMMON_MEMBERS
51
52     /* Thread properties and locks */
53 #if defined( __APPLE__ ) || defined( WIN32 )
54     bool          b_should_run_on_first_thread;
55 #endif
56
57     /* Specific interfaces */
58     intf_console_t *    p_console;                               /** console */
59     intf_sys_t *        p_sys;                          /** system interface */
60     char *              psz_intf;                    /** intf name specified */
61
62     /** Interface module */
63     module_t *   p_module;
64     void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
65
66     /** Specific for dialogs providers */
67     void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
68                                intf_dialog_args_t * );
69
70     vlc_mutex_t  change_lock;
71 };
72
73 /** \brief Arguments passed to a dialogs provider
74  *  This describes the arguments passed to the dialogs provider. They are
75  *  mainly used with INTF_DIALOG_FILE_GENERIC.
76  */
77 struct intf_dialog_args_t
78 {
79     intf_thread_t *p_intf;
80     char *psz_title;
81
82     char **psz_results;
83     int  i_results;
84
85     void (*pf_callback) ( intf_dialog_args_t * );
86     void *p_arg;
87
88     /* Specifically for INTF_DIALOG_FILE_GENERIC */
89     char *psz_extensions;
90     bool b_save;
91     bool b_multiple;
92
93     /* Specific to INTF_DIALOG_INTERACTION */
94     interaction_dialog_t *p_dialog;
95 };
96
97 /*****************************************************************************
98  * Prototypes
99  *****************************************************************************/
100 #define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
101 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
102 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
103 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
104
105 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
106 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
107
108 VLC_EXPORT( int, interaction_Register, ( intf_thread_t * ) );
109 VLC_EXPORT( int, interaction_Unregister, ( intf_thread_t * ) );
110
111 /*@}*/
112
113 /*****************************************************************************
114  * Macros
115  *****************************************************************************/
116 #if defined( WIN32 ) && !defined( UNDER_CE )
117 #    define CONSOLE_INTRO_MSG \
118          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
119          { \
120          AllocConsole(); \
121          freopen( "CONOUT$", "w", stdout ); \
122          freopen( "CONOUT$", "w", stderr ); \
123          freopen( "CONIN$", "r", stdin ); \
124          } \
125          msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
126          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
127                              "anymore, open a command-line window, go to the " \
128                              "directory where you installed VLC and run " \
129                              "\"vlc -I qt\"\n") )
130 #else
131 #    define CONSOLE_INTRO_MSG
132 #endif
133
134 /* Interface dialog ids for dialog providers */
135 typedef enum vlc_dialog {
136     INTF_DIALOG_FILE_SIMPLE = 1,
137     INTF_DIALOG_FILE,
138     INTF_DIALOG_DISC,
139     INTF_DIALOG_NET,
140     INTF_DIALOG_CAPTURE,
141     INTF_DIALOG_SAT,
142     INTF_DIALOG_DIRECTORY,
143
144     INTF_DIALOG_STREAMWIZARD,
145     INTF_DIALOG_WIZARD,
146
147     INTF_DIALOG_PLAYLIST,
148     INTF_DIALOG_MESSAGES,
149     INTF_DIALOG_FILEINFO,
150     INTF_DIALOG_PREFS,
151     INTF_DIALOG_BOOKMARKS,
152     INTF_DIALOG_EXTENDED,
153
154     INTF_DIALOG_POPUPMENU = 20,
155     INTF_DIALOG_AUDIOPOPUPMENU,
156     INTF_DIALOG_VIDEOPOPUPMENU,
157     INTF_DIALOG_MISCPOPUPMENU,
158
159     INTF_DIALOG_FILE_GENERIC = 30,
160     INTF_DIALOG_INTERACTION = 50,
161
162     INTF_DIALOG_UPDATEVLC = 90,
163     INTF_DIALOG_VLM,
164
165     INTF_DIALOG_EXIT = 99
166 } vlc_dialog_t;
167
168 /* Useful text messages shared by interfaces */
169 #define INTF_ABOUT_MSG LICENSE_MSG
170
171 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
172                          "*.mod;*.mp1;*.mp2;*.mp3;*.oga;*.ogg;*.oma;*.spx;" \
173                          "*.wav;*.wma;*.xm"
174
175 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
176                          "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
177                          "*.mpeg2;*.mpeg4;*.mpg;*.mts;*.mxf;*.nuv;" \
178                          "*.ogg;*.ogm;*.ogv;*.ogx;" \
179                          "*.ps;*.rm;*.rmvb;*.ts;*.vob;*.wmv"
180
181 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
182
183 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
184                           EXTENSIONS_PLAYLIST
185
186 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
187                             "*.jss;*.psb;*.rt;*.smi"
188
189 /** \defgroup vlc_interaction Interaction
190  * \ingroup vlc_interface
191  * Interaction between user and modules
192  * @{
193  */
194
195 /**
196  * This structure describes a piece of interaction with the user
197  */
198 struct interaction_dialog_t
199 {
200     int             i_id;               ///< Unique ID
201     int             i_type;             ///< Type identifier
202     char           *psz_title;          ///< Title
203     char           *psz_description;    ///< Descriptor string
204     char           *psz_default_button;  ///< default button title (~OK)
205     char           *psz_alternate_button;///< alternate button title (~NO)
206     /// other button title (optional,~Cancel)
207     char           *psz_other_button;
208
209     char           *psz_returned[1];    ///< returned responses from the user
210
211     vlc_value_t     val;                ///< value coming from core for dialogue
212     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
213     bool      b_cancelled;        ///< was the dialogue cancelled ?
214
215     void *          p_private;          ///< Private interface data
216
217     int             i_status;           ///< Dialog status;
218     int             i_action;           ///< Action to perform;
219     int             i_flags;            ///< Misc flags
220     int             i_return;           ///< Return status
221
222     interaction_t  *p_interaction;      ///< Parent interaction object
223     vlc_object_t   *p_parent;           ///< The vlc object that asked
224                                         //for interaction
225 };
226
227 /**
228  * Possible flags . Dialog types
229  */
230 #define DIALOG_GOT_ANSWER           0x01
231 #define DIALOG_YES_NO_CANCEL        0x02
232 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
233 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
234 #define DIALOG_BLOCKING_ERROR       0x10
235 #define DIALOG_NONBLOCKING_ERROR    0x20
236 #define DIALOG_WARNING              0x40
237 #define DIALOG_USER_PROGRESS        0x80
238 #define DIALOG_INTF_PROGRESS        0x100
239
240 /** Possible return codes */
241 enum
242 {
243     DIALOG_DEFAULT,
244     DIALOG_OK_YES,
245     DIALOG_NO,
246     DIALOG_CANCELLED
247 };
248
249 /** Possible status  */
250 enum
251 {
252     NEW_DIALOG,                 ///< Just created
253     SENT_DIALOG,                ///< Sent to interface
254     UPDATED_DIALOG,             ///< Update to send
255     ANSWERED_DIALOG,            ///< Got "answer"
256     HIDING_DIALOG,              ///< Hiding requested
257     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
258     DESTROYED_DIALOG,           ///< Interface has destroyed it
259 };
260
261 /** Possible interaction types */
262 enum
263 {
264     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
265     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
266 };
267
268 /** Possible actions */
269 enum
270 {
271     INTERACT_NEW,
272     INTERACT_UPDATE,
273     INTERACT_HIDE,
274     INTERACT_DESTROY
275 };
276
277 /**
278  * This structure contains the active interaction dialogs, and is
279  * used by the manager
280  */
281 struct interaction_t
282 {
283     VLC_COMMON_MEMBERS
284
285     int                         i_dialogs;      ///< Number of dialogs
286     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
287     intf_thread_t              *p_intf;         ///< Interface to use
288     int                         i_last_id;      ///< Last attributed ID
289 };
290
291 /***************************************************************************
292  * Exported symbols
293  ***************************************************************************/
294
295 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
296 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) LIBVLC_FORMAT( 4, 5 ) );
297 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
298 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) LIBVLC_FORMAT( 3, 4 ) );
299 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
300 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
301 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
302 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
303 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
304 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
305
306 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
307 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
308 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
309 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
310 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
311 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
312 VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
313 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
314 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
315
316 /** @} */
317 /** @} */
318
319 # ifdef __cplusplus
320 }
321 # endif
322 #endif