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