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  * \defgroup interface Interface
  37  * VLC user interfaces
  38  * @{
  39  * \file
  40  * VLC user interface modules
  41  */
  42
  43 typedef struct intf_sys_t intf_sys_t;
  44
  45 /** Describe all interface-specific data of the interface thread */
  46 typedef struct intf_thread_t
  47 {
  48     VLC_COMMON_MEMBERS
  49
  50     struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */
  51
  52     /* Specific interfaces */
  53     intf_sys_t *        p_sys;                          /** system interface */
  54
  55     /** Interface module */
  56     module_t *   p_module;
  57
  58     /** Specific for dialogs providers */
  59     void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int,
  60                                intf_dialog_args_t * );
  61
  62     config_chain_t *p_cfg;
  63 } intf_thread_t;
  64
  65 /** \brief Arguments passed to a dialogs provider
  66  *  This describes the arguments passed to the dialogs provider. They are
  67  *  mainly used with INTF_DIALOG_FILE_GENERIC.
  68  */
  69 struct intf_dialog_args_t
  70 {
  71     intf_thread_t *p_intf;
  72     char *psz_title;
  73
  74     char **psz_results;
  75     int  i_results;
  76
  77     void (*pf_callback) ( intf_dialog_args_t * );
  78     void *p_arg;
  79
  80     /* Specifically for INTF_DIALOG_FILE_GENERIC */
  81     char *psz_extensions;
  82     bool b_save;
  83     bool b_multiple;
  84
  85     /* Specific to INTF_DIALOG_INTERACTION */
  86     struct interaction_dialog_t *p_dialog;
  87 };
  88
  89 VLC_API int intf_Create( playlist_t *, const char * );
  90
  91 VLC_API void libvlc_Quit( libvlc_int_t * );
  92
  93 static inline playlist_t *pl_Get( struct intf_thread_t *intf )
  94 {
  95     return (playlist_t *)(intf->obj.parent);
  96 }
  97
  98 /**
  99  * Retrieves the current input thread from the playlist.
 100  * @note The returned object must be released with vlc_object_release().
 101  */
 102 #define pl_CurrentInput(intf) (playlist_CurrentInput(pl_Get(intf)))
 103
 104 /**
 105  * @ingroup messages
 106  * @{
 107  */
 108
 109 VLC_API void vlc_LogSet(libvlc_int_t *, vlc_log_cb cb, void *data);
 110
 111 /*@}*/
 112
 113 /* Interface dialog ids for dialog providers */
 114 typedef enum vlc_intf_dialog {
 115     INTF_DIALOG_FILE_SIMPLE = 1,
 116     INTF_DIALOG_FILE,
 117     INTF_DIALOG_DISC,
 118     INTF_DIALOG_NET,
 119     INTF_DIALOG_CAPTURE,
 120     INTF_DIALOG_SAT,
 121     INTF_DIALOG_DIRECTORY,
 122
 123     INTF_DIALOG_STREAMWIZARD,
 124     INTF_DIALOG_WIZARD,
 125
 126     INTF_DIALOG_PLAYLIST,
 127     INTF_DIALOG_MESSAGES,
 128     INTF_DIALOG_FILEINFO,
 129     INTF_DIALOG_PREFS,
 130     INTF_DIALOG_BOOKMARKS,
 131     INTF_DIALOG_EXTENDED,
 132     INTF_DIALOG_RENDERER,
 133
 134     INTF_DIALOG_POPUPMENU = 20,
 135     INTF_DIALOG_AUDIOPOPUPMENU,
 136     INTF_DIALOG_VIDEOPOPUPMENU,
 137     INTF_DIALOG_MISCPOPUPMENU,
 138
 139     INTF_DIALOG_FILE_GENERIC = 30,
 140     INTF_DIALOG_INTERACTION = 50,
 141     INTF_DIALOG_SENDKEY = 51,
 142
 143     INTF_DIALOG_UPDATEVLC = 90,
 144     INTF_DIALOG_VLM,
 145
 146     INTF_DIALOG_EXIT = 99
 147 } vlc_intf_dialog;
 148
 149 /* Useful text messages shared by interfaces */
 150 #define INTF_ABOUT_MSG LICENSE_MSG
 151
 152 #define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \
 153                          "amb", "amr", "aob", "ape", "au", "awb", "caf", "dts", "flac", "it", "kar", \
 154                          "m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \
 155                          "oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "tak", "thd", "tta", \
 156                          "voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm"
 157
 158 #define EXTENSIONS_VIDEO_CSV "3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "crf", "divx", "drc", "dv", "dvr-ms" \
 159                              "evo", "f4v", "flv", "gvi", "gxf", "iso", \
 160                              "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\
 161                              "mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \
 162                              "mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \
 163                              "ogg", "ogm", "ogv", "ogx", "ps", \
 164                              "rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \
 165                              "webm", "wm", "wmv", "wtv", "xesc"
 166
 167 #define EXTENSIONS_AUDIO \
 168     "*.3ga;" \
 169     "*.669;" \
 170     "*.a52;" \
 171     "*.aac;" \
 172     "*.ac3;" \
 173     "*.adt;" \
 174     "*.adts;" \
 175     "*.aif;"\
 176     "*.aifc;"\
 177     "*.aiff;"\
 178     "*.amb;" \
 179     "*.amr;" \
 180     "*.aob;" \
 181     "*.ape;" \
 182     "*.au;" \
 183     "*.awb;" \
 184     "*.caf;" \
 185     "*.dts;" \
 186     "*.flac;"\
 187     "*.it;"  \
 188     "*.kar;" \
 189     "*.m4a;" \
 190     "*.m4b;" \
 191     "*.m4p;" \
 192     "*.m5p;" \
 193     "*.mid;" \
 194     "*.mka;" \
 195     "*.mlp;" \
 196     "*.mod;" \
 197     "*.mpa;" \
 198     "*.mp1;" \
 199     "*.mp2;" \
 200     "*.mp3;" \
 201     "*.mpc;" \
 202     "*.mpga;" \
 203     "*.mus;" \
 204     "*.oga;" \
 205     "*.ogg;" \
 206     "*.oma;" \
 207     "*.opus;" \
 208     "*.qcp;" \
 209     "*.ra;" \
 210     "*.rmi;" \
 211     "*.s3m;" \
 212     "*.sid;" \
 213     "*.spx;" \
 214     "*.tak;" \
 215     "*.thd;" \
 216     "*.tta;" \
 217     "*.voc;" \
 218     "*.vqf;" \
 219     "*.w64;" \
 220     "*.wav;" \
 221     "*.wma;" \
 222     "*.wv;"  \
 223     "*.xa;"  \
 224     "*.xm"
 225
 226 #define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.crf;*.divx;*.drc;*.dv;*.dvr-ms;*.evo;*.f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \
 227                          "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \
 228                          "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \
 229                          "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \
 230                          "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.tp;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc"
 231
 232 #define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wax;*.wvx;*.zip;*.conf"
 233
 234 #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \
 235                           EXTENSIONS_PLAYLIST
 236
 237 #define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \
 238                             "*.sub;*.utf;*.ass;" \
 239                             "*.ssa;*.aqt;" \
 240                             "*.jss;*.psb;" \
 241                             "*.rt;*.smi;*.txt;" \
 242                             "*.smil;*.stl;*.usf;" \
 243                             "*.dks;*.pjs;*.mpl2;*.mks;" \
 244                             "*.vtt;*.ttml;*.dfxp;"
 245
 246 /** \defgroup interaction Interaction
 247  * \ingroup interface
 248  * Interaction between user and modules
 249  * @{
 250  */
 251
 252 /**
 253  * This structure describes a piece of interaction with the user
 254  */
 255 typedef struct interaction_dialog_t
 256 {
 257     int             i_type;             ///< Type identifier
 258     char           *psz_title;          ///< Title
 259     char           *psz_description;    ///< Descriptor string
 260     char           *psz_default_button;  ///< default button title (~OK)
 261     char           *psz_alternate_button;///< alternate button title (~NO)
 262     /// other button title (optional,~Cancel)
 263     char           *psz_other_button;
 264
 265     char           *psz_returned[1];    ///< returned responses from the user
 266
 267     vlc_value_t     val;                ///< value coming from core for dialogue
 268     int             i_timeToGo;         ///< time (in sec) until shown progress is finished
 269     bool      b_cancelled;        ///< was the dialogue cancelled ?
 270
 271     void *          p_private;          ///< Private interface data
 272
 273     int             i_status;           ///< Dialog status;
 274     int             i_action;           ///< Action to perform;
 275     int             i_flags;            ///< Misc flags
 276     int             i_return;           ///< Return status
 277
 278     vlc_object_t   *p_parent;           ///< The vlc object that asked
 279                                         //for interaction
 280     intf_thread_t  *p_interface;
 281     vlc_mutex_t    *p_lock;
 282 } interaction_dialog_t;
 283
 284 /**
 285  * Possible flags . Dialog types
 286  */
 287 #define DIALOG_GOT_ANSWER           0x01
 288 #define DIALOG_YES_NO_CANCEL        0x02
 289 #define DIALOG_LOGIN_PW_OK_CANCEL   0x04
 290 #define DIALOG_PSZ_INPUT_OK_CANCEL  0x08
 291 #define DIALOG_BLOCKING_ERROR       0x10
 292 #define DIALOG_NONBLOCKING_ERROR    0x20
 293 #define DIALOG_USER_PROGRESS        0x80
 294 #define DIALOG_INTF_PROGRESS        0x100
 295
 296 /** Possible return codes */
 297 enum
 298 {
 299     DIALOG_OK_YES,
 300     DIALOG_NO,
 301     DIALOG_CANCELLED
 302 };
 303
 304 /** Possible status  */
 305 enum
 306 {
 307     ANSWERED_DIALOG,            ///< Got "answer"
 308     DESTROYED_DIALOG,           ///< Interface has destroyed it
 309 };
 310
 311 /** Possible actions */
 312 enum
 313 {
 314     INTERACT_NEW,
 315     INTERACT_UPDATE,
 316     INTERACT_HIDE,
 317     INTERACT_DESTROY
 318 };
 319
 320 #define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC)
 321 #define interaction_Register( t ) (t, VLC_EGENERIC)
 322 #define interaction_Unregister( t ) (t, VLC_EGENERIC)
 323
 324
 325 /** @} */
 326 /** @} */
 327
 328 # ifdef __cplusplus
 329 }
 330 # endif
 331 #endif