1 /*****************************************************************************
2 * marq.c : marquee display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2005 VideoLAN
5 * $Id: time.c 8751 2004-09-20 21:51:41Z gbazin $
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 */
72 vlc_bool_t b_absolute; /* position control, relative vs. absolute */
74 vlc_bool_t b_need_update;
77 #define MSG_TEXT N_("Marquee text")
78 #define MSG_LONGTEXT N_("Marquee text to display")
79 #define POSX_TEXT N_("X offset, from left")
80 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
81 #define POSY_TEXT N_("Y offset, from the top")
82 #define POSY_LONGTEXT N_("Y offset, down from the top" )
83 #define TIMEOUT_TEXT N_("Marquee timeout")
84 #define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
85 "displayed, in milliseconds. Default value is " \
86 "0 (remain forever).")
87 #define OPACITY_TEXT N_("Opacity, -1..255")
88 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of overlay text. " \
89 "-1 = use freetype-opacity, 0 = transparent, 255 = totally opaque. " )
90 #define SIZE_TEXT N_("Font size, pixels")
91 #define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
92 "with -1 = use freetype-fontsize" )
94 #define COLOR_TEXT N_("Text Default Color")
95 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal." \
96 "-1 = use freetype-color, #000000 = all colors off, " \
97 "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
99 #define POS_TEXT N_("Marquee position")
100 #define POS_LONGTEXT N_( \
101 "You can enforce the marquee position on the video " \
102 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
103 "also use combinations of these values by adding them).")
105 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
106 static char *ppsz_pos_descriptions[] =
107 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
108 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
110 /*****************************************************************************
112 *****************************************************************************/
114 set_capability( "sub filter", 0 );
115 set_shortname( N_("Marquee" ));
116 set_callbacks( CreateFilter, DestroyFilter );
117 set_category( CAT_VIDEO );
118 set_subcategory( SUBCAT_VIDEO_SUBPIC );
119 add_string( "marq-marquee", "Marquee", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
120 add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
121 add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
122 add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
124 add_integer( "marq-position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
125 /* 5 sets the default to top [1] left [4] */
126 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
127 add_integer_with_range( "marq-opacity", -1, -1, 255, NULL,
128 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
129 add_integer( "marq-color", -1, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
130 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
131 add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
133 set_description( _("Marquee display sub filter") );
134 add_shortcut( "marq" );
137 /*****************************************************************************
138 * CreateFilter: allocates marquee video filter
139 *****************************************************************************/
140 static int CreateFilter( vlc_object_t *p_this )
142 filter_t *p_filter = (filter_t *)p_this;
144 vlc_object_t *p_input;
146 /* Allocate structure */
147 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
150 msg_Err( p_filter, "out of memory" );
154 /* Hook used for callback variables */
155 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
161 p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "marq-x" );
162 p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "marq-y" );
163 p_sys->i_timeout = var_CreateGetInteger( p_input->p_libvlc , "marq-timeout" );
164 p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "marq-position" );
165 p_sys->psz_marquee = var_CreateGetString( p_input->p_libvlc, "marq-marquee" );
166 var_Create( p_input->p_libvlc, "marq-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
167 p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "marq-opacity" );
168 p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "marq-color" );
169 p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "marq-size" );
171 var_AddCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
172 var_AddCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
173 var_AddCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
174 var_AddCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
175 var_AddCallback( p_input->p_libvlc, "marq-position", MarqueeCallback, p_sys );
176 var_AddCallback( p_input->p_libvlc, "marq-color", MarqueeCallback, p_sys );
177 var_AddCallback( p_input->p_libvlc, "marq-opacity", MarqueeCallback, p_sys );
178 var_AddCallback( p_input->p_libvlc, "marq-size", MarqueeCallback, p_sys );
180 vlc_object_release( p_input );
184 p_filter->pf_sub_filter = Filter;
185 p_sys->last_time = ((time_t)-1);
186 p_sys->b_need_update = VLC_TRUE;
190 /*****************************************************************************
191 * DestroyFilter: destroy marquee video filter
192 *****************************************************************************/
193 static void DestroyFilter( vlc_object_t *p_this )
195 filter_t *p_filter = (filter_t *)p_this;
196 filter_sys_t *p_sys = p_filter->p_sys;
197 vlc_object_t *p_input;
199 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
202 /* Delete the marquee variables */
203 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
208 var_Destroy( p_input->p_libvlc , "marq-marquee" );
209 var_Destroy( p_input->p_libvlc , "marq-x" );
210 var_Destroy( p_input->p_libvlc , "marq-y" );
211 var_Destroy( p_input->p_libvlc , "marq-timeout" );
212 var_Destroy( p_input->p_libvlc , "marq-position" );
213 var_Destroy( p_input->p_libvlc , "marq-color");
214 var_Destroy( p_input->p_libvlc , "marq-opacity");
215 var_Destroy( p_input->p_libvlc , "marq-size");
217 vlc_object_release( p_input );
220 /****************************************************************************
221 * Filter: the whole thing
222 ****************************************************************************
223 * This function outputs subpictures at regular time intervals.
224 ****************************************************************************/
225 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
227 filter_sys_t *p_sys = p_filter->p_sys;
232 if( p_sys->last_time == time( NULL ) )
237 if( p_sys->b_need_update == VLC_FALSE )
242 p_sys->b_absolute = VLC_TRUE;
243 if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
245 p_sys->b_absolute = VLC_FALSE;
248 p_spu = p_filter->pf_sub_buffer_new( p_filter );
249 if( !p_spu ) return NULL;
251 p_spu->b_absolute = p_sys->b_absolute;
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;
271 p_spu->i_x = p_sys->i_xoff;
272 p_spu->i_y = p_sys->i_yoff;
273 p_spu->p_region->i_font_color = p_sys->i_font_color;
274 p_spu->p_region->i_font_opacity = p_sys->i_font_opacity;
275 p_spu->p_region->i_font_size = p_sys->i_font_size;
277 p_spu->i_flags = p_sys->i_pos;
279 p_sys->b_need_update = VLC_FALSE;
283 /**********************************************************************
284 * Callback to update params on the fly
285 **********************************************************************/
286 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
287 vlc_value_t oldval, vlc_value_t newval,
290 filter_sys_t *p_sys = (filter_sys_t *) p_data;
292 if( !strncmp( psz_var, "marq-marquee", 7 ) )
294 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
295 p_sys->psz_marquee = strdup( newval.psz_string );
297 else if ( !strncmp( psz_var, "marq-x", 6 ) )
299 p_sys->i_xoff = newval.i_int;
301 else if ( !strncmp( psz_var, "marq-y", 6 ) )
303 p_sys->i_yoff = newval.i_int;
305 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
307 p_sys->i_font_color = newval.i_int;
309 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
311 p_sys->i_font_opacity = newval.i_int;
313 else if ( !strncmp( psz_var, "marq-size", 6 ) )
315 p_sys->i_font_size = newval.i_int;
317 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
319 p_sys->i_timeout = newval.i_int;
321 else if ( !strncmp( psz_var, "marq-position", 8 ) )
322 /* willing to accept a match against marq-pos */
324 p_sys->i_pos = newval.i_int;
325 p_sys->i_xoff = -1; /* force to relative positioning */
327 p_sys->b_need_update = VLC_TRUE;