Refactor osdmenu parsing logic.

[vlc] / include / vlc_osd.h

diff --git a/include/vlc_osd.h b/include/vlc_osd.h
index c379e3cb75670396d7703c514993712b0ae975db..0c5f4d15abdfd9437c91a20c17713ee300640b54 100644 (file)
--- a/include/vlc_osd.h
+++ b/include/vlc_osd.h
@@ -88,6 +88,7 @@ static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
     else
         return VLC_EGENERIC;
 }
+
 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
 {
     va_list args;
@@ -146,6 +147,12 @@ VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *,  video_format_t *, picture_t
  *  --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",
@@ -177,8 +184,9 @@ VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *,  video_format_t *, picture_t
  *
  * 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', '-' ]+
  *
@@ -242,10 +250,13 @@ struct text_style_t
     int        i_background_alpha;/**< The transparency of the background.
                                        0x00 is fully opaque,
                                        0xFF fully transparent */
+    int        i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */
+    int        i_karaoke_background_alpha;/**< The transparency of the karaoke bg.
+                                       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 */
@@ -258,9 +269,7 @@ struct text_style_t
 #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 };
-
-
+                0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 0xffffff, 0xff, 1, 0, -1 };
 
 /**
  * OSD menu button states
@@ -276,6 +285,8 @@ static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE
 #define OSD_BUTTON_SELECT   1
 #define OSD_BUTTON_PRESSED  2
 
+static const char *ppsz_button_states[] = { "unselect", "select", "pressed" };
+
 /**
  * OSD State object
  *
@@ -325,6 +336,20 @@ struct osd_button_t
     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 seperate 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
  *
@@ -363,6 +388,7 @@ struct osd_menu_t
     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 */
 
     char             *psz_path;  /*< directory where OSD menu images are stored */
     osd_button_t     *p_button;  /*< doubly linked list of buttons */
@@ -370,6 +396,11 @@ struct osd_menu_t
 
     /* 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 */
 };
 
 /**
@@ -555,7 +586,7 @@ static inline void osd_SetMenuUpdate( osd_menu_t *p_osd, vlc_bool_t b_value )
  */
 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 *, ... ) );
+VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) );
 
 /**
  * Default feedback images
@@ -568,15 +599,6 @@ VLC_EXPORT( void,osd_Message, ( spu_t *, int, char *, ... ) );
 VLC_EXPORT( int, osd_Slider, ( vlc_object_t *, spu_t *, int, int, int, int, int, int, short ) );
 VLC_EXPORT( int, osd_Icon, ( vlc_object_t *, spu_t *, int, int, int, int, int, short ) );
 
-/**
- * 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 ** ) );
-
 /** @} */
 
 /**********************************************************************
@@ -610,7 +632,7 @@ VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_sty
  *               if this is 0 the string will be shown untill the next string
  *               is about to be shown
  */
-VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
+VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
 
 /**
  * Write an informative message at the default location,
@@ -619,7 +641,7 @@ VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, char *, text_sty
  * \param i_channel Subpicture channel
  * \param psz_format printf style formatting
  **/
-VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, char *, ... ) );
+VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, const char *, ... ) ATTRIBUTE_FORMAT( 3, 4 ) );
 
 /**
  * Same as __vlc_OSDMessage() but with automatic casting