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