git.sesse.net Git - vlc/blob - include/vlc_vout_osd.h

   1 /*****************************************************************************
   2  * vlc_vout_osd.h: vout OSD
   3  *****************************************************************************
   4  * Copyright (C) 1999-2010 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  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef VLC_VOUT_OSD_H
  27 #define VLC_VOUT_OSD_H 1
  28
  29 #include <vlc_spu.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /**
  36  * OSD menu position and picture type defines
  37  */
  38 #define OSD_HOR_SLIDER 1
  39 #define OSD_VERT_SLIDER 2
  40
  41 #define OSD_PLAY_ICON 1
  42 #define OSD_PAUSE_ICON 2
  43 #define OSD_SPEAKER_ICON 3
  44 #define OSD_MUTE_ICON 4
  45
  46 /**********************************************************************
  47  * Vout text and widget overlays
  48  **********************************************************************/
  49 VLC_EXPORT( int, vout_OSDEpg, ( vout_thread_t *, input_item_t * ) );
  50
  51 /**
  52  * \brief Write an informative message if the OSD option is enabled.
  53  * \param vout The vout on which the message will be displayed
  54  * \param channel Subpicture channel
  55  * \param position Position of the text
  56  * \param duration Duration of the text being displayed
  57  * \param text Text to be displayed
  58  */
  59 VLC_EXPORT( void,  vout_OSDText, ( vout_thread_t *vout, int channel, int position, mtime_t duration, const char *text ) );
  60
  61 /**
  62  * \brief Write an informative message at the default location,
  63  *        for the default duration and only if the OSD option is enabled.
  64  * \param vout The vout on which the message will be displayed
  65  * \param channel Subpicture channel
  66  * \param format printf style formatting
  67  *
  68  * Provided for convenience.
  69  */
  70 VLC_EXPORT( void,  vout_OSDMessage, ( vout_thread_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
  71
  72 /**
  73  * Display a slider on the video output.
  74  * \param p_this    The object that called the function.
  75  * \param i_channel Subpicture channel
  76  * \param i_postion Current position in the slider
  77  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
  78  */
  79 VLC_EXPORT( void, vout_OSDSlider, ( vout_thread_t *, int, int , short ) );
  80
  81 /**
  82  * Display an Icon on the video output.
  83  * \param p_this    The object that called the function.
  84  * \param i_channel Subpicture channel
  85  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
  86  */
  87 VLC_EXPORT( void, vout_OSDIcon, ( vout_thread_t *, int, short ) );
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif /* VLC_VOUT_OSD_H */
  94