d8e8172222c9dd43712fcfe7938156f632cddcc6
[vlc.git] / include / vlc_interface.h
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
7  * $Id$
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *
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.
15  *
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.
20  *
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  *****************************************************************************/
25
26 #ifndef VLC_INTF_H_
27 #define VLC_INTF_H_
28
29 # ifdef __cplusplus
30 extern "C" {
31 # endif
32
33 typedef struct intf_dialog_args_t intf_dialog_args_t;
34
35 /**
36  * \file
37  * This file contains structures and function prototypes for
38  * interface management in vlc
39  */
40
41 /**
42  * \defgroup vlc_interface Interface
43  * These functions and structures are for interface management
44  * @{
45  */
46
47 typedef struct intf_sys_t intf_sys_t;
48
49 /** Describe all interface-specific data of the interface thread */
50 typedef struct intf_thread_t
51 {
52     VLC_COMMON_MEMBERS
53
54     struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
55     /* Thread properties and locks */
56 #if defined( __APPLE__ ) || defined( WIN32 )
57     bool          b_should_run_on_first_thread;
58 #endif
59
60     /* Specific interfaces */
61     intf_sys_t *        p_sys;                          /** system interface */
62     char *              psz_intf;                    /** intf name specified */
63
64     /** Interface module */
65     module_t *   p_module;
66     void      ( *pf_run )    ( struct intf_thread_t * ); /** Run function */
67
68     /** Specific for dialogs providers */
69     void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
70                                intf_dialog_args_t * );
71
72     config_chain_t *p_cfg;
73 } intf_thread_t;
74
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.
78  */
79 struct intf_dialog_args_t
80 {
81     intf_thread_t *p_intf;
82     char *psz_title;
83
84     char **psz_results;
85     int  i_results;
86
87     void (*pf_callback) ( intf_dialog_args_t * );
88     void *p_arg;
89
90     /* Specifically for INTF_DIALOG_FILE_GENERIC */
91     char *psz_extensions;
92     bool b_save;
93     bool b_multiple;
94
95     /* Specific to INTF_DIALOG_INTERACTION */
96     struct interaction_dialog_t *p_dialog;
97 };
98
99 /*****************************************************************************
100  * Prototypes
101  *****************************************************************************/
102 VLC_EXPORT( int, intf_Create, ( vlc_object_t *, const char * ) );
103 #define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
104
105 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
106 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
107
108 VLC_EXPORT( void, libvlc_Quit, ( libvlc_int_t * ) );
109
110 /*@}*/
111
112 /*****************************************************************************
113  * Macros
114  *****************************************************************************/
115 #if defined( WIN32 ) && !defined( UNDER_CE )
116 #    define CONSOLE_INTRO_MSG \
117          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
118          { \
119          AllocConsole(); \
120          freopen( "CONOUT$", "w", stdout ); \
121          freopen( "CONOUT$", "w", stderr ); \
122          freopen( "CONIN$", "r", stdin ); \
123          } \
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 " \
128                              "\"vlc -I qt\"\n") )
129 #else
130 #    define CONSOLE_INTRO_MSG
131 #endif
132
133 /* Interface dialog ids for dialog providers */
134 typedef enum vlc_dialog {
135     INTF_DIALOG_FILE_SIMPLE = 1,
136     INTF_DIALOG_FILE,
137     INTF_DIALOG_DISC,
138     INTF_DIALOG_NET,
139     INTF_DIALOG_CAPTURE,
140     INTF_DIALOG_SAT,
141     INTF_DIALOG_DIRECTORY,
142
143     INTF_DIALOG_STREAMWIZARD,
144     INTF_DIALOG_WIZARD,
145
146     INTF_DIALOG_PLAYLIST,
147     INTF_DIALOG_MESSAGES,
148     INTF_DIALOG_FILEINFO,
149     INTF_DIALOG_PREFS,
150     INTF_DIALOG_BOOKMARKS,
151     INTF_DIALOG_EXTENDED,
152
153     INTF_DIALOG_POPUPMENU = 20,
154     INTF_DIALOG_AUDIOPOPUPMENU,
155     INTF_DIALOG_VIDEOPOPUPMENU,
156     INTF_DIALOG_MISCPOPUPMENU,
157
158     INTF_DIALOG_FILE_GENERIC = 30,
159     INTF_DIALOG_INTERACTION = 50,
160
161     INTF_DIALOG_UPDATEVLC = 90,
162     INTF_DIALOG_VLM,
163
164     INTF_DIALOG_EXIT = 99
165 } vlc_dialog_t;
166
167 /* Useful text messages shared by interfaces */
168 #define INTF_ABOUT_MSG LICENSE_MSG
169
170 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.ape;*.dts;*.flac;*.it;" \
171                          "*.m4a;*.m4p;*.mka;*.mlp;*.mod;*.mp1;*.mp2;*.mp3;*.mpc" \
172                          "*.oga;*.ogg;*.oma;*.s3m;*.spx;" \
173                          "*.wav;*.wma;*.wv;*.xm"
174
175 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
176                          "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
177                          "*.mpeg2;*.mpeg4;*.mpg;*.mts;*.mxf;*.nuv;" \
178                          "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
179                          "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.vob;*.wmv"
180
181 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.ram;*.vlc;*.xspf"
182
183 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
184                           EXTENSIONS_PLAYLIST
185
186 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
187                             "*.jss;*.psb;*.rt;*.smi"
188
189 /** \defgroup vlc_interaction Interaction
190  * \ingroup vlc_interface
191  * Interaction between user and modules
192  * @{
193  */
194
195 /**
196  * This structure describes a piece of interaction with the user
197  */
198 typedef struct interaction_dialog_t
199 {
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;
207
208     char           *psz_returned[1];    ///< returned responses from the user
209
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 ?
213
214     void *          p_private;          ///< Private interface data
215
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
220
221     vlc_object_t   *p_parent;           ///< The vlc object that asked
222                                         //for interaction
223     intf_thread_t  *p_interface;
224     vlc_mutex_t    *p_lock;
225 } interaction_dialog_t;
226
227 /**
228  * Possible flags . Dialog types
229  */
230 #define DIALOG_GOT_ANSWER           0x01
231 #define DIALOG_YES_NO_CANCEL        0x02
232 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
233 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
234 #define DIALOG_BLOCKING_ERROR       0x10
235 #define DIALOG_NONBLOCKING_ERROR    0x20
236 #define DIALOG_USER_PROGRESS        0x80
237 #define DIALOG_INTF_PROGRESS        0x100
238
239 /** Possible return codes */
240 enum
241 {
242     DIALOG_OK_YES,
243     DIALOG_NO,
244     DIALOG_CANCELLED
245 };
246
247 /** Possible status  */
248 enum
249 {
250     ANSWERED_DIALOG,            ///< Got "answer"
251     DESTROYED_DIALOG,           ///< Interface has destroyed it
252 };
253
254 /** Possible actions */
255 enum
256 {
257     INTERACT_NEW,
258     INTERACT_UPDATE,
259     INTERACT_HIDE,
260     INTERACT_DESTROY
261 };
262
263 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
264 #define interaction_Register( t ) (t, VLC_EGENERIC)
265 #define interaction_Unregister( t ) (t, VLC_EGENERIC)
266
267
268 /** @} */
269 /** @} */
270
271 # ifdef __cplusplus
272 }
273 # endif
274 #endif