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