1 /*****************************************************************************
2 * vlc_osd.h - OSD menu and subpictures definitions and function prototypes
3 *****************************************************************************
4 * Copyright (Cà 1999-2006 the VideoLAN team
5 * Copyright (C) 2004-2005 M2X
8 * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
9 * Gildas Bazin <gbazin@videolan.org>
11 * Added code from include/osd.h written by:
12 * Copyright (C) 2003-2005 the VideoLAN team
13 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28 *****************************************************************************/
30 #if !defined( __LIBVLC__ )
31 #error You are not libvlc or one of its plugins. You cannot include this file
43 /**********************************************************************
45 **********************************************************************/
47 * \defgroup spu Subpicture Unit
48 * This module describes the programming interface for the subpicture unit.
49 * It includes functions allowing to create/destroy an spu, create/destroy
50 * subpictures and render them.
57 * Subpicture unit descriptor
63 vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
64 subpicture_t p_subpicture[VOUT_MAX_SUBPICTURES]; /**< subpictures */
65 int i_channel; /**< number of subpicture channels registered */
67 filter_t *p_blend; /**< alpha blending module */
68 filter_t *p_text; /**< text renderer module */
69 filter_t *p_scale; /**< scaling module */
70 vlc_bool_t b_force_crop; /**< force cropping of subpicture */
71 int i_crop_x, i_crop_y, i_crop_width, i_crop_height; /**< cropping */
73 int i_margin; /**< force position of a subpicture */
74 vlc_bool_t b_force_palette; /**< force palette of subpicture */
75 uint8_t palette[4][4]; /**< forced palette */
77 int ( *pf_control ) ( spu_t *, int, va_list );
79 /* Supciture filters */
80 filter_t *pp_filter[10];
84 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
86 if( p_spu->pf_control )
87 return p_spu->pf_control( p_spu, i_query, args );
91 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
96 va_start( args, i_query );
97 i_result = spu_vaControl( p_spu, i_query, args );
104 SPU_CHANNEL_REGISTER, /* arg1= int * res= */
105 SPU_CHANNEL_CLEAR /* arg1= int res= */
108 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
109 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
110 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
111 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
112 void spu_Attach( spu_t *, vlc_object_t *, vlc_bool_t );
114 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
115 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
116 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
118 #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
119 VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
120 #define spu_MakeRegion(a,b,c) __spu_MakeRegion(VLC_OBJECT(a),b,c)
121 VLC_EXPORT( subpicture_region_t *,__spu_MakeRegion, ( vlc_object_t *, video_format_t *, picture_t * ) );
122 #define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
123 VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
124 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t, vlc_bool_t ) );
125 VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) );
129 /**********************************************************************
131 **********************************************************************/
133 * \defgroup osdmenu OSD Menu
134 * The OSD menu core creates the OSD menu structure in memory. It parses a
135 * configuration file that defines all elements that are part of the menu. The
136 * core also handles all actions and menu structure updates on behalf of video
137 * subpicture filters.
139 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
140 * specifies the final information on positioning of the current state image.
141 * A subpicture filter is called each time a video picture has to be rendered,
142 * it also gives a start and end date to the subpicture. The subpicture can be
143 * streamed if used inside a transcoding command. For example:
145 * vlc dvdsimple:///dev/dvd --extraintf rc
146 * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
147 * --osdmenu-file=share/osdmenu/dvd.cfg
149 * Each OSD menu element, called "action", defines a hotkey action. Each action
150 * can have several states (unselect, select, pressed). Each state has an image
151 * that represents the state visually. The commands "menu right", "menu left",
152 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
153 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
154 * show and hide the OSD menu subpictures.
156 * There is one special element called "range". A range is an arbritary range
157 * of state images that can be browsed using "menu up" and "menu down" commands
158 * on the rc interface.
160 * The OSD menu configuration file uses a very simple syntax and basic parser.
161 * A configuration file has the ".cfg".
162 * An example is "share/osdmenu/dvd256.cfg".
167 * \brief The OSD Menu configuration file format.
169 * The configuration file syntax is very basic and so is its parser. See the
170 * BNF formal representation below:
172 * The keywords FILENAME and PATHNAME represent the filename and pathname
173 * specification that is valid for the Operating System VLC is compiled for.
175 * The hotkey actions that are supported by VLC are documented in the file
176 * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
178 * CONFIG_FILE = FILENAME '.cfg'
179 * WS = [ ' ' | '\t' ]+
180 * OSDMEN_PATH = PATHNAME
181 * DIR = 'dir' WS OSDMENU_PATH '\n'
182 * STATE = [ 'unselect' | 'select' | 'pressed' ]
183 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
185 * ACTION_TYPE = 'type' 'volume' '\n'
186 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
187 * ACTION_BLOCK_END = 'end' '\n'
188 * ACTION_STATE = STATE WS FILENAME '\n'
189 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
190 * ACTION_RANGE_END = 'end' '\n'
191 * ACTION_RANGE_STATE = FILENAME '\n'
193 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
194 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
195 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
200 * OSD menu position and picture type defines
203 #define OSD_ALIGN_LEFT 0x1
204 #define OSD_ALIGN_RIGHT 0x2
205 #define OSD_ALIGN_TOP 0x4
206 #define OSD_ALIGN_BOTTOM 0x8
208 #define OSD_HOR_SLIDER 1
209 #define OSD_VERT_SLIDER 2
211 #define OSD_PLAY_ICON 1
212 #define OSD_PAUSE_ICON 2
213 #define OSD_SPEAKER_ICON 3
214 #define OSD_MUTE_ICON 4
219 * A text style is used to specify the formatting of text.
220 * A font renderer can use the supplied information to render the
225 char * psz_fontname; /**< The name of the font */
226 int i_font_size; /**< The font size in pixels */
227 int i_font_color; /**< The color of the text 0xRRGGBB
228 (native endianness) */
229 int i_font_alpha; /**< The transparency of the text.
230 0x00 is fully opaque,
231 0xFF fully transparent */
232 int i_style_flags; /**< Formatting style flags */
233 int i_outline_color; /**< The color of the outline 0xRRGGBB */
234 int i_outline_alpha; /**< The transparency of the outline.
235 0x00 is fully opaque,
236 0xFF fully transparent */
237 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
238 int i_shadow_alpha; /**< The transparency of the shadow.
239 0x00 is fully opaque,
240 0xFF fully transparent */
241 int i_background_color;/**< The color of the background 0xRRGGBB */
242 int i_background_alpha;/**< The transparency of the background.
243 0x00 is fully opaque,
244 0xFF fully transparent */
245 int i_outline_width; /**< The width of the outline in pixels */
246 int i_shadow_width; /**< The width of the shadow in pixels */
247 int i_spacing; /**< The spaceing between glyphs in pixels */
248 int i_text_align; /**< An alignment hint for the text */
251 /* Style flags for \ref text_style_t */
253 #define STYLE_ITALIC 2
254 #define STYLE_OUTLINE 4
255 #define STYLE_SHADOW 8
256 #define STYLE_BACKGROUND 16
257 #define STYLE_UNDERLINE 32
258 #define STYLE_STRIKEOUT 64
260 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
261 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 1, 0, -1, 0 };
266 * OSD menu button states
268 * Every button has three states, either it is unselected, selected or pressed.
269 * An OSD menu skin can associate images with each state.
271 * OSD_BUTTON_UNSELECT 0
272 * OSD_BUTTON_SELECT 1
273 * OSD_BUTTON_PRESSED 2
275 #define OSD_BUTTON_UNSELECT 0
276 #define OSD_BUTTON_SELECT 1
277 #define OSD_BUTTON_PRESSED 2
282 * The OSD state object holds the state and associated images for a
283 * particular state on the screen. The picture is displayed when this
284 * state is the active state.
288 osd_state_t *p_next; /*< pointer to next state */
289 osd_state_t *p_prev; /*< pointer to previous state */
290 picture_t *p_pic; /*< picture of state */
292 char *psz_state; /*< state name */
293 int i_state; /*< state index */
299 * An OSD Button has different states. Each state has an image for display.
303 osd_button_t *p_next; /*< pointer to next button */
304 osd_button_t *p_prev; /*< pointer to previous button */
305 osd_button_t *p_up; /*< pointer to up button */
306 osd_button_t *p_down; /*< pointer to down button */
308 osd_state_t *p_current_state; /*< pointer to current state image */
309 osd_state_t *p_states; /*< doubly linked list of states */
310 picture_t *p_feedback; /*< feedback picture */
312 char *psz_name; /*< name of button */
314 /* These member should probably be a struct hotkey */
315 char *psz_action; /*< hotkey action name on button*/
316 char *psz_action_down; /*< hotkey action name on range buttons
317 for command "menu down" */
318 /* end of hotkey specifics */
320 int i_x; /*< x-position of button visible state image */
321 int i_y; /*< y-position of button visible state image */
323 /* range style button */
324 vlc_bool_t b_range; /*< button should be interpreted as range */
325 int i_ranges; /*< number of states */
329 * OSD Menu State object
331 * Represents the current state as displayed.
333 /* Represent the menu state */
334 struct osd_menu_state_t
336 int i_x; /*< x position of spu region */
337 int i_y; /*< y position of spu region */
338 int i_width; /*< width of spu region */
339 int i_height; /*< height of spu region */
341 picture_t *p_pic; /*< pointer to picture to display */
342 osd_button_t *p_visible; /*< shortcut to visible button */
344 vlc_bool_t b_menu_visible; /*< menu currently visible? */
345 vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */
347 /* quick hack to volume state. */
348 osd_button_t *p_volume; /*< pointer to volume range object. */
354 * The main OSD Menu object, which holds a linked list to all buttons
355 * and images that defines the menu. The p_state variable represents the
356 * current state of the OSD Menu.
362 int i_x; /*< x-position of OSD Menu on the video screen */
363 int i_y; /*< y-position of OSD Menu on the video screen */
364 int i_width; /*< width of OSD Menu on the video screen */
365 int i_height; /*< height of OSD Menu on the video screen */
367 char *psz_path; /*< directory where OSD menu images are stored */
368 osd_button_t *p_button; /*< doubly linked list of buttons */
369 osd_menu_state_t *p_state; /*< current state of OSD menu */
371 /* quick link in the linked list. */
372 osd_button_t *p_last_button; /*< pointer to last button in the list */
376 * Initialize an osd_menu_t object
378 * This functions has to be called before any call to other osd_menu_t*
379 * functions. It creates the osd_menu object and holds a pointer to it
380 * during its lifetime.
382 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
385 * Delete the osd_menu_t object
387 * This functions has to be called to release the associated module and
388 * memory for the osdmenu. After return of this function the pointer to
389 * osd_menu_t* is invalid.
391 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
394 * Change state on an osd_button_t.
396 * This function selects the specified state and returns a pointer to it. The
397 * following states are currently supported:
398 * \see OSD_BUTTON_UNSELECT
399 * \see OSD_BUTTON_SELECT
400 * \see OSD_BUTTON_PRESSED
402 VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
404 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
405 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
406 #define osd_StateChange(object,value) __osd_StateChange( object, value )
411 * Show the OSD menu on the video output or mux it into the stream.
412 * Every change to the OSD menu will now be visible in the output. An output
413 * can be a video output window or a stream (\see stream output)
415 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
420 * Stop showing the OSD menu on the video output or mux it into the stream.
422 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
425 * Activate the action of this OSD menu item.
427 * The rc interface command "menu select" triggers the sending of an
428 * hotkey action to the hotkey interface. The hotkey that belongs to
429 * the current highlighted OSD menu item will be used.
431 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
433 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
434 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
435 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
440 * Select the next OSD menu item to be highlighted.
441 * Note: The actual position on screen of the menu item is determined by
442 * the OSD menu configuration file.
444 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
447 * Previous OSD menu item
449 * Select the previous OSD menu item to be highlighted.
450 * Note: The actual position on screen of the menu item is determined by
451 * the OSD menu configuration file.
453 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
456 * OSD menu item above
458 * Select the OSD menu item above the current item to be highlighted.
459 * Note: The actual position on screen of the menu item is determined by
460 * the OSD menu configuration file.
462 VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );
465 * OSD menu item below
467 * Select the next OSD menu item below the current item to be highlighted.
468 * Note: The actual position on screen of the menu item is determined by
469 * the OSD menu configuration file.
471 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
473 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
474 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
475 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
476 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
479 * Display the audio volume bitmap.
481 * Display the correct audio volume bitmap that corresponds to the
482 * current Audio Volume setting.
484 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
486 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
489 * Retrieve a non modifyable pointer to the OSD Menu state
492 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
494 return( p_osd->p_state );
498 * Get the last key press received by the OSD Menu
500 * Returns 0 when no key has been pressed or the value of the key pressed.
502 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
504 return( p_osd->p_state->b_update );
508 * Set the key pressed to a value.
510 * Assign a new key value to the last key pressed on the OSD Menu.
512 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
517 var_Set( p_this, "key-pressed", val );
521 * Update the OSD Menu visibility flag.
523 * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu
524 * should not be shown.
526 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
530 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
531 var_Set( p_osd, "osd-menu-visible", val );
535 * Update the OSD Menu update flag
537 * If the OSD Menu should be updated then set the update flag to
538 * VLC_TRUE, else to VLC_FALSE.
540 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
544 val.b_bool = p_osd->p_state->b_update = b_value;
545 var_Set( p_osd, "osd-menu-update", val );
551 * Functions that provide the textual feedback on the OSD. They are shown
552 * on hotkey commands. The feedback is also part of the osd_button_t
553 * object. The types are declared in the include file include/vlc_osd.h
556 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
557 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
558 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
561 * Default feedback images
563 * Functions that provide the default OSD feedback images on hotkey
564 * commands. These feedback images are also part of the osd_button_t
565 * object. The types are declared in the include file include/vlc_osd.h
568 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
569 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
572 * Loading and parse the OSD Configuration file
574 * These functions load/unload the OSD menu configuration file and
575 * create/destroy the themable OSD menu structure on the OSD object.
577 VLC_EXPORT( int, osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );
578 VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );
582 /**********************************************************************
583 * Vout text and widget overlays
584 **********************************************************************/
587 * Show text on the video for some time
588 * \param p_vout pointer to the vout the text is to be showed on
589 * \param i_channel Subpicture channel
590 * \param psz_string The text to be shown
591 * \param p_style Pointer to a struct with text style info
592 * \param i_flags flags for alignment and such
593 * \param i_hmargin horizontal margin in pixels
594 * \param i_vmargin vertical margin in pixels
595 * \param i_duration Amount of time the text is to be shown.
597 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
600 * Show text on the video from a given start date to a given end date
601 * \param p_vout pointer to the vout the text is to be showed on
602 * \param i_channel Subpicture channel
603 * \param psz_string The text to be shown
604 * \param p_style Pointer to a struct with text style info
605 * \param i_flags flags for alignment and such
606 * \param i_hmargin horizontal margin in pixels
607 * \param i_vmargin vertical margin in pixels
608 * \param i_start the time when this string is to appear on the video
609 * \param i_stop the time when this string should stop to be displayed
610 * if this is 0 the string will be shown untill the next string
611 * is about to be shown
613 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
616 * Write an informative message at the default location,
617 * for the default duration and only if the OSD option is enabled.
618 * \param p_caller The object that called the function.
619 * \param i_channel Subpicture channel
620 * \param psz_format printf style formatting
622 VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, char *, ... ) );
625 * Same as __vlc_OSDMessage() but with automatic casting
627 #if defined(HAVE_VARIADIC_MACROS)
628 # define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args )
630 # define vout_OSDMessage __vout_OSDMessage
634 * Display a slider on the video output.
635 * \param p_this The object that called the function.
636 * \param i_channel Subpicture channel
637 * \param i_postion Current position in the slider
638 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
641 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
644 * Display an Icon on the video output.
645 * \param p_this The object that called the function.
646 * \param i_channel Subpicture channel
647 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
650 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
656 #endif /* _VLC_OSD_H */