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  * Write an informative message at the default location,
  53  * for the default duration and only if the OSD option is enabled.
  54  * \param p_caller The object that called the function.
  55  * \param i_channel Subpicture channel
  56  * \param psz_format printf style formatting
  57  **/
  58 VLC_EXPORT( void,  vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
  59
  60 #define vout_OSDMessage( obj, chan, ...) \
  61         vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ )
  62
  63 /**
  64  * Display a slider on the video output.
  65  * \param p_this    The object that called the function.
  66  * \param i_channel Subpicture channel
  67  * \param i_postion Current position in the slider
  68  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
  69  * @see vlc_osd.h
  70  */
  71 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
  72
  73 /**
  74  * Display an Icon on the video output.
  75  * \param p_this    The object that called the function.
  76  * \param i_channel Subpicture channel
  77  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
  78  * @see vlc_osd.h
  79  */
  80 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /* VLC_VOUT_OSD_H */
  87