1 /*****************************************************************************
2 * time.c : time display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2005 the VideoLAN team
7 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
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() */
35 #include "vlc_filter.h"
36 #include "vlc_block.h"
39 /*****************************************************************************
41 *****************************************************************************/
42 static int CreateFilter ( vlc_object_t * );
43 static void DestroyFilter( vlc_object_t * );
44 static subpicture_t *Filter( filter_t *, mtime_t );
45 static int TimeCallback( 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: time filter descriptor
60 *****************************************************************************/
63 int i_xoff, i_yoff; /* offsets for the display string in the video window */
64 char *psz_format; /* time format string */
65 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
66 int i_font_color, i_font_opacity, i_font_size; /* font control */
71 #define MSG_TEXT N_("Time format string (%Y%m%d %H%M%S)")
72 #define MSG_LONGTEXT N_("Time format string (%Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second")
73 #define POSX_TEXT N_("X offset, from left")
74 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
75 #define POSY_TEXT N_("Y offset, from the top")
76 #define POSY_LONGTEXT N_("Y offset, down from the top" )
77 #define OPACITY_TEXT N_("Opacity")
78 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
79 "overlay text. 0 = transparent, 255 = totally opaque. " )
80 #define SIZE_TEXT N_("Font size, pixels")
81 #define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
82 "with -1 = use freetype-fontsize" )
84 #define COLOR_TEXT N_("Text Default Color")
85 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal. " \
86 "#000000 = all colors off, " \
87 "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
88 #define POS_TEXT N_("Time position")
89 #define POS_LONGTEXT N_( \
90 "You can enforce the time position on the video " \
91 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
92 "also use combinations of these values by adding them).")
94 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
95 static char *ppsz_pos_descriptions[] =
96 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
97 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
99 /*****************************************************************************
101 *****************************************************************************/
103 set_capability( "sub filter", 0 );
104 set_shortname( N_("Time overlay"));
105 set_category( CAT_VIDEO );
106 set_subcategory( SUBCAT_VIDEO_SUBPIC );
107 set_callbacks( CreateFilter, DestroyFilter );
108 add_string( "time-format", "%Y-%m-%d %H:%M:%S", NULL, MSG_TEXT,
109 MSG_LONGTEXT, VLC_TRUE );
110 add_integer( "time-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
111 add_integer( "time-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
112 add_integer( "time-position", 9, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
113 /* 9 sets the default to bottom-left, minimizing jitter */
114 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
115 add_integer_with_range( "time-opacity", 255, 0, 255, NULL,
116 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
117 add_integer( "time-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
119 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
120 add_integer( "time-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
121 set_description( _("Time display sub filter") );
122 add_shortcut( "time" );
125 /*****************************************************************************
126 * CreateFilter: allocates time video filter
127 *****************************************************************************/
128 static int CreateFilter( vlc_object_t *p_this )
130 filter_t *p_filter = (filter_t *)p_this;
132 vlc_object_t *p_input;
134 /* Allocate structure */
135 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
138 msg_Err( p_filter, "out of memory" );
141 /* Hook used for callback variables */
142 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
148 p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "time-x" );
149 p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "time-y" );
150 p_sys->psz_format = var_CreateGetString( p_input->p_libvlc, "time-format" );
151 p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "time-position" );
152 var_Create( p_input->p_libvlc, "time-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
153 p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "time-opacity" );
154 p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "time-color" );
155 p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "time-size" );
157 var_AddCallback( p_input->p_libvlc, "time-x", TimeCallback, p_sys );
158 var_AddCallback( p_input->p_libvlc, "time-y", TimeCallback, p_sys );
159 var_AddCallback( p_input->p_libvlc, "time-format", TimeCallback, p_sys );
160 var_AddCallback( p_input->p_libvlc, "time-position", TimeCallback, p_sys );
161 var_AddCallback( p_input->p_libvlc, "time-color", TimeCallback, p_sys );
162 var_AddCallback( p_input->p_libvlc, "time-opacity", TimeCallback, p_sys );
163 var_AddCallback( p_input->p_libvlc, "time-size", TimeCallback, p_sys );
165 vlc_object_release( p_input );
168 p_filter->pf_sub_filter = Filter;
169 p_sys->last_time = ((time_t)-1);
173 /*****************************************************************************
174 * DestroyFilter: destroy logo video filter
175 *****************************************************************************/
176 static void DestroyFilter( vlc_object_t *p_this )
178 filter_t *p_filter = (filter_t *)p_this;
179 filter_sys_t *p_sys = p_filter->p_sys;
180 vlc_object_t *p_input;
182 if( p_sys->psz_format ) free( p_sys->psz_format );
184 /* Delete the time variables */
185 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
190 var_Destroy( p_input->p_libvlc , "time-format" );
191 var_Destroy( p_input->p_libvlc , "time-x" );
192 var_Destroy( p_input->p_libvlc , "time-y" );
193 var_Destroy( p_input->p_libvlc , "time-position" );
194 var_Destroy( p_input->p_libvlc , "time-color");
195 var_Destroy( p_input->p_libvlc , "time-opacity");
196 var_Destroy( p_input->p_libvlc , "time-size");
198 vlc_object_release( p_input );
201 static char *FormatTime(char *tformat )
205 #if defined(HAVE_LOCALTIME_R)
211 /* Get the current time. */
212 curtime = time( NULL );
214 /* Convert it to local time representation. */
215 #if defined(HAVE_LOCALTIME_R)
216 localtime_r( &curtime, &loctime );
217 strftime( buffer, 255, tformat, &loctime );
219 loctime = localtime( &curtime );
220 strftime( buffer, 255, tformat, loctime );
222 return strdup( buffer );
225 /****************************************************************************
226 * Filter: the whole thing
227 ****************************************************************************
228 * This function outputs subpictures at regular time intervals.
229 ****************************************************************************/
230 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
232 filter_sys_t *p_sys = p_filter->p_sys;
236 if( p_sys->last_time == time( NULL ) ) return NULL;
238 p_spu = p_filter->pf_sub_buffer_new( p_filter );
239 if( !p_spu ) return NULL;
241 memset( &fmt, 0, sizeof(video_format_t) );
242 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
244 fmt.i_width = fmt.i_height = 0;
247 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
248 if( !p_spu->p_region )
250 p_filter->pf_sub_buffer_del( p_filter, p_spu );
254 p_sys->last_time = time( NULL );
256 p_spu->p_region->psz_text = FormatTime( p_sys->psz_format );
257 p_spu->i_start = date;
259 p_spu->b_ephemer = VLC_TRUE;
261 /* where to locate the string: */
262 if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
263 { /* set to one of the 9 relative locations */
264 p_spu->i_flags = p_sys->i_pos;
267 p_spu->b_absolute = VLC_FALSE;
270 { /* set to an absolute xy, referenced to upper left corner */
271 p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
272 p_spu->i_x = p_sys->i_xoff;
273 p_spu->i_y = p_sys->i_yoff;
274 p_spu->b_absolute = VLC_TRUE;
276 p_spu->p_region->i_text_color = p_sys->i_font_color;
277 p_spu->p_region->i_text_alpha = 255 - p_sys->i_font_opacity;
278 p_spu->p_region->i_text_size = p_sys->i_font_size;
282 /**********************************************************************
283 * Callback to update params on the fly
284 **********************************************************************/
285 static int TimeCallback( vlc_object_t *p_this, char const *psz_var,
286 vlc_value_t oldval, vlc_value_t newval,
289 filter_sys_t *p_sys = (filter_sys_t *) p_data;
291 if( !strncmp( psz_var, "time-format", 11 ) )
293 if( p_sys->psz_format ) free( p_sys->psz_format );
294 p_sys->psz_format = strdup( newval.psz_string );
296 else if ( !strncmp( psz_var, "time-x", 6 ) )
298 p_sys->i_xoff = newval.i_int;
300 else if ( !strncmp( psz_var, "time-y", 6 ) )
302 p_sys->i_yoff = newval.i_int;
304 else if ( !strncmp( psz_var, "time-color", 8 ) ) /* "time-c" */
306 p_sys->i_font_color = newval.i_int;
308 else if ( !strncmp( psz_var, "time-opacity", 8 ) ) /* "time-o" */
310 p_sys->i_font_opacity = newval.i_int;
312 else if ( !strncmp( psz_var, "time-size", 6 ) )
314 p_sys->i_font_size = newval.i_int;
316 else if ( !strncmp( psz_var, "time-position", 8 ) )
317 /* willing to accept a match against time-pos */
319 p_sys->i_pos = newval.i_int;
320 p_sys->i_xoff = -1; /* force to relative positioning */