]> git.sesse.net Git - vlc/blobdiff - modules/video_filter/marq.c
For consistency, remove references to vlc from libvlc
[vlc] / modules / video_filter / marq.c
index 707990fae301fac689facbd87084f5ace0f8889a..5935bb46dca8ca50b0acb5cf5cfd786a432b42fb 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * marq.c : marquee display video plugin for vlc
  *****************************************************************************
- * Copyright (C) 2003-2005 VideoLAN
- * $Id: time.c 8751 2004-09-20 21:51:41Z gbazin $
+ * Copyright (C) 2003-2005 the VideoLAN team
+ * $Id$
  *
  * Authors: Mark Moriarty
  *
@@ -18,7 +18,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -32,7 +32,7 @@
 
 #include "vlc_filter.h"
 #include "vlc_block.h"
-#include "osd.h"
+#include "vlc_osd.h"
 
 /*****************************************************************************
  * Local prototypes
@@ -45,14 +45,14 @@ 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"), 
+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_("Fuchsia"), N_("Yellow"), N_("Olive"), N_("Green"),
+               N_("Teal"), N_("Lime"), N_("Purple"), N_("Navy"), N_("Blue"),
                N_("Aqua") };
 
 /*****************************************************************************
@@ -66,40 +66,41 @@ struct filter_sys_t
 
     char *psz_marquee;    /* marquee string */
 
-    int  i_font_color, i_font_opacity, i_font_size; /* font control */
-    
+    text_style_t *p_style; /* font control */
+
     time_t last_time;
 
     vlc_bool_t b_need_update;
 };
 
-#define MSG_TEXT N_("Marquee text")
-#define MSG_LONGTEXT N_("Marquee text to display")
-#define POSX_TEXT N_("X offset, from left")
-#define POSX_LONGTEXT N_("X offset, from the left screen edge" )
-#define POSY_TEXT N_("Y offset, from the top")
-#define POSY_LONGTEXT N_("Y offset, down from the top" )
-#define TIMEOUT_TEXT N_("Marquee timeout")
-#define TIMEOUT_LONGTEXT N_("Defines the time the marquee must remain " \
-                            "displayed, in milliseconds. Default value is " \
-                            "0 (remain forever).")
+#define MSG_TEXT N_("Text")
+#define MSG_LONGTEXT N_("Marquee text to display.")
+#define POSX_TEXT N_("X offset")
+#define POSX_LONGTEXT N_("X offset, from the left screen edge." )
+#define POSY_TEXT N_("Y offset")
+#define POSY_LONGTEXT N_("Y offset, down from the top." )
+#define TIMEOUT_TEXT N_("Timeout")
+#define TIMEOUT_LONGTEXT N_("Number of milliseconds the marquee must remain " \
+                            "displayed. Default value is " \
+                            "0 (remains forever).")
 #define OPACITY_TEXT N_("Opacity")
-#define OPACITY_LONGTEXT N_("The opacity (inverse of transparency) of " \
-    "overlay text. 0 = transparent, 255 = totally opaque. " )
+#define OPACITY_LONGTEXT N_("Opacity (inverse of transparency) of " \
+    "overlayed 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 SIZE_LONGTEXT N_("Font size, in pixels. Default is -1 (use default " \
+    "font size)." )
 
-#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 COLOR_TEXT N_("Color")
+#define COLOR_LONGTEXT N_("Color of the text that will be rendered on "\
+    "the video. This must be an hexadecimal (like HTML colors). The first two "\
+    "chars are for red, then green, then blue. #000000 = black, #FF0000 = red,"\
+    " #00FF00 = green, #FFFF00 = yellow (red + green), #FFFFFF = 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).")
+  "also use combinations of these values, eg 6 = top-right).")
 
 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
 static char *ppsz_pos_descriptions[] =
@@ -115,19 +116,21 @@ vlc_module_begin();
     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_string( "marq-marquee", "VLC", NULL, MSG_TEXT, MSG_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 );
+    add_integer( "marq-x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_TRUE );
+    add_integer( "marq-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_TRUE );
+    add_integer( "marq-position", 5, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
 
     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 );
+    add_integer( "marq-color", 0xFFFFFF, NULL, COLOR_TEXT, COLOR_LONGTEXT,
+                  VLC_FALSE );
         change_integer_list( pi_color_values, ppsz_color_descriptions, 0 );
     add_integer( "marq-size", -1, NULL, SIZE_TEXT, SIZE_LONGTEXT, VLC_FALSE );
 
@@ -135,7 +138,7 @@ vlc_module_begin();
     add_integer( "marq-timeout", 0, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT,
                  VLC_FALSE );
 
-    set_description( _("Marquee display sub filter") );
+    set_description( _("Marquee display") );
     add_shortcut( "marq" );
 vlc_module_end();
 
@@ -146,7 +149,6 @@ static int CreateFilter( vlc_object_t *p_this )
 {
     filter_t *p_filter = (filter_t *)p_this;
     filter_sys_t *p_sys;
-    vlc_object_t *p_input;
 
     /* Allocate structure */
     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
@@ -156,34 +158,26 @@ static int CreateFilter( vlc_object_t *p_this )
         return VLC_ENOMEM;
     }
 
-    /* Hook used for callback variables */
-    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
-    if( !p_input )
-    {
-        return VLC_ENOOBJ;
-    }
-
-    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 );
-
+    p_sys->p_style = malloc( sizeof( text_style_t ) );
+    memcpy( p_sys->p_style, &default_text_style, sizeof( text_style_t ) );
+
+    p_sys->i_xoff = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-x" );
+    p_sys->i_yoff = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-y" );
+    p_sys->i_timeout = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-timeout" );
+    p_sys->i_pos = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-position" );
+    p_sys->psz_marquee =  var_CreateGetString( p_filter->p_libvlc_global, "marq-marquee" );
+    p_sys->p_style->i_font_alpha = 255 - var_CreateGetInteger( p_filter->p_libvlc_global , "marq-opacity" );
+    p_sys->p_style->i_font_color = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-color" );
+    p_sys->p_style->i_font_size  = var_CreateGetInteger( p_filter->p_libvlc_global , "marq-size" );
+
+    var_AddCallback( p_filter->p_libvlc_global, "marq-x", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-y", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-marquee", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-timeout", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-position", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-color", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-opacity", MarqueeCallback, p_sys );
+    var_AddCallback( p_filter->p_libvlc_global, "marq-size", MarqueeCallback, p_sys );
 
     /* Misc init */
     p_filter->pf_sub_filter = Filter;
@@ -199,27 +193,29 @@ 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;
-    vlc_object_t *p_input;
 
+    if( p_sys->p_style ) free( p_sys->p_style );
     if( p_sys->psz_marquee ) free( p_sys->psz_marquee );
     free( p_sys );
 
     /* Delete the marquee variables */
-    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_ANYWHERE );
-    if( !p_input )
-    {
-        return;
-    }
-    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 );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-x", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-y", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-marquee", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-timeout", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-position", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-color", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-opacity", MarqueeCallback, p_sys );
+    var_DelCallback( p_filter->p_libvlc_global, "marq-size", MarqueeCallback, p_sys );
+
+    var_Destroy( p_filter->p_libvlc_global , "marq-marquee" );
+    var_Destroy( p_filter->p_libvlc_global , "marq-x" );
+    var_Destroy( p_filter->p_libvlc_global , "marq-y" );
+    var_Destroy( p_filter->p_libvlc_global , "marq-timeout" );
+    var_Destroy( p_filter->p_libvlc_global , "marq-position" );
+    var_Destroy( p_filter->p_libvlc_global , "marq-color");
+    var_Destroy( p_filter->p_libvlc_global , "marq-opacity");
+    var_Destroy( p_filter->p_libvlc_global , "marq-size");
 }
 
 /****************************************************************************
@@ -277,15 +273,12 @@ static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
     }
     else
     {   /*  set to an absolute xy, referenced to upper left corner */
-           p_spu->i_flags = OSD_ALIGN_LEFT | OSD_ALIGN_TOP;
+        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_spu->p_region->p_style = p_sys->p_style;
 
     p_sys->b_need_update = VLC_FALSE;
     return p_spu;
@@ -313,17 +306,17 @@ 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" */ 
+    else if ( !strncmp( psz_var, "marq-color", 8 ) )  /* "marq-col" */
     {
-        p_sys->i_font_color = newval.i_int;
+        p_sys->p_style->i_font_color = newval.i_int;
     }
-    else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */ 
+    else if ( !strncmp( psz_var, "marq-opacity", 8 ) ) /* "marq-opa" */
     {
-        p_sys->i_font_opacity = newval.i_int;
+        p_sys->p_style->i_font_alpha = 255 - newval.i_int;
     }
     else if ( !strncmp( psz_var, "marq-size", 6 ) )
     {
-        p_sys->i_font_size = newval.i_int;
+        p_sys->p_style->i_font_size = newval.i_int;
     }
     else if ( !strncmp( psz_var, "marq-timeout", 12 ) )
     {