/*****************************************************************************
* vlc_osd.h - OSD menu and subpictures definitions and function prototypes
*****************************************************************************
- * Copyright (C) 1999-2006 the VideoLAN team
+ * Copyright (C) 1999-2006 VLC authors and VideoLAN
* Copyright (C) 2004-2005 M2X
* $Id$
*
* Gildas Bazin <gbazin@videolan.org>
*
* Added code from include/osd.h written by:
- * Copyright (C) 2003-2005 the VideoLAN team
+ * Copyright (C) 2003-2005 VLC authors and VideoLAN
* Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * 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 General Public License for more details.
+ * 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 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.
+ * 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_OSD_H
* The OSD menu core creates the OSD menu structure in memory. It parses a
* configuration file that defines all elements that are part of the menu. The
* core also handles all actions and menu structure updates on behalf of video
- * subpicture filters.
+ * subpicture sources.
*
- * The file modules/video_filters/osdmenu.c implements a subpicture filter that
+ * The file modules/video_filters/osdmenu.c implements a subpicture source that
* specifies the final information on positioning of the current state image.
- * A subpicture filter is called each time a video picture has to be rendered,
+ * A subpicture source is called each time a video picture has to be rendered,
* it also gives a start and end date to the subpicture. The subpicture can be
* streamed if used inside a transcoding command. For example:
*
* An example for local usage of the OSD menu is:
*
* vlc dvdsimple:///dev/dvd --extraintf rc
- * --sub-filter osdmenu
+ * --sub-source osdmenu
* --osdmenu-file=share/osdmenu/dvd.cfg
*
* Each OSD menu element, called "action", defines a hotkey action. Each action
osd_state_t *p_current_state; /*< pointer to current state image */
osd_state_t *p_states; /*< doubly linked list of states */
- picture_t *p_feedback; /*< feedback picture */
char *psz_name; /*< name of button */
* functions. It creates the osd_menu object and holds a pointer to it
* during its lifetime.
*/
-VLC_EXPORT( osd_menu_t *, osd_MenuCreate, ( vlc_object_t *, const char * ) LIBVLC_USED );
+VLC_API osd_menu_t * osd_MenuCreate( vlc_object_t *, const char * ) VLC_USED;
/**
* Delete the osd_menu_t object
* memory for the osdmenu. After return of this function the pointer to
* osd_menu_t* is invalid.
*/
-VLC_EXPORT( void, osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
+VLC_API void osd_MenuDelete( vlc_object_t *, osd_menu_t * );
#define osd_MenuCreate(object,file) osd_MenuCreate( VLC_OBJECT(object), file )
#define osd_MenuDelete(object,osd) osd_MenuDelete( VLC_OBJECT(object), osd )
/**
* Find OSD Menu button at position x,y
*/
-VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this,
- int, int, int, int, int, int ) LIBVLC_USED );
+VLC_API osd_button_t *osd_ButtonFind( vlc_object_t *p_this,
+ int, int, int, int, int, int ) VLC_USED;
#define osd_ButtonFind(object,x,y,h,w,sh,sw) osd_ButtonFind(object,x,y,h,w,sh,sw)
/**
* Select the button provided as the new active button
*/
-VLC_EXPORT( void, osd_ButtonSelect, ( vlc_object_t *, osd_button_t *) );
+VLC_API void osd_ButtonSelect( vlc_object_t *, osd_button_t *);
#define osd_ButtonSelect(object,button) osd_ButtonSelect(object,button)
* Every change to the OSD menu will now be visible in the output. An output
* can be a video output window or a stream (\see stream output)
*/
-VLC_EXPORT( void, osd_MenuShow, ( vlc_object_t * ) );
+VLC_API void osd_MenuShow( vlc_object_t * );
/**
* Hide the OSD menu.
*
* Stop showing the OSD menu on the video output or mux it into the stream.
*/
-VLC_EXPORT( void, osd_MenuHide, ( vlc_object_t * ) );
+VLC_API void osd_MenuHide( vlc_object_t * );
/**
* Activate the action of this OSD menu item.
* hotkey action to the hotkey interface. The hotkey that belongs to
* the current highlighted OSD menu item will be used.
*/
-VLC_EXPORT( void, osd_MenuActivate, ( vlc_object_t * ) );
+VLC_API void osd_MenuActivate( vlc_object_t * );
#define osd_MenuShow(object) osd_MenuShow( VLC_OBJECT(object) )
#define osd_MenuHide(object) osd_MenuHide( VLC_OBJECT(object) )
* Note: The actual position on screen of the menu item is determined by
* the OSD menu configuration file.
*/
-VLC_EXPORT( void, osd_MenuNext, ( vlc_object_t * ) );
+VLC_API void osd_MenuNext( vlc_object_t * );
/**
* Previous OSD menu item
* Note: The actual position on screen of the menu item is determined by
* the OSD menu configuration file.
*/
-VLC_EXPORT( void, osd_MenuPrev, ( vlc_object_t * ) );
+VLC_API void osd_MenuPrev( vlc_object_t * );
/**
* OSD menu item above
* Note: The actual position on screen of the menu item is determined by
* the OSD menu configuration file.
*/
-VLC_EXPORT( void, osd_MenuUp, ( vlc_object_t * ) );
+VLC_API void osd_MenuUp( vlc_object_t * );
/**
* OSD menu item below
* Note: The actual position on screen of the menu item is determined by
* the OSD menu configuration file.
*/
-VLC_EXPORT( void, osd_MenuDown, ( vlc_object_t * ) );
+VLC_API void osd_MenuDown( vlc_object_t * );
#define osd_MenuNext(object) osd_MenuNext( VLC_OBJECT(object) )
#define osd_MenuPrev(object) osd_MenuPrev( VLC_OBJECT(object) )
#define osd_MenuUp(object) osd_MenuUp( VLC_OBJECT(object) )
#define osd_MenuDown(object) osd_MenuDown( VLC_OBJECT(object) )
-/**
- * Display the audio volume bitmap.
- *
- * Display the correct audio volume bitmap that corresponds to the
- * current Audio Volume setting.
- */
-VLC_EXPORT( void, osd_Volume, ( vlc_object_t * ) );
-
-#define osd_Volume(object) osd_Volume( VLC_OBJECT(object) )
-
/**
* Retrieve a non modifyable pointer to the OSD Menu state
*
*/
-LIBVLC_USED
+VLC_USED
static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
{
return( p_osd->p_state );
*
* Returns 0 when no key has been pressed or the value of the key pressed.
*/
-LIBVLC_USED
+VLC_USED
static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
{
return( p_osd->p_state->b_update );
* object. The types are declared in the include file include/vlc_osd.h
* @see vlc_osd.h
*/
-VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t ) );
-VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t ) );
-VLC_EXPORT( void, osd_Message, ( spu_t *, int, char *, ... ) LIBVLC_FORMAT( 3, 4 ) );
+VLC_API int osd_ShowTextRelative( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t );
+VLC_API int osd_ShowTextAbsolute( spu_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t );
+VLC_API void osd_Message( spu_t *, int, char *, ... ) VLC_FORMAT( 3, 4 );
/** @} */
projects / vlc / blobdiff