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