osdmenu.c File Reference

Include dependency graph for osdmenu.c:


Data Structures

struct  filter_sys_t
 filter_sys_t: chroma method descriptor More...

Defines

#define OSD_FILE_TEXT   N_("Configuration file")
#define OSD_FILE_LONGTEXT
#define OSD_PATH_TEXT   N_("Path to OSD menu images")
#define OSD_PATH_LONGTEXT
#define POSX_TEXT   N_("X coordinate")
#define POSX_LONGTEXT   N_("You can move the OSD menu by left-clicking on it." )
#define POSY_TEXT   N_("Y coordinate")
#define POSY_LONGTEXT   N_("You can move the OSD menu by left-clicking on it." )
#define POS_TEXT   N_("Menu position")
#define POS_LONGTEXT
#define TIMEOUT_TEXT   N_("Menu timeout")
#define TIMEOUT_LONGTEXT
#define OSD_UPDATE_TEXT   N_("Menu update interval" )
#define OSD_UPDATE_LONGTEXT
#define OSD_ALPHA_TEXT   N_("Alpha transparency value (default 255)")
#define OSD_ALPHA_LONGTEXT
#define OSD_CFG   "osdmenu-"
#define OSD_DEFAULT_CFG   "share/osdmenu/default.cfg"
#define OSD_UPDATE_MIN   0
#define OSD_UPDATE_DEFAULT   300
#define OSD_UPDATE_MAX   1000
#define ARRAY_SIZE(x)   (sizeof(x) / sizeof((x)[0]))

Functions

static int CreateFilter (vlc_object_t *)
static void DestroyFilter (vlc_object_t *)
static subpicture_t * Filter (filter_t *, mtime_t)
static int OSDMenuUpdateEvent (vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *)
static int OSDMenuVisibleEvent (vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *)
static int OSDMenuCallback (vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *)
static int MouseEvent (filter_t *, const vlc_mouse_t *, const vlc_mouse_t *, const video_format_t *)
int vlc_entry__main (module_t *p_module)
const char * vlc_entry_license__main (void)
static subpicture_region_t * create_picture_region (filter_t *p_filter, subpicture_t *p_spu, int i_width, int i_height, picture_t *p_pic)

Variables

static const int pi_pos_values [] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 }
static const char *const ppsz_pos_descriptions []

Define Documentation

#define ARRAY_SIZE ( x   )     (sizeof(x) / sizeof((x)[0]))

#define OSD_ALPHA_LONGTEXT

Value:

N_( \
    "The transparency of the OSD menu can be changed by giving a value " \
    "between 0 and 255. A lower value specifies more transparency a higher " \
    "means less transparency. The default is being not transparent " \
    "(value 255) the minimum is fully transparent (value 0)." )

#define OSD_ALPHA_TEXT   N_("Alpha transparency value (default 255)")

#define OSD_CFG   "osdmenu-"

Referenced by CreateFilter(), DestroyFilter(), and OSDMenuCallback().

#define OSD_DEFAULT_CFG   "share/osdmenu/default.cfg"

#define OSD_FILE_LONGTEXT

Value:

N_( \
    "Configuration file for the OSD Menu." )

#define OSD_FILE_TEXT   N_("Configuration file")

#define OSD_PATH_LONGTEXT

Value:

N_( \
    "Path to the OSD menu images. This will override the path defined in the " \
    "OSD configuration file." )

#define OSD_PATH_TEXT   N_("Path to OSD menu images")

#define OSD_UPDATE_DEFAULT   300

#define OSD_UPDATE_LONGTEXT

Value:

N_( \
    "The default is to update the OSD menu picture every 200 ms. Shorten the" \
    " update time for environments that experience transmissions errors. " \
    "Be careful with this option as encoding OSD menu pictures is very " \
    "computing intensive. The range is 0 - 1000 ms." )

#define OSD_UPDATE_MAX   1000

#define OSD_UPDATE_MIN   0

#define OSD_UPDATE_TEXT   N_("Menu update interval" )

#define POS_LONGTEXT

Value:

N_( \
  "You can enforce the OSD menu position on the video " \
  "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  "also use combinations of these values, eg. 6 = top-right).")

#define POS_TEXT   N_("Menu position")

#define POSX_LONGTEXT   N_("You can move the OSD menu by left-clicking on it." )

#define POSX_TEXT   N_("X coordinate")

#define POSY_LONGTEXT   N_("You can move the OSD menu by left-clicking on it." )

#define POSY_TEXT   N_("Y coordinate")

#define TIMEOUT_LONGTEXT

Value:

N_( \
    "OSD menu pictures get a default timeout of 15 seconds added to their " \
    "remaining time. This will ensure that they are at least the specified " \
    "time visible.")

#define TIMEOUT_TEXT   N_("Menu timeout")

Function Documentation

static subpicture_region_t* create_picture_region ( filter_t *  p_filter,
subpicture_t *  p_spu,
int  i_width,
int  i_height,
picture_t *  p_pic 
) [static]

References subpicture_region_t::fmt, subpicture_region_t::i_align, filter_sys_t::i_alpha, subpicture_region_t::i_alpha, video_format_t::i_chroma, video_palette_t::i_entries, video_format_t::i_height, filter_sys_t::i_position, video_format_t::i_sar_den, video_format_t::i_sar_num, video_format_t::i_visible_height, video_format_t::i_visible_width, video_format_t::i_width, subpicture_region_t::i_x, video_format_t::i_x_offset, subpicture_region_t::i_y, video_format_t::i_y_offset, msg_Dbg, msg_Err, video_format_t::p_palette, subpicture_region_t::p_picture, filter_t::p_sys, picture_Copy(), subpicture_region_New(), VLC_CODEC_YUVA, and VLC_CODEC_YUVP.

Referenced by Filter().

static int CreateFilter ( vlc_object_t *  p_this  )  [static]

References filter_sys_t::b_absolute, filter_sys_t::b_clicked, filter_sys_t::b_update, filter_sys_t::b_visible, es_format_Init(), Filter(), filter_t::fmt_out, filter_sys_t::i_alpha, filter_sys_t::i_last_date, osd_menu_t::i_position, filter_sys_t::i_position, es_format_t::i_priority, filter_sys_t::i_timeout, filter_sys_t::i_update, osd_menu_t::i_x, filter_sys_t::i_x, osd_menu_t::i_y, filter_sys_t::i_y, mdate(), MouseEvent(), msg_Err, OSD_CFG, osd_MenuCreate, OSDMenuCallback(), OSDMenuUpdateEvent(), OSDMenuVisibleEvent(), filter_sys_t::p_menu, filter_t::p_sys, p_sys, filter_sys_t::psz_file, filter_sys_t::psz_path, SPU_ES, var_AddCallback, var_CreateGetIntegerCommand, var_CreateGetString, VLC_CODEC_SPU, VLC_EGENERIC, VLC_ENOMEM, and VLC_SUCCESS.

static void DestroyFilter ( vlc_object_t *  p_this  )  [static]

References OSD_CFG, osd_MenuDelete, OSDMenuCallback(), OSDMenuUpdateEvent(), OSDMenuVisibleEvent(), filter_sys_t::p_menu, filter_t::p_sys, p_sys, filter_sys_t::psz_file, filter_sys_t::psz_path, var_DelCallback, and var_Destroy.

static subpicture_t * Filter ( filter_t *  p_filter,
mtime_t  i_date 
) [static]

References filter_sys_t::b_absolute, subpicture_t::b_absolute, filter_sys_t::b_clicked, subpicture_t::b_ephemer, subpicture_t::b_fade, filter_sys_t::b_update, filter_sys_t::b_visible, create_picture_region(), filter_NewSubpicture(), subpicture_region_t::fmt, filter_sys_t::i_alpha, subpicture_t::i_alpha, filter_sys_t::i_end_date, osd_menu_state_t::i_height, filter_sys_t::i_last_date, subpicture_t::i_start, subpicture_t::i_stop, osd_menu_t::i_style, filter_sys_t::i_timeout, filter_sys_t::i_update, plane_t::i_visible_lines, plane_t::i_visible_pitch, video_format_t::i_visible_width, osd_menu_state_t::i_width, subpicture_region_t::i_x, osd_menu_state_t::i_x, osd_button_t::i_x, subpicture_region_t::i_y, osd_menu_state_t::i_y, osd_button_t::i_y, OSD_MENU_STYLE_CONCAT, osd_MenuActivate, picture_t::p, osd_menu_t::p_button, osd_button_t::p_current_state, filter_sys_t::p_menu, osd_button_t::p_next, subpicture_region_t::p_next, osd_state_t::p_pic, osd_menu_state_t::p_pic, subpicture_t::p_region, osd_menu_t::p_state, filter_t::p_sys, p_sys, osd_menu_state_t::p_visible, osd_button_t::psz_action, subpicture_region_ChainDelete(), subpicture_region_Delete(), and Y_PLANE.

static int MouseEvent ( filter_t *  p_filter,
const vlc_mouse_t *  p_old,
const vlc_mouse_t *  p_new,
const video_format_t *  p_fmt 
) [static]

References filter_sys_t::b_clicked, filter_sys_t::b_update, filter_sys_t::b_visible, video_format_t::i_height, video_format_t::i_width, vlc_mouse_t::i_x, vlc_mouse_t::i_y, MOUSE_BUTTON_LEFT, msg_Dbg, osd_ButtonFind, osd_ButtonSelect, filter_t::p_sys, p_sys, osd_button_t::psz_name, vlc_mouse_HasPressed(), VLC_OBJECT, and VLC_SUCCESS.

static int OSDMenuCallback ( vlc_object_t *  p_this,
char const *  psz_var,
vlc_value_t  oldval,
vlc_value_t  newval,
void *  p_data 
) [static]

References ARRAY_SIZE, filter_sys_t::b_absolute, filter_sys_t::b_update, filter_sys_t::b_visible, i, filter_sys_t::i_alpha, vlc_value_t::i_int, filter_sys_t::i_position, filter_sys_t::i_update, osd_menu_t::i_x, filter_sys_t::i_x, osd_menu_t::i_y, filter_sys_t::i_y, OSD_CFG, filter_sys_t::p_menu, p_sys, pi_pos_values, VLC_SUCCESS, and VLC_UNUSED.

Referenced by CreateFilter(), and DestroyFilter().

static int OSDMenuUpdateEvent ( vlc_object_t *  p_this,
char const *  psz_var,
vlc_value_t  oldval,
vlc_value_t  newval,
void *  p_data 
) [static]

References filter_sys_t::b_update, filter_sys_t::b_visible, filter_sys_t::i_end_date, filter_t::p_sys, p_sys, VLC_SUCCESS, and VLC_UNUSED.

Referenced by CreateFilter(), and DestroyFilter().

static int OSDMenuVisibleEvent ( vlc_object_t *  p_this,
char const *  psz_var,
vlc_value_t  oldval,
vlc_value_t  newval,
void *  p_data 
) [static]

References filter_sys_t::b_update, filter_sys_t::b_visible, filter_t::p_sys, VLC_SUCCESS, and VLC_UNUSED.

Referenced by CreateFilter(), and DestroyFilter().

int vlc_entry__main ( module_t *  p_module  ) 

const char* vlc_entry_license__main ( void   ) 

Variable Documentation

const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 } [static]

const char* const ppsz_pos_descriptions[] [static]

Initial value:

{ N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") }

Generated on Tue May 25 08:05:31 2010 for VLC by  doxygen 1.5.6