X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_osd.h;h=78cec6310ae4835baae8a5959157c457f30a456f;hb=5ba9cf272657c4300008f3c33bc214840b5bc0e6;hp=0aff210871579b4b731c49bac1a387e16ece3374;hpb=681ac9f14efd4a8611e7868004f59d5bf4f84d71;p=vlc diff --git a/include/vlc_osd.h b/include/vlc_osd.h index 0aff210871..78cec6310a 100644 --- a/include/vlc_osd.h +++ b/include/vlc_osd.h @@ -30,7 +30,8 @@ #ifndef VLC_OSD_H #define VLC_OSD_H 1 -#include "vlc_vout.h" +#include +#include # ifdef __cplusplus extern "C" { @@ -41,89 +42,6 @@ extern "C" { * This file defines SPU subpicture and OSD functions and object types. */ -/********************************************************************** - * Base SPU structures - **********************************************************************/ -/** - * \defgroup spu Subpicture Unit - * This module describes the programming interface for the subpicture unit. - * It includes functions allowing to create/destroy an spu, create/destroy - * subpictures and render them. - * @{ - */ - -#include - -typedef struct spu_private_t spu_private_t; - -/** - * Subpicture unit descriptor - */ -struct spu_t -{ - VLC_COMMON_MEMBERS - - int (*pf_control)( spu_t *, int, va_list ); - - spu_private_t *p; -}; - -enum spu_query_e -{ - SPU_CHANNEL_REGISTER, /* arg1= int * res= */ - SPU_CHANNEL_CLEAR /* arg1= int res= */ -}; - -static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args ) -{ - if( p_spu->pf_control ) - return p_spu->pf_control( p_spu, i_query, args ); - else - return VLC_EGENERIC; -} - -static inline int spu_Control( spu_t *p_spu, int i_query, ... ) -{ - va_list args; - int i_result; - - va_start( args, i_query ); - i_result = spu_vaControl( p_spu, i_query, args ); - va_end( args ); - return i_result; -} - -#define spu_Create(a) __spu_Create(VLC_OBJECT(a)) -VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) ); -VLC_EXPORT( int, spu_Init, ( spu_t * ) ); -VLC_EXPORT( void, spu_Destroy, ( spu_t * ) ); -void spu_Attach( spu_t *, vlc_object_t *, bool ); - -/** - * This function sends a subpicture to the spu_t core. - * - * You cannot use the provided subpicture anymore. The spu_t core - * will destroy it at its convenience. - */ -VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) ); - -/** - * This function asks the spu_t core a list of subpictures to display. - * - * The returned list can only be used by spu_RenderSubpictures. - */ -VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t display_date, bool b_paused, bool b_subtitle_only ) ); - -/** - * This function renders a list of subpicture_t on the provided picture. - * - * \param p_fmt_dst is the format of the destination picture. - * \param p_fmt_src is the format of the original(source) video. - */ -VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, picture_t *, const video_format_t *p_fmt_dst, subpicture_t *p_list, const video_format_t *p_fmt_src, bool b_paused ) ); - -/** @}*/ - /********************************************************************** * OSD Menu **********************************************************************/ @@ -204,12 +122,6 @@ VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, picture_t *, const video_fo /** * OSD menu position and picture type defines */ - -#define OSD_ALIGN_LEFT 0x1 -#define OSD_ALIGN_RIGHT 0x2 -#define OSD_ALIGN_TOP 0x4 -#define OSD_ALIGN_BOTTOM 0x8 - #define OSD_HOR_SLIDER 1 #define OSD_VERT_SLIDER 2 @@ -218,73 +130,6 @@ VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, picture_t *, const video_fo #define OSD_SPEAKER_ICON 3 #define OSD_MUTE_ICON 4 -/** - * Text style - * - * A text style is used to specify the formatting of text. - * A font renderer can use the supplied information to render the - * text specified. - */ -struct text_style_t -{ - char * psz_fontname; /**< The name of the font */ - int i_font_size; /**< The font size in pixels */ - int i_font_color; /**< The color of the text 0xRRGGBB - (native endianness) */ - int i_font_alpha; /**< The transparency of the text. - 0x00 is fully opaque, - 0xFF fully transparent */ - int i_style_flags; /**< Formatting style flags */ - int i_outline_color; /**< The color of the outline 0xRRGGBB */ - int i_outline_alpha; /**< The transparency of the outline. - 0x00 is fully opaque, - 0xFF fully transparent */ - int i_shadow_color; /**< The color of the shadow 0xRRGGBB */ - int i_shadow_alpha; /**< The transparency of the shadow. - 0x00 is fully opaque, - 0xFF fully transparent */ - int i_background_color;/**< The color of the background 0xRRGGBB */ - int i_background_alpha;/**< The transparency of the background. - 0x00 is fully opaque, - 0xFF fully transparent */ - int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */ - int i_karaoke_background_alpha;/**< The transparency of the karaoke bg. - 0x00 is fully opaque, - 0xFF fully transparent */ - int i_outline_width; /**< The width of the outline in pixels */ - int i_shadow_width; /**< The width of the shadow in pixels */ - int i_spacing; /**< The spaceing between glyphs in pixels */ -}; - -/* Style flags for \ref text_style_t */ -#define STYLE_BOLD 1 -#define STYLE_ITALIC 2 -#define STYLE_OUTLINE 4 -#define STYLE_SHADOW 8 -#define STYLE_BACKGROUND 16 -#define STYLE_UNDERLINE 32 -#define STYLE_STRIKEOUT 64 - -/** - * Create a default text style - */ -VLC_EXPORT( text_style_t *, text_style_New, ( void ) ); - -/** - * Copy a text style into another - */ -VLC_EXPORT( text_style_t *, text_style_Copy, ( text_style_t *, const text_style_t * ) ); - -/** - * Duplicate a text style - */ -VLC_EXPORT( text_style_t *, text_style_Duplicate, ( const text_style_t * ) ); - -/** - * Delete a text style created by text_style_New or text_style_Duplicate - */ -VLC_EXPORT( void, text_style_Delete, ( text_style_t * ) ); - /** * OSD menu button states * @@ -430,7 +275,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 * ) ); /** * Delete the osd_menu_t object @@ -439,25 +284,25 @@ VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) ); * memory for the osdmenu. After return of this function the pointer to * osd_menu_t* is invalid. */ -VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) ); +VLC_EXPORT( void, osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) ); -#define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file ) -#define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd ) +#define osd_MenuCreate(object,file) osd_MenuCreate( VLC_OBJECT(object), file ) +#define osd_MenuDelete(object,osd) osd_MenuDelete( VLC_OBJECT(object), osd ) /** * Find OSD Menu button at position x,y */ -VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this, +VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this, int, int, int, int, int, int ) ); -#define osd_ButtonFind(object,x,y,h,w,sh,sw) __osd_ButtonFind(object,x,y,h,w,sh,sw) +#define osd_ButtonFind(object,x,y,h,w,sh,sw) osd_ButtonFind(object,x,y,h,w,sh,sw) /** * Select the button provided as the new active button */ -VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) ); +VLC_EXPORT( void, osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) ); -#define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button) +#define osd_ButtonSelect(object,button) osd_ButtonSelect(object,button) /** * Show the OSD menu. @@ -466,14 +311,14 @@ VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) ); * Every change to the OSD menu will now be visible in the output. An output * can be a video output window or a stream (\see stream output) */ -VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuShow, ( vlc_object_t * ) ); /** * Hide the OSD menu. * * Stop showing the OSD menu on the video output or mux it into the stream. */ -VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuHide, ( vlc_object_t * ) ); /** * Activate the action of this OSD menu item. @@ -482,11 +327,11 @@ VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) ); * hotkey action to the hotkey interface. The hotkey that belongs to * the current highlighted OSD menu item will be used. */ -VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuActivate, ( vlc_object_t * ) ); -#define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) ) -#define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) ) -#define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) ) +#define osd_MenuShow(object) osd_MenuShow( VLC_OBJECT(object) ) +#define osd_MenuHide(object) osd_MenuHide( VLC_OBJECT(object) ) +#define osd_MenuActivate(object) osd_MenuActivate( VLC_OBJECT(object) ) /** * Next OSD menu item @@ -495,7 +340,7 @@ VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) ); * Note: The actual position on screen of the menu item is determined by * the OSD menu configuration file. */ -VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuNext, ( vlc_object_t * ) ); /** * Previous OSD menu item @@ -504,7 +349,7 @@ VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) ); * Note: The actual position on screen of the menu item is determined by * the OSD menu configuration file. */ -VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuPrev, ( vlc_object_t * ) ); /** * OSD menu item above @@ -513,7 +358,7 @@ VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) ); * Note: The actual position on screen of the menu item is determined by * the OSD menu configuration file. */ -VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuUp, ( vlc_object_t * ) ); /** * OSD menu item below @@ -522,12 +367,12 @@ VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) ); * Note: The actual position on screen of the menu item is determined by * the OSD menu configuration file. */ -VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_MenuDown, ( vlc_object_t * ) ); -#define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) ) -#define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) ) -#define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) ) -#define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) ) +#define osd_MenuNext(object) osd_MenuNext( VLC_OBJECT(object) ) +#define osd_MenuPrev(object) osd_MenuPrev( VLC_OBJECT(object) ) +#define osd_MenuUp(object) osd_MenuUp( VLC_OBJECT(object) ) +#define osd_MenuDown(object) osd_MenuDown( VLC_OBJECT(object) ) /** * Display the audio volume bitmap. @@ -535,9 +380,9 @@ VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) ); * Display the correct audio volume bitmap that corresponds to the * current Audio Volume setting. */ -VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) ); +VLC_EXPORT( void, osd_Volume, ( vlc_object_t * ) ); -#define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) ) +#define osd_Volume(object) osd_Volume( VLC_OBJECT(object) ) /** * Retrieve a non modifyable pointer to the OSD Menu state @@ -627,10 +472,7 @@ VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, s /********************************************************************** * Vout text and widget overlays **********************************************************************/ - -VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, const text_style_t *, int, int, int, mtime_t ) ); - -VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) ); +VLC_EXPORT( int, vout_OSDEpg, ( vout_thread_t *, input_item_t * ) ); /** * Write an informative message at the default location, @@ -639,13 +481,10 @@ VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, co * \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 ) ); +VLC_EXPORT( void, vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) ); -/** - * Same as __vlc_OSDMessage() but with automatic casting - */ #define vout_OSDMessage( obj, chan, ...) \ - __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ ) + vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ ) /** * Display a slider on the video output.