Include dependency graph for vlc_osd.h:
Go to the source code of this file.
Data Structures | |
| struct | spu_t |
| Subpicture unit descriptor. More... | |
| struct | text_style_t |
| Text style. More... | |
| struct | osd_state_t |
| OSD State object. More... | |
| struct | osd_button_t |
| OSD Button object. More... | |
| struct | osd_menu_state_t |
| OSD Menu State object. More... | |
| struct | osd_menu_t |
| OSD Menu object. More... | |
Defines | |
| #define | VLC_OSD_H 1 |
| #define | spu_Create(a) __spu_Create(VLC_OBJECT(a)) |
| #define | spu_CreateRegion(a, b) __spu_CreateRegion(VLC_OBJECT(a),b) |
| #define | spu_MakeRegion(a, b, c) __spu_MakeRegion(VLC_OBJECT(a),b,c) |
| #define | spu_DestroyRegion(a, b) __spu_DestroyRegion(VLC_OBJECT(a),b) |
| #define | OSD_ALIGN_LEFT 0x1 |
| OSD menu position and picture type defines. | |
| #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 |
| #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 |
| #define | OSD_BUTTON_UNSELECT 0 |
| OSD menu button states. | |
| #define | OSD_BUTTON_SELECT 1 |
| #define | OSD_BUTTON_PRESSED 2 |
| #define | OSD_MENU_STYLE_SIMPLE 0x0 |
| OSD Menu Style. | |
| #define | OSD_MENU_STYLE_CONCAT 0x1 |
| #define | osd_MenuCreate(object, file) __osd_MenuCreate( VLC_OBJECT(object), file ) |
| #define | osd_MenuDelete(object, osd) __osd_MenuDelete( VLC_OBJECT(object), osd ) |
| #define | osd_ButtonFind(object, x, y, h, w, sh, sw) __osd_ButtonFind(object,x,y,h,w,sh,sw) |
| #define | osd_ButtonSelect(object, button) __osd_ButtonSelect(object,button) |
| #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_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_Volume(object) __osd_Volume( VLC_OBJECT(object) ) |
| #define | vout_OSDMessage(obj, chan,...) __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ ) |
| Same as __vlc_OSDMessage() but with automatic casting. | |
Enumerations | |
| enum | spu_query_e { SPU_CHANNEL_REGISTER, SPU_CHANNEL_CLEAR } |
Functions | |
| static int | spu_vaControl (spu_t *p_spu, int i_query, va_list args) |
| static int | spu_Control (spu_t *p_spu, int i_query,...) |
| spu_t * | __spu_Create (vlc_object_t *) |
| Creates the subpicture unit. | |
| int | spu_Init (spu_t *) |
| Initialise the subpicture unit. | |
| void | spu_Destroy (spu_t *) |
| Destroy the subpicture unit. | |
| void | spu_Attach (spu_t *, vlc_object_t *, bool) |
| Attach/Detach the SPU from any input. | |
| subpicture_t * | spu_CreateSubpicture (spu_t *) |
| Allocate a subpicture in the spu heap. | |
| void | spu_DestroySubpicture (spu_t *, subpicture_t *) |
| Remove a subpicture from the heap. | |
| void | spu_DisplaySubpicture (spu_t *, subpicture_t *) |
| Display a subpicture. | |
| subpicture_region_t * | __spu_CreateRegion (vlc_object_t *, video_format_t *) |
| subpicture_region_t * | __spu_MakeRegion (vlc_object_t *, video_format_t *, picture_t *) |
| Make a subpicture region from an existing picture_t. | |
| void | __spu_DestroyRegion (vlc_object_t *, subpicture_region_t *) |
| Destroy a subpicture region. | |
| subpicture_t * | spu_SortSubpictures (spu_t *, mtime_t, bool) |
| void | spu_RenderSubpictures (spu_t *, video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int) |
| osd_menu_t * | __osd_MenuCreate (vlc_object_t *, const char *) |
| Initialize an osd_menu_t object. | |
| void | __osd_MenuDelete (vlc_object_t *, osd_menu_t *) |
| Delete the osd_menu_t object. | |
| osd_button_t * | __osd_ButtonFind (vlc_object_t *p_this, int, int, int, int, int, int) |
| Find OSD Menu button at position x,y. | |
| void | __osd_ButtonSelect (vlc_object_t *, osd_button_t *) |
| Select the button provided as the new active button. | |
| void | __osd_MenuShow (vlc_object_t *) |
| Show the OSD menu. | |
| void | __osd_MenuHide (vlc_object_t *) |
| Hide the OSD menu. | |
| void | __osd_MenuActivate (vlc_object_t *) |
| Activate the action of this OSD menu item. | |
| void | __osd_MenuNext (vlc_object_t *) |
| Next OSD menu item. | |
| void | __osd_MenuPrev (vlc_object_t *) |
| Previous OSD menu item. | |
| void | __osd_MenuUp (vlc_object_t *) |
| OSD menu item above. | |
| void | __osd_MenuDown (vlc_object_t *) |
| OSD menu item below. | |
| void | __osd_Volume (vlc_object_t *) |
| Display the audio volume bitmap. | |
| static const osd_menu_state_t * | osd_GetMenuState (osd_menu_t *p_osd) |
| Retrieve a non modifyable pointer to the OSD Menu state. | |
| static bool | osd_GetKeyPressed (osd_menu_t *p_osd) |
| Get the last key press received by the OSD Menu. | |
| static void | osd_SetKeyPressed (vlc_object_t *p_this, int i_value) |
| Set the key pressed to a value. | |
| static void | osd_SetMenuVisible (osd_menu_t *p_osd, bool b_value) |
| Update the OSD Menu visibility flag. | |
| static void | osd_SetMenuUpdate (osd_menu_t *p_osd, bool b_value) |
| Update the OSD Menu update flag. | |
| int | osd_ShowTextRelative (spu_t *, int, char *, text_style_t *, int, int, int, mtime_t) |
| Textual feedback. | |
| int | osd_ShowTextAbsolute (spu_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t) |
| Show text on the video from a given start date to a given end date. | |
| void | osd_Message (spu_t *, int, char *,...) |
| Write an informative message at the default location, for the default duration and only if the OSD option is enabled. | |
| int | osd_Slider (vlc_object_t *, spu_t *, int, int, int, int, int, int, short) |
| Default feedback images. | |
| int | osd_Icon (vlc_object_t *, spu_t *, int, int, int, int, int, short) |
| int | vout_ShowTextRelative (vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t) |
| Show text on the video for some time. | |
| int | vout_ShowTextAbsolute (vout_thread_t *, int, const char *, text_style_t *, int, int, int, mtime_t, mtime_t) |
| Show text on the video from a given start date to a given end date. | |
| void | __vout_OSDMessage (vlc_object_t *, int, const char *,...) |
| Write an informative message at the default location, for the default duration and only if the OSD option is enabled. | |
| void | vout_OSDSlider (vlc_object_t *, int, int, short) |
| Display a slider on the video output. | |
| void | vout_OSDIcon (vlc_object_t *, int, short) |
| Display an Icon on the video output. | |
Variables | |
| static const text_style_t | default_text_style |
| #define VLC_OSD_H 1 |
| #define vout_OSDMessage | ( | obj, | |||
| chan, | |||||
| ... | ) | __vout_OSDMessage( VLC_OBJECT(obj), chan, __VA_ARGS__ ) |
Same as __vlc_OSDMessage() but with automatic casting.
| void __vout_OSDMessage | ( | vlc_object_t * | p_caller, | |
| int | i_channel, | |||
| const char * | psz_format, | |||
| ... | ||||
| ) |
Write an informative message at the default location, for the default duration and only if the OSD option is enabled.
| p_caller | The object that called the function. | |
| i_channel | Subpicture channel | |
| psz_format | printf style formatting |
| void vout_OSDIcon | ( | vlc_object_t * | , | |
| int | , | |||
| short | ||||
| ) |
Display an Icon on the video output.
| p_this | The object that called the function. | |
| i_channel | Subpicture channel | |
| i_type | Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON |
| void vout_OSDSlider | ( | vlc_object_t * | , | |
| int | , | |||
| int | , | |||
| short | ||||
| ) |
Display a slider on the video output.
| p_this | The object that called the function. | |
| i_channel | Subpicture channel | |
| i_postion | Current position in the slider | |
| i_type | Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER. |
| int vout_ShowTextAbsolute | ( | vout_thread_t * | p_vout, | |
| int | i_channel, | |||
| const char * | psz_string, | |||
| text_style_t * | p_style, | |||
| int | i_flags, | |||
| int | i_hmargin, | |||
| int | i_vmargin, | |||
| mtime_t | i_start, | |||
| mtime_t | i_stop | |||
| ) |
Show text on the video from a given start date to a given end date.
| p_vout | pointer to the vout the text is to be showed on | |
| i_channel | Subpicture channel | |
| psz_string | The text to be shown | |
| p_style | Pointer to a struct with text style info | |
| i_flags | flags for alignment and such | |
| i_hmargin | horizontal margin in pixels | |
| i_vmargin | vertical margin in pixels | |
| i_start | the time when this string is to appear on the video | |
| i_stop | the time when this string should stop to be displayed if this is 0 the string will be shown untill the next string is about to be shown |
| int vout_ShowTextRelative | ( | vout_thread_t * | p_vout, | |
| int | i_channel, | |||
| char * | psz_string, | |||
| text_style_t * | p_style, | |||
| int | i_flags, | |||
| int | i_hmargin, | |||
| int | i_vmargin, | |||
| mtime_t | i_duration | |||
| ) |
Show text on the video for some time.
| p_vout | pointer to the vout the text is to be showed on | |
| i_channel | Subpicture channel | |
| psz_string | The text to be shown | |
| p_style | Pointer to a struct with text style info | |
| i_flags | flags for alignment and such | |
| i_hmargin | horizontal margin in pixels | |
| i_vmargin | vertical margin in pixels | |
| i_duration | Amount of time the text is to be shown. |
1.5.1