X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_interface.h;h=ed9b64edf48717f3566d223bc0f27a11f87b4b18;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=9642341f29fd261b49d510d743fab718f1e88199;hpb=da7262d76793cf824d1b6aafc472eb84b01e5612;p=vlc diff --git a/include/vlc_interface.h b/include/vlc_interface.h index 9642341f29..ed9b64edf4 100644 --- a/include/vlc_interface.h +++ b/include/vlc_interface.h @@ -23,6 +23,12 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ +#ifndef VLC_INTF_H_ +#define VLC_INTF_H_ + +# ifdef __cplusplus +extern "C" { +# endif typedef struct intf_dialog_args_t intf_dialog_args_t; @@ -32,64 +38,44 @@ typedef struct intf_dialog_args_t intf_dialog_args_t; * interface management in vlc */ - -/***************************************************************************** - * intf_thread_t: describe an interface thread - ***************************************************************************** - * This struct describes all interface-specific data of the main (interface) - * thread. - *****************************************************************************/ - /** * \defgroup vlc_interface Interface * These functions and structures are for interface management * @{ */ -struct intf_thread_t + +typedef struct intf_sys_t intf_sys_t; + +/** Describe all interface-specific data of the interface thread */ +typedef struct intf_thread_t { VLC_COMMON_MEMBERS + struct intf_thread_t *p_next; /** LibVLC interfaces book keeping */ /* Thread properties and locks */ - vlc_bool_t b_block; - vlc_bool_t b_play; +#if defined( __APPLE__ ) + bool b_should_run_on_first_thread; +#endif /* 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 */ + void ( *pf_run ) ( struct 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 * ); - /** Interaction stuff */ - vlc_bool_t b_interaction; + config_chain_t *p_cfg; +} intf_thread_t; - /** Video window callbacks */ - void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *, - int *, int *, - unsigned int *, unsigned int * ); - void ( *pf_release_window ) ( intf_thread_t *, void * ); - int ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list ); - - /* XXX: new message passing stuff will go here */ - vlc_mutex_t change_lock; - vlc_bool_t b_menu_change; - vlc_bool_t b_menu; - - /* Provides the ability to switch an interface on the fly */ - char *psz_switch_intf; -}; - -/***************************************************************************** - * intf_dialog_args_t: arguments structure passed to a dialogs provider. - ***************************************************************************** - * This struct describes the arguments passed to the dialogs provider. - * For now they are only used with INTF_DIALOG_FILE_GENERIC. - *****************************************************************************/ +/** \brief Arguments passed to a dialogs provider + * This describes the arguments passed to the dialogs provider. They are + * mainly used with INTF_DIALOG_FILE_GENERIC. + */ struct intf_dialog_args_t { intf_thread_t *p_intf; @@ -103,25 +89,23 @@ struct intf_dialog_args_t /* Specifically for INTF_DIALOG_FILE_GENERIC */ char *psz_extensions; - vlc_bool_t b_save; - vlc_bool_t b_multiple; + bool b_save; + 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,c,d) __intf_Create(VLC_OBJECT(a),b,c,d) -VLC_EXPORT( intf_thread_t *, __intf_Create, ( vlc_object_t *, const char *, int, const char *const * ) ); -VLC_EXPORT( int, intf_RunThread, ( intf_thread_t * ) ); -VLC_EXPORT( void, intf_StopThread, ( intf_thread_t * ) ); -VLC_EXPORT( void, intf_Destroy, ( intf_thread_t * ) ); +VLC_EXPORT( int, intf_Create, ( vlc_object_t *, const char * ) ); +#define intf_Create(a,b) intf_Create(VLC_OBJECT(a),b) + +VLC_EXPORT( int, intf_Eject, ( vlc_object_t *, const char * ) ); +#define intf_Eject(a,b) intf_Eject(VLC_OBJECT(a),b) -/* If the interface is in the main thread, it should listen both to - * p_intf->b_die and p_libvlc->b_die */ -#define intf_ShouldDie( p_intf ) (p_intf->b_die || (p_intf->b_block && p_intf->p_libvlc->b_die ) ) +VLC_EXPORT( void, libvlc_Quit, ( libvlc_int_t * ) ); /*@}*/ @@ -137,60 +121,192 @@ VLC_EXPORT( void, intf_Destroy, ( intf_thread_t * ) ); freopen( "CONOUT$", "w", stderr ); \ freopen( "CONIN$", "r", stdin ); \ } \ - msg_Info( p_intf, COPYRIGHT_MESSAGE ); \ + msg_Info( p_intf, "VLC media player - %s", VERSION_MESSAGE ); \ + 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 wx\"\n") ) + "\"vlc -I qt\"\n") ) #else # define CONSOLE_INTRO_MSG #endif /* Interface dialog ids for dialog providers */ -#define INTF_DIALOG_FILE_SIMPLE 1 -#define INTF_DIALOG_FILE 2 -#define INTF_DIALOG_DISC 3 -#define INTF_DIALOG_NET 4 -#define INTF_DIALOG_CAPTURE 5 -#define INTF_DIALOG_SAT 6 +typedef enum vlc_dialog { + INTF_DIALOG_FILE_SIMPLE = 1, + INTF_DIALOG_FILE, + INTF_DIALOG_DISC, + INTF_DIALOG_NET, + INTF_DIALOG_CAPTURE, + INTF_DIALOG_SAT, + INTF_DIALOG_DIRECTORY, + + INTF_DIALOG_STREAMWIZARD, + INTF_DIALOG_WIZARD, + + INTF_DIALOG_PLAYLIST, + INTF_DIALOG_MESSAGES, + INTF_DIALOG_FILEINFO, + INTF_DIALOG_PREFS, + INTF_DIALOG_BOOKMARKS, + INTF_DIALOG_EXTENDED, + + INTF_DIALOG_POPUPMENU = 20, + INTF_DIALOG_AUDIOPOPUPMENU, + INTF_DIALOG_VIDEOPOPUPMENU, + INTF_DIALOG_MISCPOPUPMENU, + + INTF_DIALOG_FILE_GENERIC = 30, + INTF_DIALOG_INTERACTION = 50, + + INTF_DIALOG_UPDATEVLC = 90, + INTF_DIALOG_VLM, + + INTF_DIALOG_EXIT = 99 +} vlc_dialog_t; -#define INTF_DIALOG_DIRECTORY 7 +/* Useful text messages shared by interfaces */ +#define INTF_ABOUT_MSG LICENSE_MSG -#define INTF_DIALOG_STREAMWIZARD 8 -#define INTF_DIALOG_WIZARD 9 +#define EXTENSIONS_AUDIO \ + "*.a52;" \ + "*.aac;" \ + "*.ac3;" \ + "*.adt;" \ + "*.adts;" \ + "*.aif;"\ + "*.aifc;"\ + "*.aiff;"\ + "*.amr;" \ + "*.aob;" \ + "*.ape;" \ + "*.cda;" \ + "*.dts;" \ + "*.flac;"\ + "*.it;" \ + "*.m4a;" \ + "*.m4p;" \ + "*.mid;" \ + "*.mka;" \ + "*.mlp;" \ + "*.mod;" \ + "*.mp1;" \ + "*.mp2;" \ + "*.mp3;" \ + "*.mpc;" \ + "*.oga;" \ + "*.ogg;" \ + "*.oma;" \ + "*.rmi;" \ + "*.s3m;" \ + "*.spx;" \ + "*.tta;" \ + "*.voc;" \ + "*.vqf;" \ + "*.w64;" \ + "*.wav;" \ + "*.wma;" \ + "*.wv;" \ + "*.xa;" \ + "*.xm" + +#define EXTENSIONS_VIDEO "*.3g2;*.3gp;*.3gp2;*.3gpp;*.amv;*.asf;*.avi;*.bin;*.cue;*.divx;*.dv;*.flv;*.gxf;*.iso;*.m1v;*.m2v;" \ + "*.m2t;*.m2ts;*.m4v;*.mkv;*.mov;*.mp2;*.mp2v;*.mp4;*.mp4v;*.mpa;*.mpe;*.mpeg;*.mpeg1;" \ + "*.mpeg2;*.mpeg4;*.mpg;*.mpv2;*.mts;*.mxf;*.nsv;*.nuv;" \ + "*.ogg;*.ogm;*.ogv;*.ogx;*.ps;" \ + "*.rec;*.rm;*.rmvb;*.tod;*.ts;*.tts;*.vob;*.vro;*.webm;*.wmv" + +#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.ifo;*.m3u;*.m3u8;*.pls;*.ram;*.rar;*.sdp;*.vlc;*.xspf;*.zip" -#define INTF_DIALOG_PLAYLIST 10 -#define INTF_DIALOG_MESSAGES 11 -#define INTF_DIALOG_FILEINFO 12 -#define INTF_DIALOG_PREFS 13 -#define INTF_DIALOG_BOOKMARKS 14 +#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \ + EXTENSIONS_PLAYLIST -#define INTF_DIALOG_POPUPMENU 20 -#define INTF_DIALOG_AUDIOPOPUPMENU 21 -#define INTF_DIALOG_VIDEOPOPUPMENU 22 -#define INTF_DIALOG_MISCPOPUPMENU 23 +#define EXTENSIONS_SUBTITLE "*.cdg;*.idx;*.srt;*.sub;*.utf;*.ass;*.ssa;*.aqt;" \ + "*.jss;*.psb;*.rt;*.smi" -#define INTF_DIALOG_FILE_GENERIC 30 -#define INTF_DIALOG_INTERACTION 50 +/** \defgroup vlc_interaction Interaction + * \ingroup vlc_interface + * Interaction between user and modules + * @{ + */ -#define INTF_DIALOG_UPDATEVLC 90 -#define INTF_DIALOG_VLM 91 +/** + * This structure describes a piece of interaction with the user + */ +typedef struct interaction_dialog_t +{ + int i_type; ///< Type identifier + char *psz_title; ///< Title + char *psz_description; ///< Descriptor string + char *psz_default_button; ///< default button title (~OK) + char *psz_alternate_button;///< alternate button title (~NO) + /// other button title (optional,~Cancel) + char *psz_other_button; -#define INTF_DIALOG_EXIT 99 + char *psz_returned[1]; ///< returned responses from the user -/* Useful text messages shared by interfaces */ -#define INTF_ABOUT_MSG LICENSE_MSG + vlc_value_t val; ///< value coming from core for dialogue + int i_timeToGo; ///< time (in sec) until shown progress is finished + bool b_cancelled; ///< was the dialogue cancelled ? -#define EXTENSIONS_AUDIO "*.a52;*.aac;*.ac3;*.dts;*.flac;*.m4a;*.m4p;*.mka;" \ - "*.mod;*.mp1;*.mp2;*.mp3;*.ogg;*.spx;*.wav;*.wma;*.xm" + void * p_private; ///< Private interface data -#define EXTENSIONS_VIDEO "*.asf;*.avi;*.divx;*.dv;*.m1v;*.m2v;*.m4v;*.mkv;" \ - "*.mov;*.mp2;*.mp4;*.mpeg;*.mpeg1;*.mpeg2;*.mpeg4;" \ - "*.mpg;*.ogg;*.ogm;*.ps;*.ts;*.vob;*.wmv" + int i_status; ///< Dialog status; + int i_action; ///< Action to perform; + int i_flags; ///< Misc flags + int i_return; ///< Return status -#define EXTENSIONS_PLAYLIST "*.asx;*.b4s;*.m3u;*.pls;*.vlc;*.xspf" + 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; -#define EXTENSIONS_MEDIA EXTENSIONS_VIDEO ";" EXTENSIONS_AUDIO ";" \ - EXTENSIONS_PLAYLIST +/** + * Possible flags . Dialog types + */ +#define DIALOG_GOT_ANSWER 0x01 +#define DIALOG_YES_NO_CANCEL 0x02 +#define DIALOG_LOGIN_PW_OK_CANCEL 0x04 +#define DIALOG_PSZ_INPUT_OK_CANCEL 0x08 +#define DIALOG_BLOCKING_ERROR 0x10 +#define DIALOG_NONBLOCKING_ERROR 0x20 +#define DIALOG_USER_PROGRESS 0x80 +#define DIALOG_INTF_PROGRESS 0x100 + +/** Possible return codes */ +enum +{ + DIALOG_OK_YES, + DIALOG_NO, + DIALOG_CANCELLED +}; + +/** Possible status */ +enum +{ + ANSWERED_DIALOG, ///< Got "answer" + DESTROYED_DIALOG, ///< Interface has destroyed it +}; -#define EXTENSIONS_SUBTITLE "*.idx;*.srt;*.sub;*.utf" +/** Possible actions */ +enum +{ + INTERACT_NEW, + INTERACT_UPDATE, + INTERACT_HIDE, + INTERACT_DESTROY +}; + +#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) + + +/** @} */ +/** @} */ + +# ifdef __cplusplus +} +# endif +#endif