X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_osd.h;h=bfbd4272e9f38fda217d184aed09c036332b9ffe;hb=22dbf2bfad420b171fee86c1a97a433929e6fc1e;hp=d403b67fba3d4127ef8e32c01b03a5801a23f9f9;hpb=ad1fb8798056bb4d298aae0d9d053f8872fc4a79;p=vlc diff --git a/include/vlc_osd.h b/include/vlc_osd.h index d403b67fba..bfbd4272e9 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,10 +27,6 @@ * 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 @@ -66,19 +62,19 @@ struct spu_t 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 */ + filter_t *p_scale_yuvp; /**< scaling module for YUVP */ + filter_t *p_scale; /**< scaling module (all but YUVP) */ + bool 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 */ + bool 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; + filter_chain_t *p_chain; }; static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args ) @@ -88,6 +84,7 @@ static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args ) else return VLC_EGENERIC; } + static inline int spu_Control( spu_t *p_spu, int i_query, ... ) { va_list args; @@ -109,7 +106,7 @@ enum spu_query_e 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 ); +void spu_Attach( spu_t *, vlc_object_t *, bool ); VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) ); VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) ); @@ -121,7 +118,7 @@ VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_fo 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( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t, bool ) ); VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) ); /** @}*/ @@ -270,8 +267,6 @@ struct text_style_t 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 * @@ -301,6 +296,11 @@ struct osd_state_t char *psz_state; /*< state name */ int i_state; /*< state index */ + + int i_x; /*< x-position of button state image */ + int i_y; /*< y-position of button state image */ + int i_width; /*< width of button state image */ + int i_height; /*< height of button state image */ }; /** @@ -329,9 +329,11 @@ struct osd_button_t int i_x; /*< x-position of button visible state image */ int i_y; /*< y-position of button visible state image */ + int i_width; /*< width of button visible state image */ + 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 */ }; @@ -365,8 +367,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. */ @@ -388,6 +390,7 @@ struct osd_menu_t int i_width; /*< width of OSD Menu on the video screen */ int i_height; /*< height of OSD Menu on the video screen */ int i_style; /*< style of spu region generation */ + int i_position; /*< display position */ char *psz_path; /*< directory where OSD menu images are stored */ osd_button_t *p_button; /*< doubly linked list of buttons */ @@ -420,20 +423,23 @@ VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) ); */ 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 ) + /** - * Change state on an osd_button_t. - * - * This function selects the specified state and returns a pointer to it. The - * following states are currently supported: - * \see OSD_BUTTON_UNSELECT - * \see OSD_BUTTON_SELECT - * \see OSD_BUTTON_PRESSED + * Find OSD Menu button at position x,y */ -VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) ); +VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this, + int, int, int, int, int, int ) ); -#define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file ) -#define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd ) -#define osd_StateChange(object,value) __osd_StateChange( object, value ) +#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 *) ); + +#define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button) /** * Show the OSD menu. @@ -529,7 +535,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. */ -static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd ) +static inline bool osd_GetKeyPressed( osd_menu_t *p_osd ) { return( p_osd->p_state->b_update ); } @@ -550,10 +556,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; @@ -565,9 +571,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; @@ -585,7 +591,7 @@ static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value ) */ 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 ) ); +VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) ); /** * Default feedback images @@ -640,16 +646,13 @@ VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, te * \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 ) ); +VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_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 +#define vout_OSDMessage( obj, chan, ...) \ + __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ ) /** * Display a slider on the video output.