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 *****************************************************************************/
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 /** Describe all interface-specific data of the interface thread */
52 /* Thread properties and locks */
53 #if defined( __APPLE__ ) || defined( WIN32 )
54 bool b_should_run_on_first_thread;
57 /* Specific interfaces */
58 intf_sys_t * p_sys; /** system interface */
59 char * psz_intf; /** intf name specified */
61 /** Interface module */
63 void ( *pf_run ) ( intf_thread_t * ); /** Run function */
65 /** Specific for dialogs providers */
66 void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
67 intf_dialog_args_t * );
69 vlc_mutex_t change_lock;
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 interaction_dialog_t *p_dialog;
96 /*****************************************************************************
98 *****************************************************************************/
99 #define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
100 VLC_EXPORT( intf_thread_t *, __intf_Create, ( vlc_object_t *, const char * ) );
101 VLC_EXPORT( int, intf_RunThread, ( intf_thread_t * ) );
102 VLC_EXPORT( void, intf_StopThread, ( intf_thread_t * ) );
104 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
105 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
107 VLC_EXPORT( int, interaction_Register, ( intf_thread_t * ) );
108 VLC_EXPORT( int, interaction_Unregister, ( intf_thread_t * ) );
112 /*****************************************************************************
114 *****************************************************************************/
115 #if defined( WIN32 ) && !defined( UNDER_CE )
116 # define CONSOLE_INTRO_MSG \
117 if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
120 freopen( "CONOUT$", "w", stdout ); \
121 freopen( "CONOUT$", "w", stderr ); \
122 freopen( "CONIN$", "r", stdin ); \
124 msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
125 msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
126 "anymore, open a command-line window, go to the " \
127 "directory where you installed VLC and run " \
130 # define CONSOLE_INTRO_MSG
133 /* Interface dialog ids for dialog providers */
134 typedef enum vlc_dialog {
135 INTF_DIALOG_FILE_SIMPLE = 1,
141 INTF_DIALOG_DIRECTORY,
143 INTF_DIALOG_STREAMWIZARD,
146 INTF_DIALOG_PLAYLIST,
147 INTF_DIALOG_MESSAGES,
148 INTF_DIALOG_FILEINFO,
150 INTF_DIALOG_BOOKMARKS,
151 INTF_DIALOG_EXTENDED,
153 INTF_DIALOG_POPUPMENU = 20,
154 INTF_DIALOG_AUDIOPOPUPMENU,
155 INTF_DIALOG_VIDEOPOPUPMENU,
156 INTF_DIALOG_MISCPOPUPMENU,
158 INTF_DIALOG_FILE_GENERIC = 30,
159 INTF_DIALOG_INTERACTION = 50,
161 INTF_DIALOG_UPDATEVLC = 90,
164 INTF_DIALOG_EXIT = 99
167 /* Useful text messages shared by interfaces */
168 #define INTF_ABOUT_MSG LICENSE_MSG
170 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
171 "*.mod;*.mp1;*.mp2;*.mp3;*.oga;*.ogg;*.oma;*.spx;" \
174 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
175 "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
176 "*.mpeg2;*.mpeg4;*.mpg;*.mts;*.mxf;*.nuv;" \
177 "*.ogg;*.ogm;*.ogv;*.ogx;" \
178 "*.ps;*.rm;*.rmvb;*.ts;*.vob;*.wmv"
180 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
182 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
185 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
186 "*.jss;*.psb;*.rt;*.smi"
188 /** \defgroup vlc_interaction Interaction
189 * \ingroup vlc_interface
190 * Interaction between user and modules
195 * This structure describes a piece of interaction with the user
197 struct interaction_dialog_t
199 int i_id; ///< Unique ID
200 int i_type; ///< Type identifier
201 char *psz_title; ///< Title
202 char *psz_description; ///< Descriptor string
203 char *psz_default_button; ///< default button title (~OK)
204 char *psz_alternate_button;///< alternate button title (~NO)
205 /// other button title (optional,~Cancel)
206 char *psz_other_button;
208 char *psz_returned[1]; ///< returned responses from the user
210 vlc_value_t val; ///< value coming from core for dialogue
211 int i_timeToGo; ///< time (in sec) until shown progress is finished
212 bool b_cancelled; ///< was the dialogue cancelled ?
214 void * p_private; ///< Private interface data
216 int i_status; ///< Dialog status;
217 int i_action; ///< Action to perform;
218 int i_flags; ///< Misc flags
219 int i_return; ///< Return status
221 interaction_t *p_interaction; ///< Parent interaction object
222 vlc_object_t *p_parent; ///< The vlc object that asked
227 * Possible flags . Dialog types
229 #define DIALOG_GOT_ANSWER 0x01
230 #define DIALOG_YES_NO_CANCEL 0x02
231 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
232 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
233 #define DIALOG_BLOCKING_ERROR 0x10
234 #define DIALOG_NONBLOCKING_ERROR 0x20
235 #define DIALOG_WARNING 0x40
236 #define DIALOG_USER_PROGRESS 0x80
237 #define DIALOG_INTF_PROGRESS 0x100
239 /** Possible return codes */
248 /** Possible status */
251 NEW_DIALOG, ///< Just created
252 SENT_DIALOG, ///< Sent to interface
253 UPDATED_DIALOG, ///< Update to send
254 ANSWERED_DIALOG, ///< Got "answer"
255 HIDING_DIALOG, ///< Hiding requested
256 HIDDEN_DIALOG, ///< Now hidden. Requesting destruction
257 DESTROYED_DIALOG, ///< Interface has destroyed it
260 /** Possible interaction types */
263 INTERACT_DIALOG_ONEWAY, ///< Dialog box without feedback
264 INTERACT_DIALOG_TWOWAY, ///< Dialog box with feedback
267 /** Possible actions */
276 /***************************************************************************
278 ***************************************************************************/
280 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
281 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) LIBVLC_FORMAT( 4, 5 ) );
282 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
283 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) LIBVLC_FORMAT( 3, 4 ) );
284 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
285 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
286 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
287 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
288 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
289 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
291 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
292 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
293 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
294 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
295 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
296 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
297 VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
298 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
299 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));