1 /*****************************************************************************
2 * marq.c : marquee display video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2003-2005 the VideoLAN team
7 * Authors: Mark Moriarty
8 * Sigmund Augdal Helberg <dnumgis@videolan.org>
9 * Antoine Cellerier <dionoea . videolan \ org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
29 #include <stdlib.h> /* malloc(), free() */
37 #include "vlc_filter.h"
38 #include "vlc_block.h"
40 #include "vlc_playlist.h"
42 #include "vlc_input.h"
45 /*****************************************************************************
47 *****************************************************************************/
48 static int CreateFilter ( vlc_object_t * );
49 static void DestroyFilter( vlc_object_t * );
50 static subpicture_t *Filter( filter_t *, mtime_t );
53 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
54 vlc_value_t oldval, vlc_value_t newval,
56 static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
57 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
58 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
59 0x00000080, 0x000000FF, 0x0000FFFF};
60 static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
61 N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
62 N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
63 N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
66 /*****************************************************************************
67 * filter_sys_t: marquee filter descriptor
68 *****************************************************************************/
71 int i_xoff, i_yoff; /* offsets for the display string in the video window */
72 int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
75 char *psz_marquee; /* marquee string */
77 text_style_t *p_style; /* font control */
81 vlc_bool_t b_need_update;
84 #define MSG_TEXT N_("Text")
85 #define MSG_LONGTEXT N_( \
86 "Marquee text to display. " \
87 "(Available format strings: " \
88 "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
89 "%M = minute, %S = second, ... " \
90 "Meta data related: $a = artist, $b = album, $c = copyright, " \
91 "$d = description, $e = encoded by, $g = genre, " \
92 "$l = language, $n = track num, $p = now playing, " \
93 "$r = rating, $s = subtitles language, $t = title, "\
94 "$u = url, $A = date, " \
95 "$B = audio bitrate (in kb/s), $C = chapter," \
96 "$D = duration, $F = full name with path, $I = title, "\
98 "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
99 "$S = audio sample rate (in kHz), " \
100 "$T = time, $U = publisher, $V = volume, $_ = new line) ")
101 #define POSX_TEXT N_("X offset")
102 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
103 #define POSY_TEXT N_("Y offset")
104 #define POSY_LONGTEXT N_("Y offset, down from the top." )
105 #define TIMEOUT_TEXT N_("Timeout")
106 #define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
107 "displayed. Default value is " \
108 "0 (remains forever).")
109 #define OPACITY_TEXT N_("Opacity")
110 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
111 "overlayed text. 0 = transparent, 255 = totally opaque. " )
112 #define SIZE_TEXT N_("Font size, pixels")
113 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
116 #define COLOR_TEXT N_("Color")
117 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
118 "the video. This must be an hexadecimal (like HTML colors). The first two "\
119 "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
120 " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
122 #define POS_TEXT N_("Marquee position")
123 #define POS_LONGTEXT N_( \
124 "You can enforce the marquee position on the video " \
125 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
126 "also use combinations of these values, eg 6 = top-right).")
128 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
129 static char *ppsz_pos_descriptions[] =
130 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
131 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
133 /*****************************************************************************
135 *****************************************************************************/
137 set_capability( "sub filter", 0 );
138 set_shortname( N_("Marquee" ));
139 set_callbacks( CreateFilter, DestroyFilter );
140 set_category( CAT_VIDEO );
141 set_subcategory( SUBCAT_VIDEO_SUBPIC );
142 add_string( "marq-marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
145 set_section( N_("Position"), NULL );
146 add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
147 add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
148 add_integer( "marq-position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
150 set_section( N_("Font"), NULL );
151 /* 5 sets the default to top [1] left [4] */
152 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
153 add_integer_with_range( "marq-opacity", 255, 0, 255, NULL,
154 OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
155 add_integer( "marq-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
157 change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
158 add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
160 set_section( N_("Misc"), NULL );
161 add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
164 set_description( _("Marquee display") );
165 add_shortcut( "marq" );
166 add_shortcut( "time" );
169 /*****************************************************************************
170 * CreateFilter: allocates marquee video filter
171 *****************************************************************************/
172 static int CreateFilter( vlc_object_t *p_this )
174 filter_t *p_filter = (filter_t *)p_this;
177 /* Allocate structure */
178 p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
181 msg_Err( p_filter, "out of memory" );
185 p_sys->p_style = malloc( sizeof( text_style_t ) );
186 memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
188 #define CREATE_VAR( stor, type, var ) \
189 p_sys->stor = var_CreateGet##type( p_filter->p_libvlc, var ); \
190 var_AddCallback( p_filter->p_libvlc, var, MarqueeCallback, p_sys );
192 CREATE_VAR( i_xoff, Integer, "marq-x" );
193 CREATE_VAR( i_yoff, Integer, "marq-y" );
194 CREATE_VAR( i_timeout,Integer, "marq-timeout" );
195 CREATE_VAR( i_pos, Integer, "marq-position" );
196 CREATE_VAR( psz_marquee, String, "marq-marquee" );
197 CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
198 CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
199 CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
201 p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
204 p_filter->pf_sub_filter = Filter;
205 p_sys->last_time = ((time_t)-1);
206 p_sys->b_need_update = VLC_TRUE;
210 /*****************************************************************************
211 * DestroyFilter: destroy marquee video filter
212 *****************************************************************************/
213 static void DestroyFilter( vlc_object_t *p_this )
215 filter_t *p_filter = (filter_t *)p_this;
216 filter_sys_t *p_sys = p_filter->p_sys;
218 if( p_sys->p_style ) free( p_sys->p_style );
219 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
222 /* Delete the marquee variables */
223 #define DEL_VAR(var) \
224 var_DelCallback( p_filter->p_libvlc, var, MarqueeCallback, p_sys ); \
225 var_Destroy( p_filter->p_libvlc, var );
228 DEL_VAR( "marq-marquee" );
229 DEL_VAR( "marq-timeout" );
230 DEL_VAR( "marq-position" );
231 DEL_VAR( "marq-color" );
232 DEL_VAR( "marq-opacity" );
233 DEL_VAR( "marq-size" );
235 /****************************************************************************
236 * String formating functions
237 ****************************************************************************/
239 static char *FormatTime(char *tformat )
243 #if defined(HAVE_LOCALTIME_R)
249 /* Get the current time. */
250 curtime = time( NULL );
252 /* Convert it to local time representation. */
253 #if defined(HAVE_LOCALTIME_R)
254 localtime_r( &curtime, &loctime );
255 strftime( buffer, 255, tformat, &loctime );
257 loctime = localtime( &curtime );
258 strftime( buffer, 255, tformat, loctime );
260 return strdup( buffer );
263 #define INSERT_STRING( check, string ) \
264 if( check && string ) \
266 int len = strlen( string ); \
267 dst = realloc( dst, \
268 i_size = i_size + len + 1 ); \
269 strncpy( d, string, len+1 ); \
277 char *FormatMeta( vlc_object_t *p_object, char *string )
280 char *dst = malloc( 1000 );
284 int i_size = strlen( string );
286 playlist_t *p_playlist = pl_Yield( p_object );
287 input_thread_t *p_input = p_playlist->p_input;
288 input_item_t *p_item = NULL;
289 pl_Release( p_object );
292 vlc_object_yield( p_input );
293 p_item = p_input->input.p_item;
295 vlc_mutex_lock( &p_item->lock );
298 sprintf( dst, string );
307 INSERT_STRING( p_item && p_item->p_meta,
308 p_item->p_meta->psz_artist );
311 INSERT_STRING( p_item && p_item->p_meta,
312 p_item->p_meta->psz_album );
315 INSERT_STRING( p_item && p_item->p_meta,
316 p_item->p_meta->psz_copyright );
319 INSERT_STRING( p_item && p_item->p_meta,
320 p_item->p_meta->psz_description );
323 INSERT_STRING( p_item && p_item->p_meta,
324 p_item->p_meta->psz_encodedby );
327 INSERT_STRING( p_item && p_item->p_meta,
328 p_item->p_meta->psz_genre );
331 INSERT_STRING( p_item && p_item->p_meta,
332 p_item->p_meta->psz_language );
335 INSERT_STRING( p_item && p_item->p_meta,
336 p_item->p_meta->psz_tracknum );
339 INSERT_STRING( p_item && p_item->p_meta,
340 p_item->p_meta->psz_nowplaying );
343 INSERT_STRING( p_item && p_item->p_meta,
344 p_item->p_meta->psz_rating );
351 lang = var_GetString( p_input, "sub-language" );
355 lang = strdup( "-" );
357 INSERT_STRING( 1, lang );
361 INSERT_STRING( p_item && p_item->p_meta,
362 p_item->p_meta->psz_title );
365 INSERT_STRING( p_item && p_item->p_meta,
366 p_item->p_meta->psz_url );
369 INSERT_STRING( p_item && p_item->p_meta,
370 p_item->p_meta->psz_date );
375 snprintf( buf, 10, "%d",
376 var_GetInteger( p_input, "bit-rate" )/1000 );
382 INSERT_STRING( 1, buf );
387 snprintf( buf, 10, "%d",
388 var_GetInteger( p_input, "chapter" ) );
394 INSERT_STRING( 1, buf );
399 sprintf( buf, "%02d:%02d:%02d",
400 (int)(p_item->i_duration/(3600000000)),
401 (int)((p_item->i_duration/(60000000))%60),
402 (int)((p_item->i_duration/1000000)%60) );
406 sprintf( buf, "--:--:--" );
408 INSERT_STRING( 1, buf );
411 INSERT_STRING( p_item, p_item->psz_uri );
416 snprintf( buf, 10, "%d",
417 var_GetInteger( p_input, "title" ) );
423 INSERT_STRING( 1, buf );
426 if( p_item && p_input )
428 sprintf( buf, "%02d:%02d:%02d",
429 (int)((p_item->i_duration-p_input->i_time)/(3600000000)),
430 (int)(((p_item->i_duration-p_input->i_time)/(60000000))%60),
431 (int)(((p_item->i_duration-p_input->i_time)/1000000)%60) );
435 sprintf( buf, "--:--:--" );
437 INSERT_STRING( 1, buf );
440 INSERT_STRING( p_item, p_item->psz_name );
447 lang = var_GetString( p_input, "audio-language" );
451 lang = strdup( "-" );
453 INSERT_STRING( 1, lang );
459 snprintf( buf, 10, "%2.1lf",
460 var_GetFloat( p_input, "position" ) * 100. );
464 sprintf( buf, "--.-%%" );
466 INSERT_STRING( 1, buf );
471 int r = var_GetInteger( p_input, "rate" );
472 snprintf( buf, 10, "%d.%d", r/1000, r%1000 );
478 INSERT_STRING( 1, buf );
483 int r = var_GetInteger( p_input, "sample-rate" );
484 snprintf( buf, 10, "%d.%d", r/1000, (r/100)%10 );
490 INSERT_STRING( 1, buf );
495 sprintf( buf, "%02d:%02d:%02d",
496 (int)(p_input->i_time/(3600000000)),
497 (int)((p_input->i_time/(60000000))%60),
498 (int)((p_input->i_time/1000000)%60) );
502 sprintf( buf, "--:--:--" );
504 INSERT_STRING( 1, buf );
507 INSERT_STRING( p_item && p_item->p_meta,
508 p_item->p_meta->psz_publisher );
512 audio_volume_t volume;
513 aout_VolumeGet( p_object, &volume );
514 snprintf( buf, 10, "%d", volume );
515 INSERT_STRING( 1, buf );
545 vlc_object_release( p_input );
547 vlc_mutex_unlock( &p_item->lock );
553 /****************************************************************************
554 * Filter: the whole thing
555 ****************************************************************************
556 * This function outputs subpictures at regular time intervals.
557 ****************************************************************************/
558 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
560 filter_sys_t *p_sys = p_filter->p_sys;
566 if( p_sys->last_time == time( NULL ) )
571 /* if( p_sys->b_need_update == VLC_FALSE )
576 p_spu = p_filter->pf_sub_buffer_new( p_filter );
577 if( !p_spu ) return NULL;
579 memset( &fmt, 0, sizeof(video_format_t) );
580 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
582 fmt.i_width = fmt.i_height = 0;
585 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
586 if( !p_spu->p_region )
588 p_filter->pf_sub_buffer_del( p_filter, p_spu );
592 t = p_sys->last_time = time( NULL );
594 buf = FormatTime( p_sys->psz_marquee );
595 p_spu->p_region->psz_text = FormatMeta( VLC_OBJECT( p_filter ), buf );
597 p_spu->i_start = date;
598 p_spu->i_stop = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
599 p_spu->b_ephemer = VLC_TRUE;
601 /* where to locate the string: */
602 if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
603 { /* set to one of the 9 relative locations */
604 p_spu->i_flags = p_sys->i_pos;
607 p_spu->b_absolute = VLC_FALSE;
610 { /* set to an absolute xy, referenced to upper left corner */
611 p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
612 p_spu->i_x = p_sys->i_xoff;
613 p_spu->i_y = p_sys->i_yoff;
614 p_spu->b_absolute = VLC_TRUE;
616 p_spu->p_region->p_style = p_sys->p_style;
618 p_sys->b_need_update = VLC_FALSE;
622 /**********************************************************************
623 * Callback to update params on the fly
624 **********************************************************************/
625 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
626 vlc_value_t oldval, vlc_value_t newval,
629 filter_sys_t *p_sys = (filter_sys_t *) p_data;
631 if( !strncmp( psz_var, "marq-marquee", 7 ) )
633 if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
634 p_sys->psz_marquee = strdup( newval.psz_string );
636 else if ( !strncmp( psz_var, "marq-x", 6 ) )
638 p_sys->i_xoff = newval.i_int;
640 else if ( !strncmp( psz_var, "marq-y", 6 ) )
642 p_sys->i_yoff = newval.i_int;
644 else if ( !strncmp( psz_var, "marq-color", 8 ) ) /* "marq-col" */
646 p_sys->p_style->i_font_color = newval.i_int;
648 else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
650 p_sys->p_style->i_font_alpha = 255 - newval.i_int;
652 else if ( !strncmp( psz_var, "marq-size", 6 ) )
654 p_sys->p_style->i_font_size = newval.i_int;
656 else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
658 p_sys->i_timeout = newval.i_int;
660 else if ( !strncmp( psz_var, "marq-position", 8 ) )
661 /* willing to accept a match against marq-pos */
663 p_sys->i_pos = newval.i_int;
664 p_sys->i_xoff = -1; /* force to relative positioning */
666 p_sys->b_need_update = VLC_TRUE;