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 */
56 /* Specific interfaces */
57 intf_sys_t * p_sys; /** system interface */
59 /** Interface module */
62 /** Specific for dialogs providers */
63 void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
64 intf_dialog_args_t * );
66 config_chain_t *p_cfg;
69 /** \brief Arguments passed to a dialogs provider
70 * This describes the arguments passed to the dialogs provider. They are
71 * mainly used with INTF_DIALOG_FILE_GENERIC.
73 struct intf_dialog_args_t
75 intf_thread_t *p_intf;
81 void (*pf_callback) ( intf_dialog_args_t * );
84 /* Specifically for INTF_DIALOG_FILE_GENERIC */
89 /* Specific to INTF_DIALOG_INTERACTION */
90 struct interaction_dialog_t *p_dialog;
93 VLC_API int intf_Create( playlist_t *, const char * );
95 VLC_API void libvlc_Quit( libvlc_int_t * );
97 static inline playlist_t *pl_Get( struct intf_thread_t *intf )
99 return (playlist_t *)(intf->p_parent);
103 * Retrieves the current input thread from the playlist.
104 * @note The returned object must be released with vlc_object_release().
106 #define pl_CurrentInput(intf) (playlist_CurrentInput(pl_Get(intf)))
109 * \defgroup vlc_subscription Log messages subscription
110 * These functions deal with log messages.
115 * Message logging callback signature.
116 * \param data data pointer as provided to vlc_msg_SetCallback().
117 * \param type message type (VLC_MSG_* values from enum vlc_log_type)
118 * \param item meta information
119 * \param fmt format string
120 * \param args format string arguments
122 typedef void (*vlc_log_cb) (void *data, int type, const vlc_log_t *item,
123 const char *fmt, va_list args);
125 VLC_API void vlc_LogSet(libvlc_int_t *, vlc_log_cb cb, void *data);
129 #if defined( _WIN32 ) && !VLC_WINSTORE_APP
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", "adt", "adts", "aif", "aifc", "aiff", \
186 "amr", "aob", "ape", "awb", "caf", "dts", "flac", "it", "kar", \
187 "m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \
188 "oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "thd", "tta", \
189 "voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"
191 #define EXTENSIONS_VIDEO_CSV "3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "divx", "drc", "dv", \
192 "f4v", "flv", "gvi", "gxf", "iso", \
193 "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
194 "mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \
195 "mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \
196 "ogg", "ogm", "ogv", "ogx", "ps", \
197 "rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \
198 "webm", "wm", "wmv", "wtv", "xesc"
200 #define EXTENSIONS_AUDIO \
256 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.divx;*.drc;*.dv;*f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
257 "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
258 "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
259 "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
260 "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
262 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wax;*.wvx;*.zip;*.conf"
264 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
267 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
268 "*.sub;*.utf;*.ass;" \
271 "*.rt;*.smi;*.txt;" \
272 "*.smil;*.stl;*.usf;" \
273 "*.dks;*.pjs;*.mpl2;*.mks;" \
276 /** \defgroup vlc_interaction Interaction
277 * \ingroup vlc_interface
278 * Interaction between user and modules
283 * This structure describes a piece of interaction with the user
285 typedef struct interaction_dialog_t
287 int i_type; ///< Type identifier
288 char *psz_title; ///< Title
289 char *psz_description; ///< Descriptor string
290 char *psz_default_button; ///< default button title (~OK)
291 char *psz_alternate_button;///< alternate button title (~NO)
292 /// other button title (optional,~Cancel)
293 char *psz_other_button;
295 char *psz_returned[1]; ///< returned responses from the user
297 vlc_value_t val; ///< value coming from core for dialogue
298 int i_timeToGo; ///< time (in sec) until shown progress is finished
299 bool b_cancelled; ///< was the dialogue cancelled ?
301 void * p_private; ///< Private interface data
303 int i_status; ///< Dialog status;
304 int i_action; ///< Action to perform;
305 int i_flags; ///< Misc flags
306 int i_return; ///< Return status
308 vlc_object_t *p_parent; ///< The vlc object that asked
310 intf_thread_t *p_interface;
312 } interaction_dialog_t;
315 * Possible flags . Dialog types
317 #define DIALOG_GOT_ANSWER 0x01
318 #define DIALOG_YES_NO_CANCEL 0x02
319 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
320 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
321 #define DIALOG_BLOCKING_ERROR 0x10
322 #define DIALOG_NONBLOCKING_ERROR 0x20
323 #define DIALOG_USER_PROGRESS 0x80
324 #define DIALOG_INTF_PROGRESS 0x100
326 /** Possible return codes */
334 /** Possible status */
337 ANSWERED_DIALOG, ///< Got "answer"
338 DESTROYED_DIALOG, ///< Interface has destroyed it
341 /** Possible actions */
350 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
351 #define interaction_Register( t ) (t, VLC_EGENERIC)
352 #define interaction_Unregister( t ) (t, VLC_EGENERIC)