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