include/vlc_vout_osd.h

   1 /*****************************************************************************
   2  * vlc_vout_osd.h: vout OSD
   3  *****************************************************************************
   4  * Copyright (C) 1999-2010 VLC authors and VideoLAN
   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 it
  12  * under the terms of the GNU Lesser General Public License as published by
  13  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * along with this program; if not, write to the Free Software Foundation,
  23  * 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 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /**
  34  * \defgroup osd On-screen display
  35  * \ingroup spu
  36  * @{
  37  * \file
  38  * Overlay text and widgets
  39  */
  40
  41 //* Default subpicture channel ID */
  42 #define SPU_DEFAULT_CHANNEL (1)
  43
  44 /**
  45  * OSD menu position and picture type defines
  46  */
  47 enum
  48 {
  49     /* Icons */
  50     OSD_PLAY_ICON = 1,
  51     OSD_PAUSE_ICON,
  52     OSD_SPEAKER_ICON,
  53     OSD_MUTE_ICON,
  54     /* Sliders */
  55     OSD_HOR_SLIDER,
  56     OSD_VERT_SLIDER,
  57 };
  58
  59 VLC_API int vout_OSDEpg( vout_thread_t *, input_item_t * );
  60
  61 /**
  62  * \brief Write an informative message if the OSD option is enabled.
  63  * \param vout The vout on which the message will be displayed
  64  * \param channel Subpicture channel
  65  * \param position Position of the text
  66  * \param duration Duration of the text being displayed
  67  * \param text Text to be displayed
  68  */
  69 VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, mtime_t duration, const char *text );
  70
  71 /**
  72  * \brief Write an informative message at the default location,
  73  *        for the default duration and only if the OSD option is enabled.
  74  * \param vout The vout on which the message will be displayed
  75  * \param channel Subpicture channel
  76  * \param format printf style formatting
  77  *
  78  * Provided for convenience.
  79  */
  80 VLC_API void vout_OSDMessage( vout_thread_t *, int, const char *, ... ) VLC_FORMAT( 3, 4 );
  81
  82 /**
  83  * Display a slider on the video output.
  84  * \param p_this    The object that called the function.
  85  * \param i_channel Subpicture channel
  86  * \param i_postion Current position in the slider
  87  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
  88  */
  89 VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short );
  90
  91 /**
  92  * Display an Icon on the video output.
  93  * \param p_this    The object that called the function.
  94  * \param i_channel Subpicture channel
  95  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
  96  */
  97 VLC_API void vout_OSDIcon( vout_thread_t *, int, short );
  98
  99 /** @} */
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif /* VLC_VOUT_OSD_H */
 105