X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=modules%2Fvideo_filter%2Fmarq.c;h=ebf5b5c3c908bfaec69a3219bf8fa0b133843d52;hb=5ebd61f421602d9df5ab47d0044c0d0f32b0156a;hp=5320632c9457d0598f859dbea9b0b76565370488;hpb=13ae40b0efc4f1b1ce205d9a057537047fcab3f4;p=vlc diff --git a/modules/video_filter/marq.c b/modules/video_filter/marq.c index 5320632c94..ebf5b5c3c9 100644 --- a/modules/video_filter/marq.c +++ b/modules/video_filter/marq.c @@ -1,26 +1,26 @@ /***************************************************************************** * 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 * Antoine Cellerier * - * 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. *****************************************************************************/ /***************************************************************************** @@ -31,15 +31,14 @@ # include "config.h" #endif -#include +#include #include -#include -#include "vlc_filter.h" -#include "vlc_block.h" -#include "vlc_osd.h" +#include +#include +#include -#include "vlc_strings.h" +#include /***************************************************************************** * Local prototypes @@ -48,16 +47,18 @@ static int CreateFilter ( vlc_object_t * ); 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 ); -static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0, +static const int pi_color_values[] = { + 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0, 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080, 0x00000080, 0x000000FF, 0x0000FFFF}; -static const char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"), - N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"), +static const char *const 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"), N_("Aqua") }; @@ -67,18 +68,20 @@ static const char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"), *****************************************************************************/ 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") @@ -98,6 +101,8 @@ struct filter_sys_t "$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") @@ -108,7 +113,7 @@ struct filter_sys_t "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 " \ @@ -129,60 +134,59 @@ struct filter_sys_t "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \ "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 const char *ppsz_pos_descriptions[] = +static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 }; +static const char *const 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-" +#define MARQUEE_HELP N_("Display text above the video") + /***************************************************************************** * Module descriptor *****************************************************************************/ -vlc_module_begin(); - set_capability( "sub filter", 0 ); - 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, - false ); - - 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, 0 ); - - set_section( N_("Font"), NULL ); +vlc_module_begin () + 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", 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, 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, 0 ); - add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, - false ); - - 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 ); - - 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 *ppsz_filter_options[] = { + 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, TIMEOUT_TEXT, TIMEOUT_LONGTEXT, + false ) + add_integer( CFG_PREFIX "refresh", 1000, REFRESH_TEXT, + REFRESH_LONGTEXT, false ) + + add_shortcut( "time" ) +vlc_module_end () + +static const char *const ppsz_filter_options[] = { "marquee", "x", "y", "position", "color", "size", "timeout", "refresh", + "opacity", NULL }; @@ -197,17 +201,15 @@ static int CreateFilter( vlc_object_t *p_this ) /* Allocate structure */ p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) ); if( p_sys == NULL ) - { - msg_Err( p_filter, "out of memory" ); 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 ); @@ -215,19 +217,22 @@ static int CreateFilter( vlc_object_t *p_this ) 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 * 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; } @@ -239,22 +244,25 @@ static void DestroyFilter( vlc_object_t *p_this ) 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 ); } @@ -266,46 +274,54 @@ static void DestroyFilter( vlc_object_t *p_this ) static subpicture_t *Filter( filter_t *p_filter, mtime_t date ) { filter_sys_t *p_sys = p_filter->p_sys; - subpicture_t *p_spu; + subpicture_t *p_spu = NULL; video_format_t fmt; - if( p_sys->last_time + p_sys->i_refresh*1000 > date ) + vlc_mutex_lock( &p_sys->lock ); + if( p_sys->last_time + p_sys->i_refresh > date ) + goto out; + + if( p_sys->filepath != NULL ) { - return NULL; + char *fmt = MarqueeReadFile( p_filter, p_sys->filepath ); + if( fmt != NULL ) + { + free( p_sys->format ); + p_sys->format = fmt; + } } - if( p_sys->b_need_update == false ) + 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 ) ) { - return NULL; + free( msg ); + goto out; } + free( p_sys->message ); + p_sys->message = msg; - p_spu = p_filter->pf_sub_buffer_new( p_filter ); - if( !p_spu ) return NULL; + 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_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt ); + p_spu->p_region = subpicture_region_New( &fmt ); if( !p_spu->p_region ) { p_filter->pf_sub_buffer_del( p_filter, p_spu ); - return NULL; + p_spu = NULL; + goto out; } p_sys->last_time = date; - 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->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; @@ -313,7 +329,7 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date ) /* 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 @@ -322,14 +338,41 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date ) 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->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_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 **********************************************************************/ @@ -337,48 +380,55 @@ static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var, 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 ) ) + 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; + 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; + + free( p_sys->message ); + p_sys->message = NULL; /* force update */ + + vlc_mutex_unlock( &p_sys->lock ); return VLC_SUCCESS; }