git.sesse.net Git - vlc/blob - include/vlc_interface.h

   1 /*****************************************************************************
   2  * vlc_interface.h: interface access for other threads
   3  * This library provides basic functions for threads to interact with user
   4  * interface, such as message output.
   5  *****************************************************************************
   6  * Copyright (C) 1999, 2000 the VideoLAN team
   7  * $Id$
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef _VLC_INTF_H_
  27 #define _VLC_INTF_H_
  28
  29 # ifdef __cplusplus
  30 extern "C" {
  31 # endif
  32
  33 typedef struct intf_dialog_args_t intf_dialog_args_t;
  34
  35 /**
  36  * \file
  37  * This file contains structures and function prototypes for
  38  * interface management in vlc
  39  */
  40
  41 /**
  42  * \defgroup vlc_interface Interface
  43  * These functions and structures are for interface management
  44  * @{
  45  */
  46
  47 /** Describe all interface-specific data of the interface thread */
  48 struct intf_thread_t
  49 {
  50     VLC_COMMON_MEMBERS
  51
  52     /* Thread properties and locks */
  53     vlc_bool_t          b_block;
  54     vlc_bool_t          b_play;
  55
  56     /* Specific interfaces */
  57     intf_console_t *    p_console;                               /** console */
  58     intf_sys_t *        p_sys;                          /** system interface */
  59
  60     /** Interface module */
  61     module_t *   p_module;
  62     void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
  63
  64     /** Specific for dialogs providers */
  65     void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
  66                                intf_dialog_args_t * );
  67
  68     /** Interaction stuff */
  69     vlc_bool_t b_interaction;
  70
  71     /** Video window callbacks */
  72     void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *,
  73                                     int *, int *,
  74                                     unsigned int *, unsigned int * );
  75     void   ( *pf_release_window ) ( intf_thread_t *, void * );
  76     int    ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list );
  77
  78     /* XXX: new message passing stuff will go here */
  79     vlc_mutex_t  change_lock;
  80     vlc_bool_t   b_menu_change;
  81     vlc_bool_t   b_menu;
  82
  83     /* Provides the ability to switch an interface on the fly */
  84     char *psz_switch_intf;
  85 };
  86
  87 /** \brief Arguments passed to a dialogs provider
  88  *  This describes the arguments passed to the dialogs provider. They are
  89  *  mainly iused with INTF_DIALOG_FILE_GENERIC
  90  */
  91 struct intf_dialog_args_t
  92 {
  93     intf_thread_t *p_intf;
  94     char *psz_title;
  95
  96     char **psz_results;
  97     int  i_results;
  98
  99     void (*pf_callback) ( intf_dialog_args_t * );
 100     void *p_arg;
 101
 102     /* Specifically for INTF_DIALOG_FILE_GENERIC */
 103     char *psz_extensions;
 104     vlc_bool_t b_save;
 105     vlc_bool_t b_multiple;
 106
 107     /* Specific to INTF_DIALOG_INTERACTION */
 108     interaction_dialog_t *p_dialog;
 109 };
 110
 111 /*****************************************************************************
 112  * Prototypes
 113  *****************************************************************************/
 114 #define intf_Create(a,b,c,d) __intf_Create(VLC_OBJECT(a),b,c,d)
 115 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char *, int, const char *const * ) );
 116 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
 117 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
 118 VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
 119
 120 /* If the interface is in the main thread, it should listen both to
 121  * p_intf->b_die and p_libvlc->b_die */
 122 #define intf_ShouldDie( p_intf ) (p_intf->b_die || (p_intf->b_block && p_intf->p_libvlc->b_die ) )
 123
 124 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
 125 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
 126
 127 /*@}*/
 128
 129 /*****************************************************************************
 130  * Macros
 131  *****************************************************************************/
 132 #if defined( WIN32 ) && !defined( UNDER_CE )
 133 #    define CONSOLE_INTRO_MSG \
 134          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
 135          { \
 136          AllocConsole(); \
 137          freopen( "CONOUT$", "w", stdout ); \
 138          freopen( "CONOUT$", "w", stderr ); \
 139          freopen( "CONIN$", "r", stdin ); \
 140          } \
 141          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
 142          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
 143                              "anymore, open a command-line window, go to the " \
 144                              "directory where you installed VLC and run " \
 145                              "\"vlc -I wx\"\n") )
 146 #else
 147 #    define CONSOLE_INTRO_MSG
 148 #endif
 149
 150 /* Interface dialog ids for dialog providers */
 151 #define INTF_DIALOG_FILE_SIMPLE 1
 152 #define INTF_DIALOG_FILE        2
 153 #define INTF_DIALOG_DISC        3
 154 #define INTF_DIALOG_NET         4
 155 #define INTF_DIALOG_CAPTURE     5
 156 #define INTF_DIALOG_SAT         6
 157 #define INTF_DIALOG_DIRECTORY   7
 158
 159 #define INTF_DIALOG_STREAMWIZARD 8
 160 #define INTF_DIALOG_WIZARD 9
 161
 162 #define INTF_DIALOG_PLAYLIST   10
 163 #define INTF_DIALOG_MESSAGES   11
 164 #define INTF_DIALOG_FILEINFO   12
 165 #define INTF_DIALOG_PREFS      13
 166 #define INTF_DIALOG_BOOKMARKS  14
 167
 168 #define INTF_DIALOG_POPUPMENU  20
 169 #define INTF_DIALOG_AUDIOPOPUPMENU  21
 170 #define INTF_DIALOG_VIDEOPOPUPMENU  22
 171 #define INTF_DIALOG_MISCPOPUPMENU  23
 172
 173 #define INTF_DIALOG_FILE_GENERIC 30
 174 #define INTF_DIALOG_INTERACTION 50
 175
 176 #define INTF_DIALOG_UPDATEVLC   90
 177 #define INTF_DIALOG_VLM   91
 178
 179 #define INTF_DIALOG_EXIT       99
 180
 181 /* Useful text messages shared by interfaces */
 182 #define INTF_ABOUT_MSG LICENSE_MSG
 183
 184 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
 185                          "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.spx;*.wav;*.wma;*.xm"
 186
 187 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.m1v;*.m2v;*.m4v;*.mkv;" \
 188                          "*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;*.mpeg2;*.mpeg4;" \
 189                          "*.mpg;*.ogg;*.ogm;*.ps;*.ts;*.vob;*.wmv"
 190
 191 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
 192
 193 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
 194                           EXTENSIONS_PLAYLIST
 195
 196 #define EXTENSIONS_SUBTITLE "*.idx;*.srt;*.sub;*.utf"
 197
 198 /** \defgroup vlc_interaction Interaction
 199  * \ingroup vlc_interface
 200  * Interaction between user and modules
 201  * @{
 202  */
 203
 204 /**
 205  * This structure describes a piece of interaction with the user
 206  */
 207 struct interaction_dialog_t
 208 {
 209     int             i_id;               ///< Unique ID
 210     int             i_type;             ///< Type identifier
 211     char           *psz_title;          ///< Title
 212     char           *psz_description;    ///< Descriptor string
 213     char           *psz_default_button;  ///< default button title (~OK)
 214     char           *psz_alternate_button;///< alternate button title (~NO)
 215     /// other button title (optional,~Cancel)
 216     char           *psz_other_button;
 217
 218     char           *psz_returned[1];    ///< returned responses from the user
 219
 220     vlc_value_t     val;                ///< value coming from core for dialogue
 221     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
 222     vlc_bool_t      b_cancelled;        ///< was the dialogue cancelled ?
 223
 224     void *          p_private;          ///< Private interface data
 225
 226     int             i_status;           ///< Dialog status;
 227     int             i_action;           ///< Action to perform;
 228     int             i_flags;            ///< Misc flags
 229     int             i_return;           ///< Return status
 230
 231     interaction_t  *p_interaction;      ///< Parent interaction object
 232     vlc_object_t   *p_parent;           ///< The vlc object that asked
 233                                         //for interaction
 234 };
 235 /**
 236  * Possible flags . Dialog types
 237  */
 238 #define DIALOG_GOT_ANSWER           0x01
 239 #define DIALOG_YES_NO_CANCEL        0x02
 240 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
 241 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
 242 #define DIALOG_BLOCKING_ERROR       0x10
 243 #define DIALOG_NONBLOCKING_ERROR    0x20
 244 #define DIALOG_WARNING              0x40
 245 #define DIALOG_USER_PROGRESS        0x80
 246 #define DIALOG_INTF_PROGRESS        0x100
 247
 248 /** Possible return codes */
 249 enum
 250 {
 251     DIALOG_DEFAULT,
 252     DIALOG_OK_YES,
 253     DIALOG_NO,
 254     DIALOG_CANCELLED
 255 };
 256
 257 /** Possible status  */
 258 enum
 259 {
 260     NEW_DIALOG,                 ///< Just created
 261     SENT_DIALOG,                ///< Sent to interface
 262     UPDATED_DIALOG,             ///< Update to send
 263     ANSWERED_DIALOG,            ///< Got "answer"
 264     HIDING_DIALOG,              ///< Hiding requested
 265     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
 266     DESTROYED_DIALOG,           ///< Interface has destroyed it
 267 };
 268
 269 /** Possible interaction types */
 270 enum
 271 {
 272     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
 273     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
 274 };
 275
 276 /** Possible actions */
 277 enum
 278 {
 279     INTERACT_NEW,
 280     INTERACT_UPDATE,
 281     INTERACT_HIDE,
 282     INTERACT_DESTROY
 283 };
 284
 285 /**
 286  * This structure contains the active interaction dialogs, and is
 287  * used by the manager
 288  */
 289 struct interaction_t
 290 {
 291     VLC_COMMON_MEMBERS
 292
 293     int                         i_dialogs;      ///< Number of dialogs
 294     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
 295     intf_thread_t              *p_intf;         ///< Interface to use
 296     int                         i_last_id;      ///< Last attributed ID
 297 };
 298
 299 /***************************************************************************
 300  * Exported symbols
 301  ***************************************************************************/
 302
 303 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
 304 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, vlc_bool_t, const char*, const char*, ...) );
 305 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
 306 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) );
 307 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
 308 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
 309 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
 310 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
 311 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
 312 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
 313
 314 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
 315 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
 316 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
 317 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
 318 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
 319 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
 320 VLC_EXPORT( vlc_bool_t, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
 321 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
 322 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
 323
 324 /** @} */
 325 /** @} */
 326
 327 # ifdef __cplusplus
 328 }
 329 # endif
 330 #endif