Implement clickable osdmenu. The clickable positioning and scaling guessing is not...
[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 #if !defined( __LIBVLC__ )
31   #error You are not libvlc or one of its plugins. You cannot include this file
32 #endif
33
34 #ifndef _VLC_OSD_H
35 #define _VLC_OSD_H 1
36
37 #include "vlc_vout.h"
38
39 # ifdef __cplusplus
40 extern "C" {
41 # endif
42
43 /**********************************************************************
44  * Base SPU structures
45  **********************************************************************/
46 /**
47  * \defgroup spu Subpicture Unit
48  * This module describes the programming interface for the subpicture unit.
49  * It includes functions allowing to create/destroy an spu, create/destroy
50  * subpictures and render them.
51  * @{
52  */
53
54 #include <vlc_vout.h>
55
56 /**
57  * Subpicture unit descriptor
58  */
59 struct spu_t
60 {
61     VLC_COMMON_MEMBERS
62
63     vlc_mutex_t  subpicture_lock;                  /**< subpicture heap lock */
64     subpicture_t p_subpicture[VOUT_MAX_SUBPICTURES];        /**< subpictures */
65     int i_channel;             /**< number of subpicture channels registered */
66
67     filter_t *p_blend;                            /**< alpha blending module */
68     filter_t *p_text;                              /**< text renderer module */
69     filter_t *p_scale;                                   /**< scaling module */
70     vlc_bool_t b_force_crop;               /**< force cropping of subpicture */
71     int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */
72
73     int i_margin;                        /**< force position of a subpicture */
74     vlc_bool_t b_force_palette;             /**< force palette of subpicture */
75     uint8_t palette[4][4];                               /**< forced palette */
76
77     int ( *pf_control ) ( spu_t *, int, va_list );
78
79     /* Supciture filters */
80     filter_t *pp_filter[10];
81     int      i_filter;
82 };
83
84 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
85 {
86     if( p_spu->pf_control )
87         return p_spu->pf_control( p_spu, i_query, args );
88     else
89         return VLC_EGENERIC;
90 }
91
92 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
93 {
94     va_list args;
95     int i_result;
96
97     va_start( args, i_query );
98     i_result = spu_vaControl( p_spu, i_query, args );
99     va_end( args );
100     return i_result;
101 }
102
103 enum spu_query_e
104 {
105     SPU_CHANNEL_REGISTER,         /* arg1= int *   res=    */
106     SPU_CHANNEL_CLEAR             /* arg1= int     res=    */
107 };
108
109 #define spu_Create(a) __spu_Create(VLC_OBJECT(a))
110 VLC_EXPORT( spu_t *, __spu_Create, ( vlc_object_t * ) );
111 VLC_EXPORT( int, spu_Init, ( spu_t * ) );
112 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
113 void spu_Attach( spu_t *, vlc_object_t *, vlc_bool_t );
114
115 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
116 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
117 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
118
119 #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
120 VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
121 #define spu_MakeRegion(a,b,c) __spu_MakeRegion(VLC_OBJECT(a),b,c)
122 VLC_EXPORT( subpicture_region_t *,__spu_MakeRegion, ( vlc_object_t *, video_format_t *, picture_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, vlc_bool_t ) );
126 VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *,  video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) );
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 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
272                 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 };
273
274 /**
275  * OSD menu button states
276  *
277  * Every button has three states, either it is unselected, selected or pressed.
278  * An OSD menu skin can associate images with each state.
279  *
280  *  OSD_BUTTON_UNSELECT 0
281  *  OSD_BUTTON_SELECT   1
282  *  OSD_BUTTON_PRESSED  2
283  */
284 #define OSD_BUTTON_UNSELECT 0
285 #define OSD_BUTTON_SELECT   1
286 #define OSD_BUTTON_PRESSED  2
287
288 /**
289  * OSD State object
290  *
291  * The OSD state object holds the state and associated images for a
292  * particular state on the screen. The picture is displayed when this
293  * state is the active state.
294  */
295 struct osd_state_t
296 {
297     osd_state_t *p_next;    /*< pointer to next state */
298     osd_state_t *p_prev;    /*< pointer to previous state */
299     picture_t   *p_pic;     /*< picture of state */
300
301     char        *psz_state; /*< state name */
302     int          i_state;   /*< state index */
303
304     int     i_x;            /*< x-position of button state image */
305     int     i_y;            /*< y-position of button state image */
306     int     i_width;        /*< width of button state image */
307     int     i_height;       /*< height of button state image */
308 };
309
310 /**
311  * OSD Button object
312  *
313  * An OSD Button has different states. Each state has an image for display.
314  */
315 struct osd_button_t
316 {
317     osd_button_t *p_next;   /*< pointer to next button */
318     osd_button_t *p_prev;   /*< pointer to previous button */
319     osd_button_t *p_up;     /*< pointer to up button */
320     osd_button_t *p_down;   /*< pointer to down button */
321
322     osd_state_t *p_current_state; /*< pointer to current state image */
323     osd_state_t *p_states; /*< doubly linked list of states */
324     picture_t   *p_feedback; /*< feedback picture */
325
326     char    *psz_name;     /*< name of button */
327
328     /* These member should probably be a struct hotkey */
329     char    *psz_action;      /*< hotkey action name on button*/
330     char    *psz_action_down; /*< hotkey action name on range buttons
331                                   for command "menu down" */
332     /* end of hotkey specifics */
333
334     int     i_x;            /*< x-position of button visible state image */
335     int     i_y;            /*< y-position of button visible state image */
336     int     i_width;        /*< width of button visible state image */
337     int     i_height;       /*< height of button visible state image */
338
339     /* range style button */
340     vlc_bool_t   b_range;    /*< button should be interpreted as range */
341     int          i_ranges;   /*< number of states */
342 };
343
344 /**
345  * OSD Menu Style
346  *
347  * The images that make up an OSD menu can be created in such away that
348  * they contain all buttons in the same picture, with the selected one
349  * highlighted or being a concatenation of all the seperate images. The
350  * first case is the default.
351  *
352  * To change the default style the keyword 'style' should be set to 'concat'.
353  */
354
355 #define OSD_MENU_STYLE_SIMPLE 0x0
356 #define OSD_MENU_STYLE_CONCAT 0x1
357
358 /**
359  * OSD Menu State object
360  *
361  * Represents the current state as displayed.
362  */
363 /* Represent the menu state */
364 struct osd_menu_state_t
365 {
366     int     i_x;        /*< x position of spu region */
367     int     i_y;        /*< y position of spu region */
368     int     i_width;    /*< width of spu region */
369     int     i_height;   /*< height of spu region */
370
371     picture_t    *p_pic;  /*< pointer to picture to display */
372     osd_button_t *p_visible; /*< shortcut to visible button */
373
374     vlc_bool_t b_menu_visible; /*< menu currently visible? */
375     vlc_bool_t b_update;       /*< update OSD Menu when VLC_TRUE */
376
377     /* quick hack to volume state. */
378     osd_button_t *p_volume; /*< pointer to volume range object. */
379 };
380
381 /**
382  * OSD Menu object
383  *
384  * The main OSD Menu object, which holds a linked list to all buttons
385  * and images that defines the menu. The p_state variable represents the
386  * current state of the OSD Menu.
387  */
388 struct osd_menu_t
389 {
390     VLC_COMMON_MEMBERS
391
392     int     i_x;        /*< x-position of OSD Menu on the video screen */
393     int     i_y;        /*< y-position of OSD Menu on the video screen */
394     int     i_width;    /*< width of OSD Menu on the video screen */
395     int     i_height;   /*< height of OSD Menu on the video screen */
396     int     i_style;    /*< style of spu region generation */
397     int     i_position; /*< display position */
398
399     char             *psz_path;  /*< directory where OSD menu images are stored */
400     osd_button_t     *p_button;  /*< doubly linked list of buttons */
401     osd_menu_state_t *p_state;   /*< current state of OSD menu */
402
403     /* quick link in the linked list. */
404     osd_button_t  *p_last_button; /*< pointer to last button in the list */
405
406     /* misc parser */
407     module_t        *p_parser;  /*< pointer to parser module */
408     char            *psz_file;  /*< Config file name */
409     image_handler_t *p_image;   /*< handler to image loading and conversion libraries */
410 };
411
412 /**
413  * Initialize an osd_menu_t object
414  *
415  * This functions has to be called before any call to other osd_menu_t*
416  * functions. It creates the osd_menu object and holds a pointer to it
417  * during its lifetime.
418  */
419 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
420
421 /**
422  * Delete the osd_menu_t object
423  *
424  * This functions has to be called to release the associated module and
425  * memory for the osdmenu. After return of this function the pointer to
426  * osd_menu_t* is invalid.
427  */
428 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
429
430 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
431 #define osd_MenuDelete(object,osd)  __osd_MenuDelete( VLC_OBJECT(object), osd )
432
433 /**
434  * Find OSD Menu button at position x,y
435  */
436 VLC_EXPORT( osd_button_t *, __osd_ButtonFind, ( vlc_object_t *p_this,
437      int, int, int, int, int, int ) );
438
439 #define osd_ButtonFind(object,x,y,h,w,sh,sw)  __osd_ButtonFind(object,x,y,h,w,sh,sw)
440
441 /**
442  * Select the button provided as the new active button
443  */
444 VLC_EXPORT( void, __osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
445
446 #define osd_ButtonSelect(object,button) __osd_ButtonSelect(object,button)
447
448 /**
449  * Show the OSD menu.
450  *
451  * Show the OSD menu on the video output or mux it into the stream.
452  * Every change to the OSD menu will now be visible in the output. An output
453  * can be a video output window or a stream (\see stream output)
454  */
455 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
456
457 /**
458  * Hide the OSD menu.
459  *
460  * Stop showing the OSD menu on the video output or mux it into the stream.
461  */
462 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
463
464 /**
465  * Activate the action of this OSD menu item.
466  *
467  * The rc interface command "menu select" triggers the sending of an
468  * hotkey action to the hotkey interface. The hotkey that belongs to
469  * the current highlighted OSD menu item will be used.
470  */
471 VLC_EXPORT( void, __osd_MenuActivate,   ( vlc_object_t * ) );
472
473 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
474 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
475 #define osd_MenuActivate(object)   __osd_MenuActivate( VLC_OBJECT(object) )
476
477 /**
478  * Next OSD menu item
479  *
480  * Select the next OSD menu item to be highlighted.
481  * Note: The actual position on screen of the menu item is determined by
482  * the OSD menu configuration file.
483  */
484 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
485
486 /**
487  * Previous OSD menu item
488  *
489  * Select the previous OSD menu item to be highlighted.
490  * Note: The actual position on screen of the menu item is determined by
491  * the OSD menu configuration file.
492  */
493 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
494
495 /**
496  * OSD menu item above
497  *
498  * Select the OSD menu item above the current item to be highlighted.
499  * Note: The actual position on screen of the menu item is determined by
500  * the OSD menu configuration file.
501  */
502 VLC_EXPORT( void, __osd_MenuUp,   ( vlc_object_t * ) );
503
504 /**
505  * OSD menu item below
506  *
507  * Select the next OSD menu item below the current item to be highlighted.
508  * Note: The actual position on screen of the menu item is determined by
509  * the OSD menu configuration file.
510  */
511 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
512
513 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
514 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
515 #define osd_MenuUp(object)   __osd_MenuUp( VLC_OBJECT(object) )
516 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
517
518 /**
519  * Display the audio volume bitmap.
520  *
521  * Display the correct audio volume bitmap that corresponds to the
522  * current Audio Volume setting.
523  */
524 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
525
526 #define osd_Volume(object)     __osd_Volume( VLC_OBJECT(object) )
527
528 /**
529  * Retrieve a non modifyable pointer to the OSD Menu state
530  *
531  */
532 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
533 {
534     return( p_osd->p_state );
535 }
536
537 /**
538  * Get the last key press received by the OSD Menu
539  *
540  * Returns 0 when no key has been pressed or the value of the key pressed.
541  */
542 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
543 {
544     return( p_osd->p_state->b_update );
545 }
546
547 /**
548  * Set the key pressed to a value.
549  *
550  * Assign a new key value to the last key pressed on the OSD Menu.
551  */
552 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
553 {
554     vlc_value_t val;
555
556     val.i_int = i_value;
557     var_Set( p_this, "key-pressed", val );
558 }
559
560 /**
561  * Update the OSD Menu visibility flag.
562  *
563  * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu
564  * should not be shown.
565  */
566 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
567 {
568     vlc_value_t val;
569
570     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
571     var_Set( p_osd, "osd-menu-visible", val );
572 }
573
574 /**
575  * Update the OSD Menu update flag
576  *
577  * If the OSD Menu should be updated then set the update flag to
578  * VLC_TRUE, else to VLC_FALSE.
579  */
580 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
581 {
582     vlc_value_t val;
583
584     val.b_bool = p_osd->p_state->b_update = b_value;
585     var_Set( p_osd, "osd-menu-update", val );
586 }
587
588 /**
589  * Textual feedback
590  *
591  * Functions that provide the textual feedback on the OSD. They are shown
592  * on hotkey commands. The feedback is also part of the osd_button_t
593  * object. The types are declared in the include file include/vlc_osd.h
594  * @see vlc_osd.h
595  */
596 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
597 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
598 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) );
599
600 /**
601  * Default feedback images
602  *
603  * Functions that provide the default OSD feedback images on hotkey
604  * commands. These feedback images are also part of the osd_button_t
605  * object. The types are declared in the include file include/vlc_osd.h
606  * @see vlc_osd.h
607  */
608 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
609 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
610
611 /** @} */
612
613 /**********************************************************************
614  * Vout text and widget overlays
615  **********************************************************************/
616
617 /**
618  * Show text on the video for some time
619  * \param p_vout pointer to the vout the text is to be showed on
620  * \param i_channel Subpicture channel
621  * \param psz_string The text to be shown
622  * \param p_style Pointer to a struct with text style info
623  * \param i_flags flags for alignment and such
624  * \param i_hmargin horizontal margin in pixels
625  * \param i_vmargin vertical margin in pixels
626  * \param i_duration Amount of time the text is to be shown.
627  */
628 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
629
630 /**
631  * Show text on the video from a given start date to a given end date
632  * \param p_vout pointer to the vout the text is to be showed on
633  * \param i_channel Subpicture channel
634  * \param psz_string The text to be shown
635  * \param p_style Pointer to a struct with text style info
636  * \param i_flags flags for alignment and such
637  * \param i_hmargin horizontal margin in pixels
638  * \param i_vmargin vertical margin in pixels
639  * \param i_start the time when this string is to appear on the video
640  * \param i_stop the time when this string should stop to be displayed
641  *               if this is 0 the string will be shown untill the next string
642  *               is about to be shown
643  */
644 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
645
646 /**
647  * Write an informative message at the default location,
648  * for the default duration and only if the OSD option is enabled.
649  * \param p_caller The object that called the function.
650  * \param i_channel Subpicture channel
651  * \param psz_format printf style formatting
652  **/
653 VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) );
654
655 /**
656  * Same as __vlc_OSDMessage() but with automatic casting
657  */
658 #if defined(HAVE_VARIADIC_MACROS)
659 #    define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args )
660 #else
661 #    define vout_OSDMessage __vout_OSDMessage
662 #endif
663
664 /**
665  * Display a slider on the video output.
666  * \param p_this    The object that called the function.
667  * \param i_channel Subpicture channel
668  * \param i_postion Current position in the slider
669  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
670  * @see vlc_osd.h
671  */
672 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
673
674 /**
675  * Display an Icon on the video output.
676  * \param p_this    The object that called the function.
677  * \param i_channel Subpicture channel
678  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
679  * @see vlc_osd.h
680  */
681 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
682
683 # ifdef __cplusplus
684 }
685 # endif
686
687 #endif /* _VLC_OSD_H */