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 */
57 #if defined( __APPLE__ )
58 bool b_should_run_on_first_thread;
61 /* Specific interfaces */
62 intf_sys_t * p_sys; /** system interface */
64 /** Interface module */
66 void ( *pf_run ) ( struct intf_thread_t * ); /** Run function */
68 /** Specific for dialogs providers */
69 void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
70 intf_dialog_args_t * );
72 config_chain_t *p_cfg;
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.
79 struct intf_dialog_args_t
81 intf_thread_t *p_intf;
87 void (*pf_callback) ( intf_dialog_args_t * );
90 /* Specifically for INTF_DIALOG_FILE_GENERIC */
95 /* Specific to INTF_DIALOG_INTERACTION */
96 struct interaction_dialog_t *p_dialog;
99 VLC_API int intf_Create( vlc_object_t *, const char * );
100 #define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
102 VLC_API void libvlc_Quit( libvlc_int_t * );
105 * \defgroup vlc_subscription Log messages subscription
106 * These functions deal with log messages.
111 * Used by interface plugins which subscribe to the message bank.
113 typedef struct msg_subscription_t msg_subscription_t;
116 * Message logging callback signature.
117 * Accepts one private data pointer, the message, and an overrun counter.
119 typedef void (*msg_callback_t) (void *, int, const msg_item_t *,
120 const char *, va_list);
122 VLC_API msg_subscription_t *vlc_Subscribe(msg_callback_t, void *) VLC_USED;
123 VLC_API void vlc_Unsubscribe(msg_subscription_t *);
127 #if defined( WIN32 ) && !defined( UNDER_CE )
128 # define CONSOLE_INTRO_MSG \
129 if( !getenv( "PWD" ) ) /* detect Cygwin shell or Wine */ \
132 freopen( "CONOUT$", "w", stdout ); \
133 freopen( "CONOUT$", "w", stderr ); \
134 freopen( "CONIN$", "r", stdin ); \
136 msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \
137 msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
138 msg_Info( p_intf, _("\nWarning: if you cannot access the GUI " \
139 "anymore, open a command-line window, go to the " \
140 "directory where you installed VLC and run " \
143 # define CONSOLE_INTRO_MSG (void)0
146 /* Interface dialog ids for dialog providers */
147 typedef enum vlc_dialog {
148 INTF_DIALOG_FILE_SIMPLE = 1,
154 INTF_DIALOG_DIRECTORY,
156 INTF_DIALOG_STREAMWIZARD,
159 INTF_DIALOG_PLAYLIST,
160 INTF_DIALOG_MESSAGES,
161 INTF_DIALOG_FILEINFO,
163 INTF_DIALOG_BOOKMARKS,
164 INTF_DIALOG_EXTENDED,
166 INTF_DIALOG_POPUPMENU = 20,
167 INTF_DIALOG_AUDIOPOPUPMENU,
168 INTF_DIALOG_VIDEOPOPUPMENU,
169 INTF_DIALOG_MISCPOPUPMENU,
171 INTF_DIALOG_FILE_GENERIC = 30,
172 INTF_DIALOG_INTERACTION = 50,
174 INTF_DIALOG_UPDATEVLC = 90,
177 INTF_DIALOG_EXIT = 99
180 /* Useful text messages shared by interfaces */
181 #define INTF_ABOUT_MSG LICENSE_MSG
183 #define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
184 "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3", "mpc", "mpga", \
185 "oga", "ogg", "oma", "qcp", "ra", "rmi", "s3m", "spx", "thd", "tta", \
186 "wav", "wma", "wv", "xm"
188 #define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "drc", "dv", "f4v", "flv", "gvi", "gxf", "iso", \
189 "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
190 "mp2", "mp4", "mpeg", "mpeg1", \
191 "mpeg2", "mpeg4", "mpg", "mts", "mtv", "mxf", "mxg", "nuv", \
192 "ogg", "ogm", "ogv", "ogx", "ps", \
193 "rec", "rm", "rmvb", "ts", "vob", "wm", "wmv"
195 #define EXTENSIONS_AUDIO \
245 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.drc;*.dv;*f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
246 "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
247 "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
248 "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
249 "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wm;*.wmv"
251 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wvx;*.zip;*.conf"
253 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
256 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
257 "*.sub;*.utf;*.ass;" \
260 "*.rt;*.smi;*.txt;" \
261 "*.smil;*.stl;*.usf" \
264 /** \defgroup vlc_interaction Interaction
265 * \ingroup vlc_interface
266 * Interaction between user and modules
271 * This structure describes a piece of interaction with the user
273 typedef struct interaction_dialog_t
275 int i_type; ///< Type identifier
276 char *psz_title; ///< Title
277 char *psz_description; ///< Descriptor string
278 char *psz_default_button; ///< default button title (~OK)
279 char *psz_alternate_button;///< alternate button title (~NO)
280 /// other button title (optional,~Cancel)
281 char *psz_other_button;
283 char *psz_returned[1]; ///< returned responses from the user
285 vlc_value_t val; ///< value coming from core for dialogue
286 int i_timeToGo; ///< time (in sec) until shown progress is finished
287 bool b_cancelled; ///< was the dialogue cancelled ?
289 void * p_private; ///< Private interface data
291 int i_status; ///< Dialog status;
292 int i_action; ///< Action to perform;
293 int i_flags; ///< Misc flags
294 int i_return; ///< Return status
296 vlc_object_t *p_parent; ///< The vlc object that asked
298 intf_thread_t *p_interface;
300 } interaction_dialog_t;
303 * Possible flags . Dialog types
305 #define DIALOG_GOT_ANSWER 0x01
306 #define DIALOG_YES_NO_CANCEL 0x02
307 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
308 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
309 #define DIALOG_BLOCKING_ERROR 0x10
310 #define DIALOG_NONBLOCKING_ERROR 0x20
311 #define DIALOG_USER_PROGRESS 0x80
312 #define DIALOG_INTF_PROGRESS 0x100
314 /** Possible return codes */
322 /** Possible status */
325 ANSWERED_DIALOG, ///< Got "answer"
326 DESTROYED_DIALOG, ///< Interface has destroyed it
329 /** Possible actions */
338 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
339 #define interaction_Register( t ) (t, VLC_EGENERIC)
340 #define interaction_Unregister( t ) (t, VLC_EGENERIC)