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     bool          b_should_run_on_first_thread;
  58
  59     /* Specific interfaces */
  60     intf_console_t *    p_console;                               /** console */
  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 )    ( 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     bool 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     bool   b_menu_change;
  85     bool   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     bool b_save;
 109     bool 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) __intf_Create(VLC_OBJECT(a),b)
 119 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
 120 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
 121 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
 122
 123 /* If the interface is in the main thread, it should listen both to
 124  * p_intf->b_die and p_libvlc->b_die */
 125 #define intf_ShouldDie( p_intf ) (p_intf->b_die || p_intf->p_libvlc->b_die )
 126
 127 #define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b)
 128 VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) );
 129
 130 /*@}*/
 131
 132 /*****************************************************************************
 133  * Macros
 134  *****************************************************************************/
 135 #if defined( WIN32 ) && !defined( UNDER_CE )
 136 #    define CONSOLE_INTRO_MSG \
 137          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
 138          { \
 139          AllocConsole(); \
 140          freopen( "CONOUT$", "w", stdout ); \
 141          freopen( "CONOUT$", "w", stderr ); \
 142          freopen( "CONIN$", "r", stdin ); \
 143          } \
 144          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
 145          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
 146                              "anymore, open a command-line window, go to the " \
 147                              "directory where you installed VLC and run " \
 148                              "\"vlc -I wx\"\n") )
 149 #else
 150 #    define CONSOLE_INTRO_MSG
 151 #endif
 152
 153 /* Interface dialog ids for dialog providers */
 154 typedef enum vlc_dialog {
 155     INTF_DIALOG_FILE_SIMPLE = 1,
 156     INTF_DIALOG_FILE,
 157     INTF_DIALOG_DISC,
 158     INTF_DIALOG_NET,
 159     INTF_DIALOG_CAPTURE,
 160     INTF_DIALOG_SAT,
 161     INTF_DIALOG_DIRECTORY,
 162
 163     INTF_DIALOG_STREAMWIZARD,
 164     INTF_DIALOG_WIZARD,
 165
 166     INTF_DIALOG_PLAYLIST,
 167     INTF_DIALOG_MESSAGES,
 168     INTF_DIALOG_FILEINFO,
 169     INTF_DIALOG_PREFS,
 170     INTF_DIALOG_BOOKMARKS,
 171     INTF_DIALOG_EXTENDED,
 172
 173     INTF_DIALOG_POPUPMENU = 20,
 174     INTF_DIALOG_AUDIOPOPUPMENU,
 175     INTF_DIALOG_VIDEOPOPUPMENU,
 176     INTF_DIALOG_MISCPOPUPMENU,
 177
 178     INTF_DIALOG_FILE_GENERIC = 30,
 179     INTF_DIALOG_INTERACTION = 50,
 180
 181     INTF_DIALOG_UPDATEVLC = 90,
 182     INTF_DIALOG_VLM,
 183
 184     INTF_DIALOG_EXIT = 99
 185 } vlc_dialog_t;
 186
 187 /* Useful text messages shared by interfaces */
 188 #define INTF_ABOUT_MSG LICENSE_MSG
 189
 190 #define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \
 191                          "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.spx;*.wav;*.wma;*.xm"
 192
 193 #define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \
 194                          "*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \
 195                          "*.mpeg2;*.mpeg4;*.mpg;*.mxf;*.ogg;*.ogm;" \
 196                          "*.ps;*.ts;*.vob;*.wmv"
 197
 198 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf"
 199
 200 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
 201                           EXTENSIONS_PLAYLIST
 202
 203 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \
 204                             "*.jss;*.psb;*.rt;*.smi"
 205
 206 /** \defgroup vlc_interaction Interaction
 207  * \ingroup vlc_interface
 208  * Interaction between user and modules
 209  * @{
 210  */
 211
 212 /**
 213  * This structure describes a piece of interaction with the user
 214  */
 215 struct interaction_dialog_t
 216 {
 217     int             i_id;               ///< Unique ID
 218     int             i_type;             ///< Type identifier
 219     char           *psz_title;          ///< Title
 220     char           *psz_description;    ///< Descriptor string
 221     char           *psz_default_button;  ///< default button title (~OK)
 222     char           *psz_alternate_button;///< alternate button title (~NO)
 223     /// other button title (optional,~Cancel)
 224     char           *psz_other_button;
 225
 226     char           *psz_returned[1];    ///< returned responses from the user
 227
 228     vlc_value_t     val;                ///< value coming from core for dialogue
 229     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
 230     bool      b_cancelled;        ///< was the dialogue cancelled ?
 231
 232     void *          p_private;          ///< Private interface data
 233
 234     int             i_status;           ///< Dialog status;
 235     int             i_action;           ///< Action to perform;
 236     int             i_flags;            ///< Misc flags
 237     int             i_return;           ///< Return status
 238
 239     interaction_t  *p_interaction;      ///< Parent interaction object
 240     vlc_object_t   *p_parent;           ///< The vlc object that asked
 241                                         //for interaction
 242 };
 243
 244 /**
 245  * Possible flags . Dialog types
 246  */
 247 #define DIALOG_GOT_ANSWER           0x01
 248 #define DIALOG_YES_NO_CANCEL        0x02
 249 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
 250 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
 251 #define DIALOG_BLOCKING_ERROR       0x10
 252 #define DIALOG_NONBLOCKING_ERROR    0x20
 253 #define DIALOG_WARNING              0x40
 254 #define DIALOG_USER_PROGRESS        0x80
 255 #define DIALOG_INTF_PROGRESS        0x100
 256
 257 /** Possible return codes */
 258 enum
 259 {
 260     DIALOG_DEFAULT,
 261     DIALOG_OK_YES,
 262     DIALOG_NO,
 263     DIALOG_CANCELLED
 264 };
 265
 266 /** Possible status  */
 267 enum
 268 {
 269     NEW_DIALOG,                 ///< Just created
 270     SENT_DIALOG,                ///< Sent to interface
 271     UPDATED_DIALOG,             ///< Update to send
 272     ANSWERED_DIALOG,            ///< Got "answer"
 273     HIDING_DIALOG,              ///< Hiding requested
 274     HIDDEN_DIALOG,              ///< Now hidden. Requesting destruction
 275     DESTROYED_DIALOG,           ///< Interface has destroyed it
 276 };
 277
 278 /** Possible interaction types */
 279 enum
 280 {
 281     INTERACT_DIALOG_ONEWAY,     ///< Dialog box without feedback
 282     INTERACT_DIALOG_TWOWAY,     ///< Dialog box with feedback
 283 };
 284
 285 /** Possible actions */
 286 enum
 287 {
 288     INTERACT_NEW,
 289     INTERACT_UPDATE,
 290     INTERACT_HIDE,
 291     INTERACT_DESTROY
 292 };
 293
 294 /**
 295  * This structure contains the active interaction dialogs, and is
 296  * used by the manager
 297  */
 298 struct interaction_t
 299 {
 300     VLC_COMMON_MEMBERS
 301
 302     int                         i_dialogs;      ///< Number of dialogs
 303     interaction_dialog_t      **pp_dialogs;     ///< Dialogs
 304     intf_thread_t              *p_intf;         ///< Interface to use
 305     int                         i_last_id;      ///< Last attributed ID
 306 };
 307
 308 /***************************************************************************
 309  * Exported symbols
 310  ***************************************************************************/
 311
 312 #define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e )
 313 VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) LIBVLC_FORMAT( 4, 5 ) );
 314 #define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e )
 315 VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) LIBVLC_FORMAT( 3, 4 ) );
 316 #define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e)
 317 VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) );
 318 #define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f )
 319 VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) );
 320 #define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d )
 321 VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) );
 322
 323 #define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 )
 324 #define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e )
 325 VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) );
 326 #define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e )
 327 VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) );
 328 #define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b )
 329 VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) );
 330 #define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b )
 331 VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int ));
 332
 333 /** @} */
 334 /** @} */
 335
 336 # ifdef __cplusplus
 337 }
 338 # endif
 339 #endif