vlc_interface.h 11.9 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
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
26 27 28 29
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

Clément Stenac's avatar
Clément Stenac committed
30 31 32 33 34 35
#ifndef _VLC_INTF_H_
#define _VLC_INTF_H_

# ifdef __cplusplus
extern "C" {
# endif
36

Gildas Bazin's avatar
 
Gildas Bazin committed
37 38
typedef struct intf_dialog_args_t intf_dialog_args_t;

Clément Stenac's avatar
Clément Stenac committed
39 40
/**
 * \file
Clément Stenac's avatar
Clément Stenac committed
41 42
 * This file contains structures and function prototypes for
 * interface management in vlc
Clément Stenac's avatar
Clément Stenac committed
43 44 45 46 47 48 49
 */

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

/** Describe all interface-specific data of the interface thread */
52
struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
53
{
54 55 56
    VLC_COMMON_MEMBERS

    /* Thread properties and locks */
57 58
    bool          b_play;
    bool          b_should_run_on_first_thread;
Michel Kaempf's avatar
Michel Kaempf committed
59

60
    /* Specific interfaces */
Gildas Bazin's avatar
 
Gildas Bazin committed
61 62
    intf_console_t *    p_console;                               /** console */
    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;
Clément Stenac's avatar
Clément Stenac committed
67
    void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
68

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

73
    /** Interaction stuff */
74
    bool b_interaction;
75

Gildas Bazin's avatar
Gildas Bazin committed
76
    /** Video window callbacks */
77 78
    void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *,
                                    int *, int *,
Gildas Bazin's avatar
Gildas Bazin committed
79 80
                                    unsigned int *, unsigned int * );
    void   ( *pf_release_window ) ( intf_thread_t *, void * );
81
    int    ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list );
Gildas Bazin's avatar
Gildas Bazin committed
82

Sam Hocevar's avatar
 
Sam Hocevar committed
83
    /* XXX: new message passing stuff will go here */
84
    vlc_mutex_t  change_lock;
85 86
    bool   b_menu_change;
    bool   b_menu;
Gildas Bazin's avatar
 
Gildas Bazin committed
87 88 89

    /* Provides the ability to switch an interface on the fly */
    char *psz_switch_intf;
90
};
Sam Hocevar's avatar
 
Sam Hocevar committed
91

Clément Stenac's avatar
Clément Stenac committed
92 93
/** \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
94
 *  mainly used with INTF_DIALOG_FILE_GENERIC.
Clément Stenac's avatar
Clément Stenac committed
95
 */
Gildas Bazin's avatar
 
Gildas Bazin committed
96 97
struct intf_dialog_args_t
{
98
    intf_thread_t *p_intf;
Gildas Bazin's avatar
 
Gildas Bazin committed
99 100 101 102 103 104 105 106 107 108
    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;
109 110
    bool b_save;
    bool b_multiple;
111 112 113

    /* Specific to INTF_DIALOG_INTERACTION */
    interaction_dialog_t *p_dialog;
Gildas Bazin's avatar
 
Gildas Bazin committed
114 115
};

116
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
117
 * Prototypes
118
 *****************************************************************************/
119
#define intf_Create(a,b,c,d) __intf_Create(VLC_OBJECT(a),b,c,d)
120
VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char *, int, const char *const * ) );
Sam Hocevar's avatar
Sam Hocevar committed
121
VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
122 123
VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
Vincent Seguin's avatar
Vincent Seguin committed
124

125 126
/* If the interface is in the main thread, it should listen both to
 * p_intf->b_die and p_libvlc->b_die */
127
#define intf_ShouldDie( p_intf ) (p_intf->b_die || p_intf->p_libvlc->b_die )
128

Clément Stenac's avatar
Clément Stenac committed
129 130 131
#define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );

Clément Stenac's avatar
Clément Stenac committed
132 133
/*@}*/

Gildas Bazin's avatar
 
Gildas Bazin committed
134 135 136
/*****************************************************************************
 * Macros
 *****************************************************************************/
137
#if defined( WIN32 ) && !defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
138
#    define CONSOLE_INTRO_MSG \
139 140
         if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
         { \
Gildas Bazin's avatar
 
Gildas Bazin committed
141 142 143 144
         AllocConsole(); \
         freopen( "CONOUT$", "w", stdout ); \
         freopen( "CONOUT$", "w", stderr ); \
         freopen( "CONIN$", "r", stdin ); \
145
         } \
Sam Hocevar's avatar
Sam Hocevar committed
146
         msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
Gildas Bazin's avatar
 
Gildas Bazin committed
147
         msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
148
                             "anymore, open a command-line window, go to the " \
Gildas Bazin's avatar
 
Gildas Bazin committed
149
                             "directory where you installed VLC and run " \
150
                             "\"vlc -I wx\"\n") )
Gildas Bazin's avatar
 
Gildas Bazin committed
151 152 153
#else
#    define CONSOLE_INTRO_MSG
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
154 155

/* Interface dialog ids for dialog providers */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
156
typedef enum vlc_dialog {
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
    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
187
} vlc_dialog_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
188 189

/* Useful text messages shared by interfaces */
190
#define INTF_ABOUT_MSG LICENSE_MSG
191 192 193 194

#define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
                         "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.spx;*.wav;*.wma;*.xm"

195 196 197 198
#define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
                         "*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
                         "*.mpeg2;*.mpeg4;*.mpg;*.mxf;*.ogg;*.ogm;" \
                         "*.ps;*.ts;*.vob;*.wmv"
199 200 201

#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"

202 203 204
#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
                          EXTENSIONS_PLAYLIST

205
#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
206
                            "*.jss;*.psb"
Clément Stenac's avatar
Clément Stenac committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

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

/**
 * This structure describes a piece of interaction with the user
 */
struct interaction_dialog_t
{
    int             i_id;               ///< Unique ID
    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
232
    bool      b_cancelled;        ///< was the dialogue cancelled ?
Clément Stenac's avatar
Clément Stenac committed
233 234 235 236 237 238 239 240 241 242 243 244

    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

    interaction_t  *p_interaction;      ///< Parent interaction object
    vlc_object_t   *p_parent;           ///< The vlc object that asked
                                        //for interaction
};
245

Clément Stenac's avatar
Clément Stenac committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 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 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_WARNING              0x40
#define DIALOG_USER_PROGRESS        0x80
#define DIALOG_INTF_PROGRESS        0x100

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

/** Possible status  */
enum
{
    NEW_DIALOG,                 ///< Just created
    SENT_DIALOG,                ///< Sent to interface
    UPDATED_DIALOG,             ///< Update to send
    ANSWERED_DIALOG,            ///< Got "answer"
    HIDING_DIALOG,              ///< Hiding requested
    HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
    DESTROYED_DIALOG,           ///< Interface has destroyed it
};

/** Possible interaction types */
enum
{
    INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
    INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
};

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

/**
 * This structure contains the active interaction dialogs, and is
 * used by the manager
 */
struct interaction_t
{
    VLC_COMMON_MEMBERS

    int                         i_dialogs;      ///< Number of dialogs
    interaction_dialog_t      **pp_dialogs;     ///< Dialogs
    intf_thread_t              *p_intf;         ///< Interface to use
    int                         i_last_id;      ///< Last attributed ID
};

/***************************************************************************
 * Exported symbols
 ***************************************************************************/

#define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
315
VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) ATTRIBUTE_FORMAT( 4, 5 ) );
Clément Stenac's avatar
Clément Stenac committed
316
#define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
317
VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) ATTRIBUTE_FORMAT( 3, 4 ) );
Clément Stenac's avatar
Clément Stenac committed
318 319 320 321 322 323 324 325 326 327 328 329 330
#define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
#define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
#define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );

#define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
#define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
#define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
#define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
331
VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
Clément Stenac's avatar
Clément Stenac committed
332 333 334 335 336 337 338 339 340 341
#define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));

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

# ifdef __cplusplus
}
# endif
#endif