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     bool          b_should_run_on_first_thread;
  54
  55     /* Specific interfaces */
  56     intf_console_t *    p_console;                               /** console */
  57     intf_sys_t *        p_sys;                          /** system interface */
  58     char *              psz_intf;                    /** intf name specified */
  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     bool b_interaction;
  70
  71     /* XXX: new message passing stuff will go here */
  72     vlc_mutex_t  change_lock;
  73     bool   b_menu_change;
  74     bool   b_menu;
  75
  76     /* Provides the ability to switch an interface on the fly */
  77     char *psz_switch_intf;
  78 };
  79
  80 /** \brief Arguments passed to a dialogs provider
  81  *  This describes the arguments passed to the dialogs provider. They are
  82  *  mainly used with INTF_DIALOG_FILE_GENERIC.
  83  */
  84 struct intf_dialog_args_t
  85 {
  86     intf_thread_t *p_intf;
  87     char *psz_title;
  88
  89     char **psz_results;
  90     int  i_results;
  91
  92     void (*pf_callback) ( intf_dialog_args_t * );
  93     void *p_arg;
  94
  95     /* Specifically for INTF_DIALOG_FILE_GENERIC */
  96     char *psz_extensions;
  97     bool b_save;
  98     bool b_multiple;
  99
 100     /* Specific to INTF_DIALOG_INTERACTION */
 101     interaction_dialog_t *p_dialog;
 102 };
 103
 104 /*****************************************************************************
 105  * Prototypes
 106  *****************************************************************************/
 107 #define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
 108 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
 109 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
 110 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
 111
 112 /* If the interface is in the main thread, it should listen both to
 113  * p_intf->b_die and p_libvlc->b_die */
 114 #define intf_ShouldDie( p_intf ) (p_intf->b_die || p_intf->p_libvlc->b_die )
 115
 116 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
 117 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
 118
 119 /*@}*/
 120
 121 /*****************************************************************************
 122  * Macros
 123  *****************************************************************************/
 124 #if defined( WIN32 ) && !defined( UNDER_CE )
 125 #    define CONSOLE_INTRO_MSG \
 126          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
 127          { \
 128          AllocConsole(); \
 129          freopen( "CONOUT$", "w", stdout ); \
 130          freopen( "CONOUT$", "w", stderr ); \
 131          freopen( "CONIN$", "r", stdin ); \
 132          } \
 133          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
 134          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
 135                              "anymore, open a command-line window, go to the " \
 136                              "directory where you installed VLC and run " \
 137                              "\"vlc -I wx\"\n") )
 138 #else
 139 #    define CONSOLE_INTRO_MSG
 140 #endif
 141
 142 /* Interface dialog ids for dialog providers */
 143 typedef enum vlc_dialog {
 144     INTF_DIALOG_FILE_SIMPLE = 1,
 145     INTF_DIALOG_FILE,
 146     INTF_DIALOG_DISC,
 147     INTF_DIALOG_NET,
 148     INTF_DIALOG_CAPTURE,
 149     INTF_DIALOG_SAT,
 150     INTF_DIALOG_DIRECTORY,
 151
 152     INTF_DIALOG_STREAMWIZARD,
 153     INTF_DIALOG_WIZARD,
 154
 155     INTF_DIALOG_PLAYLIST,
 156     INTF_DIALOG_MESSAGES,
 157     INTF_DIALOG_FILEINFO,
 158     INTF_DIALOG_PREFS,
 159     INTF_DIALOG_BOOKMARKS,
 160     INTF_DIALOG_EXTENDED,
 161
 162     INTF_DIALOG_POPUPMENU = 20,
 163     INTF_DIALOG_AUDIOPOPUPMENU,
 164     INTF_DIALOG_VIDEOPOPUPMENU,
 165     INTF_DIALOG_MISCPOPUPMENU,
 166
 167     INTF_DIALOG_FILE_GENERIC = 30,
 168     INTF_DIALOG_INTERACTION = 50,
 169
 170     INTF_DIALOG_UPDATEVLC = 90,
 171     INTF_DIALOG_VLM,
 172
 173     INTF_DIALOG_EXIT = 99
 174 } vlc_dialog_t;
 175
 176 /* Useful text messages shared by interfaces */
 177 #define INTF_ABOUT_MSG LICENSE_MSG
 178
 179 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
 180                          "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.oma;*.spx;" \
 181                          "*.wav;*.wma;*.xm"
 182
 183 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
 184                          "*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
 185                          "*.mpeg2;*.mpeg4;*.mpg;*.mxf;*.ogg;*.ogm;" \
 186                          "*.ps;*.ts;*.vob;*.wmv"
 187
 188 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
 189
 190 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
 191                           EXTENSIONS_PLAYLIST
 192
 193 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
 194                             "*.jss;*.psb;*.rt;*.smi"
 195
 196 /** \defgroup vlc_interaction Interaction
 197  * \ingroup vlc_interface
 198  * Interaction between user and modules
 199  * @{
 200  */
 201
 202 /**
 203  * This structure describes a piece of interaction with the user
 204  */
 205 struct interaction_dialog_t
 206 {
 207     int             i_id;               ///< Unique ID
 208     int             i_type;             ///< Type identifier
 209     char           *psz_title;          ///< Title
 210     char           *psz_description;    ///< Descriptor string
 211     char           *psz_default_button;  ///< default button title (~OK)
 212     char           *psz_alternate_button;///< alternate button title (~NO)
 213     /// other button title (optional,~Cancel)
 214     char           *psz_other_button;
 215
 216     char           *psz_returned[1];    ///< returned responses from the user
 217
 218     vlc_value_t     val;                ///< value coming from core for dialogue
 219     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
 220     bool      b_cancelled;        ///< was the dialogue cancelled ?
 221
 222     void *          p_private;          ///< Private interface data
 223
 224     int             i_status;           ///< Dialog status;
 225     int             i_action;           ///< Action to perform;
 226     int             i_flags;            ///< Misc flags
 227     int             i_return;           ///< Return status
 228
 229     interaction_t  *p_interaction;      ///< Parent interaction object
 230     vlc_object_t   *p_parent;           ///< The vlc object that asked
 231                                         //for interaction
 232 };
 233
 234 /**
 235  * Possible flags . Dialog types
 236  */
 237 #define DIALOG_GOT_ANSWER           0x01
 238 #define DIALOG_YES_NO_CANCEL        0x02
 239 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
 240 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
 241 #define DIALOG_BLOCKING_ERROR       0x10
 242 #define DIALOG_NONBLOCKING_ERROR    0x20
 243 #define DIALOG_WARNING              0x40
 244 #define DIALOG_USER_PROGRESS        0x80
 245 #define DIALOG_INTF_PROGRESS        0x100
 246
 247 /** Possible return codes */
 248 enum
 249 {
 250     DIALOG_DEFAULT,
 251     DIALOG_OK_YES,
 252     DIALOG_NO,
 253     DIALOG_CANCELLED
 254 };
 255
 256 /** Possible status  */
 257 enum
 258 {
 259     NEW_DIALOG,                 ///< Just created
 260     SENT_DIALOG,                ///< Sent to interface
 261     UPDATED_DIALOG,             ///< Update to send
 262     ANSWERED_DIALOG,            ///< Got "answer"
 263     HIDING_DIALOG,              ///< Hiding requested
 264     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
 265     DESTROYED_DIALOG,           ///< Interface has destroyed it
 266 };
 267
 268 /** Possible interaction types */
 269 enum
 270 {
 271     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
 272     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
 273 };
 274
 275 /** Possible actions */
 276 enum
 277 {
 278     INTERACT_NEW,
 279     INTERACT_UPDATE,
 280     INTERACT_HIDE,
 281     INTERACT_DESTROY
 282 };
 283
 284 /**
 285  * This structure contains the active interaction dialogs, and is
 286  * used by the manager
 287  */
 288 struct interaction_t
 289 {
 290     VLC_COMMON_MEMBERS
 291
 292     int                         i_dialogs;      ///< Number of dialogs
 293     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
 294     intf_thread_t              *p_intf;         ///< Interface to use
 295     int                         i_last_id;      ///< Last attributed ID
 296 };
 297
 298 /***************************************************************************
 299  * Exported symbols
 300  ***************************************************************************/
 301
 302 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
 303 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) LIBVLC_FORMAT( 4, 5 ) );
 304 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
 305 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) LIBVLC_FORMAT( 3, 4 ) );
 306 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
 307 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
 308 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
 309 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
 310 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
 311 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
 312
 313 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
 314 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
 315 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
 316 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
 317 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
 318 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
 319 VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
 320 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
 321 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
 322
 323 /** @} */
 324 /** @} */
 325
 326 # ifdef __cplusplus
 327 }
 328 # endif
 329 #endif