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