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_outline_width;   /**< The width of the outline in pixels */
 253     int        i_shadow_width;    /**< The width of the shadow in pixels */
 254     int        i_spacing;         /**< The spaceing between glyphs in pixels */
 255     int        i_text_align;      /**< An alignment hint for the text */
 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, 1, 0, -1, 0 };
 269
 270
 271
 272 /**
 273  * OSD menu button states
 274  *
 275  * Every button has three states, either it is unselected, selected or pressed.
 276  * An OSD menu skin can associate images with each state.
 277  *
 278  *  OSD_BUTTON_UNSELECT 0
 279  *  OSD_BUTTON_SELECT   1
 280  *  OSD_BUTTON_PRESSED  2
 281  */
 282 #define OSD_BUTTON_UNSELECT 0
 283 #define OSD_BUTTON_SELECT   1
 284 #define OSD_BUTTON_PRESSED  2
 285
 286 /**
 287  * OSD State object
 288  *
 289  * The OSD state object holds the state and associated images for a
 290  * particular state on the screen. The picture is displayed when this
 291  * state is the active state.
 292  */
 293 struct osd_state_t
 294 {
 295     osd_state_t *p_next;    /*< pointer to next state */
 296     osd_state_t *p_prev;    /*< pointer to previous state */
 297     picture_t   *p_pic;     /*< picture of state */
 298
 299     char        *psz_state; /*< state name */
 300     int          i_state;   /*< state index */
 301 };
 302
 303 /**
 304  * OSD Button object
 305  *
 306  * An OSD Button has different states. Each state has an image for display.
 307  */
 308 struct osd_button_t
 309 {
 310     osd_button_t *p_next;   /*< pointer to next button */
 311     osd_button_t *p_prev;   /*< pointer to previous button */
 312     osd_button_t *p_up;     /*< pointer to up button */
 313     osd_button_t *p_down;   /*< pointer to down button */
 314
 315     osd_state_t *p_current_state; /*< pointer to current state image */
 316     osd_state_t *p_states; /*< doubly linked list of states */
 317     picture_t   *p_feedback; /*< feedback picture */
 318
 319     char    *psz_name;     /*< name of button */
 320
 321     /* These member should probably be a struct hotkey */
 322     char    *psz_action;      /*< hotkey action name on button*/
 323     char    *psz_action_down; /*< hotkey action name on range buttons
 324                                   for command "menu down" */
 325     /* end of hotkey specifics */
 326
 327     int     i_x;            /*< x-position of button visible state image */
 328     int     i_y;            /*< y-position of button visible state image */
 329
 330     /* range style button */
 331     vlc_bool_t   b_range;    /*< button should be interpreted as range */
 332     int          i_ranges;   /*< number of states */
 333 };
 334
 335 /**
 336  * OSD Menu Style
 337  *
 338  * The images that make up an OSD menu can be created in such away that
 339  * they contain all buttons in the same picture, with the selected one
 340  * highlighted or being a concatenation of all the seperate images. The
 341  * first case is the default.
 342  *
 343  * To change the default style the keyword 'style' should be set to 'concat'.
 344  */
 345
 346 #define OSD_MENU_STYLE_SIMPLE 0x0
 347 #define OSD_MENU_STYLE_CONCAT 0x1
 348
 349 /**
 350  * OSD Menu State object
 351  *
 352  * Represents the current state as displayed.
 353  */
 354 /* Represent the menu state */
 355 struct osd_menu_state_t
 356 {
 357     int     i_x;        /*< x position of spu region */
 358     int     i_y;        /*< y position of spu region */
 359     int     i_width;    /*< width of spu region */
 360     int     i_height;   /*< height of spu region */
 361
 362     picture_t    *p_pic;  /*< pointer to picture to display */
 363     osd_button_t *p_visible; /*< shortcut to visible button */
 364
 365     vlc_bool_t b_menu_visible; /*< menu currently visible? */
 366     vlc_bool_t b_update;       /*< update OSD Menu when VLC_TRUE */
 367
 368     /* quick hack to volume state. */
 369     osd_button_t *p_volume; /*< pointer to volume range object. */
 370 };
 371
 372 /**
 373  * OSD Menu object
 374  *
 375  * The main OSD Menu object, which holds a linked list to all buttons
 376  * and images that defines the menu. The p_state variable represents the
 377  * current state of the OSD Menu.
 378  */
 379 struct osd_menu_t
 380 {
 381     VLC_COMMON_MEMBERS
 382
 383     int     i_x;        /*< x-position of OSD Menu on the video screen */
 384     int     i_y;        /*< y-position of OSD Menu on the video screen */
 385     int     i_width;    /*< width of OSD Menu on the video screen */
 386     int     i_height;   /*< height of OSD Menu on the video screen */
 387     int     i_style;    /*< style of spu region generation */
 388
 389     char             *psz_path;  /*< directory where OSD menu images are stored */
 390     osd_button_t     *p_button;  /*< doubly linked list of buttons */
 391     osd_menu_state_t *p_state;   /*< current state of OSD menu */
 392
 393     /* quick link in the linked list. */
 394     osd_button_t  *p_last_button; /*< pointer to last button in the list */
 395 };
 396
 397 /**
 398  * Initialize an osd_menu_t object
 399  *
 400  * This functions has to be called before any call to other osd_menu_t*
 401  * functions. It creates the osd_menu object and holds a pointer to it
 402  * during its lifetime.
 403  */
 404 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
 405
 406 /**
 407  * Delete the osd_menu_t object
 408  *
 409  * This functions has to be called to release the associated module and
 410  * memory for the osdmenu. After return of this function the pointer to
 411  * osd_menu_t* is invalid.
 412  */
 413 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
 414
 415 /**
 416  * Change state on an osd_button_t.
 417  *
 418  * This function selects the specified state and returns a pointer to it. The
 419  * following states are currently supported:
 420  * \see OSD_BUTTON_UNSELECT
 421  * \see OSD_BUTTON_SELECT
 422  * \see OSD_BUTTON_PRESSED
 423  */
 424 VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
 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 #define osd_StateChange(object,value) __osd_StateChange( object, value )
 429
 430 /**
 431  * Show the OSD menu.
 432  *
 433  * Show the OSD menu on the video output or mux it into the stream.
 434  * Every change to the OSD menu will now be visible in the output. An output
 435  * can be a video output window or a stream (\see stream output)
 436  */
 437 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
 438
 439 /**
 440  * Hide the OSD menu.
 441  *
 442  * Stop showing the OSD menu on the video output or mux it into the stream.
 443  */
 444 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
 445
 446 /**
 447  * Activate the action of this OSD menu item.
 448  *
 449  * The rc interface command "menu select" triggers the sending of an
 450  * hotkey action to the hotkey interface. The hotkey that belongs to
 451  * the current highlighted OSD menu item will be used.
 452  */
 453 VLC_EXPORT( void, __osd_MenuActivate,   ( vlc_object_t * ) );
 454
 455 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
 456 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
 457 #define osd_MenuActivate(object)   __osd_MenuActivate( VLC_OBJECT(object) )
 458
 459 /**
 460  * Next OSD menu item
 461  *
 462  * Select the next OSD menu item to be highlighted.
 463  * Note: The actual position on screen of the menu item is determined by
 464  * the OSD menu configuration file.
 465  */
 466 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
 467
 468 /**
 469  * Previous OSD menu item
 470  *
 471  * Select the previous OSD menu item to be highlighted.
 472  * Note: The actual position on screen of the menu item is determined by
 473  * the OSD menu configuration file.
 474  */
 475 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
 476
 477 /**
 478  * OSD menu item above
 479  *
 480  * Select the OSD menu item above the current item to be highlighted.
 481  * Note: The actual position on screen of the menu item is determined by
 482  * the OSD menu configuration file.
 483  */
 484 VLC_EXPORT( void, __osd_MenuUp,   ( vlc_object_t * ) );
 485
 486 /**
 487  * OSD menu item below
 488  *
 489  * Select the next OSD menu item below the current item to be highlighted.
 490  * Note: The actual position on screen of the menu item is determined by
 491  * the OSD menu configuration file.
 492  */
 493 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
 494
 495 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
 496 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
 497 #define osd_MenuUp(object)   __osd_MenuUp( VLC_OBJECT(object) )
 498 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
 499
 500 /**
 501  * Display the audio volume bitmap.
 502  *
 503  * Display the correct audio volume bitmap that corresponds to the
 504  * current Audio Volume setting.
 505  */
 506 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
 507
 508 #define osd_Volume(object)     __osd_Volume( VLC_OBJECT(object) )
 509
 510 /**
 511  * Retrieve a non modifyable pointer to the OSD Menu state
 512  *
 513  */
 514 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
 515 {
 516     return( p_osd->p_state );
 517 }
 518
 519 /**
 520  * Get the last key press received by the OSD Menu
 521  *
 522  * Returns 0 when no key has been pressed or the value of the key pressed.
 523  */
 524 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
 525 {
 526     return( p_osd->p_state->b_update );
 527 }
 528
 529 /**
 530  * Set the key pressed to a value.
 531  *
 532  * Assign a new key value to the last key pressed on the OSD Menu.
 533  */
 534 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
 535 {
 536     vlc_value_t val;
 537
 538     val.i_int = i_value;
 539     var_Set( p_this, "key-pressed", val );
 540 }
 541
 542 /**
 543  * Update the OSD Menu visibility flag.
 544  *
 545  * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu
 546  * should not be shown.
 547  */
 548 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
 549 {
 550     vlc_value_t val;
 551
 552     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
 553     var_Set( p_osd, "osd-menu-visible", val );
 554 }
 555
 556 /**
 557  * Update the OSD Menu update flag
 558  *
 559  * If the OSD Menu should be updated then set the update flag to
 560  * VLC_TRUE, else to VLC_FALSE.
 561  */
 562 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
 563 {
 564     vlc_value_t val;
 565
 566     val.b_bool = p_osd->p_state->b_update = b_value;
 567     var_Set( p_osd, "osd-menu-update", val );
 568 }
 569
 570 /**
 571  * Textual feedback
 572  *
 573  * Functions that provide the textual feedback on the OSD. They are shown
 574  * on hotkey commands. The feedback is also part of the osd_button_t
 575  * object. The types are declared in the include file include/vlc_osd.h
 576  * @see vlc_osd.h
 577  */
 578 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
 579 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
 580 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
 581
 582 /**
 583  * Default feedback images
 584  *
 585  * Functions that provide the default OSD feedback images on hotkey
 586  * commands. These feedback images are also part of the osd_button_t
 587  * object. The types are declared in the include file include/vlc_osd.h
 588  * @see vlc_osd.h
 589  */
 590 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
 591 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
 592
 593 /**
 594  * Loading and parse the OSD Configuration file
 595  *
 596  * These functions load/unload the OSD menu configuration file and
 597  * create/destroy the themable OSD menu structure on the OSD object.
 598  */
 599 VLC_EXPORT( int,  osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );
 600 VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );
 601
 602 /** @} */
 603
 604 /**********************************************************************
 605  * Vout text and widget overlays
 606  **********************************************************************/
 607
 608 /**
 609  * Show text on the video for some time
 610  * \param p_vout pointer to the vout the text is to be showed on
 611  * \param i_channel Subpicture channel
 612  * \param psz_string The text to be shown
 613  * \param p_style Pointer to a struct with text style info
 614  * \param i_flags flags for alignment and such
 615  * \param i_hmargin horizontal margin in pixels
 616  * \param i_vmargin vertical margin in pixels
 617  * \param i_duration Amount of time the text is to be shown.
 618  */
 619 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
 620
 621 /**
 622  * Show text on the video from a given start date to a given end date
 623  * \param p_vout pointer to the vout the text is to be showed on
 624  * \param i_channel Subpicture channel
 625  * \param psz_string The text to be shown
 626  * \param p_style Pointer to a struct with text style info
 627  * \param i_flags flags for alignment and such
 628  * \param i_hmargin horizontal margin in pixels
 629  * \param i_vmargin vertical margin in pixels
 630  * \param i_start the time when this string is to appear on the video
 631  * \param i_stop the time when this string should stop to be displayed
 632  *               if this is 0 the string will be shown untill the next string
 633  *               is about to be shown
 634  */
 635 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
 636
 637 /**
 638  * Write an informative message at the default location,
 639  * for the default duration and only if the OSD option is enabled.
 640  * \param p_caller The object that called the function.
 641  * \param i_channel Subpicture channel
 642  * \param psz_format printf style formatting
 643  **/
 644 VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) );
 645
 646 /**
 647  * Same as __vlc_OSDMessage() but with automatic casting
 648  */
 649 #if defined(HAVE_VARIADIC_MACROS)
 650 #    define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args )
 651 #else
 652 #    define vout_OSDMessage __vout_OSDMessage
 653 #endif
 654
 655 /**
 656  * Display a slider on the video output.
 657  * \param p_this    The object that called the function.
 658  * \param i_channel Subpicture channel
 659  * \param i_postion Current position in the slider
 660  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
 661  * @see vlc_osd.h
 662  */
 663 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
 664
 665 /**
 666  * Display an Icon on the video output.
 667  * \param p_this    The object that called the function.
 668  * \param i_channel Subpicture channel
 669  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
 670  * @see vlc_osd.h
 671  */
 672 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
 673
 674 # ifdef __cplusplus
 675 }
 676 # endif
 677
 678 #endif /* _VLC_OSD_H */