]> git.sesse.net Git - vlc/blobdiff - modules/video_filter/marq.c
Fixed the value set in text_style_t::i_font_alpha by the marquee filter.
[vlc] / modules / video_filter / marq.c
index 8c18c30f0338c39f81540f7942c395d9095ef821..cfcfe31e7cf98bb1e3c284f0138e2d18072f113f 100644 (file)
 
 #include <vlc_common.h>
 #include <vlc_plugin.h>
-#include <vlc_vout.h>
 
-#include "vlc_filter.h"
-#include "vlc_block.h"
-#include "vlc_osd.h"
+#include <vlc_filter.h>
+#include <vlc_block.h>
 
-#include "vlc_strings.h"
+#include <vlc_strings.h>
 
 /*****************************************************************************
  * Local prototypes
@@ -112,7 +110,7 @@ struct filter_sys_t
                             "0 (remains forever).")
 #define REFRESH_TEXT N_("Refresh period in ms")
 #define REFRESH_LONGTEXT N_("Number of milliseconds between string updates. " \
-                            "This is mainly usefull when using meta data " \
+                            "This is mainly useful when using meta data " \
                             "or time format string sequences.")
 #define OPACITY_TEXT N_("Opacity")
 #define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
@@ -140,53 +138,50 @@ static const char *const ppsz_pos_descriptions[] =
 
 #define CFG_PREFIX "marq-"
 
+#define MARQUEE_HELP N_("Display text above the video")
+
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
 vlc_module_begin ()
-    set_capability( "sub filter", 0 )
+    set_capability( "sub source", 0 )
     set_shortname( N_("Marquee" ))
+    set_description( N_("Marquee display") )
+    set_help(MARQUEE_HELP)
     set_callbacks( CreateFilter, DestroyFilter )
     set_category( CAT_VIDEO )
     set_subcategory( SUBCAT_VIDEO_SUBPIC )
-    add_string( CFG_PREFIX "marquee", "VLC", NULL, MSG_TEXT, MSG_LONGTEXT,
+    add_string( CFG_PREFIX "marquee", "VLC", MSG_TEXT, MSG_LONGTEXT,
                 false )
 
     set_section( N_("Position"), NULL )
-    add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true )
-    add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true )
-    add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false )
-        change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
+    add_integer( CFG_PREFIX "x", 0, POSX_TEXT, POSX_LONGTEXT, true )
+    add_integer( CFG_PREFIX "y", 0, POSY_TEXT, POSY_LONGTEXT, true )
+    add_integer( CFG_PREFIX "position", -1, POS_TEXT, POS_LONGTEXT, false )
+        change_integer_list( pi_pos_values, ppsz_pos_descriptions )
 
     set_section( N_("Font"), NULL )
     /* 5 sets the default to top [1] left [4] */
-    add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
+    add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255,
         OPACITY_TEXT, OPACITY_LONGTEXT, false )
-    add_integer( CFG_PREFIX "color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
+    add_integer( CFG_PREFIX "color", 0xFFFFFF, COLOR_TEXT, COLOR_LONGTEXT,
                  false )
-        change_integer_list( pi_color_values, ppsz_color_descriptions, NULL )
-    add_integer( CFG_PREFIX "size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT,
+        change_integer_list( pi_color_values, ppsz_color_descriptions )
+    add_integer( CFG_PREFIX "size", -1, SIZE_TEXT, SIZE_LONGTEXT,
                  false )
 
     set_section( N_("Misc"), NULL )
-    add_integer( CFG_PREFIX "timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
+    add_integer( CFG_PREFIX "timeout", 0, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
                  false )
-    add_integer( CFG_PREFIX "refresh", 1000, NULL, REFRESH_TEXT,
+    add_integer( CFG_PREFIX "refresh", 1000, REFRESH_TEXT,
                  REFRESH_LONGTEXT, false )
 
-    set_description( N_("Marquee display") )
     add_shortcut( "time" )
-    add_obsolete_string( "time-format" )
-    add_obsolete_string( "time-x" )
-    add_obsolete_string( "time-y" )
-    add_obsolete_string( "time-position" )
-    add_obsolete_string( "time-opacity" )
-    add_obsolete_string( "time-color" )
-    add_obsolete_string( "time-size" )
 vlc_module_end ()
 
 static const char *const ppsz_filter_options[] = {
     "marquee", "x", "y", "position", "color", "size", "timeout", "refresh",
+    "opacity",
     NULL
 };
 
@@ -209,27 +204,29 @@ static int CreateFilter( vlc_object_t *p_this )
     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
                        p_filter->p_cfg );
 
+
 #define CREATE_VAR( stor, type, var ) \
     p_sys->stor = var_CreateGet##type##Command( p_filter, var ); \
     var_AddCallback( p_filter, var, MarqueeCallback, p_sys );
 
+    p_sys->b_need_update = true;
     CREATE_VAR( i_xoff, Integer, "marq-x" );
     CREATE_VAR( i_yoff, Integer, "marq-y" );
     CREATE_VAR( i_timeout,Integer, "marq-timeout" );
-    CREATE_VAR( i_refresh,Integer, "marq-refresh" );
-    p_sys->i_refresh *= 1000;
+    p_sys->i_refresh = 1000 * var_CreateGetIntegerCommand( p_filter,
+                                                           "marq-refresh" );
+    var_AddCallback( p_filter, "marq-refresh", MarqueeCallback, p_sys );
     CREATE_VAR( i_pos, Integer, "marq-position" );
     CREATE_VAR( psz_marquee, String, "marq-marquee" );
-    CREATE_VAR( p_style->i_font_alpha, Integer, "marq-opacity" );
+    p_sys->p_style->i_font_alpha = var_CreateGetIntegerCommand( p_filter,
+                                                            "marq-opacity" );
+    var_AddCallback( p_filter, "marq-opacity", MarqueeCallback, p_sys );
     CREATE_VAR( p_style->i_font_color, Integer, "marq-color" );
     CREATE_VAR( p_style->i_font_size, Integer, "marq-size" );
 
-    p_sys->p_style->i_font_alpha = 255 - p_sys->p_style->i_font_alpha ;
-
     /* Misc init */
-    p_filter->pf_sub_filter = Filter;
+    p_filter->pf_sub_source = Filter;
     p_sys->last_time = 0;
-    p_sys->b_need_update = true;
 
     return VLC_SUCCESS;
 }
@@ -241,23 +238,23 @@ static void DestroyFilter( vlc_object_t *p_this )
     filter_t *p_filter = (filter_t *)p_this;
     filter_sys_t *p_sys = p_filter->p_sys;
 
-    text_style_Delete( p_sys->p_style );
-    free( p_sys->psz_marquee );
-
     /* Delete the marquee variables */
 #define DEL_VAR(var) \
     var_DelCallback( p_filter, var, MarqueeCallback, p_sys ); \
     var_Destroy( p_filter, var );
     DEL_VAR( "marq-x" );
     DEL_VAR( "marq-y" );
-    DEL_VAR( "marq-marquee" );
     DEL_VAR( "marq-timeout" );
+    DEL_VAR( "marq-refresh" );
     DEL_VAR( "marq-position" );
-    DEL_VAR( "marq-color" );
+    DEL_VAR( "marq-marquee" );
     DEL_VAR( "marq-opacity" );
+    DEL_VAR( "marq-color" );
     DEL_VAR( "marq-size" );
 
     vlc_mutex_destroy( &p_sys->lock );
+    text_style_Delete( p_sys->p_style );
+    free( p_sys->psz_marquee );
     free( p_sys );
 }
 
@@ -275,7 +272,7 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
     vlc_mutex_lock( &p_sys->lock );
     if( p_sys->last_time + p_sys->i_refresh > date )
         goto out;
-    if( p_sys->b_need_update == false )
+    if( !p_sys->b_need_update )
         goto out;
 
     p_spu = filter_NewSubpicture( p_filter );
@@ -284,7 +281,6 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
 
     memset( &fmt, 0, sizeof(video_format_t) );
     fmt.i_chroma = VLC_CODEC_TEXT;
-    fmt.i_aspect = 0;
     fmt.i_width = fmt.i_height = 0;
     fmt.i_x_offset = 0;
     fmt.i_y_offset = 0;
@@ -310,7 +306,7 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
     /*  where to locate the string: */
     if( p_sys->i_pos < 0 )
     {   /*  set to an absolute xy */
-        p_spu->p_region->i_align = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
+        p_spu->p_region->i_align = SUBPICTURE_ALIGN_LEFT | SUBPICTURE_ALIGN_TOP;
         p_spu->b_absolute = true;
     }
     else
@@ -342,40 +338,40 @@ static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
     VLC_UNUSED(p_this);
 
     vlc_mutex_lock( &p_sys->lock );
-    if( !strncmp( psz_var, "marq-marquee", 7 ) )
+    if( !strcmp( psz_var, "marq-marquee" ) )
     {
         free( p_sys->psz_marquee );
         p_sys->psz_marquee = strdup( newval.psz_string );
     }
-    else if ( !strncmp( psz_var, "marq-x", 6 ) )
+    else if ( !strcmp( psz_var, "marq-x" ) )
     {
         p_sys->i_xoff = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-y", 6 ) )
+    else if ( !strcmp( psz_var, "marq-y" ) )
     {
         p_sys->i_yoff = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-color", 8 ) )  /* "marq-col" */
+    else if ( !strcmp( psz_var, "marq-color" ) )
     {
         p_sys->p_style->i_font_color = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
+    else if ( !strcmp( psz_var, "marq-opacity" ) )
     {
-        p_sys->p_style->i_font_alpha = 255 - newval.i_int;
+        p_sys->p_style->i_font_alpha = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-size", 6 ) )
+    else if ( !strcmp( psz_var, "marq-size" ) )
     {
         p_sys->p_style->i_font_size = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
+    else if ( !strcmp( psz_var, "marq-timeout" ) )
     {
         p_sys->i_timeout = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-refresh", 12 ) )
+    else if ( !strcmp( psz_var, "marq-refresh" ) )
     {
         p_sys->i_refresh = newval.i_int * 1000;
     }
-    else if ( !strncmp( psz_var, "marq-position", 8 ) )
+    else if ( !strcmp( psz_var, "marq-position" ) )
     /* willing to accept a match against marq-pos */
     {
         p_sys->i_pos = newval.i_int;