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