git.sesse.net Git - vlc/blob - modules/video_filter/marq.c

   1 /*****************************************************************************
   2  * marq.c : marquee display video plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2003-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Mark Moriarty
   8  *          Sigmund Augdal Helberg <dnumgis@videolan.org>
   9  *          Antoine Cellerier <dionoea . videolan \ org>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_vout.h>
  37
  38 #include "vlc_filter.h"
  39 #include "vlc_block.h"
  40 #include "vlc_osd.h"
  41
  42 #include "vlc_strings.h"
  43
  44 /*****************************************************************************
  45  * Local prototypes
  46  *****************************************************************************/
  47 static int  CreateFilter ( vlc_object_t * );
  48 static void DestroyFilter( vlc_object_t * );
  49 static subpicture_t *Filter( filter_t *, mtime_t );
  50
  51
  52 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
  53                             vlc_value_t oldval, vlc_value_t newval,
  54                             void *p_data );
  55 static const int pi_color_values[] = {
  56                0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
  57                0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
  58                0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
  59                0x00000080, 0x000000FF, 0x0000FFFF};
  60 static const char *const ppsz_color_descriptions[] = {
  61                N_("Default"), N_("Black"), N_("Gray"),
  62                N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
  63                N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
  64                N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
  65                N_("Aqua") };
  66
  67 /*****************************************************************************
  68  * filter_sys_t: marquee filter descriptor
  69  *****************************************************************************/
  70 struct filter_sys_t
  71 {
  72     int i_xoff, i_yoff;  /* offsets for the display string in the video window */
  73     int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
  74     int i_timeout;
  75
  76     char *psz_marquee;    /* marquee string */
  77
  78     text_style_t *p_style; /* font control */
  79
  80     mtime_t last_time;
  81     mtime_t i_refresh;
  82
  83     bool b_need_update;
  84 };
  85
  86 #define MSG_TEXT N_("Text")
  87 #define MSG_LONGTEXT N_( \
  88     "Marquee text to display. " \
  89     "(Available format strings: " \
  90     "Time related: %Y = year, %m = month, %d = day, %H = hour, " \
  91     "%M = minute, %S = second, ... " \
  92     "Meta data related: $a = artist, $b = album, $c = copyright, " \
  93     "$d = description, $e = encoded by, $g = genre, " \
  94     "$l = language, $n = track num, $p = now playing, " \
  95     "$r = rating, $s = subtitles language, $t = title, "\
  96     "$u = url, $A = date, " \
  97     "$B = audio bitrate (in kb/s), $C = chapter," \
  98     "$D = duration, $F = full name with path, $I = title, "\
  99     "$L = time left, " \
 100     "$N = name, $O = audio language, $P = position (in %), $R = rate, " \
 101     "$S = audio sample rate (in kHz), " \
 102     "$T = time, $U = publisher, $V = volume, $_ = new line) ")
 103 #define POSX_TEXT N_("X offset")
 104 #define POSX_LONGTEXT N_("X offset, from the left screen edge." )
 105 #define POSY_TEXT N_("Y offset")
 106 #define POSY_LONGTEXT N_("Y offset, down from the top." )
 107 #define TIMEOUT_TEXT N_("Timeout")
 108 #define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
 109                             "displayed. Default value is " \
 110                             "0 (remains forever).")
 111 #define REFRESH_TEXT N_("Refresh period in ms")
 112 #define REFRESH_LONGTEXT N_("Number of milliseconds between string updates. " \
 113                             "This is mainly usefull when using meta data " \
 114                             "or time format string sequences.")
 115 #define OPACITY_TEXT N_("Opacity")
 116 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
 117     "overlayed text. 0 = transparent, 255 = totally opaque. " )
 118 #define SIZE_TEXT N_("Font size, pixels")
 119 #define SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
 120     "font size)." )
 121
 122 #define COLOR_TEXT N_("Color")
 123 #define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
 124     "the video. This must be an hexadecimal (like HTML colors). The first two "\
 125     "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
 126     " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = white" )
 127
 128 #define POS_TEXT N_("Marquee position")
 129 #define POS_LONGTEXT N_( \
 130   "You can enforce the marquee position on the video " \
 131   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
 132   "also use combinations of these values, eg 6 = top-right).")
 133
 134 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
 135 static const char *const ppsz_pos_descriptions[] =
 136      { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
 137      N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
 138
 139 #define CFG_PREFIX "marq-"
 140
 141 /*****************************************************************************
 142  * Module descriptor
 143  *****************************************************************************/
 144 vlc_module_begin();
 145     set_capability( "sub filter", 0 );
 146     set_shortname( N_("Marquee" ));
 147     set_callbacks( CreateFilter, DestroyFilter );
 148     set_category( CAT_VIDEO );
 149     set_subcategory( SUBCAT_VIDEO_SUBPIC );
 150     add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
 151                 false );
 152
 153     set_section( N_("Position"), NULL );
 154     add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true );
 155     add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true );
 156     add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false );
 157         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
 158
 159     set_section( N_("Font"), NULL );
 160     /* 5 sets the default to top [1] left [4] */
 161     add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
 162         OPACITY_TEXT, OPACITY_LONGTEXT, false );
 163     add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
 164                  false );
 165         change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
 166     add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
 167                  false );
 168
 169     set_section( N_("Misc"), NULL );
 170     add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
 171                  false );
 172     add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
 173                  REFRESH_LONGTEXT, false );
 174
 175     set_description( N_("Marquee display") );
 176     add_shortcut( "time" );
 177     add_obsolete_string( "time-format" );
 178     add_obsolete_string( "time-x" );
 179     add_obsolete_string( "time-y" );
 180     add_obsolete_string( "time-position" );
 181     add_obsolete_string( "time-opacity" );
 182     add_obsolete_string( "time-color" );
 183     add_obsolete_string( "time-size" );
 184 vlc_module_end();
 185
 186 static const char *const ppsz_filter_options[] = {
 187     "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
 188     NULL
 189 };
 190
 191 /*****************************************************************************
 192  * CreateFilter: allocates marquee video filter
 193  *****************************************************************************/
 194 static int CreateFilter( vlc_object_t *p_this )
 195 {
 196     filter_t *p_filter = (filter_t *)p_this;
 197     filter_sys_t *p_sys;
 198
 199     /* Allocate structure */
 200     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 201     if( p_sys == NULL )
 202     {
 203         msg_Err( p_filter, "out of memory" );
 204         return VLC_ENOMEM;
 205     }
 206
 207     p_sys->p_style = malloc( sizeof( text_style_t ) );
 208     memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
 209
 210     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
 211                        p_filter->p_cfg );
 212
 213 #define CREATE_VAR( stor, type, var ) \
 214     p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
 215     var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
 216
 217     CREATE_VAR( i_xoff, Integer, "marq-x" );
 218     CREATE_VAR( i_yoff, Integer, "marq-y" );
 219     CREATE_VAR( i_timeout,Integer, "marq-timeout" );
 220     CREATE_VAR( i_refresh,Integer, "marq-refresh" );
 221     CREATE_VAR( i_pos, Integer, "marq-position" );
 222     CREATE_VAR( psz_marquee, String, "marq-marquee" );
 223     CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
 224     CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
 225     CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
 226
 227     p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
 228
 229     /* Misc init */
 230     p_filter->pf_sub_filter = Filter;
 231     p_sys->last_time = 0;
 232     p_sys->b_need_update = true;
 233
 234     return VLC_SUCCESS;
 235 }
 236 /*****************************************************************************
 237  * DestroyFilter: destroy marquee video filter
 238  *****************************************************************************/
 239 static void DestroyFilter( vlc_object_t *p_this )
 240 {
 241     filter_t *p_filter = (filter_t *)p_this;
 242     filter_sys_t *p_sys = p_filter->p_sys;
 243
 244     free( p_sys->p_style );
 245     free( p_sys->psz_marquee );
 246
 247     /* Delete the marquee variables */
 248 #define DEL_VAR(var) \
 249     var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
 250     var_Destroy( p_filter, var );
 251     DEL_VAR( "marq-x" );
 252     DEL_VAR( "marq-y" );
 253     DEL_VAR( "marq-marquee" );
 254     DEL_VAR( "marq-timeout" );
 255     DEL_VAR( "marq-position" );
 256     DEL_VAR( "marq-color" );
 257     DEL_VAR( "marq-opacity" );
 258     DEL_VAR( "marq-size" );
 259
 260     free( p_sys );
 261 }
 262
 263 /****************************************************************************
 264  * Filter: the whole thing
 265  ****************************************************************************
 266  * This function outputs subpictures at regular time intervals.
 267  ****************************************************************************/
 268 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 269 {
 270     filter_sys_t *p_sys = p_filter->p_sys;
 271     subpicture_t *p_spu;
 272     video_format_t fmt;
 273
 274     if( p_sys->last_time + p_sys->i_refresh*1000 > date )
 275     {
 276         return NULL;
 277     }
 278
 279     if( p_sys->b_need_update == false )
 280     {
 281         return NULL;
 282     }
 283
 284     p_spu = p_filter->pf_sub_buffer_new( p_filter );
 285     if( !p_spu ) return NULL;
 286
 287     memset( &fmt, 0, sizeof(video_format_t) );
 288     fmt.i_chroma = VLC_FOURCC('T','E','X','T');
 289     fmt.i_aspect = 0;
 290     fmt.i_width = fmt.i_height = 0;
 291     fmt.i_x_offset = 0;
 292     fmt.i_y_offset = 0;
 293     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
 294     if( !p_spu->p_region )
 295     {
 296         p_filter->pf_sub_buffer_del( p_filter, p_spu );
 297         return NULL;
 298     }
 299
 300     p_sys->last_time = date;
 301
 302     if( strchr( p_sys->psz_marquee, '%' ) || strchr( p_sys->psz_marquee, '$' ) )
 303     {
 304         p_sys->b_need_update = true;
 305     }
 306     else
 307     {
 308         p_sys->b_need_update = false;
 309     }
 310     p_spu->p_region->psz_text = str_format( p_filter, p_sys->psz_marquee );
 311     p_spu->i_start = date;
 312     p_spu->i_stop  = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
 313     p_spu->b_ephemer = true;
 314
 315     /*  where to locate the string: */
 316     if( p_sys->i_pos < 0 )
 317     {   /*  set to an absolute xy */
 318         p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
 319         p_spu->b_absolute = true;
 320     }
 321     else
 322     {   /* set to one of the 9 relative locations */
 323         p_spu->p_region->i_align = p_sys->i_pos;
 324         p_spu->b_absolute = false;
 325     }
 326
 327     p_spu->i_x = p_sys->i_xoff;
 328     p_spu->i_y = p_sys->i_yoff;
 329
 330     p_spu->p_region->p_style = p_sys->p_style;
 331
 332     return p_spu;
 333 }
 334
 335 /**********************************************************************
 336  * Callback to update params on the fly
 337  **********************************************************************/
 338 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
 339                             vlc_value_t oldval, vlc_value_t newval,
 340                             void *p_data )
 341 {
 342     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 343     filter_sys_t *p_sys = (filter_sys_t *) p_data;
 344
 345     if( !strncmp( psz_var, "marq-marquee", 7 ) )
 346     {
 347         free( p_sys->psz_marquee );
 348         p_sys->psz_marquee = strdup( newval.psz_string );
 349     }
 350     else if ( !strncmp( psz_var, "marq-x", 6 ) )
 351     {
 352         p_sys->i_xoff = newval.i_int;
 353     }
 354     else if ( !strncmp( psz_var, "marq-y", 6 ) )
 355     {
 356         p_sys->i_yoff = newval.i_int;
 357     }
 358     else if ( !strncmp( psz_var, "marq-color", 8 ) )  /* "marq-col" */
 359     {
 360         p_sys->p_style->i_font_color = newval.i_int;
 361     }
 362     else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
 363     {
 364         p_sys->p_style->i_font_alpha = 255 - newval.i_int;
 365     }
 366     else if ( !strncmp( psz_var, "marq-size", 6 ) )
 367     {
 368         p_sys->p_style->i_font_size = newval.i_int;
 369     }
 370     else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
 371     {
 372         p_sys->i_timeout = newval.i_int;
 373     }
 374     else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
 375     {
 376         p_sys->i_refresh = newval.i_int;
 377     }
 378     else if ( !strncmp( psz_var, "marq-position", 8 ) )
 379     /* willing to accept a match against marq-pos */
 380     {
 381         p_sys->i_pos = newval.i_int;
 382         p_sys->i_xoff = -1;       /* force to relative positioning */
 383     }
 384     p_sys->b_need_update = true;
 385     return VLC_SUCCESS;
 386 }