OSD Menu

The OSD menu core creates the OSD menu structure in memory. More...


Data Structures
struct	text_style_t
	Text style. More...
struct	osd_state_t
	OSD State object. More...
struct	osd_button_t
	OSD Button object. More...
struct	osd_menu_state_t
	OSD Menu State object. More...
struct	osd_menu_t
	OSD Menu object. More...
Defines
#define	OSD_ALIGN_LEFT 0x1
	OSD menu position and picture type defines.
#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
#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
#define	OSD_BUTTON_UNSELECT 0
	OSD menu button states.
#define	OSD_BUTTON_SELECT 1
#define	OSD_BUTTON_PRESSED 2
#define	OSD_MENU_STYLE_SIMPLE 0x0
	OSD Menu Style.
#define	OSD_MENU_STYLE_CONCAT 0x1
#define	osd_MenuCreate(object, file) __osd_MenuCreate( VLC_OBJECT(object), file )
#define	osd_MenuDelete(object, osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
#define	osd_ButtonFind(object, x, y, h, w, sh, sw) __osd_ButtonFind(object,x,y,h,w,sh,sw)
#define	osd_ButtonSelect(object, button) __osd_ButtonSelect(object,button)
#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_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_Volume(object) __osd_Volume( VLC_OBJECT(object) )
Functions
osd_menu_t *	__osd_MenuCreate (vlc_object_t , const char )
	Initialize an osd_menu_t object.
void	__osd_MenuDelete (vlc_object_t , osd_menu_t )
	Delete the osd_menu_t object.
osd_button_t *	__osd_ButtonFind (vlc_object_t *p_this, int, int, int, int, int, int)
	Find OSD Menu button at position x,y.
void	__osd_ButtonSelect (vlc_object_t , osd_button_t )
	Select the button provided as the new active button.
void	__osd_MenuShow (vlc_object_t *)
	Show the OSD menu.
void	__osd_MenuHide (vlc_object_t *)
	Hide the OSD menu.
void	__osd_MenuActivate (vlc_object_t *)
	Activate the action of this OSD menu item.
void	__osd_MenuNext (vlc_object_t *)
	Next OSD menu item.
void	__osd_MenuPrev (vlc_object_t *)
	Previous OSD menu item.
void	__osd_MenuUp (vlc_object_t *)
	OSD menu item above.
void	__osd_MenuDown (vlc_object_t *)
	OSD menu item below.
void	__osd_Volume (vlc_object_t *)
	Display the audio volume bitmap.
static const osd_menu_state_t *	osd_GetMenuState (osd_menu_t *p_osd)
	Retrieve a non modifyable pointer to the OSD Menu state.
static bool	osd_GetKeyPressed (osd_menu_t *p_osd)
	Get the last key press received by the OSD Menu.
static void	osd_SetKeyPressed (vlc_object_t *p_this, int i_value)
	Set the key pressed to a value.
static void	osd_SetMenuVisible (osd_menu_t *p_osd, bool b_value)
	Update the OSD Menu visibility flag.
static void	osd_SetMenuUpdate (osd_menu_t *p_osd, bool b_value)
	Update the OSD Menu update flag.
int	osd_ShowTextRelative (spu_t , int, char , text_style_t *, int, int, int, mtime_t)
	Textual feedback.
int	osd_ShowTextAbsolute (spu_t , int, char , text_style_t *, int, int, int, mtime_t, mtime_t)
	Show text on the video from a given start date to a given end date.
void	osd_Message (spu_t , int, char ,...)
	Write an informative message at the default location, for the default duration and only if the OSD option is enabled.
int	osd_Slider (vlc_object_t , spu_t , int, int, int, int, int, int, short)
	Default feedback images.
int	osd_Icon (vlc_object_t , spu_t , int, int, int, int, int, short)
Variables
static const text_style_t	default_text_style

Detailed Description

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 subpicture filters.

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:

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", "menu up" and "menu down" are used to navigate through the OSD menu structure. The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively show and hide the OSD menu subpictures.

There is one special element called "range". A range is an arbritary range of state images that can be browsed using "menu up" and "menu down" commands 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".

Define Documentation

#define OSD_ALIGN_BOTTOM 0x8

#define OSD_ALIGN_LEFT 0x1

OSD menu position and picture type defines.

#define OSD_ALIGN_RIGHT 0x2

#define OSD_ALIGN_TOP 0x4

#define OSD_BUTTON_PRESSED 2

#define OSD_BUTTON_SELECT 1

#define OSD_BUTTON_UNSELECT 0

OSD menu button states.

Every button has three states, either it is unselected, selected or pressed. An OSD menu skin can associate images with each state.

OSD_BUTTON_UNSELECT 0 OSD_BUTTON_SELECT 1 OSD_BUTTON_PRESSED 2

#define osd_ButtonFind	(	object,
		x,
		y,
		h,
		w,
		sh,
		sw	)	__osd_ButtonFind(object,x,y,h,w,sh,sw)

#define osd_ButtonSelect	(	object,
		button		)	__osd_ButtonSelect(object,button)

#define OSD_HOR_SLIDER 1

#define OSD_MENU_STYLE_CONCAT 0x1

#define OSD_MENU_STYLE_SIMPLE 0x0

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_MenuActivate ( object ) __osd_MenuActivate( VLC_OBJECT(object) )

#define osd_MenuCreate	(	object,
		file		)	__osd_MenuCreate( VLC_OBJECT(object), file )

#define osd_MenuDelete	(	object,
		osd		)	__osd_MenuDelete( VLC_OBJECT(object), osd )

#define osd_MenuDown ( object ) __osd_MenuDown( VLC_OBJECT(object) )

#define osd_MenuHide ( object ) __osd_MenuHide( VLC_OBJECT(object) )

#define osd_MenuNext ( object ) __osd_MenuNext( VLC_OBJECT(object) )

#define osd_MenuPrev ( object ) __osd_MenuPrev( VLC_OBJECT(object) )

#define osd_MenuShow ( object ) __osd_MenuShow( VLC_OBJECT(object) )

#define osd_MenuUp ( object ) __osd_MenuUp( VLC_OBJECT(object) )

#define OSD_MUTE_ICON 4

#define OSD_PAUSE_ICON 2

#define OSD_PLAY_ICON 1

#define OSD_SPEAKER_ICON 3

#define OSD_VERT_SLIDER 2

#define osd_Volume ( object ) __osd_Volume( VLC_OBJECT(object) )

#define STYLE_BACKGROUND 16

#define STYLE_BOLD 1

#define STYLE_ITALIC 2

#define STYLE_OUTLINE 4

#define STYLE_SHADOW 8

#define STYLE_STRIKEOUT 64

#define STYLE_UNDERLINE 32

Function Documentation

osd_button_t* __osd_ButtonFind	(	vlc_object_t *	p_this,
		int	,
		int	,
		int	,
		int	,
		int	,
		int
	)

Find OSD Menu button at position x,y.

void __osd_ButtonSelect	(	vlc_object_t *	,
		osd_button_t *
	)

Select the button provided as the new active button.

void __osd_MenuActivate ( vlc_object_t * )

Activate the action of this OSD menu item.

The rc interface command "menu select" triggers the sending of an hotkey action to the hotkey interface. The hotkey that belongs to the current highlighted OSD menu item will be used.

osd_menu_t* __osd_MenuCreate	(	vlc_object_t *	,
		const char *
	)

Initialize an osd_menu_t object.

This functions has to be called before any call to other osd_menu_t* functions. It creates the osd_menu object and holds a pointer to it during its lifetime.

void __osd_MenuDelete	(	vlc_object_t *	,
		osd_menu_t *
	)

Delete the osd_menu_t object.

This functions has to be called to release the associated module and memory for the osdmenu. After return of this function the pointer to osd_menu_t* is invalid.

void __osd_MenuDown ( vlc_object_t * )

OSD menu item below.

Select the next OSD menu item below the current item to be highlighted. Note: The actual position on screen of the menu item is determined by the OSD menu configuration file.

void __osd_MenuHide ( vlc_object_t * )

Hide the OSD menu.

Stop showing the OSD menu on the video output or mux it into the stream.

void __osd_MenuNext ( vlc_object_t * )

Next OSD menu item.

Select the next OSD menu item to be highlighted. Note: The actual position on screen of the menu item is determined by the OSD menu configuration file.

void __osd_MenuPrev ( vlc_object_t * )

Previous OSD menu item.

Select the previous OSD menu item to be highlighted. Note: The actual position on screen of the menu item is determined by the OSD menu configuration file.

void __osd_MenuShow ( vlc_object_t * )

Show the OSD menu.

Show the OSD menu on the video output or mux it into the stream. 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 also:: Stream output)

void __osd_MenuUp ( vlc_object_t * )

OSD menu item above.

Select the OSD menu item above the current item to be highlighted. Note: The actual position on screen of the menu item is determined by the OSD menu configuration file.

void __osd_Volume ( vlc_object_t * p_this )

Display the audio volume bitmap.

The OSD Menu audio volume bar is updated to reflect the new audio volume. Call this function when the audio volume is updated outside the OSD menu command "menu up", "menu down" or "menu select".

static bool osd_GetKeyPressed ( osd_menu_t * p_osd ) [inline, static]

Get the last key press received by the OSD Menu.

Returns 0 when no key has been pressed or the value of the key pressed.

static const osd_menu_state_t* osd_GetMenuState ( osd_menu_t * p_osd ) [inline, static]

Retrieve a non modifyable pointer to the OSD Menu state.

int osd_Icon	(	vlc_object_t *	,
		spu_t *	,
		int	,
		int	,
		int	,
		int	,
		int	,
		short
	)

void osd_Message	(	spu_t *	p_spu,
		int	i_channel,
		char *	psz_format,
			...
	)

Write an informative message at the default location, for the default duration and only if the OSD option is enabled.

Parameters:

	p_caller	The object that called the function.
	i_channel	Subpicture channel
	psz_format	printf style formatting

static void osd_SetKeyPressed	(	vlc_object_t *	p_this,
		int	i_value
	)			`[inline, static]`

Set the key pressed to a value.

Assign a new key value to the last key pressed on the OSD Menu.

static void osd_SetMenuUpdate	(	osd_menu_t *	p_osd,
		bool	b_value
	)			`[inline, static]`

Update the OSD Menu update flag.

If the OSD Menu should be updated then set the update flag to true, else to false.

static void osd_SetMenuVisible	(	osd_menu_t *	p_osd,
		bool	b_value
	)			`[inline, static]`

Update the OSD Menu visibility flag.

true means OSD Menu should be shown. false means OSD Menu should not be shown.

int osd_ShowTextAbsolute	(	spu_t *	p_spu_channel,
		int	i_channel,
		char *	psz_string,
		text_style_t *	p_style,
		int	i_flags,
		int	i_hmargin,
		int	i_vmargin,
		mtime_t	i_start,
		mtime_t	i_stop
	)

Show text on the video from a given start date to a given end date.

Parameters:

	p_spu	pointer to the subpicture queue the text is to be showed on
	i_channel	Subpicture channel
	psz_string	The text to be shown
	p_style	Pointer to a struct with text style info
	i_flags	flags for alignment and such
	i_hmargin	horizontal margin in pixels
	i_vmargin	vertical margin in pixels
	i_start	the time when this string is to appear on the video
	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

int osd_ShowTextRelative	(	spu_t *	p_spu,
		int	i_channel,
		char *	psz_string,
		text_style_t *	p_style,
		int	i_flags,
		int	i_hmargin,
		int	i_vmargin,
		mtime_t	i_duration
	)

Textual feedback.

Parameters:

	p_spu	pointer to the subpicture queue the text is to be showed on
	i_channel	Subpicture channel
	psz_string	The text to be shown
	p_style	Pointer to a struct with text style info
	i_flags	flags for alignment and such
	i_hmargin	horizontal margin in pixels
	i_vmargin	vertical margin in pixels
	i_duration	Amount of time the text is to be shown.

int osd_Slider	(	vlc_object_t *	,
		spu_t *	,
		int	,
		int	,
		int	,
		int	,
		int	,
		int	,
		short
	)

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 also:: vlc_osd.h

Variable Documentation

const text_style_t default_text_style [static]

Initial value:

 { NULL, 22, 0xffffff, 0xff,  4 ,
                0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 }

Generated on Wed Aug 13 08:05:54 2008 for VLC by

1.5.1

OSD Menu

Data Structures

Defines

Functions

Variables

Detailed Description

Define Documentation

Function Documentation

Variable Documentation