]> git.sesse.net Git - vlc/blob - include/vlc_osd.h
Splitted out text_style_t and related function to its own header.
[vlc] / 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 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 );
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 render_subtitle_date, 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, mtime_t render_subtitle_date ) );
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 #define OSD_HOR_SLIDER 1
211 #define OSD_VERT_SLIDER 2
212
213 #define OSD_PLAY_ICON 1
214 #define OSD_PAUSE_ICON 2
215 #define OSD_SPEAKER_ICON 3
216 #define OSD_MUTE_ICON 4
217
218 /**
219  * OSD menu button states
220  *
221  * Every button has three states, either it is unselected, selected or pressed.
222  * An OSD menu skin can associate images with each state.
223  *
224  *  OSD_BUTTON_UNSELECT 0
225  *  OSD_BUTTON_SELECT   1
226  *  OSD_BUTTON_PRESSED  2
227  */
228 #define OSD_BUTTON_UNSELECT 0
229 #define OSD_BUTTON_SELECT   1
230 #define OSD_BUTTON_PRESSED  2
231
232 /**
233  * OSD State object
234  *
235  * The OSD state object holds the state and associated images for a
236  * particular state on the screen. The picture is displayed when this
237  * state is the active state.
238  */
239 struct osd_state_t
240 {
241     osd_state_t *p_next;    /*< pointer to next state */
242     osd_state_t *p_prev;    /*< pointer to previous state */
243     picture_t   *p_pic;     /*< picture of state */
244
245     char        *psz_state; /*< state name */
246     int          i_state;   /*< state index */
247
248     int     i_x;            /*< x-position of button state image */
249     int     i_y;            /*< y-position of button state image */
250     int     i_width;        /*< width of button state image */
251     int     i_height;       /*< height of button state image */
252 };
253
254 /**
255  * OSD Button object
256  *
257  * An OSD Button has different states. Each state has an image for display.
258  */
259 struct osd_button_t
260 {
261     osd_button_t *p_next;   /*< pointer to next button */
262     osd_button_t *p_prev;   /*< pointer to previous button */
263     osd_button_t *p_up;     /*< pointer to up button */
264     osd_button_t *p_down;   /*< pointer to down button */
265
266     osd_state_t *p_current_state; /*< pointer to current state image */
267     osd_state_t *p_states; /*< doubly linked list of states */
268     picture_t   *p_feedback; /*< feedback picture */
269
270     char    *psz_name;     /*< name of button */
271
272     /* These member should probably be a struct hotkey */
273     char    *psz_action;      /*< hotkey action name on button*/
274     char    *psz_action_down; /*< hotkey action name on range buttons
275                                   for command "menu down" */
276     /* end of hotkey specifics */
277
278     int     i_x;            /*< x-position of button visible state image */
279     int     i_y;            /*< y-position of button visible state image */
280     int     i_width;        /*< width of button visible state image */
281     int     i_height;       /*< height of button visible state image */
282
283     /* range style button */
284     bool   b_range;    /*< button should be interpreted as range */
285     int          i_ranges;   /*< number of states */
286 };
287
288 /**
289  * OSD Menu Style
290  *
291  * The images that make up an OSD menu can be created in such away that
292  * they contain all buttons in the same picture, with the selected one
293  * highlighted or being a concatenation of all the seperate images. The
294  * first case is the default.
295  *
296  * To change the default style the keyword 'style' should be set to 'concat'.
297  */
298
299 #define OSD_MENU_STYLE_SIMPLE 0x0
300 #define OSD_MENU_STYLE_CONCAT 0x1
301
302 /**
303  * OSD Menu State object
304  *
305  * Represents the current state as displayed.
306  */
307 /* Represent the menu state */
308 struct osd_menu_state_t
309 {
310     int     i_x;        /*< x position of spu region */
311     int     i_y;        /*< y position of spu region */
312     int     i_width;    /*< width of spu region */
313     int     i_height;   /*< height of spu region */
314
315     picture_t    *p_pic;  /*< pointer to picture to display */
316     osd_button_t *p_visible; /*< shortcut to visible button */
317
318     bool b_menu_visible; /*< menu currently visible? */
319     bool b_update;       /*< update OSD Menu when true */
320
321     /* quick hack to volume state. */
322     osd_button_t *p_volume; /*< pointer to volume range object. */
323 };
324
325 /**
326  * OSD Menu object
327  *
328  * The main OSD Menu object, which holds a linked list to all buttons
329  * and images that defines the menu. The p_state variable represents the
330  * current state of the OSD Menu.
331  */
332 struct osd_menu_t
333 {
334     VLC_COMMON_MEMBERS
335
336     int     i_x;        /*< x-position of OSD Menu on the video screen */
337     int     i_y;        /*< y-position of OSD Menu on the video screen */
338     int     i_width;    /*< width of OSD Menu on the video screen */
339     int     i_height;   /*< height of OSD Menu on the video screen */
340     int     i_style;    /*< style of spu region generation */
341     int     i_position; /*< display position */
342
343     char             *psz_path;  /*< directory where OSD menu images are stored */
344     osd_button_t     *p_button;  /*< doubly linked list of buttons */
345     osd_menu_state_t *p_state;   /*< current state of OSD menu */
346
347     /* quick link in the linked list. */
348     osd_button_t  *p_last_button; /*< pointer to last button in the list */
349
350     /* misc parser */
351     module_t        *p_parser;  /*< pointer to parser module */
352     char            *psz_file;  /*< Config file name */
353     image_handler_t *p_image;   /*< handler to image loading and conversion libraries */
354 };
355
356 /**
357  * Initialize an osd_menu_t object
358  *
359  * This functions has to be called before any call to other osd_menu_t*
360  * functions. It creates the osd_menu object and holds a pointer to it
361  * during its lifetime.
362  */
363 VLC_EXPORT( osd_menu_t *, osd_MenuCreate, ( vlc_object_t *, const char * ) );
364
365 /**
366  * Delete the osd_menu_t object
367  *
368  * This functions has to be called to release the associated module and
369  * memory for the osdmenu. After return of this function the pointer to
370  * osd_menu_t* is invalid.
371  */
372 VLC_EXPORT( void, osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
373
374 #define osd_MenuCreate(object,file) osd_MenuCreate( VLC_OBJECT(object), file )
375 #define osd_MenuDelete(object,osd)  osd_MenuDelete( VLC_OBJECT(object), osd )
376
377 /**
378  * Find OSD Menu button at position x,y
379  */
380 VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this,
381      int, int, int, int, int, int ) );
382
383 #define osd_ButtonFind(object,x,y,h,w,sh,sw)  osd_ButtonFind(object,x,y,h,w,sh,sw)
384
385 /**
386  * Select the button provided as the new active button
387  */
388 VLC_EXPORT( void, osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
389
390 #define osd_ButtonSelect(object,button) osd_ButtonSelect(object,button)
391
392 /**
393  * Show the OSD menu.
394  *
395  * Show the OSD menu on the video output or mux it into the stream.
396  * Every change to the OSD menu will now be visible in the output. An output
397  * can be a video output window or a stream (\see stream output)
398  */
399 VLC_EXPORT( void, osd_MenuShow, ( vlc_object_t * ) );
400
401 /**
402  * Hide the OSD menu.
403  *
404  * Stop showing the OSD menu on the video output or mux it into the stream.
405  */
406 VLC_EXPORT( void, osd_MenuHide, ( vlc_object_t * ) );
407
408 /**
409  * Activate the action of this OSD menu item.
410  *
411  * The rc interface command "menu select" triggers the sending of an
412  * hotkey action to the hotkey interface. The hotkey that belongs to
413  * the current highlighted OSD menu item will be used.
414  */
415 VLC_EXPORT( void, osd_MenuActivate,   ( vlc_object_t * ) );
416
417 #define osd_MenuShow(object) osd_MenuShow( VLC_OBJECT(object) )
418 #define osd_MenuHide(object) osd_MenuHide( VLC_OBJECT(object) )
419 #define osd_MenuActivate(object)   osd_MenuActivate( VLC_OBJECT(object) )
420
421 /**
422  * Next OSD menu item
423  *
424  * Select the next OSD menu item to be highlighted.
425  * Note: The actual position on screen of the menu item is determined by
426  * the OSD menu configuration file.
427  */
428 VLC_EXPORT( void, osd_MenuNext, ( vlc_object_t * ) );
429
430 /**
431  * Previous OSD menu item
432  *
433  * Select the previous OSD menu item to be highlighted.
434  * Note: The actual position on screen of the menu item is determined by
435  * the OSD menu configuration file.
436  */
437 VLC_EXPORT( void, osd_MenuPrev, ( vlc_object_t * ) );
438
439 /**
440  * OSD menu item above
441  *
442  * Select the OSD menu item above the current item to be highlighted.
443  * Note: The actual position on screen of the menu item is determined by
444  * the OSD menu configuration file.
445  */
446 VLC_EXPORT( void, osd_MenuUp,   ( vlc_object_t * ) );
447
448 /**
449  * OSD menu item below
450  *
451  * Select the next OSD menu item below the current item to be highlighted.
452  * Note: The actual position on screen of the menu item is determined by
453  * the OSD menu configuration file.
454  */
455 VLC_EXPORT( void, osd_MenuDown, ( vlc_object_t * ) );
456
457 #define osd_MenuNext(object) osd_MenuNext( VLC_OBJECT(object) )
458 #define osd_MenuPrev(object) osd_MenuPrev( VLC_OBJECT(object) )
459 #define osd_MenuUp(object)   osd_MenuUp( VLC_OBJECT(object) )
460 #define osd_MenuDown(object) osd_MenuDown( VLC_OBJECT(object) )
461
462 /**
463  * Display the audio volume bitmap.
464  *
465  * Display the correct audio volume bitmap that corresponds to the
466  * current Audio Volume setting.
467  */
468 VLC_EXPORT( void, osd_Volume, ( vlc_object_t * ) );
469
470 #define osd_Volume(object)     osd_Volume( VLC_OBJECT(object) )
471
472 /**
473  * Retrieve a non modifyable pointer to the OSD Menu state
474  *
475  */
476 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
477 {
478     return( p_osd->p_state );
479 }
480
481 /**
482  * Get the last key press received by the OSD Menu
483  *
484  * Returns 0 when no key has been pressed or the value of the key pressed.
485  */
486 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
487 {
488     return( p_osd->p_state->b_update );
489 }
490
491 /**
492  * Set the key pressed to a value.
493  *
494  * Assign a new key value to the last key pressed on the OSD Menu.
495  */
496 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
497 {
498     vlc_value_t val;
499
500     val.i_int = i_value;
501     var_Set( p_this, "key-pressed", val );
502 }
503
504 /**
505  * Update the OSD Menu visibility flag.
506  *
507  * true means OSD Menu should be shown. false means OSD Menu
508  * should not be shown.
509  */
510 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
511 {
512     vlc_value_t val;
513
514     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
515     var_Set( p_osd, "osd-menu-visible", val );
516 }
517
518 /**
519  * Update the OSD Menu update flag
520  *
521  * If the OSD Menu should be updated then set the update flag to
522  * true, else to false.
523  */
524 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
525 {
526     vlc_value_t val;
527
528     val.b_bool = p_osd->p_state->b_update = b_value;
529     var_Set( p_osd, "osd-menu-update", val );
530 }
531
532 /**
533  * Textual feedback
534  *
535  * Functions that provide the textual feedback on the OSD. They are shown
536  * on hotkey commands. The feedback is also part of the osd_button_t
537  * object. The types are declared in the include file include/vlc_osd.h
538  * @see vlc_osd.h
539  */
540 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t ) );
541 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
542 VLC_EXPORT( void, osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
543
544 /**
545  * Default feedback images
546  *
547  * Functions that provide the default OSD feedback images on hotkey
548  * commands. These feedback images are also part of the osd_button_t
549  * object. The types are declared in the include file include/vlc_osd.h
550  * @see vlc_osd.h
551  */
552 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
553 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
554
555 /** @} */
556
557 /**********************************************************************
558  * Vout text and widget overlays
559  **********************************************************************/
560 VLC_EXPORT( int, vout_OSDEpg, ( vout_thread_t *, input_item_t * ) );
561
562 /**
563  * Write an informative message at the default location,
564  * for the default duration and only if the OSD option is enabled.
565  * \param p_caller The object that called the function.
566  * \param i_channel Subpicture channel
567  * \param psz_format printf style formatting
568  **/
569 VLC_EXPORT( void,  vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
570
571 #define vout_OSDMessage( obj, chan, ...) \
572         vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
573
574 /**
575  * Display a slider on the video output.
576  * \param p_this    The object that called the function.
577  * \param i_channel Subpicture channel
578  * \param i_postion Current position in the slider
579  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
580  * @see vlc_osd.h
581  */
582 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
583
584 /**
585  * Display an Icon on the video output.
586  * \param p_this    The object that called the function.
587  * \param i_channel Subpicture channel
588  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
589  * @see vlc_osd.h
590  */
591 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
592
593 # ifdef __cplusplus
594 }
595 # endif
596
597 #endif /* _VLC_OSD_H */