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 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
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 const int pi_color_values[] = {
55 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
56 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
57 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
58 0x00000080, 0x000000FF, 0x0000FFFF};
59 static const char *const ppsz_color_descriptions[] = {
60 N_("Default"), N_("Black"), N_("Gray"),
61 N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
62 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
63 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
66 /*****************************************************************************
67 * filter_sys_t: marquee filter descriptor
68 *****************************************************************************/
73 int i_xoff, i_yoff; /* offsets for the display string in the video window */
74 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
77 char *psz_marquee; /* marquee string */
79 text_style_t *p_style; /* font control */
87 #define MSG_TEXT N_("Text")
88 #define MSG_LONGTEXT N_( \
89 "Marquee text to display. " \
90 "(Available format strings: " \
91 "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
92 "%M = minute, %S = second, ... " \
93 "Meta data related: $a = artist, $b = album, $c = copyright, " \
94 "$d = description, $e = encoded by, $g = genre, " \
95 "$l = language, $n = track num, $p = now playing, " \
96 "$r = rating, $s = subtitles language, $t = title, "\
97 "$u = url, $A = date, " \
98 "$B = audio bitrate (in kb/s), $C = chapter," \
99 "$D = duration, $F = full name with path, $I = title, "\
101 "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
102 "$S = audio sample rate (in kHz), " \
103 "$T = time, $U = publisher, $V = volume, $_ = new line) ")
104 #define POSX_TEXT N_("X offset")
105 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
106 #define POSY_TEXT N_("Y offset")
107 #define POSY_LONGTEXT N_("Y offset, down from the top." )
108 #define TIMEOUT_TEXT N_("Timeout")
109 #define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
110 "displayed. Default value is " \
111 "0 (remains forever).")
112 #define REFRESH_TEXT N_("Refresh period in ms")
113 #define REFRESH_LONGTEXT N_("Number of milliseconds between string updates. " \
114 "This is mainly usefull when using meta data " \
115 "or time format string sequences.")
116 #define OPACITY_TEXT N_("Opacity")
117 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
118 "overlayed text. 0 = transparent, 255 = totally opaque. " )
119 #define SIZE_TEXT N_("Font size, pixels")
120 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
123 #define COLOR_TEXT N_("Color")
124 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
125 "the video. This must be an hexadecimal (like HTML colors). The first two "\
126 "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
127 " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
129 #define POS_TEXT N_("Marquee position")
130 #define POS_LONGTEXT N_( \
131 "You can enforce the marquee position on the video " \
132 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
133 "also use combinations of these values, eg 6 = top-right).")
135 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
136 static const char *const ppsz_pos_descriptions[] =
137 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
138 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
140 #define CFG_PREFIX "marq-"
142 /*****************************************************************************
144 *****************************************************************************/
146 set_capability( "sub filter", 0 )
147 set_shortname( N_("Marquee" ))
148 set_callbacks( CreateFilter, DestroyFilter )
149 set_category( CAT_VIDEO )
150 set_subcategory( SUBCAT_VIDEO_SUBPIC )
151 add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
154 set_section( N_("Position"), NULL )
155 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true )
156 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true )
157 add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false )
158 change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
160 set_section( N_("Font"), NULL )
161 /* 5 sets the default to top [1] left [4] */
162 add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
163 OPACITY_TEXT, OPACITY_LONGTEXT, false )
164 add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
166 change_integer_list( pi_color_values, ppsz_color_descriptions, NULL )
167 add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
170 set_section( N_("Misc"), NULL )
171 add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
173 add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
174 REFRESH_LONGTEXT, false )
176 set_description( N_("Marquee display") )
177 add_shortcut( "time" )
178 add_obsolete_string( "time-format" )
179 add_obsolete_string( "time-x" )
180 add_obsolete_string( "time-y" )
181 add_obsolete_string( "time-position" )
182 add_obsolete_string( "time-opacity" )
183 add_obsolete_string( "time-color" )
184 add_obsolete_string( "time-size" )
187 static const char *const ppsz_filter_options[] = {
188 "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
192 /*****************************************************************************
193 * CreateFilter: allocates marquee video filter
194 *****************************************************************************/
195 static int CreateFilter( vlc_object_t *p_this )
197 filter_t *p_filter = (filter_t *)p_this;
200 /* Allocate structure */
201 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
205 vlc_mutex_init( &p_sys->lock );
206 p_sys->p_style = text_style_New();
208 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
212 #define CREATE_VAR( stor, type, var ) \
213 p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
214 var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
216 p_sys->b_need_update = true;
217 CREATE_VAR( i_xoff, Integer, "marq-x" );
218 CREATE_VAR( i_yoff, Integer, "marq-y" );
219 CREATE_VAR( i_timeout,Integer, "marq-timeout" );
220 p_sys->i_refresh = 1000 * var_CreateGetIntegerCommand( p_filter,
222 var_AddCallback( p_filter, "marq-refresh", MarqueeCallback, p_sys );
223 CREATE_VAR( i_pos, Integer, "marq-position" );
224 CREATE_VAR( psz_marquee, String, "marq-marquee" );
225 CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
226 p_sys->p_style->i_font_alpha =
227 255 - var_CreateGetIntegerCommand( p_filter, "marq-opacity" );
228 var_AddCallback( p_filter, "marq-opacity", MarqueeCallback, p_sys );
229 CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
230 CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
233 p_filter->pf_sub_filter = Filter;
234 p_sys->last_time = 0;
238 /*****************************************************************************
239 * DestroyFilter: destroy marquee video filter
240 *****************************************************************************/
241 static void DestroyFilter( vlc_object_t *p_this )
243 filter_t *p_filter = (filter_t *)p_this;
244 filter_sys_t *p_sys = p_filter->p_sys;
246 /* Delete the marquee variables */
247 #define DEL_VAR(var) \
248 var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
249 var_Destroy( p_filter, var );
252 DEL_VAR( "marq-marquee" );
253 DEL_VAR( "marq-timeout" );
254 DEL_VAR( "marq-position" );
255 DEL_VAR( "marq-color" );
256 DEL_VAR( "marq-opacity" );
257 DEL_VAR( "marq-size" );
259 vlc_mutex_destroy( &p_sys->lock );
260 text_style_Delete( p_sys->p_style );
261 free( p_sys->psz_marquee );
265 /****************************************************************************
266 * Filter: the whole thing
267 ****************************************************************************
268 * This function outputs subpictures at regular time intervals.
269 ****************************************************************************/
270 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
272 filter_sys_t *p_sys = p_filter->p_sys;
273 subpicture_t *p_spu = NULL;
276 vlc_mutex_lock( &p_sys->lock );
277 if( p_sys->last_time + p_sys->i_refresh > date )
279 if( p_sys->b_need_update == false )
282 p_spu = filter_NewSubpicture( p_filter );
286 memset( &fmt, 0, sizeof(video_format_t) );
287 fmt.i_chroma = VLC_CODEC_TEXT;
289 fmt.i_width = fmt.i_height = 0;
292 p_spu->p_region = subpicture_region_New( &fmt );
293 if( !p_spu->p_region )
295 p_filter->pf_sub_buffer_del( p_filter, p_spu );
300 p_sys->last_time = date;
302 if( !strchr( p_sys->psz_marquee, '%' )
303 && !strchr( p_sys->psz_marquee, '$' ) )
304 p_sys->b_need_update = false;
306 p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
307 p_spu->i_start = date;
308 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
309 p_spu->b_ephemer = true;
311 /* where to locate the string: */
312 if( p_sys->i_pos < 0 )
313 { /* set to an absolute xy */
314 p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
315 p_spu->b_absolute = true;
318 { /* set to one of the 9 relative locations */
319 p_spu->p_region->i_align = p_sys->i_pos;
320 p_spu->b_absolute = false;
323 p_spu->p_region->i_x = p_sys->i_xoff;
324 p_spu->p_region->i_y = p_sys->i_yoff;
326 p_spu->p_region->p_style = text_style_Duplicate( p_sys->p_style );
329 vlc_mutex_unlock( &p_sys->lock );
333 /**********************************************************************
334 * Callback to update params on the fly
335 **********************************************************************/
336 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
337 vlc_value_t oldval, vlc_value_t newval,
340 filter_sys_t *p_sys = (filter_sys_t *) p_data;
345 vlc_mutex_lock( &p_sys->lock );
346 if( !strncmp( psz_var, "marq-marquee", 7 ) )
348 free( p_sys->psz_marquee );
349 p_sys->psz_marquee = strdup( newval.psz_string );
351 else if ( !strncmp( psz_var, "marq-x", 6 ) )
353 p_sys->i_xoff = newval.i_int;
355 else if ( !strncmp( psz_var, "marq-y", 6 ) )
357 p_sys->i_yoff = newval.i_int;
359 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
361 p_sys->p_style->i_font_color = newval.i_int;
363 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
365 p_sys->p_style->i_font_alpha = 255 - newval.i_int;
367 else if ( !strncmp( psz_var, "marq-size", 6 ) )
369 p_sys->p_style->i_font_size = newval.i_int;
371 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
373 p_sys->i_timeout = newval.i_int;
375 else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
377 p_sys->i_refresh = newval.i_int * 1000;
379 else if ( !strncmp( psz_var, "marq-position", 8 ) )
380 /* willing to accept a match against marq-pos */
382 p_sys->i_pos = newval.i_int;
383 p_sys->i_xoff = -1; /* force to relative positioning */
385 p_sys->b_need_update = true;
386 vlc_mutex_unlock( &p_sys->lock );