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