vlc_interface.h 9.79 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_interface.h: interface access for other threads
Michel Kaempf's avatar
Michel Kaempf committed
3 4
 * This library provides basic functions for threads to interact with user
 * interface, such as message output.
5
 *****************************************************************************
6
 * Copyright (C) 1999, 2000 the VideoLAN team
7
 * $Id$
8
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 11 12 13 14
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
15
 *
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
20
 *
21 22
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 25
 *****************************************************************************/

26 27
#ifndef VLC_INTF_H_
#define VLC_INTF_H_
Clément Stenac's avatar
Clément Stenac committed
28 29 30 31

# ifdef __cplusplus
extern "C" {
# endif
32

Gildas Bazin's avatar
 
Gildas Bazin committed
33 34
typedef struct intf_dialog_args_t intf_dialog_args_t;

Clément Stenac's avatar
Clément Stenac committed
35 36
/**
 * \file
Clément Stenac's avatar
Clément Stenac committed
37 38
 * This file contains structures and function prototypes for
 * interface management in vlc
Clément Stenac's avatar
Clément Stenac committed
39 40 41 42 43 44 45
 */

/**
 * \defgroup vlc_interface Interface
 * These functions and structures are for interface management
 * @{
 */
Clément Stenac's avatar
Clément Stenac committed
46

47 48
typedef struct intf_sys_t intf_sys_t;

Clément Stenac's avatar
Clément Stenac committed
49
/** Describe all interface-specific data of the interface thread */
50
typedef struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
51
{
52 53
    VLC_COMMON_MEMBERS

54
    struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
55
    vlc_thread_t thread; /** LibVLC thread */
56
    /* Thread properties and locks */
57
#if defined( __APPLE__ )
58
    bool          b_should_run_on_first_thread;
59
#endif
Michel Kaempf's avatar
Michel Kaempf committed
60

61
    /* Specific interfaces */
Gildas Bazin's avatar
 
Gildas Bazin committed
62
    intf_sys_t *        p_sys;                          /** system interface */
63
    char *              psz_intf;                    /** intf name specified */
64

Clément Stenac's avatar
Clément Stenac committed
65
    /** Interface module */
66
    module_t *   p_module;
67
    void      ( *pf_run )    ( struct intf_thread_t * ); /** Run function */
68

Clément Stenac's avatar
Clément Stenac committed
69
    /** Specific for dialogs providers */
70
    void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
Gildas Bazin's avatar
 
Gildas Bazin committed
71
                               intf_dialog_args_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
72

73
    config_chain_t *p_cfg;
74
} intf_thread_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
75

Clément Stenac's avatar
Clément Stenac committed
76 77
/** \brief Arguments passed to a dialogs provider
 *  This describes the arguments passed to the dialogs provider. They are
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
78
 *  mainly used with INTF_DIALOG_FILE_GENERIC.
Clément Stenac's avatar
Clément Stenac committed
79
 */
Gildas Bazin's avatar
 
Gildas Bazin committed
80 81
struct intf_dialog_args_t
{
82
    intf_thread_t *p_intf;
Gildas Bazin's avatar
 
Gildas Bazin committed
83 84 85 86 87 88 89 90 91 92
    char *psz_title;

    char **psz_results;
    int  i_results;

    void (*pf_callback) ( intf_dialog_args_t * );
    void *p_arg;

    /* Specifically for INTF_DIALOG_FILE_GENERIC */
    char *psz_extensions;
93 94
    bool b_save;
    bool b_multiple;
95 96

    /* Specific to INTF_DIALOG_INTERACTION */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
97
    struct interaction_dialog_t *p_dialog;
Gildas Bazin's avatar
 
Gildas Bazin committed
98 99
};

100
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
101
 * Prototypes
102
 *****************************************************************************/
103
VLC_API int intf_Create( vlc_object_t *, const char * );
104
#define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
Vincent Seguin's avatar
Vincent Seguin committed
105

106
VLC_API int intf_Eject( vlc_object_t *, const char * );
107
#define intf_Eject(a,b) intf_Eject(VLC_OBJECT(a),b)
Clément Stenac's avatar
Clément Stenac committed
108

109
VLC_API void libvlc_Quit( libvlc_int_t * );
110

Clément Stenac's avatar
Clément Stenac committed
111 112
/*@}*/

Gildas Bazin's avatar
 
Gildas Bazin committed
113 114 115
/*****************************************************************************
 * Macros
 *****************************************************************************/
116
#if defined( WIN32 ) && !defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
117
#    define CONSOLE_INTRO_MSG \
118 119
         if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
         { \
Gildas Bazin's avatar
 
Gildas Bazin committed
120 121 122 123
         AllocConsole(); \
         freopen( "CONOUT$", "w", stdout ); \
         freopen( "CONOUT$", "w", stderr ); \
         freopen( "CONIN$", "r", stdin ); \
124
         } \
125
         msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \
126
         msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
Gildas Bazin's avatar
 
Gildas Bazin committed
127
         msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
128
                             "anymore, open a command-line window, go to the " \
Gildas Bazin's avatar
 
Gildas Bazin committed
129
                             "directory where you installed VLC and run " \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
130
                             "\"vlc -I qt\"\n") )
Gildas Bazin's avatar
 
Gildas Bazin committed
131 132 133
#else
#    define CONSOLE_INTRO_MSG
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
134 135

/* Interface dialog ids for dialog providers */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
136
typedef enum vlc_dialog {
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    INTF_DIALOG_FILE_SIMPLE = 1,
    INTF_DIALOG_FILE,
    INTF_DIALOG_DISC,
    INTF_DIALOG_NET,
    INTF_DIALOG_CAPTURE,
    INTF_DIALOG_SAT,
    INTF_DIALOG_DIRECTORY,

    INTF_DIALOG_STREAMWIZARD,
    INTF_DIALOG_WIZARD,

    INTF_DIALOG_PLAYLIST,
    INTF_DIALOG_MESSAGES,
    INTF_DIALOG_FILEINFO,
    INTF_DIALOG_PREFS,
    INTF_DIALOG_BOOKMARKS,
    INTF_DIALOG_EXTENDED,

    INTF_DIALOG_POPUPMENU = 20,
    INTF_DIALOG_AUDIOPOPUPMENU,
    INTF_DIALOG_VIDEOPOPUPMENU,
    INTF_DIALOG_MISCPOPUPMENU,

    INTF_DIALOG_FILE_GENERIC = 30,
    INTF_DIALOG_INTERACTION = 50,

    INTF_DIALOG_UPDATEVLC = 90,
    INTF_DIALOG_VLM,

    INTF_DIALOG_EXIT = 99
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
167
} vlc_dialog_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
168 169

/* Useful text messages shared by interfaces */
170
#define INTF_ABOUT_MSG LICENSE_MSG
171

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
172
#define EXTENSIONS_AUDIO_CSV "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
173 174 175 176
                         "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3",\
                         "oga", "ogg", "oma", "s3m", "spx" \
                         "wav", "wma", "wv", "xm"

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
177
#define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "dv", "f4v", "flv", "gxf", "iso", \
178 179 180 181 182 183
                             "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
                             "mp2", "mp4", "mpeg", "mpeg1", \
                             "mpeg2", "mpeg4", "mpg", "mts", "mxf", "nuv", \
                             "ogg", "ogm", "ogv", "ogx", "ps", \
                             "rec", "rm", "rmvb", "ts", "vob", "wmv"

184 185 186 187
#define EXTENSIONS_AUDIO \
    "*.a52;" \
    "*.aac;" \
    "*.ac3;" \
188 189 190 191
    "*.adt;" \
    "*.adts;" \
    "*.aif;"\
    "*.aifc;"\
192
    "*.aiff;"\
193
    "*.amr;" \
194 195
    "*.aob;" \
    "*.ape;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
196
    "*.awb;" \
197
    "*.cda;" \
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
    "*.dts;" \
    "*.flac;"\
    "*.it;"  \
    "*.m4a;" \
    "*.m4p;" \
    "*.mid;" \
    "*.mka;" \
    "*.mlp;" \
    "*.mod;" \
    "*.mp1;" \
    "*.mp2;" \
    "*.mp3;" \
    "*.mpc;" \
    "*.oga;" \
    "*.ogg;" \
    "*.oma;" \
    "*.rmi;" \
    "*.s3m;" \
    "*.spx;" \
217
    "*.tta;" \
218 219 220 221 222 223 224 225
    "*.voc;" \
    "*.vqf;" \
    "*.w64;" \
    "*.wav;" \
    "*.wma;" \
    "*.wv;"  \
    "*.xa;"  \
    "*.xm"
226

227
#define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.dv;*f4v;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
228 229
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
                         "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mxf;*.nsv;*.nuv;" \
230
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
231
                         "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wmv"
232

233
#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.zip"
234

235 236 237
#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
                          EXTENSIONS_PLAYLIST

238
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
239
                            "*.jss;*.psb;*.rt;*.smi;*.txt;*.smil;*.stl"
Clément Stenac's avatar
Clément Stenac committed
240 241 242 243 244 245 246 247 248 249

/** \defgroup vlc_interaction Interaction
 * \ingroup vlc_interface
 * Interaction between user and modules
 * @{
 */

/**
 * This structure describes a piece of interaction with the user
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
250
typedef struct interaction_dialog_t
Clément Stenac's avatar
Clément Stenac committed
251 252 253 254 255 256 257 258 259 260 261 262 263
{
    int             i_type;             ///< Type identifier
    char           *psz_title;          ///< Title
    char           *psz_description;    ///< Descriptor string
    char           *psz_default_button;  ///< default button title (~OK)
    char           *psz_alternate_button;///< alternate button title (~NO)
    /// other button title (optional,~Cancel)
    char           *psz_other_button;

    char           *psz_returned[1];    ///< returned responses from the user

    vlc_value_t     val;                ///< value coming from core for dialogue
    int             i_timeToGo;         ///< time (in sec) until shown progress is finished
264
    bool      b_cancelled;        ///< was the dialogue cancelled ?
Clément Stenac's avatar
Clément Stenac committed
265 266 267 268 269 270 271 272 273 274

    void *          p_private;          ///< Private interface data

    int             i_status;           ///< Dialog status;
    int             i_action;           ///< Action to perform;
    int             i_flags;            ///< Misc flags
    int             i_return;           ///< Return status

    vlc_object_t   *p_parent;           ///< The vlc object that asked
                                        //for interaction
275
    intf_thread_t  *p_interface;
276
    vlc_mutex_t    *p_lock;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
277
} interaction_dialog_t;
278

Clément Stenac's avatar
Clément Stenac committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
/**
 * Possible flags . Dialog types
 */
#define DIALOG_GOT_ANSWER           0x01
#define DIALOG_YES_NO_CANCEL        0x02
#define DIALOG_LOGIN_PW_OK_CANCEL   0x04
#define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
#define DIALOG_BLOCKING_ERROR       0x10
#define DIALOG_NONBLOCKING_ERROR    0x20
#define DIALOG_USER_PROGRESS        0x80
#define DIALOG_INTF_PROGRESS        0x100

/** Possible return codes */
enum
{
    DIALOG_OK_YES,
    DIALOG_NO,
    DIALOG_CANCELLED
};

/** Possible status  */
enum
{
    ANSWERED_DIALOG,            ///< Got "answer"
    DESTROYED_DIALOG,           ///< Interface has destroyed it
};

/** Possible actions */
enum
{
    INTERACT_NEW,
    INTERACT_UPDATE,
    INTERACT_HIDE,
    INTERACT_DESTROY
};

315
#define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
316
#define interaction_Register( t ) (t, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
317 318
#define interaction_Unregister( t ) (t, VLC_EGENERIC)

Clément Stenac's avatar
Clément Stenac committed
319 320 321 322 323 324 325 326

/** @} */
/** @} */

# ifdef __cplusplus
}
# endif
#endif