mirror of https://code.videolan.org/videolan/vlc
121 lines
3.7 KiB
C
121 lines
3.7 KiB
C
/*****************************************************************************
|
|
* vlc_vout_osd.h: vout OSD
|
|
*****************************************************************************
|
|
* Copyright (C) 1999-2010 VLC authors and VideoLAN
|
|
* Copyright (C) 2004-2005 M2X
|
|
*
|
|
* Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
|
|
* Gildas Bazin <gbazin@videolan.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation; either version 2.1 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_VOUT_OSD_H
|
|
#define VLC_VOUT_OSD_H 1
|
|
|
|
#include <vlc_tick.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \defgroup osd On-screen display
|
|
* \ingroup spu
|
|
* @{
|
|
* \file
|
|
* Overlay text and widgets
|
|
*/
|
|
|
|
/**
|
|
* OSD menu position and picture type defines
|
|
*/
|
|
enum
|
|
{
|
|
/* Icons */
|
|
OSD_PLAY_ICON = 1,
|
|
OSD_PAUSE_ICON,
|
|
OSD_SPEAKER_ICON,
|
|
OSD_MUTE_ICON,
|
|
/* Sliders */
|
|
OSD_HOR_SLIDER,
|
|
OSD_VERT_SLIDER,
|
|
};
|
|
|
|
/**
|
|
* \brief Show EPG information about the current program of an input item
|
|
* \param vout pointer to the vout the information is to be showed on
|
|
* \param input pointer to the input item the information is to be showed
|
|
*/
|
|
VLC_API int vout_OSDEpg( vout_thread_t *vout, input_item_t *input);
|
|
|
|
/**
|
|
* \brief Write an informative message if the OSD option is enabled.
|
|
* \param vout The vout on which the message will be displayed
|
|
* \param channel Subpicture channel
|
|
* \param position Position of the text
|
|
* \param duration Duration of the text being displayed
|
|
* \param text Text to be displayed
|
|
*/
|
|
VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, vlc_tick_t duration, const char *text );
|
|
|
|
/**
|
|
* Write an informative message at the default location, for the default duration and only
|
|
* if the OSD option is enabled.
|
|
*
|
|
* \param vout The vout on which the message will be displayed
|
|
* \param channel Subpicture channel
|
|
* \param format printf style formatting
|
|
* \param args format argument list
|
|
*
|
|
* Provided for convenience.
|
|
*/
|
|
VLC_API void vout_OSDMessageVa(vout_thread_t *vout, int channel, const char *format, va_list args);
|
|
|
|
static inline void
|
|
vout_OSDMessage(vout_thread_t *vout, int channel, const char *format, ...)
|
|
{
|
|
va_list args;
|
|
va_start(args, format);
|
|
vout_OSDMessageVa(vout, channel, format, args);
|
|
va_end(args);
|
|
}
|
|
|
|
/**
|
|
* Display a slider on the video output.
|
|
* \param p_this The object that called the function.
|
|
* \param i_channel Subpicture channel
|
|
* \param i_position Current position in the slider
|
|
* \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
|
|
*/
|
|
VLC_API void vout_OSDSlider( vout_thread_t *p_this, int i_channel,
|
|
int i_position, short i_type);
|
|
|
|
/**
|
|
* Display an Icon on the video output.
|
|
* \param p_this The object that called the function.
|
|
* \param i_channel Subpicture channel
|
|
* \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
|
|
*/
|
|
VLC_API void vout_OSDIcon( vout_thread_t *p_this, int i_channel,
|
|
short i_type);
|
|
|
|
/** @} */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* VLC_VOUT_OSD_H */
|