vlc_interface.h 9.74 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
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
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
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
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_
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
 * \ingroup vlc
38
 * VLC user interfaces
Clément Stenac's avatar
Clément Stenac committed
39
 * @{
40 41
 * \file
 * VLC user interface modules
Clément Stenac's avatar
Clément Stenac committed
42
 */
43

44 45
typedef struct intf_sys_t intf_sys_t;

46
/** Describe all interface-specific data of the interface thread */
47
typedef struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
48
{
49
    struct vlc_common_members obj;
50

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

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

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

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

63
    config_chain_t *p_cfg;
64
} intf_thread_t;
65

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

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

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

92
VLC_API void libvlc_Quit( libvlc_int_t * );
93

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

/**
 * 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)))

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

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

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

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

    INTF_DIALOG_POPUPMENU = 20,
    INTF_DIALOG_AUDIOPOPUPMENU,
    INTF_DIALOG_VIDEOPOPUPMENU,
    INTF_DIALOG_MISCPOPUPMENU,

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

    INTF_DIALOG_UPDATEVLC = 90,
    INTF_DIALOG_VLM,

    INTF_DIALOG_EXIT = 99
148
} vlc_intf_dialog;
149 150

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

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

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

168
#define EXTENSIONS_AUDIO \
169
    "*.3ga;" \
170
    "*.669;" \
171 172 173
    "*.a52;" \
    "*.aac;" \
    "*.ac3;" \
174 175 176 177
    "*.adt;" \
    "*.adts;" \
    "*.aif;"\
    "*.aifc;"\
178
    "*.aiff;"\
179
    "*.amb;" \
180
    "*.amr;" \
181 182
    "*.aob;" \
    "*.ape;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
183
    "*.au;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
184
    "*.awb;" \
185
    "*.caf;" \
186 187 188
    "*.dts;" \
    "*.flac;"\
    "*.it;"  \
189
    "*.kar;" \
190
    "*.m4a;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
191
    "*.m4b;" \
192
    "*.m4p;" \
193
    "*.m5p;" \
194 195 196 197
    "*.mid;" \
    "*.mka;" \
    "*.mlp;" \
    "*.mod;" \
198
    "*.mpa;" \
199 200 201 202
    "*.mp1;" \
    "*.mp2;" \
    "*.mp3;" \
    "*.mpc;" \
203
    "*.mpga;" \
204
    "*.mus;" \
205 206 207
    "*.oga;" \
    "*.ogg;" \
    "*.oma;" \
.'s avatar
. committed
208
    "*.opus;" \
209
    "*.qcp;" \
210
    "*.ra;" \
211 212
    "*.rmi;" \
    "*.s3m;" \
213
    "*.sid;" \
214
    "*.spx;" \
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
215
    "*.tak;" \
216
    "*.thd;" \
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;*.bik;*.bin;*.crf;*.divx;*.drc;*.dv;*.dvr-ms;*.evo;*.f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
228
                         "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
Sébastien Escudier's avatar
Sébastien Escudier committed
229
                         "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
230
                         "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
231
                         "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.tp;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
232

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

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

238 239 240 241
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
                            "*.sub;*.utf;*.ass;" \
                            "*.ssa;*.aqt;" \
                            "*.jss;*.psb;" \
242
                            "*.rt;*.sami;*.smi;*.txt;" \
243
                            "*.smil;*.stl;*.usf;" \
244
                            "*.dks;*.pjs;*.mpl2;*.mks;" \
245 246
                            "*.vtt;*.tt;*.ttml;*.dfxp;" \
                            "*.scc"
247

248 249
/** \defgroup interaction Interaction
 * \ingroup interface
250 251 252 253 254 255 256
 * Interaction between user and modules
 * @{
 */

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

    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
282
    intf_thread_t  *p_interface;
283
    vlc_mutex_t    *p_lock;
284
} interaction_dialog_t;
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 320 321
/**
 * 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
};

322
#define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
323
#define interaction_Register( t ) (t, VLC_EGENERIC)
324 325
#define interaction_Unregister( t ) (t, VLC_EGENERIC)

326 327 328 329 330 331 332 333

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

# ifdef __cplusplus
}
# endif
#endif