1 /*****************************************************************************
2 * marq.c : marquee display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2005 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 *****************************************************************************/
29 #include <stdlib.h> /* malloc(), free() */
35 #include "vlc_filter.h"
36 #include "vlc_block.h"
39 #include "vlc_strings.h"
41 /*****************************************************************************
43 *****************************************************************************/
44 static int CreateFilter ( vlc_object_t * );
45 static void DestroyFilter( vlc_object_t * );
46 static subpicture_t *Filter( filter_t *, mtime_t );
49 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
50 vlc_value_t oldval, vlc_value_t newval,
52 static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
53 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
54 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
55 0x00000080, 0x000000FF, 0x0000FFFF};
56 static const char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
57 N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
58 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
59 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
62 /*****************************************************************************
63 * filter_sys_t: marquee filter descriptor
64 *****************************************************************************/
67 int i_xoff, i_yoff; /* offsets for the display string in the video window */
68 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
71 char *psz_marquee; /* marquee string */
73 text_style_t *p_style; /* font control */
77 vlc_bool_t b_need_update;
80 #define MSG_TEXT N_("Text")
81 #define MSG_LONGTEXT N_( \
82 "Marquee text to display. " \
83 "(Available format strings: " \
84 "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
85 "%M = minute, %S = second, ... " \
86 "Meta data related: $a = artist, $b = album, $c = copyright, " \
87 "$d = description, $e = encoded by, $g = genre, " \
88 "$l = language, $n = track num, $p = now playing, " \
89 "$r = rating, $s = subtitles language, $t = title, "\
90 "$u = url, $A = date, " \
91 "$B = audio bitrate (in kb/s), $C = chapter," \
92 "$D = duration, $F = full name with path, $I = title, "\
94 "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
95 "$S = audio sample rate (in kHz), " \
96 "$T = time, $U = publisher, $V = volume, $_ = new line) ")
97 #define POSX_TEXT N_("X offset")
98 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
99 #define POSY_TEXT N_("Y offset")
100 #define POSY_LONGTEXT N_("Y offset, down from the top." )
101 #define TIMEOUT_TEXT N_("Timeout")
102 #define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
103 "displayed. Default value is " \
104 "0 (remains forever).")
105 #define OPACITY_TEXT N_("Opacity")
106 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
107 "overlayed text. 0 = transparent, 255 = totally opaque. " )
108 #define SIZE_TEXT N_("Font size, pixels")
109 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
112 #define COLOR_TEXT N_("Color")
113 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
114 "the video. This must be an hexadecimal (like HTML colors). The first two "\
115 "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
116 " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
118 #define POS_TEXT N_("Marquee position")
119 #define POS_LONGTEXT N_( \
120 "You can enforce the marquee position on the video " \
121 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
122 "also use combinations of these values, eg 6 = top-right).")
124 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
125 static const char *ppsz_pos_descriptions[] =
126 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
127 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
129 #define CFG_PREFIX "marq-"
131 /*****************************************************************************
133 *****************************************************************************/
135 set_capability( "sub filter", 0 );
136 set_shortname( _("Marquee" ));
137 set_callbacks( CreateFilter, DestroyFilter );
138 set_category( CAT_VIDEO );
139 set_subcategory( SUBCAT_VIDEO_SUBPIC );
140 add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
143 set_section( N_("Position"), NULL );
144 add_integer( CFG_PREFIX "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
145 add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
146 add_integer( CFG_PREFIX "position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
147 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
149 set_section( N_("Font"), NULL );
150 /* 5 sets the default to top [1] left [4] */
151 add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
152 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
153 add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
155 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
156 add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
159 set_section( N_("Misc"), NULL );
160 add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
163 set_description( _("Marquee display") );
164 add_shortcut( "marq" );
165 add_shortcut( "time" );
168 static const char *ppsz_filter_options[] = {
169 "marquee", "x", "y", "position", "color", "size", "timeout", NULL
172 /*****************************************************************************
173 * CreateFilter: allocates marquee video filter
174 *****************************************************************************/
175 static int CreateFilter( vlc_object_t *p_this )
177 filter_t *p_filter = (filter_t *)p_this;
180 /* Allocate structure */
181 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
184 msg_Err( p_filter, "out of memory" );
188 p_sys->p_style = malloc( sizeof( text_style_t ) );
189 memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
191 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
194 #define CREATE_VAR( stor, type, var ) \
195 p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
196 var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
198 CREATE_VAR( i_xoff, Integer, "marq-x" );
199 CREATE_VAR( i_yoff, Integer, "marq-y" );
200 CREATE_VAR( i_timeout,Integer, "marq-timeout" );
201 CREATE_VAR( i_pos, Integer, "marq-position" );
202 CREATE_VAR( psz_marquee, String, "marq-marquee" );
203 CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
204 CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
205 CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
207 p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
210 p_filter->pf_sub_filter = Filter;
211 p_sys->last_time = ((time_t)-1);
212 p_sys->b_need_update = VLC_TRUE;
216 /*****************************************************************************
217 * DestroyFilter: destroy marquee video filter
218 *****************************************************************************/
219 static void DestroyFilter( vlc_object_t *p_this )
221 filter_t *p_filter = (filter_t *)p_this;
222 filter_sys_t *p_sys = p_filter->p_sys;
224 if( p_sys->p_style ) free( p_sys->p_style );
225 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
227 /* Delete the marquee variables */
228 #define DEL_VAR(var) \
229 var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
230 var_Destroy( p_filter, var );
233 DEL_VAR( "marq-marquee" );
234 DEL_VAR( "marq-timeout" );
235 DEL_VAR( "marq-position" );
236 DEL_VAR( "marq-color" );
237 DEL_VAR( "marq-opacity" );
238 DEL_VAR( "marq-size" );
243 /****************************************************************************
244 * Filter: the whole thing
245 ****************************************************************************
246 * This function outputs subpictures at regular time intervals.
247 ****************************************************************************/
248 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
250 filter_sys_t *p_sys = p_filter->p_sys;
255 if( p_sys->last_time == time( NULL ) )
260 if( p_sys->b_need_update == VLC_FALSE )
265 p_spu = p_filter->pf_sub_buffer_new( p_filter );
266 if( !p_spu ) return NULL;
268 memset( &fmt, 0, sizeof(video_format_t) );
269 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
271 fmt.i_width = fmt.i_height = 0;
274 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
275 if( !p_spu->p_region )
277 p_filter->pf_sub_buffer_del( p_filter, p_spu );
281 t = p_sys->last_time = time( NULL );
283 if( strchr( p_sys->psz_marquee, '%' ) || strchr( p_sys->psz_marquee, '$' ) )
285 p_sys->b_need_update = VLC_TRUE;
289 p_sys->b_need_update = VLC_FALSE;
291 p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
292 p_spu->i_start = date;
293 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
294 p_spu->b_ephemer = VLC_TRUE;
296 /* where to locate the string: */
297 if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
298 { /* set to one of the 9 relative locations */
299 p_spu->i_flags = p_sys->i_pos;
302 p_spu->b_absolute = VLC_FALSE;
305 { /* set to an absolute xy, referenced to upper left corner */
306 p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
307 p_spu->i_x = p_sys->i_xoff;
308 p_spu->i_y = p_sys->i_yoff;
309 p_spu->b_absolute = VLC_TRUE;
311 p_spu->p_region->p_style = p_sys->p_style;
316 /**********************************************************************
317 * Callback to update params on the fly
318 **********************************************************************/
319 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
320 vlc_value_t oldval, vlc_value_t newval,
323 filter_sys_t *p_sys = (filter_sys_t *) p_data;
325 if( !strncmp( psz_var, "marq-marquee", 7 ) )
327 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
328 p_sys->psz_marquee = strdup( newval.psz_string );
330 else if ( !strncmp( psz_var, "marq-x", 6 ) )
332 p_sys->i_xoff = newval.i_int;
334 else if ( !strncmp( psz_var, "marq-y", 6 ) )
336 p_sys->i_yoff = newval.i_int;
338 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
340 p_sys->p_style->i_font_color = newval.i_int;
342 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
344 p_sys->p_style->i_font_alpha = 255 - newval.i_int;
346 else if ( !strncmp( psz_var, "marq-size", 6 ) )
348 p_sys->p_style->i_font_size = newval.i_int;
350 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
352 p_sys->i_timeout = newval.i_int;
354 else if ( !strncmp( psz_var, "marq-position", 8 ) )
355 /* willing to accept a match against marq-pos */
357 p_sys->i_pos = newval.i_int;
358 p_sys->i_xoff = -1; /* force to relative positioning */
360 p_sys->b_need_update = VLC_TRUE;