]> git.sesse.net Git - vlc/blob - modules/video_filter/marq.c
* include/vlc_filter.h, vlc_video.h, src/video_output/vout_subpictures.c: new simpler...
[vlc] / modules / video_filter / marq.c
1 /*****************************************************************************
2  * marq.c : marquee display video plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2003-2005 VideoLAN
5  * $Id: time.c 8751 2004-09-20 21:51:41Z gbazin $
6  *
7  * Authors: Mark Moriarty
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 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
46                             vlc_value_t oldval, vlc_value_t newval,
47                             void *p_data );
48 static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0, 
49                0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00, 
50                0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080, 
51                0x00000080, 0x000000FF, 0x0000FFFF}; 
52 static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"), 
53                N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
54                N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"), 
55                N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"), 
56                N_("Aqua") };
57
58 /*****************************************************************************
59  * filter_sys_t: marquee filter descriptor
60  *****************************************************************************/
61 struct filter_sys_t
62 {
63     int i_xoff, i_yoff;  /* offsets for the display string in the video window */
64     int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
65     int i_timeout;
66
67     char *psz_marquee;    /* marquee string */
68
69     int  i_font_color, i_font_opacity, i_font_size; /* font control */
70     
71     time_t last_time;
72
73     vlc_bool_t b_need_update;
74 };
75
76 #define MSG_TEXT N_("Marquee text")
77 #define MSG_LONGTEXT N_("Marquee text to display")
78 #define POSX_TEXT N_("X offset, from left")
79 #define POSX_LONGTEXT N_("X offset, from the left screen edge" )
80 #define POSY_TEXT N_("Y offset, from the top")
81 #define POSY_LONGTEXT N_("Y offset, down from the top" )
82 #define TIMEOUT_TEXT N_("Marquee timeout")
83 #define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
84                             "displayed, in milliseconds. Default value is " \
85                             "0 (remain forever).")
86 #define OPACITY_TEXT N_("Opacity, -1..255")
87 #define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
88     "overlay text. 0 = transparent, 255 = totally opaque. " )
89 #define SIZE_TEXT N_("Font size, pixels")
90 #define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
91     "with -1 = use freetype-fontsize" )
92
93 #define COLOR_TEXT N_("Text Default Color")
94 #define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal." \
95     "-1 = use freetype-color, #000000 = all colors off, " \
96     "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
97
98 #define POS_TEXT N_("Marquee position")
99 #define POS_LONGTEXT N_( \
100   "You can enforce the marquee position on the video " \
101   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
102   "also use combinations of these values by adding them).")
103
104 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
105 static char *ppsz_pos_descriptions[] =
106      { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
107      N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
108
109 /*****************************************************************************
110  * Module descriptor
111  *****************************************************************************/
112 vlc_module_begin();
113     set_capability( "sub filter", 0 );
114     set_shortname( N_("Marquee" ));
115     set_callbacks( CreateFilter, DestroyFilter );
116     set_category( CAT_VIDEO );
117     set_subcategory( SUBCAT_VIDEO_SUBPIC );
118     add_string( "marq-marquee", "Marquee", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
119     add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
120     add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
121     add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
122                  VLC_FALSE );
123     add_integer( "marq-position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
124     /* 5 sets the default to top [1] left [4] */
125     change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
126     add_integer_with_range( "marq-opacity", 0, 0, 255, NULL,
127         OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
128     add_integer( "marq-color", -1, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
129         change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
130     add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
131
132     set_description( _("Marquee display sub filter") );
133     add_shortcut( "marq" );
134 vlc_module_end();
135
136 /*****************************************************************************
137  * CreateFilter: allocates marquee video filter
138  *****************************************************************************/
139 static int CreateFilter( vlc_object_t *p_this )
140 {
141     filter_t *p_filter = (filter_t *)p_this;
142     filter_sys_t *p_sys;
143     vlc_object_t *p_input;
144
145     /* Allocate structure */
146     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
147     if( p_sys == NULL )
148     {
149         msg_Err( p_filter, "out of memory" );
150         return VLC_ENOMEM;
151     }
152
153     /* Hook used for callback variables */
154     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
155     if( !p_input )
156     {
157         return VLC_ENOOBJ;
158     }
159
160     p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "marq-x" );
161     p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "marq-y" );
162     p_sys->i_timeout = var_CreateGetInteger( p_input->p_libvlc , "marq-timeout" );
163     p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "marq-position" );
164     p_sys->psz_marquee =  var_CreateGetString( p_input->p_libvlc, "marq-marquee" );
165     var_Create( p_input->p_libvlc, "marq-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
166     p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "marq-opacity" );
167     p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "marq-color" );
168     p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "marq-size" );
169
170     var_AddCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
171     var_AddCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
172     var_AddCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
173     var_AddCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
174     var_AddCallback( p_input->p_libvlc, "marq-position", MarqueeCallback, p_sys );
175     var_AddCallback( p_input->p_libvlc, "marq-color", MarqueeCallback, p_sys );
176     var_AddCallback( p_input->p_libvlc, "marq-opacity", MarqueeCallback, p_sys );
177     var_AddCallback( p_input->p_libvlc, "marq-size", MarqueeCallback, p_sys );
178
179     vlc_object_release( p_input );
180
181
182     /* Misc init */
183     p_filter->pf_sub_filter = Filter;
184     p_sys->last_time = ((time_t)-1);
185     p_sys->b_need_update = VLC_TRUE;
186
187     return VLC_SUCCESS;
188 }
189 /*****************************************************************************
190  * DestroyFilter: destroy marquee video filter
191  *****************************************************************************/
192 static void DestroyFilter( vlc_object_t *p_this )
193 {
194     filter_t *p_filter = (filter_t *)p_this;
195     filter_sys_t *p_sys = p_filter->p_sys;
196     vlc_object_t *p_input;
197
198     if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
199     free( p_sys );
200
201     /* Delete the marquee variables */
202     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
203     if( !p_input )
204     {
205         return;
206     }
207     var_Destroy( p_input->p_libvlc , "marq-marquee" );
208     var_Destroy( p_input->p_libvlc , "marq-x" );
209     var_Destroy( p_input->p_libvlc , "marq-y" );
210     var_Destroy( p_input->p_libvlc , "marq-timeout" );
211     var_Destroy( p_input->p_libvlc , "marq-position" );
212     var_Destroy( p_input->p_libvlc , "marq-color");
213     var_Destroy( p_input->p_libvlc , "marq-opacity");
214     var_Destroy( p_input->p_libvlc , "marq-size");
215
216     vlc_object_release( p_input );
217 }
218
219 /****************************************************************************
220  * Filter: the whole thing
221  ****************************************************************************
222  * This function outputs subpictures at regular time intervals.
223  ****************************************************************************/
224 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
225 {
226     filter_sys_t *p_sys = p_filter->p_sys;
227     subpicture_t *p_spu;
228     video_format_t fmt;
229     time_t t;
230
231     if( p_sys->last_time == time( NULL ) )
232     {
233         return NULL;
234     }
235
236     if( p_sys->b_need_update == VLC_FALSE )
237     {
238         return NULL;
239     }
240
241     p_spu = p_filter->pf_sub_buffer_new( p_filter );
242     if( !p_spu ) return NULL;
243
244     memset( &fmt, 0, sizeof(video_format_t) );
245     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
246     fmt.i_aspect = 0;
247     fmt.i_width = fmt.i_height = 0;
248     fmt.i_x_offset = 0;
249     fmt.i_y_offset = 0;
250     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
251     if( !p_spu->p_region )
252     {
253         p_filter->pf_sub_buffer_del( p_filter, p_spu );
254         return NULL;
255     }
256
257     t = p_sys->last_time = time( NULL );
258
259     p_spu->p_region->psz_text = strdup(p_sys->psz_marquee);
260     p_spu->i_start = date;
261     p_spu->i_stop  = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
262     p_spu->b_ephemer = VLC_TRUE;
263
264     /*  where to locate the string: */
265     if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
266     {   /* set to one of the 9 relative locations */
267         p_spu->i_flags = p_sys->i_pos;
268         p_spu->i_x = 0;
269         p_spu->i_y = 0;
270         p_spu->b_absolute = VLC_FALSE;
271     }
272     else
273     {   /*  set to an absolute xy, referenced to upper left corner */
274             p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
275         p_spu->i_x = p_sys->i_xoff;
276         p_spu->i_y = p_sys->i_yoff;
277         p_spu->b_absolute = VLC_TRUE;
278     }
279     p_spu->p_region->i_text_color = p_sys->i_font_color;
280     p_spu->p_region->i_text_alpha = p_sys->i_font_opacity;
281     p_spu->p_region->i_text_size = p_sys->i_font_size;
282     
283
284     p_sys->b_need_update = VLC_FALSE;
285     return p_spu;
286 }
287
288 /**********************************************************************
289  * Callback to update params on the fly
290  **********************************************************************/
291 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
292                             vlc_value_t oldval, vlc_value_t newval,
293                             void *p_data )
294 {
295     filter_sys_t *p_sys = (filter_sys_t *) p_data;
296
297     if( !strncmp( psz_var, "marq-marquee", 7 ) )
298     {
299         if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
300         p_sys->psz_marquee = strdup( newval.psz_string );
301     }
302     else if ( !strncmp( psz_var, "marq-x", 6 ) )
303     {
304         p_sys->i_xoff = newval.i_int;
305     }
306     else if ( !strncmp( psz_var, "marq-y", 6 ) )
307     {
308         p_sys->i_yoff = newval.i_int;
309     }
310     else if ( !strncmp( psz_var, "marq-color", 8 ) )  /* "marq-col" */ 
311     {
312         p_sys->i_font_color = newval.i_int;
313     }
314     else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */ 
315     {
316         p_sys->i_font_opacity = newval.i_int;
317     }
318     else if ( !strncmp( psz_var, "marq-size", 6 ) )
319     {
320         p_sys->i_font_size = newval.i_int;
321     }
322     else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
323     {
324         p_sys->i_timeout = newval.i_int;
325     }
326     else if ( !strncmp( psz_var, "marq-position", 8 ) )
327     /* willing to accept a match against marq-pos */
328     {
329         p_sys->i_pos = newval.i_int;
330         p_sys->i_xoff = -1;       /* force to relative positioning */
331     }
332     p_sys->b_need_update = VLC_TRUE;
333     return VLC_SUCCESS;
334 }