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