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