1 /*****************************************************************************
2 * marq.c : marquee display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2004 VideoLAN
5 * $Id: time.c 8751 2004-09-20 21:51:41Z gbazin $
7 * Authors: Mark Moriarty
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() */
33 #include "vlc_filter.h"
34 #include "vlc_block.h"
37 /*****************************************************************************
39 *****************************************************************************/
40 static int CreateFilter ( vlc_object_t * );
41 static void DestroyFilter( vlc_object_t * );
42 static subpicture_t *Filter( filter_t *, mtime_t );
45 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
46 vlc_value_t oldval, vlc_value_t newval,
49 /*****************************************************************************
50 * filter_sys_t: marquee filter descriptor
51 *****************************************************************************/
54 int i_xoff, i_yoff; /* offsets for the display string in the video window */
57 char *psz_marquee; /* marquee string */
61 vlc_bool_t b_need_update;
64 #define MSG_TEXT N_("Marquee text")
65 #define MSG_LONGTEXT N_("Marquee text to display")
66 #define POSX_TEXT N_("X offset, from left")
67 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
68 #define POSY_TEXT N_("Y offset, from the top")
69 #define POSY_LONGTEXT N_("Y offset, down from the top" )
70 #define TIMEOUT_TEXT N_("Marquee timeout")
71 #define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
72 "displayed, in milliseconds. Default value is " \
73 "0 (remain forever).")
75 /*****************************************************************************
77 *****************************************************************************/
79 set_capability( "sub filter", 0 );
80 set_callbacks( CreateFilter, DestroyFilter );
81 add_string( "marq-marquee", "Marquee", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
82 add_integer( "marq-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
83 add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
84 add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
86 set_description( _("Marquee display sub filter") );
87 add_shortcut( "marq" );
90 /*****************************************************************************
91 * CreateFilter: allocates marquee video filter
92 *****************************************************************************/
93 static int CreateFilter( vlc_object_t *p_this )
95 filter_t *p_filter = (filter_t *)p_this;
97 vlc_object_t *p_input;
99 /* Allocate structure */
100 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
103 msg_Err( p_filter, "out of memory" );
107 /* Hook used for callback variables */
108 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
114 p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "marq-x" );
115 p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "marq-y" );
116 p_sys->i_timeout = var_CreateGetInteger( p_input->p_libvlc , "marq-timeout" );
117 p_sys->psz_marquee = var_CreateGetString( p_input->p_libvlc, "marq-marquee" );
119 var_AddCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
120 var_AddCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
121 var_AddCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
122 var_AddCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
124 vlc_object_release( p_input );
127 p_filter->pf_sub_filter = Filter;
128 p_sys->last_time = ((time_t)-1);
129 p_sys->b_need_update = VLC_TRUE;
133 /*****************************************************************************
134 * DestroyFilter: destroy marquee video filter
135 *****************************************************************************/
136 static void DestroyFilter( vlc_object_t *p_this )
138 filter_t *p_filter = (filter_t *)p_this;
139 filter_sys_t *p_sys = p_filter->p_sys;
140 vlc_object_t *p_input;
142 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
145 /* Delete the marquee variables from playlist */
146 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
151 var_Destroy( p_input->p_libvlc , "marq-marquee" );
152 var_Destroy( p_input->p_libvlc , "marq-x" );
153 var_Destroy( p_input->p_libvlc , "marq-y" );
154 var_Destroy( p_input->p_libvlc , "marq-timeout" );
155 vlc_object_release( p_input );
158 /****************************************************************************
159 * Filter: the whole thing
160 ****************************************************************************
161 * This function outputs subpictures at regular time intervals.
162 ****************************************************************************/
163 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
165 filter_sys_t *p_sys = p_filter->p_sys;
170 if( p_sys->last_time == time( NULL ) )
175 if( p_sys->b_need_update == VLC_FALSE )
180 p_spu = p_filter->pf_sub_buffer_new( p_filter );
181 if( !p_spu ) return NULL;
183 memset( &fmt, 0, sizeof(video_format_t) );
184 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
186 fmt.i_width = fmt.i_height = 0;
190 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
191 if( !p_spu->p_region )
193 p_filter->pf_sub_buffer_del( p_filter, p_spu );
197 t = p_sys->last_time = time( NULL );
199 p_spu->p_region->psz_text = strdup(p_sys->psz_marquee);
200 p_spu->i_start = date;
201 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
202 p_spu->b_ephemer = VLC_TRUE;
203 p_spu->b_absolute = VLC_FALSE;
204 p_spu->i_x = p_sys->i_xoff;
205 p_spu->i_y = p_sys->i_yoff;
207 p_spu->i_flags = OSD_ALIGN_LEFT|OSD_ALIGN_TOP ;
209 p_sys->b_need_update = VLC_FALSE;
213 /**********************************************************************
214 * Callback to update params on the fly
215 **********************************************************************/
216 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
217 vlc_value_t oldval, vlc_value_t newval,
220 filter_sys_t *p_sys = (filter_sys_t *) p_data;
222 if( !strncmp( psz_var, "marq-marquee", 7 ) )
224 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
225 p_sys->psz_marquee = strdup( newval.psz_string );
227 else if ( !strncmp( psz_var, "marq-x", 6 ) )
229 p_sys->i_xoff = newval.i_int;
231 else if ( !strncmp( psz_var, "marq-y", 6 ) )
233 p_sys->i_yoff = newval.i_int;
235 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
237 p_sys->i_timeout = newval.i_int;
239 p_sys->b_need_update = VLC_TRUE;