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 );
92 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
97 va_start( args, i_query );
98 i_result = spu_vaControl( p_spu, i_query, args );
105 SPU_CHANNEL_REGISTER, /* arg1= int * res= */
106 SPU_CHANNEL_CLEAR /* arg1= int res= */
109 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
110 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
111 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
112 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
113 void spu_Attach( spu_t *, vlc_object_t *, vlc_bool_t );
115 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
116 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
117 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
119 #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
120 VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
121 #define spu_MakeRegion(a,b,c) __spu_MakeRegion(VLC_OBJECT(a),b,c)
122 VLC_EXPORT( subpicture_region_t *,__spu_MakeRegion, ( vlc_object_t *, video_format_t *, picture_t * ) );
123 #define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
124 VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
125 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t, vlc_bool_t ) );
126 VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) );
130 /**********************************************************************
132 **********************************************************************/
134 * \defgroup osdmenu OSD Menu
135 * The OSD menu core creates the OSD menu structure in memory. It parses a
136 * configuration file that defines all elements that are part of the menu. The
137 * core also handles all actions and menu structure updates on behalf of video
138 * subpicture filters.
140 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
141 * specifies the final information on positioning of the current state image.
142 * A subpicture filter is called each time a video picture has to be rendered,
143 * it also gives a start and end date to the subpicture. The subpicture can be
144 * streamed if used inside a transcoding command. For example:
146 * vlc dvdsimple:///dev/dvd --extraintf rc
147 * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
148 * --osdmenu-file=share/osdmenu/dvd.cfg
150 * An example for local usage of the OSD menu is:
152 * vlc dvdsimple:///dev/dvd --extraintf rc
153 * --sub-filter osdmenu
154 * --osdmenu-file=share/osdmenu/dvd.cfg
156 * Each OSD menu element, called "action", defines a hotkey action. Each action
157 * can have several states (unselect, select, pressed). Each state has an image
158 * that represents the state visually. The commands "menu right", "menu left",
159 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
160 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
161 * show and hide the OSD menu subpictures.
163 * There is one special element called "range". A range is an arbritary range
164 * of state images that can be browsed using "menu up" and "menu down" commands
165 * on the rc interface.
167 * The OSD menu configuration file uses a very simple syntax and basic parser.
168 * A configuration file has the ".cfg".
169 * An example is "share/osdmenu/dvd256.cfg".
174 * \brief The OSD Menu configuration file format.
176 * The configuration file syntax is very basic and so is its parser. See the
177 * BNF formal representation below:
179 * The keywords FILENAME and PATHNAME represent the filename and pathname
180 * specification that is valid for the Operating System VLC is compiled for.
182 * The hotkey actions that are supported by VLC are documented in the file
183 * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
185 * CONFIG_FILE = FILENAME '.cfg'
186 * WS = [ ' ' | '\t' ]+
187 * OSDMENU_PATH = PATHNAME
188 * DIR = 'dir' WS OSDMENU_PATH '\n'
189 * STYLE = 'style' [ 'default' | 'concat' ] '\n'
190 * STATE = [ 'unselect' | 'select' | 'pressed' ]
191 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
193 * ACTION_TYPE = 'type' 'volume' '\n'
194 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
195 * ACTION_BLOCK_END = 'end' '\n'
196 * ACTION_STATE = STATE WS FILENAME '\n'
197 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
198 * ACTION_RANGE_END = 'end' '\n'
199 * ACTION_RANGE_STATE = FILENAME '\n'
201 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
202 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
203 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
208 * OSD menu position and picture type defines
211 #define OSD_ALIGN_LEFT 0x1
212 #define OSD_ALIGN_RIGHT 0x2
213 #define OSD_ALIGN_TOP 0x4
214 #define OSD_ALIGN_BOTTOM 0x8
216 #define OSD_HOR_SLIDER 1
217 #define OSD_VERT_SLIDER 2
219 #define OSD_PLAY_ICON 1
220 #define OSD_PAUSE_ICON 2
221 #define OSD_SPEAKER_ICON 3
222 #define OSD_MUTE_ICON 4
227 * A text style is used to specify the formatting of text.
228 * A font renderer can use the supplied information to render the
233 char * psz_fontname; /**< The name of the font */
234 int i_font_size; /**< The font size in pixels */
235 int i_font_color; /**< The color of the text 0xRRGGBB
236 (native endianness) */
237 int i_font_alpha; /**< The transparency of the text.
238 0x00 is fully opaque,
239 0xFF fully transparent */
240 int i_style_flags; /**< Formatting style flags */
241 int i_outline_color; /**< The color of the outline 0xRRGGBB */
242 int i_outline_alpha; /**< The transparency of the outline.
243 0x00 is fully opaque,
244 0xFF fully transparent */
245 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
246 int i_shadow_alpha; /**< The transparency of the shadow.
247 0x00 is fully opaque,
248 0xFF fully transparent */
249 int i_background_color;/**< The color of the background 0xRRGGBB */
250 int i_background_alpha;/**< The transparency of the background.
251 0x00 is fully opaque,
252 0xFF fully transparent */
253 int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
254 int i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
255 0x00 is fully opaque,
256 0xFF fully transparent */
257 int i_outline_width; /**< The width of the outline in pixels */
258 int i_shadow_width; /**< The width of the shadow in pixels */
259 int i_spacing; /**< The spaceing between glyphs in pixels */
262 /* Style flags for \ref text_style_t */
264 #define STYLE_ITALIC 2
265 #define STYLE_OUTLINE 4
266 #define STYLE_SHADOW 8
267 #define STYLE_BACKGROUND 16
268 #define STYLE_UNDERLINE 32
269 #define STYLE_STRIKEOUT 64
271 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
272 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 };
275 * OSD menu button states
277 * Every button has three states, either it is unselected, selected or pressed.
278 * An OSD menu skin can associate images with each state.
280 * OSD_BUTTON_UNSELECT 0
281 * OSD_BUTTON_SELECT 1
282 * OSD_BUTTON_PRESSED 2
284 #define OSD_BUTTON_UNSELECT 0
285 #define OSD_BUTTON_SELECT 1
286 #define OSD_BUTTON_PRESSED 2
288 static const char *ppsz_button_states[] = { "unselect", "select", "pressed" };
293 * The OSD state object holds the state and associated images for a
294 * particular state on the screen. The picture is displayed when this
295 * state is the active state.
299 osd_state_t *p_next; /*< pointer to next state */
300 osd_state_t *p_prev; /*< pointer to previous state */
301 picture_t *p_pic; /*< picture of state */
303 char *psz_state; /*< state name */
304 int i_state; /*< state index */
310 * An OSD Button has different states. Each state has an image for display.
314 osd_button_t *p_next; /*< pointer to next button */
315 osd_button_t *p_prev; /*< pointer to previous button */
316 osd_button_t *p_up; /*< pointer to up button */
317 osd_button_t *p_down; /*< pointer to down button */
319 osd_state_t *p_current_state; /*< pointer to current state image */
320 osd_state_t *p_states; /*< doubly linked list of states */
321 picture_t *p_feedback; /*< feedback picture */
323 char *psz_name; /*< name of button */
325 /* These member should probably be a struct hotkey */
326 char *psz_action; /*< hotkey action name on button*/
327 char *psz_action_down; /*< hotkey action name on range buttons
328 for command "menu down" */
329 /* end of hotkey specifics */
331 int i_x; /*< x-position of button visible state image */
332 int i_y; /*< y-position of button visible state image */
334 /* range style button */
335 vlc_bool_t b_range; /*< button should be interpreted as range */
336 int i_ranges; /*< number of states */
342 * The images that make up an OSD menu can be created in such away that
343 * they contain all buttons in the same picture, with the selected one
344 * highlighted or being a concatenation of all the seperate images. The
345 * first case is the default.
347 * To change the default style the keyword 'style' should be set to 'concat'.
350 #define OSD_MENU_STYLE_SIMPLE 0x0
351 #define OSD_MENU_STYLE_CONCAT 0x1
354 * OSD Menu State object
356 * Represents the current state as displayed.
358 /* Represent the menu state */
359 struct osd_menu_state_t
361 int i_x; /*< x position of spu region */
362 int i_y; /*< y position of spu region */
363 int i_width; /*< width of spu region */
364 int i_height; /*< height of spu region */
366 picture_t *p_pic; /*< pointer to picture to display */
367 osd_button_t *p_visible; /*< shortcut to visible button */
369 vlc_bool_t b_menu_visible; /*< menu currently visible? */
370 vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */
372 /* quick hack to volume state. */
373 osd_button_t *p_volume; /*< pointer to volume range object. */
379 * The main OSD Menu object, which holds a linked list to all buttons
380 * and images that defines the menu. The p_state variable represents the
381 * current state of the OSD Menu.
387 int i_x; /*< x-position of OSD Menu on the video screen */
388 int i_y; /*< y-position of OSD Menu on the video screen */
389 int i_width; /*< width of OSD Menu on the video screen */
390 int i_height; /*< height of OSD Menu on the video screen */
391 int i_style; /*< style of spu region generation */
393 char *psz_path; /*< directory where OSD menu images are stored */
394 osd_button_t *p_button; /*< doubly linked list of buttons */
395 osd_menu_state_t *p_state; /*< current state of OSD menu */
397 /* quick link in the linked list. */
398 osd_button_t *p_last_button; /*< pointer to last button in the list */
401 module_t *p_parser; /*< pointer to parser module */
402 char *psz_file; /*< Config file name */
403 image_handler_t *p_image; /*< handler to image loading and conversion libraries */
407 * Initialize an osd_menu_t object
409 * This functions has to be called before any call to other osd_menu_t*
410 * functions. It creates the osd_menu object and holds a pointer to it
411 * during its lifetime.
413 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
416 * Delete the osd_menu_t object
418 * This functions has to be called to release the associated module and
419 * memory for the osdmenu. After return of this function the pointer to
420 * osd_menu_t* is invalid.
422 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
425 * Change state on an osd_button_t.
427 * This function selects the specified state and returns a pointer to it. The
428 * following states are currently supported:
429 * \see OSD_BUTTON_UNSELECT
430 * \see OSD_BUTTON_SELECT
431 * \see OSD_BUTTON_PRESSED
433 VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
435 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
436 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
437 #define osd_StateChange(object,value) __osd_StateChange( object, value )
442 * Show the OSD menu on the video output or mux it into the stream.
443 * Every change to the OSD menu will now be visible in the output. An output
444 * can be a video output window or a stream (\see stream output)
446 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
451 * Stop showing the OSD menu on the video output or mux it into the stream.
453 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
456 * Activate the action of this OSD menu item.
458 * The rc interface command "menu select" triggers the sending of an
459 * hotkey action to the hotkey interface. The hotkey that belongs to
460 * the current highlighted OSD menu item will be used.
462 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
464 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
465 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
466 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
471 * Select the next OSD menu item to be highlighted.
472 * Note: The actual position on screen of the menu item is determined by
473 * the OSD menu configuration file.
475 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
478 * Previous OSD menu item
480 * Select the previous OSD menu item to be highlighted.
481 * Note: The actual position on screen of the menu item is determined by
482 * the OSD menu configuration file.
484 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
487 * OSD menu item above
489 * Select the OSD menu item above the current item to be highlighted.
490 * Note: The actual position on screen of the menu item is determined by
491 * the OSD menu configuration file.
493 VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );
496 * OSD menu item below
498 * Select the next OSD menu item below the current item to be highlighted.
499 * Note: The actual position on screen of the menu item is determined by
500 * the OSD menu configuration file.
502 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
504 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
505 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
506 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
507 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
510 * Display the audio volume bitmap.
512 * Display the correct audio volume bitmap that corresponds to the
513 * current Audio Volume setting.
515 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
517 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
520 * Retrieve a non modifyable pointer to the OSD Menu state
523 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
525 return( p_osd->p_state );
529 * Get the last key press received by the OSD Menu
531 * Returns 0 when no key has been pressed or the value of the key pressed.
533 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
535 return( p_osd->p_state->b_update );
539 * Set the key pressed to a value.
541 * Assign a new key value to the last key pressed on the OSD Menu.
543 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
548 var_Set( p_this, "key-pressed", val );
552 * Update the OSD Menu visibility flag.
554 * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu
555 * should not be shown.
557 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
561 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
562 var_Set( p_osd, "osd-menu-visible", val );
566 * Update the OSD Menu update flag
568 * If the OSD Menu should be updated then set the update flag to
569 * VLC_TRUE, else to VLC_FALSE.
571 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
575 val.b_bool = p_osd->p_state->b_update = b_value;
576 var_Set( p_osd, "osd-menu-update", val );
582 * Functions that provide the textual feedback on the OSD. They are shown
583 * on hotkey commands. The feedback is also part of the osd_button_t
584 * object. The types are declared in the include file include/vlc_osd.h
587 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
588 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
589 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) );
592 * Default feedback images
594 * Functions that provide the default OSD feedback images on hotkey
595 * commands. These feedback images are also part of the osd_button_t
596 * object. The types are declared in the include file include/vlc_osd.h
599 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
600 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
604 /**********************************************************************
605 * Vout text and widget overlays
606 **********************************************************************/
609 * Show text on the video for some time
610 * \param p_vout pointer to the vout the text is to be showed on
611 * \param i_channel Subpicture channel
612 * \param psz_string The text to be shown
613 * \param p_style Pointer to a struct with text style info
614 * \param i_flags flags for alignment and such
615 * \param i_hmargin horizontal margin in pixels
616 * \param i_vmargin vertical margin in pixels
617 * \param i_duration Amount of time the text is to be shown.
619 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
622 * Show text on the video from a given start date to a given end date
623 * \param p_vout pointer to the vout the text is to be showed on
624 * \param i_channel Subpicture channel
625 * \param psz_string The text to be shown
626 * \param p_style Pointer to a struct with text style info
627 * \param i_flags flags for alignment and such
628 * \param i_hmargin horizontal margin in pixels
629 * \param i_vmargin vertical margin in pixels
630 * \param i_start the time when this string is to appear on the video
631 * \param i_stop the time when this string should stop to be displayed
632 * if this is 0 the string will be shown untill the next string
633 * is about to be shown
635 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
638 * Write an informative message at the default location,
639 * for the default duration and only if the OSD option is enabled.
640 * \param p_caller The object that called the function.
641 * \param i_channel Subpicture channel
642 * \param psz_format printf style formatting
644 VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) );
647 * Same as __vlc_OSDMessage() but with automatic casting
649 #if defined(HAVE_VARIADIC_MACROS)
650 # define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args )
652 # define vout_OSDMessage __vout_OSDMessage
656 * Display a slider on the video output.
657 * \param p_this The object that called the function.
658 * \param i_channel Subpicture channel
659 * \param i_postion Current position in the slider
660 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
663 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
666 * Display an Icon on the video output.
667 * \param p_this The object that called the function.
668 * \param i_channel Subpicture channel
669 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
672 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
678 #endif /* _VLC_OSD_H */