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;
59 /* Default subpicture channel ID */
60 #define DEFAULT_CHAN 1
63 * Subpicture unit descriptor
69 int (*pf_control)( spu_t *, int, va_list );
76 SPU_CHANNEL_REGISTER, /* arg1= int * res= */
77 SPU_CHANNEL_CLEAR /* arg1= int res= */
80 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
82 if( p_spu->pf_control )
83 return p_spu->pf_control( p_spu, i_query, args );
88 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
93 va_start( args, i_query );
94 i_result = spu_vaControl( p_spu, i_query, args );
99 VLC_EXPORT( spu_t *, spu_Create, ( vlc_object_t * ) );
100 #define spu_Create(a) spu_Create(VLC_OBJECT(a))
101 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
102 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
103 void spu_Attach( spu_t *, vlc_object_t *, bool );
106 * This function sends a subpicture to the spu_t core.
108 * You cannot use the provided subpicture anymore. The spu_t core
109 * will destroy it at its convenience.
111 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
114 * This function asks the spu_t core a list of subpictures to display.
116 * The returned list can only be used by spu_RenderSubpictures.
118 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t render_subtitle_date, bool b_subtitle_only ) );
121 * This function renders a list of subpicture_t on the provided picture.
123 * \param p_fmt_dst is the format of the destination picture.
124 * \param p_fmt_src is the format of the original(source) video.
126 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, mtime_t render_subtitle_date ) );
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
210 #define OSD_HOR_SLIDER 1
211 #define OSD_VERT_SLIDER 2
213 #define OSD_PLAY_ICON 1
214 #define OSD_PAUSE_ICON 2
215 #define OSD_SPEAKER_ICON 3
216 #define OSD_MUTE_ICON 4
221 * A text style is used to specify the formatting of text.
222 * A font renderer can use the supplied information to render the
227 char * psz_fontname; /**< The name of the font */
228 int i_font_size; /**< The font size in pixels */
229 int i_font_color; /**< The color of the text 0xRRGGBB
230 (native endianness) */
231 int i_font_alpha; /**< The transparency of the text.
232 0x00 is fully opaque,
233 0xFF fully transparent */
234 int i_style_flags; /**< Formatting style flags */
235 int i_outline_color; /**< The color of the outline 0xRRGGBB */
236 int i_outline_alpha; /**< The transparency of the outline.
237 0x00 is fully opaque,
238 0xFF fully transparent */
239 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
240 int i_shadow_alpha; /**< The transparency of the shadow.
241 0x00 is fully opaque,
242 0xFF fully transparent */
243 int i_background_color;/**< The color of the background 0xRRGGBB */
244 int i_background_alpha;/**< The transparency of the background.
245 0x00 is fully opaque,
246 0xFF fully transparent */
247 int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
248 int i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
249 0x00 is fully opaque,
250 0xFF fully transparent */
251 int i_outline_width; /**< The width of the outline in pixels */
252 int i_shadow_width; /**< The width of the shadow in pixels */
253 int i_spacing; /**< The spaceing between glyphs in pixels */
256 /* Style flags for \ref text_style_t */
258 #define STYLE_ITALIC 2
259 #define STYLE_OUTLINE 4
260 #define STYLE_SHADOW 8
261 #define STYLE_BACKGROUND 16
262 #define STYLE_UNDERLINE 32
263 #define STYLE_STRIKEOUT 64
266 * Create a default text style
268 VLC_EXPORT( text_style_t *, text_style_New, ( void ) );
271 * Copy a text style into another
273 VLC_EXPORT( text_style_t *, text_style_Copy, ( text_style_t *, const text_style_t * ) );
276 * Duplicate a text style
278 VLC_EXPORT( text_style_t *, text_style_Duplicate, ( const text_style_t * ) );
281 * Delete a text style created by text_style_New or text_style_Duplicate
283 VLC_EXPORT( void, text_style_Delete, ( text_style_t * ) );
286 * OSD menu button states
288 * Every button has three states, either it is unselected, selected or pressed.
289 * An OSD menu skin can associate images with each state.
291 * OSD_BUTTON_UNSELECT 0
292 * OSD_BUTTON_SELECT 1
293 * OSD_BUTTON_PRESSED 2
295 #define OSD_BUTTON_UNSELECT 0
296 #define OSD_BUTTON_SELECT 1
297 #define OSD_BUTTON_PRESSED 2
302 * The OSD state object holds the state and associated images for a
303 * particular state on the screen. The picture is displayed when this
304 * state is the active state.
308 osd_state_t *p_next; /*< pointer to next state */
309 osd_state_t *p_prev; /*< pointer to previous state */
310 picture_t *p_pic; /*< picture of state */
312 char *psz_state; /*< state name */
313 int i_state; /*< state index */
315 int i_x; /*< x-position of button state image */
316 int i_y; /*< y-position of button state image */
317 int i_width; /*< width of button state image */
318 int i_height; /*< height of button state image */
324 * An OSD Button has different states. Each state has an image for display.
328 osd_button_t *p_next; /*< pointer to next button */
329 osd_button_t *p_prev; /*< pointer to previous button */
330 osd_button_t *p_up; /*< pointer to up button */
331 osd_button_t *p_down; /*< pointer to down button */
333 osd_state_t *p_current_state; /*< pointer to current state image */
334 osd_state_t *p_states; /*< doubly linked list of states */
335 picture_t *p_feedback; /*< feedback picture */
337 char *psz_name; /*< name of button */
339 /* These member should probably be a struct hotkey */
340 char *psz_action; /*< hotkey action name on button*/
341 char *psz_action_down; /*< hotkey action name on range buttons
342 for command "menu down" */
343 /* end of hotkey specifics */
345 int i_x; /*< x-position of button visible state image */
346 int i_y; /*< y-position of button visible state image */
347 int i_width; /*< width of button visible state image */
348 int i_height; /*< height of button visible state image */
350 /* range style button */
351 bool b_range; /*< button should be interpreted as range */
352 int i_ranges; /*< number of states */
358 * The images that make up an OSD menu can be created in such away that
359 * they contain all buttons in the same picture, with the selected one
360 * highlighted or being a concatenation of all the seperate images. The
361 * first case is the default.
363 * To change the default style the keyword 'style' should be set to 'concat'.
366 #define OSD_MENU_STYLE_SIMPLE 0x0
367 #define OSD_MENU_STYLE_CONCAT 0x1
370 * OSD Menu State object
372 * Represents the current state as displayed.
374 /* Represent the menu state */
375 struct osd_menu_state_t
377 int i_x; /*< x position of spu region */
378 int i_y; /*< y position of spu region */
379 int i_width; /*< width of spu region */
380 int i_height; /*< height of spu region */
382 picture_t *p_pic; /*< pointer to picture to display */
383 osd_button_t *p_visible; /*< shortcut to visible button */
385 bool b_menu_visible; /*< menu currently visible? */
386 bool b_update; /*< update OSD Menu when true */
388 /* quick hack to volume state. */
389 osd_button_t *p_volume; /*< pointer to volume range object. */
395 * The main OSD Menu object, which holds a linked list to all buttons
396 * and images that defines the menu. The p_state variable represents the
397 * current state of the OSD Menu.
403 int i_x; /*< x-position of OSD Menu on the video screen */
404 int i_y; /*< y-position of OSD Menu on the video screen */
405 int i_width; /*< width of OSD Menu on the video screen */
406 int i_height; /*< height of OSD Menu on the video screen */
407 int i_style; /*< style of spu region generation */
408 int i_position; /*< display position */
410 char *psz_path; /*< directory where OSD menu images are stored */
411 osd_button_t *p_button; /*< doubly linked list of buttons */
412 osd_menu_state_t *p_state; /*< current state of OSD menu */
414 /* quick link in the linked list. */
415 osd_button_t *p_last_button; /*< pointer to last button in the list */
418 module_t *p_parser; /*< pointer to parser module */
419 char *psz_file; /*< Config file name */
420 image_handler_t *p_image; /*< handler to image loading and conversion libraries */
424 * Initialize an osd_menu_t object
426 * This functions has to be called before any call to other osd_menu_t*
427 * functions. It creates the osd_menu object and holds a pointer to it
428 * during its lifetime.
430 VLC_EXPORT( osd_menu_t *, osd_MenuCreate, ( vlc_object_t *, const char * ) );
433 * Delete the osd_menu_t object
435 * This functions has to be called to release the associated module and
436 * memory for the osdmenu. After return of this function the pointer to
437 * osd_menu_t* is invalid.
439 VLC_EXPORT( void, osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
441 #define osd_MenuCreate(object,file) osd_MenuCreate( VLC_OBJECT(object), file )
442 #define osd_MenuDelete(object,osd) osd_MenuDelete( VLC_OBJECT(object), osd )
445 * Find OSD Menu button at position x,y
447 VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this,
448 int, int, int, int, int, int ) );
450 #define osd_ButtonFind(object,x,y,h,w,sh,sw) osd_ButtonFind(object,x,y,h,w,sh,sw)
453 * Select the button provided as the new active button
455 VLC_EXPORT( void, osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
457 #define osd_ButtonSelect(object,button) osd_ButtonSelect(object,button)
462 * Show the OSD menu on the video output or mux it into the stream.
463 * Every change to the OSD menu will now be visible in the output. An output
464 * can be a video output window or a stream (\see stream output)
466 VLC_EXPORT( void, osd_MenuShow, ( vlc_object_t * ) );
471 * Stop showing the OSD menu on the video output or mux it into the stream.
473 VLC_EXPORT( void, osd_MenuHide, ( vlc_object_t * ) );
476 * Activate the action of this OSD menu item.
478 * The rc interface command "menu select" triggers the sending of an
479 * hotkey action to the hotkey interface. The hotkey that belongs to
480 * the current highlighted OSD menu item will be used.
482 VLC_EXPORT( void, osd_MenuActivate, ( vlc_object_t * ) );
484 #define osd_MenuShow(object) osd_MenuShow( VLC_OBJECT(object) )
485 #define osd_MenuHide(object) osd_MenuHide( VLC_OBJECT(object) )
486 #define osd_MenuActivate(object) osd_MenuActivate( VLC_OBJECT(object) )
491 * Select the next OSD menu item to be highlighted.
492 * Note: The actual position on screen of the menu item is determined by
493 * the OSD menu configuration file.
495 VLC_EXPORT( void, osd_MenuNext, ( vlc_object_t * ) );
498 * Previous OSD menu item
500 * Select the previous OSD menu item to be highlighted.
501 * Note: The actual position on screen of the menu item is determined by
502 * the OSD menu configuration file.
504 VLC_EXPORT( void, osd_MenuPrev, ( vlc_object_t * ) );
507 * OSD menu item above
509 * Select the OSD menu item above the current item to be highlighted.
510 * Note: The actual position on screen of the menu item is determined by
511 * the OSD menu configuration file.
513 VLC_EXPORT( void, osd_MenuUp, ( vlc_object_t * ) );
516 * OSD menu item below
518 * Select the next OSD menu item below the current item to be highlighted.
519 * Note: The actual position on screen of the menu item is determined by
520 * the OSD menu configuration file.
522 VLC_EXPORT( void, osd_MenuDown, ( vlc_object_t * ) );
524 #define osd_MenuNext(object) osd_MenuNext( VLC_OBJECT(object) )
525 #define osd_MenuPrev(object) osd_MenuPrev( VLC_OBJECT(object) )
526 #define osd_MenuUp(object) osd_MenuUp( VLC_OBJECT(object) )
527 #define osd_MenuDown(object) osd_MenuDown( VLC_OBJECT(object) )
530 * Display the audio volume bitmap.
532 * Display the correct audio volume bitmap that corresponds to the
533 * current Audio Volume setting.
535 VLC_EXPORT( void, osd_Volume, ( vlc_object_t * ) );
537 #define osd_Volume(object) osd_Volume( VLC_OBJECT(object) )
540 * Retrieve a non modifyable pointer to the OSD Menu state
543 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
545 return( p_osd->p_state );
549 * Get the last key press received by the OSD Menu
551 * Returns 0 when no key has been pressed or the value of the key pressed.
553 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
555 return( p_osd->p_state->b_update );
559 * Set the key pressed to a value.
561 * Assign a new key value to the last key pressed on the OSD Menu.
563 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
568 var_Set( p_this, "key-pressed", val );
572 * Update the OSD Menu visibility flag.
574 * true means OSD Menu should be shown. false means OSD Menu
575 * should not be shown.
577 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
581 val.b_bool = p_osd->p_state->b_menu_visible = b_value;
582 var_Set( p_osd, "osd-menu-visible", val );
586 * Update the OSD Menu update flag
588 * If the OSD Menu should be updated then set the update flag to
589 * true, else to false.
591 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
595 val.b_bool = p_osd->p_state->b_update = b_value;
596 var_Set( p_osd, "osd-menu-update", val );
602 * Functions that provide the textual feedback on the OSD. They are shown
603 * on hotkey commands. The feedback is also part of the osd_button_t
604 * object. The types are declared in the include file include/vlc_osd.h
607 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t ) );
608 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
609 VLC_EXPORT( void, osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
612 * Default feedback images
614 * Functions that provide the default OSD feedback images on hotkey
615 * commands. These feedback images are also part of the osd_button_t
616 * object. The types are declared in the include file include/vlc_osd.h
619 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
620 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
624 /**********************************************************************
625 * Vout text and widget overlays
626 **********************************************************************/
627 VLC_EXPORT( int, vout_OSDEpg, ( vout_thread_t *, input_item_t * ) );
630 * Write an informative message at the default location,
631 * for the default duration and only if the OSD option is enabled.
632 * \param p_caller The object that called the function.
633 * \param i_channel Subpicture channel
634 * \param psz_format printf style formatting
636 VLC_EXPORT( void, vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
638 #define vout_OSDMessage( obj, chan, ...) \
639 vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
642 * Display a slider on the video output.
643 * \param p_this The object that called the function.
644 * \param i_channel Subpicture channel
645 * \param i_postion Current position in the slider
646 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
649 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
652 * Display an Icon on the video output.
653 * \param p_this The object that called the function.
654 * \param i_channel Subpicture channel
655 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
658 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
664 #endif /* _VLC_OSD_H */