1 /*****************************************************************************
2 * time.c : time display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2005 VideoLAN
7 * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
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 );
43 static int TimeCallback( vlc_object_t *p_this, char const *psz_var,
44 vlc_value_t oldval, vlc_value_t newval,
46 static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
47 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
48 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
49 0x00000080, 0x000000FF, 0x0000FFFF};
50 static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
51 N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
52 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
53 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
56 /*****************************************************************************
57 * filter_sys_t: time filter descriptor
58 *****************************************************************************/
61 int i_xoff, i_yoff; /* offsets for the display string in the video window */
62 char *psz_format; /* time format string */
63 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
64 int i_font_color, i_font_opacity, i_font_size; /* font control */
69 #define MSG_TEXT N_("Time format string (%Y%m%d %H%M%S)")
70 #define MSG_LONGTEXT N_("Time format string (%Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second")
71 #define POSX_TEXT N_("X offset, from left")
72 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
73 #define POSY_TEXT N_("Y offset, from the top")
74 #define POSY_LONGTEXT N_("Y offset, down from the top" )
75 #define OPACITY_TEXT N_("Opacity, 0..255")
76 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
77 "overlay text. 0 = transparent, 255 = totally opaque. " )
78 #define SIZE_TEXT N_("Font size, pixels")
79 #define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
80 "with -1 = use freetype-fontsize" )
82 #define COLOR_TEXT N_("Text Default Color")
83 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal." \
84 "-1 = use freetype-color, #000000 = all colors off, " \
85 "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
86 #define POS_TEXT N_("Time position")
87 #define POS_LONGTEXT N_( \
88 "You can enforce the time position on the video " \
89 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
90 "also use combinations of these values by adding them).")
92 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
93 static char *ppsz_pos_descriptions[] =
94 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
95 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
97 /*****************************************************************************
99 *****************************************************************************/
101 set_capability( "sub filter", 0 );
102 set_shortname( N_("Time overlay"));
103 set_category( CAT_VIDEO );
104 set_subcategory( SUBCAT_VIDEO_SUBPIC );
105 set_callbacks( CreateFilter, DestroyFilter );
106 add_string( "time-format", "%Y-%m-%d %H:%M:%S", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
107 add_integer( "time-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
108 add_integer( "time-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
109 add_integer( "time-position", 9, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
110 /* 9 sets the default to bottom-left, minimizing jitter */
111 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
112 add_integer_with_range( "time-opacity", 0, 0, 255, NULL,
113 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
114 add_integer( "time-color", -1, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
115 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
116 add_integer( "time-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
117 set_description( _("Time display sub filter") );
118 add_shortcut( "time" );
121 /*****************************************************************************
122 * CreateFilter: allocates time video filter
123 *****************************************************************************/
124 static int CreateFilter( vlc_object_t *p_this )
126 filter_t *p_filter = (filter_t *)p_this;
128 vlc_object_t *p_input;
130 /* Allocate structure */
131 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
134 msg_Err( p_filter, "out of memory" );
137 /* Hook used for callback variables */
138 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
144 p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "time-x" );
145 p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "time-y" );
146 p_sys->psz_format = var_CreateGetString( p_input->p_libvlc, "time-format" );
147 p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "time-position" );
148 var_Create( p_input->p_libvlc, "time-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
149 p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "time-opacity" );
150 p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "time-color" );
151 p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "time-size" );
153 var_AddCallback( p_input->p_libvlc, "time-x", TimeCallback, p_sys );
154 var_AddCallback( p_input->p_libvlc, "time-y", TimeCallback, p_sys );
155 var_AddCallback( p_input->p_libvlc, "time-format", TimeCallback, p_sys );
156 var_AddCallback( p_input->p_libvlc, "time-position", TimeCallback, p_sys );
157 var_AddCallback( p_input->p_libvlc, "time-color", TimeCallback, p_sys );
158 var_AddCallback( p_input->p_libvlc, "time-opacity", TimeCallback, p_sys );
159 var_AddCallback( p_input->p_libvlc, "time-size", TimeCallback, p_sys );
161 vlc_object_release( p_input );
164 p_filter->pf_sub_filter = Filter;
165 p_sys->last_time = ((time_t)-1);
169 /*****************************************************************************
170 * DestroyFilter: destroy logo video filter
171 *****************************************************************************/
172 static void DestroyFilter( vlc_object_t *p_this )
174 filter_t *p_filter = (filter_t *)p_this;
175 filter_sys_t *p_sys = p_filter->p_sys;
176 vlc_object_t *p_input;
178 if( p_sys->psz_format ) free( p_sys->psz_format );
180 /* Delete the time variables */
181 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
186 var_Destroy( p_input->p_libvlc , "time-format" );
187 var_Destroy( p_input->p_libvlc , "time-x" );
188 var_Destroy( p_input->p_libvlc , "time-y" );
189 var_Destroy( p_input->p_libvlc , "time-position" );
190 var_Destroy( p_input->p_libvlc , "time-color");
191 var_Destroy( p_input->p_libvlc , "time-opacity");
192 var_Destroy( p_input->p_libvlc , "time-size");
194 vlc_object_release( p_input );
197 static char *FormatTime(char *tformat )
201 #if defined(HAVE_LOCALTIME_R)
207 /* Get the current time. */
208 curtime = time( NULL );
210 /* Convert it to local time representation. */
211 #if defined(HAVE_LOCALTIME_R)
212 localtime_r( &curtime, &loctime );
213 strftime( buffer, 255, tformat, &loctime );
215 loctime = localtime( &curtime );
216 strftime( buffer, 255, tformat, loctime );
218 return strdup( buffer );
221 /****************************************************************************
222 * Filter: the whole thing
223 ****************************************************************************
224 * This function outputs subpictures at regular time intervals.
225 ****************************************************************************/
226 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
228 filter_sys_t *p_sys = p_filter->p_sys;
232 if( p_sys->last_time == time( NULL ) ) return NULL;
234 p_spu = p_filter->pf_sub_buffer_new( p_filter );
235 if( !p_spu ) return NULL;
237 memset( &fmt, 0, sizeof(video_format_t) );
238 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
240 fmt.i_width = fmt.i_height = 0;
243 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
244 if( !p_spu->p_region )
246 p_filter->pf_sub_buffer_del( p_filter, p_spu );
250 p_sys->last_time = time( NULL );
252 p_spu->p_region->psz_text = FormatTime( p_sys->psz_format );
253 p_spu->i_start = date;
255 p_spu->b_ephemer = VLC_TRUE;
257 /* where to locate the string: */
258 if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
259 { /* set to one of the 9 relative locations */
260 p_spu->i_flags = p_sys->i_pos;
263 p_spu->b_absolute = VLC_FALSE;
266 { /* set to an absolute xy, referenced to upper left corner */
267 p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
268 p_spu->i_x = p_sys->i_xoff;
269 p_spu->i_y = p_sys->i_yoff;
270 p_spu->b_absolute = VLC_TRUE;
272 p_spu->p_region->i_text_color = p_sys->i_font_color;
273 p_spu->p_region->i_text_alpha = 255 - p_sys->i_font_opacity;
274 p_spu->p_region->i_text_size = p_sys->i_font_size;
278 /**********************************************************************
279 * Callback to update params on the fly
280 **********************************************************************/
281 static int TimeCallback( vlc_object_t *p_this, char const *psz_var,
282 vlc_value_t oldval, vlc_value_t newval,
285 filter_sys_t *p_sys = (filter_sys_t *) p_data;
287 if( !strncmp( psz_var, "time-format", 11 ) )
289 if( p_sys->psz_format ) free( p_sys->psz_format );
290 p_sys->psz_format = strdup( newval.psz_string );
292 else if ( !strncmp( psz_var, "time-x", 6 ) )
294 p_sys->i_xoff = newval.i_int;
296 else if ( !strncmp( psz_var, "time-y", 6 ) )
298 p_sys->i_yoff = newval.i_int;
300 else if ( !strncmp( psz_var, "time-color", 8 ) ) /* "time-c" */
302 p_sys->i_font_color = newval.i_int;
304 else if ( !strncmp( psz_var, "time-opacity", 8 ) ) /* "time-o" */
306 p_sys->i_font_opacity = newval.i_int;
308 else if ( !strncmp( psz_var, "time-size", 6 ) )
310 p_sys->i_font_size = newval.i_int;
312 else if ( !strncmp( psz_var, "time-position", 8 ) )
313 /* willing to accept a match against time-pos */
315 p_sys->i_pos = newval.i_int;
316 p_sys->i_xoff = -1; /* force to relative positioning */