access: linsys: clear some warnings
[vlc.git] / include / vlc_vout_osd.h
blobe8228a18668063dfa293b1522ed169b548f7281c
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$
8 * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
9 * Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
26 #ifndef VLC_VOUT_OSD_H
27 #define VLC_VOUT_OSD_H 1
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
33 /**
34 * \defgroup osd On-screen display
35 * \ingroup spu
36 * @{
37 * \file
38 * Overlay text and widgets
41 /**
42 * OSD menu position and picture type defines
44 enum
46 /* Icons */
47 OSD_PLAY_ICON = 1,
48 OSD_PAUSE_ICON,
49 OSD_SPEAKER_ICON,
50 OSD_MUTE_ICON,
51 /* Sliders */
52 OSD_HOR_SLIDER,
53 OSD_VERT_SLIDER,
56 VLC_API int vout_OSDEpg( vout_thread_t *, input_item_t * );
58 /**
59 * \brief Write an informative message if the OSD option is enabled.
60 * \param vout The vout on which the message will be displayed
61 * \param channel Subpicture channel
62 * \param position Position of the text
63 * \param duration Duration of the text being displayed
64 * \param text Text to be displayed
66 VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, vlc_tick_t duration, const char *text );
68 /**
69 * \brief Write an informative message at the default location,
70 * for the default duration and only if the OSD option is enabled.
71 * \param vout The vout on which the message will be displayed
72 * \param channel Subpicture channel
73 * \param format printf style formatting
74 * \param args format argument list
76 * Provided for convenience.
78 VLC_API void vout_OSDMessageVa(vout_thread_t *, int, const char *, va_list);
80 static inline void
81 vout_OSDMessage(vout_thread_t *vout, int channel, const char *format, ...)
83 va_list args;
84 va_start(args, format);
85 vout_OSDMessageVa(vout, channel, format, args);
86 va_end(args);
89 /**
90 * Display a slider on the video output.
91 * \param p_this The object that called the function.
92 * \param i_channel Subpicture channel
93 * \param i_postion Current position in the slider
94 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
96 VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short );
98 /**
99 * Display an Icon on the video output.
100 * \param p_this The object that called the function.
101 * \param i_channel Subpicture channel
102 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
104 VLC_API void vout_OSDIcon( vout_thread_t *, int, short );
106 /** @} */
107 #ifdef __cplusplus
109 #endif
111 #endif /* VLC_VOUT_OSD_H */