X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_interface.h;h=ca1c5646b318f4bff1b852db87098d4ff05ee3aa;hb=refs%2Fheads%2Fmaster;hp=feb738acd68746c26fc8980b439eb1b73b21e25f;hpb=cffcf64f36b2112eefeb5ddb3cf8de93e69c3cdf;p=vlc diff --git a/include/vlc_interface.h b/include/vlc_interface.h index feb738acd6..ca1c5646b3 100644 --- a/include/vlc_interface.h +++ b/include/vlc_interface.h @@ -3,24 +3,24 @@ * This library provides basic functions for threads to interact with user * interface, such as message output. ***************************************************************************** - * Copyright (C) 1999, 2000 the VideoLAN team + * Copyright (C) 1999, 2000 VLC authors and VideoLAN * $Id$ * * Authors: Vincent Seguin * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_INTF_H_ @@ -44,31 +44,27 @@ typedef struct intf_dialog_args_t intf_dialog_args_t; * @{ */ +typedef struct intf_sys_t intf_sys_t; + /** Describe all interface-specific data of the interface thread */ -struct intf_thread_t +typedef struct intf_thread_t { VLC_COMMON_MEMBERS - /* Thread properties and locks */ -#if defined( __APPLE__ ) || defined( WIN32 ) - bool b_should_run_on_first_thread; -#endif + struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */ /* Specific interfaces */ - intf_console_t * p_console; /** console */ intf_sys_t * p_sys; /** system interface */ - char * psz_intf; /** intf name specified */ /** Interface module */ module_t * p_module; - void ( *pf_run ) ( intf_thread_t * ); /** Run function */ /** Specific for dialogs providers */ - void ( *pf_show_dialog ) ( intf_thread_t *, int, int, + void ( *pf_show_dialog ) ( struct intf_thread_t *, int, int, intf_dialog_args_t * ); - vlc_mutex_t change_lock; -}; + config_chain_t *p_cfg; +} intf_thread_t; /** \brief Arguments passed to a dialogs provider * This describes the arguments passed to the dialogs provider. They are @@ -91,45 +87,32 @@ struct intf_dialog_args_t bool b_multiple; /* Specific to INTF_DIALOG_INTERACTION */ - interaction_dialog_t *p_dialog; + struct interaction_dialog_t *p_dialog; }; -/***************************************************************************** - * Prototypes - *****************************************************************************/ -#define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b) -VLC_EXPORT( intf_thread_t *, __intf_Create, ( vlc_object_t *, const char * ) ); -VLC_EXPORT( int, intf_RunThread, ( intf_thread_t * ) ); -VLC_EXPORT( void, intf_StopThread, ( intf_thread_t * ) ); +VLC_API int intf_Create( playlist_t *, const char * ); -#define intf_Eject(a,b) __intf_Eject(VLC_OBJECT(a),b) -VLC_EXPORT( int, __intf_Eject, ( vlc_object_t *, const char * ) ); +VLC_API void libvlc_Quit( libvlc_int_t * ); -VLC_EXPORT( int, interaction_Register, ( intf_thread_t * ) ); -VLC_EXPORT( int, interaction_Unregister, ( intf_thread_t * ) ); +static inline playlist_t *pl_Get( struct intf_thread_t *intf ) +{ + return (playlist_t *)(intf->p_parent); +} -/*@}*/ +/** + * Retrieves the current input thread from the playlist. + * @note The returned object must be released with vlc_object_release(). + */ +#define pl_CurrentInput(intf) (playlist_CurrentInput(pl_Get(intf))) -/***************************************************************************** - * Macros - *****************************************************************************/ -#if defined( WIN32 ) && !defined( UNDER_CE ) -# define CONSOLE_INTRO_MSG \ - if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \ - { \ - AllocConsole(); \ - freopen( "CONOUT$", "w", stdout ); \ - freopen( "CONOUT$", "w", stderr ); \ - freopen( "CONIN$", "r", stdin ); \ - } \ - msg_Info( p_intf, "%s", COPYRIGHT_MESSAGE ); \ - msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \ - "anymore, open a command-line window, go to the " \ - "directory where you installed VLC and run " \ - "\"vlc -I qt\"\n") ) -#else -# define CONSOLE_INTRO_MSG -#endif +/** + * @ingroup messages + * @{ + */ + +VLC_API void vlc_LogSet(libvlc_int_t *, vlc_log_cb cb, void *data); + +/*@}*/ /* Interface dialog ids for dialog providers */ typedef enum vlc_dialog { @@ -158,6 +141,7 @@ typedef enum vlc_dialog { INTF_DIALOG_FILE_GENERIC = 30, INTF_DIALOG_INTERACTION = 50, + INTF_DIALOG_SENDKEY = 51, INTF_DIALOG_UPDATEVLC = 90, INTF_DIALOG_VLM, @@ -168,23 +152,98 @@ typedef enum vlc_dialog { /* Useful text messages shared by interfaces */ #define INTF_ABOUT_MSG LICENSE_MSG -#define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \ - "*.mod;*.mp1;*.mp2;*.mp3;*.oga;*.ogg;*.oma;*.spx;" \ - "*.wav;*.wma;*.xm" - -#define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.flv;*.gxf;*.m1v;*.m2v;" \ - "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;" \ - "*.mpeg2;*.mpeg4;*.mpg;*.mts;*.mxf;*.nuv;" \ - "*.ogg;*.ogm;*.ogv;*.ogx;" \ - "*.ps;*.rm;*.rmvb;*.ts;*.vob;*.wmv" - -#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf" +#define EXTENSIONS_AUDIO_CSV "3ga", "669", "a52", "aac", "ac3", "adt", "adts", "aif", "aifc", "aiff", \ + "amr", "aob", "ape", "au", "awb", "caf", "dts", "flac", "it", "kar", \ + "m4a", "m4b", "m4p", "m5p", "mka", "mlp", "mod", "mpa", "mp1", "mp2", "mp3", "mpc", "mpga", "mus", \ + "oga", "ogg", "oma", "opus", "qcp", "ra", "rmi", "s3m", "sid", "spx", "tak", "thd", "tta", \ + "voc", "vqf", "w64", "wav", "wma", "wv", "xa", "xm" + +#define EXTENSIONS_VIDEO_CSV "3g2", "3gp", "3gp2", "3gpp", "amv", "asf", "avi", "bik", "divx", "drc", "dv", \ + "evo", "f4v", "flv", "gvi", "gxf", "iso", \ + "m1v", "m2v", "m2t", "m2ts", "m4v", "mkv", "mov",\ + "mp2", "mp2v", "mp4", "mp4v", "mpe", "mpeg", "mpeg1", \ + "mpeg2", "mpeg4", "mpg", "mpv2", "mts", "mtv", "mxf", "mxg", "nsv", "nuv", \ + "ogg", "ogm", "ogv", "ogx", "ps", \ + "rec", "rm", "rmvb", "rpl", "thp", "tod", "ts", "tts", "txd", "vob", "vro", \ + "webm", "wm", "wmv", "wtv", "xesc" + +#define EXTENSIONS_AUDIO \ + "*.3ga;" \ + "*.669;" \ + "*.a52;" \ + "*.aac;" \ + "*.ac3;" \ + "*.adt;" \ + "*.adts;" \ + "*.aif;"\ + "*.aifc;"\ + "*.aiff;"\ + "*.amr;" \ + "*.aob;" \ + "*.ape;" \ + "*.au;" \ + "*.awb;" \ + "*.caf;" \ + "*.dts;" \ + "*.flac;"\ + "*.it;" \ + "*.kar;" \ + "*.m4a;" \ + "*.m4b;" \ + "*.m4p;" \ + "*.m5p;" \ + "*.mid;" \ + "*.mka;" \ + "*.mlp;" \ + "*.mod;" \ + "*.mpa;" \ + "*.mp1;" \ + "*.mp2;" \ + "*.mp3;" \ + "*.mpc;" \ + "*.mpga;" \ + "*.mus;" \ + "*.oga;" \ + "*.ogg;" \ + "*.oma;" \ + "*.opus;" \ + "*.qcp;" \ + "*.ra;" \ + "*.rmi;" \ + "*.s3m;" \ + "*.sid;" \ + "*.spx;" \ + "*.tak;" \ + "*.thd;" \ + "*.tta;" \ + "*.voc;" \ + "*.vqf;" \ + "*.w64;" \ + "*.wav;" \ + "*.wma;" \ + "*.wv;" \ + "*.xa;" \ + "*.xm" + +#define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bik;*.bin;*.divx;*.drc;*.dv;*.evo;*.f4v;*.flv;*.gvi;*.gxf;*.iso;*.m1v;*.m2v;" \ + "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpe;*.mpeg;*.mpeg1;" \ + "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mtv;*.mxf;*.mxg;*.nsv;*.nuv;" \ + "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \ + "*.rec;*.rm;*.rmvb;*.rpl;*.thp;*.tod;*.ts;*.tts;*.txd;*.vob;*.vro;*.webm;*.wm;*.wmv;*.wtv;*.xesc" + +#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.cue;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.wax;*.wvx;*.zip;*.conf" #define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \ EXTENSIONS_PLAYLIST -#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \ - "*.jss;*.psb;*.rt;*.smi" +#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;" \ + "*.sub;*.utf;*.ass;" \ + "*.ssa;*.aqt;" \ + "*.jss;*.psb;" \ + "*.rt;*.smi;*.txt;" \ + "*.smil;*.stl;*.usf;" \ + "*.dks;*.pjs;*.mpl2;*.mks;" \ + "*.vtt" /** \defgroup vlc_interaction Interaction * \ingroup vlc_interface @@ -195,9 +254,8 @@ typedef enum vlc_dialog { /** * This structure describes a piece of interaction with the user */ -struct interaction_dialog_t +typedef struct interaction_dialog_t { - int i_id; ///< Unique ID int i_type; ///< Type identifier char *psz_title; ///< Title char *psz_description; ///< Descriptor string @@ -219,10 +277,11 @@ struct interaction_dialog_t int i_flags; ///< Misc flags int i_return; ///< Return status - interaction_t *p_interaction; ///< Parent interaction object vlc_object_t *p_parent; ///< The vlc object that asked //for interaction -}; + intf_thread_t *p_interface; + vlc_mutex_t *p_lock; +} interaction_dialog_t; /** * Possible flags . Dialog types @@ -233,14 +292,12 @@ struct interaction_dialog_t #define DIALOG_PSZ_INPUT_OK_CANCEL 0x08 #define DIALOG_BLOCKING_ERROR 0x10 #define DIALOG_NONBLOCKING_ERROR 0x20 -#define DIALOG_WARNING 0x40 #define DIALOG_USER_PROGRESS 0x80 #define DIALOG_INTF_PROGRESS 0x100 /** Possible return codes */ enum { - DIALOG_DEFAULT, DIALOG_OK_YES, DIALOG_NO, DIALOG_CANCELLED @@ -249,22 +306,10 @@ enum /** Possible status */ enum { - NEW_DIALOG, ///< Just created - SENT_DIALOG, ///< Sent to interface - UPDATED_DIALOG, ///< Update to send ANSWERED_DIALOG, ///< Got "answer" - HIDING_DIALOG, ///< Hiding requested - HIDDEN_DIALOG, ///< Now hidden. Requesting destruction DESTROYED_DIALOG, ///< Interface has destroyed it }; -/** Possible interaction types */ -enum -{ - INTERACT_DIALOG_ONEWAY, ///< Dialog box without feedback - INTERACT_DIALOG_TWOWAY, ///< Dialog box with feedback -}; - /** Possible actions */ enum { @@ -274,44 +319,10 @@ enum INTERACT_DESTROY }; -/** - * This structure contains the active interaction dialogs, and is - * used by the manager - */ -struct interaction_t -{ - VLC_COMMON_MEMBERS - - int i_dialogs; ///< Number of dialogs - interaction_dialog_t **pp_dialogs; ///< Dialogs - intf_thread_t *p_intf; ///< Interface to use - int i_last_id; ///< Last attributed ID -}; +#define intf_UserStringInput( a, b, c, d ) (VLC_OBJECT(a),b,c,d, VLC_EGENERIC) +#define interaction_Register( t ) (t, VLC_EGENERIC) +#define interaction_Unregister( t ) (t, VLC_EGENERIC) -/*************************************************************************** - * Exported symbols - ***************************************************************************/ - -#define intf_UserFatal( a, b, c, d, e... ) __intf_UserFatal( VLC_OBJECT(a),b,c,d, ## e ) -VLC_EXPORT( int, __intf_UserFatal,( vlc_object_t*, bool, const char*, const char*, ...) LIBVLC_FORMAT( 4, 5 ) ); -#define intf_UserWarn( a, c, d, e... ) __intf_UserWarn( VLC_OBJECT(a),c,d, ## e ) -VLC_EXPORT( int, __intf_UserWarn,( vlc_object_t*, const char*, const char*, ...) LIBVLC_FORMAT( 3, 4 ) ); -#define intf_UserLoginPassword( a, b, c, d, e... ) __intf_UserLoginPassword( VLC_OBJECT(a),b,c,d,e) -VLC_EXPORT( int, __intf_UserLoginPassword,( vlc_object_t*, const char*, const char*, char **, char **) ); -#define intf_UserYesNo( a, b, c, d, e, f ) __intf_UserYesNo( VLC_OBJECT(a),b,c, d, e, f ) -VLC_EXPORT( int, __intf_UserYesNo,( vlc_object_t*, const char*, const char*, const char*, const char*, const char*) ); -#define intf_UserStringInput( a, b, c, d ) __intf_UserStringInput( VLC_OBJECT(a),b,c,d ) -VLC_EXPORT( int, __intf_UserStringInput,(vlc_object_t*, const char*, const char*, char **) ); - -#define intf_IntfProgress( a, b, c ) __intf_Progress( VLC_OBJECT(a), NULL, b,c, -1 ) -#define intf_UserProgress( a, b, c, d, e ) __intf_Progress( VLC_OBJECT(a),b,c,d,e ) -VLC_EXPORT( int, __intf_Progress,( vlc_object_t*, const char*, const char*, float, int) ); -#define intf_ProgressUpdate( a, b, c, d, e ) __intf_ProgressUpdate( VLC_OBJECT(a),b,c,d,e ) -VLC_EXPORT( void, __intf_ProgressUpdate,( vlc_object_t*, int, const char*, float, int) ); -#define intf_ProgressIsCancelled( a, b ) __intf_UserProgressIsCancelled( VLC_OBJECT(a),b ) -VLC_EXPORT( bool, __intf_UserProgressIsCancelled,( vlc_object_t*, int ) ); -#define intf_UserHide( a, b ) __intf_UserHide( VLC_OBJECT(a), b ) -VLC_EXPORT( void, __intf_UserHide,( vlc_object_t *, int )); /** @} */ /** @} */