git.sesse.net Git - vlc/blob - modules/video_filter/time.c

   1 /*****************************************************************************
   2  * time.c : time display video plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2003-2005 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28 #include <string.h>
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc/vout.h>
  32
  33 #include "vlc_filter.h"
  34 #include "vlc_block.h"
  35 #include "osd.h"
  36
  37 /*****************************************************************************
  38  * Local prototypes
  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,
  45                             void *p_data );
  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"),
  54                N_("Aqua") };
  55
  56 /*****************************************************************************
  57  * filter_sys_t: time filter descriptor
  58  *****************************************************************************/
  59 struct filter_sys_t
  60 {
  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; /* font color control */
  65     vlc_bool_t b_absolute;  /* position control, relative vs. absolute */
  66
  67     time_t last_time;
  68 };
  69
  70 #define MSG_TEXT N_("Time format string (%Y%m%d %H%M%S)")
  71 #define MSG_LONGTEXT N_("Time format string (%Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second")
  72 #define POSX_TEXT N_("X offset, from left")
  73 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
  74 #define POSY_TEXT N_("Y offset, from the top")
  75 #define POSY_LONGTEXT N_("Y offset, down from the top" )
  76 #define OPACITY_TEXT N_("Opacity, -1..255")
  77 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of overlay text. " \
  78     "-1 = use freetype-opacity, 0 = transparent, 255 = totally opaque. " )
  79 #define COLOR_TEXT N_("Text Default Color")
  80 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal." \
  81     "-1 = use freetype-color, #000000 = all colors off, " \
  82     "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
  83 #define POS_TEXT N_("Time position")
  84 #define POS_LONGTEXT N_( \
  85   "You can enforce the time position on the video " \
  86   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  87   "also use combinations of these values by adding them).")
  88
  89 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  90 static char *ppsz_pos_descriptions[] =
  91      { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  92      N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
  93
  94 /*****************************************************************************
  95  * Module descriptor
  96  *****************************************************************************/
  97 vlc_module_begin();
  98     set_capability( "sub filter", 0 );
  99     set_shortname( N_("Time overlay"));
 100     set_category( CAT_VIDEO );
 101     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 102     set_callbacks( CreateFilter, DestroyFilter );
 103     add_string( "time-format", "%Y-%m-%d   %H:%M:%S", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
 104     add_integer( "time-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
 105     add_integer( "time-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
 106     add_integer( "time-position", 9, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
 107     /* 9 sets the default to bottom-left, minimizing jitter */
 108     change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
 109     add_integer_with_range( "time-opacity", -1, -1, 255, NULL,
 110         OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
 111     add_integer( "time-color", -1, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
 112         change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
 113     set_description( _("Time display sub filter") );
 114     add_shortcut( "time" );
 115 vlc_module_end();
 116
 117 /*****************************************************************************
 118  * CreateFilter: allocates time video filter
 119  *****************************************************************************/
 120 static int CreateFilter( vlc_object_t *p_this )
 121 {
 122     filter_t *p_filter = (filter_t *)p_this;
 123     filter_sys_t *p_sys;
 124     vlc_object_t *p_input;
 125     vlc_value_t     val;
 126
 127     /* Allocate structure */
 128     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 129     if( p_sys == NULL )
 130     {
 131         msg_Err( p_filter, "out of memory" );
 132         return VLC_ENOMEM;
 133     }
 134     /* Hook used for callback variables */
 135     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 136     if( !p_input )
 137     {
 138         return VLC_ENOOBJ;
 139     }
 140
 141     p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "time-x" );
 142     p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "time-y" );
 143     p_sys->psz_format = var_CreateGetString( p_input->p_libvlc, "time-format" );
 144     p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "time-position" );
 145     var_Create( p_input->p_libvlc, "time-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 146     p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "time-opacity" );
 147     p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "time-color" );
 148
 149     var_AddCallback( p_input->p_libvlc, "time-x", TimeCallback, p_sys );
 150     var_AddCallback( p_input->p_libvlc, "time-y", TimeCallback, p_sys );
 151     var_AddCallback( p_input->p_libvlc, "time-format", TimeCallback, p_sys );
 152     var_AddCallback( p_input->p_libvlc, "time-position", TimeCallback, p_sys );
 153     var_AddCallback( p_input->p_libvlc, "time-color", TimeCallback, p_sys );
 154     var_AddCallback( p_input->p_libvlc, "time-opacity", TimeCallback, p_sys );
 155
 156     vlc_object_release( p_input );
 157
 158     /* Misc init */
 159     p_filter->pf_sub_filter = Filter;
 160     p_sys->last_time = ((time_t)-1);
 161
 162     return VLC_SUCCESS;
 163 }
 164 /*****************************************************************************
 165  * DestroyFilter: destroy logo video filter
 166  *****************************************************************************/
 167 static void DestroyFilter( vlc_object_t *p_this )
 168 {
 169     filter_t *p_filter = (filter_t *)p_this;
 170     filter_sys_t *p_sys = p_filter->p_sys;
 171     vlc_object_t *p_input;
 172
 173     if( p_sys->psz_format ) free( p_sys->psz_format );
 174     free( p_sys );
 175     /* Delete the time variables */
 176     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
 177     if( !p_input )
 178     {
 179         return;
 180     }
 181     var_Destroy( p_input->p_libvlc , "time-format" );
 182     var_Destroy( p_input->p_libvlc , "time-x" );
 183     var_Destroy( p_input->p_libvlc , "time-y" );
 184     var_Destroy( p_input->p_libvlc , "time-position" );
 185     var_Destroy( p_input->p_libvlc , "time-color");
 186     var_Destroy( p_input->p_libvlc , "time-opacity");
 187     vlc_object_release( p_input );
 188 }
 189
 190 static char *FormatTime(char *tformat )
 191 {
 192   char buffer[255];
 193   time_t curtime;
 194 #if defined(HAVE_LOCALTIME_R)
 195   struct tm loctime;
 196 #else
 197   struct tm *loctime;
 198 #endif
 199
 200   /* Get the current time.  */
 201   curtime = time( NULL );
 202
 203   /* Convert it to local time representation.  */
 204 #if defined(HAVE_LOCALTIME_R)
 205   localtime_r( &curtime, &loctime );
 206   strftime( buffer, 255, tformat, &loctime );
 207 #else
 208   loctime = localtime( &curtime );
 209   strftime( buffer, 255, tformat, loctime );
 210 #endif
 211   return strdup( buffer );
 212 }
 213
 214 /****************************************************************************
 215  * Filter: the whole thing
 216  ****************************************************************************
 217  * This function outputs subpictures at regular time intervals.
 218  ****************************************************************************/
 219 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 220 {
 221     filter_sys_t *p_sys = p_filter->p_sys;
 222     subpicture_t *p_spu;
 223     video_format_t fmt;
 224
 225     if( p_sys->last_time == time( NULL ) ) return NULL;
 226
 227     p_sys->b_absolute = VLC_TRUE;
 228     if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
 229     {
 230         p_sys->b_absolute = VLC_FALSE;
 231     }
 232
 233     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 234     if( !p_spu ) return NULL;
 235
 236     p_spu->b_absolute = p_sys->b_absolute;
 237     memset( &fmt, 0, sizeof(video_format_t) );
 238     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
 239     fmt.i_aspect = 0;
 240     fmt.i_width = fmt.i_height = 0;
 241     fmt.i_x_offset = 0;
 242     fmt.i_y_offset = 0;
 243     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 244     if( !p_spu->p_region )
 245     {
 246         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 247         return NULL;
 248     }
 249
 250     p_sys->last_time = time( NULL );
 251
 252     p_spu->p_region->psz_text = FormatTime( p_sys->psz_format );
 253     p_spu->i_start = date;
 254     p_spu->i_stop  = 0;
 255     p_spu->b_ephemer = VLC_TRUE;
 256     p_spu->b_absolute = VLC_FALSE;
 257     p_spu->i_x = p_sys->i_xoff;
 258     p_spu->i_y = p_sys->i_yoff;
 259     p_spu->p_region->i_font_color = p_sys->i_font_color;
 260     p_spu->p_region->i_font_opacity = p_sys->i_font_opacity;;
 261
 262     p_spu->i_flags = p_sys->i_pos;
 263
 264     return p_spu;
 265 }
 266 /**********************************************************************
 267  * Callback to update params on the fly
 268  **********************************************************************/
 269 static int TimeCallback( vlc_object_t *p_this, char const *psz_var,
 270                             vlc_value_t oldval, vlc_value_t newval,
 271                             void *p_data )
 272 {
 273     filter_sys_t *p_sys = (filter_sys_t *) p_data;
 274
 275     if( !strncmp( psz_var, "time-format", 11 ) )
 276     {
 277         if( p_sys->psz_format ) free( p_sys->psz_format );
 278         p_sys->psz_format = strdup( newval.psz_string );
 279     }
 280     else if ( !strncmp( psz_var, "time-x", 6 ) )
 281     {
 282         p_sys->i_xoff = newval.i_int;
 283     }
 284     else if ( !strncmp( psz_var, "time-y", 6 ) )
 285     {
 286         p_sys->i_yoff = newval.i_int;
 287     }
 288     else if ( !strncmp( psz_var, "time-color", 8 ) )  /* "time-col" */
 289     {
 290         p_sys->i_font_color = newval.i_int;
 291     }
 292     else if ( !strncmp( psz_var, "time-opacity", 8 ) ) /* "time-opa" */
 293     {
 294         p_sys->i_font_opacity = newval.i_int;
 295     }
 296     else if ( !strncmp( psz_var, "time-position", 8 ) )
 297     /* willing to accept a match against time-pos */
 298     {
 299         p_sys->i_pos = newval.i_int;
 300         p_sys->i_xoff = -1;       /* force to relative positioning */
 301     }
 302     return VLC_SUCCESS;
 303 }