vlc_interface.h 9.04 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
    /* Thread properties and locks */
56
#if defined( __APPLE__ ) || defined( WIN32 )
57
    bool          b_should_run_on_first_thread;
58
#endif
Michel Kaempf's avatar
Michel Kaempf committed
59

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

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

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

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

Clément Stenac's avatar
Clément Stenac committed
75 76
/** \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
77
 *  mainly used with INTF_DIALOG_FILE_GENERIC.
Clément Stenac's avatar
Clément Stenac committed
78
 */
Gildas Bazin's avatar
 
Gildas Bazin committed
79 80
struct intf_dialog_args_t
{
81
    intf_thread_t *p_intf;
Gildas Bazin's avatar
 
Gildas Bazin committed
82 83 84 85 86 87 88 89 90 91
    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;
92 93
    bool b_save;
    bool b_multiple;
94 95

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

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

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

108 109
VLC_EXPORT( void, libvlc_Quit, ( libvlc_int_t * ) );

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

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

/* Interface dialog ids for dialog providers */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
135
typedef enum vlc_dialog {
136 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
    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
166
} vlc_dialog_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
167 168

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

171 172 173 174
#define EXTENSIONS_AUDIO \
    "*.a52;" \
    "*.aac;" \
    "*.ac3;" \
175 176 177 178
    "*.adt;" \
    "*.adts;" \
    "*.aif;"\
    "*.aifc;"\
179
    "*.aiff;"\
180
    "*.amr;" \
181 182
    "*.aob;" \
    "*.ape;" \
183
    "*.cda;" \
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    "*.dts;" \
    "*.flac;"\
    "*.it;"  \
    "*.m4a;" \
    "*.m4p;" \
    "*.mid;" \
    "*.mka;" \
    "*.mlp;" \
    "*.mod;" \
    "*.mp1;" \
    "*.mp2;" \
    "*.mp3;" \
    "*.mpc;" \
    "*.oga;" \
    "*.ogg;" \
    "*.oma;" \
    "*.rmi;" \
    "*.s3m;" \
    "*.spx;" \
203
    "*.tta;" \
204 205 206 207 208 209 210 211
    "*.voc;" \
    "*.vqf;" \
    "*.w64;" \
    "*.wav;" \
    "*.wma;" \
    "*.wv;"  \
    "*.xa;"  \
    "*.xm"
212

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

219
#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.zip"
220

221 222 223
#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
                          EXTENSIONS_PLAYLIST

224
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
225
                            "*.jss;*.psb;*.rt;*.smi"
Clément Stenac's avatar
Clément Stenac committed
226 227 228 229 230 231 232 233 234 235

/** \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
236
typedef struct interaction_dialog_t
Clément Stenac's avatar
Clément Stenac committed
237 238 239 240 241 242 243 244 245 246 247 248 249
{
    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
250
    bool      b_cancelled;        ///< was the dialogue cancelled ?
Clément Stenac's avatar
Clément Stenac committed
251 252 253 254 255 256 257 258 259 260

    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
261
    intf_thread_t  *p_interface;
262
    vlc_mutex_t    *p_lock;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
263
} interaction_dialog_t;
264

Clément Stenac's avatar
Clément Stenac committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
/**
 * 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
};

301
#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
302
#define interaction_Register( t ) (t, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
303 304
#define interaction_Unregister( t ) (t, VLC_EGENERIC)

Clément Stenac's avatar
Clément Stenac committed
305 306 307 308 309 310 311 312

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

# ifdef __cplusplus
}
# endif
#endif