/*****************************************************************************
- * vlc_osd.h - OSD menu definitions and function prototypes
+ * vlc_osd.h - OSD menu and subpictures definitions and function prototypes
*****************************************************************************
+ * Copyright (C) 1999-2006 the VideoLAN team
* Copyright (C) 2004-2005 M2X
* $Id$
*
* Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
+ * Gildas Bazin <gbazin@videolan.org>
*
* Added code from include/osd.h written by:
* Copyright (C) 2003-2005 the VideoLAN team
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+#ifndef VLC_OSD_H
+#define VLC_OSD_H 1
+
+#include <vlc_vout.h>
+#include <vlc_spu.h>
+#include <vlc_vout_osd.h>
+
+# ifdef __cplusplus
+extern "C" {
+# endif
+
/**
* \file
+ * This file defines SPU subpicture and OSD functions and object types.
+ */
+
+/**********************************************************************
+ * OSD Menu
+ **********************************************************************/
+/**
+ * \defgroup osdmenu OSD Menu
* 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
*
* The file modules/video_filters/osdmenu.c implements a subpicture filter 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, it
- * also gives a start and end date to the subpicture. The subpicture can be streamed
- * if used inside a transcoding command. For example:
+ * A subpicture filter 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:
*
* vlc dvdsimple:///dev/dvd --extraintf rc
- * --sout='#transcode{osd}:std{access=udp,mux=ts,url=dest_ipaddr}'
+ * --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
+ * --osdmenu-file=share/osdmenu/dvd.cfg
+ *
+ * An example for local usage of the OSD menu is:
+ *
+ * vlc dvdsimple:///dev/dvd --extraintf rc
+ * --sub-filter osdmenu
* --osdmenu-file=share/osdmenu/dvd.cfg
*
* Each OSD menu element, called "action", defines a hotkey action. Each action
* on the rc interface.
*
* The OSD menu configuration file uses a very simple syntax and basic parser.
- * A configuration file has the ".cfg". An example is "share/osdmenu/dvd256.cfg".
+ * A configuration file has the ".cfg".
+ * An example is "share/osdmenu/dvd256.cfg".
+ * @{
*/
-#ifndef _VLC_OSD_H
-#define _VLC_OSD_H 1
-
-#include "vlc_video.h"
-
-# ifdef __cplusplus
-extern "C" {
-# endif
-
/**
* \brief The OSD Menu configuration file format.
*
* The configuration file syntax is very basic and so is its parser. See the
* BNF formal representation below:
*
- * The keywords FILENAME and PATHNAME represent the filename and pathname specification
- * that is valid for the Operating System VLC is compiled for.
+ * The keywords FILENAME and PATHNAME represent the filename and pathname
+ * specification that is valid for the Operating System VLC is compiled for.
*
- * The hotkey actions that are supported by VLC are documented in the file src/libvlc. The
- * file include/vlc_keys.h defines some hotkey internals.
+ * The hotkey actions that are supported by VLC are documented in the file
+ * src/libvlc. The file include/vlc_keys.h defines some hotkey internals.
*
* CONFIG_FILE = FILENAME '.cfg'
* WS = [ ' ' | '\t' ]+
- * OSDMEN_PATH = PATHNAME
+ * OSDMENU_PATH = PATHNAME
* DIR = 'dir' WS OSDMENU_PATH '\n'
+ * STYLE = 'style' [ 'default' | 'concat' ] '\n'
* STATE = [ 'unselect' | 'select' | 'pressed' ]
* HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
*
*
*/
-/**
- * OSD menu position and picture type defines
- */
-
-#define OSD_ALIGN_LEFT 0x1
-#define OSD_ALIGN_RIGHT 0x2
-#define OSD_ALIGN_TOP 0x4
-#define OSD_ALIGN_BOTTOM 0x8
-
-#define OSD_HOR_SLIDER 1
-#define OSD_VERT_SLIDER 2
-
-#define OSD_PLAY_ICON 1
-#define OSD_PAUSE_ICON 2
-#define OSD_SPEAKER_ICON 3
-#define OSD_MUTE_ICON 4
-
-/**
- * Text style
- *
- * A text style is used to specify the formatting of text.
- * A font renderer can use the supplied information to render the text specified.
- */
-struct text_style_t
-{
- char * psz_fontname; /**< The name of the font */
- int i_font_size; /**< The font size in pixels */
- int i_font_color; /**< The color of the text 0xRRGGBB (native endianness) */
- int i_font_alpha; /**< The transparency of the text.
- 0x00 is fully opaque, 0xFF fully transparent */
- int i_style_flags; /**< Formatting style flags */
- int i_outline_color; /**< The color of the outline 0xRRGGBB */
- int i_outline_alpha; /**< The transparency of the outline.
- 0x00 is fully opaque, 0xFF fully transparent */
- int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
- int i_shadow_alpha; /**< The transparency of the shadow.
- 0x00 is fully opaque, 0xFF fully transparent */
- int i_background_color; /**< The color of the background 0xRRGGBB */
- int i_background_alpha; /**< The transparency of the background.
- 0x00 is fully opaque, 0xFF fully transparent */
- int i_outline_width; /**< The width of the outline in pixels */
- int i_shadow_width; /**< The width of the shadow in pixels */
- int i_spacing; /**< The spaceing between glyphs in pixels */
- int i_text_align; /**< An alignment hint for the text */
-};
-
-/* Style flags for \ref text_style_t */
-#define STYLE_BOLD 1
-#define STYLE_ITALIC 2
-#define STYLE_OUTLINE 4
-#define STYLE_SHADOW 8
-#define STYLE_BACKGROUND 16
-#define STYLE_UNDERLINE 32
-#define STYLE_STRIKEOUT 64
-
-static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
- 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 1, 0, -1, 0 };
-
-
-
/**
* OSD menu button states
*
/**
* OSD State object
*
- * The OSD state object holds the state and associated images for a particular state
- * on the screen. The picture is displayed when this state is the active state.
+ * The OSD state object holds the state and associated images for a
+ * particular state on the screen. The picture is displayed when this
+ * state is the active state.
*/
struct osd_state_t
{
char *psz_state; /*< state name */
int i_state; /*< state index */
+
+ int i_x; /*< x-position of button state image */
+ int i_y; /*< y-position of button state image */
+ int i_width; /*< width of button state image */
+ int i_height; /*< height of button state image */
};
/**
/* These member should probably be a struct hotkey */
char *psz_action; /*< hotkey action name on button*/
- char *psz_action_down; /*< hotkey action name on range buttons for command "menu down" */
+ char *psz_action_down; /*< hotkey action name on range buttons
+ for command "menu down" */
/* end of hotkey specifics */
int i_x; /*< x-position of button visible state image */
int i_y; /*< y-position of button visible state image */
+ int i_width; /*< width of button visible state image */
+ int i_height; /*< height of button visible state image */
/* range style button */
- vlc_bool_t b_range; /*< button should be interpreted as range */
+ bool b_range; /*< button should be interpreted as range */
int i_ranges; /*< number of states */
};
+/**
+ * OSD Menu Style
+ *
+ * The images that make up an OSD menu can be created in such away that
+ * they contain all buttons in the same picture, with the selected one
+ * highlighted or being a concatenation of all the separate images. The
+ * first case is the default.
+ *
+ * To change the default style the keyword 'style' should be set to 'concat'.
+ */
+
+#define OSD_MENU_STYLE_SIMPLE 0x0
+#define OSD_MENU_STYLE_CONCAT 0x1
+
/**
* OSD Menu State object
*
picture_t *p_pic; /*< pointer to picture to display */
osd_button_t *p_visible; /*< shortcut to visible button */
- vlc_bool_t b_menu_visible; /*< menu currently visible? */
- vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */
+ bool b_menu_visible; /*< menu currently visible? */
+ bool b_update; /*< update OSD Menu when true */
/* quick hack to volume state. */
osd_button_t *p_volume; /*< pointer to volume range object. */
int i_y; /*< y-position of OSD Menu on the video screen */
int i_width; /*< width of OSD Menu on the video screen */
int i_height; /*< height of OSD Menu on the video screen */
+ int i_style; /*< style of spu region generation */
+ int i_position; /*< display position */
char *psz_path; /*< directory where OSD menu images are stored */
osd_button_t *p_button; /*< doubly linked list of buttons */
/* quick link in the linked list. */
osd_button_t *p_last_button; /*< pointer to last button in the list */
+
+ /* misc parser */
+ module_t *p_parser; /*< pointer to parser module */
+ char *psz_file; /*< Config file name */
+ image_handler_t *p_image; /*< handler to image loading and conversion libraries */
};
/**
* Initialize an osd_menu_t object
*
- * This functions has to be called before any call to other osd_menu_t* functions.
- * It creates the osd_menu object and holds a pointer to it during its lifetime.
+ * This functions has to be called before any call to other osd_menu_t*
+ * 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 * ) );
+VLC_EXPORT( osd_menu_t *, osd_MenuCreate, ( vlc_object_t *, const char * ) LIBVLC_USED );
/**
* Delete the osd_menu_t object
*
- * This functions has to be called to release the associated module and memory
- * for the osdmenu. After return of this function the pointer to osd_menu_t* is invalid.
+ * This functions has to be called to release the associated module and
+ * 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_EXPORT( 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 )
/**
- * Change state on an osd_button_t.
- *
- * This function selects the specified state and returns a pointer to it. The
- * following states are currently supported:
- * \see OSD_BUTTON_UNSELECT
- * \see OSD_BUTTON_SELECT
- * \see OSD_BUTTON_PRESSED
+ * Find OSD Menu button at position x,y
*/
-VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
+VLC_EXPORT( osd_button_t *, osd_ButtonFind, ( vlc_object_t *p_this,
+ int, int, int, int, int, int ) LIBVLC_USED );
-#define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
-#define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )
-#define osd_StateChange(object,value) __osd_StateChange( object, value )
+#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 *) );
+
+#define osd_ButtonSelect(object,button) osd_ButtonSelect(object,button)
/**
* Show the OSD menu.
* 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_EXPORT( 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_EXPORT( void, osd_MenuHide, ( vlc_object_t * ) );
/**
* Activate the action of this OSD menu item.
*
- * The rc interface command "menu select" triggers the sending of an hotkey action
- * to the hotkey interface. The hotkey that belongs to the current highlighted
- * OSD menu item will be used.
+ * The rc interface command "menu select" triggers the sending of an
+ * 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_EXPORT( void, osd_MenuActivate, ( vlc_object_t * ) );
-#define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
-#define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
-#define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )
+#define osd_MenuShow(object) osd_MenuShow( VLC_OBJECT(object) )
+#define osd_MenuHide(object) osd_MenuHide( VLC_OBJECT(object) )
+#define osd_MenuActivate(object) osd_MenuActivate( VLC_OBJECT(object) )
/**
* Next OSD menu item
*
* Select the next OSD menu item to be highlighted.
- * Note: The actual position on screen of the menu item is determined by the the
- * OSD menu configuration file.
+ * 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_EXPORT( void, osd_MenuNext, ( vlc_object_t * ) );
/**
* Previous OSD menu item
*
* Select the previous OSD menu item to be highlighted.
- * Note: The actual position on screen of the menu item is determined by the the
- * OSD menu configuration file.
+ * 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_EXPORT( void, osd_MenuPrev, ( vlc_object_t * ) );
/**
* OSD menu item above
*
* Select the OSD menu item above the current item to be highlighted.
- * Note: The actual position on screen of the menu item is determined by the the
- * OSD menu configuration file.
+ * 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_EXPORT( void, osd_MenuUp, ( vlc_object_t * ) );
/**
* OSD menu item below
*
* Select the next OSD menu item below the current item to be highlighted.
- * Note: The actual position on screen of the menu item is determined by the the
- * OSD menu configuration file.
+ * 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_EXPORT( 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) )
+#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 * ) );
+VLC_EXPORT( void, osd_Volume, ( vlc_object_t * ) );
-#define osd_Volume(object) __osd_Volume( VLC_OBJECT(object) )
+#define osd_Volume(object) osd_Volume( VLC_OBJECT(object) )
/**
* Retrieve a non modifyable pointer to the OSD Menu state
*
*/
+LIBVLC_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.
*/
-static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
+LIBVLC_USED
+static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
{
return( p_osd->p_state->b_update );
}
/**
* Update the OSD Menu visibility flag.
*
- * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu should not be shown.
+ * true means OSD Menu should be shown. false means OSD Menu
+ * should not be shown.
*/
-static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
+static inline void osd_SetMenuVisible( osd_menu_t *p_osd, bool b_value )
{
vlc_value_t val;
/**
* Update the OSD Menu update flag
*
- * If the OSD Menu should be updated then set the update flag to VLC_TRUE, else to VLC_FALSE.
+ * If the OSD Menu should be updated then set the update flag to
+ * true, else to false.
*/
-static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
+static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, bool b_value )
{
vlc_value_t val;
/**
* Textual feedback
*
- * Functions that provide the textual feedback on the OSD. They are shown on hotkey commands. The feedback
- * is also part of the osd_button_t 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, char *, text_style_t *, int, int, int, mtime_t ) );
-VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
-VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
-
-/**
- * Default feedback images
- *
- * Functions that provide the default OSD feedback images on hotkey commands. These feedback
- * images are also part of the osd_button_t object. The types are declared in the include file
- * include/vlc_osd.h
+ * Functions that provide the textual feedback on the OSD. They are shown
+ * on hotkey commands. The feedback is also part of the osd_button_t
+ * object. The types are declared in the include file include/vlc_osd.h
* @see vlc_osd.h
*/
-VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, short ) );
-VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, short ) );
+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 ) );
-/**
- * Loading and parse the OSD Configuration file
- *
- * These functions load/unload the OSD menu configuration file and create/destroy the
- * themable OSD menu structure on the OSD object.
- */
-VLC_EXPORT( int, osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );
-VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );
+/** @} */
# ifdef __cplusplus
}
projects / vlc / blobdiff