/*****************************************************************************
* marq.c : marquee display video plugin for vlc
*****************************************************************************
- * Copyright (C) 2003-2005 the VideoLAN team
+ * Copyright (C) 2003-2008 the VideoLAN team
* $Id$
*
* Authors: Mark Moriarty
+ * Sigmund Augdal Helberg <dnumgis@videolan.org>
+ * Antoine Cellerier <dionoea . videolan \ org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <stdlib.h> /* malloc(), free() */
-#include <string.h>
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
#include <vlc/vlc.h>
-#include <vlc/vout.h>
+#include <vlc_plugin.h>
+#include <vlc_vout.h>
#include "vlc_filter.h"
#include "vlc_block.h"
#include "vlc_osd.h"
+#include "vlc_strings.h"
+
/*****************************************************************************
* Local prototypes
*****************************************************************************/
0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
0x00000080, 0x000000FF, 0x0000FFFF};
-static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
+static const char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
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 MSG_LONGTEXT N_("Marquee text to display")
+#define MSG_LONGTEXT N_( \
+ "Marquee text to display. " \
+ "(Available format strings: " \
+ "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
+ "%M = minute, %S = second, ... " \
+ "Meta data related: $a = artist, $b = album, $c = copyright, " \
+ "$d = description, $e = encoded by, $g = genre, " \
+ "$l = language, $n = track num, $p = now playing, " \
+ "$r = rating, $s = subtitles language, $t = title, "\
+ "$u = url, $A = date, " \
+ "$B = audio bitrate (in kb/s), $C = chapter," \
+ "$D = duration, $F = full name with path, $I = title, "\
+ "$L = time left, " \
+ "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
+ "$S = audio sample rate (in kHz), " \
+ "$T = time, $U = publisher, $V = volume, $_ = new line) ")
#define POSX_TEXT N_("X offset")
-#define POSX_LONGTEXT N_("X offset, from the left screen edge" )
+#define POSX_LONGTEXT N_("X offset, from the left screen edge." )
#define POSY_TEXT N_("Y offset")
-#define POSY_LONGTEXT N_("Y offset, down from the top" )
+#define POSY_LONGTEXT N_("Y offset, down from the top." )
#define TIMEOUT_TEXT N_("Timeout")
#define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
- "display. Default value is " \
+ "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 " \
- "overlay text. 0 = transparent, 255 = totally opaque. " )
+ "overlayed text. 0 = transparent, 255 = totally opaque. " )
#define SIZE_TEXT N_("Font size, pixels")
#define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
"font size)." )
"also use combinations of these values, eg 6 = top-right).")
static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
-static char *ppsz_pos_descriptions[] =
+static const char *ppsz_pos_descriptions[] =
{ N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
+#define CFG_PREFIX "marq-"
+
/*****************************************************************************
* Module descriptor
*****************************************************************************/
vlc_module_begin();
set_capability( "sub filter", 0 );
- set_shortname( N_("Marquee" ));
+ set_shortname( _("Marquee" ));
set_callbacks( CreateFilter, DestroyFilter );
set_category( CAT_VIDEO );
set_subcategory( SUBCAT_VIDEO_SUBPIC );
- add_string( "marq-marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
- VLC_FALSE );
+ add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
+ false );
set_section( N_("Position"), NULL );
- add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
- add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
- add_integer( "marq-position", 5, 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] */
- change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
- add_integer_with_range( "marq-opacity", 255, 0, 255, NULL,
- OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
- add_integer( "marq-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
- VLC_FALSE );
+ add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
+ OPACITY_TEXT, OPACITY_LONGTEXT, false );
+ add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
+ false );
change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
- add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
+ add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
+ false );
set_section( N_("Misc"), NULL );
- add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
- VLC_FALSE );
-
- set_description( _("Marquee display sub filter") );
- add_shortcut( "marq" );
+ add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
+ false );
+ add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
+ REFRESH_LONGTEXT, false );
+
+ set_description( _("Marquee display") );
+ add_shortcut( "time" );
+ add_obsolete_string( "time-format" );
+ add_obsolete_string( "time-x" );
+ add_obsolete_string( "time-y" );
+ add_obsolete_string( "time-position" );
+ add_obsolete_string( "time-opacity" );
+ add_obsolete_string( "time-color" );
+ add_obsolete_string( "time-size" );
vlc_module_end();
+static const char *ppsz_filter_options[] = {
+ "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
+ NULL
+};
+
/*****************************************************************************
* CreateFilter: allocates marquee video filter
*****************************************************************************/
{
filter_t *p_filter = (filter_t *)p_this;
filter_sys_t *p_sys;
- vlc_object_t *p_input;
/* Allocate structure */
p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
return VLC_ENOMEM;
}
- /* Hook used for callback variables */
- p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
- if( !p_input )
- {
- return VLC_ENOOBJ;
- }
-
p_sys->p_style = malloc( sizeof( text_style_t ) );
memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
- p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "marq-x" );
- p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "marq-y" );
- p_sys->i_timeout = var_CreateGetInteger( p_input->p_libvlc , "marq-timeout" );
- p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "marq-position" );
- p_sys->psz_marquee = var_CreateGetString( p_input->p_libvlc, "marq-marquee" );
- p_sys->p_style->i_font_alpha = 255 - var_CreateGetInteger( p_input->p_libvlc , "marq-opacity" );
- p_sys->p_style->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "marq-color" );
- p_sys->p_style->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "marq-size" );
+ config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
+ p_filter->p_cfg );
- var_AddCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-position", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-color", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-opacity", MarqueeCallback, p_sys );
- var_AddCallback( p_input->p_libvlc, "marq-size", MarqueeCallback, p_sys );
+#define CREATE_VAR( stor, type, var ) \
+ p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
+ var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
- vlc_object_release( p_input );
+ 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" );
+ CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
+ CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
+ p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
/* 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;
- vlc_object_t *p_input;
- if( p_sys->p_style ) free( p_sys->p_style );
- if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
- free( p_sys );
+ free( p_sys->p_style );
+ free( p_sys->psz_marquee );
/* Delete the marquee variables */
- p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
- if( !p_input )
- {
- return;
- }
- var_DelCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-position", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-color", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-opacity", MarqueeCallback, p_sys );
- var_DelCallback( p_input->p_libvlc, "marq-size", MarqueeCallback, p_sys );
-
- var_Destroy( p_input->p_libvlc , "marq-marquee" );
- var_Destroy( p_input->p_libvlc , "marq-x" );
- var_Destroy( p_input->p_libvlc , "marq-y" );
- var_Destroy( p_input->p_libvlc , "marq-timeout" );
- var_Destroy( p_input->p_libvlc , "marq-position" );
- var_Destroy( p_input->p_libvlc , "marq-color");
- var_Destroy( p_input->p_libvlc , "marq-opacity");
- var_Destroy( p_input->p_libvlc , "marq-size");
-
- vlc_object_release( p_input );
+#define DEL_VAR(var) \
+ var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
+ var_Destroy( p_filter, var );
+ DEL_VAR( "marq-x" );
+ DEL_VAR( "marq-y" );
+ DEL_VAR( "marq-marquee" );
+ DEL_VAR( "marq-timeout" );
+ DEL_VAR( "marq-position" );
+ DEL_VAR( "marq-color" );
+ DEL_VAR( "marq-opacity" );
+ DEL_VAR( "marq-size" );
+
+ free( p_sys );
}
/****************************************************************************
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;
- p_spu->p_region->psz_text = strdup(p_sys->psz_marquee);
+ if( strchr( p_sys->psz_marquee, '%' ) || strchr( p_sys->psz_marquee, '$' ) )
+ {
+ p_sys->b_need_update = true;
+ }
+ else
+ {
+ 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_xoff < 0 || p_sys->i_yoff < 0 )
- { /* set to one of the 9 relative locations */
- p_spu->i_flags = p_sys->i_pos;
- p_spu->i_x = 0;
- p_spu->i_y = 0;
- p_spu->b_absolute = VLC_FALSE;
+ 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 = true;
}
else
- { /* set to an absolute xy, referenced to upper left corner */
- p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
- p_spu->i_x = p_sys->i_xoff;
- p_spu->i_y = p_sys->i_yoff;
- p_spu->b_absolute = VLC_TRUE;
+ { /* set to one of the 9 relative locations */
+ p_spu->p_region->i_align = p_sys->i_pos;
+ p_spu->b_absolute = false;
}
+
+ p_spu->i_x = p_sys->i_xoff;
+ p_spu->i_y = p_sys->i_yoff;
+
p_spu->p_region->p_style = p_sys->p_style;
- p_sys->b_need_update = VLC_FALSE;
return p_spu;
}
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