1 /*****************************************************************************
2 * vlc_osd.h - OSD menu definitions and function prototypes
3 *****************************************************************************
4 * Copyright (C) 2004-2005 M2X
7 * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
9 * Added code from include/osd.h written by:
10 * Copyright (C) 2003-2005 the VideoLAN team
11 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
30 * The OSD menu core creates the OSD menu structure in memory. It parses a
31 * configuration file that defines all elements that are part of the menu. The
32 * core also handles all actions and menu structure updates on behalf of video
35 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
36 * specifies the final information on positioning of the current state image.
37 * A subpicture filter is called each time a video picture has to be rendered, it
38 * also gives a start and end date to the subpicture. The subpicture can be streamed
39 * if used inside a transcoding command. For example:
41 * vlc dvdsimple:///dev/dvd --extraintf rc
42 * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
43 * --osdmenu-file=share/osdmenu/dvd.cfg
45 * Each OSD menu element, called "action", defines a hotkey action. Each action
46 * can have several states (unselect, select, pressed). Each state has an image
47 * that represents the state visually. The commands "menu right", "menu left",
48 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
49 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
50 * show and hide the OSD menu subpictures.
52 * There is one special element called "range". A range is an arbritary range
53 * of state images that can be browsed using "menu up" and "menu down" commands
54 * on the rc interface.
56 * The OSD menu configuration file uses a very simple syntax and basic parser.
57 * A configuration file has the ".cfg". An example is "share/osdmenu/dvd256.cfg".
63 #include "vlc_video.h"
70 * \brief The OSD Menu configuration file format.
72 * The configuration file syntax is very basic and so is its parser. See the
73 * BNF formal representation below:
75 * The keywords FILENAME and PATHNAME represent the filename and pathname
76 * specification that is valid for the Operating System VLC is compiled for.
78 * The hotkey actions that are supported by VLC are documented in the file
79 * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
81 * CONFIG_FILE = FILENAME '.cfg'
82 * WS = [ ' ' | '\t' ]+
83 * OSDMEN_PATH = PATHNAME
84 * DIR = 'dir' WS OSDMENU_PATH '\n'
85 * STATE = [ 'unselect' | 'select' | 'pressed' ]
86 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
88 * ACTION_TYPE = 'type' 'volume' '\n'
89 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
90 * ACTION_BLOCK_END = 'end' '\n'
91 * ACTION_STATE = STATE WS FILENAME '\n'
92 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
93 * ACTION_RANGE_END = 'end' '\n'
94 * ACTION_RANGE_STATE = FILENAME '\n'
96 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
97 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
98 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
103 * OSD menu position and picture type defines
106 #define OSD_ALIGN_LEFT 0x1
107 #define OSD_ALIGN_RIGHT 0x2
108 #define OSD_ALIGN_TOP 0x4
109 #define OSD_ALIGN_BOTTOM 0x8
111 #define OSD_HOR_SLIDER 1
112 #define OSD_VERT_SLIDER 2
114 #define OSD_PLAY_ICON 1
115 #define OSD_PAUSE_ICON 2
116 #define OSD_SPEAKER_ICON 3
117 #define OSD_MUTE_ICON 4
122 * A text style is used to specify the formatting of text.
123 * A font renderer can use the supplied information to render the
128 char * psz_fontname; /**< The name of the font */
129 int i_font_size; /**< The font size in pixels */
130 int i_font_color; /**< The color of the text 0xRRGGBB
131 (native endianness) */
132 int i_font_alpha; /**< The transparency of the text.
133 0x00 is fully opaque,
134 0xFF fully transparent */
135 int i_style_flags; /**< Formatting style flags */
136 int i_outline_color; /**< The color of the outline 0xRRGGBB */
137 int i_outline_alpha; /**< The transparency of the outline.
138 0x00 is fully opaque,
139 0xFF fully transparent */
140 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
141 int i_shadow_alpha; /**< The transparency of the shadow.
142 0x00 is fully opaque,
143 0xFF fully transparent */
144 int i_background_color;/**< The color of the background 0xRRGGBB */
145 int i_background_alpha;/**< The transparency of the background.
146 0x00 is fully opaque,
147 0xFF fully transparent */
148 int i_outline_width; /**< The width of the outline in pixels */
149 int i_shadow_width; /**< The width of the shadow in pixels */
150 int i_spacing; /**< The spaceing between glyphs in pixels */
151 int i_text_align; /**< An alignment hint for the text */
154 /* Style flags for \ref text_style_t */
156 #define STYLE_ITALIC 2
157 #define STYLE_OUTLINE 4
158 #define STYLE_SHADOW 8
159 #define STYLE_BACKGROUND 16
160 #define STYLE_UNDERLINE 32
161 #define STYLE_STRIKEOUT 64
163 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
164 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 1, 0, -1, 0 };
169 * OSD menu button states
171 * Every button has three states, either it is unselected, selected or pressed.
172 * An OSD menu skin can associate images with each state.
174 * OSD_BUTTON_UNSELECT 0
175 * OSD_BUTTON_SELECT 1
176 * OSD_BUTTON_PRESSED 2
178 #define OSD_BUTTON_UNSELECT 0
179 #define OSD_BUTTON_SELECT 1
180 #define OSD_BUTTON_PRESSED 2
185 * The OSD state object holds the state and associated images for a
186 * particular state on the screen. The picture is displayed when this
187 * state is the active state.
191 osd_state_t *p_next; /*< pointer to next state */
192 osd_state_t *p_prev; /*< pointer to previous state */
193 picture_t *p_pic; /*< picture of state */
195 char *psz_state; /*< state name */
196 int i_state; /*< state index */
202 * An OSD Button has different states. Each state has an image for display.
206 osd_button_t *p_next; /*< pointer to next button */
207 osd_button_t *p_prev; /*< pointer to previous button */
208 osd_button_t *p_up; /*< pointer to up button */
209 osd_button_t *p_down; /*< pointer to down button */
211 osd_state_t *p_current_state; /*< pointer to current state image */
212 osd_state_t *p_states; /*< doubly linked list of states */
213 picture_t *p_feedback; /*< feedback picture */
215 char *psz_name; /*< name of button */
217 /* These member should probably be a struct hotkey */
218 char *psz_action; /*< hotkey action name on button*/
219 char *psz_action_down; /*< hotkey action name on range buttons
220 for command "menu down" */
221 /* end of hotkey specifics */
223 int i_x; /*< x-position of button visible state image */
224 int i_y; /*< y-position of button visible state image */
226 /* range style button */
227 vlc_bool_t b_range; /*< button should be interpreted as range */
228 int i_ranges; /*< number of states */
232 * OSD Menu State object
234 * Represents the current state as displayed.
236 /* Represent the menu state */
237 struct osd_menu_state_t
239 int i_x; /*< x position of spu region */
240 int i_y; /*< y position of spu region */
241 int i_width; /*< width of spu region */
242 int i_height; /*< height of spu region */
244 picture_t *p_pic; /*< pointer to picture to display */
245 osd_button_t *p_visible; /*< shortcut to visible button */
247 vlc_bool_t b_menu_visible; /*< menu currently visible? */
248 vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */
250 /* quick hack to volume state. */
251 osd_button_t *p_volume; /*< pointer to volume range object. */
257 * The main OSD Menu object, which holds a linked list to all buttons
258 * and images that defines the menu. The p_state variable represents the
259 * current state of the OSD Menu.
265 int i_x; /*< x-position of OSD Menu on the video screen */
266 int i_y; /*< y-position of OSD Menu on the video screen */
267 int i_width; /*< width of OSD Menu on the video screen */
268 int i_height; /*< height of OSD Menu on the video screen */
270 char *psz_path; /*< directory where OSD menu images are stored */
271 osd_button_t *p_button; /*< doubly linked list of buttons */
272 osd_menu_state_t *p_state; /*< current state of OSD menu */
274 /* quick link in the linked list. */
275 osd_button_t *p_last_button; /*< pointer to last button in the list */
279 * Initialize an osd_menu_t object
281 * This functions has to be called before any call to other osd_menu_t*
282 * functions. It creates the osd_menu object and holds a pointer to it
283 * during its lifetime.
285 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
288 * Delete the osd_menu_t object
290 * This functions has to be called to release the associated module and
291 * memory for the osdmenu. After return of this function the pointer to
292 * osd_menu_t* is invalid.
294 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
297 * Change state on an osd_button_t.
299 * This function selects the specified state and returns a pointer to it. The
300 * following states are currently supported:
301 * \see OSD_BUTTON_UNSELECT
302 * \see OSD_BUTTON_SELECT
303 * \see OSD_BUTTON_PRESSED
305 VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
307 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
308 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
309 #define osd_StateChange(object,value) __osd_StateChange( object, value )
314 * Show the OSD menu on the video output or mux it into the stream.
315 * Every change to the OSD menu will now be visible in the output. An output
316 * can be a video output window or a stream (\see stream output)
318 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
323 * Stop showing the OSD menu on the video output or mux it into the stream.
325 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
328 * Activate the action of this OSD menu item.
330 * The rc interface command "menu select" triggers the sending of an
331 * hotkey action to the hotkey interface. The hotkey that belongs to
332 * the current highlighted OSD menu item will be used.
334 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
336 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
337 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
338 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
343 * Select the next OSD menu item to be highlighted.
344 * Note: The actual position on screen of the menu item is determined by
345 * the OSD menu configuration file.
347 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
350 * Previous OSD menu item
352 * Select the previous OSD menu item to be highlighted.
353 * Note: The actual position on screen of the menu item is determined by
354 * the OSD menu configuration file.
356 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
359 * OSD menu item above
361 * Select the OSD menu item above the current item to be highlighted.
362 * Note: The actual position on screen of the menu item is determined by
363 * the OSD menu configuration file.
365 VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );
368 * OSD menu item below
370 * Select the next OSD menu item below the current item to be highlighted.
371 * Note: The actual position on screen of the menu item is determined by
372 * the OSD menu configuration file.
374 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
376 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
377 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
378 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
379 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
382 * Display the audio volume bitmap.
384 * Display the correct audio volume bitmap that corresponds to the
385 * current Audio Volume setting.
387 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
389 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
392 * Retrieve a non modifyable pointer to the OSD Menu state
395 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
397 return( p_osd->p_state );
401 * Get the last key press received by the OSD Menu
403 * Returns 0 when no key has been pressed or the value of the key pressed.
405 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
407 return( p_osd->p_state->b_update );
411 * Set the key pressed to a value.
413 * Assign a new key value to the last key pressed on the OSD Menu.
415 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
420 var_Set( p_this, "key-pressed", val );
424 * Update the OSD Menu visibility flag.
426 * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu
427 * should not be shown.
429 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
433 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
434 var_Set( p_osd, "osd-menu-visible", val );
438 * Update the OSD Menu update flag
440 * If the OSD Menu should be updated then set the update flag to
441 * VLC_TRUE, else to VLC_FALSE.
443 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
447 val.b_bool = p_osd->p_state->b_update = b_value;
448 var_Set( p_osd, "osd-menu-update", val );
454 * Functions that provide the textual feedback on the OSD. They are shown
455 * on hotkey commands. The feedback is also part of the osd_button_t
456 * object. The types are declared in the include file include/vlc_osd.h
459 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
460 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
461 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
464 * Default feedback images
466 * Functions that provide the default OSD feedback images on hotkey
467 * commands. These feedback images are also part of the osd_button_t
468 * object. The types are declared in the include file include/vlc_osd.h
471 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
472 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
475 * Loading and parse the OSD Configuration file
477 * These functions load/unload the OSD menu configuration file and
478 * create/destroy the themable OSD menu structure on the OSD object.
480 VLC_EXPORT( int, osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );
481 VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );
487 #endif /* _VLC_OSD_H */