git.sesse.net Git - vlc/blob - include/vlc_osd.h

   1 /*****************************************************************************
   2  * vlc_osd.h - OSD menu definitions and function prototypes
   3  *****************************************************************************
   4  * Copyright (C) 2004-2005 M2X
   5  * $Id$
   6  *
   7  * Authors: Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
   8  *
   9  * Added code from include/osd.h written by:
  10  * Copyright (C) 2003-2005 the VideoLAN team
  11  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  26  *****************************************************************************/
  27
  28 /**
  29  * \file
  30  * The OSD menu core creates the OSD menu structure in memory. It parses a
  31  * configuration file that defines all elements that are part of the menu. The
  32  * core also handles all actions and menu structure updates on behalf of video
  33  * subpicture filters.
  34  *
  35  * The file modules/video_filters/osdmenu.c implements a subpicture filter that
  36  * specifies the final information on positioning of the current state image.
  37  * A subpicture filter is called each time a video picture has to be rendered, it
  38  * also gives a start and end date to the subpicture. The subpicture can be streamed
  39  * if used inside a transcoding command. For example:
  40  *
  41  *  vlc dvdsimple:///dev/dvd --extraintf rc
  42  *  --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
  43  *  --osdmenu-file=share/osdmenu/dvd.cfg
  44  *
  45  * Each OSD menu element, called "action", defines a hotkey action. Each action
  46  * can have several states (unselect, select, pressed). Each state has an image
  47  * that represents the state visually. The commands "menu right", "menu left",
  48  * "menu up" and "menu down" are used to navigate through the OSD menu structure.
  49  * The commands "menu on" or "menu show" and "menu off" or "menu hide" respectively
  50  * show and hide the OSD menu subpictures.
  51  *
  52  * There is one special element called "range". A range is an arbritary range
  53  * of state images that can be browsed using "menu up" and "menu down" commands
  54  * on the rc interface.
  55  *
  56  * The OSD menu configuration file uses a very simple syntax and basic parser.
  57  * A configuration file has the ".cfg". An example is "share/osdmenu/dvd256.cfg".
  58  */
  59
  60 #ifndef _VLC_OSD_H
  61 #define _VLC_OSD_H 1
  62
  63 #include "vlc_video.h"
  64
  65 # ifdef __cplusplus
  66 extern "C" {
  67 # endif
  68
  69 /**
  70  * \brief The OSD Menu configuration file format.
  71  *
  72  * The configuration file syntax is very basic and so is its parser. See the
  73  * BNF formal representation below:
  74  *
  75  * The keywords FILENAME and PATHNAME represent the filename and pathname specification
  76  * that is valid for the Operating System VLC is compiled for.
  77  *
  78  * The hotkey actions that are supported by VLC are documented in the file src/libvlc. The
  79  * file include/vlc_keys.h defines some hotkey internals.
  80  *
  81  * CONFIG_FILE = FILENAME '.cfg'
  82  * WS = [ ' ' | '\t' ]+
  83  * OSDMEN_PATH = PATHNAME
  84  * DIR = 'dir' WS OSDMENU_PATH '\n'
  85  * STATE = [ 'unselect' | 'select' | 'pressed' ]
  86  * HOTKEY_ACTION = 'key-' [ 'a' .. 'z', 'A' .. 'Z', '-' ]+
  87  *
  88  * ACTION_TYPE        = 'type' 'volume' '\n'
  89  * ACTION_BLOCK_START = 'action' WS HOTKEY_ACTION WS '('POS','POS')' '\n'
  90  * ACTION_BLOCK_END   = 'end' '\n'
  91  * ACTION_STATE       = STATE WS FILENAME '\n'
  92  * ACTION_RANGE_START = 'range' WS HOTKEY_ACTION WS DEFAULT_INDEX '\n'
  93  * ACTION_RANGE_END   = 'end' '\n'
  94  * ACTION_RANGE_STATE = FILENAME '\n'
  95  *
  96  * ACTION_BLOCK_RANGE = ACTION_RANGE_START [WS ACTION_RANGE_STATE]+ WS ACTION_RANGE_END
  97  * ACTION_BLOCK = ACTION_BLOCK_START [WS ACTION_TYPE*] [ [WS ACTION_STATE]+3 | [WS ACTION_BLOCK_RANGE]+1 ] ACTION_BLOCK_END
  98  * CONFIG_FILE_CONTENTS = DIR [ACTION_BLOCK]+
  99  *
 100  */
 101
 102 /**
 103  * OSD menu position and picture type defines
 104  */
 105
 106 #define OSD_ALIGN_LEFT 0x1
 107 #define OSD_ALIGN_RIGHT 0x2
 108 #define OSD_ALIGN_TOP 0x4
 109 #define OSD_ALIGN_BOTTOM 0x8
 110
 111 #define OSD_HOR_SLIDER 1
 112 #define OSD_VERT_SLIDER 2
 113
 114 #define OSD_PLAY_ICON 1
 115 #define OSD_PAUSE_ICON 2
 116 #define OSD_SPEAKER_ICON 3
 117 #define OSD_MUTE_ICON 4
 118
 119 /**
 120  * Text style
 121  *
 122  * A text style is used to specify the formatting of text.
 123  * A font renderer can use the supplied information to render the text specified.
 124  */
 125 struct text_style_t
 126 {
 127     char *     psz_fontname;                                /**< The name of the font */
 128     int        i_font_size;                              /**< The font size in pixels */
 129     int        i_font_color;  /**< The color of the text 0xRRGGBB (native endianness) */
 130     int        i_font_alpha;                        /**< The transparency of the text.
 131                                          0x00 is fully opaque, 0xFF fully transparent */
 132     int        i_style_flags;                             /**< Formatting style flags */
 133     int        i_outline_color;                /**< The color of the outline 0xRRGGBB */
 134     int        i_outline_alpha;                  /**< The transparency of the outline.
 135                                          0x00 is fully opaque, 0xFF fully transparent */
 136     int        i_shadow_color;                  /**< The color of the shadow 0xRRGGBB */
 137     int        i_shadow_alpha;                    /**< The transparency of the shadow.
 138                                          0x00 is fully opaque, 0xFF fully transparent */
 139     int        i_background_color;          /**< The color of the background 0xRRGGBB */
 140     int        i_background_alpha;            /**< The transparency of the background.
 141                                          0x00 is fully opaque, 0xFF fully transparent */
 142     int        i_outline_width;               /**< The width of the outline in pixels */
 143     int        i_shadow_width;                 /**< The width of the shadow in pixels */
 144     int        i_spacing;                  /**< The spaceing between glyphs in pixels */
 145     int        i_text_align;                      /**< An alignment hint for the text */
 146 };
 147
 148 /* Style flags for \ref text_style_t */
 149 #define STYLE_BOLD        1
 150 #define STYLE_ITALIC      2
 151 #define STYLE_OUTLINE     4
 152 #define STYLE_SHADOW      8
 153 #define STYLE_BACKGROUND  16
 154 #define STYLE_UNDERLINE   32
 155 #define STYLE_STRIKEOUT   64
 156
 157 static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
 158                 0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 1, 0, -1, 0 };
 159
 160
 161
 162 /**
 163  * OSD menu button states
 164  *
 165  * Every button has three states, either it is unselected, selected or pressed.
 166  * An OSD menu skin can associate images with each state.
 167  *
 168  *  OSD_BUTTON_UNSELECT 0
 169  *  OSD_BUTTON_SELECT   1
 170  *  OSD_BUTTON_PRESSED  2
 171  */
 172 #define OSD_BUTTON_UNSELECT 0
 173 #define OSD_BUTTON_SELECT   1
 174 #define OSD_BUTTON_PRESSED  2
 175
 176 /**
 177  * OSD State object
 178  *
 179  * The OSD state object holds the state and associated images for a particular state
 180  * on the screen. The picture is displayed when this state is the active state.
 181  */
 182 struct osd_state_t
 183 {
 184     osd_state_t *p_next;    /*< pointer to next state */
 185     osd_state_t *p_prev;    /*< pointer to previous state */
 186     picture_t   *p_pic;     /*< picture of state */
 187
 188     char        *psz_state; /*< state name */
 189     int          i_state;   /*< state index */
 190 };
 191
 192 /**
 193  * OSD Button object
 194  *
 195  * An OSD Button has different states. Each state has an image for display.
 196  */
 197 struct osd_button_t
 198 {
 199     osd_button_t *p_next;   /*< pointer to next button */
 200     osd_button_t *p_prev;   /*< pointer to previous button */
 201     osd_button_t *p_up;     /*< pointer to up button */
 202     osd_button_t *p_down;   /*< pointer to down button */
 203
 204     osd_state_t *p_current_state; /*< pointer to current state image */
 205     osd_state_t *p_states; /*< doubly linked list of states */
 206     picture_t   *p_feedback; /*< feedback picture */
 207
 208     char    *psz_name;     /*< name of button */
 209
 210     /* These member should probably be a struct hotkey */
 211     char    *psz_action;      /*< hotkey action name on button*/
 212     char    *psz_action_down; /*< hotkey action name on range buttons for command "menu down" */
 213     /* end of hotkey specifics */
 214
 215     int     i_x;            /*< x-position of button visible state image */
 216     int     i_y;            /*< y-position of button visible state image */
 217
 218     /* range style button */
 219     vlc_bool_t   b_range;    /*< button should be interpreted as range */
 220     int          i_ranges;   /*< number of states */
 221 };
 222
 223 /**
 224  * OSD Menu State object
 225  *
 226  * Represents the current state as displayed.
 227  */
 228 /* Represent the menu state */
 229 struct osd_menu_state_t
 230 {
 231     int     i_x;        /*< x position of spu region */
 232     int     i_y;        /*< y position of spu region */
 233     int     i_width;    /*< width of spu region */
 234     int     i_height;   /*< height of spu region */
 235
 236     picture_t    *p_pic;  /*< pointer to picture to display */
 237     osd_button_t *p_visible; /*< shortcut to visible button */
 238
 239     vlc_bool_t b_menu_visible; /*< menu currently visible? */
 240     vlc_bool_t b_update;       /*< update OSD Menu when VLC_TRUE */
 241
 242     /* quick hack to volume state. */
 243     osd_button_t *p_volume; /*< pointer to volume range object. */
 244 };
 245
 246 /**
 247  * OSD Menu object
 248  *
 249  * The main OSD Menu object, which holds a linked list to all buttons
 250  * and images that defines the menu. The p_state variable represents the
 251  * current state of the OSD Menu.
 252  */
 253 struct osd_menu_t
 254 {
 255     VLC_COMMON_MEMBERS
 256
 257     int     i_x;        /*< x-position of OSD Menu on the video screen */
 258     int     i_y;        /*< y-position of OSD Menu on the video screen */
 259     int     i_width;    /*< width of OSD Menu on the video screen */
 260     int     i_height;   /*< height of OSD Menu on the video screen */
 261
 262     char             *psz_path;  /*< directory where OSD menu images are stored */
 263     osd_button_t     *p_button;  /*< doubly linked list of buttons */
 264     osd_menu_state_t *p_state;   /*< current state of OSD menu */
 265
 266     /* quick link in the linked list. */
 267     osd_button_t  *p_last_button; /*< pointer to last button in the list */
 268 };
 269
 270 /**
 271  * Initialize an osd_menu_t object
 272  *
 273  * This functions has to be called before any call to other osd_menu_t* functions.
 274  * It creates the osd_menu object and holds a pointer to it during its lifetime.
 275  */
 276 VLC_EXPORT( osd_menu_t *, __osd_MenuCreate, ( vlc_object_t *, const char * ) );
 277
 278 /**
 279  * Delete the osd_menu_t object
 280  *
 281  * This functions has to be called to release the associated module and memory
 282  * for the osdmenu. After return of this function the pointer to osd_menu_t* is invalid.
 283  */
 284 VLC_EXPORT( void, __osd_MenuDelete, ( vlc_object_t *, osd_menu_t * ) );
 285
 286 /**
 287  * Change state on an osd_button_t.
 288  *
 289  * This function selects the specified state and returns a pointer to it. The
 290  * following states are currently supported:
 291  * \see OSD_BUTTON_UNSELECT
 292  * \see OSD_BUTTON_SELECT
 293  * \see OSD_BUTTON_PRESSED
 294  */
 295 VLC_EXPORT( osd_state_t *, __osd_StateChange, ( osd_state_t *, const int ) );
 296
 297 #define osd_MenuCreate(object,file) __osd_MenuCreate( VLC_OBJECT(object), file )
 298 #define osd_MenuDelete(object,osd)  __osd_MenuDelete( VLC_OBJECT(object), osd )
 299 #define osd_StateChange(object,value) __osd_StateChange( object, value )
 300
 301 /**
 302  * Show the OSD menu.
 303  *
 304  * Show the OSD menu on the video output or mux it into the stream.
 305  * Every change to the OSD menu will now be visible in the output. An output
 306  * can be a video output window or a stream (\see stream output)
 307  */
 308 VLC_EXPORT( void, __osd_MenuShow, ( vlc_object_t * ) );
 309
 310 /**
 311  * Hide the OSD menu.
 312  *
 313  * Stop showing the OSD menu on the video output or mux it into the stream.
 314  */
 315 VLC_EXPORT( void, __osd_MenuHide, ( vlc_object_t * ) );
 316
 317 /**
 318  * Activate the action of this OSD menu item.
 319  *
 320  * The rc interface command "menu select" triggers the sending of an hotkey action
 321  * to the hotkey interface. The hotkey that belongs to the current highlighted
 322  * OSD menu item will be used.
 323  */
 324 VLC_EXPORT( void, __osd_MenuActivate,   ( vlc_object_t * ) );
 325
 326 #define osd_MenuShow(object) __osd_MenuShow( VLC_OBJECT(object) )
 327 #define osd_MenuHide(object) __osd_MenuHide( VLC_OBJECT(object) )
 328 #define osd_MenuActivate(object)   __osd_MenuActivate( VLC_OBJECT(object) )
 329
 330 /**
 331  * Next OSD menu item
 332  *
 333  * Select the next OSD menu item to be highlighted.
 334  * Note: The actual position on screen of the menu item is determined by the the
 335  * OSD menu configuration file.
 336  */
 337 VLC_EXPORT( void, __osd_MenuNext, ( vlc_object_t * ) );
 338
 339 /**
 340  * Previous OSD menu item
 341  *
 342  * Select the previous OSD menu item to be highlighted.
 343  * Note: The actual position on screen of the menu item is determined by the the
 344  * OSD menu configuration file.
 345  */
 346 VLC_EXPORT( void, __osd_MenuPrev, ( vlc_object_t * ) );
 347
 348 /**
 349  * OSD menu item above
 350  *
 351  * Select the OSD menu item above the current item to be highlighted.
 352  * Note: The actual position on screen of the menu item is determined by the the
 353  * OSD menu configuration file.
 354  */
 355 VLC_EXPORT( void, __osd_MenuUp,   ( vlc_object_t * ) );
 356
 357 /**
 358  * OSD menu item below
 359  *
 360  * Select the next OSD menu item below the current item to be highlighted.
 361  * Note: The actual position on screen of the menu item is determined by the the
 362  * OSD menu configuration file.
 363  */
 364 VLC_EXPORT( void, __osd_MenuDown, ( vlc_object_t * ) );
 365
 366 #define osd_MenuNext(object) __osd_MenuNext( VLC_OBJECT(object) )
 367 #define osd_MenuPrev(object) __osd_MenuPrev( VLC_OBJECT(object) )
 368 #define osd_MenuUp(object)   __osd_MenuUp( VLC_OBJECT(object) )
 369 #define osd_MenuDown(object) __osd_MenuDown( VLC_OBJECT(object) )
 370
 371 /**
 372  * Display the audio volume bitmap.
 373  *
 374  * Display the correct audio volume bitmap that corresponds to the
 375  * current Audio Volume setting.
 376  */
 377 VLC_EXPORT( void, __osd_Volume, ( vlc_object_t * ) );
 378
 379 #define osd_Volume(object)     __osd_Volume( VLC_OBJECT(object) )
 380
 381 /**
 382  * Retrieve a non modifyable pointer to the OSD Menu state
 383  *
 384  */
 385 static inline const osd_menu_state_t *osd_GetMenuState( osd_menu_t *p_osd )
 386 {
 387     return( p_osd->p_state );
 388 }
 389
 390 /**
 391  * Get the last key press received by the OSD Menu
 392  *
 393  * Returns 0 when no key has been pressed or the value of the key pressed.
 394  */
 395 static inline vlc_bool_t osd_GetKeyPressed( osd_menu_t *p_osd )
 396 {
 397     return( p_osd->p_state->b_update );
 398 }
 399
 400 /**
 401  * Set the key pressed to a value.
 402  *
 403  * Assign a new key value to the last key pressed on the OSD Menu.
 404  */
 405 static inline void osd_SetKeyPressed( vlc_object_t *p_this, int i_value )
 406 {
 407     vlc_value_t val;
 408
 409     val.i_int = i_value;
 410     var_Set( p_this, "key-pressed", val );
 411 }
 412
 413 /**
 414  * Update the OSD Menu visibility flag.
 415  *
 416  * VLC_TRUE means OSD Menu should be shown. VLC_FALSE means OSD Menu should not be shown.
 417  */
 418 static inline void osd_SetMenuVisible( osd_menu_t *p_osd, vlc_bool_t b_value )
 419 {
 420     vlc_value_t val;
 421
 422     val.b_bool = p_osd->p_state->b_menu_visible = b_value;
 423     var_Set( p_osd, "osd-menu-visible", val );
 424 }
 425
 426 /**
 427  * Update the OSD Menu update flag
 428  *
 429  * If the OSD Menu should be updated then set the update flag to VLC_TRUE, else to VLC_FALSE.
 430  */
 431 static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
 432 {
 433     vlc_value_t val;
 434
 435     val.b_bool = p_osd->p_state->b_update = b_value;
 436     var_Set( p_osd, "osd-menu-update", val );
 437 }
 438
 439 /**
 440  * Textual feedback
 441  *
 442  * Functions that provide the textual feedback on the OSD. They are shown on hotkey commands. The feedback
 443  * is also part of the osd_button_t object. The types are declared in the include file
 444  * include/vlc_osd.h
 445  * @see vlc_osd.h
 446  */
 447 VLC_EXPORT( int, osd_ShowTextRelative, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
 448 VLC_EXPORT( int, osd_ShowTextAbsolute, ( spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
 449 VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
 450
 451 /**
 452  * Default feedback images
 453  *
 454  * Functions that provide the default OSD feedback images on hotkey commands. These feedback
 455  * images are also part of the osd_button_t object. The types are declared in the include file
 456  * include/vlc_osd.h
 457  * @see vlc_osd.h
 458  */
 459 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, short ) );
 460 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, short ) );
 461
 462 /**
 463  * Loading and parse the OSD Configuration file
 464  *
 465  * These functions load/unload the OSD menu configuration file and create/destroy the
 466  * themable OSD menu structure on the OSD object.
 467  */
 468 VLC_EXPORT( int,  osd_ConfigLoader, ( vlc_object_t *, const char *, osd_menu_t ** ) );
 469 VLC_EXPORT( void, osd_ConfigUnload, ( vlc_object_t *, osd_menu_t ** ) );
 470
 471 # ifdef __cplusplus
 472 }
 473 # endif
 474
 475 #endif /* _VLC_OSD_H */