]> git.sesse.net Git - vlc/blobdiff - modules/video_filter/marq.c
Merged OSD functionality on the same core functions. All OSD functionality is describ...
[vlc] / modules / video_filter / marq.c
old mode 100755 (executable)
new mode 100644 (file)
index 1fe76df..5af4f7b
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * marq.c : marquee display video plugin for vlc
  *****************************************************************************
- * Copyright (C) 2003-2004 VideoLAN
- * $Id: time.c 8751 2004-09-20 21:51:41Z gbazin $
+ * Copyright (C) 2003-2005 the VideoLAN team
+ * $Id$
  *
  * Authors: Mark Moriarty
  *
@@ -32,7 +32,7 @@
 
 #include "vlc_filter.h"
 #include "vlc_block.h"
-#include "osd.h"
+#include "vlc_osd.h"
 
 /*****************************************************************************
  * Local prototypes
@@ -45,6 +45,15 @@ static subpicture_t *Filter( filter_t *, mtime_t );
 static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
                             vlc_value_t oldval, vlc_value_t newval,
                             void *p_data );
+static int pi_color_values[] = { 0xf0000000, 0x00000000, 0x00808080, 0x00C0C0C0,
+               0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00,
+               0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080,
+               0x00000080, 0x000000FF, 0x0000FFFF};
+static char *ppsz_color_descriptions[] = { N_("Default"), N_("Black"),
+               N_("Gray"), N_("Silver"), N_("White"), N_("Maroon"), N_("Red"),
+               N_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
+               N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
+               N_("Aqua") };
 
 /*****************************************************************************
  * filter_sys_t: marquee filter descriptor
@@ -52,10 +61,13 @@ static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
 struct filter_sys_t
 {
     int i_xoff, i_yoff;  /* offsets for the display string in the video window */
+    int i_pos; /* permit relative positioning (top, bottom, left, right, center) */
     int i_timeout;
 
     char *psz_marquee;    /* marquee string */
 
+    int  i_font_color, i_font_opacity, i_font_size; /* font control */
+
     time_t last_time;
 
     vlc_bool_t b_need_update;
@@ -71,18 +83,58 @@ struct filter_sys_t
 #define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
                             "displayed, in milliseconds. Default value is " \
                             "0 (remain forever).")
+#define OPACITY_TEXT N_("Opacity")
+#define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
+    "overlay text. 0 = transparent, 255 = totally opaque. " )
+#define SIZE_TEXT N_("Font size, pixels")
+#define SIZE_LONGTEXT N_("Specify the font size, in pixels, " \
+    "with -1 = use freetype-fontsize" )
+
+#define COLOR_TEXT N_("Text Default Color")
+#define COLOR_LONGTEXT N_("The color of overlay text. 1 byte for each color, hexadecimal. " \
+    "#000000 = all colors off, " \
+    "0xFF0000 = just Red, 0xFFFFFF = all color on [White]" )
+
+#define POS_TEXT N_("Marquee position")
+#define POS_LONGTEXT N_( \
+  "You can enforce the marquee position on the video " \
+  "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
+  "also use combinations of these values by adding them).")
+
+static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
+static char *ppsz_pos_descriptions[] =
+     { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
+     N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
 
 /*****************************************************************************
  * Module descriptor
  *****************************************************************************/
 vlc_module_begin();
     set_capability( "sub filter", 0 );
+    set_shortname( N_("Marquee" ));
     set_callbacks( CreateFilter, DestroyFilter );
+    set_category( CAT_VIDEO );
+    set_subcategory( SUBCAT_VIDEO_SUBPIC );
     add_string( "marq-marquee", "Marquee", NULL, MSG_TEXT, MSG_LONGTEXT, VLC_FALSE );
-    add_integer( "marq-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
+
+    set_section( N_("Position"), NULL );
+    add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
     add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
+    add_integer( "marq-position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
+
+    set_section( N_("Font"), NULL );
+    /* 5 sets the default to top [1] left [4] */
+    change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
+    add_integer_with_range( "marq-opacity", 255, 0, 255, NULL,
+        OPACITY_TEXT, OPACITY_LONGTEXT, VLC_FALSE );
+    add_integer( "marq-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
+        change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
+    add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
+
+    set_section( N_("Misc"), NULL );
     add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
                  VLC_FALSE );
+
     set_description( _("Marquee display sub filter") );
     add_shortcut( "marq" );
 vlc_module_end();
@@ -104,26 +156,35 @@ static int CreateFilter( vlc_object_t *p_this )
         return VLC_ENOMEM;
     }
 
-    /* hook to the playlist */
+    /* Hook used for callback variables */
     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
     if( !p_input )
     {
         return VLC_ENOOBJ;
     }
-/* p_access->p_libvlc p_demux->p_libvlc */
 
-    p_sys->i_xoff = var_CreateGetInteger( p_input , "marq-x" );
-    p_sys->i_yoff = var_CreateGetInteger( p_input , "marq-y" );
-    p_sys->i_timeout = var_CreateGetInteger( p_input , "marq-timeout" );
-    p_sys->psz_marquee =  var_CreateGetString( p_input, "marq-marquee" );
-
-    var_AddCallback( p_input, "marq-x", MarqueeCallback, p_sys );
-    var_AddCallback( p_input, "marq-y", MarqueeCallback, p_sys );
-    var_AddCallback( p_input, "marq-marquee", MarqueeCallback, p_sys );
-    var_AddCallback( p_input, "marq-timeout", MarqueeCallback, p_sys );
+    p_sys->i_xoff = var_CreateGetInteger( p_input->p_libvlc , "marq-x" );
+    p_sys->i_yoff = var_CreateGetInteger( p_input->p_libvlc , "marq-y" );
+    p_sys->i_timeout = var_CreateGetInteger( p_input->p_libvlc , "marq-timeout" );
+    p_sys->i_pos = var_CreateGetInteger( p_input->p_libvlc , "marq-position" );
+    p_sys->psz_marquee =  var_CreateGetString( p_input->p_libvlc, "marq-marquee" );
+    var_Create( p_input->p_libvlc, "marq-opacity", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
+    p_sys->i_font_opacity = var_CreateGetInteger( p_input->p_libvlc , "marq-opacity" );
+    p_sys->i_font_color = var_CreateGetInteger( p_input->p_libvlc , "marq-color" );
+    p_sys->i_font_size = var_CreateGetInteger( p_input->p_libvlc , "marq-size" );
+
+    var_AddCallback( p_input->p_libvlc, "marq-x", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-y", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-marquee", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-timeout", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-position", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-color", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-opacity", MarqueeCallback, p_sys );
+    var_AddCallback( p_input->p_libvlc, "marq-size", MarqueeCallback, p_sys );
 
     vlc_object_release( p_input );
 
+
     /* Misc init */
     p_filter->pf_sub_filter = Filter;
     p_sys->last_time = ((time_t)-1);
@@ -143,16 +204,21 @@ static void DestroyFilter( vlc_object_t *p_this )
     if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
     free( p_sys );
 
-    /* Delete the marquee variables from playlist */
+    /* Delete the marquee variables */
     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
     if( !p_input )
     {
         return;
     }
-    var_Destroy( p_input , "marq-marquee" );
-    var_Destroy( p_input , "marq-x" );
-    var_Destroy( p_input , "marq-y" );
-    var_Destroy( p_input , "marq-timeout" );
+    var_Destroy( p_input->p_libvlc , "marq-marquee" );
+    var_Destroy( p_input->p_libvlc , "marq-x" );
+    var_Destroy( p_input->p_libvlc , "marq-y" );
+    var_Destroy( p_input->p_libvlc , "marq-timeout" );
+    var_Destroy( p_input->p_libvlc , "marq-position" );
+    var_Destroy( p_input->p_libvlc , "marq-color");
+    var_Destroy( p_input->p_libvlc , "marq-opacity");
+    var_Destroy( p_input->p_libvlc , "marq-size");
+
     vlc_object_release( p_input );
 }
 
@@ -187,7 +253,6 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
     fmt.i_width = fmt.i_height = 0;
     fmt.i_x_offset = 0;
     fmt.i_y_offset = 0;
-
     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
     if( !p_spu->p_region )
     {
@@ -201,11 +266,26 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
     p_spu->i_start = date;
     p_spu->i_stop  = p_sys->i_timeout == 0 ? 0 : date + p_sys->i_timeout * 1000;
     p_spu->b_ephemer = VLC_TRUE;
-    p_spu->b_absolute = VLC_FALSE;
-    p_spu->i_x = p_sys->i_xoff;
-    p_spu->i_y = p_sys->i_yoff;
 
-    p_spu->i_flags = OSD_ALIGN_LEFT|OSD_ALIGN_TOP ;
+    /*  where to locate the string: */
+    if( p_sys->i_xoff < 0 || p_sys->i_yoff < 0 )
+    {   /* set to one of the 9 relative locations */
+        p_spu->i_flags = p_sys->i_pos;
+        p_spu->i_x = 0;
+        p_spu->i_y = 0;
+        p_spu->b_absolute = VLC_FALSE;
+    }
+    else
+    {   /*  set to an absolute xy, referenced to upper left corner */
+        p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
+        p_spu->i_x = p_sys->i_xoff;
+        p_spu->i_y = p_sys->i_yoff;
+        p_spu->b_absolute = VLC_TRUE;
+    }
+    p_spu->p_region->i_text_color = p_sys->i_font_color;
+    p_spu->p_region->i_text_alpha = 255 - p_sys->i_font_opacity;
+    p_spu->p_region->i_text_size = p_sys->i_font_size;
+
 
     p_sys->b_need_update = VLC_FALSE;
     return p_spu;
@@ -233,10 +313,28 @@ static int MarqueeCallback( vlc_object_t *p_this, char const *psz_var,
     {
         p_sys->i_yoff = newval.i_int;
     }
+    else if ( !strncmp( psz_var, "marq-color", 8 ) )  /* "marq-col" */
+    {
+        p_sys->i_font_color = newval.i_int;
+    }
+    else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
+    {
+        p_sys->i_font_opacity = newval.i_int;
+    }
+    else if ( !strncmp( psz_var, "marq-size", 6 ) )
+    {
+        p_sys->i_font_size = newval.i_int;
+    }
     else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
     {
         p_sys->i_timeout = newval.i_int;
     }
+    else if ( !strncmp( psz_var, "marq-position", 8 ) )
+    /* willing to accept a match against marq-pos */
+    {
+        p_sys->i_pos = newval.i_int;
+        p_sys->i_xoff = -1;       /* force to relative positioning */
+    }
     p_sys->b_need_update = VLC_TRUE;
     return VLC_SUCCESS;
 }