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