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 );
103 * This function sends a subpicture to the spu_t core.
105 * You cannot use the provided subpicture anymore. The spu_t core
106 * will destroy it at its convenience.
108 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
111 * This function asks the spu_t core a list of subpictures to display.
113 * The returned list can only be used by spu_RenderSubpictures.
115 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t display_date, bool b_paused, bool b_subtitle_only ) );
118 * This function renders a list of subpicture_t on the provided picture.
120 * \param p_fmt_dst is the format of the destination picture.
121 * \param p_fmt_src is the format of the original(source) video.
123 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, bool b_paused ) );
127 /**********************************************************************
129 **********************************************************************/
131 * \defgroup osdmenu OSD Menu
132 * The OSD menu core creates the OSD menu structure in memory. It parses a
133 * configuration file that defines all elements that are part of the menu. The
134 * core also handles all actions and menu structure updates on behalf of video
135 * subpicture filters.
137 * The file modules/video_filters/osdmenu.c implements a subpicture filter that
138 * specifies the final information on positioning of the current state image.
139 * A subpicture filter is called each time a video picture has to be rendered,
140 * it also gives a start and end date to the subpicture. The subpicture can be
141 * streamed if used inside a transcoding command. For example:
143 * vlc dvdsimple:///dev/dvd --extraintf rc
144 * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
145 * --osdmenu-file=share/osdmenu/dvd.cfg
147 * An example for local usage of the OSD menu is:
149 * vlc dvdsimple:///dev/dvd --extraintf rc
150 * --sub-filter osdmenu
151 * --osdmenu-file=share/osdmenu/dvd.cfg
153 * Each OSD menu element, called "action", defines a hotkey action. Each action
154 * can have several states (unselect, select, pressed). Each state has an image
155 * that represents the state visually. The commands "menu right", "menu left",
156 * "menu up" and "menu down" are used to navigate through the OSD menu structure.
157 * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
158 * show and hide the OSD menu subpictures.
160 * There is one special element called "range". A range is an arbritary range
161 * of state images that can be browsed using "menu up" and "menu down" commands
162 * on the rc interface.
164 * The OSD menu configuration file uses a very simple syntax and basic parser.
165 * A configuration file has the ".cfg".
166 * An example is "share/osdmenu/dvd256.cfg".
171 * \brief The OSD Menu configuration file format.
173 * The configuration file syntax is very basic and so is its parser. See the
174 * BNF formal representation below:
176 * The keywords FILENAME and PATHNAME represent the filename and pathname
177 * specification that is valid for the Operating System VLC is compiled for.
179 * The hotkey actions that are supported by VLC are documented in the file
180 * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
182 * CONFIG_FILE = FILENAME '.cfg'
183 * WS = [ ' ' | '\t' ]+
184 * OSDMENU_PATH = PATHNAME
185 * DIR = 'dir' WS OSDMENU_PATH '\n'
186 * STYLE = 'style' [ 'default' | 'concat' ] '\n'
187 * STATE = [ 'unselect' | 'select' | 'pressed' ]
188 * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
190 * ACTION_TYPE = 'type' 'volume' '\n'
191 * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
192 * ACTION_BLOCK_END = 'end' '\n'
193 * ACTION_STATE = STATE WS FILENAME '\n'
194 * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
195 * ACTION_RANGE_END = 'end' '\n'
196 * ACTION_RANGE_STATE = FILENAME '\n'
198 * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
199 * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
200 * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
205 * OSD menu position and picture type defines
208 #define OSD_ALIGN_LEFT 0x1
209 #define OSD_ALIGN_RIGHT 0x2
210 #define OSD_ALIGN_TOP 0x4
211 #define OSD_ALIGN_BOTTOM 0x8
213 #define OSD_HOR_SLIDER 1
214 #define OSD_VERT_SLIDER 2
216 #define OSD_PLAY_ICON 1
217 #define OSD_PAUSE_ICON 2
218 #define OSD_SPEAKER_ICON 3
219 #define OSD_MUTE_ICON 4
224 * A text style is used to specify the formatting of text.
225 * A font renderer can use the supplied information to render the
230 char * psz_fontname; /**< The name of the font */
231 int i_font_size; /**< The font size in pixels */
232 int i_font_color; /**< The color of the text 0xRRGGBB
233 (native endianness) */
234 int i_font_alpha; /**< The transparency of the text.
235 0x00 is fully opaque,
236 0xFF fully transparent */
237 int i_style_flags; /**< Formatting style flags */
238 int i_outline_color; /**< The color of the outline 0xRRGGBB */
239 int i_outline_alpha; /**< The transparency of the outline.
240 0x00 is fully opaque,
241 0xFF fully transparent */
242 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
243 int i_shadow_alpha; /**< The transparency of the shadow.
244 0x00 is fully opaque,
245 0xFF fully transparent */
246 int i_background_color;/**< The color of the background 0xRRGGBB */
247 int i_background_alpha;/**< The transparency of the background.
248 0x00 is fully opaque,
249 0xFF fully transparent */
250 int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
251 int i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
252 0x00 is fully opaque,
253 0xFF fully transparent */
254 int i_outline_width; /**< The width of the outline in pixels */
255 int i_shadow_width; /**< The width of the shadow in pixels */
256 int i_spacing; /**< The spaceing between glyphs in pixels */
259 /* Style flags for \ref text_style_t */
261 #define STYLE_ITALIC 2
262 #define STYLE_OUTLINE 4
263 #define STYLE_SHADOW 8
264 #define STYLE_BACKGROUND 16
265 #define STYLE_UNDERLINE 32
266 #define STYLE_STRIKEOUT 64
269 * Create a default text style
271 VLC_EXPORT( text_style_t *, text_style_New, ( void ) );
274 * Copy a text style into another
276 VLC_EXPORT( text_style_t *, text_style_Copy, ( text_style_t *, const text_style_t * ) );
279 * Duplicate a text style
281 VLC_EXPORT( text_style_t *, text_style_Duplicate, ( const text_style_t * ) );
284 * Delete a text style created by text_style_New or text_style_Duplicate
286 VLC_EXPORT( void, text_style_Delete, ( text_style_t * ) );
289 * OSD menu button states
291 * Every button has three states, either it is unselected, selected or pressed.
292 * An OSD menu skin can associate images with each state.
294 * OSD_BUTTON_UNSELECT 0
295 * OSD_BUTTON_SELECT 1
296 * OSD_BUTTON_PRESSED 2
298 #define OSD_BUTTON_UNSELECT 0
299 #define OSD_BUTTON_SELECT 1
300 #define OSD_BUTTON_PRESSED 2
305 * The OSD state object holds the state and associated images for a
306 * particular state on the screen. The picture is displayed when this
307 * state is the active state.
311 osd_state_t *p_next; /*< pointer to next state */
312 osd_state_t *p_prev; /*< pointer to previous state */
313 picture_t *p_pic; /*< picture of state */
315 char *psz_state; /*< state name */
316 int i_state; /*< state index */
318 int i_x; /*< x-position of button state image */
319 int i_y; /*< y-position of button state image */
320 int i_width; /*< width of button state image */
321 int i_height; /*< height of button state image */
327 * An OSD Button has different states. Each state has an image for display.
331 osd_button_t *p_next; /*< pointer to next button */
332 osd_button_t *p_prev; /*< pointer to previous button */
333 osd_button_t *p_up; /*< pointer to up button */
334 osd_button_t *p_down; /*< pointer to down button */
336 osd_state_t *p_current_state; /*< pointer to current state image */
337 osd_state_t *p_states; /*< doubly linked list of states */
338 picture_t *p_feedback; /*< feedback picture */
340 char *psz_name; /*< name of button */
342 /* These member should probably be a struct hotkey */
343 char *psz_action; /*< hotkey action name on button*/
344 char *psz_action_down; /*< hotkey action name on range buttons
345 for command "menu down" */
346 /* end of hotkey specifics */
348 int i_x; /*< x-position of button visible state image */
349 int i_y; /*< y-position of button visible state image */
350 int i_width; /*< width of button visible state image */
351 int i_height; /*< height of button visible state image */
353 /* range style button */
354 bool b_range; /*< button should be interpreted as range */
355 int i_ranges; /*< number of states */
361 * The images that make up an OSD menu can be created in such away that
362 * they contain all buttons in the same picture, with the selected one
363 * highlighted or being a concatenation of all the seperate images. The
364 * first case is the default.
366 * To change the default style the keyword 'style' should be set to 'concat'.
369 #define OSD_MENU_STYLE_SIMPLE 0x0
370 #define OSD_MENU_STYLE_CONCAT 0x1
373 * OSD Menu State object
375 * Represents the current state as displayed.
377 /* Represent the menu state */
378 struct osd_menu_state_t
380 int i_x; /*< x position of spu region */
381 int i_y; /*< y position of spu region */
382 int i_width; /*< width of spu region */
383 int i_height; /*< height of spu region */
385 picture_t *p_pic; /*< pointer to picture to display */
386 osd_button_t *p_visible; /*< shortcut to visible button */
388 bool b_menu_visible; /*< menu currently visible? */
389 bool b_update; /*< update OSD Menu when true */
391 /* quick hack to volume state. */
392 osd_button_t *p_volume; /*< pointer to volume range object. */
398 * The main OSD Menu object, which holds a linked list to all buttons
399 * and images that defines the menu. The p_state variable represents the
400 * current state of the OSD Menu.
406 int i_x; /*< x-position of OSD Menu on the video screen */
407 int i_y; /*< y-position of OSD Menu on the video screen */
408 int i_width; /*< width of OSD Menu on the video screen */
409 int i_height; /*< height of OSD Menu on the video screen */
410 int i_style; /*< style of spu region generation */
411 int i_position; /*< display position */
413 char *psz_path; /*< directory where OSD menu images are stored */
414 osd_button_t *p_button; /*< doubly linked list of buttons */
415 osd_menu_state_t *p_state; /*< current state of OSD menu */
417 /* quick link in the linked list. */
418 osd_button_t *p_last_button; /*< pointer to last button in the list */
421 module_t *p_parser; /*< pointer to parser module */
422 char *psz_file; /*< Config file name */
423 image_handler_t *p_image; /*< handler to image loading and conversion libraries */
427 * Initialize an osd_menu_t object
429 * This functions has to be called before any call to other osd_menu_t*
430 * functions. It creates the osd_menu object and holds a pointer to it
431 * during its lifetime.
433 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
436 * Delete the osd_menu_t object
438 * This functions has to be called to release the associated module and
439 * memory for the osdmenu. After return of this function the pointer to
440 * osd_menu_t* is invalid.
442 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
444 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
445 #define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
448 * Find OSD Menu button at position x,y
450 VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this,
451 int, int, int, int, int, int ) );
453 #define osd_ButtonFind(object,x,y,h,w,sh,sw) __osd_ButtonFind(object,x,y,h,w,sh,sw)
456 * Select the button provided as the new active button
458 VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
460 #define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button)
465 * Show the OSD menu on the video output or mux it into the stream.
466 * Every change to the OSD menu will now be visible in the output. An output
467 * can be a video output window or a stream (\see stream output)
469 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
474 * Stop showing the OSD menu on the video output or mux it into the stream.
476 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
479 * Activate the action of this OSD menu item.
481 * The rc interface command "menu select" triggers the sending of an
482 * hotkey action to the hotkey interface. The hotkey that belongs to
483 * the current highlighted OSD menu item will be used.
485 VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );
487 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
488 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
489 #define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
494 * Select the next OSD menu item to be highlighted.
495 * Note: The actual position on screen of the menu item is determined by
496 * the OSD menu configuration file.
498 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
501 * Previous OSD menu item
503 * Select the previous OSD menu item to be highlighted.
504 * Note: The actual position on screen of the menu item is determined by
505 * the OSD menu configuration file.
507 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
510 * OSD menu item above
512 * Select the OSD menu item above the current item to be highlighted.
513 * Note: The actual position on screen of the menu item is determined by
514 * the OSD menu configuration file.
516 VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );
519 * OSD menu item below
521 * Select the next OSD menu item below the current item to be highlighted.
522 * Note: The actual position on screen of the menu item is determined by
523 * the OSD menu configuration file.
525 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
527 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
528 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
529 #define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )
530 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
533 * Display the audio volume bitmap.
535 * Display the correct audio volume bitmap that corresponds to the
536 * current Audio Volume setting.
538 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
540 #define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
543 * Retrieve a non modifyable pointer to the OSD Menu state
546 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
548 return( p_osd->p_state );
552 * Get the last key press received by the OSD Menu
554 * Returns 0 when no key has been pressed or the value of the key pressed.
556 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
558 return( p_osd->p_state->b_update );
562 * Set the key pressed to a value.
564 * Assign a new key value to the last key pressed on the OSD Menu.
566 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
571 var_Set( p_this, "key-pressed", val );
575 * Update the OSD Menu visibility flag.
577 * true means OSD Menu should be shown. false means OSD Menu
578 * should not be shown.
580 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
584 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
585 var_Set( p_osd, "osd-menu-visible", val );
589 * Update the OSD Menu update flag
591 * If the OSD Menu should be updated then set the update flag to
592 * true, else to false.
594 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
598 val.b_bool = p_osd->p_state->b_update = b_value;
599 var_Set( p_osd, "osd-menu-update", val );
605 * Functions that provide the textual feedback on the OSD. They are shown
606 * on hotkey commands. The feedback is also part of the osd_button_t
607 * object. The types are declared in the include file include/vlc_osd.h
610 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t ) );
611 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
612 VLC_EXPORT( void, osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
615 * Default feedback images
617 * Functions that provide the default OSD feedback images on hotkey
618 * commands. These feedback images are also part of the osd_button_t
619 * object. The types are declared in the include file include/vlc_osd.h
622 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
623 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
627 /**********************************************************************
628 * Vout text and widget overlays
629 **********************************************************************/
631 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, const text_style_t *, int, int, int, mtime_t ) );
633 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
636 * Write an informative message at the default location,
637 * for the default duration and only if the OSD option is enabled.
638 * \param p_caller The object that called the function.
639 * \param i_channel Subpicture channel
640 * \param psz_format printf style formatting
642 VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
645 * Same as __vlc_OSDMessage() but with automatic casting
647 #define vout_OSDMessage( obj, chan, ...) \
648 __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
651 * Display a slider on the video output.
652 * \param p_this The object that called the function.
653 * \param i_channel Subpicture channel
654 * \param i_postion Current position in the slider
655 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
658 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
661 * Display an Icon on the video output.
662 * \param p_this The object that called the function.
663 * \param i_channel Subpicture channel
664 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
667 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
673 #endif /* _VLC_OSD_H */