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 #if !defined( __LIBVLC__ )
  27   #error You are not libvlc or one of its plugins. You cannot include this file
  28 #endif
  29
  30 #ifndef _VLC_INTF_H_
  31 #define _VLC_INTF_H_
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 typedef struct intf_dialog_args_t intf_dialog_args_t;
  38
  39 /**
  40  * \file
  41  * This file contains structures and function prototypes for
  42  * interface management in vlc
  43  */
  44
  45 /**
  46  * \defgroup vlc_interface Interface
  47  * These functions and structures are for interface management
  48  * @{
  49  */
  50
  51 /** Describe all interface-specific data of the interface thread */
  52 struct intf_thread_t
  53 {
  54     VLC_COMMON_MEMBERS
  55
  56     /* Thread properties and locks */
  57     vlc_bool_t          b_block;
  58     vlc_bool_t          b_play;
  59
  60     /* Specific interfaces */
  61     intf_console_t *    p_console;                               /** console */
  62     intf_sys_t *        p_sys;                          /** system interface */
  63
  64     /** Interface module */
  65     module_t *   p_module;
  66     void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
  67
  68     /** Specific for dialogs providers */
  69     void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
  70                                intf_dialog_args_t * );
  71
  72     /** Interaction stuff */
  73     vlc_bool_t b_interaction;
  74
  75     /** Video window callbacks */
  76     void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *,
  77                                     int *, int *,
  78                                     unsigned int *, unsigned int * );
  79     void   ( *pf_release_window ) ( intf_thread_t *, void * );
  80     int    ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list );
  81
  82     /* XXX: new message passing stuff will go here */
  83     vlc_mutex_t  change_lock;
  84     vlc_bool_t   b_menu_change;
  85     vlc_bool_t   b_menu;
  86
  87     /* Provides the ability to switch an interface on the fly */
  88     char *psz_switch_intf;
  89 };
  90
  91 /** \brief Arguments passed to a dialogs provider
  92  *  This describes the arguments passed to the dialogs provider. They are
  93  *  mainly used with INTF_DIALOG_FILE_GENERIC.
  94  */
  95 struct intf_dialog_args_t
  96 {
  97     intf_thread_t *p_intf;
  98     char *psz_title;
  99
 100     char **psz_results;
 101     int  i_results;
 102
 103     void (*pf_callback) ( intf_dialog_args_t * );
 104     void *p_arg;
 105
 106     /* Specifically for INTF_DIALOG_FILE_GENERIC */
 107     char *psz_extensions;
 108     vlc_bool_t b_save;
 109     vlc_bool_t b_multiple;
 110
 111     /* Specific to INTF_DIALOG_INTERACTION */
 112     interaction_dialog_t *p_dialog;
 113 };
 114
 115 /*****************************************************************************
 116  * Prototypes
 117  *****************************************************************************/
 118 #define intf_Create(a,b,c,d) __intf_Create(VLC_OBJECT(a),b,c,d)
 119 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char *, int, const char *const * ) );
 120 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
 121 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
 122 VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
 123
 124 /* If the interface is in the main thread, it should listen both to
 125  * p_intf->b_die and p_libvlc->b_die */
 126 #define intf_ShouldDie( p_intf ) (p_intf->b_die || (p_intf->b_block && p_intf->p_libvlc->b_die ) )
 127
 128 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
 129 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
 130
 131 /*@}*/
 132
 133 /*****************************************************************************
 134  * Macros
 135  *****************************************************************************/
 136 #if defined( WIN32 ) && !defined( UNDER_CE )
 137 #    define CONSOLE_INTRO_MSG \
 138          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
 139          { \
 140          AllocConsole(); \
 141          freopen( "CONOUT$", "w", stdout ); \
 142          freopen( "CONOUT$", "w", stderr ); \
 143          freopen( "CONIN$", "r", stdin ); \
 144          } \
 145          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
 146          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
 147                              "anymore, open a command-line window, go to the " \
 148                              "directory where you installed VLC and run " \
 149                              "\"vlc -I wx\"\n") )
 150 #else
 151 #    define CONSOLE_INTRO_MSG
 152 #endif
 153
 154 /* Interface dialog ids for dialog providers */
 155 #define INTF_DIALOG_FILE_SIMPLE 1
 156 #define INTF_DIALOG_FILE        2
 157 #define INTF_DIALOG_DISC        3
 158 #define INTF_DIALOG_NET         4
 159 #define INTF_DIALOG_CAPTURE     5
 160 #define INTF_DIALOG_SAT         6
 161 #define INTF_DIALOG_DIRECTORY   7
 162
 163 #define INTF_DIALOG_STREAMWIZARD 8
 164 #define INTF_DIALOG_WIZARD 9
 165
 166 #define INTF_DIALOG_PLAYLIST   10
 167 #define INTF_DIALOG_MESSAGES   11
 168 #define INTF_DIALOG_FILEINFO   12
 169 #define INTF_DIALOG_PREFS      13
 170 #define INTF_DIALOG_BOOKMARKS  14
 171 #define INTF_DIALOG_EXTENDED   15
 172
 173 #define INTF_DIALOG_POPUPMENU  20
 174 #define INTF_DIALOG_AUDIOPOPUPMENU  21
 175 #define INTF_DIALOG_VIDEOPOPUPMENU  22
 176 #define INTF_DIALOG_MISCPOPUPMENU  23
 177
 178 #define INTF_DIALOG_FILE_GENERIC 30
 179 #define INTF_DIALOG_INTERACTION 50
 180
 181 #define INTF_DIALOG_UPDATEVLC   90
 182 #define INTF_DIALOG_VLM   91
 183
 184 #define INTF_DIALOG_EXIT       99
 185
 186 /* Useful text messages shared by interfaces */
 187 #define INTF_ABOUT_MSG LICENSE_MSG
 188
 189 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
 190                          "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.spx;*.wav;*.wma;*.xm"
 191
 192 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.m1v;*.m2v;*.m4v;*.mkv;" \
 193                          "*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;*.mpeg2;*.mpeg4;" \
 194                          "*.mpg;*.ogg;*.ogm;*.ps;*.ts;*.vob;*.wmv"
 195
 196 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
 197
 198 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
 199                           EXTENSIONS_PLAYLIST
 200
 201 #define EXTENSIONS_SUBTITLE "*.idx;*.srt;*.sub;*.utf"
 202
 203 /** \defgroup vlc_interaction Interaction
 204  * \ingroup vlc_interface
 205  * Interaction between user and modules
 206  * @{
 207  */
 208
 209 /**
 210  * This structure describes a piece of interaction with the user
 211  */
 212 struct interaction_dialog_t
 213 {
 214     int             i_id;               ///< Unique ID
 215     int             i_type;             ///< Type identifier
 216     char           *psz_title;          ///< Title
 217     char           *psz_description;    ///< Descriptor string
 218     char           *psz_default_button;  ///< default button title (~OK)
 219     char           *psz_alternate_button;///< alternate button title (~NO)
 220     /// other button title (optional,~Cancel)
 221     char           *psz_other_button;
 222
 223     char           *psz_returned[1];    ///< returned responses from the user
 224
 225     vlc_value_t     val;                ///< value coming from core for dialogue
 226     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
 227     vlc_bool_t      b_cancelled;        ///< was the dialogue cancelled ?
 228
 229     void *          p_private;          ///< Private interface data
 230
 231     int             i_status;           ///< Dialog status;
 232     int             i_action;           ///< Action to perform;
 233     int             i_flags;            ///< Misc flags
 234     int             i_return;           ///< Return status
 235
 236     interaction_t  *p_interaction;      ///< Parent interaction object
 237     vlc_object_t   *p_parent;           ///< The vlc object that asked
 238                                         //for interaction
 239 };
 240 /**
 241  * Possible flags . Dialog types
 242  */
 243 #define DIALOG_GOT_ANSWER           0x01
 244 #define DIALOG_YES_NO_CANCEL        0x02
 245 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
 246 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
 247 #define DIALOG_BLOCKING_ERROR       0x10
 248 #define DIALOG_NONBLOCKING_ERROR    0x20
 249 #define DIALOG_WARNING              0x40
 250 #define DIALOG_USER_PROGRESS        0x80
 251 #define DIALOG_INTF_PROGRESS        0x100
 252
 253 /** Possible return codes */
 254 enum
 255 {
 256     DIALOG_DEFAULT,
 257     DIALOG_OK_YES,
 258     DIALOG_NO,
 259     DIALOG_CANCELLED
 260 };
 261
 262 /** Possible status  */
 263 enum
 264 {
 265     NEW_DIALOG,                 ///< Just created
 266     SENT_DIALOG,                ///< Sent to interface
 267     UPDATED_DIALOG,             ///< Update to send
 268     ANSWERED_DIALOG,            ///< Got "answer"
 269     HIDING_DIALOG,              ///< Hiding requested
 270     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
 271     DESTROYED_DIALOG,           ///< Interface has destroyed it
 272 };
 273
 274 /** Possible interaction types */
 275 enum
 276 {
 277     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
 278     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
 279 };
 280
 281 /** Possible actions */
 282 enum
 283 {
 284     INTERACT_NEW,
 285     INTERACT_UPDATE,
 286     INTERACT_HIDE,
 287     INTERACT_DESTROY
 288 };
 289
 290 /**
 291  * This structure contains the active interaction dialogs, and is
 292  * used by the manager
 293  */
 294 struct interaction_t
 295 {
 296     VLC_COMMON_MEMBERS
 297
 298     int                         i_dialogs;      ///< Number of dialogs
 299     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
 300     intf_thread_t              *p_intf;         ///< Interface to use
 301     int                         i_last_id;      ///< Last attributed ID
 302 };
 303
 304 /***************************************************************************
 305  * Exported symbols
 306  ***************************************************************************/
 307
 308 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
 309 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, vlc_bool_t, const char*, const char*, ...) );
 310 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
 311 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) );
 312 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
 313 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
 314 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
 315 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
 316 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
 317 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
 318
 319 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
 320 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
 321 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
 322 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
 323 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
 324 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
 325 VLC_EXPORT( vlc_bool_t, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
 326 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
 327 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
 328
 329 /** @} */
 330 /** @} */
 331
 332 # ifdef __cplusplus
 333 }
 334 # endif
 335 #endif