* Preamble
*****************************************************************************/
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
#include <vlc/vlc.h>
+#include <vlc_plugin.h>
#include <vlc_vout.h>
#include "vlc_filter.h"
text_style_t *p_style; /* font control */
- time_t last_time;
+ mtime_t last_time;
+ mtime_t i_refresh;
- vlc_bool_t b_need_update;
+ bool b_need_update;
};
#define MSG_TEXT N_("Text")
#define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
"displayed. Default value is " \
"0 (remains forever).")
+#define REFRESH_TEXT N_("Refresh period in ms")
+#define REFRESH_LONGTEXT N_("Number of milliseconds between string updates. " \
+ "This is mainly usefull when using meta data " \
+ "or time format string sequences.")
#define OPACITY_TEXT N_("Opacity")
#define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
"overlayed text. 0 = transparent, 255 = totally opaque. " )
*****************************************************************************/
vlc_module_begin();
set_capability( "sub filter", 0 );
- set_shortname( _("Marquee" ));
+ set_shortname( N_("Marquee" ));
set_callbacks( CreateFilter, DestroyFilter );
set_category( CAT_VIDEO );
set_subcategory( SUBCAT_VIDEO_SUBPIC );
add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
- VLC_FALSE );
+ false );
set_section( N_("Position"), NULL );
- add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
- add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
- add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
+ add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true );
+ add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true );
+ add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false );
change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
set_section( N_("Font"), NULL );
/* 5 sets the default to top [1] left [4] */
add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
- OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
+ OPACITY_TEXT, OPACITY_LONGTEXT, false );
add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
- VLC_FALSE );
+ false );
change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
- VLC_FALSE );
+ false );
set_section( N_("Misc"), NULL );
add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
- VLC_FALSE );
+ false );
+ add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
+ REFRESH_LONGTEXT, false );
- set_description( _("Marquee display") );
+ set_description( N_("Marquee display") );
add_shortcut( "time" );
add_obsolete_string( "time-format" );
add_obsolete_string( "time-x" );
vlc_module_end();
static const char *ppsz_filter_options[] = {
- "marquee", "x", "y", "position", "color", "size", "timeout", NULL
+ "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
+ NULL
};
/*****************************************************************************
CREATE_VAR( i_xoff, Integer, "marq-x" );
CREATE_VAR( i_yoff, Integer, "marq-y" );
CREATE_VAR( i_timeout,Integer, "marq-timeout" );
+ CREATE_VAR( i_refresh,Integer, "marq-refresh" );
CREATE_VAR( i_pos, Integer, "marq-position" );
CREATE_VAR( psz_marquee, String, "marq-marquee" );
CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
/* Misc init */
p_filter->pf_sub_filter = Filter;
- p_sys->last_time = ((time_t)-1);
- p_sys->b_need_update = VLC_TRUE;
+ p_sys->last_time = 0;
+ p_sys->b_need_update = true;
return VLC_SUCCESS;
}
filter_t *p_filter = (filter_t *)p_this;
filter_sys_t *p_sys = p_filter->p_sys;
- if( p_sys->p_style ) free( p_sys->p_style );
- if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
+ free( p_sys->p_style );
+ free( p_sys->psz_marquee );
/* Delete the marquee variables */
#define DEL_VAR(var) \
filter_sys_t *p_sys = p_filter->p_sys;
subpicture_t *p_spu;
video_format_t fmt;
- time_t t;
- if( p_sys->last_time == time( NULL ) )
+ if( p_sys->last_time + p_sys->i_refresh*1000 > date )
{
return NULL;
}
- if( p_sys->b_need_update == VLC_FALSE )
+ if( p_sys->b_need_update == false )
{
return NULL;
}
return NULL;
}
- t = p_sys->last_time = time( NULL );
+ p_sys->last_time = date;
if( strchr( p_sys->psz_marquee, '%' ) || strchr( p_sys->psz_marquee, '$' ) )
{
- p_sys->b_need_update = VLC_TRUE;
+ p_sys->b_need_update = true;
}
else
{
- p_sys->b_need_update = VLC_FALSE;
+ p_sys->b_need_update = false;
}
p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
p_spu->i_start = date;
p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
- p_spu->b_ephemer = VLC_TRUE;
+ p_spu->b_ephemer = true;
/* where to locate the string: */
if( p_sys->i_pos < 0 )
{ /* set to an absolute xy */
p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
- p_spu->b_absolute = VLC_TRUE;
+ p_spu->b_absolute = true;
}
else
{ /* set to one of the 9 relative locations */
p_spu->p_region->i_align = p_sys->i_pos;
- p_spu->b_absolute = VLC_FALSE;
+ p_spu->b_absolute = false;
}
p_spu->i_x = p_sys->i_xoff;
vlc_value_t oldval, vlc_value_t newval,
void *p_data )
{
+ VLC_UNUSED(p_this); VLC_UNUSED(oldval);
filter_sys_t *p_sys = (filter_sys_t *) p_data;
if( !strncmp( psz_var, "marq-marquee", 7 ) )
{
- if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
+ free( p_sys->psz_marquee );
p_sys->psz_marquee = strdup( newval.psz_string );
}
else if ( !strncmp( psz_var, "marq-x", 6 ) )
{
p_sys->i_timeout = newval.i_int;
}
+ else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
+ {
+ p_sys->i_refresh = newval.i_int;
+ }
else if ( !strncmp( psz_var, "marq-position", 8 ) )
/* willing to accept a match against marq-pos */
{
p_sys->i_pos = newval.i_int;
p_sys->i_xoff = -1; /* force to relative positioning */
}
- p_sys->b_need_update = VLC_TRUE;
+ p_sys->b_need_update = true;
return VLC_SUCCESS;
}
projects / vlc / blobdiff