Add .evo files to open dialogs
[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
56     /* Specific interfaces */
57     intf_sys_t *        p_sys;                          /** system interface */
58
59     /** Interface module */
60     module_t *   p_module;
61
62     /** Specific for dialogs providers */
63     void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
64                                intf_dialog_args_t * );
65
66     config_chain_t *p_cfg;
67 } intf_thread_t;
68
69 /** \brief Arguments passed to a dialogs provider
70  *  This describes the arguments passed to the dialogs provider. They are
71  *  mainly used with INTF_DIALOG_FILE_GENERIC.
72  */
73 struct intf_dialog_args_t
74 {
75     intf_thread_t *p_intf;
76     char *psz_title;
77
78     char **psz_results;
79     int  i_results;
80
81     void (*pf_callback) ( intf_dialog_args_t * );
82     void *p_arg;
83
84     /* Specifically for INTF_DIALOG_FILE_GENERIC */
85     char *psz_extensions;
86     bool b_save;
87     bool b_multiple;
88
89     /* Specific to INTF_DIALOG_INTERACTION */
90     struct interaction_dialog_t *p_dialog;
91 };
92
93 VLC_API int intf_Create( playlist_t *, const char * );
94
95 VLC_API void libvlc_Quit( libvlc_int_t * );
96
97 static inline playlist_t *pl_Get( struct intf_thread_t *intf )
98 {
99     return (playlist_t *)(intf->p_parent);
100 }
101
102 /**
103  * Retrieves the current input thread from the playlist.
104  * @note The returned object must be released with vlc_object_release().
105  */
106 #define pl_CurrentInput(intf) (playlist_CurrentInput(pl_Get(intf)))
107
108 /**
109  * \defgroup vlc_subscription Log messages subscription
110  * These functions deal with log messages.
111  * @{
112  */
113
114 /**
115  * Message logging callback signature.
116  * \param data data pointer as provided to vlc_msg_SetCallback().
117  * \param type message type (VLC_MSG_* values from enum vlc_log_type)
118  * \param item meta information
119  * \param fmt format string
120  * \param args format string arguments
121  */
122 typedef void (*vlc_log_cb) (void *data, int type, const vlc_log_t *item,
123                             const char *fmt, va_list args);
124
125 VLC_API void vlc_LogSet(libvlc_int_t *, vlc_log_cb cb, void *data);
126
127 /*@}*/
128
129 #if defined( _WIN32 ) && !VLC_WINSTORE_APP
130 #    define CONSOLE_INTRO_MSG \
131          if( !getenv( "PWD" ) ) /* detect Cygwin shell or Wine */ \
132          { \
133          AllocConsole(); \
134          freopen( "CONOUT$", "w", stdout ); \
135          freopen( "CONOUT$", "w", stderr ); \
136          freopen( "CONIN$", "r", stdin ); \
137          } \
138          msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \
139          msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
140          msg_Info( p_intf, _("\nWarning: if you cannot access the GUI " \
141                              "anymore, open a command-line window, go to the " \
142                              "directory where you installed VLC and run " \
143                              "\"vlc -I qt\"\n") )
144 #else
145 #    define CONSOLE_INTRO_MSG (void)0
146 #endif
147
148 /* Interface dialog ids for dialog providers */
149 typedef enum vlc_dialog {
150     INTF_DIALOG_FILE_SIMPLE = 1,
151     INTF_DIALOG_FILE,
152     INTF_DIALOG_DISC,
153     INTF_DIALOG_NET,
154     INTF_DIALOG_CAPTURE,
155     INTF_DIALOG_SAT,
156     INTF_DIALOG_DIRECTORY,
157
158     INTF_DIALOG_STREAMWIZARD,
159     INTF_DIALOG_WIZARD,
160
161     INTF_DIALOG_PLAYLIST,
162     INTF_DIALOG_MESSAGES,
163     INTF_DIALOG_FILEINFO,
164     INTF_DIALOG_PREFS,
165     INTF_DIALOG_BOOKMARKS,
166     INTF_DIALOG_EXTENDED,
167
168     INTF_DIALOG_POPUPMENU = 20,
169     INTF_DIALOG_AUDIOPOPUPMENU,
170     INTF_DIALOG_VIDEOPOPUPMENU,
171     INTF_DIALOG_MISCPOPUPMENU,
172
173     INTF_DIALOG_FILE_GENERIC = 30,
174     INTF_DIALOG_INTERACTION = 50,
175     INTF_DIALOG_SENDKEY = 51,
176
177     INTF_DIALOG_UPDATEVLC = 90,
178     INTF_DIALOG_VLM,
179
180     INTF_DIALOG_EXIT = 99
181 } vlc_dialog_t;
182
183 /* Useful text messages shared by interfaces */
184 #define INTF_ABOUT_MSG LICENSE_MSG
185
186 #define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \
187                          "amr", "aob", "ape", "awb", "caf", "dts", "flac", "it", "kar", \
188                          "m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \
189                          "oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "thd", "tta", \
190                          "voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"
191
192 #define EXTENSIONS_VIDEO_CSV "3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "divx", "drc", "dv", \
193                              "evo", "f4v", "flv", "gvi", "gxf", "iso", \
194                              "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
195                              "mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \
196                              "mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \
197                              "ogg", "ogm", "ogv", "ogx", "ps", \
198                              "rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \
199                              "webm", "wm", "wmv", "wtv", "xesc"
200
201 #define EXTENSIONS_AUDIO \
202     "*.3ga;" \
203     "*.669;" \
204     "*.a52;" \
205     "*.aac;" \
206     "*.ac3;" \
207     "*.adt;" \
208     "*.adts;" \
209     "*.aif;"\
210     "*.aifc;"\
211     "*.aiff;"\
212     "*.amr;" \
213     "*.aob;" \
214     "*.ape;" \
215     "*.awb;" \
216     "*.caf;" \
217     "*.dts;" \
218     "*.flac;"\
219     "*.it;"  \
220     "*.kar;" \
221     "*.m4a;" \
222     "*.m4b;" \
223     "*.m4p;" \
224     "*.m5p;" \
225     "*.mid;" \
226     "*.mka;" \
227     "*.mlp;" \
228     "*.mod;" \
229     "*.mpa;" \
230     "*.mp1;" \
231     "*.mp2;" \
232     "*.mp3;" \
233     "*.mpc;" \
234     "*.mpga;" \
235     "*.mus;" \
236     "*.oga;" \
237     "*.ogg;" \
238     "*.oma;" \
239     "*.opus;" \
240     "*.qcp;" \
241     "*.ra;" \
242     "*.rmi;" \
243     "*.s3m;" \
244     "*.sid;" \
245     "*.spx;" \
246     "*.thd;" \
247     "*.tta;" \
248     "*.voc;" \
249     "*.vqf;" \
250     "*.w64;" \
251     "*.wav;" \
252     "*.wma;" \
253     "*.wv;"  \
254     "*.xa;"  \
255     "*.xm"
256
257 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.divx;*.drc;*.dv;*.evo;*.f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
258                          "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
259                          "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
260                          "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
261                          "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
262
263 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wax;*.wvx;*.zip;*.conf"
264
265 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
266                           EXTENSIONS_PLAYLIST
267
268 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
269                             "*.sub;*.utf;*.ass;" \
270                             "*.ssa;*.aqt;" \
271                             "*.jss;*.psb;" \
272                             "*.rt;*.smi;*.txt;" \
273                             "*.smil;*.stl;*.usf;" \
274                             "*.dks;*.pjs;*.mpl2;*.mks;" \
275                             "*.vtt"
276
277 /** \defgroup vlc_interaction Interaction
278  * \ingroup vlc_interface
279  * Interaction between user and modules
280  * @{
281  */
282
283 /**
284  * This structure describes a piece of interaction with the user
285  */
286 typedef struct interaction_dialog_t
287 {
288     int             i_type;             ///< Type identifier
289     char           *psz_title;          ///< Title
290     char           *psz_description;    ///< Descriptor string
291     char           *psz_default_button;  ///< default button title (~OK)
292     char           *psz_alternate_button;///< alternate button title (~NO)
293     /// other button title (optional,~Cancel)
294     char           *psz_other_button;
295
296     char           *psz_returned[1];    ///< returned responses from the user
297
298     vlc_value_t     val;                ///< value coming from core for dialogue
299     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
300     bool      b_cancelled;        ///< was the dialogue cancelled ?
301
302     void *          p_private;          ///< Private interface data
303
304     int             i_status;           ///< Dialog status;
305     int             i_action;           ///< Action to perform;
306     int             i_flags;            ///< Misc flags
307     int             i_return;           ///< Return status
308
309     vlc_object_t   *p_parent;           ///< The vlc object that asked
310                                         //for interaction
311     intf_thread_t  *p_interface;
312     vlc_mutex_t    *p_lock;
313 } interaction_dialog_t;
314
315 /**
316  * Possible flags . Dialog types
317  */
318 #define DIALOG_GOT_ANSWER           0x01
319 #define DIALOG_YES_NO_CANCEL        0x02
320 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
321 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
322 #define DIALOG_BLOCKING_ERROR       0x10
323 #define DIALOG_NONBLOCKING_ERROR    0x20
324 #define DIALOG_USER_PROGRESS        0x80
325 #define DIALOG_INTF_PROGRESS        0x100
326
327 /** Possible return codes */
328 enum
329 {
330     DIALOG_OK_YES,
331     DIALOG_NO,
332     DIALOG_CANCELLED
333 };
334
335 /** Possible status  */
336 enum
337 {
338     ANSWERED_DIALOG,            ///< Got "answer"
339     DESTROYED_DIALOG,           ///< Interface has destroyed it
340 };
341
342 /** Possible actions */
343 enum
344 {
345     INTERACT_NEW,
346     INTERACT_UPDATE,
347     INTERACT_HIDE,
348     INTERACT_DESTROY
349 };
350
351 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
352 #define interaction_Register( t ) (t, VLC_EGENERIC)
353 #define interaction_Unregister( t ) (t, VLC_EGENERIC)
354
355
356 /** @} */
357 /** @} */
358
359 # ifdef __cplusplus
360 }
361 # endif
362 #endif