/*****************************************************************************
* logo.c : logo video plugin for vlc
*****************************************************************************
- * Copyright (C) 2003-2004 VideoLAN
+ * Copyright (C) 2003-2006 the VideoLAN team
* $Id$
*
* Authors: Gildas Bazin <gbazin@videolan.org>
*
* 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.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <stdlib.h> /* malloc(), free() */
-#include <string.h>
-#include <png.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+#include <assert.h>
-#include <vlc/vlc.h>
-#include <vlc/vout.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_filter.h>
+#include <vlc_url.h>
-#include "vlc_filter.h"
-#include "filter_common.h"
+#include <vlc_image.h>
-/*****************************************************************************
- * Local prototypes
- *****************************************************************************/
-static int Create ( vlc_object_t * );
-static void Destroy ( vlc_object_t * );
-
-static int Init ( vout_thread_t * );
-static void End ( vout_thread_t * );
-static void Render ( vout_thread_t *, picture_t * );
-
-static int SendEvents( vlc_object_t *, char const *,
- vlc_value_t, vlc_value_t, void * );
-static int MouseEvent ( vlc_object_t *, char const *,
- vlc_value_t , vlc_value_t , void * );
-static int Control ( vout_thread_t *, int, va_list );
-
-static int CreateFilter ( vlc_object_t * );
-static void DestroyFilter( vlc_object_t * );
+#ifdef LoadImage
+# undef LoadImage
+#endif
/*****************************************************************************
* Module descriptor
*****************************************************************************/
-#define FILE_TEXT N_("Logo filename")
-#define FILE_LONGTEXT N_("Full path of the PNG file to use.")
-#define POSX_TEXT N_("X coordinate of the logo")
-#define POSX_LONGTEXT N_("You can move the logo by left-clicking on it." )
-#define POSY_TEXT N_("Y coordinate of the logo")
-#define POSY_LONGTEXT N_("You can move the logo by left-clicking on it." )
-#define TRANS_TEXT N_("Transparency of the logo")
-#define TRANS_LONGTEXT N_("You can set the logo transparency value here " \
+#define FILE_TEXT N_("Logo filenames")
+#define FILE_LONGTEXT N_("Full path of the image files to use. Format is " \
+"<image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]. " \
+"If you only have one file, simply enter its filename.")
+#define REPEAT_TEXT N_("Logo animation # of loops")
+#define REPEAT_LONGTEXT N_("Number of loops for the logo animation." \
+ "-1 = continuous, 0 = disabled")
+#define DELAY_TEXT N_("Logo individual image time in ms")
+#define DELAY_LONGTEXT N_("Individual image display time of 0 - 60000 ms.")
+
+#define POSX_TEXT N_("X coordinate")
+#define POSX_LONGTEXT N_("X coordinate of the logo. You can move the logo " \
+ "by left-clicking it." )
+#define POSY_TEXT N_("Y coordinate")
+#define POSY_LONGTEXT N_("Y coordinate of the logo. You can move the logo " \
+ "by left-clicking it." )
+#define OPACITY_TEXT N_("Opacity of the logo")
+#define OPACITY_LONGTEXT N_("Logo opacity value " \
"(from 0 for full transparency to 255 for full opacity)." )
+#define POS_TEXT N_("Logo position")
+#define POS_LONGTEXT N_( \
+ "Enforce the logo position on the video " \
+ "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
+ "also use combinations of these values, eg 6 = top-right).")
+
+#define LOGO_HELP N_("Use a local picture as logo on the video")
+
+#define CFG_PREFIX "logo-"
+
+static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
+static const char *const 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") };
+
+static int OpenSub ( vlc_object_t * );
+static int OpenVideo( vlc_object_t * );
+static void Close ( vlc_object_t * );
+
+vlc_module_begin ()
+ set_category( CAT_VIDEO )
+ set_subcategory( SUBCAT_VIDEO_SUBPIC )
+ set_help(LOGO_HELP)
+ set_capability( "sub filter", 0 )
+ set_callbacks( OpenSub, Close )
+ set_description( N_("Logo sub filter") )
+ set_shortname( N_("Logo overlay") )
+ add_shortcut( "logo" )
+
+ add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, false )
+ add_integer( CFG_PREFIX "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, true )
+ add_integer( CFG_PREFIX "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, true )
+ /* default to 1000 ms per image, continuously cycle through them */
+ add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, true )
+ add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, true )
+ add_integer_with_range( CFG_PREFIX "opacity", 255, 0, 255, NULL,
+ OPACITY_TEXT, OPACITY_LONGTEXT, false )
+ add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false )
+ change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
+
+ /* video output filter submodule */
+ add_submodule ()
+ set_capability( "video filter2", 0 )
+ set_callbacks( OpenVideo, Close )
+ set_description( N_("Logo video filter") )
+ add_shortcut( "logo" )
+vlc_module_end ()
-vlc_module_begin();
- set_description( _("Logo video filter") );
- set_capability( "video filter", 0 );
- add_shortcut( "logo" );
- set_callbacks( Create, Destroy );
-
- add_file( "logo-file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, VLC_FALSE );
- add_integer( "logo-x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
- add_integer( "logo-y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );
- add_integer_with_range( "logo-transparency", 255, 0, 255, NULL,
- TRANS_TEXT, TRANS_LONGTEXT, VLC_FALSE );
-
- /* subpicture filter submodule */
- add_submodule();
- set_capability( "sub filter", 0 );
- set_callbacks( CreateFilter, DestroyFilter );
- set_description( _("Logo sub filter") );
- add_shortcut( "logo" );
-vlc_module_end();
/*****************************************************************************
- * LoadPNG: loads the PNG logo into memory
+ * Local prototypes
*****************************************************************************/
-static picture_t *LoadPNG( vlc_object_t *p_this )
+
+/**
+ * Structure to hold the set of individual logo image names, times,
+ * transparencies
+ */
+typedef struct
{
+ int i_delay; /* -1 means use default delay */
+ int i_alpha; /* -1 means use default alpha */
picture_t *p_pic;
- char *psz_filename;
- vlc_value_t val;
- FILE *file;
- int i, j, i_trans;
- vlc_bool_t b_alpha = VLC_TRUE;
-
- png_uint_32 i_width, i_height;
- int i_color_type, i_interlace_type, i_compression_type, i_filter_type;
- int i_bit_depth;
- png_bytep *p_row_pointers;
- png_structp p_png;
- png_infop p_info, p_end_info;
-
- var_Create( p_this, "logo-file", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
- var_Get( p_this, "logo-file", &val );
- psz_filename = val.psz_string;
- if( !psz_filename ) return 0;
-
- if( !(file = fopen( psz_filename , "rb" )) )
- {
- msg_Err( p_this , "logo file (%s) not found", psz_filename );
- free( psz_filename );
- return 0;
- }
- free( psz_filename );
- p_png = png_create_read_struct( PNG_LIBPNG_VER_STRING, 0, 0, 0 );
- p_info = png_create_info_struct( p_png );
- p_end_info = png_create_info_struct( p_png );
- png_init_io( p_png, file );
- png_read_info( p_png, p_info );
- png_get_IHDR( p_png, p_info, &i_width, &i_height,
- &i_bit_depth, &i_color_type, &i_interlace_type,
- &i_compression_type, &i_filter_type);
+} logo_t;
- if( i_color_type == PNG_COLOR_TYPE_PALETTE )
- png_set_palette_to_rgb( p_png );
+/**
+ * Logo list structure.
+ */
+typedef struct
+{
+ logo_t *p_logo; /* the parsing's result */
+ unsigned int i_count; /* the number of logo images to be displayed */
- if( i_color_type == PNG_COLOR_TYPE_GRAY ||
- i_color_type == PNG_COLOR_TYPE_GRAY_ALPHA )
- png_set_gray_to_rgb( p_png );
+ int i_repeat; /* how often to repeat the images, image time in ms */
+ mtime_t i_next_pic; /* when to bring up a new logo image */
- if( png_get_valid( p_png, p_info, PNG_INFO_tRNS ) )
- {
- png_set_tRNS_to_alpha( p_png );
- }
- else
- {
- b_alpha = VLC_FALSE;
- }
+ unsigned int i_counter; /* index into the list of logo images */
- p_row_pointers = malloc( sizeof(png_bytep) * i_height );
- for( i = 0; i < (int)i_height; i++ )
- {
- p_row_pointers[i] = malloc( 4 * ( i_bit_depth + 7 ) / 8 * i_width );
- }
- png_read_image( p_png, p_row_pointers );
- png_read_end( p_png, p_end_info );
+ int i_delay; /* default delay (0 - 60000 ms) */
+ int i_alpha; /* default alpha */
- fclose( file );
- png_destroy_read_struct( &p_png, &p_info, &p_end_info );
+} logo_list_t;
- /* Convert to YUVA */
- p_pic = malloc( sizeof(picture_t) );
- if( vout_AllocatePicture( p_this, p_pic, VLC_FOURCC('Y','U','V','A'),
- i_width, i_height, VOUT_ASPECT_FACTOR ) !=
- VLC_SUCCESS )
- {
- free( p_row_pointers );
- return 0;
- }
+/**
+ * Private logo data holder
+ */
+struct filter_sys_t
+{
+ filter_t *p_blend;
- var_Create(p_this, "logo-transparency", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT);
- var_Get( p_this, "logo-transparency", &val );
- i_trans = val.i_int;
+ vlc_mutex_t lock;
- for( j = 0; j < (int)i_height ; j++ )
- {
- uint8_t *p = (uint8_t *)p_row_pointers[j];
+ logo_list_t list;
- for( i = 0; i < (int)i_width ; i++ )
- {
- int i_offset = i + j * p_pic->p[Y_PLANE].i_pitch;
-
- p_pic->p[Y_PLANE].p_pixels[i_offset] =
- (p[0] * 257L + p[1] * 504 + p[2] * 98)/1000 + 16;
- p_pic->p[U_PLANE].p_pixels[i_offset] =
- (p[2] * 439L - p[0] * 148 - p[1] * 291)/1000 + 128;
- p_pic->p[V_PLANE].p_pixels[i_offset] =
- (p[0] * 439L - p[1] * 368 - p[2] * 71)/1000 + 128;
- p_pic->p[A_PLANE].p_pixels[i_offset] =
- b_alpha ? (p[3] * i_trans) / 255 : 255;
-
- p += (b_alpha ? 4 : 3);
- }
- }
+ int i_pos;
+ int i_pos_x;
+ int i_pos_y;
+ bool b_absolute;
- free( p_row_pointers );
- return p_pic;
-}
+ /* On the fly control variable */
+ bool b_spu_update;
-/*****************************************************************************
- * vout_sys_t: logo video output method descriptor
- *****************************************************************************
- * This structure is part of the video output thread descriptor.
- * It describes the Invert specific properties of an output thread.
- *****************************************************************************/
-struct vout_sys_t
-{
- vout_thread_t *p_vout;
+ /* */
+ bool b_mouse_grab;
+};
- filter_t *p_blend;
- picture_t *p_pic;
+static const char *const ppsz_filter_options[] = {
+ "file", "x", "y", "delay", "repeat", "opacity", "position", NULL
+};
- int i_width, i_height;
- int posx, posy;
+static const char *const ppsz_filter_callbacks[] = {
+ "logo-file",
+ "logo-x",
+ "logo-y",
+ "logo-position",
+ "logo-opacity",
+ "logo-repeat",
+ NULL
};
-/*****************************************************************************
- * Create: allocates logo video thread output method
- *****************************************************************************/
-static int Create( vlc_object_t *p_this )
-{
- vout_thread_t *p_vout = (vout_thread_t *)p_this;
- vout_sys_t *p_sys;
- vlc_value_t val;
+static int OpenCommon( vlc_object_t *, bool b_sub );
- /* Allocate structure */
- p_sys = p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
- if( p_sys == NULL )
- {
- msg_Err( p_vout, "out of memory" );
- return VLC_ENOMEM;
- }
+static subpicture_t *FilterSub( filter_t *, mtime_t );
+static picture_t *FilterVideo( filter_t *, picture_t * );
- p_vout->pf_init = Init;
- p_vout->pf_end = End;
- p_vout->pf_manage = NULL;
- p_vout->pf_render = Render;
- p_vout->pf_display = NULL;
- p_vout->pf_control = Control;
-
- var_Create( p_this, "logo-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
- var_Get( p_this, "logo-x", &val );
- p_sys->posx = val.i_int;
- var_Create( p_this, "logo-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
- var_Get( p_this, "logo-y", &val );
- p_sys->posy = val.i_int;
-
- p_sys->p_pic = LoadPNG( p_this );
- if( !p_sys->p_pic )
- {
- free( p_sys );
- return VLC_EGENERIC;
- }
+static int Mouse( filter_t *, vlc_mouse_t *, const vlc_mouse_t *, const vlc_mouse_t * );
- p_sys->i_width = p_sys->p_pic->p[Y_PLANE].i_visible_pitch;
- p_sys->i_height = p_sys->p_pic->p[Y_PLANE].i_visible_lines;
+static int LogoCallback( vlc_object_t *, char const *,
+ vlc_value_t, vlc_value_t, void * );
- return VLC_SUCCESS;
+static void LogoListLoad( vlc_object_t *, logo_list_t *, const char * );
+static void LogoListUnload( logo_list_t * );
+static logo_t *LogoListNext( logo_list_t *p_list, mtime_t i_date );
+static logo_t *LogoListCurrent( logo_list_t *p_list );
+
+/**
+ * Open the sub filter
+ */
+static int OpenSub( vlc_object_t *p_this )
+{
+ return OpenCommon( p_this, true );
}
-/*****************************************************************************
- * Init: initialize logo video thread output method
- *****************************************************************************/
-static int Init( vout_thread_t *p_vout )
+/**
+ * Open the video filter
+ */
+static int OpenVideo( vlc_object_t *p_this )
{
- vout_sys_t *p_sys = p_vout->p_sys;
- picture_t *p_pic;
- int i_index;
-
- I_OUTPUTPICTURES = 0;
-
- /* Initialize the output structure */
- p_vout->output.i_chroma = p_vout->render.i_chroma;
- p_vout->output.i_width = p_vout->render.i_width;
- p_vout->output.i_height = p_vout->render.i_height;
- p_vout->output.i_aspect = p_vout->render.i_aspect;
-
- /* Load the video blending filter */
- p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
- vlc_object_attach( p_sys->p_blend, p_vout );
- p_sys->p_blend->fmt_out.video.i_x_offset =
- p_sys->p_blend->fmt_out.video.i_y_offset = 0;
- p_sys->p_blend->fmt_in.video.i_x_offset =
- p_sys->p_blend->fmt_in.video.i_y_offset = 0;
- p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
- p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
- p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
- p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
- p_sys->p_blend->fmt_in.video.i_width =
- p_sys->p_blend->fmt_in.video.i_visible_width =
- p_sys->p_pic->p[Y_PLANE].i_visible_pitch;
- p_sys->p_blend->fmt_in.video.i_height =
- p_sys->p_blend->fmt_in.video.i_visible_height =
- p_sys->p_pic->p[Y_PLANE].i_visible_lines;
- p_sys->p_blend->fmt_out.video.i_width =
- p_sys->p_blend->fmt_out.video.i_visible_width =
- p_vout->output.i_width;
- p_sys->p_blend->fmt_out.video.i_height =
- p_sys->p_blend->fmt_out.video.i_visible_height =
- p_vout->output.i_height;
-
- p_sys->p_blend->p_module =
- module_Need( p_sys->p_blend, "video blending", 0, 0 );
- if( !p_sys->p_blend->p_module )
+ return OpenCommon( p_this, false );
+}
+
+/**
+ * Common open function
+ */
+static int OpenCommon( vlc_object_t *p_this, bool b_sub )
+{
+ filter_t *p_filter = (filter_t *)p_this;
+ filter_sys_t *p_sys;
+ char *psz_filename;
+
+ /* */
+ if( !b_sub && !es_format_IsSimilar( &p_filter->fmt_in, &p_filter->fmt_out ) )
{
- msg_Err( p_vout, "can't open blending filter, aborting" );
- vlc_object_detach( p_sys->p_blend );
- vlc_object_destroy( p_sys->p_blend );
+ msg_Err( p_filter, "Input and output format does not match" );
return VLC_EGENERIC;
}
- /* Try to open the real video output */
- msg_Dbg( p_vout, "spawning the real video output" );
+ /* */
+ p_filter->p_sys = p_sys = malloc( sizeof( *p_sys ) );
+ if( !p_sys )
+ return VLC_ENOMEM;
- p_sys->p_vout =
- vout_Create( p_vout, p_vout->render.i_width, p_vout->render.i_height,
- p_vout->render.i_chroma, p_vout->render.i_aspect );
+ /* */
+ p_sys->p_blend = NULL;
+ if( !b_sub )
+ {
- /* Everything failed */
- if( p_sys->p_vout == NULL )
+ p_sys->p_blend = filter_NewBlend( VLC_OBJECT(p_filter),
+ &p_filter->fmt_in.video );
+ if( !p_sys->p_blend )
+ {
+ free( p_sys );
+ return VLC_EGENERIC;
+ }
+ }
+
+ /* */
+ config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
+ p_filter->p_cfg );
+
+ /* */
+ logo_list_t *p_list = &p_sys->list;
+
+ psz_filename = var_CreateGetStringCommand( p_filter, "logo-file" );
+ if( !psz_filename )
{
- msg_Err( p_vout, "can't open vout, aborting" );
- return VLC_EGENERIC;
+ if( p_sys->p_blend )
+ filter_DeleteBlend( p_sys->p_blend );
+ free( p_sys );
+ return VLC_ENOMEM;
}
+ if( *psz_filename == '\0' )
+ msg_Warn( p_this, "no logo file specified" );
- var_AddCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
- var_AddCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
+ p_list->i_alpha = var_CreateGetIntegerCommand( p_filter, "logo-opacity");
+ p_list->i_alpha = __MAX( __MIN( p_list->i_alpha, 255 ), 0 );
+ p_list->i_delay = var_CreateGetIntegerCommand( p_filter, "logo-delay" );
+ p_list->i_repeat = var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
- ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
- ADD_CALLBACKS( p_sys->p_vout, SendEvents );
- ADD_PARENT_CALLBACKS( SendEventsToChild );
+ p_sys->i_pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
+ p_sys->i_pos_x = var_CreateGetIntegerCommand( p_filter, "logo-x" );
+ p_sys->i_pos_y = var_CreateGetIntegerCommand( p_filter, "logo-y" );
- return VLC_SUCCESS;
-}
+ /* Ignore aligment if a position is given for video filter */
+ if( !b_sub && p_sys->i_pos_x >= 0 && p_sys->i_pos_y >= 0 )
+ p_sys->i_pos = 0;
-/*****************************************************************************
- * End: terminate logo video thread output method
- *****************************************************************************/
-static void End( vout_thread_t *p_vout )
-{
- vout_sys_t *p_sys = p_vout->p_sys;
- int i_index;
+ vlc_mutex_init( &p_sys->lock );
+ LogoListLoad( p_this, p_list, psz_filename );
+ p_sys->b_spu_update = true;
+ p_sys->b_mouse_grab = false;
+
+ for( int i = 0; ppsz_filter_callbacks[i]; i++ )
+ var_AddCallback( p_filter, ppsz_filter_callbacks[i],
+ LogoCallback, p_sys );
- /* Free the fake output buffers we allocated */
- for( i_index = I_OUTPUTPICTURES ; i_index ; )
+ /* Misc init */
+ if( b_sub )
{
- i_index--;
- free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
+ p_filter->pf_sub_filter = FilterSub;
}
-
- var_DelCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
- var_DelCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
-
- if( p_sys->p_vout )
+ else
{
- DEL_CALLBACKS( p_sys->p_vout, SendEvents );
- vlc_object_detach( p_sys->p_vout );
- vout_Destroy( p_sys->p_vout );
+ p_filter->pf_video_filter = FilterVideo;
+ p_filter->pf_video_mouse = Mouse;
}
- if( p_sys->p_blend->p_module )
- module_Unneed( p_sys->p_blend, p_sys->p_blend->p_module );
- vlc_object_detach( p_sys->p_blend );
- vlc_object_destroy( p_sys->p_blend );
+ free( psz_filename );
+ return VLC_SUCCESS;
}
-/*****************************************************************************
- * Destroy: destroy logo video thread output method
- *****************************************************************************/
-static void Destroy( vlc_object_t *p_this )
+/**
+ * Common close function
+ */
+static void Close( vlc_object_t *p_this )
{
- vout_thread_t *p_vout = (vout_thread_t *)p_this;
- vout_sys_t *p_sys = p_vout->p_sys;
+ filter_t *p_filter = (filter_t *)p_this;
+ filter_sys_t *p_sys = p_filter->p_sys;
- DEL_PARENT_CALLBACKS( SendEventsToChild );
+ for( int i = 0; ppsz_filter_callbacks[i]; i++ )
+ var_DelCallback( p_filter, ppsz_filter_callbacks[i],
+ LogoCallback, p_sys );
- if( p_sys->p_pic && p_sys->p_pic->p_data_orig )
- free( p_sys->p_pic->p_data_orig );
- if( p_sys->p_pic ) free( p_sys->p_pic );
+ if( p_sys->p_blend )
+ filter_DeleteBlend( p_sys->p_blend );
+ vlc_mutex_destroy( &p_sys->lock );
+ LogoListUnload( &p_sys->list );
free( p_sys );
}
-/*****************************************************************************
- * Render: render the logo onto the video
- *****************************************************************************/
-static void Render( vout_thread_t *p_vout, picture_t *p_pic )
+/**
+ * Sub filter
+ */
+static subpicture_t *FilterSub( filter_t *p_filter, mtime_t date )
{
- vout_sys_t *p_sys = p_vout->p_sys;
- picture_t *p_outpic;
+ filter_sys_t *p_sys = p_filter->p_sys;
+ logo_list_t *p_list = &p_sys->list;
- /* This is a new frame. Get a structure from the video_output. */
- while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
+ subpicture_t *p_spu;
+ subpicture_region_t *p_region;
+ video_format_t fmt;
+ picture_t *p_pic;
+ logo_t *p_logo;
+
+ vlc_mutex_lock( &p_sys->lock );
+ /* Basic test: b_spu_update occurs on a dynamic change,
+ & i_next_pic is the general timer, when to
+ look at updating the logo image */
+
+ if( ( !p_sys->b_spu_update && p_list->i_next_pic > date ) ||
+ !p_list->i_repeat )
{
- if( p_vout->b_die || p_vout->b_error ) return;
- msleep( VOUT_OUTMEM_SLEEP );
+ vlc_mutex_unlock( &p_sys->lock );
+ return NULL;
}
- vout_CopyPicture( p_vout, p_outpic, p_pic );
- vout_DatePicture( p_sys->p_vout, p_outpic, p_pic->date );
+ /* adjust index to the next logo */
+ p_logo = LogoListNext( p_list, date );
+ p_sys->b_spu_update = false;
- p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic, p_outpic,
- p_sys->p_pic, p_sys->posx, p_sys->posy );
+ p_pic = p_logo->p_pic;
- vout_DisplayPicture( p_sys->p_vout, p_outpic );
-}
+ /* Allocate the subpicture internal data. */
+ p_spu = filter_NewSubpicture( p_filter );
+ if( !p_spu )
+ goto exit;
-/*****************************************************************************
- * SendEvents: forward mouse and keyboard events to the parent p_vout
- *****************************************************************************/
-static int SendEvents( vlc_object_t *p_this, char const *psz_var,
- vlc_value_t oldval, vlc_value_t newval, void *p_data )
-{
- var_Set( (vlc_object_t *)p_data, psz_var, newval );
- return VLC_SUCCESS;
+ p_spu->b_absolute = p_sys->b_absolute;
+ p_spu->i_start = date;
+ p_spu->i_stop = 0;
+ p_spu->b_ephemer = true;
+
+ /* Send an empty subpicture to clear the display when needed */
+ if( p_list->i_repeat != -1 && p_list->i_counter == 0 )
+ {
+ p_list->i_repeat--;
+ if( p_list->i_repeat == 0 )
+ goto exit;
+ }
+ if( !p_pic || !p_logo->i_alpha ||
+ ( p_logo->i_alpha == -1 && !p_list->i_alpha ) )
+ goto exit;
+
+ /* Create new SPU region */
+ memset( &fmt, 0, sizeof(video_format_t) );
+ fmt.i_chroma = VLC_CODEC_YUVA;
+ fmt.i_sar_num = fmt.i_sar_den = 1;
+ fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
+ fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
+ fmt.i_x_offset = fmt.i_y_offset = 0;
+ p_region = subpicture_region_New( &fmt );
+ if( !p_region )
+ {
+ msg_Err( p_filter, "cannot allocate SPU region" );
+ p_filter->pf_sub_buffer_del( p_filter, p_spu );
+ p_spu = NULL;
+ goto exit;
+ }
+
+ /* */
+ picture_Copy( p_region->p_picture, p_pic );
+
+ /* where to locate the logo: */
+ if( p_sys->i_pos < 0 )
+ { /* set to an absolute xy */
+ p_region->i_align = SUBPICTURE_ALIGN_RIGHT | SUBPICTURE_ALIGN_TOP;
+ p_spu->b_absolute = true;
+ }
+ else
+ { /* set to one of the 9 relative locations */
+ p_region->i_align = p_sys->i_pos;
+ p_spu->b_absolute = false;
+ }
+
+ p_region->i_x = p_sys->i_pos_x;
+ p_region->i_y = p_sys->i_pos_y;
+
+ p_spu->p_region = p_region;
+
+ p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
+ p_logo->i_alpha : p_list->i_alpha );
+
+exit:
+ vlc_mutex_unlock( &p_sys->lock );
+
+ return p_spu;
}
-/*****************************************************************************
- * MouseEvent: callback for mouse events
- *****************************************************************************/
-static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
- vlc_value_t oldval, vlc_value_t newval, void *p_data )
+/**
+ * Video filter
+ */
+static picture_t *FilterVideo( filter_t *p_filter, picture_t *p_src )
{
- vout_thread_t *p_vout = (vout_thread_t*)p_data;
- vout_sys_t *p_sys = p_vout->p_sys;
- vlc_value_t valb;
- int i_delta;
+ filter_sys_t *p_sys = p_filter->p_sys;
+ logo_list_t *p_list = &p_sys->list;
- var_Get( p_vout->p_sys->p_vout, "mouse-button-down", &valb );
+ picture_t *p_dst = filter_NewPicture( p_filter );
+ if( !p_dst )
+ goto exit;
- i_delta = newval.i_int - oldval.i_int;
+ picture_Copy( p_dst, p_src );
- if( (valb.i_int & 0x1) == 0 )
- {
- return VLC_SUCCESS;
- }
+ /* */
+ vlc_mutex_lock( &p_sys->lock );
- if( psz_var[6] == 'x' )
+ logo_t *p_logo;
+ if( p_list->i_next_pic < p_src->date )
+ p_logo = LogoListNext( p_list, p_src->date );
+ else
+ p_logo = LogoListCurrent( p_list );
+
+ /* */
+ const picture_t *p_pic = p_logo->p_pic;
+ if( p_pic )
{
- vlc_value_t valy;
- var_Get( p_vout->p_sys->p_vout, "mouse-y", &valy );
- if( newval.i_int >= (int)p_sys->posx &&
- valy.i_int >= (int)p_sys->posy &&
- newval.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
- valy.i_int <= (int)(p_sys->posy + p_sys->i_height) )
+ const video_format_t *p_fmt = &p_pic->format;
+ const int i_dst_w = p_filter->fmt_out.video.i_visible_width;
+ const int i_dst_h = p_filter->fmt_out.video.i_visible_height;
+
+ if( p_sys->i_pos )
{
- p_sys->posx = __MIN( __MAX( p_sys->posx + i_delta, 0 ),
- p_vout->output.i_width - p_sys->i_width );
+ if( p_sys->i_pos & SUBPICTURE_ALIGN_BOTTOM )
+ {
+ p_sys->i_pos_y = i_dst_h - p_fmt->i_visible_height;
+ }
+ else if ( !(p_sys->i_pos & SUBPICTURE_ALIGN_TOP) )
+ {
+ p_sys->i_pos_y = ( i_dst_h - p_fmt->i_visible_height ) / 2;
+ }
+ else
+ {
+ p_sys->i_pos_y = 0;
+ }
+
+ if( p_sys->i_pos & SUBPICTURE_ALIGN_RIGHT )
+ {
+ p_sys->i_pos_x = i_dst_w - p_fmt->i_visible_width;
+ }
+ else if ( !(p_sys->i_pos & SUBPICTURE_ALIGN_LEFT) )
+ {
+ p_sys->i_pos_x = ( i_dst_w - p_fmt->i_visible_width ) / 2;
+ }
+ else
+ {
+ p_sys->i_pos_x = 0;
+ }
+ }
+
+ /* */
+ const int i_alpha = p_logo->i_alpha != -1 ? p_logo->i_alpha : p_list->i_alpha;
+ if( filter_ConfigureBlend( p_sys->p_blend, i_dst_w, i_dst_h, p_fmt ) ||
+ filter_Blend( p_sys->p_blend, p_dst, p_sys->i_pos_x, p_sys->i_pos_y,
+ p_pic, i_alpha ) )
+ {
+ msg_Err( p_filter, "failed to blend a picture" );
}
}
- else if( psz_var[6] == 'y' )
+ vlc_mutex_unlock( &p_sys->lock );
+
+exit:
+ picture_Release( p_src );
+ return p_dst;
+}
+
+static int Mouse( filter_t *p_filter, vlc_mouse_t *p_mouse,
+ const vlc_mouse_t *p_old, const vlc_mouse_t *p_new )
+{
+ filter_sys_t *p_sys = p_filter->p_sys;
+
+ vlc_mutex_lock( &p_sys->lock );
+ logo_t *p_logo = LogoListCurrent( &p_sys->list );
+ const picture_t *p_pic = p_logo->p_pic;
+
+ if( p_pic )
{
- vlc_value_t valx;
- var_Get( p_vout->p_sys->p_vout, "mouse-x", &valx );
- if( valx.i_int >= (int)p_sys->posx &&
- newval.i_int >= (int)p_sys->posy &&
- valx.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
- newval.i_int <= (int)(p_sys->posy + p_sys->i_height) )
+ const video_format_t *p_fmt = &p_pic->format;
+ const int i_logo_w = p_fmt->i_visible_width;
+ const int i_logo_h = p_fmt->i_visible_height;
+
+ /* Check if we are over the logo */
+ const bool b_over = p_new->i_x >= p_sys->i_pos_x &&
+ p_new->i_x < p_sys->i_pos_x + i_logo_w &&
+ p_new->i_y >= p_sys->i_pos_y &&
+ p_new->i_y < p_sys->i_pos_y + i_logo_h;
+
+ if( b_over && vlc_mouse_HasPressed( p_old, p_new, MOUSE_BUTTON_LEFT ) )
+ p_sys->b_mouse_grab = true;
+ else if( vlc_mouse_HasReleased( p_old, p_new, MOUSE_BUTTON_LEFT ) )
+ p_sys->b_mouse_grab = false;
+
+ if( p_sys->b_mouse_grab )
+ {
+ int i_dx, i_dy;
+ vlc_mouse_GetMotion( &i_dx, &i_dy, p_old, p_new );
+ p_sys->i_pos_x = __MIN( __MAX( p_sys->i_pos_x + i_dx, 0 ),
+ p_filter->fmt_in.video.i_width - i_logo_w );
+ p_sys->i_pos_y = __MIN( __MAX( p_sys->i_pos_y + i_dy, 0 ),
+ p_filter->fmt_in.video.i_height - i_logo_h );
+
+ /* object under mouse has moved */
+ var_SetBool( p_filter->p_parent, "mouse-object", true );
+ }
+ else if( b_over )
+ {
+ /* object under mouse stoped moving */
+ var_SetBool( p_filter->p_parent, "mouse-object", false );
+ }
+
+ if( p_sys->b_mouse_grab || b_over )
{
- p_sys->posy = __MIN( __MAX( p_sys->posy + i_delta, 0 ),
- p_vout->output.i_height - p_sys->i_height );
+ vlc_mutex_unlock( &p_sys->lock );
+ return VLC_EGENERIC;
}
}
+ vlc_mutex_unlock( &p_sys->lock );
+ *p_mouse = *p_new;
return VLC_SUCCESS;
}
/*****************************************************************************
- * Control: control facility for the vout (forwards to child vout)
+ * Callback to update params on the fly
*****************************************************************************/
-static int Control( vout_thread_t *p_vout, int i_query, va_list args )
+static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
+ vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
- return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
-}
+ VLC_UNUSED(oldval);
+ filter_sys_t *p_sys = (filter_sys_t *)p_data;
+ logo_list_t *p_list = &p_sys->list;
+
+ vlc_mutex_lock( &p_sys->lock );
+ if( !strcmp( psz_var, "logo-file" ) )
+ {
+ LogoListUnload( p_list );
+ LogoListLoad( p_this, p_list, newval.psz_string );
+ }
+ else if ( !strcmp( psz_var, "logo-x" ) )
+ {
+ p_sys->i_pos_x = newval.i_int;
+ }
+ else if ( !strcmp( psz_var, "logo-y" ) )
+ {
+ p_sys->i_pos_y = newval.i_int;
+ }
+ else if ( !strcmp( psz_var, "logo-position" ) )
+ {
+ p_sys->i_pos = newval.i_int;
+ }
+ else if ( !strcmp( psz_var, "logo-opacity" ) )
+ {
+ p_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
+ }
+ else if ( !strcmp( psz_var, "logo-repeat" ) )
+ {
+ p_list->i_repeat = newval.i_int;
+ }
+ p_sys->b_spu_update = true;
+ vlc_mutex_unlock( &p_sys->lock );
-/*****************************************************************************
- * SendEventsToChild: forward events to the child/children vout
- *****************************************************************************/
-static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
- vlc_value_t oldval, vlc_value_t newval, void *p_data )
-{
- vout_thread_t *p_vout = (vout_thread_t *)p_this;
- var_Set( p_vout->p_sys->p_vout, psz_var, newval );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * filter_sys_t: logo filter descriptor
- *****************************************************************************/
-struct filter_sys_t
+/**
+ * It loads the logo image into memory.
+ */
+static picture_t *LoadImage( vlc_object_t *p_this, const char *psz_filename )
{
- picture_t *p_pic;
+ if( !psz_filename )
+ return NULL;
- int i_width, i_height;
- int posx, posy;
+ video_format_t fmt_in;
+ video_format_Init( &fmt_in, 0 );
- mtime_t i_last_date;
-};
+ video_format_t fmt_out;
+ video_format_Init( &fmt_out, VLC_CODEC_YUVA );
-static subpicture_t *Filter( filter_t *, mtime_t );
+ image_handler_t *p_image = image_HandlerCreate( p_this );
+ if( !p_image )
+ return NULL;
-/*****************************************************************************
- * CreateFilter: allocates logo video filter
- *****************************************************************************/
-static int CreateFilter( vlc_object_t *p_this )
+ char *psz_url = make_URI( psz_filename, NULL );
+ picture_t *p_pic = image_ReadUrl( p_image, psz_url, &fmt_in, &fmt_out );
+ free( psz_url );
+ image_HandlerDelete( p_image );
+
+ return p_pic;
+}
+
+/**
+ * It loads the logo images into memory.
+ *
+ * Read the logo-file input switch, obtaining a list of images and
+ * associated durations and transparencies. Store the image(s), and
+ * times. An image without a stated time or opacity will use the
+ * logo-delay and logo-opacity values.
+ */
+static void LogoListLoad( vlc_object_t *p_this, logo_list_t *p_logo_list,
+ const char *psz_filename )
{
- filter_t *p_filter = (filter_t *)p_this;
- filter_sys_t *p_sys;
- vlc_value_t val;
+ char *psz_list; /* the list: <logo>[,[<delay>[,[<alpha>]]]][;...] */
+ char *psz_original;
+ unsigned int i;
+ logo_t *p_logo; /* the parsing's result */
- /* Allocate structure */
- p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
- if( p_sys == NULL )
+ p_logo_list->i_counter = 0;
+ p_logo_list->i_next_pic = 0;
+
+ psz_original = psz_list = strdup( psz_filename );
+ if( !psz_list )
+ abort();
+
+ /* Count the number logos == number of ';' + 1 */
+ p_logo_list->i_count = 1;
+ for( i = 0; i < strlen( psz_list ); i++ )
{
- msg_Err( p_filter, "out of memory" );
- return VLC_ENOMEM;
+ if( psz_list[i] == ';' )
+ p_logo_list->i_count++;
}
- var_Create( p_this, "logo-x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
- var_Get( p_this, "logo-x", &val );
- p_sys->posx = val.i_int;
- var_Create( p_this, "logo-y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
- var_Get( p_this, "logo-y", &val );
- p_sys->posy = val.i_int;
+ p_logo_list->p_logo =
+ p_logo = calloc( p_logo_list->i_count, sizeof(*p_logo) );
+ if( !p_logo )
+ abort();
- p_sys->p_pic = LoadPNG( p_this );
- if( !p_sys->p_pic )
+ /* Fill the data */
+ for( i = 0; i < p_logo_list->i_count; i++ )
{
- free( p_sys );
- return VLC_EGENERIC;
- }
+ char *p_c = strchr( psz_list, ';' );
+ char *p_c2 = strchr( psz_list, ',' );
- p_sys->i_width = p_sys->p_pic->p[Y_PLANE].i_visible_pitch;
- p_sys->i_height = p_sys->p_pic->p[Y_PLANE].i_visible_lines;
- p_sys->i_last_date = 0;
+ p_logo[i].i_alpha = -1; /* use default settings */
+ p_logo[i].i_delay = -1; /* use default settings */
- /* Misc init */
- p_filter->pf_sub_filter = Filter;
+ if( p_c2 && ( p_c2 < p_c || !p_c ) )
+ {
+ /* <logo>,<delay>[,<alpha>] type */
+ if( p_c2[1] != ',' && p_c2[1] != ';' && p_c2[1] != '\0' )
+ p_logo[i].i_delay = atoi( p_c2+1 );
+ *p_c2 = '\0';
+ if( ( p_c2 = strchr( p_c2+1, ',' ) )
+ && ( p_c2 < p_c || !p_c ) && p_c2[1] != ';' && p_c2[1] != '\0' )
+ p_logo[i].i_alpha = atoi( p_c2 + 1 );
+ }
+ else
+ {
+ /* <logo> type */
+ if( p_c )
+ *p_c = '\0';
+ }
- return VLC_SUCCESS;
-}
+ msg_Dbg( p_this, "logo file name %s, delay %d, alpha %d",
+ psz_list, p_logo[i].i_delay, p_logo[i].i_alpha );
+ p_logo[i].p_pic = LoadImage( p_this, psz_list );
+ if( !p_logo[i].p_pic )
+ {
+ msg_Warn( p_this, "error while loading logo %s, will be skipped",
+ psz_list );
+ }
-/*****************************************************************************
- * DestroyFilter: destroy logo video filter
- *****************************************************************************/
-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;
+ if( p_c )
+ psz_list = &p_c[1];
+ }
- if( p_sys->p_pic && p_sys->p_pic->p_data_orig )
- free( p_sys->p_pic->p_data_orig );
- if( p_sys->p_pic ) free( p_sys->p_pic );
+ /* initialize so that on the first update it will wrap back to 0 */
+ p_logo_list->i_counter = p_logo_list->i_count - 1;
- free( p_sys );
+ free( psz_original );
}
-/****************************************************************************
- * Filter: the whole thing
- ****************************************************************************
- * This function outputs subpictures at regular time intervals.
- ****************************************************************************/
-static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
+/**
+ * Unload a list of logo and release associated ressources.
+ */
+static void LogoListUnload( logo_list_t *p_list )
{
- filter_sys_t *p_sys = p_filter->p_sys;
- subpicture_t *p_spu;
- subpicture_region_t *p_region;
- video_format_t fmt;
-
- if( p_sys->i_last_date && p_sys->i_last_date + 5000000 > date ) return 0;
-
- /* Allocate the subpicture internal data. */
- p_spu = p_filter->pf_sub_buffer_new( p_filter );
- if( !p_spu ) return NULL;
-
- /* Create new SPU region */
- memset( &fmt, 0, sizeof(video_format_t) );
- fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
- fmt.i_aspect = VOUT_ASPECT_FACTOR;
- fmt.i_width = fmt.i_visible_width = p_sys->i_width;
- fmt.i_height = fmt.i_visible_height = p_sys->i_height;
- fmt.i_x_offset = fmt.i_y_offset = 0;
- p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
- if( !p_region )
+ for( unsigned i = 0; i < p_list->i_count; i++ )
{
- msg_Err( p_filter, "cannot allocate SPU region" );
- p_filter->pf_sub_buffer_del( p_filter, p_spu );
- return NULL;
+ logo_t *p_logo = &p_list->p_logo[i];
+
+ if( p_logo->p_pic )
+ picture_Release( p_logo->p_pic );
}
+ free( p_list->p_logo );
+}
- vout_CopyPicture( p_filter, &p_region->picture, p_sys->p_pic );
- p_region->i_x = 0;
- p_region->i_y = 0;
- p_spu->i_x = p_sys->posx;
- p_spu->i_y = p_sys->posy;
- p_spu->p_region = p_region;
+/**
+ * Go to the next logo and return its pointer.
+ */
+static logo_t *LogoListNext( logo_list_t *p_list, mtime_t i_date )
+{
+ p_list->i_counter = ( p_list->i_counter + 1 ) % p_list->i_count;
- p_spu->i_start = p_sys->i_last_date = date;
- p_spu->i_stop = 0;
- p_spu->b_ephemer = VLC_TRUE;
+ logo_t *p_logo = LogoListCurrent( p_list );
- return p_spu;
+ p_list->i_next_pic = i_date + ( p_logo->i_delay != -1 ?
+ p_logo->i_delay : p_list->i_delay ) * 1000;
+ return p_logo;
}
+/**
+ * Return the current logo pointer
+ */
+static logo_t *LogoListCurrent( logo_list_t *p_list )
+{
+ return &p_list->p_logo[p_list->i_counter];
+}
+