X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_osd.h;h=06168b4b8f4986601c4239d2e73b81232ccba6e7;hb=c60652e38ac6afd74bd8225e9dae5406f13aaa4f;hp=78cec6310ae4835baae8a5959157c457f30a456f;hpb=5ba9cf272657c4300008f3c33bc214840b5bc0e6;p=vlc diff --git a/include/vlc_osd.h b/include/vlc_osd.h index 78cec6310a..06168b4b8f 100644 --- a/include/vlc_osd.h +++ b/include/vlc_osd.h @@ -32,6 +32,7 @@ #include #include +#include # ifdef __cplusplus extern "C" { @@ -119,17 +120,6 @@ extern "C" { * */ -/** - * OSD menu position and picture type defines - */ -#define OSD_HOR_SLIDER 1 -#define OSD_VERT_SLIDER 2 - -#define OSD_PLAY_ICON 1 -#define OSD_PAUSE_ICON 2 -#define OSD_SPEAKER_ICON 3 -#define OSD_MUTE_ICON 4 - /** * OSD menu button states * @@ -205,7 +195,7 @@ struct osd_button_t * * The images that make up an OSD menu can be created in such away that * they contain all buttons in the same picture, with the selected one - * highlighted or being a concatenation of all the seperate images. The + * highlighted or being a concatenation of all the separate images. The * first case is the default. * * To change the default style the keyword 'style' should be set to 'concat'. @@ -275,7 +265,7 @@ struct osd_menu_t * functions. It creates the osd_menu object and holds a pointer to it * during its lifetime. */ -VLC_EXPORT( osd_menu_t *, osd_MenuCreate, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( osd_menu_t *, osd_MenuCreate, ( vlc_object_t *, const char * ) LIBVLC_USED ); /** * Delete the osd_menu_t object @@ -293,7 +283,7 @@ VLC_EXPORT( void, osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) ); * Find OSD Menu button at position x,y */ VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this, - int, int, int, int, int, int ) ); + int, int, int, int, int, int ) LIBVLC_USED ); #define osd_ButtonFind(object,x,y,h,w,sh,sw) osd_ButtonFind(object,x,y,h,w,sh,sw) @@ -388,6 +378,7 @@ VLC_EXPORT( void, osd_Volume, ( vlc_object_t * ) ); * Retrieve a non modifyable pointer to the OSD Menu state * */ +LIBVLC_USED static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd ) { return( p_osd->p_state ); @@ -398,6 +389,7 @@ static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd ) * * Returns 0 when no key has been pressed or the value of the key pressed. */ +LIBVLC_USED static inline bool osd_GetKeyPressed( osd_menu_t *p_osd ) { return( p_osd->p_state->b_update ); @@ -456,55 +448,8 @@ VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_ VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) ); VLC_EXPORT( void, osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) ); -/** - * Default feedback images - * - * Functions that provide the default OSD feedback images on hotkey - * commands. These feedback images are also part of the osd_button_t - * object. The types are declared in the include file include/vlc_osd.h - * @see vlc_osd.h - */ -VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) ); -VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) ); - /** @} */ -/********************************************************************** - * Vout text and widget overlays - **********************************************************************/ -VLC_EXPORT( int, vout_OSDEpg, ( vout_thread_t *, input_item_t * ) ); - -/** - * Write an informative message at the default location, - * for the default duration and only if the OSD option is enabled. - * \param p_caller The object that called the function. - * \param i_channel Subpicture channel - * \param psz_format printf style formatting - **/ -VLC_EXPORT( void, vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) ); - -#define vout_OSDMessage( obj, chan, ...) \ - vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ ) - -/** - * Display a slider on the video output. - * \param p_this The object that called the function. - * \param i_channel Subpicture channel - * \param i_postion Current position in the slider - * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER. - * @see vlc_osd.h - */ -VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) ); - -/** - * Display an Icon on the video output. - * \param p_this The object that called the function. - * \param i_channel Subpicture channel - * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON - * @see vlc_osd.h - */ -VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) ); - # ifdef __cplusplus } # endif