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
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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 *****************************************************************************/
26 #if !defined( __LIBVLC__ )
27 #error You are not libvlc or one of its plugins. You cannot include this file
37 typedef struct intf_dialog_args_t intf_dialog_args_t;
41 * This file contains structures and function prototypes for
42 * interface management in vlc
46 * \defgroup vlc_interface Interface
47 * These functions and structures are for interface management
51 /** Describe all interface-specific data of the interface thread */
56 /* Thread properties and locks */
58 bool b_should_run_on_first_thread;
60 /* Specific interfaces */
61 intf_console_t * p_console; /** console */
62 intf_sys_t * p_sys; /** system interface */
63 char * psz_intf; /** intf name specified */
65 /** Interface module */
67 void ( *pf_run ) ( intf_thread_t * ); /** Run function */
69 /** Specific for dialogs providers */
70 void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
71 intf_dialog_args_t * );
73 /** Interaction stuff */
76 /** Video window callbacks */
77 void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *,
79 unsigned int *, unsigned int * );
80 void ( *pf_release_window ) ( intf_thread_t *, void * );
81 int ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list );
83 /* XXX: new message passing stuff will go here */
84 vlc_mutex_t change_lock;
88 /* Provides the ability to switch an interface on the fly */
89 char *psz_switch_intf;
92 /** \brief Arguments passed to a dialogs provider
93 * This describes the arguments passed to the dialogs provider. They are
94 * mainly used with INTF_DIALOG_FILE_GENERIC.
96 struct intf_dialog_args_t
98 intf_thread_t *p_intf;
104 void (*pf_callback) ( intf_dialog_args_t * );
107 /* Specifically for INTF_DIALOG_FILE_GENERIC */
108 char *psz_extensions;
112 /* Specific to INTF_DIALOG_INTERACTION */
113 interaction_dialog_t *p_dialog;
116 /*****************************************************************************
118 *****************************************************************************/
119 #define intf_Create(a,b,c,d) __intf_Create(VLC_OBJECT(a),b,c,d)
120 VLC_EXPORT( intf_thread_t *, __intf_Create, ( vlc_object_t *, const char *, int, const char *const * ) );
121 VLC_EXPORT( int, intf_RunThread, ( intf_thread_t * ) );
122 VLC_EXPORT( void, intf_StopThread, ( intf_thread_t * ) );
123 VLC_EXPORT( void, intf_Destroy, ( intf_thread_t * ) );
125 /* If the interface is in the main thread, it should listen both to
126 * p_intf->b_die and p_libvlc->b_die */
127 #define intf_ShouldDie( p_intf ) (p_intf->b_die || p_intf->p_libvlc->b_die )
129 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
130 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
134 /*****************************************************************************
136 *****************************************************************************/
137 #if defined( WIN32 ) && !defined( UNDER_CE )
138 # define CONSOLE_INTRO_MSG \
139 if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
142 freopen( "CONOUT$", "w", stdout ); \
143 freopen( "CONOUT$", "w", stderr ); \
144 freopen( "CONIN$", "r", stdin ); \
146 msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
147 msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
148 "anymore, open a command-line window, go to the " \
149 "directory where you installed VLC and run " \
152 # define CONSOLE_INTRO_MSG
155 /* Interface dialog ids for dialog providers */
156 typedef enum vlc_dialog {
157 INTF_DIALOG_FILE_SIMPLE = 1,
163 INTF_DIALOG_DIRECTORY,
165 INTF_DIALOG_STREAMWIZARD,
168 INTF_DIALOG_PLAYLIST,
169 INTF_DIALOG_MESSAGES,
170 INTF_DIALOG_FILEINFO,
172 INTF_DIALOG_BOOKMARKS,
173 INTF_DIALOG_EXTENDED,
175 INTF_DIALOG_POPUPMENU = 20,
176 INTF_DIALOG_AUDIOPOPUPMENU,
177 INTF_DIALOG_VIDEOPOPUPMENU,
178 INTF_DIALOG_MISCPOPUPMENU,
180 INTF_DIALOG_FILE_GENERIC = 30,
181 INTF_DIALOG_INTERACTION = 50,
183 INTF_DIALOG_UPDATEVLC = 90,
186 INTF_DIALOG_EXIT = 99
189 /* Useful text messages shared by interfaces */
190 #define INTF_ABOUT_MSG LICENSE_MSG
192 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
193 "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.spx;*.wav;*.wma;*.xm"
195 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
196 "*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
197 "*.mpeg2;*.mpeg4;*.mpg;*.mxf;*.ogg;*.ogm;" \
198 "*.ps;*.ts;*.vob;*.wmv"
200 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
202 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
205 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
208 /** \defgroup vlc_interaction Interaction
209 * \ingroup vlc_interface
210 * Interaction between user and modules
215 * This structure describes a piece of interaction with the user
217 struct interaction_dialog_t
219 int i_id; ///< Unique ID
220 int i_type; ///< Type identifier
221 char *psz_title; ///< Title
222 char *psz_description; ///< Descriptor string
223 char *psz_default_button; ///< default button title (~OK)
224 char *psz_alternate_button;///< alternate button title (~NO)
225 /// other button title (optional,~Cancel)
226 char *psz_other_button;
228 char *psz_returned[1]; ///< returned responses from the user
230 vlc_value_t val; ///< value coming from core for dialogue
231 int i_timeToGo; ///< time (in sec) until shown progress is finished
232 bool b_cancelled; ///< was the dialogue cancelled ?
234 void * p_private; ///< Private interface data
236 int i_status; ///< Dialog status;
237 int i_action; ///< Action to perform;
238 int i_flags; ///< Misc flags
239 int i_return; ///< Return status
241 interaction_t *p_interaction; ///< Parent interaction object
242 vlc_object_t *p_parent; ///< The vlc object that asked
247 * Possible flags . Dialog types
249 #define DIALOG_GOT_ANSWER 0x01
250 #define DIALOG_YES_NO_CANCEL 0x02
251 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
252 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
253 #define DIALOG_BLOCKING_ERROR 0x10
254 #define DIALOG_NONBLOCKING_ERROR 0x20
255 #define DIALOG_WARNING 0x40
256 #define DIALOG_USER_PROGRESS 0x80
257 #define DIALOG_INTF_PROGRESS 0x100
259 /** Possible return codes */
268 /** Possible status */
271 NEW_DIALOG, ///< Just created
272 SENT_DIALOG, ///< Sent to interface
273 UPDATED_DIALOG, ///< Update to send
274 ANSWERED_DIALOG, ///< Got "answer"
275 HIDING_DIALOG, ///< Hiding requested
276 HIDDEN_DIALOG, ///< Now hidden. Requesting destruction
277 DESTROYED_DIALOG, ///< Interface has destroyed it
280 /** Possible interaction types */
283 INTERACT_DIALOG_ONEWAY, ///< Dialog box without feedback
284 INTERACT_DIALOG_TWOWAY, ///< Dialog box with feedback
287 /** Possible actions */
297 * This structure contains the active interaction dialogs, and is
298 * used by the manager
304 int i_dialogs; ///< Number of dialogs
305 interaction_dialog_t **pp_dialogs; ///< Dialogs
306 intf_thread_t *p_intf; ///< Interface to use
307 int i_last_id; ///< Last attributed ID
310 /***************************************************************************
312 ***************************************************************************/
314 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
315 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) ATTRIBUTE_FORMAT( 4, 5 ) );
316 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
317 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) ATTRIBUTE_FORMAT( 3, 4 ) );
318 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
319 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
320 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
321 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
322 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
323 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
325 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
326 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
327 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
328 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
329 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
330 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
331 VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
332 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
333 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));