1 /*****************************************************************************
2 * marq.c : marquee display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2005 the VideoLAN team
7 * Authors: Mark Moriarty
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
33 #include "vlc_filter.h"
34 #include "vlc_block.h"
37 /*****************************************************************************
39 *****************************************************************************/
40 static int CreateFilter ( vlc_object_t * );
41 static void DestroyFilter( vlc_object_t * );
42 static subpicture_t *Filter( filter_t *, mtime_t );
45 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
46 vlc_value_t oldval, vlc_value_t newval,
48 static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
49 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
50 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
51 0x00000080, 0x000000FF, 0x0000FFFF};
52 static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
53 N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
54 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
55 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
58 /*****************************************************************************
59 * filter_sys_t: marquee filter descriptor
60 *****************************************************************************/
63 int i_xoff, i_yoff; /* offsets for the display string in the video window */
64 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
67 char *psz_marquee; /* marquee string */
69 int i_font_color, i_font_opacity, i_font_size; /* font control */
73 vlc_bool_t b_need_update;
76 #define MSG_TEXT N_("Marquee text")
77 #define MSG_LONGTEXT N_("Marquee text to display")
78 #define POSX_TEXT N_("X offset, from left")
79 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
80 #define POSY_TEXT N_("Y offset, from the top")
81 #define POSY_LONGTEXT N_("Y offset, down from the top" )
82 #define TIMEOUT_TEXT N_("Marquee timeout")
83 #define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
84 "displayed, in milliseconds. Default value is " \
85 "0 (remain forever).")
86 #define OPACITY_TEXT N_("Opacity")
87 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
88 "overlay text. 0 = transparent, 255 = totally opaque. " )
89 #define SIZE_TEXT N_("Font size, pixels")
90 #define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
91 "with -1 = use freetype-fontsize" )
93 #define COLOR_TEXT N_("Text Default Color")
94 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal. " \
95 "#000000 = all colors off, " \
96 "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
98 #define POS_TEXT N_("Marquee position")
99 #define POS_LONGTEXT N_( \
100 "You can enforce the marquee position on the video " \
101 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
102 "also use combinations of these values by adding them).")
104 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
105 static char *ppsz_pos_descriptions[] =
106 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
107 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
109 /*****************************************************************************
111 *****************************************************************************/
113 set_capability( "sub filter", 0 );
114 set_shortname( N_("Marquee" ));
115 set_callbacks( CreateFilter, DestroyFilter );
116 set_category( CAT_VIDEO );
117 set_subcategory( SUBCAT_VIDEO_SUBPIC );
118 add_string( "marq-marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
121 set_section( N_("Position"), NULL );
122 add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
123 add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
124 add_integer( "marq-position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
126 set_section( N_("Font"), NULL );
127 /* 5 sets the default to top [1] left [4] */
128 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
129 add_integer_with_range( "marq-opacity", 255, 0, 255, NULL,
130 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
131 add_integer( "marq-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
133 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
134 add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
136 set_section( N_("Misc"), NULL );
137 add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
140 set_description( _("Marquee display sub filter") );
141 add_shortcut( "marq" );
144 /*****************************************************************************
145 * CreateFilter: allocates marquee video filter
146 *****************************************************************************/
147 static int CreateFilter( vlc_object_t *p_this )
149 filter_t *p_filter = (filter_t *)p_this;
151 vlc_object_t *p_input;
153 /* Allocate structure */
154 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
157 msg_Err( p_filter, "out of memory" );
161 /* Hook used for callback variables */
162 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
168 p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "marq-x" );
169 p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "marq-y" );
170 p_sys->i_timeout = var_CreateGetInteger( p_input->p_libvlc , "marq-timeout" );
171 p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "marq-position" );
172 p_sys->psz_marquee = var_CreateGetString( p_input->p_libvlc, "marq-marquee" );
173 var_Create( p_input->p_libvlc, "marq-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
174 p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "marq-opacity" );
175 p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "marq-color" );
176 p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "marq-size" );
178 var_AddCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
179 var_AddCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
180 var_AddCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
181 var_AddCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
182 var_AddCallback( p_input->p_libvlc, "marq-position", MarqueeCallback, p_sys );
183 var_AddCallback( p_input->p_libvlc, "marq-color", MarqueeCallback, p_sys );
184 var_AddCallback( p_input->p_libvlc, "marq-opacity", MarqueeCallback, p_sys );
185 var_AddCallback( p_input->p_libvlc, "marq-size", MarqueeCallback, p_sys );
187 vlc_object_release( p_input );
191 p_filter->pf_sub_filter = Filter;
192 p_sys->last_time = ((time_t)-1);
193 p_sys->b_need_update = VLC_TRUE;
197 /*****************************************************************************
198 * DestroyFilter: destroy marquee video filter
199 *****************************************************************************/
200 static void DestroyFilter( vlc_object_t *p_this )
202 filter_t *p_filter = (filter_t *)p_this;
203 filter_sys_t *p_sys = p_filter->p_sys;
204 vlc_object_t *p_input;
206 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
209 /* Delete the marquee variables */
210 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
215 var_Destroy( p_input->p_libvlc , "marq-marquee" );
216 var_Destroy( p_input->p_libvlc , "marq-x" );
217 var_Destroy( p_input->p_libvlc , "marq-y" );
218 var_Destroy( p_input->p_libvlc , "marq-timeout" );
219 var_Destroy( p_input->p_libvlc , "marq-position" );
220 var_Destroy( p_input->p_libvlc , "marq-color");
221 var_Destroy( p_input->p_libvlc , "marq-opacity");
222 var_Destroy( p_input->p_libvlc , "marq-size");
224 vlc_object_release( p_input );
227 /****************************************************************************
228 * Filter: the whole thing
229 ****************************************************************************
230 * This function outputs subpictures at regular time intervals.
231 ****************************************************************************/
232 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
234 filter_sys_t *p_sys = p_filter->p_sys;
239 if( p_sys->last_time == time( NULL ) )
244 if( p_sys->b_need_update == VLC_FALSE )
249 p_spu = p_filter->pf_sub_buffer_new( p_filter );
250 if( !p_spu ) return NULL;
252 memset( &fmt, 0, sizeof(video_format_t) );
253 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
255 fmt.i_width = fmt.i_height = 0;
258 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
259 if( !p_spu->p_region )
261 p_filter->pf_sub_buffer_del( p_filter, p_spu );
265 t = p_sys->last_time = time( NULL );
267 p_spu->p_region->psz_text = strdup(p_sys->psz_marquee);
268 p_spu->i_start = date;
269 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
270 p_spu->b_ephemer = VLC_TRUE;
272 /* where to locate the string: */
273 if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
274 { /* set to one of the 9 relative locations */
275 p_spu->i_flags = p_sys->i_pos;
278 p_spu->b_absolute = VLC_FALSE;
281 { /* set to an absolute xy, referenced to upper left corner */
282 p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
283 p_spu->i_x = p_sys->i_xoff;
284 p_spu->i_y = p_sys->i_yoff;
285 p_spu->b_absolute = VLC_TRUE;
287 p_spu->p_region->i_text_color = p_sys->i_font_color;
288 p_spu->p_region->i_text_alpha = 255 - p_sys->i_font_opacity;
289 p_spu->p_region->i_text_size = p_sys->i_font_size;
292 p_sys->b_need_update = VLC_FALSE;
296 /**********************************************************************
297 * Callback to update params on the fly
298 **********************************************************************/
299 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
300 vlc_value_t oldval, vlc_value_t newval,
303 filter_sys_t *p_sys = (filter_sys_t *) p_data;
305 if( !strncmp( psz_var, "marq-marquee", 7 ) )
307 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
308 p_sys->psz_marquee = strdup( newval.psz_string );
310 else if ( !strncmp( psz_var, "marq-x", 6 ) )
312 p_sys->i_xoff = newval.i_int;
314 else if ( !strncmp( psz_var, "marq-y", 6 ) )
316 p_sys->i_yoff = newval.i_int;
318 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
320 p_sys->i_font_color = newval.i_int;
322 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
324 p_sys->i_font_opacity = newval.i_int;
326 else if ( !strncmp( psz_var, "marq-size", 6 ) )
328 p_sys->i_font_size = newval.i_int;
330 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
332 p_sys->i_timeout = newval.i_int;
334 else if ( !strncmp( psz_var, "marq-position", 8 ) )
335 /* willing to accept a match against marq-pos */
337 p_sys->i_pos = newval.i_int;
338 p_sys->i_xoff = -1; /* force to relative positioning */
340 p_sys->b_need_update = VLC_TRUE;