X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_osd.h;h=cccc2aed3ea4b51563e28c9e8bd9c38563467631;hb=9146b77e2a2764aa1367f5acd69502dd6725203e;hp=99db0757db02310d6e3786ab9b6ece390f793dbb;hpb=4bf6d519bf503dabeb86e8912514c07f363c1a76;p=vlc diff --git a/include/vlc_osd.h b/include/vlc_osd.h index 99db0757db..cccc2aed3e 100644 --- a/include/vlc_osd.h +++ b/include/vlc_osd.h @@ -1,10 +1,12 @@ /***************************************************************************** - * vlc_osd.h - OSD menu definitions and function prototypes + * vlc_osd.h - OSD menu and subpictures definitions and function prototypes ***************************************************************************** + * Copyright (C) 1999-2006 the VideoLAN team * Copyright (C) 2004-2005 M2X * $Id$ * * Authors: Jean-Paul Saman + * Gildas Bazin * * Added code from include/osd.h written by: * Copyright (C) 2003-2005 the VideoLAN team @@ -25,8 +27,106 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ +#ifndef _VLC_OSD_H +#define _VLC_OSD_H 1 + +#include "vlc_vout.h" + +# 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. + * @{ + */ + +#include + /** - * \file + * 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 */ + 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 */ + 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_chain_t *p_chain; +}; + +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 *, bool ); + +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, bool ) ); +VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) ); + +/** @}*/ + +/********************************************************************** + * OSD Menu + **********************************************************************/ +/** + * \defgroup osdmenu OSD Menu * The OSD menu core creates the OSD menu structure in memory. It parses a * configuration file that defines all elements that are part of the menu. The * core also handles all actions and menu structure updates on behalf of video @@ -34,14 +134,20 @@ * * The file modules/video_filters/osdmenu.c implements a subpicture filter that * specifies the final information on positioning of the current state image. - * A subpicture filter is called each time a video picture has to be rendered, it - * also gives a start and end date to the subpicture. The subpicture can be streamed - * if used inside a transcoding command. For example: + * A subpicture filter is called each time a video picture has to be rendered, + * it also gives a start and end date to the subpicture. The subpicture can be + * streamed if used inside a transcoding command. For example: * * vlc dvdsimple:///dev/dvd --extraintf rc * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}' * --osdmenu-file=share/osdmenu/dvd.cfg * + * An example for local usage of the OSD menu is: + * + * vlc dvdsimple:///dev/dvd --extraintf rc + * --sub-filter osdmenu + * --osdmenu-file=share/osdmenu/dvd.cfg + * * Each OSD menu element, called "action", defines a hotkey action. Each action * can have several states (unselect, select, pressed). Each state has an image * that represents the state visually. The commands "menu right", "menu left", @@ -54,18 +160,11 @@ * on the rc interface. * * The OSD menu configuration file uses a very simple syntax and basic parser. - * A configuration file has the ".cfg". An example is "share/osdmenu/dvd256.cfg". + * A configuration file has the ".cfg". + * An example is "share/osdmenu/dvd256.cfg". + * @{ */ -#ifndef _VLC_OSD_H -#define _VLC_OSD_H 1 - -#include "vlc_video.h" - -# ifdef __cplusplus -extern "C" { -# endif - /** * \brief The OSD Menu configuration file format. * @@ -80,8 +179,9 @@ extern "C" { * * CONFIG_FILE = FILENAME '.cfg' * WS = [ ' ' | '\t' ]+ - * OSDMEN_PATH = PATHNAME + * OSDMENU_PATH = PATHNAME * DIR = 'dir' WS OSDMENU_PATH '\n' + * STYLE = 'style' [ 'default' | 'concat' ] '\n' * STATE = [ 'unselect' | 'select' | 'pressed' ] * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+ * @@ -145,10 +245,13 @@ struct text_style_t 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 */ - int i_text_align; /**< An alignment hint for the text */ }; /* Style flags for \ref text_style_t */ @@ -161,9 +264,7 @@ struct text_style_t #define STYLE_STRIKEOUT 64 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE, - 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 1, 0, -1, 0 }; - - + 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 }; /** * OSD menu button states @@ -194,6 +295,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 */ }; /** @@ -222,12 +328,28 @@ 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 */ }; +/** + * OSD Menu Style + * + * 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 + * first case is the default. + * + * To change the default style the keyword 'style' should be set to 'concat'. + */ + +#define OSD_MENU_STYLE_SIMPLE 0x0 +#define OSD_MENU_STYLE_CONCAT 0x1 + /** * OSD Menu State object * @@ -244,8 +366,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. */ @@ -266,6 +388,8 @@ struct osd_menu_t int i_y; /*< y-position of OSD Menu on the video screen */ 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 */ @@ -273,6 +397,11 @@ struct osd_menu_t /* quick link in the linked list. */ osd_button_t *p_last_button; /*< pointer to last button in the list */ + + /* misc parser */ + module_t *p_parser; /*< pointer to parser module */ + char *psz_file; /*< Config file name */ + image_handler_t *p_image; /*< handler to image loading and conversion libraries */ }; /** @@ -293,20 +422,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. @@ -402,7 +534,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 ); } @@ -423,10 +555,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; @@ -438,9 +570,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; @@ -458,7 +590,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 *, ... ) ); +VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) ); /** * Default feedback images @@ -468,17 +600,77 @@ VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) ); * 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, short ) ); -VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, short ) ); +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 + **********************************************************************/ /** - * Loading and parse the OSD Configuration file - * - * These functions load/unload the OSD menu configuration file and - * create/destroy the themable OSD menu structure on the OSD object. + * 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 *, ... ) 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__ ) + +/** + * 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( int, osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) ); -VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) ); +VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) ); # ifdef __cplusplus }