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: logo.c 8721 2004-09-17 10:21:00Z gbazin $
   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_head;  /* text to put before the day/time */
  51
  52     time_t last_time;
  53 };
  54
  55 #define MSG_TEXT N_("Timestamp Prefix")
  56 #define MSG_LONGTEXT N_("Text (name) to display before the date and time")
  57 #define POSX_TEXT N_("X coordinate of the timestamp")
  58 #define POSX_LONGTEXT N_("Positive offset, from the left" )
  59 #define POSY_TEXT N_("Y coordinate of the timestamp")
  60 #define POSY_LONGTEXT N_("Positive offset, down from the top" )
  61 #define TRANS_TEXT N_("Transparency of the timestamp")
  62
  63 /*****************************************************************************
  64  * Module descriptor
  65  *****************************************************************************/
  66 vlc_module_begin();
  67     set_capability( "sub filter", 0 );
  68     set_callbacks( CreateFilter, DestroyFilter );
  69     add_string( "time-text", NULL, NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
  70     add_integer( "time-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
  71     add_integer( "time-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
  72     set_description( _("Time display sub filter") );
  73     add_shortcut( "time" );
  74 vlc_module_end();
  75
  76 /*****************************************************************************
  77  * CreateFilter: allocates logo video filter
  78  *****************************************************************************/
  79 static int CreateFilter( vlc_object_t *p_this )
  80 {
  81     filter_t *p_filter = (filter_t *)p_this;
  82     filter_sys_t *p_sys;
  83     vlc_value_t val;
  84
  85     /* Allocate structure */
  86     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
  87     if( p_sys == NULL )
  88     {
  89         msg_Err( p_filter, "out of memory" );
  90         return VLC_ENOMEM;
  91     }
  92
  93     var_Create( p_this, "time-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
  94     var_Get( p_filter, "time-x", &val );
  95     p_sys->i_xoff = val.i_int;
  96     var_Create( p_this, "time-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
  97     var_Get( p_filter, "time-y", &val );
  98     p_sys->i_yoff = val.i_int;
  99     p_sys->psz_head = var_CreateGetString( p_this, "time-text" );
 100
 101     /* Misc init */
 102     p_filter->pf_sub_filter = Filter;
 103     p_sys->last_time = ((time_t)-1);
 104
 105     return VLC_SUCCESS;
 106 }
 107 /*****************************************************************************
 108  * DestroyFilter: destroy logo video filter
 109  *****************************************************************************/
 110 static void DestroyFilter( vlc_object_t *p_this )
 111 {
 112     filter_t *p_filter = (filter_t *)p_this;
 113     filter_sys_t *p_sys = p_filter->p_sys;
 114
 115     if( p_sys->psz_head ) free( p_sys->psz_head );
 116     free( p_sys );
 117 }
 118
 119 char *myCtime( time_t *t )
 120 {
 121 #ifdef HAVE_CTIME_R
 122     char tmp[27];
 123     ctime_r( t, tmp );
 124     return strdup( tmp );
 125 #else
 126     return strdup( ctime(t) );
 127 #endif
 128 }
 129
 130 /****************************************************************************
 131  * Filter: the whole thing
 132  ****************************************************************************
 133  * This function outputs subpictures at regular time intervals.
 134  ****************************************************************************/
 135 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 136 {
 137     filter_sys_t *p_sys = p_filter->p_sys;
 138     subpicture_t *p_spu;
 139     video_format_t fmt;
 140     time_t t;
 141     char *psz_time, *psz_string;
 142
 143     if( p_sys->last_time == time( NULL ) ) return NULL;
 144
 145     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 146     if( !p_spu ) return NULL;
 147
 148     memset( &fmt, 0, sizeof(video_format_t) );
 149     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
 150     fmt.i_aspect = 0;
 151     fmt.i_width = fmt.i_height = 0;
 152     fmt.i_x_offset = 0;
 153     fmt.i_y_offset = 0;
 154
 155     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 156     if( !p_spu->p_region )
 157     {
 158         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 159         return NULL;
 160     }
 161
 162     t = p_sys->last_time = time( NULL );
 163
 164     psz_time = myCtime( &t );
 165     asprintf( &psz_string, "%s%s", p_sys->psz_head, psz_time );
 166     free( psz_time );
 167
 168     p_spu->p_region->psz_text = psz_string;
 169     p_spu->i_start = date;
 170     p_spu->i_stop  = date + 1000000;
 171     p_spu->b_ephemer = VLC_TRUE;
 172     p_spu->b_absolute = VLC_FALSE;
 173     p_spu->i_x = p_sys->i_xoff;
 174     p_spu->i_y = p_sys->i_yoff;
 175
 176     p_spu->i_flags = OSD_ALIGN_LEFT|OSD_ALIGN_TOP ;
 177     return p_spu;
 178 }