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