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