1 /*****************************************************************************
2 * marq.c : marquee display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2008 the VideoLAN team
7 * Authors: Mark Moriarty
8 * Sigmund Augdal Helberg <dnumgis@videolan.org>
9 * Antoine Cellerier <dionoea . videolan \ org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
37 #include "vlc_filter.h"
38 #include "vlc_block.h"
41 #include "vlc_strings.h"
43 /*****************************************************************************
45 *****************************************************************************/
46 static int CreateFilter ( vlc_object_t * );
47 static void DestroyFilter( vlc_object_t * );
48 static subpicture_t *Filter( filter_t *, mtime_t );
51 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
52 vlc_value_t oldval, vlc_value_t newval,
54 static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
55 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
56 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
57 0x00000080, 0x000000FF, 0x0000FFFF};
58 static const char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
59 N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
60 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
61 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
64 /*****************************************************************************
65 * filter_sys_t: marquee filter descriptor
66 *****************************************************************************/
69 int i_xoff, i_yoff; /* offsets for the display string in the video window */
70 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
73 char *psz_marquee; /* marquee string */
75 text_style_t *p_style; /* font control */
80 vlc_bool_t b_need_update;
83 #define MSG_TEXT N_("Text")
84 #define MSG_LONGTEXT N_( \
85 "Marquee text to display. " \
86 "(Available format strings: " \
87 "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
88 "%M = minute, %S = second, ... " \
89 "Meta data related: $a = artist, $b = album, $c = copyright, " \
90 "$d = description, $e = encoded by, $g = genre, " \
91 "$l = language, $n = track num, $p = now playing, " \
92 "$r = rating, $s = subtitles language, $t = title, "\
93 "$u = url, $A = date, " \
94 "$B = audio bitrate (in kb/s), $C = chapter," \
95 "$D = duration, $F = full name with path, $I = title, "\
97 "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
98 "$S = audio sample rate (in kHz), " \
99 "$T = time, $U = publisher, $V = volume, $_ = new line) ")
100 #define POSX_TEXT N_("X offset")
101 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
102 #define POSY_TEXT N_("Y offset")
103 #define POSY_LONGTEXT N_("Y offset, down from the top." )
104 #define TIMEOUT_TEXT N_("Timeout")
105 #define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
106 "displayed. Default value is " \
107 "0 (remains forever).")
108 #define REFRESH_TEXT N_("Refresh period in ms")
109 #define REFRESH_LONGTEXT N_("Number of milliseconds between string updates. " \
110 "This is mainly usefull when using meta data " \
111 "or time format string sequences.")
112 #define OPACITY_TEXT N_("Opacity")
113 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
114 "overlayed text. 0 = transparent, 255 = totally opaque. " )
115 #define SIZE_TEXT N_("Font size, pixels")
116 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
119 #define COLOR_TEXT N_("Color")
120 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
121 "the video. This must be an hexadecimal (like HTML colors). The first two "\
122 "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
123 " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
125 #define POS_TEXT N_("Marquee position")
126 #define POS_LONGTEXT N_( \
127 "You can enforce the marquee position on the video " \
128 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
129 "also use combinations of these values, eg 6 = top-right).")
131 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
132 static const char *ppsz_pos_descriptions[] =
133 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
134 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
136 #define CFG_PREFIX "marq-"
138 /*****************************************************************************
140 *****************************************************************************/
142 set_capability( "sub filter", 0 );
143 set_shortname( _("Marquee" ));
144 set_callbacks( CreateFilter, DestroyFilter );
145 set_category( CAT_VIDEO );
146 set_subcategory( SUBCAT_VIDEO_SUBPIC );
147 add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
150 set_section( N_("Position"), NULL );
151 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
152 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
153 add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
154 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
156 set_section( N_("Font"), NULL );
157 /* 5 sets the default to top [1] left [4] */
158 add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
159 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
160 add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
162 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
163 add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
166 set_section( N_("Misc"), NULL );
167 add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
169 add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
170 REFRESH_LONGTEXT, VLC_FALSE );
172 set_description( _("Marquee display") );
173 add_shortcut( "time" );
174 add_obsolete_string( "time-format" );
175 add_obsolete_string( "time-x" );
176 add_obsolete_string( "time-y" );
177 add_obsolete_string( "time-position" );
178 add_obsolete_string( "time-opacity" );
179 add_obsolete_string( "time-color" );
180 add_obsolete_string( "time-size" );
183 static const char *ppsz_filter_options[] = {
184 "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
188 /*****************************************************************************
189 * CreateFilter: allocates marquee video filter
190 *****************************************************************************/
191 static int CreateFilter( vlc_object_t *p_this )
193 filter_t *p_filter = (filter_t *)p_this;
196 /* Allocate structure */
197 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
200 msg_Err( p_filter, "out of memory" );
204 p_sys->p_style = malloc( sizeof( text_style_t ) );
205 memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
207 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
210 #define CREATE_VAR( stor, type, var ) \
211 p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
212 var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
214 CREATE_VAR( i_xoff, Integer, "marq-x" );
215 CREATE_VAR( i_yoff, Integer, "marq-y" );
216 CREATE_VAR( i_timeout,Integer, "marq-timeout" );
217 CREATE_VAR( i_refresh,Integer, "marq-refresh" );
218 CREATE_VAR( i_pos, Integer, "marq-position" );
219 CREATE_VAR( psz_marquee, String, "marq-marquee" );
220 CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
221 CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
222 CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
224 p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
227 p_filter->pf_sub_filter = Filter;
228 p_sys->last_time = 0;
229 p_sys->b_need_update = VLC_TRUE;
233 /*****************************************************************************
234 * DestroyFilter: destroy marquee video filter
235 *****************************************************************************/
236 static void DestroyFilter( vlc_object_t *p_this )
238 filter_t *p_filter = (filter_t *)p_this;
239 filter_sys_t *p_sys = p_filter->p_sys;
241 free( p_sys->p_style );
242 free( p_sys->psz_marquee );
244 /* Delete the marquee variables */
245 #define DEL_VAR(var) \
246 var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
247 var_Destroy( p_filter, var );
250 DEL_VAR( "marq-marquee" );
251 DEL_VAR( "marq-timeout" );
252 DEL_VAR( "marq-position" );
253 DEL_VAR( "marq-color" );
254 DEL_VAR( "marq-opacity" );
255 DEL_VAR( "marq-size" );
260 /****************************************************************************
261 * Filter: the whole thing
262 ****************************************************************************
263 * This function outputs subpictures at regular time intervals.
264 ****************************************************************************/
265 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
267 filter_sys_t *p_sys = p_filter->p_sys;
271 if( p_sys->last_time + p_sys->i_refresh*1000 > date )
276 if( p_sys->b_need_update == VLC_FALSE )
281 p_spu = p_filter->pf_sub_buffer_new( p_filter );
282 if( !p_spu ) return NULL;
284 memset( &fmt, 0, sizeof(video_format_t) );
285 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
287 fmt.i_width = fmt.i_height = 0;
290 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
291 if( !p_spu->p_region )
293 p_filter->pf_sub_buffer_del( p_filter, p_spu );
297 p_sys->last_time = date;
299 if( strchr( p_sys->psz_marquee, '%' ) || strchr( p_sys->psz_marquee, '$' ) )
301 p_sys->b_need_update = VLC_TRUE;
305 p_sys->b_need_update = VLC_FALSE;
307 p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
308 p_spu->i_start = date;
309 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
310 p_spu->b_ephemer = VLC_TRUE;
312 /* where to locate the string: */
313 if( p_sys->i_pos < 0 )
314 { /* set to an absolute xy */
315 p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
316 p_spu->b_absolute = VLC_TRUE;
319 { /* set to one of the 9 relative locations */
320 p_spu->p_region->i_align = p_sys->i_pos;
321 p_spu->b_absolute = VLC_FALSE;
324 p_spu->i_x = p_sys->i_xoff;
325 p_spu->i_y = p_sys->i_yoff;
327 p_spu->p_region->p_style = p_sys->p_style;
332 /**********************************************************************
333 * Callback to update params on the fly
334 **********************************************************************/
335 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
336 vlc_value_t oldval, vlc_value_t newval,
339 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
340 filter_sys_t *p_sys = (filter_sys_t *) p_data;
342 if( !strncmp( psz_var, "marq-marquee", 7 ) )
344 free( p_sys->psz_marquee );
345 p_sys->psz_marquee = strdup( newval.psz_string );
347 else if ( !strncmp( psz_var, "marq-x", 6 ) )
349 p_sys->i_xoff = newval.i_int;
351 else if ( !strncmp( psz_var, "marq-y", 6 ) )
353 p_sys->i_yoff = newval.i_int;
355 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
357 p_sys->p_style->i_font_color = newval.i_int;
359 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
361 p_sys->p_style->i_font_alpha = 255 - newval.i_int;
363 else if ( !strncmp( psz_var, "marq-size", 6 ) )
365 p_sys->p_style->i_font_size = newval.i_int;
367 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
369 p_sys->i_timeout = newval.i_int;
371 else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
373 p_sys->i_refresh = newval.i_int;
375 else if ( !strncmp( psz_var, "marq-position", 8 ) )
376 /* willing to accept a match against marq-pos */
378 p_sys->i_pos = newval.i_int;
379 p_sys->i_xoff = -1; /* force to relative positioning */
381 p_sys->b_need_update = VLC_TRUE;