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 *****************************************************************************/
41 * This file defines SPU subpicture and OSD functions and object types.
44 /**********************************************************************
46 **********************************************************************/
48 * \defgroup spu Subpicture Unit
49 * This module describes the programming interface for the subpicture unit.
50 * It includes functions allowing to create/destroy an spu, create/destroy
51 * subpictures and render them.
58 * Subpicture unit descriptor
64 vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
65 subpicture_t p_subpicture[VOUT_MAX_SUBPICTURES]; /**< subpictures */
66 int i_channel; /**< number of subpicture channels registered */
68 filter_t *p_blend; /**< alpha blending module */
69 filter_t *p_text; /**< text renderer module */
70 filter_t *p_scale_yuvp; /**< scaling module for YUVP */
71 filter_t *p_scale; /**< scaling module (all but YUVP) */
72 bool b_force_crop; /**< force cropping of subpicture */
73 int i_crop_x, i_crop_y, i_crop_width, i_crop_height; /**< cropping */
75 int i_margin; /**< force position of a subpicture */
76 bool b_force_palette; /**< force palette of subpicture */
77 uint8_t palette[4][4]; /**< forced palette */
79 int ( *pf_control ) ( spu_t *, int, va_list );
81 /* Supciture filters */
82 filter_chain_t *p_chain;
85 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
87 if( p_spu->pf_control )
88 return p_spu->pf_control( p_spu, i_query, args );
93 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
98 va_start( args, i_query );
99 i_result = spu_vaControl( p_spu, i_query, args );
106 SPU_CHANNEL_REGISTER, /* arg1= int * res= */
107 SPU_CHANNEL_CLEAR /* arg1= int res= */
110 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
111 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
112 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
113 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
114 void spu_Attach( spu_t *, vlc_object_t *, bool );
116 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
117 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
118 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
120 #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
121 VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_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 display_date, bool b_paused, bool b_subtitle_only ) );
127 * This function renders a list of subpicture_t on the provided picture.
129 * \param p_fmt_dst is the format of the destination picture.
130 * \param p_fmt_src is the format of the original(source) video.
132 VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, picture_t *, video_format_t *p_fmt_dst, subpicture_t *p_list, const video_format_t *p_fmt_src ) );
136 /**********************************************************************
138 **********************************************************************/
140 * \defgroup osdmenu OSD Menu
141 * The OSD menu core creates the OSD menu structure in memory. It parses a
142 * configuration file that defines all elements that are part of the menu. The
143 * core also handles all actions and menu structure updates on behalf of video
144 * subpicture filters.
146 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
147 * specifies the final information on positioning of the current state image.
148 * A subpicture filter is called each time a video picture has to be rendered,
149 * it also gives a start and end date to the subpicture. The subpicture can be
150 * streamed if used inside a transcoding command. For example:
152 * vlc dvdsimple:///dev/dvd --extraintf rc
153 * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
154 * --osdmenu-file=share/osdmenu/dvd.cfg
156 * An example for local usage of the OSD menu is:
158 * vlc dvdsimple:///dev/dvd --extraintf rc
159 * --sub-filter osdmenu
160 * --osdmenu-file=share/osdmenu/dvd.cfg
162 * Each OSD menu element, called "action", defines a hotkey action. Each action
163 * can have several states (unselect, select, pressed). Each state has an image
164 * that represents the state visually. The commands "menu right", "menu left",
165 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
166 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
167 * show and hide the OSD menu subpictures.
169 * There is one special element called "range". A range is an arbritary range
170 * of state images that can be browsed using "menu up" and "menu down" commands
171 * on the rc interface.
173 * The OSD menu configuration file uses a very simple syntax and basic parser.
174 * A configuration file has the ".cfg".
175 * An example is "share/osdmenu/dvd256.cfg".
180 * \brief The OSD Menu configuration file format.
182 * The configuration file syntax is very basic and so is its parser. See the
183 * BNF formal representation below:
185 * The keywords FILENAME and PATHNAME represent the filename and pathname
186 * specification that is valid for the Operating System VLC is compiled for.
188 * The hotkey actions that are supported by VLC are documented in the file
189 * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
191 * CONFIG_FILE = FILENAME '.cfg'
192 * WS = [ ' ' | '\t' ]+
193 * OSDMENU_PATH = PATHNAME
194 * DIR = 'dir' WS OSDMENU_PATH '\n'
195 * STYLE = 'style' [ 'default' | 'concat' ] '\n'
196 * STATE = [ 'unselect' | 'select' | 'pressed' ]
197 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
199 * ACTION_TYPE = 'type' 'volume' '\n'
200 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
201 * ACTION_BLOCK_END = 'end' '\n'
202 * ACTION_STATE = STATE WS FILENAME '\n'
203 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
204 * ACTION_RANGE_END = 'end' '\n'
205 * ACTION_RANGE_STATE = FILENAME '\n'
207 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
208 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
209 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
214 * OSD menu position and picture type defines
217 #define OSD_ALIGN_LEFT 0x1
218 #define OSD_ALIGN_RIGHT 0x2
219 #define OSD_ALIGN_TOP 0x4
220 #define OSD_ALIGN_BOTTOM 0x8
222 #define OSD_HOR_SLIDER 1
223 #define OSD_VERT_SLIDER 2
225 #define OSD_PLAY_ICON 1
226 #define OSD_PAUSE_ICON 2
227 #define OSD_SPEAKER_ICON 3
228 #define OSD_MUTE_ICON 4
233 * A text style is used to specify the formatting of text.
234 * A font renderer can use the supplied information to render the
239 char * psz_fontname; /**< The name of the font */
240 int i_font_size; /**< The font size in pixels */
241 int i_font_color; /**< The color of the text 0xRRGGBB
242 (native endianness) */
243 int i_font_alpha; /**< The transparency of the text.
244 0x00 is fully opaque,
245 0xFF fully transparent */
246 int i_style_flags; /**< Formatting style flags */
247 int i_outline_color; /**< The color of the outline 0xRRGGBB */
248 int i_outline_alpha; /**< The transparency of the outline.
249 0x00 is fully opaque,
250 0xFF fully transparent */
251 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
252 int i_shadow_alpha; /**< The transparency of the shadow.
253 0x00 is fully opaque,
254 0xFF fully transparent */
255 int i_background_color;/**< The color of the background 0xRRGGBB */
256 int i_background_alpha;/**< The transparency of the background.
257 0x00 is fully opaque,
258 0xFF fully transparent */
259 int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
260 int i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
261 0x00 is fully opaque,
262 0xFF fully transparent */
263 int i_outline_width; /**< The width of the outline in pixels */
264 int i_shadow_width; /**< The width of the shadow in pixels */
265 int i_spacing; /**< The spaceing between glyphs in pixels */
268 /* Style flags for \ref text_style_t */
270 #define STYLE_ITALIC 2
271 #define STYLE_OUTLINE 4
272 #define STYLE_SHADOW 8
273 #define STYLE_BACKGROUND 16
274 #define STYLE_UNDERLINE 32
275 #define STYLE_STRIKEOUT 64
277 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
278 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 };
281 * OSD menu button states
283 * Every button has three states, either it is unselected, selected or pressed.
284 * An OSD menu skin can associate images with each state.
286 * OSD_BUTTON_UNSELECT 0
287 * OSD_BUTTON_SELECT 1
288 * OSD_BUTTON_PRESSED 2
290 #define OSD_BUTTON_UNSELECT 0
291 #define OSD_BUTTON_SELECT 1
292 #define OSD_BUTTON_PRESSED 2
297 * The OSD state object holds the state and associated images for a
298 * particular state on the screen. The picture is displayed when this
299 * state is the active state.
303 osd_state_t *p_next; /*< pointer to next state */
304 osd_state_t *p_prev; /*< pointer to previous state */
305 picture_t *p_pic; /*< picture of state */
307 char *psz_state; /*< state name */
308 int i_state; /*< state index */
310 int i_x; /*< x-position of button state image */
311 int i_y; /*< y-position of button state image */
312 int i_width; /*< width of button state image */
313 int i_height; /*< height of button state image */
319 * An OSD Button has different states. Each state has an image for display.
323 osd_button_t *p_next; /*< pointer to next button */
324 osd_button_t *p_prev; /*< pointer to previous button */
325 osd_button_t *p_up; /*< pointer to up button */
326 osd_button_t *p_down; /*< pointer to down button */
328 osd_state_t *p_current_state; /*< pointer to current state image */
329 osd_state_t *p_states; /*< doubly linked list of states */
330 picture_t *p_feedback; /*< feedback picture */
332 char *psz_name; /*< name of button */
334 /* These member should probably be a struct hotkey */
335 char *psz_action; /*< hotkey action name on button*/
336 char *psz_action_down; /*< hotkey action name on range buttons
337 for command "menu down" */
338 /* end of hotkey specifics */
340 int i_x; /*< x-position of button visible state image */
341 int i_y; /*< y-position of button visible state image */
342 int i_width; /*< width of button visible state image */
343 int i_height; /*< height of button visible state image */
345 /* range style button */
346 bool b_range; /*< button should be interpreted as range */
347 int i_ranges; /*< number of states */
353 * The images that make up an OSD menu can be created in such away that
354 * they contain all buttons in the same picture, with the selected one
355 * highlighted or being a concatenation of all the seperate images. The
356 * first case is the default.
358 * To change the default style the keyword 'style' should be set to 'concat'.
361 #define OSD_MENU_STYLE_SIMPLE 0x0
362 #define OSD_MENU_STYLE_CONCAT 0x1
365 * OSD Menu State object
367 * Represents the current state as displayed.
369 /* Represent the menu state */
370 struct osd_menu_state_t
372 int i_x; /*< x position of spu region */
373 int i_y; /*< y position of spu region */
374 int i_width; /*< width of spu region */
375 int i_height; /*< height of spu region */
377 picture_t *p_pic; /*< pointer to picture to display */
378 osd_button_t *p_visible; /*< shortcut to visible button */
380 bool b_menu_visible; /*< menu currently visible? */
381 bool b_update; /*< update OSD Menu when true */
383 /* quick hack to volume state. */
384 osd_button_t *p_volume; /*< pointer to volume range object. */
390 * The main OSD Menu object, which holds a linked list to all buttons
391 * and images that defines the menu. The p_state variable represents the
392 * current state of the OSD Menu.
398 int i_x; /*< x-position of OSD Menu on the video screen */
399 int i_y; /*< y-position of OSD Menu on the video screen */
400 int i_width; /*< width of OSD Menu on the video screen */
401 int i_height; /*< height of OSD Menu on the video screen */
402 int i_style; /*< style of spu region generation */
403 int i_position; /*< display position */
405 char *psz_path; /*< directory where OSD menu images are stored */
406 osd_button_t *p_button; /*< doubly linked list of buttons */
407 osd_menu_state_t *p_state; /*< current state of OSD menu */
409 /* quick link in the linked list. */
410 osd_button_t *p_last_button; /*< pointer to last button in the list */
413 module_t *p_parser; /*< pointer to parser module */
414 char *psz_file; /*< Config file name */
415 image_handler_t *p_image; /*< handler to image loading and conversion libraries */
419 * Initialize an osd_menu_t object
421 * This functions has to be called before any call to other osd_menu_t*
422 * functions. It creates the osd_menu object and holds a pointer to it
423 * during its lifetime.
425 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
428 * Delete the osd_menu_t object
430 * This functions has to be called to release the associated module and
431 * memory for the osdmenu. After return of this function the pointer to
432 * osd_menu_t* is invalid.
434 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
436 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
437 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
440 * Find OSD Menu button at position x,y
442 VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this,
443 int, int, int, int, int, int ) );
445 #define osd_ButtonFind(object,x,y,h,w,sh,sw) __osd_ButtonFind(object,x,y,h,w,sh,sw)
448 * Select the button provided as the new active button
450 VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
452 #define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button)
457 * Show the OSD menu on the video output or mux it into the stream.
458 * Every change to the OSD menu will now be visible in the output. An output
459 * can be a video output window or a stream (\see stream output)
461 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
466 * Stop showing the OSD menu on the video output or mux it into the stream.
468 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
471 * Activate the action of this OSD menu item.
473 * The rc interface command "menu select" triggers the sending of an
474 * hotkey action to the hotkey interface. The hotkey that belongs to
475 * the current highlighted OSD menu item will be used.
477 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
479 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
480 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
481 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
486 * Select the next OSD menu item to be highlighted.
487 * Note: The actual position on screen of the menu item is determined by
488 * the OSD menu configuration file.
490 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
493 * Previous OSD menu item
495 * Select the previous OSD menu item to be highlighted.
496 * Note: The actual position on screen of the menu item is determined by
497 * the OSD menu configuration file.
499 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
502 * OSD menu item above
504 * Select the OSD menu item above the current item to be highlighted.
505 * Note: The actual position on screen of the menu item is determined by
506 * the OSD menu configuration file.
508 VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );
511 * OSD menu item below
513 * Select the next OSD menu item below the current item to be highlighted.
514 * Note: The actual position on screen of the menu item is determined by
515 * the OSD menu configuration file.
517 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
519 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
520 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
521 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
522 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
525 * Display the audio volume bitmap.
527 * Display the correct audio volume bitmap that corresponds to the
528 * current Audio Volume setting.
530 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
532 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
535 * Retrieve a non modifyable pointer to the OSD Menu state
538 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
540 return( p_osd->p_state );
544 * Get the last key press received by the OSD Menu
546 * Returns 0 when no key has been pressed or the value of the key pressed.
548 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
550 return( p_osd->p_state->b_update );
554 * Set the key pressed to a value.
556 * Assign a new key value to the last key pressed on the OSD Menu.
558 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
563 var_Set( p_this, "key-pressed", val );
567 * Update the OSD Menu visibility flag.
569 * true means OSD Menu should be shown. false means OSD Menu
570 * should not be shown.
572 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
576 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
577 var_Set( p_osd, "osd-menu-visible", val );
581 * Update the OSD Menu update flag
583 * If the OSD Menu should be updated then set the update flag to
584 * true, else to false.
586 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
590 val.b_bool = p_osd->p_state->b_update = b_value;
591 var_Set( p_osd, "osd-menu-update", val );
597 * Functions that provide the textual feedback on the OSD. They are shown
598 * on hotkey commands. The feedback is also part of the osd_button_t
599 * object. The types are declared in the include file include/vlc_osd.h
602 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
603 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
604 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
607 * Default feedback images
609 * Functions that provide the default OSD feedback images on hotkey
610 * commands. These feedback images are also part of the osd_button_t
611 * object. The types are declared in the include file include/vlc_osd.h
614 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
615 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
619 /**********************************************************************
620 * Vout text and widget overlays
621 **********************************************************************/
624 * Show text on the video for some time
625 * \param p_vout pointer to the vout the text is to be showed on
626 * \param i_channel Subpicture channel
627 * \param psz_string The text to be shown
628 * \param p_style Pointer to a struct with text style info
629 * \param i_flags flags for alignment and such
630 * \param i_hmargin horizontal margin in pixels
631 * \param i_vmargin vertical margin in pixels
632 * \param i_duration Amount of time the text is to be shown.
634 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
637 * Show text on the video from a given start date to a given end date
638 * \param p_vout pointer to the vout the text is to be showed on
639 * \param i_channel Subpicture channel
640 * \param psz_string The text to be shown
641 * \param p_style Pointer to a struct with text style info
642 * \param i_flags flags for alignment and such
643 * \param i_hmargin horizontal margin in pixels
644 * \param i_vmargin vertical margin in pixels
645 * \param i_start the time when this string is to appear on the video
646 * \param i_stop the time when this string should stop to be displayed
647 * if this is 0 the string will be shown untill the next string
648 * is about to be shown
650 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
653 * Write an informative message at the default location,
654 * for the default duration and only if the OSD option is enabled.
655 * \param p_caller The object that called the function.
656 * \param i_channel Subpicture channel
657 * \param psz_format printf style formatting
659 VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
662 * Same as __vlc_OSDMessage() but with automatic casting
664 #define vout_OSDMessage( obj, chan, ...) \
665 __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
668 * Display a slider on the video output.
669 * \param p_this The object that called the function.
670 * \param i_channel Subpicture channel
671 * \param i_postion Current position in the slider
672 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
675 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
678 * Display an Icon on the video output.
679 * \param p_this The object that called the function.
680 * \param i_channel Subpicture channel
681 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
684 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
690 #endif /* _VLC_OSD_H */