X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=modules%2Fvideo_filter%2Fmarq.c;h=cfcfe31e7cf98bb1e3c284f0138e2d18072f113f;hb=5b323eff127755ed386f5e233819c61edd883507;hp=5935bb46dca8ca50b0acb5cf5cfd786a432b42fb;hpb=f485214f09dd284cbb85674e937fbbb0a6032a2e;p=vlc diff --git a/modules/video_filter/marq.c b/modules/video_filter/marq.c index 5935bb46dc..cfcfe31e7c 100644 --- a/modules/video_filter/marq.c +++ b/modules/video_filter/marq.c @@ -1,10 +1,12 @@ /***************************************************************************** * 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 + * 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 @@ -24,15 +26,18 @@ /***************************************************************************** * Preamble *****************************************************************************/ -#include /* malloc(), free() */ -#include -#include -#include +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif -#include "vlc_filter.h" -#include "vlc_block.h" -#include "vlc_osd.h" +#include +#include + +#include +#include + +#include /***************************************************************************** * Local prototypes @@ -45,12 +50,14 @@ static subpicture_t *Filter( filter_t *, mtime_t ); 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 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") }; @@ -60,6 +67,8 @@ static 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; @@ -68,13 +77,29 @@ struct filter_sys_t 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 POSY_TEXT N_("Y offset") @@ -83,6 +108,10 @@ struct filter_sys_t #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 useful 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. " ) @@ -102,45 +131,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 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( "marq-marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT, - VLC_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 ); - - 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 ) + + 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] */ - 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 ); - change_integer_list( pi_color_values, ppsz_color_descriptions, 0 ); - add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE ); - - set_section( N_("Misc"), NULL ); - add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT, - VLC_FALSE ); - - set_description( _("Marquee display") ); - add_shortcut( "marq" ); -vlc_module_end(); + add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, + OPACITY_TEXT, OPACITY_LONGTEXT, false ) + add_integer( 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 ) + + 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 +}; /***************************************************************************** * CreateFilter: allocates marquee video filter @@ -153,36 +196,37 @@ 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 ) ); - - p_sys->i_xoff = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-x" ); - p_sys->i_yoff = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-y" ); - p_sys->i_timeout = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-timeout" ); - p_sys->i_pos = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-position" ); - p_sys->psz_marquee = var_CreateGetString( p_filter->p_libvlc_global, "marq-marquee" ); - p_sys->p_style->i_font_alpha = 255 - var_CreateGetInteger( p_filter->p_libvlc_global , "marq-opacity" ); - p_sys->p_style->i_font_color = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-color" ); - p_sys->p_style->i_font_size = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-size" ); - - var_AddCallback( p_filter->p_libvlc_global, "marq-x", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-y", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-marquee", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-timeout", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-position", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-color", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-opacity", MarqueeCallback, p_sys ); - var_AddCallback( p_filter->p_libvlc_global, "marq-size", MarqueeCallback, p_sys ); + 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 ); + + p_sys->b_need_update = true; + CREATE_VAR( i_xoff, Integer, "marq-x" ); + CREATE_VAR( i_yoff, Integer, "marq-y" ); + CREATE_VAR( i_timeout,Integer, "marq-timeout" ); + 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" ); + 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" ); /* Misc init */ - p_filter->pf_sub_filter = Filter; - p_sys->last_time = ((time_t)-1); - p_sys->b_need_update = VLC_TRUE; + p_filter->pf_sub_source = Filter; + p_sys->last_time = 0; return VLC_SUCCESS; } @@ -194,28 +238,24 @@ 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; - if( p_sys->p_style ) free( p_sys->p_style ); - if( p_sys->psz_marquee ) free( p_sys->psz_marquee ); - free( p_sys ); - /* Delete the marquee variables */ - var_DelCallback( p_filter->p_libvlc_global, "marq-x", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-y", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-marquee", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-timeout", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-position", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-color", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-opacity", MarqueeCallback, p_sys ); - var_DelCallback( p_filter->p_libvlc_global, "marq-size", MarqueeCallback, p_sys ); - - var_Destroy( p_filter->p_libvlc_global , "marq-marquee" ); - var_Destroy( p_filter->p_libvlc_global , "marq-x" ); - var_Destroy( p_filter->p_libvlc_global , "marq-y" ); - var_Destroy( p_filter->p_libvlc_global , "marq-timeout" ); - var_Destroy( p_filter->p_libvlc_global , "marq-position" ); - var_Destroy( p_filter->p_libvlc_global , "marq-color"); - var_Destroy( p_filter->p_libvlc_global , "marq-opacity"); - var_Destroy( p_filter->p_libvlc_global , "marq-size"); +#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-timeout" ); + DEL_VAR( "marq-refresh" ); + DEL_VAR( "marq-position" ); + 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->psz_marquee ); + free( p_sys ); } /**************************************************************************** @@ -226,61 +266,62 @@ 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; - time_t t; - if( p_sys->last_time == time( NULL ) ) - { - return NULL; - } + vlc_mutex_lock( &p_sys->lock ); + if( p_sys->last_time + p_sys->i_refresh > date ) + goto out; + if( !p_sys->b_need_update ) + goto out; - if( p_sys->b_need_update == VLC_FALSE ) - { - return NULL; - } - - 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; } - 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 = false; - p_spu->p_region->psz_text = strdup(p_sys->psz_marquee); + 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 = SUBPICTURE_ALIGN_LEFT | SUBPICTURE_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->p_region->p_style = p_sys->p_style; - p_sys->b_need_update = VLC_FALSE; + 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 = text_style_Duplicate( p_sys->p_style ); + +out: + vlc_mutex_unlock( &p_sys->lock ); return p_spu; } @@ -293,41 +334,50 @@ static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var, { 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" ) ) { - 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 ) ) + 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-position", 8 ) ) + else if ( !strcmp( psz_var, "marq-refresh" ) ) + { + p_sys->i_refresh = newval.i_int * 1000; + } + 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 = VLC_TRUE; + p_sys->b_need_update = true; + vlc_mutex_unlock( &p_sys->lock ); return VLC_SUCCESS; }