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-2004 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
  44 /*****************************************************************************
  45  * filter_sys_t: time filter descriptor
  46  *****************************************************************************/
  47 struct filter_sys_t
  48 {
  49     int i_xoff, i_yoff;  /* offsets for the display string in the video window */
  50     char *psz_format;    /* time format string */
  51
  52     time_t last_time;
  53 };
  54
  55 #define MSG_TEXT N_("Time format string (%Y%m%d %H%M%S)")
  56 #define MSG_LONGTEXT N_("Time format string (%Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second")
  57 #define POSX_TEXT N_("X offset, from left")
  58 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
  59 #define POSY_TEXT N_("Y offset, from the top")
  60 #define POSY_LONGTEXT N_("Y offset, down from the top" )
  61
  62 /*****************************************************************************
  63  * Module descriptor
  64  *****************************************************************************/
  65 vlc_module_begin();
  66     set_capability( "sub filter", 0 );
  67     set_category( CAT_VIDEO );
  68     set_subcategory( SUBCAT_VIDEO_SUBPIC );
  69     set_callbacks( CreateFilter, DestroyFilter );
  70     add_string( "time-format", "%Y-%m-%d   %H:%M:%S", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
  71     add_integer( "time-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
  72     add_integer( "time-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
  73     set_description( _("Time display sub filter") );
  74     add_shortcut( "time" );
  75 vlc_module_end();
  76
  77 /*****************************************************************************
  78  * CreateFilter: allocates logo video filter
  79  *****************************************************************************/
  80 static int CreateFilter( vlc_object_t *p_this )
  81 {
  82     filter_t *p_filter = (filter_t *)p_this;
  83     filter_sys_t *p_sys;
  84     vlc_value_t val;
  85
  86     /* Allocate structure */
  87     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
  88     if( p_sys == NULL )
  89     {
  90         msg_Err( p_filter, "out of memory" );
  91         return VLC_ENOMEM;
  92     }
  93
  94     var_Create( p_this, "time-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
  95     var_Get( p_filter, "time-x", &val );
  96     p_sys->i_xoff = val.i_int;
  97     var_Create( p_this, "time-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
  98     var_Get( p_filter, "time-y", &val );
  99     p_sys->i_yoff = val.i_int;
 100     p_sys->psz_format = var_CreateGetString( p_this, "time-format" );
 101
 102     /* Misc init */
 103     p_filter->pf_sub_filter = Filter;
 104     p_sys->last_time = ((time_t)-1);
 105
 106     return VLC_SUCCESS;
 107 }
 108 /*****************************************************************************
 109  * DestroyFilter: destroy logo video filter
 110  *****************************************************************************/
 111 static void DestroyFilter( vlc_object_t *p_this )
 112 {
 113     filter_t *p_filter = (filter_t *)p_this;
 114     filter_sys_t *p_sys = p_filter->p_sys;
 115
 116     if( p_sys->psz_format ) free( p_sys->psz_format );
 117     free( p_sys );
 118 }
 119
 120
 121 static char *FormatTime(char *tformat )
 122 {
 123   char buffer[255];
 124   time_t curtime;
 125 #if defined(HAVE_LOCALTIME_R)
 126   struct tm loctime;
 127 #else
 128   struct tm *loctime;
 129 #endif
 130
 131   /* Get the current time.  */
 132   curtime = time( NULL );
 133
 134   /* Convert it to local time representation.  */
 135 #if defined(HAVE_LOCALTIME_R)
 136   localtime_r( &curtime, &loctime );
 137   strftime( buffer, 255, tformat, &loctime );
 138 #else
 139   loctime = localtime( &curtime );
 140   strftime( buffer, 255, tformat, loctime );
 141 #endif
 142   return strdup( buffer );
 143 }
 144
 145 /****************************************************************************
 146  * Filter: the whole thing
 147  ****************************************************************************
 148  * This function outputs subpictures at regular time intervals.
 149  ****************************************************************************/
 150 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 151 {
 152     filter_sys_t *p_sys = p_filter->p_sys;
 153     subpicture_t *p_spu;
 154     video_format_t fmt;
 155
 156     if( p_sys->last_time == time( NULL ) ) return NULL;
 157
 158     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 159     if( !p_spu ) return NULL;
 160
 161     memset( &fmt, 0, sizeof(video_format_t) );
 162     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
 163     fmt.i_aspect = 0;
 164     fmt.i_width = fmt.i_height = 0;
 165     fmt.i_x_offset = 0;
 166     fmt.i_y_offset = 0;
 167
 168     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 169     if( !p_spu->p_region )
 170     {
 171         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 172         return NULL;
 173     }
 174
 175     p_sys->last_time = time( NULL );
 176
 177     p_spu->p_region->psz_text = FormatTime( p_sys->psz_format );
 178     p_spu->i_start = date;
 179     p_spu->i_stop  = 0;
 180     p_spu->b_ephemer = VLC_TRUE;
 181     p_spu->b_absolute = VLC_FALSE;
 182     p_spu->i_x = p_sys->i_xoff;
 183     p_spu->i_y = p_sys->i_yoff;
 184
 185     p_spu->i_flags = OSD_ALIGN_LEFT|OSD_ALIGN_TOP ;
 186     return p_spu;
 187 }