Render subpictures in the right order to improve overlap support.
[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 /**
58  * Subpicture unit descriptor
59  */
60 struct spu_t
61 {
62     VLC_COMMON_MEMBERS
63
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 */
67     int64_t i_subpicture_order; /**< number of created subpicture since spu creation */
68
69     filter_t *p_blend;                            /**< alpha blending module */
70     filter_t *p_text;                              /**< text renderer module */
71     filter_t *p_scale_yuvp;                     /**< scaling module for YUVP */
72     filter_t *p_scale;                    /**< scaling module (all but YUVP) */
73     bool b_force_crop;                     /**< force cropping of subpicture */
74     int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */
75
76     int i_margin;                        /**< force position of a subpicture */
77     bool b_force_palette;             /**< force palette of subpicture */
78     uint8_t palette[4][4];                               /**< forced palette */
79
80     int ( *pf_control ) ( spu_t *, int, va_list );
81
82     /* Supciture filters */
83     filter_chain_t *p_chain;
84 };
85
86 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
87 {
88     if( p_spu->pf_control )
89         return p_spu->pf_control( p_spu, i_query, args );
90     else
91         return VLC_EGENERIC;
92 }
93
94 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
95 {
96     va_list args;
97     int i_result;
98
99     va_start( args, i_query );
100     i_result = spu_vaControl( p_spu, i_query, args );
101     va_end( args );
102     return i_result;
103 }
104
105 enum spu_query_e
106 {
107     SPU_CHANNEL_REGISTER,         /* arg1= int *   res=    */
108     SPU_CHANNEL_CLEAR             /* arg1= int     res=    */
109 };
110
111 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
112 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
113 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
114 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
115 void spu_Attach( spu_t *, vlc_object_t *, bool );
116
117 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
118 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
119 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
120
121 #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
122 VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
123 #define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
124 VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
125 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t display_date, bool b_paused, bool b_subtitle_only ) );
126
127 /**
128  * This function renders a list of subpicture_t on the provided picture.
129  *
130  * \param p_fmt_dst is the format of the destination picture.
131  * \param p_fmt_src is the format of the original(source) video.
132  */
133 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 ) );
134
135 /** @}*/
136
137 /**********************************************************************
138  * OSD Menu
139  **********************************************************************/
140 /**
141  * \defgroup osdmenu OSD Menu
142  * The OSD menu core creates the OSD menu structure in memory. It parses a
143  * configuration file that defines all elements that are part of the menu. The
144  * core also handles all actions and menu structure updates on behalf of video
145  * subpicture filters.
146  *
147  * The file modules/video_filters/osdmenu.c implements a subpicture filter that
148  * specifies the final information on positioning of the current state image.
149  * A subpicture filter is called each time a video picture has to be rendered,
150  * it also gives a start and end date to the subpicture. The subpicture can be
151  * streamed if used inside a transcoding command. For example:
152  *
153  *  vlc dvdsimple:///dev/dvd --extraintf rc
154  *  --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
155  *  --osdmenu-file=share/osdmenu/dvd.cfg
156  *
157  * An example for local usage of the OSD menu is:
158  *
159  *  vlc dvdsimple:///dev/dvd --extraintf rc
160  *  --sub-filter osdmenu
161  *  --osdmenu-file=share/osdmenu/dvd.cfg
162  *
163  * Each OSD menu element, called "action", defines a hotkey action. Each action
164  * can have several states (unselect, select, pressed). Each state has an image
165  * that represents the state visually. The commands "menu right", "menu left",
166  * "menu up" and "menu down" are used to navigate through the OSD menu structure.
167  * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
168  * show and hide the OSD menu subpictures.
169  *
170  * There is one special element called "range". A range is an arbritary range
171  * of state images that can be browsed using "menu up" and "menu down" commands
172  * on the rc interface.
173  *
174  * The OSD menu configuration file uses a very simple syntax and basic parser.
175  * A configuration file has the ".cfg".
176  * An example is "share/osdmenu/dvd256.cfg".
177  * @{
178  */
179
180 /**
181  * \brief The OSD Menu configuration file format.
182  *
183  * The configuration file syntax is very basic and so is its parser. See the
184  * BNF formal representation below:
185  *
186  * The keywords FILENAME and PATHNAME represent the filename and pathname
187  * specification that is valid for the Operating System VLC is compiled for.
188  *
189  * The hotkey actions that are supported by VLC are documented in the file
190  * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
191  *
192  * CONFIG_FILE = FILENAME '.cfg'
193  * WS = [ ' ' | '\t' ]+
194  * OSDMENU_PATH = PATHNAME
195  * DIR = 'dir' WS OSDMENU_PATH '\n'
196  * STYLE = 'style' [ 'default' | 'concat' ] '\n'
197  * STATE = [ 'unselect' | 'select' | 'pressed' ]
198  * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
199  *
200  * ACTION_TYPE        = 'type' 'volume' '\n'
201  * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
202  * ACTION_BLOCK_END   = 'end' '\n'
203  * ACTION_STATE       = STATE WS FILENAME '\n'
204  * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
205  * ACTION_RANGE_END   = 'end' '\n'
206  * ACTION_RANGE_STATE = FILENAME '\n'
207  *
208  * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
209  * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
210  * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
211  *
212  */
213
214 /**
215  * OSD menu position and picture type defines
216  */
217
218 #define OSD_ALIGN_LEFT 0x1
219 #define OSD_ALIGN_RIGHT 0x2
220 #define OSD_ALIGN_TOP 0x4
221 #define OSD_ALIGN_BOTTOM 0x8
222
223 #define OSD_HOR_SLIDER 1
224 #define OSD_VERT_SLIDER 2
225
226 #define OSD_PLAY_ICON 1
227 #define OSD_PAUSE_ICON 2
228 #define OSD_SPEAKER_ICON 3
229 #define OSD_MUTE_ICON 4
230
231 /**
232  * Text style
233  *
234  * A text style is used to specify the formatting of text.
235  * A font renderer can use the supplied information to render the
236  * text specified.
237  */
238 struct text_style_t
239 {
240     char *     psz_fontname;      /**< The name of the font */
241     int        i_font_size;       /**< The font size in pixels */
242     int        i_font_color;      /**< The color of the text 0xRRGGBB
243                                        (native endianness) */
244     int        i_font_alpha;      /**< The transparency of the text.
245                                        0x00 is fully opaque,
246                                        0xFF fully transparent */
247     int        i_style_flags;     /**< Formatting style flags */
248     int        i_outline_color;   /**< The color of the outline 0xRRGGBB */
249     int        i_outline_alpha;   /**< The transparency of the outline.
250                                        0x00 is fully opaque,
251                                        0xFF fully transparent */
252     int        i_shadow_color;    /**< The color of the shadow 0xRRGGBB */
253     int        i_shadow_alpha;    /**< The transparency of the shadow.
254                                         0x00 is fully opaque,
255                                         0xFF fully transparent */
256     int        i_background_color;/**< The color of the background 0xRRGGBB */
257     int        i_background_alpha;/**< The transparency of the background.
258                                        0x00 is fully opaque,
259                                        0xFF fully transparent */
260     int        i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
261     int        i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
262                                        0x00 is fully opaque,
263                                        0xFF fully transparent */
264     int        i_outline_width;   /**< The width of the outline in pixels */
265     int        i_shadow_width;    /**< The width of the shadow in pixels */
266     int        i_spacing;         /**< The spaceing between glyphs in pixels */
267 };
268
269 /* Style flags for \ref text_style_t */
270 #define STYLE_BOLD        1
271 #define STYLE_ITALIC      2
272 #define STYLE_OUTLINE     4
273 #define STYLE_SHADOW      8
274 #define STYLE_BACKGROUND  16
275 #define STYLE_UNDERLINE   32
276 #define STYLE_STRIKEOUT   64
277
278 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
279                 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 };
280
281 /**
282  * OSD menu button states
283  *
284  * Every button has three states, either it is unselected, selected or pressed.
285  * An OSD menu skin can associate images with each state.
286  *
287  *  OSD_BUTTON_UNSELECT 0
288  *  OSD_BUTTON_SELECT   1
289  *  OSD_BUTTON_PRESSED  2
290  */
291 #define OSD_BUTTON_UNSELECT 0
292 #define OSD_BUTTON_SELECT   1
293 #define OSD_BUTTON_PRESSED  2
294
295 /**
296  * OSD State object
297  *
298  * The OSD state object holds the state and associated images for a
299  * particular state on the screen. The picture is displayed when this
300  * state is the active state.
301  */
302 struct osd_state_t
303 {
304     osd_state_t *p_next;    /*< pointer to next state */
305     osd_state_t *p_prev;    /*< pointer to previous state */
306     picture_t   *p_pic;     /*< picture of state */
307
308     char        *psz_state; /*< state name */
309     int          i_state;   /*< state index */
310
311     int     i_x;            /*< x-position of button state image */
312     int     i_y;            /*< y-position of button state image */
313     int     i_width;        /*< width of button state image */
314     int     i_height;       /*< height of button state image */
315 };
316
317 /**
318  * OSD Button object
319  *
320  * An OSD Button has different states. Each state has an image for display.
321  */
322 struct osd_button_t
323 {
324     osd_button_t *p_next;   /*< pointer to next button */
325     osd_button_t *p_prev;   /*< pointer to previous button */
326     osd_button_t *p_up;     /*< pointer to up button */
327     osd_button_t *p_down;   /*< pointer to down button */
328
329     osd_state_t *p_current_state; /*< pointer to current state image */
330     osd_state_t *p_states; /*< doubly linked list of states */
331     picture_t   *p_feedback; /*< feedback picture */
332
333     char    *psz_name;     /*< name of button */
334
335     /* These member should probably be a struct hotkey */
336     char    *psz_action;      /*< hotkey action name on button*/
337     char    *psz_action_down; /*< hotkey action name on range buttons
338                                   for command "menu down" */
339     /* end of hotkey specifics */
340
341     int     i_x;            /*< x-position of button visible state image */
342     int     i_y;            /*< y-position of button visible state image */
343     int     i_width;        /*< width of button visible state image */
344     int     i_height;       /*< height of button visible state image */
345
346     /* range style button */
347     bool   b_range;    /*< button should be interpreted as range */
348     int          i_ranges;   /*< number of states */
349 };
350
351 /**
352  * OSD Menu Style
353  *
354  * The images that make up an OSD menu can be created in such away that
355  * they contain all buttons in the same picture, with the selected one
356  * highlighted or being a concatenation of all the seperate images. The
357  * first case is the default.
358  *
359  * To change the default style the keyword 'style' should be set to 'concat'.
360  */
361
362 #define OSD_MENU_STYLE_SIMPLE 0x0
363 #define OSD_MENU_STYLE_CONCAT 0x1
364
365 /**
366  * OSD Menu State object
367  *
368  * Represents the current state as displayed.
369  */
370 /* Represent the menu state */
371 struct osd_menu_state_t
372 {
373     int     i_x;        /*< x position of spu region */
374     int     i_y;        /*< y position of spu region */
375     int     i_width;    /*< width of spu region */
376     int     i_height;   /*< height of spu region */
377
378     picture_t    *p_pic;  /*< pointer to picture to display */
379     osd_button_t *p_visible; /*< shortcut to visible button */
380
381     bool b_menu_visible; /*< menu currently visible? */
382     bool b_update;       /*< update OSD Menu when true */
383
384     /* quick hack to volume state. */
385     osd_button_t *p_volume; /*< pointer to volume range object. */
386 };
387
388 /**
389  * OSD Menu object
390  *
391  * The main OSD Menu object, which holds a linked list to all buttons
392  * and images that defines the menu. The p_state variable represents the
393  * current state of the OSD Menu.
394  */
395 struct osd_menu_t
396 {
397     VLC_COMMON_MEMBERS
398
399     int     i_x;        /*< x-position of OSD Menu on the video screen */
400     int     i_y;        /*< y-position of OSD Menu on the video screen */
401     int     i_width;    /*< width of OSD Menu on the video screen */
402     int     i_height;   /*< height of OSD Menu on the video screen */
403     int     i_style;    /*< style of spu region generation */
404     int     i_position; /*< display position */
405
406     char             *psz_path;  /*< directory where OSD menu images are stored */
407     osd_button_t     *p_button;  /*< doubly linked list of buttons */
408     osd_menu_state_t *p_state;   /*< current state of OSD menu */
409
410     /* quick link in the linked list. */
411     osd_button_t  *p_last_button; /*< pointer to last button in the list */
412
413     /* misc parser */
414     module_t        *p_parser;  /*< pointer to parser module */
415     char            *psz_file;  /*< Config file name */
416     image_handler_t *p_image;   /*< handler to image loading and conversion libraries */
417 };
418
419 /**
420  * Initialize an osd_menu_t object
421  *
422  * This functions has to be called before any call to other osd_menu_t*
423  * functions. It creates the osd_menu object and holds a pointer to it
424  * during its lifetime.
425  */
426 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
427
428 /**
429  * Delete the osd_menu_t object
430  *
431  * This functions has to be called to release the associated module and
432  * memory for the osdmenu. After return of this function the pointer to
433  * osd_menu_t* is invalid.
434  */
435 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
436
437 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
438 #define osd_MenuDelete(object,osd)  __osd_MenuDelete( VLC_OBJECT(object), osd )
439
440 /**
441  * Find OSD Menu button at position x,y
442  */
443 VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this,
444      int, int, int, int, int, int ) );
445
446 #define osd_ButtonFind(object,x,y,h,w,sh,sw)  __osd_ButtonFind(object,x,y,h,w,sh,sw)
447
448 /**
449  * Select the button provided as the new active button
450  */
451 VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
452
453 #define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button)
454
455 /**
456  * Show the OSD menu.
457  *
458  * Show the OSD menu on the video output or mux it into the stream.
459  * Every change to the OSD menu will now be visible in the output. An output
460  * can be a video output window or a stream (\see stream output)
461  */
462 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
463
464 /**
465  * Hide the OSD menu.
466  *
467  * Stop showing the OSD menu on the video output or mux it into the stream.
468  */
469 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
470
471 /**
472  * Activate the action of this OSD menu item.
473  *
474  * The rc interface command "menu select" triggers the sending of an
475  * hotkey action to the hotkey interface. The hotkey that belongs to
476  * the current highlighted OSD menu item will be used.
477  */
478 VLC_EXPORT( void, __osd_MenuActivate,   ( vlc_object_t * ) );
479
480 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
481 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
482 #define osd_MenuActivate(object)   __osd_MenuActivate( VLC_OBJECT(object) )
483
484 /**
485  * Next OSD menu item
486  *
487  * Select the next OSD menu item to be highlighted.
488  * Note: The actual position on screen of the menu item is determined by
489  * the OSD menu configuration file.
490  */
491 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
492
493 /**
494  * Previous OSD menu item
495  *
496  * Select the previous OSD menu item to be highlighted.
497  * Note: The actual position on screen of the menu item is determined by
498  * the OSD menu configuration file.
499  */
500 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
501
502 /**
503  * OSD menu item above
504  *
505  * Select the OSD menu item above the current item to be highlighted.
506  * Note: The actual position on screen of the menu item is determined by
507  * the OSD menu configuration file.
508  */
509 VLC_EXPORT( void, __osd_MenuUp,   ( vlc_object_t * ) );
510
511 /**
512  * OSD menu item below
513  *
514  * Select the next OSD menu item below the current item to be highlighted.
515  * Note: The actual position on screen of the menu item is determined by
516  * the OSD menu configuration file.
517  */
518 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
519
520 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
521 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
522 #define osd_MenuUp(object)   __osd_MenuUp( VLC_OBJECT(object) )
523 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
524
525 /**
526  * Display the audio volume bitmap.
527  *
528  * Display the correct audio volume bitmap that corresponds to the
529  * current Audio Volume setting.
530  */
531 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
532
533 #define osd_Volume(object)     __osd_Volume( VLC_OBJECT(object) )
534
535 /**
536  * Retrieve a non modifyable pointer to the OSD Menu state
537  *
538  */
539 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
540 {
541     return( p_osd->p_state );
542 }
543
544 /**
545  * Get the last key press received by the OSD Menu
546  *
547  * Returns 0 when no key has been pressed or the value of the key pressed.
548  */
549 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
550 {
551     return( p_osd->p_state->b_update );
552 }
553
554 /**
555  * Set the key pressed to a value.
556  *
557  * Assign a new key value to the last key pressed on the OSD Menu.
558  */
559 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
560 {
561     vlc_value_t val;
562
563     val.i_int = i_value;
564     var_Set( p_this, "key-pressed", val );
565 }
566
567 /**
568  * Update the OSD Menu visibility flag.
569  *
570  * true means OSD Menu should be shown. false means OSD Menu
571  * should not be shown.
572  */
573 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
574 {
575     vlc_value_t val;
576
577     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
578     var_Set( p_osd, "osd-menu-visible", val );
579 }
580
581 /**
582  * Update the OSD Menu update flag
583  *
584  * If the OSD Menu should be updated then set the update flag to
585  * true, else to false.
586  */
587 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
588 {
589     vlc_value_t val;
590
591     val.b_bool = p_osd->p_state->b_update = b_value;
592     var_Set( p_osd, "osd-menu-update", val );
593 }
594
595 /**
596  * Textual feedback
597  *
598  * Functions that provide the textual feedback on the OSD. They are shown
599  * on hotkey commands. The feedback is also part of the osd_button_t
600  * object. The types are declared in the include file include/vlc_osd.h
601  * @see vlc_osd.h
602  */
603 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
604 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
605 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
606
607 /**
608  * Default feedback images
609  *
610  * Functions that provide the default OSD feedback images on hotkey
611  * commands. These feedback images are also part of the osd_button_t
612  * object. The types are declared in the include file include/vlc_osd.h
613  * @see vlc_osd.h
614  */
615 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
616 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
617
618 /** @} */
619
620 /**********************************************************************
621  * Vout text and widget overlays
622  **********************************************************************/
623
624 /**
625  * Show text on the video for some time
626  * \param p_vout pointer to the vout the text is to be showed on
627  * \param i_channel Subpicture channel
628  * \param psz_string The text to be shown
629  * \param p_style Pointer to a struct with text style info
630  * \param i_flags flags for alignment and such
631  * \param i_hmargin horizontal margin in pixels
632  * \param i_vmargin vertical margin in pixels
633  * \param i_duration Amount of time the text is to be shown.
634  */
635 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
636
637 /**
638  * Show text on the video from a given start date to a given end date
639  * \param p_vout pointer to the vout the text is to be showed on
640  * \param i_channel Subpicture channel
641  * \param psz_string The text to be shown
642  * \param p_style Pointer to a struct with text style info
643  * \param i_flags flags for alignment and such
644  * \param i_hmargin horizontal margin in pixels
645  * \param i_vmargin vertical margin in pixels
646  * \param i_start the time when this string is to appear on the video
647  * \param i_stop the time when this string should stop to be displayed
648  *               if this is 0 the string will be shown untill the next string
649  *               is about to be shown
650  */
651 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
652
653 /**
654  * Write an informative message at the default location,
655  * for the default duration and only if the OSD option is enabled.
656  * \param p_caller The object that called the function.
657  * \param i_channel Subpicture channel
658  * \param psz_format printf style formatting
659  **/
660 VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
661
662 /**
663  * Same as __vlc_OSDMessage() but with automatic casting
664  */
665 #define vout_OSDMessage( obj, chan, ...) \
666       __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
667
668 /**
669  * Display a slider on the video output.
670  * \param p_this    The object that called the function.
671  * \param i_channel Subpicture channel
672  * \param i_postion Current position in the slider
673  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
674  * @see vlc_osd.h
675  */
676 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
677
678 /**
679  * Display an Icon on the video output.
680  * \param p_this    The object that called the function.
681  * \param i_channel Subpicture channel
682  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
683  * @see vlc_osd.h
684  */
685 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
686
687 # ifdef __cplusplus
688 }
689 # endif
690
691 #endif /* _VLC_OSD_H */