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
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
32 typedef struct vlc_playlist vlc_playlist_t
;
33 typedef struct intf_dialog_args_t intf_dialog_args_t
;
36 * \defgroup interface Interface
41 * VLC user interface modules
44 typedef struct intf_sys_t intf_sys_t
;
46 /** Describe all interface-specific data of the interface thread */
47 typedef struct intf_thread_t
49 struct vlc_common_members obj
;
51 struct intf_thread_t
*p_next
; /** LibVLC interfaces book keeping */
53 /* Specific interfaces */
54 intf_sys_t
* p_sys
; /** system interface */
56 /** Interface module */
59 /** Specific for dialogs providers */
60 void ( *pf_show_dialog
) ( struct intf_thread_t
*, int, int,
61 intf_dialog_args_t
* );
63 config_chain_t
*p_cfg
;
66 /** \brief Arguments passed to a dialogs provider
67 * This describes the arguments passed to the dialogs provider. They are
68 * mainly used with INTF_DIALOG_FILE_GENERIC.
70 struct intf_dialog_args_t
72 intf_thread_t
*p_intf
;
78 void (*pf_callback
) ( intf_dialog_args_t
* );
81 /* Specifically for INTF_DIALOG_FILE_GENERIC */
86 /* Specific to INTF_DIALOG_INTERACTION */
87 struct interaction_dialog_t
*p_dialog
;
90 VLC_API
int intf_Create( playlist_t
*, const char * );
92 VLC_API
void libvlc_Quit( libvlc_int_t
* );
94 static inline playlist_t
*pl_Get( struct intf_thread_t
*intf
)
96 return (playlist_t
*)(intf
->obj
.parent
);
99 VLC_API vlc_playlist_t
*
100 vlc_intf_GetMainPlaylist(intf_thread_t
*intf
);
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)))
113 VLC_API
void vlc_LogSet(libvlc_int_t
*, const struct vlc_logger_operations
*,
118 /* Interface dialog ids for dialog providers */
119 typedef enum vlc_intf_dialog
{
120 INTF_DIALOG_FILE_SIMPLE
= 1,
126 INTF_DIALOG_DIRECTORY
,
128 INTF_DIALOG_STREAMWIZARD
,
131 INTF_DIALOG_PLAYLIST
,
132 INTF_DIALOG_MESSAGES
,
133 INTF_DIALOG_FILEINFO
,
135 INTF_DIALOG_BOOKMARKS
,
136 INTF_DIALOG_EXTENDED
,
137 INTF_DIALOG_RENDERER
,
139 INTF_DIALOG_POPUPMENU
= 20,
140 INTF_DIALOG_AUDIOPOPUPMENU
,
141 INTF_DIALOG_VIDEOPOPUPMENU
,
142 INTF_DIALOG_MISCPOPUPMENU
,
144 INTF_DIALOG_FILE_GENERIC
= 30,
145 INTF_DIALOG_INTERACTION
= 50,
146 INTF_DIALOG_SENDKEY
= 51,
148 INTF_DIALOG_UPDATEVLC
= 90,
151 INTF_DIALOG_EXIT
= 99
154 /* Useful text messages shared by interfaces */
155 #define INTF_ABOUT_MSG LICENSE_MSG
157 #define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \
158 "amb", "amr", "aob", "ape", "au", "awb", "caf", "dts", "dsf", "dff", "flac", "it", "kar", \
159 "m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \
160 "oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "tak", "thd", "tta", \
161 "voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"
163 #define EXTENSIONS_VIDEO_CSV "3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "crf", "divx", "drc", "dv", "dvr-ms" \
164 "evo", "f4v", "flv", "gvi", "gxf", "iso", \
165 "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
166 "mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \
167 "mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \
168 "ogg", "ogm", "ogv", "ogx", "ps", \
169 "rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \
170 "webm", "wm", "wmv", "wtv", "xesc"
172 #define EXTENSIONS_AUDIO \
233 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.crf;*.divx;*.drc;*.dv;*.dvr-ms;*.evo;*.f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
234 "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
235 "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
236 "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
237 "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.tp;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
239 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wax;*.wvx;*.zip;*.conf"
241 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
244 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
245 "*.sub;*.utf;*.ass;" \
248 "*.rt;*.sami;*.smi;*.txt;" \
249 "*.smil;*.stl;*.usf;" \
250 "*.dks;*.pjs;*.mpl2;*.mks;" \
251 "*.vtt;*.tt;*.ttml;*.dfxp;" \
254 /** \defgroup interaction Interaction
256 * Interaction between user and modules
261 * This structure describes a piece of interaction with the user
263 typedef struct interaction_dialog_t
265 int i_type
; ///< Type identifier
266 char *psz_title
; ///< Title
267 char *psz_description
; ///< Descriptor string
268 char *psz_default_button
; ///< default button title (~OK)
269 char *psz_alternate_button
;///< alternate button title (~NO)
270 /// other button title (optional,~Cancel)
271 char *psz_other_button
;
273 char *psz_returned
[1]; ///< returned responses from the user
275 vlc_value_t val
; ///< value coming from core for dialogue
276 int i_timeToGo
; ///< time (in sec) until shown progress is finished
277 bool b_cancelled
; ///< was the dialogue cancelled ?
279 void * p_private
; ///< Private interface data
281 int i_status
; ///< Dialog status;
282 int i_action
; ///< Action to perform;
283 int i_flags
; ///< Misc flags
284 int i_return
; ///< Return status
286 vlc_object_t
*p_parent
; ///< The vlc object that asked
288 intf_thread_t
*p_interface
;
290 } interaction_dialog_t
;
293 * Possible flags . Dialog types
295 #define DIALOG_GOT_ANSWER 0x01
296 #define DIALOG_YES_NO_CANCEL 0x02
297 #define DIALOG_LOGIN_PW_OK_CANCEL 0x04
298 #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08
299 #define DIALOG_BLOCKING_ERROR 0x10
300 #define DIALOG_NONBLOCKING_ERROR 0x20
301 #define DIALOG_USER_PROGRESS 0x80
302 #define DIALOG_INTF_PROGRESS 0x100
304 /** Possible return codes */
312 /** Possible status */
315 ANSWERED_DIALOG
, ///< Got "answer"
316 DESTROYED_DIALOG
, ///< Interface has destroyed it
319 /** Possible actions */
328 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
329 #define interaction_Register( t ) (t, VLC_EGENERIC)
330 #define interaction_Unregister( t ) (t, VLC_EGENERIC)