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