/*****************************************************************************
* marq.c : marquee display video plugin for vlc
*****************************************************************************
- * Copyright (C) 2003-2008 the VideoLAN team
+ * Copyright (C) 2003-2008 VLC authors and VideoLAN
* $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
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
#include <vlc_common.h>
#include <vlc_plugin.h>
-#include <vlc_vout.h>
-#include "vlc_filter.h"
-#include "vlc_block.h"
-#include "vlc_osd.h"
+#include <vlc_filter.h>
+#include <vlc_block.h>
+#include <vlc_fs.h>
-#include "vlc_strings.h"
+#include <vlc_strings.h>
/*****************************************************************************
* Local prototypes
static void DestroyFilter( vlc_object_t * );
static subpicture_t *Filter( filter_t *, mtime_t );
-
+static char *MarqueeReadFile( filter_t *, const char * );
static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
vlc_value_t oldval, vlc_value_t newval,
void *p_data );
*****************************************************************************/
struct filter_sys_t
{
+ vlc_mutex_t lock;
+
int i_xoff, i_yoff; /* offsets for the display string in the video window */
int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
int i_timeout;
- char *psz_marquee; /* marquee string */
+ char *format; /**< marquee text format */
+ char *filepath; /**< marquee file path */
+ char *message; /**< marquee plain text */
text_style_t *p_style; /* font control */
mtime_t last_time;
mtime_t i_refresh;
-
- bool b_need_update;
};
#define MSG_TEXT N_("Text")
"$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 FILE_TEXT N_("Text file")
+#define FILE_LONGTEXT N_("File to read the marquee text from.")
#define POSX_TEXT N_("X offset")
#define POSX_LONGTEXT N_("X offset, from the left screen edge." )
#define POSY_TEXT N_("Y offset")
"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 " \
+ "This is mainly useful when using meta data " \
"or time format string sequences.")
#define OPACITY_TEXT N_("Opacity")
#define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
#define CFG_PREFIX "marq-"
+#define MARQUEE_HELP N_("Display text above the video")
+
/*****************************************************************************
* Module descriptor
*****************************************************************************/
vlc_module_begin ()
- set_capability( "sub filter", 0 )
+ set_capability( "sub source", 0 )
set_shortname( N_("Marquee" ))
+ set_description( N_("Marquee display") )
+ set_help(MARQUEE_HELP)
set_callbacks( CreateFilter, DestroyFilter )
set_category( CAT_VIDEO )
set_subcategory( SUBCAT_VIDEO_SUBPIC )
- add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
- false );
+ add_string( CFG_PREFIX "marquee", "VLC", MSG_TEXT, MSG_LONGTEXT,
+ false )
+ add_loadfile( CFG_PREFIX "file", NULL, FILE_TEXT, FILE_LONGTEXT, true )
set_section( N_("Position"), NULL )
- 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, NULL );
+ add_integer( CFG_PREFIX "x", 0, POSX_TEXT, POSX_LONGTEXT, true )
+ add_integer( CFG_PREFIX "y", 0, POSY_TEXT, POSY_LONGTEXT, true )
+ add_integer( CFG_PREFIX "position", -1, POS_TEXT, POS_LONGTEXT, false )
+ change_integer_list( pi_pos_values, ppsz_pos_descriptions )
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, false );
- add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
- false );
- change_integer_list( pi_color_values, ppsz_color_descriptions, NULL );
- add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
- false );
+ add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255,
+ OPACITY_TEXT, OPACITY_LONGTEXT, false )
+ add_rgb( CFG_PREFIX "color", 0xFFFFFF, COLOR_TEXT, COLOR_LONGTEXT,
+ false )
+ change_integer_list( pi_color_values, ppsz_color_descriptions )
+ add_integer( CFG_PREFIX "size", -1, SIZE_TEXT, SIZE_LONGTEXT,
+ false )
+ change_integer_range( -1, 4096)
set_section( N_("Misc"), NULL )
- add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
- false );
- add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
- REFRESH_LONGTEXT, false );
+ add_integer( CFG_PREFIX "timeout", 0, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
+ false )
+ add_integer( CFG_PREFIX "refresh", 1000, REFRESH_TEXT,
+ REFRESH_LONGTEXT, false )
- set_description( N_("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 *const ppsz_filter_options[] = {
"marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
+ "opacity",
NULL
};
if( p_sys == NULL )
return VLC_ENOMEM;
- p_sys->p_style = malloc( sizeof( text_style_t ) );
- memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
+ vlc_mutex_init( &p_sys->lock );
+ p_sys->p_style = text_style_New();
config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
p_filter->p_cfg );
+
#define CREATE_VAR( stor, type, var ) \
p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
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" );
- p_sys->i_refresh *= 1000;
+ p_sys->i_refresh = 1000 * var_CreateGetIntegerCommand( p_filter,
+ "marq-refresh" );
+ var_AddCallback( p_filter, "marq-refresh", MarqueeCallback, p_sys );
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( format, String, "marq-marquee" );
+ p_sys->filepath = var_InheritString( p_filter, "marq-file" );
+ p_sys->message = NULL;
+ p_sys->p_style->i_font_alpha = var_CreateGetIntegerCommand( p_filter,
+ "marq-opacity" );
+ var_AddCallback( p_filter, "marq-opacity", MarqueeCallback, p_sys );
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_filter->pf_sub_source = Filter;
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;
- free( p_sys->p_style );
- free( p_sys->psz_marquee );
-
/* Delete the marquee variables */
#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-refresh" );
DEL_VAR( "marq-position" );
- DEL_VAR( "marq-color" );
+ DEL_VAR( "marq-marquee" );
DEL_VAR( "marq-opacity" );
+ DEL_VAR( "marq-color" );
DEL_VAR( "marq-size" );
+ vlc_mutex_destroy( &p_sys->lock );
+ text_style_Delete( p_sys->p_style );
+ free( p_sys->format );
+ free( p_sys->filepath );
+ free( p_sys->message );
free( p_sys );
}
subpicture_t *p_spu = NULL;
video_format_t fmt;
+ vlc_mutex_lock( &p_sys->lock );
if( p_sys->last_time + p_sys->i_refresh > date )
- return NULL;
+ goto out;
- vlc_object_lock( p_filter );
- if( p_sys->b_need_update == false )
+ if( p_sys->filepath != NULL )
+ {
+ char *fmt = MarqueeReadFile( p_filter, p_sys->filepath );
+ if( fmt != NULL )
+ {
+ free( p_sys->format );
+ p_sys->format = fmt;
+ }
+ }
+
+ char *msg = str_format_time( p_sys->format ? p_sys->format : "" );
+ if( unlikely( msg == NULL ) )
+ goto out;
+ if( p_sys->message != NULL && !strcmp( msg, p_sys->message ) )
+ {
+ free( msg );
goto out;
+ }
+ free( p_sys->message );
+ p_sys->message = msg;
p_spu = filter_NewSubpicture( p_filter );
if( !p_spu )
goto out;
memset( &fmt, 0, sizeof(video_format_t) );
- fmt.i_chroma = VLC_FOURCC('T','E','X','T');
- fmt.i_aspect = 0;
+ fmt.i_chroma = VLC_CODEC_TEXT;
fmt.i_width = fmt.i_height = 0;
fmt.i_x_offset = 0;
fmt.i_y_offset = 0;
p_sys->last_time = date;
- if( !strchr( p_sys->psz_marquee, '%' )
- && !strchr( p_sys->psz_marquee, '$' ) )
- p_sys->b_need_update = false;
-
- p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
+ p_spu->p_region->psz_text = strdup( msg );
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 = 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->p_region->i_align = SUBPICTURE_ALIGN_LEFT | SUBPICTURE_ALIGN_TOP;
p_spu->b_absolute = true;
}
else
p_spu->p_region->i_x = p_sys->i_xoff;
p_spu->p_region->i_y = p_sys->i_yoff;
- p_spu->p_region->p_style = p_sys->p_style;
+ p_spu->p_region->p_style = text_style_Duplicate( p_sys->p_style );
out:
- vlc_object_unlock( p_filter );
+ vlc_mutex_unlock( &p_sys->lock );
return p_spu;
}
+static char *MarqueeReadFile( filter_t *obj, const char *path )
+{
+ FILE *stream = vlc_fopen( path, "rt" );
+ if( stream == NULL )
+ {
+ msg_Err( obj, "cannot open %s: %m", path );
+ return NULL;
+ }
+
+ char *line = NULL;
+
+ ssize_t len = getline( &line, &(size_t){ 0 }, stream );
+ if( len == -1 )
+ {
+ msg_Err( obj, "cannot read %s: %m", path );
+ clearerr( stream );
+ line = NULL;
+ }
+ fclose( stream );
+
+ if( len >= 1 && line[len - 1] == '\n' )
+ line[--len] = '\0';
+ return line;
+}
+
/**********************************************************************
* Callback to update params on the fly
**********************************************************************/
vlc_value_t oldval, vlc_value_t newval,
void *p_data )
{
- VLC_UNUSED(oldval);
filter_sys_t *p_sys = (filter_sys_t *) p_data;
- vlc_object_lock( p_this );
- if( !strncmp( psz_var, "marq-marquee", 7 ) )
+ VLC_UNUSED(oldval);
+ VLC_UNUSED(p_this);
+
+ vlc_mutex_lock( &p_sys->lock );
+ if( !strcmp( psz_var, "marq-marquee" ) )
{
- free( p_sys->psz_marquee );
- p_sys->psz_marquee = strdup( newval.psz_string );
+ free( p_sys->format );
+ p_sys->format = strdup( newval.psz_string );
}
- else if ( !strncmp( psz_var, "marq-x", 6 ) )
+ else if ( !strcmp( psz_var, "marq-x" ) )
{
p_sys->i_xoff = newval.i_int;
}
- else if ( !strncmp( psz_var, "marq-y", 6 ) )
+ else if ( !strcmp( psz_var, "marq-y" ) )
{
p_sys->i_yoff = newval.i_int;
}
- else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
+ else if ( !strcmp( psz_var, "marq-color" ) )
{
p_sys->p_style->i_font_color = newval.i_int;
}
- else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
+ else if ( !strcmp( psz_var, "marq-opacity" ) )
{
- p_sys->p_style->i_font_alpha = 255 - newval.i_int;
+ p_sys->p_style->i_font_alpha = newval.i_int;
}
- else if ( !strncmp( psz_var, "marq-size", 6 ) )
+ else if ( !strcmp( psz_var, "marq-size" ) )
{
p_sys->p_style->i_font_size = newval.i_int;
}
- else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
+ else if ( !strcmp( psz_var, "marq-timeout" ) )
{
p_sys->i_timeout = newval.i_int;
}
- else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
+ else if ( !strcmp( psz_var, "marq-refresh" ) )
{
p_sys->i_refresh = newval.i_int * 1000;
}
- else if ( !strncmp( psz_var, "marq-position", 8 ) )
+ else if ( !strcmp( psz_var, "marq-position" ) )
/* 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 = true;
- vlc_object_unlock( p_this );
+
+ free( p_sys->message );
+ p_sys->message = NULL; /* force update */
+
+ vlc_mutex_unlock( &p_sys->lock );
return VLC_SUCCESS;
}
projects / vlc / blobdiff