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
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
33 typedef struct intf_dialog_args_t intf_dialog_args_t;
37 * This file contains structures and function prototypes for
38 * interface management in vlc
42 * \defgroup vlc_interface Interface
43 * These functions and structures are for interface management
47 typedef struct intf_sys_t intf_sys_t;
49 /** Describe all interface-specific data of the interface thread */
50 typedef struct intf_thread_t
54 struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
55 vlc_thread_t thread; /** LibVLC thread */
56 /* Thread properties and locks */
58 /* Specific interfaces */
59 intf_sys_t * p_sys; /** system interface */
61 /** Interface module */
63 void ( *pf_run ) ( struct intf_thread_t * ); /** Run function */
65 /** Specific for dialogs providers */
66 void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
67 intf_dialog_args_t * );
69 config_chain_t *p_cfg;
72 /** \brief Arguments passed to a dialogs provider
73 * This describes the arguments passed to the dialogs provider. They are
74 * mainly used with INTF_DIALOG_FILE_GENERIC.
76 struct intf_dialog_args_t
78 intf_thread_t *p_intf;
84 void (*pf_callback) ( intf_dialog_args_t * );
87 /* Specifically for INTF_DIALOG_FILE_GENERIC */
92 /* Specific to INTF_DIALOG_INTERACTION */
93 struct interaction_dialog_t *p_dialog;
96 VLC_API int intf_Create( vlc_object_t *, const char * );
97 #define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
99 VLC_API void libvlc_Quit( libvlc_int_t * );
102 * \defgroup vlc_subscription Log messages subscription
103 * These functions deal with log messages.
108 * Message logging callback signature.
109 * Accepts one private data pointer, the message, and an overrun counter.
111 typedef void (*msg_callback_t) (void *, int, const msg_item_t *,
112 const char *, va_list);
115 * Used by interface plugins which subscribe to the message bank.
117 typedef struct msg_subscription
119 struct msg_subscription *prev, *next;
122 } msg_subscription_t;
124 VLC_API void vlc_Subscribe(msg_subscription_t *, msg_callback_t, void *);
125 VLC_API void vlc_Unsubscribe(msg_subscription_t *);
129 #if defined( WIN32 ) && !defined( UNDER_CE )
130 # define CONSOLE_INTRO_MSG \
131 if( !getenv( "PWD" ) ) /* detect Cygwin shell or Wine */ \
134 freopen( "CONOUT$", "w", stdout ); \
135 freopen( "CONOUT$", "w", stderr ); \
136 freopen( "CONIN$", "r", stdin ); \
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 " \
145 # define CONSOLE_INTRO_MSG (void)0
148 /* Interface dialog ids for dialog providers */
149 typedef enum vlc_dialog {
150 INTF_DIALOG_FILE_SIMPLE = 1,
156 INTF_DIALOG_DIRECTORY,
158 INTF_DIALOG_STREAMWIZARD,
161 INTF_DIALOG_PLAYLIST,
162 INTF_DIALOG_MESSAGES,
163 INTF_DIALOG_FILEINFO,
165 INTF_DIALOG_BOOKMARKS,
166 INTF_DIALOG_EXTENDED,
168 INTF_DIALOG_POPUPMENU = 20,
169 INTF_DIALOG_AUDIOPOPUPMENU,
170 INTF_DIALOG_VIDEOPOPUPMENU,
171 INTF_DIALOG_MISCPOPUPMENU,
173 INTF_DIALOG_FILE_GENERIC = 30,
174 INTF_DIALOG_INTERACTION = 50,
176 INTF_DIALOG_UPDATEVLC = 90,
179 INTF_DIALOG_EXIT = 99
182 /* Useful text messages shared by interfaces */
183 #define INTF_ABOUT_MSG LICENSE_MSG
185 #define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
186 "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3", "mpc", "mpga", \
187 "oga", "ogg", "oma", "qcp", "ra", "rmi", "s3m", "spx", "thd", "tta", \
188 "wav", "wma", "wv", "xm"
190 #define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "drc", "dv", "f4v", "flv", "gvi", "gxf", "iso", \
191 "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
192 "mp2", "mp4", "mpeg", "mpeg1", \
193 "mpeg2", "mpeg4", "mpg", "mts", "mtv", "mxf", "mxg", "nuv", \
194 "ogg", "ogm", "ogv", "ogx", "ps", \
195 "rec", "rm", "rmvb", "ts", "vob", "wm", "wmv", "xesc"
197 #define EXTENSIONS_AUDIO \
247 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.drc;*.dv;*f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
248 "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
249 "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
250 "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
251 "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wm;*.wmv;*.xesc"
253 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wvx;*.zip;*.conf"
255 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
258 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
259 "*.sub;*.utf;*.ass;" \
262 "*.rt;*.smi;*.txt;" \
263 "*.smil;*.stl;*.usf" \
266 /** \defgroup vlc_interaction Interaction
267 * \ingroup vlc_interface
268 * Interaction between user and modules
273 * This structure describes a piece of interaction with the user
275 typedef struct interaction_dialog_t
277 int i_type; ///< Type identifier
278 char *psz_title; ///< Title
279 char *psz_description; ///< Descriptor string
280 char *psz_default_button; ///< default button title (~OK)
281 char *psz_alternate_button;///< alternate button title (~NO)
282 /// other button title (optional,~Cancel)
283 char *psz_other_button;
285 char *psz_returned[1]; ///< returned responses from the user
287 vlc_value_t val; ///< value coming from core for dialogue
288 int i_timeToGo; ///< time (in sec) until shown progress is finished
289 bool b_cancelled; ///< was the dialogue cancelled ?
291 void * p_private; ///< Private interface data
293 int i_status; ///< Dialog status;
294 int i_action; ///< Action to perform;
295 int i_flags; ///< Misc flags
296 int i_return; ///< Return status
298 vlc_object_t *p_parent; ///< The vlc object that asked
300 intf_thread_t *p_interface;
302 } interaction_dialog_t;
305 * Possible flags . Dialog types
307 #define DIALOG_GOT_ANSWER 0x01
308 #define DIALOG_YES_NO_CANCEL 0x02
309 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
310 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
311 #define DIALOG_BLOCKING_ERROR 0x10
312 #define DIALOG_NONBLOCKING_ERROR 0x20
313 #define DIALOG_USER_PROGRESS 0x80
314 #define DIALOG_INTF_PROGRESS 0x100
316 /** Possible return codes */
324 /** Possible status */
327 ANSWERED_DIALOG, ///< Got "answer"
328 DESTROYED_DIALOG, ///< Interface has destroyed it
331 /** Possible actions */
340 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
341 #define interaction_Register( t ) (t, VLC_EGENERIC)
342 #define interaction_Unregister( t ) (t, VLC_EGENERIC)