X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_osd.h;h=06168b4b8f4986601c4239d2e73b81232ccba6e7;hb=c60652e38ac6afd74bd8225e9dae5406f13aaa4f;hp=83b9b18c8113f027da8acea579e16c6f4a6a7a91;hpb=82e29c9ba1135639fe10881591e6261bc3396ae4;p=vlc diff --git a/include/vlc_osd.h b/include/vlc_osd.h index 83b9b18c81..06168b4b8f 100644 --- a/include/vlc_osd.h +++ b/include/vlc_osd.h @@ -1,7 +1,7 @@ /***************************************************************************** * vlc_osd.h - OSD menu and subpictures definitions and function prototypes ***************************************************************************** - * Copyright (Cà 1999-2006 the VideoLAN team + * Copyright (C) 1999-2006 the VideoLAN team * Copyright (C) 2004-2005 M2X * $Id$ * @@ -27,106 +27,22 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif +#ifndef VLC_OSD_H +#define VLC_OSD_H 1 -#ifndef _VLC_OSD_H -#define _VLC_OSD_H 1 - -#include "vlc_vout.h" +#include +#include +#include # ifdef __cplusplus extern "C" { # endif -/********************************************************************** - * 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. - * @{ + * \file + * This file defines SPU subpicture and OSD functions and object types. */ -#include - -/** - * Subpicture unit descriptor - */ -struct spu_t -{ - VLC_COMMON_MEMBERS - - vlc_mutex_t subpicture_lock; /**< subpicture heap lock */ - subpicture_t p_subpicture[VOUT_MAX_SUBPICTURES]; /**< subpictures */ - int i_channel; /**< number of subpicture channels registered */ - - filter_t *p_blend; /**< alpha blending module */ - filter_t *p_text; /**< text renderer module */ - filter_t *p_scale; /**< scaling module */ - vlc_bool_t b_force_crop; /**< force cropping of subpicture */ - int i_crop_x, i_crop_y, i_crop_width, i_crop_height; /**< cropping */ - - int i_margin; /**< force position of a subpicture */ - vlc_bool_t b_force_palette; /**< force palette of subpicture */ - uint8_t palette[4][4]; /**< forced palette */ - - int ( *pf_control ) ( spu_t *, int, va_list ); - - /* Supciture filters */ - filter_t *pp_filter[10]; - int i_filter; -}; - -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; -} - -enum spu_query_e -{ - SPU_CHANNEL_REGISTER, /* arg1= int * res= */ - SPU_CHANNEL_CLEAR /* arg1= int res= */ -}; - -#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 *, vlc_bool_t ); - -VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) ); -VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) ); -VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) ); - -#define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b) -VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) ); -#define spu_MakeRegion(a,b,c) __spu_MakeRegion(VLC_OBJECT(a),b,c) -VLC_EXPORT( subpicture_region_t *,__spu_MakeRegion, ( vlc_object_t *, video_format_t *, picture_t * ) ); -#define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b) -VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) ); -VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t, vlc_bool_t ) ); -VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) ); - -/** @}*/ - /********************************************************************** * OSD Menu **********************************************************************/ @@ -204,73 +120,6 @@ VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t * */ -/** - * 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 - -#define OSD_PLAY_ICON 1 -#define OSD_PAUSE_ICON 2 -#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 - -static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE, - 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 }; - /** * OSD menu button states * @@ -337,7 +186,7 @@ struct osd_button_t int i_height; /*< height of button visible state image */ /* range style button */ - vlc_bool_t b_range; /*< button should be interpreted as range */ + bool b_range; /*< button should be interpreted as range */ int i_ranges; /*< number of states */ }; @@ -346,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'. @@ -371,8 +220,8 @@ struct osd_menu_state_t picture_t *p_pic; /*< pointer to picture to display */ osd_button_t *p_visible; /*< shortcut to visible button */ - vlc_bool_t b_menu_visible; /*< menu currently visible? */ - vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */ + bool b_menu_visible; /*< menu currently visible? */ + bool b_update; /*< update OSD Menu when true */ /* quick hack to volume state. */ osd_button_t *p_volume; /*< pointer to volume range object. */ @@ -416,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 @@ -425,25 +274,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, - int, int, int, int, int, int ) ); +VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this, + 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) +#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. @@ -452,14 +301,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. @@ -468,11 +317,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 @@ -481,7 +330,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 @@ -490,7 +339,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 @@ -499,7 +348,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 @@ -508,12 +357,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. @@ -521,14 +370,15 @@ 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 * */ +LIBVLC_USED static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd ) { return( p_osd->p_state ); @@ -539,7 +389,8 @@ 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. */ -static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd ) +LIBVLC_USED +static inline bool osd_GetKeyPressed( osd_menu_t *p_osd ) { return( p_osd->p_state->b_update ); } @@ -560,10 +411,10 @@ static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value ) /** * Update the OSD Menu visibility flag. * - * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu + * true means OSD Menu should be shown. false means OSD Menu * should not be shown. */ -static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value ) +static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value ) { vlc_value_t val; @@ -575,9 +426,9 @@ static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value ) * Update the OSD Menu update flag * * If the OSD Menu should be updated then set the update flag to - * VLC_TRUE, else to VLC_FALSE. + * true, else to false. */ -static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value ) +static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value ) { vlc_value_t val; @@ -593,93 +444,12 @@ static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value ) * object. The types are declared in the include file include/vlc_osd.h * @see vlc_osd.h */ -VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) ); -VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) ); -VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) ATTRIBUTE_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 ) ); +VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t ) ); +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 ) ); /** @} */ -/********************************************************************** - * Vout text and widget overlays - **********************************************************************/ - -/** - * Show text on the video for some time - * \param p_vout pointer to the vout the text is to be showed on - * \param i_channel Subpicture channel - * \param psz_string The text to be shown - * \param p_style Pointer to a struct with text style info - * \param i_flags flags for alignment and such - * \param i_hmargin horizontal margin in pixels - * \param i_vmargin vertical margin in pixels - * \param i_duration Amount of time the text is to be shown. - */ -VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) ); - -/** - * Show text on the video from a given start date to a given end date - * \param p_vout pointer to the vout the text is to be showed on - * \param i_channel Subpicture channel - * \param psz_string The text to be shown - * \param p_style Pointer to a struct with text style info - * \param i_flags flags for alignment and such - * \param i_hmargin horizontal margin in pixels - * \param i_vmargin vertical margin in pixels - * \param i_start the time when this string is to appear on the video - * \param i_stop the time when this string should stop to be displayed - * if this is 0 the string will be shown untill the next string - * is about to be shown - */ -VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_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 *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) ); - -/** - * Same as __vlc_OSDMessage() but with automatic casting - */ -#if defined(HAVE_VARIADIC_MACROS) -# define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args ) -#else -# define vout_OSDMessage __vout_OSDMessage -#endif - -/** - * 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