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