-/*****************************************************************************\r
- * osd.h - OSD menu definitions and function prototypes\r
- *****************************************************************************\r
- * Copyright (C) 2004-2005 M2X\r
- * $Id: osd.h 9451 2004-12-01 01:07:08Z jpsaman $\r
- *\r
- * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.\r
- *****************************************************************************/\r
-\r
-/**\r
- * \file\r
- * The OSD menu core creates the OSD menu structure in memory. It parses a \r
- * configuration file that defines all elements that are part of the menu. The \r
- * core also handles all actions and menu structure updates on behalf of video \r
- * subpicture filters.\r
- *\r
- * The file modules/video_filters/osdmenu.c implements a subpicture filter that\r
- * specifies the final information on positioning of the current state image. \r
- * A subpicture filter is called each time a video picture has to be rendered, it\r
- * also gives a start and end date to the subpicture. The subpicture can be streamed\r
- * if used inside a transcoding command. For example:\r
- *\r
- * vlc dvdsimple:///dev/dvd --extraintf rc\r
- * --sout='#transcode{osdenc=dvbsub,osdcoded=YUVP,sfilter=osdmenu} \r
- * --osdmenu-file share/osdmenu/dvd.cfg\r
- *\r
- * Each OSD menu element, called "action", defines a hotkey action. Each action \r
- * can have several states (unselect, select, pressed). Each state has an image \r
- * that represents the state visually. The commands "menu right", "menu left", \r
- * "menu up" and "menu down" are used to navigate through the OSD menu structure.\r
- * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively\r
- * show and hide the OSD menu subpictures.\r
- *\r
- * There is one special element called "range". A range is an arbritary range\r
- * of state images that can be browsed using "menu up" and "menu down" commands\r
- * on the rc interface. \r
- * \r
- * The OSD menu configuration file uses a very simple syntax and basic parser. \r
- * A configuration file has the ".cfg". An example is "share/osdmenu/dvd256.cfg".\r
- */\r
- \r
-#ifndef _VLC_OSD_H\r
-#define _VLC_OSD_H 1\r
-\r
-#include "vlc_video.h"\r
-\r
-# ifdef __cplusplus\r
-extern "C" {\r
-# endif\r
-\r
-/**\r
- * The OSD Menu configuration file format.\r
- *\r
- * The configuration file syntax is very basic and so is its parser. See the\r
- * BNF formal representation below:\r
- *\r
- * The keywords FILENAME and PATHNAME represent the filename and pathname specification\r
- * that is valid for the Operating System VLC is compiled for. \r
- *\r
- * The hotkey actions that are supported by VLC are documented in the file src/libvlc. The\r
- * file include/vlc_keys.h defines some hotkey internals.\r
- *\r
- * CONFIG_FILE = FILENAME '.cfg'\r
- * WS = [ ' ' | '\t' ]+\r
- * OSDMEN_PATH = PATHNAME\r
- * DIR = 'dir' WS OSDMENU_PATH '\n'\r
- * STATE = [ 'unselect' | 'select' | 'pressed' ]\r
- * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+\r
- * \r
- * ACTION_TYPE = 'type' 'volume' '\n'\r
- * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'\r
- * ACTION_BLOCK_END = 'end' '\n'\r
- * ACTION_STATE = STATE WS FILENAME '\n'\r
- * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'\r
- * ACTION_RANGE_END = 'end' '\n'\r
- * ACTION_RANGE_STATE = FILENAME '\n'\r
- *\r
- * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END\r
- * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END\r
- * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+\r
- *\r
- */ \r
-\r
-/**\r
- * OSD menu button states\r
- *\r
- * Every button has three states, either it is unselected, selected or pressed.\r
- * An OSD menu skin can associate images with each state.\r
- *\r
- * OSD_BUTTON_UNSELECT 0\r
- * OSD_BUTTON_SELECT 1\r
- * OSD_BUTTON_PRESSED 2\r
- */\r
-#define OSD_BUTTON_UNSELECT 0\r
-#define OSD_BUTTON_SELECT 1\r
-#define OSD_BUTTON_PRESSED 2\r
-\r
-/**\r
- * OSD State object\r
- *\r
- * The OSD state object holds the state and associated images for a particular state\r
- * on the screen. The picture is displayed when this state is the active state.\r
- */\r
-struct osd_state_t\r
-{\r
- osd_state_t *p_next; /*< pointer to next state */\r
- osd_state_t *p_prev; /*< pointer to previous state */\r
- picture_t *p_pic; /*< picture of state */\r
- \r
- char *psz_state; /*< state name */\r
- int i_state; /*< state index */ \r
-};\r
-\r
-/** \r
- * OSD Button object\r
- *\r
- * An OSD Button has different states. Each state has an image for display. \r
- */\r
-struct osd_button_t\r
-{\r
- osd_button_t *p_next; /*< pointer to next button */\r
- osd_button_t *p_prev; /*< pointer to previous button */\r
- osd_button_t *p_up; /*< pointer to up button */\r
- osd_button_t *p_down; /*< pointer to down button */\r
- \r
- osd_state_t *p_current_state; /*< pointer to current state image */\r
- osd_state_t *p_states; /*< doubly linked list of states */\r
- picture_t *p_feedback; /*< feedback picture */\r
- \r
- char *psz_name; /*< name of button */\r
- \r
- /* These member should probably be a struct hotkey */\r
- char *psz_action; /*< hotkey action name on button*/\r
- char *psz_action_down; /*< hotkey action name on range buttons for command "menu down" */\r
- /* end of hotkey specifics */\r
- \r
- int i_x; /*< x-position of button visible state image */\r
- int i_y; /*< y-position of button visible state image */ \r
- \r
- /* range style button */ \r
- vlc_bool_t b_range; /*< button should be interpreted as range */\r
- int i_ranges; /*< number of states */\r
-};\r
-\r
-/** \r
- * OSD Menu State object\r
- *\r
- * Represents the current state as displayed. \r
- */\r
-/* Represent the menu state */\r
-struct osd_menu_state_t\r
-{\r
- int i_x; /*< x position of spu region */\r
- int i_y; /*< y position of spu region */\r
- int i_width; /*< width of spu region */\r
- int i_height; /*< height of spu region */ \r
- \r
- picture_t *p_pic; /*< pointer to picture to display */\r
- osd_button_t *p_visible; /*< shortcut to visible button */\r
- \r
- vlc_bool_t b_menu_visible; /*< menu currently visible? */\r
- vlc_bool_t b_update; /*< update OSD Menu when VLC_TRUE */\r
- \r
- /* quick hack to volume state. */\r
- osd_button_t *p_volume; /*< pointer to volume range object. */\r
-};\r
-\r
-/**\r
- * OSD Menu object\r
- *\r
- * The main OSD Menu object, which holds a linked list to all buttons\r
- * and images that defines the menu. The p_state variable represents the\r
- * current state of the OSD Menu.\r
- */\r
-struct osd_menu_t\r
-{\r
- VLC_COMMON_MEMBERS\r
- \r
- int i_x; /*< x-position of OSD Menu on the video screen */ \r
- int i_y; /*< y-position of OSD Menu on the video screen */ \r
- int i_width; /*< width of OSD Menu on the video screen */ \r
- int i_height; /*< height of OSD Menu on the video screen */ \r
- \r
- char *psz_path; /*< directory where OSD menu images are stored */\r
- osd_button_t *p_button; /*< doubly linked list of buttons */\r
- osd_menu_state_t *p_state; /*< current state of OSD menu */\r
- \r
- /* quick link in the linked list. */\r
- osd_button_t *p_last_button; /*< pointer to last button in the list */\r
-};\r
-\r
-/**\r
- * Initialize an osd_menu_t object\r
- *\r
- * This functions has to be called before any call to other osd_menu_t* functions.\r
- * It creates the osd_menu object and holds a pointer to it during its lifetime.\r
- */\r
-VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );\r
-\r
-/**\r
- * Delete the osd_menu_t object\r
- *\r
- * This functions has to be called to release the associated module and memory\r
- * for the osdmenu. After return of this function the pointer to osd_menu_t* is invalid.\r
- */\r
-VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );\r
-\r
-/**\r
- * Change state on an osd_button_t.\r
- *\r
- * This function selects the specified state and returns a pointer to it. The \r
- * following states are currently supported: \r
- * \see OSD_BUTTON_UNSELECT\r
- * \see OSD_BUTTON_SELECT \r
- * \see OSD_BUTTON_PRESSED \r
- */\r
-VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );\r
-\r
-#define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )\r
-#define osd_MenuDelete(object,osd) __osd_MenuDelete( VLC_OBJECT(object), osd )\r
-#define osd_StateChange(object,value) __osd_StateChange( object, value )\r
-\r
-/**\r
- * Show the OSD menu.\r
- *\r
- * Show the OSD menu on the video output or mux it into the stream. \r
- * Every change to the OSD menu will now be visible in the output. An output \r
- * can be a video output window or a stream (\see stream output)\r
- */\r
-VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) ); \r
-\r
-/**\r
- * Hide the OSD menu.\r
- *\r
- * Stop showing the OSD menu on the video output or mux it into the stream.\r
- */\r
-VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );\r
-\r
-/**\r
- * Activate the action of this OSD menu item.\r
- *\r
- * The rc interface command "menu select" triggers the sending of an hotkey action\r
- * to the hotkey interface. The hotkey that belongs to the current highlighted \r
- * OSD menu item will be used.\r
- */\r
-VLC_EXPORT( void, __osd_MenuActivate, ( vlc_object_t * ) );\r
-\r
-#define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )\r
-#define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )\r
-#define osd_MenuActivate(object) __osd_MenuActivate( VLC_OBJECT(object) )\r
-\r
-/**\r
- * Next OSD menu item\r
- *\r
- * Select the next OSD menu item to be highlighted.\r
- * Note: The actual position on screen of the menu item is determined by the the\r
- * OSD menu configuration file.\r
- */\r
-VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) ); \r
-\r
-/**\r
- * Previous OSD menu item\r
- *\r
- * Select the previous OSD menu item to be highlighted.\r
- * Note: The actual position on screen of the menu item is determined by the the\r
- * OSD menu configuration file.\r
- */\r
-VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );\r
-\r
-/**\r
- * OSD menu item above\r
- *\r
- * Select the OSD menu item above the current item to be highlighted. \r
- * Note: The actual position on screen of the menu item is determined by the the\r
- * OSD menu configuration file.\r
- */\r
-VLC_EXPORT( void, __osd_MenuUp, ( vlc_object_t * ) );\r
-\r
-/**\r
- * OSD menu item below\r
- *\r
- * Select the next OSD menu item below the current item to be highlighted.\r
- * Note: The actual position on screen of the menu item is determined by the the\r
- * OSD menu configuration file.\r
- */\r
-VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );\r
-\r
-#define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )\r
-#define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )\r
-#define osd_MenuUp(object) __osd_MenuUp( VLC_OBJECT(object) )\r
-#define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )\r
-\r
-/**\r
- * Turn Volume Up\r
- *\r
- * Use the OSD menu to turn the audio volume up.\r
- */\r
-VLC_EXPORT( void, __osd_VolumeUp, ( vlc_object_t * ) );\r
-\r
-/**\r
- * Turn Volume Down\r
- *\r
- * Use the OSD menu to turn the audio volume down.\r
- */\r
-VLC_EXPORT( void, __osd_VolumeDown, ( vlc_object_t * ) );\r
-\r
-#define osd_VolumeUp(object) __osd_VolumeUp( VLC_OBJECT(object) )\r
-#define osd_VolumeDown(object) __osd_VolumeDown( VLC_OBJECT(object) )\r
-\r
-/**\r
- * Retrieve a non modifyable pointer to the OSD Menu state\r
- *\r
- */\r
-static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )\r
-{\r
- return( p_osd->p_state );\r
-}\r
-\r
-/**\r
- * Get the last key press received by the OSD Menu\r
- *\r
- * Returns 0 when no key has been pressed or the value of the key pressed.\r
- */\r
-static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )\r
-{\r
- return( p_osd->p_state->b_update );\r
-} \r
-\r
-/**\r
- * Set the key pressed to a value.\r
- *\r
- * Assign a new key value to the last key pressed on the OSD Menu.\r
- */\r
-static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )\r
-{\r
- vlc_value_t val;\r
- \r
- val.i_int = i_value; \r
- var_Set( p_this, "key-pressed", val ); \r
-}\r
-\r
-/**\r
- * Update the OSD Menu visibility flag.\r
- *\r
- * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu should not be shown.\r
- */\r
-static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )\r
-{\r
- vlc_value_t val;\r
- \r
- val.b_bool = p_osd->p_state->b_menu_visible = b_value; \r
- var_Set( p_osd, "osd-menu-visible", val );\r
-}\r
-\r
-/**\r
- * Update the OSD Menu update flag\r
- *\r
- * If the OSD Menu should be updated then set the update flag to VLC_TRUE, else to VLC_FALSE.\r
- */\r
-static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )\r
-{\r
- vlc_value_t val;\r
- \r
- val.b_bool = p_osd->p_state->b_update = b_value;\r
- var_Set( p_osd, "osd-menu-update", val );\r
-} \r
-\r
-/**\r
- * Default feedback images\r
- *\r
- * Functions that provide the default OSD feedback images on hotkey commands. These feedback\r
- * images are also part of the osd_button_t object. The types are declared in the include file\r
- * include/osd.h\r
- * @see osd.h \r
- */\r
-VLC_EXPORT( picture_t *, osd_Slider, ( int i_width, int i_height, int i_position, short i_type ) );\r
-VLC_EXPORT( picture_t *, osd_Icon, ( int i_width, int i_height, short i_type ) );\r
-\r
-/**\r
- * Loading and parse the OSD Configuration file\r
- *\r
- * These functions load/unload the OSD menu configuration file and create/destroy the\r
- * themable OSD menu structure on the OSD object.\r
- */\r
-VLC_EXPORT( int, osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );\r
-VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );\r
-\r
-# ifdef __cplusplus\r
-}\r
-# endif\r
-\r
-#endif /* _VLC_OSD_H */\r
+/*****************************************************************************
+ * 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
+ * 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
+ * (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.
+ *
+ * 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.
+ *****************************************************************************/
+
+#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
+ * subpicture filters.
+ *
+ * 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:
+ *
+ * vlc dvdsimple:///dev/dvd --extraintf rc
+ * --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
+ * can have several states (unselect, select, pressed). Each state has an image
+ * that represents the state visually. The commands "menu right", "menu left",
+ * "menu up" and "menu down" are used to navigate through the OSD menu structure.
+ * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
+ * show and hide the OSD menu subpictures.
+ *
+ * There is one special element called "range". A range is an arbritary range
+ * of state images that can be browsed using "menu up" and "menu down" commands
+ * 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".
+ * @{
+ */
+
+/**
+ * \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 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' ]+
+ * 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', '-' ]+
+ *
+ * ACTION_TYPE = 'type' 'volume' '\n'
+ * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
+ * ACTION_BLOCK_END = 'end' '\n'
+ * ACTION_STATE = STATE WS FILENAME '\n'
+ * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
+ * ACTION_RANGE_END = 'end' '\n'
+ * ACTION_RANGE_STATE = FILENAME '\n'
+ *
+ * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
+ * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
+ * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
+ *
+ */
+
+/**
+ * OSD menu button states
+ *
+ * Every button has three states, either it is unselected, selected or pressed.
+ * An OSD menu skin can associate images with each state.
+ *
+ * OSD_BUTTON_UNSELECT 0
+ * OSD_BUTTON_SELECT 1
+ * OSD_BUTTON_PRESSED 2
+ */
+#define OSD_BUTTON_UNSELECT 0
+#define OSD_BUTTON_SELECT 1
+#define OSD_BUTTON_PRESSED 2
+
+/**
+ * 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.
+ */
+struct osd_state_t
+{
+ osd_state_t *p_next; /*< pointer to next state */
+ osd_state_t *p_prev; /*< pointer to previous state */
+ picture_t *p_pic; /*< picture of state */
+
+ 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 */
+};
+
+/**
+ * OSD Button object
+ *
+ * An OSD Button has different states. Each state has an image for display.
+ */
+struct osd_button_t
+{
+ osd_button_t *p_next; /*< pointer to next button */
+ osd_button_t *p_prev; /*< pointer to previous button */
+ osd_button_t *p_up; /*< pointer to up button */
+ osd_button_t *p_down; /*< pointer to down button */
+
+ 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 */
+
+ /* 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" */
+ /* 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 */
+ 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
+ *
+ * Represents the current state as displayed.
+ */
+/* Represent the menu state */
+struct osd_menu_state_t
+{
+ int i_x; /*< x position of spu region */
+ int i_y; /*< y position of spu region */
+ int i_width; /*< width of spu region */
+ int i_height; /*< height of spu region */
+
+ picture_t *p_pic; /*< pointer to picture to display */
+ osd_button_t *p_visible; /*< shortcut to visible button */
+
+ 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. */
+};
+
+/**
+ * OSD Menu object
+ *
+ * The main OSD Menu object, which holds a linked list to all buttons
+ * and images that defines the menu. The p_state variable represents the
+ * current state of the OSD Menu.
+ */
+struct osd_menu_t
+{
+ VLC_COMMON_MEMBERS
+
+ int i_x; /*< x-position of OSD Menu on the video screen */
+ 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 */
+ osd_menu_state_t *p_state; /*< current state of OSD menu */
+
+ /* 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.
+ */
+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.
+ */
+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 )
+
+/**
+ * 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 );
+
+#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.
+ *
+ * Show the OSD menu on the video output or mux it into the stream.
+ * 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 * ) );
+
+/**
+ * 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 * ) );
+
+/**
+ * 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.
+ */
+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) )
+
+/**
+ * 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 OSD menu configuration file.
+ */
+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 OSD menu configuration file.
+ */
+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 OSD menu configuration file.
+ */
+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 OSD menu configuration file.
+ */
+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) )
+
+/**
+ * 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
+static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
+{
+ return( p_osd->p_state );
+}
+
+/**
+ * Get the last key press received by the OSD Menu
+ *
+ * Returns 0 when no key has been pressed or the value of the key pressed.
+ */
+LIBVLC_USED
+static inline bool osd_GetKeyPressed( osd_menu_t *p_osd )
+{
+ return( p_osd->p_state->b_update );
+}
+
+/**
+ * Set the key pressed to a value.
+ *
+ * Assign a new key value to the last key pressed on the OSD Menu.
+ */
+static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
+{
+ vlc_value_t val;
+
+ val.i_int = i_value;
+ var_Set( p_this, "key-pressed", val );
+}
+
+/**
+ * Update the OSD Menu visibility flag.
+ *
+ * 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, bool b_value )
+{
+ vlc_value_t val;
+
+ val.b_bool = p_osd->p_state->b_menu_visible = b_value;
+ var_Set( p_osd, "osd-menu-visible", val );
+}
+
+/**
+ * Update the OSD Menu update flag
+ *
+ * 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, bool b_value )
+{
+ vlc_value_t val;
+
+ val.b_bool = p_osd->p_state->b_update = b_value;
+ var_Set( p_osd, "osd-menu-update", 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, 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 ) );
+
+/** @} */
+
+# ifdef __cplusplus
+}
+# endif
+
+#endif /* _VLC_OSD_H */
projects / vlc / blobdiff