310b6f0491b8857ee61e8a35896825298606354d
[vlc.git] / include / vlc_osd.h
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
6  * $Id$
7  *
8  * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
9  *          Gildas Bazin <gbazin@videolan.org>
10  *
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>
14  *
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.
19  *
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.
24  *
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  *****************************************************************************/
29
30 #ifndef VLC_OSD_H
31 #define VLC_OSD_H 1
32
33 #include "vlc_vout.h"
34
35 # ifdef __cplusplus
36 extern "C" {
37 # endif
38
39 /**
40  * \file
41  * This file defines SPU subpicture and OSD functions and object types.
42  */
43
44 /**********************************************************************
45  * Base SPU structures
46  **********************************************************************/
47 /**
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.
52  * @{
53  */
54
55 #include <vlc_vout.h>
56
57 typedef struct spu_private_t spu_private_t;
58
59 /* Default subpicture channel ID */
60 #define DEFAULT_CHAN           1
61
62 /**
63  * Subpicture unit descriptor
64  */
65 struct spu_t
66 {
67     VLC_COMMON_MEMBERS
68
69     int (*pf_control)( spu_t *, int, va_list );
70
71     spu_private_t *p;
72 };
73
74 enum spu_query_e
75 {
76     SPU_CHANNEL_REGISTER,         /* arg1= int *   res=    */
77     SPU_CHANNEL_CLEAR             /* arg1= int     res=    */
78 };
79
80 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
81 {
82     if( p_spu->pf_control )
83         return p_spu->pf_control( p_spu, i_query, args );
84     else
85         return VLC_EGENERIC;
86 }
87
88 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
89 {
90     va_list args;
91     int i_result;
92
93     va_start( args, i_query );
94     i_result = spu_vaControl( p_spu, i_query, args );
95     va_end( args );
96     return i_result;
97 }
98
99 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
100 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
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 );
104
105 /**
106  * This function sends a subpicture to the spu_t core.
107  * 
108  * You cannot use the provided subpicture anymore. The spu_t core
109  * will destroy it at its convenience.
110  */
111 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
112
113 /**
114  * This function asks the spu_t core a list of subpictures to display.
115  *
116  * The returned list can only be used by spu_RenderSubpictures.
117  */
118 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t display_date, bool b_paused, bool b_subtitle_only ) );
119
120 /**
121  * This function renders a list of subpicture_t on the provided picture.
122  *
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.
125  */
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, bool b_paused ) );
127
128 /** @}*/
129
130 /**********************************************************************
131  * OSD Menu
132  **********************************************************************/
133 /**
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.
139  *
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:
145  *
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
149  *
150  * An example for local usage of the OSD menu is:
151  *
152  *  vlc dvdsimple:///dev/dvd --extraintf rc
153  *  --sub-filter osdmenu
154  *  --osdmenu-file=share/osdmenu/dvd.cfg
155  *
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.
162  *
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.
166  *
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".
170  * @{
171  */
172
173 /**
174  * \brief The OSD Menu configuration file format.
175  *
176  * The configuration file syntax is very basic and so is its parser. See the
177  * BNF formal representation below:
178  *
179  * The keywords FILENAME and PATHNAME represent the filename and pathname
180  * specification that is valid for the Operating System VLC is compiled for.
181  *
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.
184  *
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', '-' ]+
192  *
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'
200  *
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]+
204  *
205  */
206
207 /**
208  * OSD menu position and picture type defines
209  */
210
211 #define OSD_ALIGN_LEFT 0x1
212 #define OSD_ALIGN_RIGHT 0x2
213 #define OSD_ALIGN_TOP 0x4
214 #define OSD_ALIGN_BOTTOM 0x8
215
216 #define OSD_HOR_SLIDER 1
217 #define OSD_VERT_SLIDER 2
218
219 #define OSD_PLAY_ICON 1
220 #define OSD_PAUSE_ICON 2
221 #define OSD_SPEAKER_ICON 3
222 #define OSD_MUTE_ICON 4
223
224 /**
225  * Text style
226  *
227  * A text style is used to specify the formatting of text.
228  * A font renderer can use the supplied information to render the
229  * text specified.
230  */
231 struct text_style_t
232 {
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 */
260 };
261
262 /* Style flags for \ref text_style_t */
263 #define STYLE_BOLD        1
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
270
271 /**
272  * Create a default text style
273  */
274 VLC_EXPORT( text_style_t *, text_style_New, ( void ) );
275
276 /**
277  * Copy a text style into another
278  */
279 VLC_EXPORT( text_style_t *, text_style_Copy, ( text_style_t *, const text_style_t * ) );
280
281 /**
282  * Duplicate a text style
283  */
284 VLC_EXPORT( text_style_t *, text_style_Duplicate, ( const text_style_t * ) );
285
286 /**
287  * Delete a text style created by text_style_New or text_style_Duplicate
288  */
289 VLC_EXPORT( void, text_style_Delete, ( text_style_t * ) );
290
291 /**
292  * OSD menu button states
293  *
294  * Every button has three states, either it is unselected, selected or pressed.
295  * An OSD menu skin can associate images with each state.
296  *
297  *  OSD_BUTTON_UNSELECT 0
298  *  OSD_BUTTON_SELECT   1
299  *  OSD_BUTTON_PRESSED  2
300  */
301 #define OSD_BUTTON_UNSELECT 0
302 #define OSD_BUTTON_SELECT   1
303 #define OSD_BUTTON_PRESSED  2
304
305 /**
306  * OSD State object
307  *
308  * The OSD state object holds the state and associated images for a
309  * particular state on the screen. The picture is displayed when this
310  * state is the active state.
311  */
312 struct osd_state_t
313 {
314     osd_state_t *p_next;    /*< pointer to next state */
315     osd_state_t *p_prev;    /*< pointer to previous state */
316     picture_t   *p_pic;     /*< picture of state */
317
318     char        *psz_state; /*< state name */
319     int          i_state;   /*< state index */
320
321     int     i_x;            /*< x-position of button state image */
322     int     i_y;            /*< y-position of button state image */
323     int     i_width;        /*< width of button state image */
324     int     i_height;       /*< height of button state image */
325 };
326
327 /**
328  * OSD Button object
329  *
330  * An OSD Button has different states. Each state has an image for display.
331  */
332 struct osd_button_t
333 {
334     osd_button_t *p_next;   /*< pointer to next button */
335     osd_button_t *p_prev;   /*< pointer to previous button */
336     osd_button_t *p_up;     /*< pointer to up button */
337     osd_button_t *p_down;   /*< pointer to down button */
338
339     osd_state_t *p_current_state; /*< pointer to current state image */
340     osd_state_t *p_states; /*< doubly linked list of states */
341     picture_t   *p_feedback; /*< feedback picture */
342
343     char    *psz_name;     /*< name of button */
344
345     /* These member should probably be a struct hotkey */
346     char    *psz_action;      /*< hotkey action name on button*/
347     char    *psz_action_down; /*< hotkey action name on range buttons
348                                   for command "menu down" */
349     /* end of hotkey specifics */
350
351     int     i_x;            /*< x-position of button visible state image */
352     int     i_y;            /*< y-position of button visible state image */
353     int     i_width;        /*< width of button visible state image */
354     int     i_height;       /*< height of button visible state image */
355
356     /* range style button */
357     bool   b_range;    /*< button should be interpreted as range */
358     int          i_ranges;   /*< number of states */
359 };
360
361 /**
362  * OSD Menu Style
363  *
364  * The images that make up an OSD menu can be created in such away that
365  * they contain all buttons in the same picture, with the selected one
366  * highlighted or being a concatenation of all the seperate images. The
367  * first case is the default.
368  *
369  * To change the default style the keyword 'style' should be set to 'concat'.
370  */
371
372 #define OSD_MENU_STYLE_SIMPLE 0x0
373 #define OSD_MENU_STYLE_CONCAT 0x1
374
375 /**
376  * OSD Menu State object
377  *
378  * Represents the current state as displayed.
379  */
380 /* Represent the menu state */
381 struct osd_menu_state_t
382 {
383     int     i_x;        /*< x position of spu region */
384     int     i_y;        /*< y position of spu region */
385     int     i_width;    /*< width of spu region */
386     int     i_height;   /*< height of spu region */
387
388     picture_t    *p_pic;  /*< pointer to picture to display */
389     osd_button_t *p_visible; /*< shortcut to visible button */
390
391     bool b_menu_visible; /*< menu currently visible? */
392     bool b_update;       /*< update OSD Menu when true */
393
394     /* quick hack to volume state. */
395     osd_button_t *p_volume; /*< pointer to volume range object. */
396 };
397
398 /**
399  * OSD Menu object
400  *
401  * The main OSD Menu object, which holds a linked list to all buttons
402  * and images that defines the menu. The p_state variable represents the
403  * current state of the OSD Menu.
404  */
405 struct osd_menu_t
406 {
407     VLC_COMMON_MEMBERS
408
409     int     i_x;        /*< x-position of OSD Menu on the video screen */
410     int     i_y;        /*< y-position of OSD Menu on the video screen */
411     int     i_width;    /*< width of OSD Menu on the video screen */
412     int     i_height;   /*< height of OSD Menu on the video screen */
413     int     i_style;    /*< style of spu region generation */
414     int     i_position; /*< display position */
415
416     char             *psz_path;  /*< directory where OSD menu images are stored */
417     osd_button_t     *p_button;  /*< doubly linked list of buttons */
418     osd_menu_state_t *p_state;   /*< current state of OSD menu */
419
420     /* quick link in the linked list. */
421     osd_button_t  *p_last_button; /*< pointer to last button in the list */
422
423     /* misc parser */
424     module_t        *p_parser;  /*< pointer to parser module */
425     char            *psz_file;  /*< Config file name */
426     image_handler_t *p_image;   /*< handler to image loading and conversion libraries */
427 };
428
429 /**
430  * Initialize an osd_menu_t object
431  *
432  * This functions has to be called before any call to other osd_menu_t*
433  * functions. It creates the osd_menu object and holds a pointer to it
434  * during its lifetime.
435  */
436 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
437
438 /**
439  * Delete the osd_menu_t object
440  *
441  * This functions has to be called to release the associated module and
442  * memory for the osdmenu. After return of this function the pointer to
443  * osd_menu_t* is invalid.
444  */
445 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
446
447 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
448 #define osd_MenuDelete(object,osd)  __osd_MenuDelete( VLC_OBJECT(object), osd )
449
450 /**
451  * Find OSD Menu button at position x,y
452  */
453 VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this,
454      int, int, int, int, int, int ) );
455
456 #define osd_ButtonFind(object,x,y,h,w,sh,sw)  __osd_ButtonFind(object,x,y,h,w,sh,sw)
457
458 /**
459  * Select the button provided as the new active button
460  */
461 VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
462
463 #define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button)
464
465 /**
466  * Show the OSD menu.
467  *
468  * Show the OSD menu on the video output or mux it into the stream.
469  * Every change to the OSD menu will now be visible in the output. An output
470  * can be a video output window or a stream (\see stream output)
471  */
472 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
473
474 /**
475  * Hide the OSD menu.
476  *
477  * Stop showing the OSD menu on the video output or mux it into the stream.
478  */
479 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
480
481 /**
482  * Activate the action of this OSD menu item.
483  *
484  * The rc interface command "menu select" triggers the sending of an
485  * hotkey action to the hotkey interface. The hotkey that belongs to
486  * the current highlighted OSD menu item will be used.
487  */
488 VLC_EXPORT( void, __osd_MenuActivate,   ( vlc_object_t * ) );
489
490 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
491 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
492 #define osd_MenuActivate(object)   __osd_MenuActivate( VLC_OBJECT(object) )
493
494 /**
495  * Next OSD menu item
496  *
497  * Select the next OSD menu item to be highlighted.
498  * Note: The actual position on screen of the menu item is determined by
499  * the OSD menu configuration file.
500  */
501 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
502
503 /**
504  * Previous OSD menu item
505  *
506  * Select the previous OSD menu item to be highlighted.
507  * Note: The actual position on screen of the menu item is determined by
508  * the OSD menu configuration file.
509  */
510 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
511
512 /**
513  * OSD menu item above
514  *
515  * Select the OSD menu item above the current item to be highlighted.
516  * Note: The actual position on screen of the menu item is determined by
517  * the OSD menu configuration file.
518  */
519 VLC_EXPORT( void, __osd_MenuUp,   ( vlc_object_t * ) );
520
521 /**
522  * OSD menu item below
523  *
524  * Select the next OSD menu item below the current item to be highlighted.
525  * Note: The actual position on screen of the menu item is determined by
526  * the OSD menu configuration file.
527  */
528 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
529
530 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
531 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
532 #define osd_MenuUp(object)   __osd_MenuUp( VLC_OBJECT(object) )
533 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
534
535 /**
536  * Display the audio volume bitmap.
537  *
538  * Display the correct audio volume bitmap that corresponds to the
539  * current Audio Volume setting.
540  */
541 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
542
543 #define osd_Volume(object)     __osd_Volume( VLC_OBJECT(object) )
544
545 /**
546  * Retrieve a non modifyable pointer to the OSD Menu state
547  *
548  */
549 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
550 {
551     return( p_osd->p_state );
552 }
553
554 /**
555  * Get the last key press received by the OSD Menu
556  *
557  * Returns 0 when no key has been pressed or the value of the key pressed.
558  */
559 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
560 {
561     return( p_osd->p_state->b_update );
562 }
563
564 /**
565  * Set the key pressed to a value.
566  *
567  * Assign a new key value to the last key pressed on the OSD Menu.
568  */
569 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
570 {
571     vlc_value_t val;
572
573     val.i_int = i_value;
574     var_Set( p_this, "key-pressed", val );
575 }
576
577 /**
578  * Update the OSD Menu visibility flag.
579  *
580  * true means OSD Menu should be shown. false means OSD Menu
581  * should not be shown.
582  */
583 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
584 {
585     vlc_value_t val;
586
587     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
588     var_Set( p_osd, "osd-menu-visible", val );
589 }
590
591 /**
592  * Update the OSD Menu update flag
593  *
594  * If the OSD Menu should be updated then set the update flag to
595  * true, else to false.
596  */
597 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
598 {
599     vlc_value_t val;
600
601     val.b_bool = p_osd->p_state->b_update = b_value;
602     var_Set( p_osd, "osd-menu-update", val );
603 }
604
605 /**
606  * Textual feedback
607  *
608  * Functions that provide the textual feedback on the OSD. They are shown
609  * on hotkey commands. The feedback is also part of the osd_button_t
610  * object. The types are declared in the include file include/vlc_osd.h
611  * @see vlc_osd.h
612  */
613 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t ) );
614 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
615 VLC_EXPORT( void, osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
616
617 /**
618  * Default feedback images
619  *
620  * Functions that provide the default OSD feedback images on hotkey
621  * commands. These feedback images are also part of the osd_button_t
622  * object. The types are declared in the include file include/vlc_osd.h
623  * @see vlc_osd.h
624  */
625 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
626 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
627
628 /** @} */
629
630 /**********************************************************************
631  * Vout text and widget overlays
632  **********************************************************************/
633
634 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, const text_style_t *, int, int, int, mtime_t ) );
635
636 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
637
638 /**
639  * Write an informative message at the default location,
640  * for the default duration and only if the OSD option is enabled.
641  * \param p_caller The object that called the function.
642  * \param i_channel Subpicture channel
643  * \param psz_format printf style formatting
644  **/
645 VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
646
647 /**
648  * Same as __vlc_OSDMessage() but with automatic casting
649  */
650 #define vout_OSDMessage( obj, chan, ...) \
651       __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
652
653 /**
654  * Display a slider on the video output.
655  * \param p_this    The object that called the function.
656  * \param i_channel Subpicture channel
657  * \param i_postion Current position in the slider
658  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
659  * @see vlc_osd.h
660  */
661 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
662
663 /**
664  * Display an Icon on the video output.
665  * \param p_this    The object that called the function.
666  * \param i_channel Subpicture channel
667  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
668  * @see vlc_osd.h
669  */
670 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
671
672 # ifdef __cplusplus
673 }
674 # endif
675
676 #endif /* _VLC_OSD_H */