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>
38 #include "vlc_filter.h"
39 #include "vlc_block.h"
42 #include "vlc_strings.h"
44 /*****************************************************************************
46 *****************************************************************************/
47 static int CreateFilter ( vlc_object_t * );
48 static void DestroyFilter( vlc_object_t * );
49 static subpicture_t *Filter( filter_t *, mtime_t );
52 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
53 vlc_value_t oldval, vlc_value_t newval,
55 static const int pi_color_values[] = {
56 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
57 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
58 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
59 0x00000080, 0x000000FF, 0x0000FFFF};
60 static const char *const ppsz_color_descriptions[] = {
61 N_("Default"), N_("Black"), N_("Gray"),
62 N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
63 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
64 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
67 /*****************************************************************************
68 * filter_sys_t: marquee filter descriptor
69 *****************************************************************************/
72 int i_xoff, i_yoff; /* offsets for the display string in the video window */
73 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
76 char *psz_marquee; /* marquee string */
78 text_style_t *p_style; /* font control */
86 #define MSG_TEXT N_("Text")
87 #define MSG_LONGTEXT N_( \
88 "Marquee text to display. " \
89 "(Available format strings: " \
90 "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
91 "%M = minute, %S = second, ... " \
92 "Meta data related: $a = artist, $b = album, $c = copyright, " \
93 "$d = description, $e = encoded by, $g = genre, " \
94 "$l = language, $n = track num, $p = now playing, " \
95 "$r = rating, $s = subtitles language, $t = title, "\
96 "$u = url, $A = date, " \
97 "$B = audio bitrate (in kb/s), $C = chapter," \
98 "$D = duration, $F = full name with path, $I = title, "\
100 "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
101 "$S = audio sample rate (in kHz), " \
102 "$T = time, $U = publisher, $V = volume, $_ = new line) ")
103 #define POSX_TEXT N_("X offset")
104 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
105 #define POSY_TEXT N_("Y offset")
106 #define POSY_LONGTEXT N_("Y offset, down from the top." )
107 #define TIMEOUT_TEXT N_("Timeout")
108 #define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
109 "displayed. Default value is " \
110 "0 (remains forever).")
111 #define REFRESH_TEXT N_("Refresh period in ms")
112 #define REFRESH_LONGTEXT N_("Number of milliseconds between string updates. " \
113 "This is mainly usefull when using meta data " \
114 "or time format string sequences.")
115 #define OPACITY_TEXT N_("Opacity")
116 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
117 "overlayed text. 0 = transparent, 255 = totally opaque. " )
118 #define SIZE_TEXT N_("Font size, pixels")
119 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
122 #define COLOR_TEXT N_("Color")
123 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
124 "the video. This must be an hexadecimal (like HTML colors). The first two "\
125 "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
126 " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
128 #define POS_TEXT N_("Marquee position")
129 #define POS_LONGTEXT N_( \
130 "You can enforce the marquee position on the video " \
131 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
132 "also use combinations of these values, eg 6 = top-right).")
134 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
135 static const char *const ppsz_pos_descriptions[] =
136 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
137 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
139 #define CFG_PREFIX "marq-"
141 /*****************************************************************************
143 *****************************************************************************/
145 set_capability( "sub filter", 0 );
146 set_shortname( N_("Marquee" ));
147 set_callbacks( CreateFilter, DestroyFilter );
148 set_category( CAT_VIDEO );
149 set_subcategory( SUBCAT_VIDEO_SUBPIC );
150 add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
153 set_section( N_("Position"), NULL );
154 add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true );
155 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true );
156 add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false );
157 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
159 set_section( N_("Font"), NULL );
160 /* 5 sets the default to top [1] left [4] */
161 add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
162 OPACITY_TEXT, OPACITY_LONGTEXT, false );
163 add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
165 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
166 add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
169 set_section( N_("Misc"), NULL );
170 add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
172 add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
173 REFRESH_LONGTEXT, false );
175 set_description( N_("Marquee display") );
176 add_shortcut( "time" );
177 add_obsolete_string( "time-format" );
178 add_obsolete_string( "time-x" );
179 add_obsolete_string( "time-y" );
180 add_obsolete_string( "time-position" );
181 add_obsolete_string( "time-opacity" );
182 add_obsolete_string( "time-color" );
183 add_obsolete_string( "time-size" );
186 static const char *const ppsz_filter_options[] = {
187 "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
191 /*****************************************************************************
192 * CreateFilter: allocates marquee video filter
193 *****************************************************************************/
194 static int CreateFilter( vlc_object_t *p_this )
196 filter_t *p_filter = (filter_t *)p_this;
199 /* Allocate structure */
200 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
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 p_sys->i_refresh *= 1000;
219 CREATE_VAR( i_pos, Integer, "marq-position" );
220 CREATE_VAR( psz_marquee, String, "marq-marquee" );
221 CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
222 CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
223 CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
225 p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
228 p_filter->pf_sub_filter = Filter;
229 p_sys->last_time = 0;
230 p_sys->b_need_update = true;
234 /*****************************************************************************
235 * DestroyFilter: destroy marquee video filter
236 *****************************************************************************/
237 static void DestroyFilter( vlc_object_t *p_this )
239 filter_t *p_filter = (filter_t *)p_this;
240 filter_sys_t *p_sys = p_filter->p_sys;
242 free( p_sys->p_style );
243 free( p_sys->psz_marquee );
245 /* Delete the marquee variables */
246 #define DEL_VAR(var) \
247 var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
248 var_Destroy( p_filter, var );
251 DEL_VAR( "marq-marquee" );
252 DEL_VAR( "marq-timeout" );
253 DEL_VAR( "marq-position" );
254 DEL_VAR( "marq-color" );
255 DEL_VAR( "marq-opacity" );
256 DEL_VAR( "marq-size" );
261 /****************************************************************************
262 * Filter: the whole thing
263 ****************************************************************************
264 * This function outputs subpictures at regular time intervals.
265 ****************************************************************************/
266 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
268 filter_sys_t *p_sys = p_filter->p_sys;
269 subpicture_t *p_spu = NULL;
272 if( p_sys->last_time + p_sys->i_refresh > date )
275 vlc_object_lock( p_filter );
276 if( p_sys->b_need_update == false )
279 p_spu = filter_NewSubpicture( p_filter );
283 memset( &fmt, 0, sizeof(video_format_t) );
284 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
286 fmt.i_width = fmt.i_height = 0;
289 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
290 if( !p_spu->p_region )
292 p_filter->pf_sub_buffer_del( p_filter, p_spu );
297 p_sys->last_time = date;
299 if( !strchr( p_sys->psz_marquee, '%' )
300 && !strchr( p_sys->psz_marquee, '$' ) )
301 p_sys->b_need_update = false;
303 p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
304 p_spu->i_start = date;
305 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
306 p_spu->b_ephemer = true;
308 /* where to locate the string: */
309 if( p_sys->i_pos < 0 )
310 { /* set to an absolute xy */
311 p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
312 p_spu->b_absolute = true;
315 { /* set to one of the 9 relative locations */
316 p_spu->p_region->i_align = p_sys->i_pos;
317 p_spu->b_absolute = false;
320 p_spu->i_x = p_sys->i_xoff;
321 p_spu->i_y = p_sys->i_yoff;
323 p_spu->p_region->p_style = p_sys->p_style;
326 vlc_object_unlock( p_filter );
330 /**********************************************************************
331 * Callback to update params on the fly
332 **********************************************************************/
333 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
334 vlc_value_t oldval, vlc_value_t newval,
338 filter_sys_t *p_sys = (filter_sys_t *) p_data;
340 vlc_object_lock( p_this );
341 if( !strncmp( psz_var, "marq-marquee", 7 ) )
343 free( p_sys->psz_marquee );
344 p_sys->psz_marquee = strdup( newval.psz_string );
346 else if ( !strncmp( psz_var, "marq-x", 6 ) )
348 p_sys->i_xoff = newval.i_int;
350 else if ( !strncmp( psz_var, "marq-y", 6 ) )
352 p_sys->i_yoff = newval.i_int;
354 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
356 p_sys->p_style->i_font_color = newval.i_int;
358 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
360 p_sys->p_style->i_font_alpha = 255 - newval.i_int;
362 else if ( !strncmp( psz_var, "marq-size", 6 ) )
364 p_sys->p_style->i_font_size = newval.i_int;
366 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
368 p_sys->i_timeout = newval.i_int;
370 else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
372 p_sys->i_refresh = newval.i_int * 1000;
374 else if ( !strncmp( psz_var, "marq-position", 8 ) )
375 /* willing to accept a match against marq-pos */
377 p_sys->i_pos = newval.i_int;
378 p_sys->i_xoff = -1; /* force to relative positioning */
380 p_sys->b_need_update = true;
381 vlc_object_unlock( p_this );