LGPL
[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 VLC authors and VideoLAN
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 VLC authors and VideoLAN
13  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
14  *
15  * This program is free software; you can redistribute it and/or modify it
16  * under the terms of the GNU Lesser General Public License as published by
17  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public License
26  * along with this program; if not, write to the Free Software Foundation,
27  * 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 #include <vlc_spu.h>
35 #include <vlc_vout_osd.h>
36
37 # ifdef __cplusplus
38 extern "C" {
39 # endif
40
41 /**
42  * \file
43  * This file defines SPU subpicture and OSD functions and object types.
44  */
45
46 /**********************************************************************
47  * OSD Menu
48  **********************************************************************/
49 /**
50  * \defgroup osdmenu OSD Menu
51  * The OSD menu core creates the OSD menu structure in memory. It parses a
52  * configuration file that defines all elements that are part of the menu. The
53  * core also handles all actions and menu structure updates on behalf of video
54  * subpicture sources.
55  *
56  * The file modules/video_filters/osdmenu.c implements a subpicture source that
57  * specifies the final information on positioning of the current state image.
58  * A subpicture source is called each time a video picture has to be rendered,
59  * it also gives a start and end date to the subpicture. The subpicture can be
60  * streamed if used inside a transcoding command. For example:
61  *
62  *  vlc dvdsimple:///dev/dvd --extraintf rc
63  *  --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
64  *  --osdmenu-file=share/osdmenu/dvd.cfg
65  *
66  * An example for local usage of the OSD menu is:
67  *
68  *  vlc dvdsimple:///dev/dvd --extraintf rc
69  *  --sub-source osdmenu
70  *  --osdmenu-file=share/osdmenu/dvd.cfg
71  *
72  * Each OSD menu element, called "action", defines a hotkey action. Each action
73  * can have several states (unselect, select, pressed). Each state has an image
74  * that represents the state visually. The commands "menu right", "menu left",
75  * "menu up" and "menu down" are used to navigate through the OSD menu structure.
76  * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
77  * show and hide the OSD menu subpictures.
78  *
79  * There is one special element called "range". A range is an arbritary range
80  * of state images that can be browsed using "menu up" and "menu down" commands
81  * on the rc interface.
82  *
83  * The OSD menu configuration file uses a very simple syntax and basic parser.
84  * A configuration file has the ".cfg".
85  * An example is "share/osdmenu/dvd256.cfg".
86  * @{
87  */
88
89 /**
90  * \brief The OSD Menu configuration file format.
91  *
92  * The configuration file syntax is very basic and so is its parser. See the
93  * BNF formal representation below:
94  *
95  * The keywords FILENAME and PATHNAME represent the filename and pathname
96  * specification that is valid for the Operating System VLC is compiled for.
97  *
98  * The hotkey actions that are supported by VLC are documented in the file
99  * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
100  *
101  * CONFIG_FILE = FILENAME '.cfg'
102  * WS = [ ' ' | '\t' ]+
103  * OSDMENU_PATH = PATHNAME
104  * DIR = 'dir' WS OSDMENU_PATH '\n'
105  * STYLE = 'style' [ 'default' | 'concat' ] '\n'
106  * STATE = [ 'unselect' | 'select' | 'pressed' ]
107  * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
108  *
109  * ACTION_TYPE        = 'type' 'volume' '\n'
110  * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
111  * ACTION_BLOCK_END   = 'end' '\n'
112  * ACTION_STATE       = STATE WS FILENAME '\n'
113  * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
114  * ACTION_RANGE_END   = 'end' '\n'
115  * ACTION_RANGE_STATE = FILENAME '\n'
116  *
117  * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
118  * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
119  * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
120  *
121  */
122
123 /**
124  * OSD menu button states
125  *
126  * Every button has three states, either it is unselected, selected or pressed.
127  * An OSD menu skin can associate images with each state.
128  *
129  *  OSD_BUTTON_UNSELECT 0
130  *  OSD_BUTTON_SELECT   1
131  *  OSD_BUTTON_PRESSED  2
132  */
133 #define OSD_BUTTON_UNSELECT 0
134 #define OSD_BUTTON_SELECT   1
135 #define OSD_BUTTON_PRESSED  2
136
137 /**
138  * OSD State object
139  *
140  * The OSD state object holds the state and associated images for a
141  * particular state on the screen. The picture is displayed when this
142  * state is the active state.
143  */
144 struct osd_state_t
145 {
146     osd_state_t *p_next;    /*< pointer to next state */
147     osd_state_t *p_prev;    /*< pointer to previous state */
148     picture_t   *p_pic;     /*< picture of state */
149
150     char        *psz_state; /*< state name */
151     int          i_state;   /*< state index */
152
153     int     i_x;            /*< x-position of button state image */
154     int     i_y;            /*< y-position of button state image */
155     int     i_width;        /*< width of button state image */
156     int     i_height;       /*< height of button state image */
157 };
158
159 /**
160  * OSD Button object
161  *
162  * An OSD Button has different states. Each state has an image for display.
163  */
164 struct osd_button_t
165 {
166     osd_button_t *p_next;   /*< pointer to next button */
167     osd_button_t *p_prev;   /*< pointer to previous button */
168     osd_button_t *p_up;     /*< pointer to up button */
169     osd_button_t *p_down;   /*< pointer to down button */
170
171     osd_state_t *p_current_state; /*< pointer to current state image */
172     osd_state_t *p_states; /*< doubly linked list of states */
173
174     char    *psz_name;     /*< name of button */
175
176     /* These member should probably be a struct hotkey */
177     char    *psz_action;      /*< hotkey action name on button*/
178     char    *psz_action_down; /*< hotkey action name on range buttons
179                                   for command "menu down" */
180     /* end of hotkey specifics */
181
182     int     i_x;            /*< x-position of button visible state image */
183     int     i_y;            /*< y-position of button visible state image */
184     int     i_width;        /*< width of button visible state image */
185     int     i_height;       /*< height of button visible state image */
186
187     /* range style button */
188     bool   b_range;    /*< button should be interpreted as range */
189     int          i_ranges;   /*< number of states */
190 };
191
192 /**
193  * OSD Menu Style
194  *
195  * The images that make up an OSD menu can be created in such away that
196  * they contain all buttons in the same picture, with the selected one
197  * highlighted or being a concatenation of all the separate images. The
198  * first case is the default.
199  *
200  * To change the default style the keyword 'style' should be set to 'concat'.
201  */
202
203 #define OSD_MENU_STYLE_SIMPLE 0x0
204 #define OSD_MENU_STYLE_CONCAT 0x1
205
206 /**
207  * OSD Menu State object
208  *
209  * Represents the current state as displayed.
210  */
211 /* Represent the menu state */
212 struct osd_menu_state_t
213 {
214     int     i_x;        /*< x position of spu region */
215     int     i_y;        /*< y position of spu region */
216     int     i_width;    /*< width of spu region */
217     int     i_height;   /*< height of spu region */
218
219     picture_t    *p_pic;  /*< pointer to picture to display */
220     osd_button_t *p_visible; /*< shortcut to visible button */
221
222     bool b_menu_visible; /*< menu currently visible? */
223     bool b_update;       /*< update OSD Menu when true */
224
225     /* quick hack to volume state. */
226     osd_button_t *p_volume; /*< pointer to volume range object. */
227 };
228
229 /**
230  * OSD Menu object
231  *
232  * The main OSD Menu object, which holds a linked list to all buttons
233  * and images that defines the menu. The p_state variable represents the
234  * current state of the OSD Menu.
235  */
236 struct osd_menu_t
237 {
238     VLC_COMMON_MEMBERS
239
240     int     i_x;        /*< x-position of OSD Menu on the video screen */
241     int     i_y;        /*< y-position of OSD Menu on the video screen */
242     int     i_width;    /*< width of OSD Menu on the video screen */
243     int     i_height;   /*< height of OSD Menu on the video screen */
244     int     i_style;    /*< style of spu region generation */
245     int     i_position; /*< display position */
246
247     char             *psz_path;  /*< directory where OSD menu images are stored */
248     osd_button_t     *p_button;  /*< doubly linked list of buttons */
249     osd_menu_state_t *p_state;   /*< current state of OSD menu */
250
251     /* quick link in the linked list. */
252     osd_button_t  *p_last_button; /*< pointer to last button in the list */
253
254     /* misc parser */
255     module_t        *p_parser;  /*< pointer to parser module */
256     char            *psz_file;  /*< Config file name */
257     image_handler_t *p_image;   /*< handler to image loading and conversion libraries */
258 };
259
260 /**
261  * Initialize an osd_menu_t object
262  *
263  * This functions has to be called before any call to other osd_menu_t*
264  * functions. It creates the osd_menu object and holds a pointer to it
265  * during its lifetime.
266  */
267 VLC_API osd_menu_t * osd_MenuCreate( vlc_object_t *, const char * ) VLC_USED;
268
269 /**
270  * Delete the osd_menu_t object
271  *
272  * This functions has to be called to release the associated module and
273  * memory for the osdmenu. After return of this function the pointer to
274  * osd_menu_t* is invalid.
275  */
276 VLC_API void osd_MenuDelete( vlc_object_t *, osd_menu_t * );
277
278 #define osd_MenuCreate(object,file) osd_MenuCreate( VLC_OBJECT(object), file )
279 #define osd_MenuDelete(object,osd)  osd_MenuDelete( VLC_OBJECT(object), osd )
280
281 /**
282  * Find OSD Menu button at position x,y
283  */
284 VLC_API osd_button_t *osd_ButtonFind( vlc_object_t *p_this,
285      int, int, int, int, int, int ) VLC_USED;
286
287 #define osd_ButtonFind(object,x,y,h,w,sh,sw)  osd_ButtonFind(object,x,y,h,w,sh,sw)
288
289 /**
290  * Select the button provided as the new active button
291  */
292 VLC_API void osd_ButtonSelect( vlc_object_t *, osd_button_t *);
293
294 #define osd_ButtonSelect(object,button) osd_ButtonSelect(object,button)
295
296 /**
297  * Show the OSD menu.
298  *
299  * Show the OSD menu on the video output or mux it into the stream.
300  * Every change to the OSD menu will now be visible in the output. An output
301  * can be a video output window or a stream (\see stream output)
302  */
303 VLC_API void osd_MenuShow( vlc_object_t * );
304
305 /**
306  * Hide the OSD menu.
307  *
308  * Stop showing the OSD menu on the video output or mux it into the stream.
309  */
310 VLC_API void osd_MenuHide( vlc_object_t * );
311
312 /**
313  * Activate the action of this OSD menu item.
314  *
315  * The rc interface command "menu select" triggers the sending of an
316  * hotkey action to the hotkey interface. The hotkey that belongs to
317  * the current highlighted OSD menu item will be used.
318  */
319 VLC_API void osd_MenuActivate( vlc_object_t * );
320
321 #define osd_MenuShow(object) osd_MenuShow( VLC_OBJECT(object) )
322 #define osd_MenuHide(object) osd_MenuHide( VLC_OBJECT(object) )
323 #define osd_MenuActivate(object)   osd_MenuActivate( VLC_OBJECT(object) )
324
325 /**
326  * Next OSD menu item
327  *
328  * Select the next OSD menu item to be highlighted.
329  * Note: The actual position on screen of the menu item is determined by
330  * the OSD menu configuration file.
331  */
332 VLC_API void osd_MenuNext( vlc_object_t * );
333
334 /**
335  * Previous OSD menu item
336  *
337  * Select the previous OSD menu item to be highlighted.
338  * Note: The actual position on screen of the menu item is determined by
339  * the OSD menu configuration file.
340  */
341 VLC_API void osd_MenuPrev( vlc_object_t * );
342
343 /**
344  * OSD menu item above
345  *
346  * Select the OSD menu item above the current item to be highlighted.
347  * Note: The actual position on screen of the menu item is determined by
348  * the OSD menu configuration file.
349  */
350 VLC_API void osd_MenuUp( vlc_object_t * );
351
352 /**
353  * OSD menu item below
354  *
355  * Select the next OSD menu item below the current item to be highlighted.
356  * Note: The actual position on screen of the menu item is determined by
357  * the OSD menu configuration file.
358  */
359 VLC_API void osd_MenuDown( vlc_object_t * );
360
361 #define osd_MenuNext(object) osd_MenuNext( VLC_OBJECT(object) )
362 #define osd_MenuPrev(object) osd_MenuPrev( VLC_OBJECT(object) )
363 #define osd_MenuUp(object)   osd_MenuUp( VLC_OBJECT(object) )
364 #define osd_MenuDown(object) osd_MenuDown( VLC_OBJECT(object) )
365
366 /**
367  * Display the audio volume bitmap.
368  *
369  * Display the correct audio volume bitmap that corresponds to the
370  * current Audio Volume setting.
371  */
372 VLC_API void osd_Volume( vlc_object_t * );
373
374 #define osd_Volume(object)     osd_Volume( VLC_OBJECT(object) )
375
376 /**
377  * Retrieve a non modifyable pointer to the OSD Menu state
378  *
379  */
380 VLC_USED
381 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
382 {
383     return( p_osd->p_state );
384 }
385
386 /**
387  * Get the last key press received by the OSD Menu
388  *
389  * Returns 0 when no key has been pressed or the value of the key pressed.
390  */
391 VLC_USED
392 static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
393 {
394     return( p_osd->p_state->b_update );
395 }
396
397 /**
398  * Set the key pressed to a value.
399  *
400  * Assign a new key value to the last key pressed on the OSD Menu.
401  */
402 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
403 {
404     vlc_value_t val;
405
406     val.i_int = i_value;
407     var_Set( p_this, "key-pressed", val );
408 }
409
410 /**
411  * Update the OSD Menu visibility flag.
412  *
413  * true means OSD Menu should be shown. false means OSD Menu
414  * should not be shown.
415  */
416 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
417 {
418     vlc_value_t val;
419
420     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
421     var_Set( p_osd, "osd-menu-visible", val );
422 }
423
424 /**
425  * Update the OSD Menu update flag
426  *
427  * If the OSD Menu should be updated then set the update flag to
428  * true, else to false.
429  */
430 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
431 {
432     vlc_value_t val;
433
434     val.b_bool = p_osd->p_state->b_update = b_value;
435     var_Set( p_osd, "osd-menu-update", val );
436 }
437
438 /**
439  * Textual feedback
440  *
441  * Functions that provide the textual feedback on the OSD. They are shown
442  * on hotkey commands. The feedback is also part of the osd_button_t
443  * object. The types are declared in the include file include/vlc_osd.h
444  * @see vlc_osd.h
445  */
446 VLC_API int osd_ShowTextRelative( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t );
447 VLC_API int osd_ShowTextAbsolute( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t );
448 VLC_API void osd_Message( spu_t *, int, char *, ... ) VLC_FORMAT( 3, 4 );
449
450 /** @} */
451
452 # ifdef __cplusplus
453 }
454 # endif
455
456 #endif /* _VLC_OSD_H */