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.
57 typedef struct spu_private_t spu_private_t;
60 * Subpicture unit descriptor
66 int (*pf_control)( spu_t *, int, va_list );
73 SPU_CHANNEL_REGISTER, /* arg1= int * res= */
74 SPU_CHANNEL_CLEAR /* arg1= int res= */
77 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
79 if( p_spu->pf_control )
80 return p_spu->pf_control( p_spu, i_query, args );
85 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
90 va_start( args, i_query );
91 i_result = spu_vaControl( p_spu, i_query, args );
96 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
97 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
98 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
99 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
100 void spu_Attach( spu_t *, vlc_object_t *, bool );
102 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
103 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
104 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
106 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t display_date, bool b_paused, bool b_subtitle_only ) );
109 * This function renders a list of subpicture_t on the provided picture.
111 * \param p_fmt_dst is the format of the destination picture.
112 * \param p_fmt_src is the format of the original(source) video.
114 VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *, picture_t *, const video_format_t *p_fmt_dst, subpicture_t *p_list, const video_format_t *p_fmt_src ) );
118 /**********************************************************************
120 **********************************************************************/
122 * \defgroup osdmenu OSD Menu
123 * The OSD menu core creates the OSD menu structure in memory. It parses a
124 * configuration file that defines all elements that are part of the menu. The
125 * core also handles all actions and menu structure updates on behalf of video
126 * subpicture filters.
128 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
129 * specifies the final information on positioning of the current state image.
130 * A subpicture filter is called each time a video picture has to be rendered,
131 * it also gives a start and end date to the subpicture. The subpicture can be
132 * streamed if used inside a transcoding command. For example:
134 * vlc dvdsimple:///dev/dvd --extraintf rc
135 * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
136 * --osdmenu-file=share/osdmenu/dvd.cfg
138 * An example for local usage of the OSD menu is:
140 * vlc dvdsimple:///dev/dvd --extraintf rc
141 * --sub-filter osdmenu
142 * --osdmenu-file=share/osdmenu/dvd.cfg
144 * Each OSD menu element, called "action", defines a hotkey action. Each action
145 * can have several states (unselect, select, pressed). Each state has an image
146 * that represents the state visually. The commands "menu right", "menu left",
147 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
148 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
149 * show and hide the OSD menu subpictures.
151 * There is one special element called "range". A range is an arbritary range
152 * of state images that can be browsed using "menu up" and "menu down" commands
153 * on the rc interface.
155 * The OSD menu configuration file uses a very simple syntax and basic parser.
156 * A configuration file has the ".cfg".
157 * An example is "share/osdmenu/dvd256.cfg".
162 * \brief The OSD Menu configuration file format.
164 * The configuration file syntax is very basic and so is its parser. See the
165 * BNF formal representation below:
167 * The keywords FILENAME and PATHNAME represent the filename and pathname
168 * specification that is valid for the Operating System VLC is compiled for.
170 * The hotkey actions that are supported by VLC are documented in the file
171 * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
173 * CONFIG_FILE = FILENAME '.cfg'
174 * WS = [ ' ' | '\t' ]+
175 * OSDMENU_PATH = PATHNAME
176 * DIR = 'dir' WS OSDMENU_PATH '\n'
177 * STYLE = 'style' [ 'default' | 'concat' ] '\n'
178 * STATE = [ 'unselect' | 'select' | 'pressed' ]
179 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
181 * ACTION_TYPE = 'type' 'volume' '\n'
182 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
183 * ACTION_BLOCK_END = 'end' '\n'
184 * ACTION_STATE = STATE WS FILENAME '\n'
185 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
186 * ACTION_RANGE_END = 'end' '\n'
187 * ACTION_RANGE_STATE = FILENAME '\n'
189 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
190 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
191 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
196 * OSD menu position and picture type defines
199 #define OSD_ALIGN_LEFT 0x1
200 #define OSD_ALIGN_RIGHT 0x2
201 #define OSD_ALIGN_TOP 0x4
202 #define OSD_ALIGN_BOTTOM 0x8
204 #define OSD_HOR_SLIDER 1
205 #define OSD_VERT_SLIDER 2
207 #define OSD_PLAY_ICON 1
208 #define OSD_PAUSE_ICON 2
209 #define OSD_SPEAKER_ICON 3
210 #define OSD_MUTE_ICON 4
215 * A text style is used to specify the formatting of text.
216 * A font renderer can use the supplied information to render the
221 char * psz_fontname; /**< The name of the font */
222 int i_font_size; /**< The font size in pixels */
223 int i_font_color; /**< The color of the text 0xRRGGBB
224 (native endianness) */
225 int i_font_alpha; /**< The transparency of the text.
226 0x00 is fully opaque,
227 0xFF fully transparent */
228 int i_style_flags; /**< Formatting style flags */
229 int i_outline_color; /**< The color of the outline 0xRRGGBB */
230 int i_outline_alpha; /**< The transparency of the outline.
231 0x00 is fully opaque,
232 0xFF fully transparent */
233 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
234 int i_shadow_alpha; /**< The transparency of the shadow.
235 0x00 is fully opaque,
236 0xFF fully transparent */
237 int i_background_color;/**< The color of the background 0xRRGGBB */
238 int i_background_alpha;/**< The transparency of the background.
239 0x00 is fully opaque,
240 0xFF fully transparent */
241 int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
242 int i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
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 */
250 /* Style flags for \ref text_style_t */
252 #define STYLE_ITALIC 2
253 #define STYLE_OUTLINE 4
254 #define STYLE_SHADOW 8
255 #define STYLE_BACKGROUND 16
256 #define STYLE_UNDERLINE 32
257 #define STYLE_STRIKEOUT 64
259 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
260 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 };
263 * OSD menu button states
265 * Every button has three states, either it is unselected, selected or pressed.
266 * An OSD menu skin can associate images with each state.
268 * OSD_BUTTON_UNSELECT 0
269 * OSD_BUTTON_SELECT 1
270 * OSD_BUTTON_PRESSED 2
272 #define OSD_BUTTON_UNSELECT 0
273 #define OSD_BUTTON_SELECT 1
274 #define OSD_BUTTON_PRESSED 2
279 * The OSD state object holds the state and associated images for a
280 * particular state on the screen. The picture is displayed when this
281 * state is the active state.
285 osd_state_t *p_next; /*< pointer to next state */
286 osd_state_t *p_prev; /*< pointer to previous state */
287 picture_t *p_pic; /*< picture of state */
289 char *psz_state; /*< state name */
290 int i_state; /*< state index */
292 int i_x; /*< x-position of button state image */
293 int i_y; /*< y-position of button state image */
294 int i_width; /*< width of button state image */
295 int i_height; /*< height of button state image */
301 * An OSD Button has different states. Each state has an image for display.
305 osd_button_t *p_next; /*< pointer to next button */
306 osd_button_t *p_prev; /*< pointer to previous button */
307 osd_button_t *p_up; /*< pointer to up button */
308 osd_button_t *p_down; /*< pointer to down button */
310 osd_state_t *p_current_state; /*< pointer to current state image */
311 osd_state_t *p_states; /*< doubly linked list of states */
312 picture_t *p_feedback; /*< feedback picture */
314 char *psz_name; /*< name of button */
316 /* These member should probably be a struct hotkey */
317 char *psz_action; /*< hotkey action name on button*/
318 char *psz_action_down; /*< hotkey action name on range buttons
319 for command "menu down" */
320 /* end of hotkey specifics */
322 int i_x; /*< x-position of button visible state image */
323 int i_y; /*< y-position of button visible state image */
324 int i_width; /*< width of button visible state image */
325 int i_height; /*< height of button visible state image */
327 /* range style button */
328 bool b_range; /*< button should be interpreted as range */
329 int i_ranges; /*< number of states */
335 * The images that make up an OSD menu can be created in such away that
336 * they contain all buttons in the same picture, with the selected one
337 * highlighted or being a concatenation of all the seperate images. The
338 * first case is the default.
340 * To change the default style the keyword 'style' should be set to 'concat'.
343 #define OSD_MENU_STYLE_SIMPLE 0x0
344 #define OSD_MENU_STYLE_CONCAT 0x1
347 * OSD Menu State object
349 * Represents the current state as displayed.
351 /* Represent the menu state */
352 struct osd_menu_state_t
354 int i_x; /*< x position of spu region */
355 int i_y; /*< y position of spu region */
356 int i_width; /*< width of spu region */
357 int i_height; /*< height of spu region */
359 picture_t *p_pic; /*< pointer to picture to display */
360 osd_button_t *p_visible; /*< shortcut to visible button */
362 bool b_menu_visible; /*< menu currently visible? */
363 bool b_update; /*< update OSD Menu when true */
365 /* quick hack to volume state. */
366 osd_button_t *p_volume; /*< pointer to volume range object. */
372 * The main OSD Menu object, which holds a linked list to all buttons
373 * and images that defines the menu. The p_state variable represents the
374 * current state of the OSD Menu.
380 int i_x; /*< x-position of OSD Menu on the video screen */
381 int i_y; /*< y-position of OSD Menu on the video screen */
382 int i_width; /*< width of OSD Menu on the video screen */
383 int i_height; /*< height of OSD Menu on the video screen */
384 int i_style; /*< style of spu region generation */
385 int i_position; /*< display position */
387 char *psz_path; /*< directory where OSD menu images are stored */
388 osd_button_t *p_button; /*< doubly linked list of buttons */
389 osd_menu_state_t *p_state; /*< current state of OSD menu */
391 /* quick link in the linked list. */
392 osd_button_t *p_last_button; /*< pointer to last button in the list */
395 module_t *p_parser; /*< pointer to parser module */
396 char *psz_file; /*< Config file name */
397 image_handler_t *p_image; /*< handler to image loading and conversion libraries */
401 * Initialize an osd_menu_t object
403 * This functions has to be called before any call to other osd_menu_t*
404 * functions. It creates the osd_menu object and holds a pointer to it
405 * during its lifetime.
407 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
410 * Delete the osd_menu_t object
412 * This functions has to be called to release the associated module and
413 * memory for the osdmenu. After return of this function the pointer to
414 * osd_menu_t* is invalid.
416 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
418 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
419 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
422 * Find OSD Menu button at position x,y
424 VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this,
425 int, int, int, int, int, int ) );
427 #define osd_ButtonFind(object,x,y,h,w,sh,sw) __osd_ButtonFind(object,x,y,h,w,sh,sw)
430 * Select the button provided as the new active button
432 VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
434 #define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button)
439 * Show the OSD menu on the video output or mux it into the stream.
440 * Every change to the OSD menu will now be visible in the output. An output
441 * can be a video output window or a stream (\see stream output)
443 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
448 * Stop showing the OSD menu on the video output or mux it into the stream.
450 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
453 * Activate the action of this OSD menu item.
455 * The rc interface command "menu select" triggers the sending of an
456 * hotkey action to the hotkey interface. The hotkey that belongs to
457 * the current highlighted OSD menu item will be used.
459 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
461 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
462 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
463 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
468 * Select the next OSD menu item to be highlighted.
469 * Note: The actual position on screen of the menu item is determined by
470 * the OSD menu configuration file.
472 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
475 * Previous OSD menu item
477 * Select the previous OSD menu item to be highlighted.
478 * Note: The actual position on screen of the menu item is determined by
479 * the OSD menu configuration file.
481 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
484 * OSD menu item above
486 * Select the OSD menu item above the current 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_MenuUp, ( vlc_object_t * ) );
493 * OSD menu item below
495 * Select the next OSD menu item below the current 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_MenuDown, ( vlc_object_t * ) );
501 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
502 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
503 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
504 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
507 * Display the audio volume bitmap.
509 * Display the correct audio volume bitmap that corresponds to the
510 * current Audio Volume setting.
512 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
514 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
517 * Retrieve a non modifyable pointer to the OSD Menu state
520 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
522 return( p_osd->p_state );
526 * Get the last key press received by the OSD Menu
528 * Returns 0 when no key has been pressed or the value of the key pressed.
530 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
532 return( p_osd->p_state->b_update );
536 * Set the key pressed to a value.
538 * Assign a new key value to the last key pressed on the OSD Menu.
540 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
545 var_Set( p_this, "key-pressed", val );
549 * Update the OSD Menu visibility flag.
551 * true means OSD Menu should be shown. false means OSD Menu
552 * should not be shown.
554 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
558 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
559 var_Set( p_osd, "osd-menu-visible", val );
563 * Update the OSD Menu update flag
565 * If the OSD Menu should be updated then set the update flag to
566 * true, else to false.
568 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
572 val.b_bool = p_osd->p_state->b_update = b_value;
573 var_Set( p_osd, "osd-menu-update", val );
579 * Functions that provide the textual feedback on the OSD. They are shown
580 * on hotkey commands. The feedback is also part of the osd_button_t
581 * object. The types are declared in the include file include/vlc_osd.h
584 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
585 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
586 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
589 * Default feedback images
591 * Functions that provide the default OSD feedback images on hotkey
592 * commands. These feedback images are also part of the osd_button_t
593 * object. The types are declared in the include file include/vlc_osd.h
596 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
597 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
601 /**********************************************************************
602 * Vout text and widget overlays
603 **********************************************************************/
606 * Show text on the video for some time
607 * \param p_vout pointer to the vout the text is to be showed on
608 * \param i_channel Subpicture channel
609 * \param psz_string The text to be shown
610 * \param p_style Pointer to a struct with text style info
611 * \param i_flags flags for alignment and such
612 * \param i_hmargin horizontal margin in pixels
613 * \param i_vmargin vertical margin in pixels
614 * \param i_duration Amount of time the text is to be shown.
616 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
619 * Show text on the video from a given start date to a given end date
620 * \param p_vout pointer to the vout the text is to be showed on
621 * \param i_channel Subpicture channel
622 * \param psz_string The text to be shown
623 * \param p_style Pointer to a struct with text style info
624 * \param i_flags flags for alignment and such
625 * \param i_hmargin horizontal margin in pixels
626 * \param i_vmargin vertical margin in pixels
627 * \param i_start the time when this string is to appear on the video
628 * \param i_stop the time when this string should stop to be displayed
629 * if this is 0 the string will be shown untill the next string
630 * is about to be shown
632 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
635 * Write an informative message at the default location,
636 * for the default duration and only if the OSD option is enabled.
637 * \param p_caller The object that called the function.
638 * \param i_channel Subpicture channel
639 * \param psz_format printf style formatting
641 VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
644 * Same as __vlc_OSDMessage() but with automatic casting
646 #define vout_OSDMessage( obj, chan, ...) \
647 __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
650 * Display a slider on the video output.
651 * \param p_this The object that called the function.
652 * \param i_channel Subpicture channel
653 * \param i_postion Current position in the slider
654 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
657 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
660 * Display an Icon on the video output.
661 * \param p_this The object that called the function.
662 * \param i_channel Subpicture channel
663 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
666 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
672 #endif /* _VLC_OSD_H */