vlc_interface.h 9.67 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
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
6
 * Copyright (C) 1999, 2000 VLC authors and VideoLAN
7
 * $Id$
8
 *
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
11 12 13
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
14
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
21 22 23
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software 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

33 34
typedef struct intf_dialog_args_t intf_dialog_args_t;

Clément Stenac's avatar
Clément Stenac committed
35
/**
36
 * \defgroup interface Interface
37
 * VLC user interfaces
Clément Stenac's avatar
Clément Stenac committed
38
 * @{
39 40
 * \file
 * VLC user interface modules
Clément Stenac's avatar
Clément Stenac committed
41
 */
Clément Stenac's avatar
Clément Stenac committed
42

43 44
typedef struct intf_sys_t intf_sys_t;

Clément Stenac's avatar
Clément Stenac committed
45
/** Describe all interface-specific data of the interface thread */
46
typedef struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
47
{
48 49
    VLC_COMMON_MEMBERS

50
    struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
Michel Kaempf's avatar
Michel Kaempf committed
51

52
    /* Specific interfaces */
53
    intf_sys_t *        p_sys;                          /** system interface */
54

Clément Stenac's avatar
Clément Stenac committed
55
    /** Interface module */
56
    module_t *   p_module;
57

Clément Stenac's avatar
Clément Stenac committed
58
    /** Specific for dialogs providers */
59
    void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
60
                               intf_dialog_args_t * );
61

62
    config_chain_t *p_cfg;
63
} intf_thread_t;
64

Clément Stenac's avatar
Clément Stenac committed
65 66
/** \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
67
 *  mainly used with INTF_DIALOG_FILE_GENERIC.
Clément Stenac's avatar
Clément Stenac committed
68
 */
69 70
struct intf_dialog_args_t
{
71
    intf_thread_t *p_intf;
72 73 74 75 76 77 78 79 80 81
    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;
82 83
    bool b_save;
    bool b_multiple;
84 85

    /* Specific to INTF_DIALOG_INTERACTION */
86
    struct interaction_dialog_t *p_dialog;
87 88
};

89
VLC_API int intf_Create( playlist_t *, const char * );
Vincent Seguin's avatar
Vincent Seguin committed
90

91
VLC_API void libvlc_Quit( libvlc_int_t * );
92

93 94
static inline playlist_t *pl_Get( struct intf_thread_t *intf )
{
95
    return (playlist_t *)(intf->obj.parent);
96 97 98 99 100 101 102 103
}

/**
 * Retrieves the current input thread from the playlist.
 * @note The returned object must be released with vlc_object_release().
 */
#define pl_CurrentInput(intf) (playlist_CurrentInput(pl_Get(intf)))

104
/**
105
 * @ingroup messages
106 107 108
 * @{
 */

109
VLC_API void vlc_LogSet(libvlc_int_t *, vlc_log_cb cb, void *data);
110

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

113
/* Interface dialog ids for dialog providers */
114
typedef enum vlc_intf_dialog {
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
    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,
132
    INTF_DIALOG_RENDERER,
133 134 135 136 137 138 139 140

    INTF_DIALOG_POPUPMENU = 20,
    INTF_DIALOG_AUDIOPOPUPMENU,
    INTF_DIALOG_VIDEOPOPUPMENU,
    INTF_DIALOG_MISCPOPUPMENU,

    INTF_DIALOG_FILE_GENERIC = 30,
    INTF_DIALOG_INTERACTION = 50,
141
    INTF_DIALOG_SENDKEY = 51,
142 143 144 145 146

    INTF_DIALOG_UPDATEVLC = 90,
    INTF_DIALOG_VLM,

    INTF_DIALOG_EXIT = 99
147
} vlc_intf_dialog;
148 149

/* Useful text messages shared by interfaces */
150
#define INTF_ABOUT_MSG LICENSE_MSG
151

152
#define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \
153
                         "amb", "amr", "aob", "ape", "au", "awb", "caf", "dts", "flac", "it", "kar", \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
154
                         "m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
155
                         "oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "tak", "thd", "tta", \
156 157
                         "voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"

158
#define EXTENSIONS_VIDEO_CSV "3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "crf", "divx", "drc", "dv", "dvr-ms" \
159
                             "evo", "f4v", "flv", "gvi", "gxf", "iso", \
160
                             "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
161 162
                             "mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \
                             "mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \
163
                             "ogg", "ogm", "ogv", "ogx", "ps", \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
164
                             "rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \
165
                             "webm", "wm", "wmv", "wtv", "xesc"
166

167
#define EXTENSIONS_AUDIO \
Julien Humbert's avatar
Julien Humbert committed
168
    "*.3ga;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
169
    "*.669;" \
170 171 172
    "*.a52;" \
    "*.aac;" \
    "*.ac3;" \
173 174 175 176
    "*.adt;" \
    "*.adts;" \
    "*.aif;"\
    "*.aifc;"\
177
    "*.aiff;"\
178
    "*.amb;" \
179
    "*.amr;" \
180 181
    "*.aob;" \
    "*.ape;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
182
    "*.au;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
183
    "*.awb;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
184
    "*.caf;" \
185 186 187
    "*.dts;" \
    "*.flac;"\
    "*.it;"  \
188
    "*.kar;" \
189
    "*.m4a;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
190
    "*.m4b;" \
191
    "*.m4p;" \
192
    "*.m5p;" \
193 194 195 196
    "*.mid;" \
    "*.mka;" \
    "*.mlp;" \
    "*.mod;" \
197
    "*.mpa;" \
198 199 200 201
    "*.mp1;" \
    "*.mp2;" \
    "*.mp3;" \
    "*.mpc;" \
202
    "*.mpga;" \
203
    "*.mus;" \
204 205 206
    "*.oga;" \
    "*.ogg;" \
    "*.oma;" \
.'s avatar
. committed
207
    "*.opus;" \
208
    "*.qcp;" \
209
    "*.ra;" \
210 211
    "*.rmi;" \
    "*.s3m;" \
212
    "*.sid;" \
213
    "*.spx;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
214
    "*.tak;" \
215
    "*.thd;" \
216
    "*.tta;" \
217 218 219 220 221 222 223 224
    "*.voc;" \
    "*.vqf;" \
    "*.w64;" \
    "*.wav;" \
    "*.wma;" \
    "*.wv;"  \
    "*.xa;"  \
    "*.xm"
225

226
#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;" \
227
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
Sébastien Escudier's avatar
Sébastien Escudier committed
228
                         "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
229
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
230
                         "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.tp;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
231

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

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

237 238 239 240 241
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
                            "*.sub;*.utf;*.ass;" \
                            "*.ssa;*.aqt;" \
                            "*.jss;*.psb;" \
                            "*.rt;*.smi;*.txt;" \
242
                            "*.smil;*.stl;*.usf;" \
243
                            "*.dks;*.pjs;*.mpl2;*.mks;" \
244
                            "*.vtt;*.ttml;*.dfxp;"
Clément Stenac's avatar
Clément Stenac committed
245

246 247
/** \defgroup interaction Interaction
 * \ingroup interface
Clément Stenac's avatar
Clément Stenac committed
248 249 250 251 252 253 254
 * Interaction between user and modules
 * @{
 */

/**
 * This structure describes a piece of interaction with the user
 */
255
typedef struct interaction_dialog_t
Clément Stenac's avatar
Clément Stenac committed
256 257 258 259 260 261 262 263 264 265 266 267 268
{
    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
269
    bool      b_cancelled;        ///< was the dialogue cancelled ?
Clément Stenac's avatar
Clément Stenac committed
270 271 272 273 274 275 276 277 278 279

    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
280
    intf_thread_t  *p_interface;
281
    vlc_mutex_t    *p_lock;
282
} interaction_dialog_t;
283

Clément Stenac's avatar
Clément Stenac committed
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 315 316 317 318 319
/**
 * 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
};

320
#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
321
#define interaction_Register( t ) (t, VLC_EGENERIC)
322 323
#define interaction_Unregister( t ) (t, VLC_EGENERIC)

Clément Stenac's avatar
Clément Stenac committed
324 325 326 327 328 329 330 331

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

# ifdef __cplusplus
}
# endif
#endif