1 /*****************************************************************************
\r
2 * vlc_osd.h - OSD menu definitions and function prototypes
\r
3 *****************************************************************************
\r
4 * Copyright (C) 2004-2005 M2X
\r
5 * $Id: vlc_osd.h 9451 2004-12-01 01:07:08Z jpsaman $
\r
7 * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
\r
9 * Added code from include/osd.h written by:
\r
10 * Copyright (C) 2003-2005 the VideoLAN team
\r
11 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
\r
13 * This program is free software; you can redistribute it and/or modify
\r
14 * it under the terms of the GNU General Public License as published by
\r
15 * the Free Software Foundation; either version 2 of the License, or
\r
16 * (at your option) any later version.
\r
18 * This program is distributed in the hope that it will be useful,
\r
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
21 * GNU General Public License for more details.
\r
23 * You should have received a copy of the GNU General Public License
\r
24 * along with this program; if not, write to the Free Software
\r
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
\r
26 *****************************************************************************/
\r
30 * The OSD menu core creates the OSD menu structure in memory. It parses a
\r
31 * configuration file that defines all elements that are part of the menu. The
\r
32 * core also handles all actions and menu structure updates on behalf of video
\r
33 * subpicture filters.
\r
35 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
\r
36 * specifies the final information on positioning of the current state image.
\r
37 * A subpicture filter is called each time a video picture has to be rendered, it
\r
38 * also gives a start and end date to the subpicture. The subpicture can be streamed
\r
39 * if used inside a transcoding command. For example:
\r
41 * vlc dvdsimple:///dev/dvd --extraintf rc
\r
42 * --sout='#transcode{osd}:std{access=udp,mux=ts,url=dest_ipaddr}'
\r
43 * --osdmenu-file=share/osdmenu/dvd.cfg
\r
45 * Each OSD menu element, called "action", defines a hotkey action. Each action
\r
46 * can have several states (unselect, select, pressed). Each state has an image
\r
47 * that represents the state visually. The commands "menu right", "menu left",
\r
48 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
\r
49 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
\r
50 * show and hide the OSD menu subpictures.
\r
52 * There is one special element called "range". A range is an arbritary range
\r
53 * of state images that can be browsed using "menu up" and "menu down" commands
\r
54 * on the rc interface.
\r
56 * The OSD menu configuration file uses a very simple syntax and basic parser.
\r
57 * A configuration file has the ".cfg". An example is "share/osdmenu/dvd256.cfg".
\r
61 #define _VLC_OSD_H 1
\r
63 #include "vlc_video.h"
\r
70 * \brief The OSD Menu configuration file format.
\r
72 * The configuration file syntax is very basic and so is its parser. See the
\r
73 * BNF formal representation below:
\r
75 * The keywords FILENAME and PATHNAME represent the filename and pathname specification
\r
76 * that is valid for the Operating System VLC is compiled for.
\r
78 * The hotkey actions that are supported by VLC are documented in the file src/libvlc. The
\r
79 * file include/vlc_keys.h defines some hotkey internals.
\r
81 * CONFIG_FILE = FILENAME '.cfg'
\r
82 * WS = [ ' ' | '\t' ]+
\r
83 * OSDMEN_PATH = PATHNAME
\r
84 * DIR = 'dir' WS OSDMENU_PATH '\n'
\r
85 * STATE = [ 'unselect' | 'select' | 'pressed' ]
\r
86 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
\r
88 * ACTION_TYPE = 'type' 'volume' '\n'
\r
89 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
\r
90 * ACTION_BLOCK_END = 'end' '\n'
\r
91 * ACTION_STATE = STATE WS FILENAME '\n'
\r
92 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
\r
93 * ACTION_RANGE_END = 'end' '\n'
\r
94 * ACTION_RANGE_STATE = FILENAME '\n'
\r
96 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
\r
97 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
\r
98 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
\r
103 * OSD menu position and picture type defines
\r
106 #define OSD_ALIGN_LEFT 0x1
\r
107 #define OSD_ALIGN_RIGHT 0x2
\r
108 #define OSD_ALIGN_TOP 0x4
\r
109 #define OSD_ALIGN_BOTTOM 0x8
\r
111 #define OSD_HOR_SLIDER 1
\r
112 #define OSD_VERT_SLIDER 2
\r
114 #define OSD_PLAY_ICON 1
\r
115 #define OSD_PAUSE_ICON 2
\r
116 #define OSD_SPEAKER_ICON 3
\r
117 #define OSD_MUTE_ICON 4
\r
120 * Text style information.
\r
121 * This struct is currently ignored
\r
123 struct text_style_t
\r
127 vlc_bool_t b_italic;
\r
129 vlc_bool_t b_underline;
\r
131 static const text_style_t default_text_style = { 22, 0xffffff, VLC_FALSE, VLC_FALSE, VLC_FALSE };
\r
134 * OSD menu button states
\r
136 * Every button has three states, either it is unselected, selected or pressed.
\r
137 * An OSD menu skin can associate images with each state.
\r
139 * OSD_BUTTON_UNSELECT 0
\r
140 * OSD_BUTTON_SELECT 1
\r
141 * OSD_BUTTON_PRESSED 2
\r
143 #define OSD_BUTTON_UNSELECT 0
\r
144 #define OSD_BUTTON_SELECT 1
\r
145 #define OSD_BUTTON_PRESSED 2
\r
150 * The OSD state object holds the state and associated images for a particular state
\r
151 * on the screen. The picture is displayed when this state is the active state.
\r
155 osd_state_t *p_next; /*< pointer to next state */
\r
156 osd_state_t *p_prev; /*< pointer to previous state */
\r
157 picture_t *p_pic; /*< picture of state */
\r
159 char *psz_state; /*< state name */
\r
160 int i_state; /*< state index */
\r
164 * OSD Button object
\r
166 * An OSD Button has different states. Each state has an image for display.
\r
168 struct osd_button_t
\r
170 osd_button_t *p_next; /*< pointer to next button */
\r
171 osd_button_t *p_prev; /*< pointer to previous button */
\r
172 osd_button_t *p_up; /*< pointer to up button */
\r
173 osd_button_t *p_down; /*< pointer to down button */
\r
175 osd_state_t *p_current_state; /*< pointer to current state image */
\r
176 osd_state_t *p_states; /*< doubly linked list of states */
\r
177 picture_t *p_feedback; /*< feedback picture */
\r
179 char *psz_name; /*< name of button */
\r
181 /* These member should probably be a struct hotkey */
\r
182 char *psz_action; /*< hotkey action name on button*/
\r
183 char *psz_action_down; /*< hotkey action name on range buttons for command "menu down" */
\r
184 /* end of hotkey specifics */
\r
186 int i_x; /*< x-position of button visible state image */
\r
187 int i_y; /*< y-position of button visible state image */
\r
189 /* range style button */
\r
190 vlc_bool_t b_range; /*< button should be interpreted as range */
\r
191 int i_ranges; /*< number of states */
\r
195 * OSD Menu State object
\r
197 * Represents the current state as displayed.
\r
199 /* Represent the menu state */
\r
200 struct osd_menu_state_t
\r
202 int i_x; /*< x position of spu region */
\r
203 int i_y; /*< y position of spu region */
\r
204 int i_width; /*< width of spu region */
\r
205 int i_height; /*< height of spu region */
\r
207 picture_t *p_pic; /*< pointer to picture to display */
\r
208 osd_button_t *p_visible; /*< shortcut to visible button */
\r
210 vlc_bool_t b_menu_visible; /*< menu currently visible? */
\r
211 vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */
\r
213 /* quick hack to volume state. */
\r
214 osd_button_t *p_volume; /*< pointer to volume range object. */
\r
220 * The main OSD Menu object, which holds a linked list to all buttons
\r
221 * and images that defines the menu. The p_state variable represents the
\r
222 * current state of the OSD Menu.
\r
228 int i_x; /*< x-position of OSD Menu on the video screen */
\r
229 int i_y; /*< y-position of OSD Menu on the video screen */
\r
230 int i_width; /*< width of OSD Menu on the video screen */
\r
231 int i_height; /*< height of OSD Menu on the video screen */
\r
233 char *psz_path; /*< directory where OSD menu images are stored */
\r
234 osd_button_t *p_button; /*< doubly linked list of buttons */
\r
235 osd_menu_state_t *p_state; /*< current state of OSD menu */
\r
237 /* quick link in the linked list. */
\r
238 osd_button_t *p_last_button; /*< pointer to last button in the list */
\r
242 * Initialize an osd_menu_t object
\r
244 * This functions has to be called before any call to other osd_menu_t* functions.
\r
245 * It creates the osd_menu object and holds a pointer to it during its lifetime.
\r
247 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
\r
250 * Delete the osd_menu_t object
\r
252 * This functions has to be called to release the associated module and memory
\r
253 * for the osdmenu. After return of this function the pointer to osd_menu_t* is invalid.
\r
255 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
\r
258 * Change state on an osd_button_t.
\r
260 * This function selects the specified state and returns a pointer to it. The
\r
261 * following states are currently supported:
\r
262 * \see OSD_BUTTON_UNSELECT
\r
263 * \see OSD_BUTTON_SELECT
\r
264 * \see OSD_BUTTON_PRESSED
\r
266 VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
\r
268 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
\r
269 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
\r
270 #define osd_StateChange(object,value) __osd_StateChange( object, value )
\r
273 * Show the OSD menu.
\r
275 * Show the OSD menu on the video output or mux it into the stream.
\r
276 * Every change to the OSD menu will now be visible in the output. An output
\r
277 * can be a video output window or a stream (\see stream output)
\r
279 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
\r
282 * Hide the OSD menu.
\r
284 * Stop showing the OSD menu on the video output or mux it into the stream.
\r
286 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
\r
289 * Activate the action of this OSD menu item.
\r
291 * The rc interface command "menu select" triggers the sending of an hotkey action
\r
292 * to the hotkey interface. The hotkey that belongs to the current highlighted
\r
293 * OSD menu item will be used.
\r
295 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
\r
297 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
\r
298 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
\r
299 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
\r
302 * Next OSD menu item
\r
304 * Select the next OSD menu item to be highlighted.
\r
305 * Note: The actual position on screen of the menu item is determined by the the
\r
306 * OSD menu configuration file.
\r
308 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
\r
311 * Previous OSD menu item
\r
313 * Select the previous OSD menu item to be highlighted.
\r
314 * Note: The actual position on screen of the menu item is determined by the the
\r
315 * OSD menu configuration file.
\r
317 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
\r
320 * OSD menu item above
\r
322 * Select the OSD menu item above the current item to be highlighted.
\r
323 * Note: The actual position on screen of the menu item is determined by the the
\r
324 * OSD menu configuration file.
\r
326 VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );
\r
329 * OSD menu item below
\r
331 * Select the next OSD menu item below the current item to be highlighted.
\r
332 * Note: The actual position on screen of the menu item is determined by the the
\r
333 * OSD menu configuration file.
\r
335 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
\r
337 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
\r
338 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
\r
339 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
\r
340 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
\r
343 * Display the audio volume bitmap.
\r
345 * Display the correct audio volume bitmap that corresponds to the
\r
346 * current Audio Volume setting.
\r
348 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
\r
350 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
\r
353 * Retrieve a non modifyable pointer to the OSD Menu state
\r
356 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
\r
358 return( p_osd->p_state );
\r
362 * Get the last key press received by the OSD Menu
\r
364 * Returns 0 when no key has been pressed or the value of the key pressed.
\r
366 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
\r
368 return( p_osd->p_state->b_update );
\r
372 * Set the key pressed to a value.
\r
374 * Assign a new key value to the last key pressed on the OSD Menu.
\r
376 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
\r
380 val.i_int = i_value;
\r
381 var_Set( p_this, "key-pressed", val );
\r
385 * Update the OSD Menu visibility flag.
\r
387 * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu should not be shown.
\r
389 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
\r
393 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
\r
394 var_Set( p_osd, "osd-menu-visible", val );
\r
398 * Update the OSD Menu update flag
\r
400 * If the OSD Menu should be updated then set the update flag to VLC_TRUE, else to VLC_FALSE.
\r
402 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
\r
406 val.b_bool = p_osd->p_state->b_update = b_value;
\r
407 var_Set( p_osd, "osd-menu-update", val );
\r
413 * Functions that provide the textual feedback on the OSD. They are shown on hotkey commands. The feedback
\r
414 * is also part of the osd_button_t object. The types are declared in the include file
\r
415 * include/vlc_osd.h
\r
418 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
\r
419 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
\r
420 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
\r
423 * Default feedback images
\r
425 * Functions that provide the default OSD feedback images on hotkey commands. These feedback
\r
426 * images are also part of the osd_button_t object. The types are declared in the include file
\r
427 * include/vlc_osd.h
\r
430 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, short ) );
\r
431 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, short ) );
\r
434 * Loading and parse the OSD Configuration file
\r
436 * These functions load/unload the OSD menu configuration file and create/destroy the
\r
437 * themable OSD menu structure on the OSD object.
\r
439 VLC_EXPORT( int, osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );
\r
440 VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );
\r
442 # ifdef __cplusplus
\r
446 #endif /* _VLC_OSD_H */
\r