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