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