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     vlc_thread_t thread; /** LibVLC thread */
  56     /* Thread properties and locks */
  57 #if defined( __APPLE__ )
  58     bool          b_should_run_on_first_thread;
  59 #endif
  60
  61     /* Specific interfaces */
  62     intf_sys_t *        p_sys;                          /** system interface */
  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_API int intf_Create( vlc_object_t *, const char * );
 103 #define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b)
 104
 105 VLC_API int intf_Eject( vlc_object_t *, const char * );
 106 #define intf_Eject(a,b) intf_Eject(VLC_OBJECT(a),b)
 107
 108 VLC_API 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" ) ) /* detect Cygwin shell or Wine */ \
 118          { \
 119          AllocConsole(); \
 120          freopen( "CONOUT$", "w", stdout ); \
 121          freopen( "CONOUT$", "w", stderr ); \
 122          freopen( "CONIN$", "r", stdin ); \
 123          } \
 124          msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \
 125          msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \
 126          msg_Info( p_intf, _("\nWarning: if you cannot access the GUI " \
 127                              "anymore, open a command-line window, go to the " \
 128                              "directory where you installed VLC and run " \
 129                              "\"vlc -I qt\"\n") )
 130 #else
 131 #    define CONSOLE_INTRO_MSG (void)0
 132 #endif
 133
 134 /* Interface dialog ids for dialog providers */
 135 typedef enum vlc_dialog {
 136     INTF_DIALOG_FILE_SIMPLE = 1,
 137     INTF_DIALOG_FILE,
 138     INTF_DIALOG_DISC,
 139     INTF_DIALOG_NET,
 140     INTF_DIALOG_CAPTURE,
 141     INTF_DIALOG_SAT,
 142     INTF_DIALOG_DIRECTORY,
 143
 144     INTF_DIALOG_STREAMWIZARD,
 145     INTF_DIALOG_WIZARD,
 146
 147     INTF_DIALOG_PLAYLIST,
 148     INTF_DIALOG_MESSAGES,
 149     INTF_DIALOG_FILEINFO,
 150     INTF_DIALOG_PREFS,
 151     INTF_DIALOG_BOOKMARKS,
 152     INTF_DIALOG_EXTENDED,
 153
 154     INTF_DIALOG_POPUPMENU = 20,
 155     INTF_DIALOG_AUDIOPOPUPMENU,
 156     INTF_DIALOG_VIDEOPOPUPMENU,
 157     INTF_DIALOG_MISCPOPUPMENU,
 158
 159     INTF_DIALOG_FILE_GENERIC = 30,
 160     INTF_DIALOG_INTERACTION = 50,
 161
 162     INTF_DIALOG_UPDATEVLC = 90,
 163     INTF_DIALOG_VLM,
 164
 165     INTF_DIALOG_EXIT = 99
 166 } vlc_dialog_t;
 167
 168 /* Useful text messages shared by interfaces */
 169 #define INTF_ABOUT_MSG LICENSE_MSG
 170
 171 #define EXTENSIONS_AUDIO_CSV "a52", "aac", "ac3", "ape", "awb", "dts", "flac", "it", \
 172                          "m4a", "m4p", "mka", "mlp", "mod", "mp1", "mp2", "mp3",\
 173                          "oga", "ogg", "oma", "s3m", "spx" \
 174                          "wav", "wma", "wv", "xm"
 175
 176 #define EXTENSIONS_VIDEO_CSV "asf", "avi", "divx", "dv", "f4v", "flv", "gxf", "iso", \
 177                              "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
 178                              "mp2", "mp4", "mpeg", "mpeg1", \
 179                              "mpeg2", "mpeg4", "mpg", "mts", "mtv", "mxf", "nuv", \
 180                              "ogg", "ogm", "ogv", "ogx", "ps", \
 181                              "rec", "rm", "rmvb", "ts", "vob", "wmv"
 182
 183 #define EXTENSIONS_AUDIO \
 184     "*.a52;" \
 185     "*.aac;" \
 186     "*.ac3;" \
 187     "*.adt;" \
 188     "*.adts;" \
 189     "*.aif;"\
 190     "*.aifc;"\
 191     "*.aiff;"\
 192     "*.amr;" \
 193     "*.aob;" \
 194     "*.ape;" \
 195     "*.awb;" \
 196     "*.caf;" \
 197     "*.cda;" \
 198     "*.dts;" \
 199     "*.flac;"\
 200     "*.it;"  \
 201     "*.m4a;" \
 202     "*.m4p;" \
 203     "*.mid;" \
 204     "*.mka;" \
 205     "*.mlp;" \
 206     "*.mod;" \
 207     "*.mp1;" \
 208     "*.mp2;" \
 209     "*.mp3;" \
 210     "*.mpc;" \
 211     "*.oga;" \
 212     "*.ogg;" \
 213     "*.oma;" \
 214     "*.rmi;" \
 215     "*.s3m;" \
 216     "*.spx;" \
 217     "*.tta;" \
 218     "*.voc;" \
 219     "*.vqf;" \
 220     "*.w64;" \
 221     "*.wav;" \
 222     "*.wma;" \
 223     "*.wv;"  \
 224     "*.xa;"  \
 225     "*.xm"
 226
 227 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.divx;*.dv;*f4v;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \
 228                          "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \
 229                          "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.nsv;*.nuv;" \
 230                          "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
 231                          "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wmv"
 232
 233 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.zip"
 234
 235 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
 236                           EXTENSIONS_PLAYLIST
 237
 238 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
 239                             "*.sub;*.utf;*.ass;" \
 240                             "*.ssa;*.aqt;" \
 241                             "*.jss;*.psb;" \
 242                             "*.rt;*.smi;*.txt;" \
 243                             "*.smil;*.stl;*.usf" \
 244                             "*.dks;*.pjs;*.mpl2"
 245
 246 /** \defgroup vlc_interaction Interaction
 247  * \ingroup vlc_interface
 248  * Interaction between user and modules
 249  * @{
 250  */
 251
 252 /**
 253  * This structure describes a piece of interaction with the user
 254  */
 255 typedef struct interaction_dialog_t
 256 {
 257     int             i_type;             ///< Type identifier
 258     char           *psz_title;          ///< Title
 259     char           *psz_description;    ///< Descriptor string
 260     char           *psz_default_button;  ///< default button title (~OK)
 261     char           *psz_alternate_button;///< alternate button title (~NO)
 262     /// other button title (optional,~Cancel)
 263     char           *psz_other_button;
 264
 265     char           *psz_returned[1];    ///< returned responses from the user
 266
 267     vlc_value_t     val;                ///< value coming from core for dialogue
 268     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
 269     bool      b_cancelled;        ///< was the dialogue cancelled ?
 270
 271     void *          p_private;          ///< Private interface data
 272
 273     int             i_status;           ///< Dialog status;
 274     int             i_action;           ///< Action to perform;
 275     int             i_flags;            ///< Misc flags
 276     int             i_return;           ///< Return status
 277
 278     vlc_object_t   *p_parent;           ///< The vlc object that asked
 279                                         //for interaction
 280     intf_thread_t  *p_interface;
 281     vlc_mutex_t    *p_lock;
 282 } interaction_dialog_t;
 283
 284 /**
 285  * Possible flags . Dialog types
 286  */
 287 #define DIALOG_GOT_ANSWER           0x01
 288 #define DIALOG_YES_NO_CANCEL        0x02
 289 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
 290 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
 291 #define DIALOG_BLOCKING_ERROR       0x10
 292 #define DIALOG_NONBLOCKING_ERROR    0x20
 293 #define DIALOG_USER_PROGRESS        0x80
 294 #define DIALOG_INTF_PROGRESS        0x100
 295
 296 /** Possible return codes */
 297 enum
 298 {
 299     DIALOG_OK_YES,
 300     DIALOG_NO,
 301     DIALOG_CANCELLED
 302 };
 303
 304 /** Possible status  */
 305 enum
 306 {
 307     ANSWERED_DIALOG,            ///< Got "answer"
 308     DESTROYED_DIALOG,           ///< Interface has destroyed it
 309 };
 310
 311 /** Possible actions */
 312 enum
 313 {
 314     INTERACT_NEW,
 315     INTERACT_UPDATE,
 316     INTERACT_HIDE,
 317     INTERACT_DESTROY
 318 };
 319
 320 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
 321 #define interaction_Register( t ) (t, VLC_EGENERIC)
 322 #define interaction_Unregister( t ) (t, VLC_EGENERIC)
 323
 324
 325 /** @} */
 326 /** @} */
 327
 328 # ifdef __cplusplus
 329 }
 330 # endif
 331 #endif