d587654c72ecad6bffc36d49780a027670ba800c
[vlc.git] / 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 enum
39 {
40     /* Icons */
41     OSD_PLAY_ICON = 1,
42     OSD_PAUSE_ICON,
43     OSD_SPEAKER_ICON,
44     OSD_MUTE_ICON,
45     /* Sliders */
46     OSD_HOR_SLIDER,
47     OSD_VERT_SLIDER,
48 };
49
50 /**********************************************************************
51  * Vout text and widget overlays
52  **********************************************************************/
53 VLC_API int vout_OSDEpg( vout_thread_t *, input_item_t * );
54
55 /**
56  * \brief Write an informative message if the OSD option is enabled.
57  * \param vout The vout on which the message will be displayed
58  * \param channel Subpicture channel
59  * \param position Position of the text
60  * \param duration Duration of the text being displayed
61  * \param text Text to be displayed
62  */
63 VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, mtime_t duration, const char *text );
64
65 /**
66  * \brief Write an informative message at the default location,
67  *        for the default duration and only if the OSD option is enabled.
68  * \param vout The vout on which the message will be displayed
69  * \param channel Subpicture channel
70  * \param format printf style formatting
71  *
72  * Provided for convenience.
73  */
74 VLC_API void vout_OSDMessage( vout_thread_t *, int, const char *, ... ) VLC_FORMAT( 3, 4 );
75
76 /**
77  * Display a slider on the video output.
78  * \param p_this    The object that called the function.
79  * \param i_channel Subpicture channel
80  * \param i_postion Current position in the slider
81  * \param i_type    Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
82  */
83 VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short );
84
85 /**
86  * Display an Icon on the video output.
87  * \param p_this    The object that called the function.
88  * \param i_channel Subpicture channel
89  * \param i_type    Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
90  */
91 VLC_API void vout_OSDIcon( vout_thread_t *, int, short );
92
93 #ifdef __cplusplus
94 }
95 #endif
96
97 #endif /* VLC_VOUT_OSD_H */
98