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 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 /* Thread properties and locks */
56 #if defined( __APPLE__ )
57 bool b_should_run_on_first_thread;
60 /* Specific interfaces */
61 intf_sys_t * p_sys; /** system interface */
62 char * psz_intf; /** intf name specified */
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 /*****************************************************************************
101 *****************************************************************************/
102 VLC_EXPORT( int, intf_Create, ( vlc_object_t *, const char * ) );
103 #define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
105 VLC_EXPORT( int, intf_Eject, ( vlc_object_t *, const char * ) );
106 #define intf_Eject(a,b) intf_Eject(VLC_OBJECT(a),b)
108 VLC_EXPORT( void, libvlc_Quit, ( libvlc_int_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, "VLC media player - %s", VERSION_MESSAGE ); \
125 msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
126 msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
127 "anymore, open a command-line window, go to the " \
128 "directory where you installed VLC and run " \
131 # define CONSOLE_INTRO_MSG
134 /* Interface dialog ids for dialog providers */
135 typedef enum vlc_dialog {
136 INTF_DIALOG_FILE_SIMPLE = 1,
142 INTF_DIALOG_DIRECTORY,
144 INTF_DIALOG_STREAMWIZARD,
147 INTF_DIALOG_PLAYLIST,
148 INTF_DIALOG_MESSAGES,
149 INTF_DIALOG_FILEINFO,
151 INTF_DIALOG_BOOKMARKS,
152 INTF_DIALOG_EXTENDED,
154 INTF_DIALOG_POPUPMENU = 20,
155 INTF_DIALOG_AUDIOPOPUPMENU,
156 INTF_DIALOG_VIDEOPOPUPMENU,
157 INTF_DIALOG_MISCPOPUPMENU,
159 INTF_DIALOG_FILE_GENERIC = 30,
160 INTF_DIALOG_INTERACTION = 50,
162 INTF_DIALOG_UPDATEVLC = 90,
165 INTF_DIALOG_EXIT = 99
168 /* Useful text messages shared by interfaces */
169 #define INTF_ABOUT_MSG LICENSE_MSG
171 #define EXTENSIONS_AUDIO_CSV "a52", "aac", "ac3", "ape", "dts", "flac", "it", \
172 "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3",\
173 "oga", "ogg", "oma", "s3m", "spx" \
174 "wav", "wma", "wv", "xm"
176 #define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "dv", "flv", "gxf", "iso", \
177 "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
178 "mp2", "mp4", "mpeg", "mpeg1", \
179 "mpeg2", "mpeg4", "mpg", "mts", "mxf", "nuv", \
180 "ogg", "ogm", "ogv", "ogx", "ps", \
181 "rec", "rm", "rmvb", "ts", "vob", "wmv"
183 #define EXTENSIONS_AUDIO \
225 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.cue;*.divx;*.dv;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
226 "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
227 "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mxf;*.nsv;*.nuv;" \
228 "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
229 "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wmv"
231 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.zip"
233 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
236 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
237 "*.jss;*.psb;*.rt;*.smi"
239 /** \defgroup vlc_interaction Interaction
240 * \ingroup vlc_interface
241 * Interaction between user and modules
246 * This structure describes a piece of interaction with the user
248 typedef struct interaction_dialog_t
250 int i_type; ///< Type identifier
251 char *psz_title; ///< Title
252 char *psz_description; ///< Descriptor string
253 char *psz_default_button; ///< default button title (~OK)
254 char *psz_alternate_button;///< alternate button title (~NO)
255 /// other button title (optional,~Cancel)
256 char *psz_other_button;
258 char *psz_returned[1]; ///< returned responses from the user
260 vlc_value_t val; ///< value coming from core for dialogue
261 int i_timeToGo; ///< time (in sec) until shown progress is finished
262 bool b_cancelled; ///< was the dialogue cancelled ?
264 void * p_private; ///< Private interface data
266 int i_status; ///< Dialog status;
267 int i_action; ///< Action to perform;
268 int i_flags; ///< Misc flags
269 int i_return; ///< Return status
271 vlc_object_t *p_parent; ///< The vlc object that asked
273 intf_thread_t *p_interface;
275 } interaction_dialog_t;
278 * Possible flags . Dialog types
280 #define DIALOG_GOT_ANSWER 0x01
281 #define DIALOG_YES_NO_CANCEL 0x02
282 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
283 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
284 #define DIALOG_BLOCKING_ERROR 0x10
285 #define DIALOG_NONBLOCKING_ERROR 0x20
286 #define DIALOG_USER_PROGRESS 0x80
287 #define DIALOG_INTF_PROGRESS 0x100
289 /** Possible return codes */
297 /** Possible status */
300 ANSWERED_DIALOG, ///< Got "answer"
301 DESTROYED_DIALOG, ///< Interface has destroyed it
304 /** Possible actions */
313 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
314 #define interaction_Register( t ) (t, VLC_EGENERIC)
315 #define interaction_Unregister( t ) (t, VLC_EGENERIC)