/*****************************************************************************
* time.c : time display video plugin for vlc
*****************************************************************************
- * Copyright (C) 2003-2004 VideoLAN
- * $Id: logo.c 8721 2004-09-17 10:21:00Z gbazin $
+ * Copyright (C) 2003-2005 the VideoLAN team
+ * $Id$
*
* Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
*
#include <stdlib.h> /* malloc(), free() */
#include <string.h>
+#include <time.h>
+
#include <vlc/vlc.h>
#include <vlc/vout.h>
#include "vlc_filter.h"
#include "vlc_block.h"
+#include "osd.h"
/*****************************************************************************
* Local prototypes
static int CreateFilter ( vlc_object_t * );
static void DestroyFilter( vlc_object_t * );
static subpicture_t *Filter( filter_t *, mtime_t );
+static int TimeCallback( vlc_object_t *p_this, char const *psz_var,
+ vlc_value_t oldval, vlc_value_t newval,
+ void *p_data );
+static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
+ 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
+ 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
+ 0x00000080, 0x000000FF, 0x0000FFFF};
+static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
+ N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
+ N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
+ N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
+ N_("Aqua") };
/*****************************************************************************
* filter_sys_t: time filter descriptor
*****************************************************************************/
struct filter_sys_t
{
+ int i_xoff, i_yoff; /* offsets for the display string in the video window */
+ char *psz_format; /* time format string */
+ int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
+ int i_font_color, i_font_opacity, i_font_size; /* font control */
+
+ time_t last_time;
};
+#define MSG_TEXT N_("Time format string (%Y%m%d %H%M%S)")
+#define MSG_LONGTEXT N_("Time format string (%Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second")
+#define POSX_TEXT N_("X offset, from left")
+#define POSX_LONGTEXT N_("X offset, from the left screen edge" )
+#define POSY_TEXT N_("Y offset, from the top")
+#define POSY_LONGTEXT N_("Y offset, down from the top" )
+#define OPACITY_TEXT N_("Opacity, 0..255")
+#define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
+ "overlay text. 0 = transparent, 255 = totally opaque. " )
+#define SIZE_TEXT N_("Font size, pixels")
+#define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
+ "with -1 = use freetype-fontsize" )
+
+#define COLOR_TEXT N_("Text Default Color")
+#define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal. " \
+ "#000000 = all colors off, " \
+ "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
+#define POS_TEXT N_("Time position")
+#define POS_LONGTEXT N_( \
+ "You can enforce the time position on the video " \
+ "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
+ "also use combinations of these values by adding them).")
+
+static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
+static char *ppsz_pos_descriptions[] =
+ { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
+ N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
/*****************************************************************************
* Module descriptor
*****************************************************************************/
vlc_module_begin();
set_capability( "sub filter", 0 );
+ set_shortname( N_("Time overlay"));
+ set_category( CAT_VIDEO );
+ set_subcategory( SUBCAT_VIDEO_SUBPIC );
set_callbacks( CreateFilter, DestroyFilter );
+ add_string( "time-format", "%Y-%m-%d %H:%M:%S", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
+ add_integer( "time-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
+ add_integer( "time-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
+ add_integer( "time-position", 9, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
+ /* 9 sets the default to bottom-left, minimizing jitter */
+ change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
+ add_integer_with_range( "time-opacity", 255, 0, 255, NULL,
+ OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
+ add_integer( "time-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
+ change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
+ add_integer( "time-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
set_description( _("Time display sub filter") );
add_shortcut( "time" );
vlc_module_end();
/*****************************************************************************
- * CreateFilter: allocates logo video filter
+ * CreateFilter: allocates time video filter
*****************************************************************************/
static int CreateFilter( vlc_object_t *p_this )
{
filter_t *p_filter = (filter_t *)p_this;
filter_sys_t *p_sys;
+ vlc_object_t *p_input;
/* Allocate structure */
p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
msg_Err( p_filter, "out of memory" );
return VLC_ENOMEM;
}
+ /* Hook used for callback variables */
+ p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
+ if( !p_input )
+ {
+ return VLC_ENOOBJ;
+ }
+
+ p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "time-x" );
+ p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "time-y" );
+ p_sys->psz_format = var_CreateGetString( p_input->p_libvlc, "time-format" );
+ p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "time-position" );
+ var_Create( p_input->p_libvlc, "time-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
+ p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "time-opacity" );
+ p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "time-color" );
+ p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "time-size" );
+
+ var_AddCallback( p_input->p_libvlc, "time-x", TimeCallback, p_sys );
+ var_AddCallback( p_input->p_libvlc, "time-y", TimeCallback, p_sys );
+ var_AddCallback( p_input->p_libvlc, "time-format", TimeCallback, p_sys );
+ var_AddCallback( p_input->p_libvlc, "time-position", TimeCallback, p_sys );
+ var_AddCallback( p_input->p_libvlc, "time-color", TimeCallback, p_sys );
+ var_AddCallback( p_input->p_libvlc, "time-opacity", TimeCallback, p_sys );
+ var_AddCallback( p_input->p_libvlc, "time-size", TimeCallback, p_sys );
+
+ vlc_object_release( p_input );
/* Misc init */
p_filter->pf_sub_filter = Filter;
+ p_sys->last_time = ((time_t)-1);
return VLC_SUCCESS;
}
{
filter_t *p_filter = (filter_t *)p_this;
filter_sys_t *p_sys = p_filter->p_sys;
+ vlc_object_t *p_input;
+ if( p_sys->psz_format ) free( p_sys->psz_format );
free( p_sys );
+ /* Delete the time variables */
+ p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
+ if( !p_input )
+ {
+ return;
+ }
+ var_Destroy( p_input->p_libvlc , "time-format" );
+ var_Destroy( p_input->p_libvlc , "time-x" );
+ var_Destroy( p_input->p_libvlc , "time-y" );
+ var_Destroy( p_input->p_libvlc , "time-position" );
+ var_Destroy( p_input->p_libvlc , "time-color");
+ var_Destroy( p_input->p_libvlc , "time-opacity");
+ var_Destroy( p_input->p_libvlc , "time-size");
+
+ vlc_object_release( p_input );
}
-char *myCtime( time_t *t )
+static char *FormatTime(char *tformat )
{
-#ifdef HAVE_CTIME_R
- char tmp[27];
- ctime_r( t, tmp );
- return strdup( tmp );
+ char buffer[255];
+ time_t curtime;
+#if defined(HAVE_LOCALTIME_R)
+ struct tm loctime;
#else
- return strdup(ctime(t));
+ struct tm *loctime;
#endif
+
+ /* Get the current time. */
+ curtime = time( NULL );
+
+ /* Convert it to local time representation. */
+#if defined(HAVE_LOCALTIME_R)
+ localtime_r( &curtime, &loctime );
+ strftime( buffer, 255, tformat, &loctime );
+#else
+ loctime = localtime( &curtime );
+ strftime( buffer, 255, tformat, loctime );
+#endif
+ return strdup( buffer );
}
/****************************************************************************
****************************************************************************/
static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
{
+ filter_sys_t *p_sys = p_filter->p_sys;
subpicture_t *p_spu;
video_format_t fmt;
- time_t t;
+
+ if( p_sys->last_time == time( NULL ) ) return NULL;
+
p_spu = p_filter->pf_sub_buffer_new( p_filter );
if( !p_spu ) return NULL;
-
+
memset( &fmt, 0, sizeof(video_format_t) );
fmt.i_chroma = VLC_FOURCC('T','E','X','T');
fmt.i_aspect = 0;
- fmt.i_width = fmt.i_height = 0;
- fmt.i_x_offset = fmt.i_y_offset = 0;
-
+ fmt.i_width = fmt.i_height = 0;
+ fmt.i_x_offset = 0;
+ fmt.i_y_offset = 0;
p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
if( !p_spu->p_region )
{
p_filter->pf_sub_buffer_del( p_filter, p_spu );
return NULL;
}
- t = time(NULL);
- p_spu->p_region->psz_text = myCtime(&t);
+
+ p_sys->last_time = time( NULL );
+
+ p_spu->p_region->psz_text = FormatTime( p_sys->psz_format );
p_spu->i_start = date;
- p_spu->i_stop = date + 1000000;
+ p_spu->i_stop = 0;
p_spu->b_ephemer = VLC_TRUE;
- p_spu->b_absolute = VLC_FALSE;
- p_spu->i_x = 10;
- p_spu->i_y = 10;
- p_spu->i_flags = 0;
+
+ /* where to locate the string: */
+ if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
+ { /* set to one of the 9 relative locations */
+ p_spu->i_flags = p_sys->i_pos;
+ p_spu->i_x = 0;
+ p_spu->i_y = 0;
+ p_spu->b_absolute = VLC_FALSE;
+ }
+ else
+ { /* set to an absolute xy, referenced to upper left corner */
+ p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
+ p_spu->i_x = p_sys->i_xoff;
+ p_spu->i_y = p_sys->i_yoff;
+ p_spu->b_absolute = VLC_TRUE;
+ }
+ p_spu->p_region->i_text_color = p_sys->i_font_color;
+ p_spu->p_region->i_text_alpha = 255 - p_sys->i_font_opacity;
+ p_spu->p_region->i_text_size = p_sys->i_font_size;
+
return p_spu;
}
+/**********************************************************************
+ * Callback to update params on the fly
+ **********************************************************************/
+static int TimeCallback( vlc_object_t *p_this, char const *psz_var,
+ vlc_value_t oldval, vlc_value_t newval,
+ void *p_data )
+{
+ filter_sys_t *p_sys = (filter_sys_t *) p_data;
+
+ if( !strncmp( psz_var, "time-format", 11 ) )
+ {
+ if( p_sys->psz_format ) free( p_sys->psz_format );
+ p_sys->psz_format = strdup( newval.psz_string );
+ }
+ else if ( !strncmp( psz_var, "time-x", 6 ) )
+ {
+ p_sys->i_xoff = newval.i_int;
+ }
+ else if ( !strncmp( psz_var, "time-y", 6 ) )
+ {
+ p_sys->i_yoff = newval.i_int;
+ }
+ else if ( !strncmp( psz_var, "time-color", 8 ) ) /* "time-c" */
+ {
+ p_sys->i_font_color = newval.i_int;
+ }
+ else if ( !strncmp( psz_var, "time-opacity", 8 ) ) /* "time-o" */
+ {
+ p_sys->i_font_opacity = newval.i_int;
+ }
+ else if ( !strncmp( psz_var, "time-size", 6 ) )
+ {
+ p_sys->i_font_size = newval.i_int;
+ }
+ else if ( !strncmp( psz_var, "time-position", 8 ) )
+ /* willing to accept a match against time-pos */
+ {
+ p_sys->i_pos = newval.i_int;
+ p_sys->i_xoff = -1; /* force to relative positioning */
+ }
+ return VLC_SUCCESS;
+}
projects / vlc / blobdiff