Changed subpicture_region_t->picture into a picture_t *
[vlc.git] / modules / video_filter / logo.c
1 /*****************************************************************************
2  * logo.c : logo video plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2003-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *          Simon Latapie <garf@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_vout.h>
36
37 #include "vlc_filter.h"
38 #include "filter_common.h"
39 #include "vlc_image.h"
40 #include "vlc_osd.h"
41
42 #ifdef LoadImage
43 #   undef LoadImage
44 #endif
45
46 /*****************************************************************************
47  * Local prototypes
48  *****************************************************************************/
49 static int  Create    ( vlc_object_t * );
50 static void Destroy   ( vlc_object_t * );
51
52 static int  Init      ( vout_thread_t * );
53 static void End       ( vout_thread_t * );
54 static void Render    ( vout_thread_t *, picture_t * );
55
56 static int  SendEvents( vlc_object_t *, char const *,
57                         vlc_value_t, vlc_value_t, void * );
58 static int  MouseEvent( vlc_object_t *, char const *,
59                         vlc_value_t , vlc_value_t , void * );
60 static int  Control   ( vout_thread_t *, int, va_list );
61
62 static int  CreateFilter ( vlc_object_t * );
63 static void DestroyFilter( vlc_object_t * );
64
65 static int LogoCallback( vlc_object_t *, char const *,
66                          vlc_value_t, vlc_value_t, void * );
67
68 /*****************************************************************************
69  * Module descriptor
70  *****************************************************************************/
71 #define FILE_TEXT N_("Logo filenames")
72 #define FILE_LONGTEXT N_("Full path of the image files to use. Format is " \
73 "<image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]. " \
74 "If you only have one file, simply enter its filename.")
75 #define REPEAT_TEXT N_("Logo animation # of loops")
76 #define REPEAT_LONGTEXT N_("Number of loops for the logo animation." \
77         "-1 = continuous, 0 = disabled")
78 #define DELAY_TEXT N_("Logo individual image time in ms")
79 #define DELAY_LONGTEXT N_("Individual image display time of 0 - 60000 ms.")
80
81 #define POSX_TEXT N_("X coordinate")
82 #define POSX_LONGTEXT N_("X coordinate of the logo. You can move the logo " \
83                 "by left-clicking it." )
84 #define POSY_TEXT N_("Y coordinate")
85 #define POSY_LONGTEXT N_("Y coordinate of the logo. You can move the logo " \
86                 "by left-clicking it." )
87 #define TRANS_TEXT N_("Transparency of the logo")
88 #define TRANS_LONGTEXT N_("Logo transparency value " \
89   "(from 0 for full transparency to 255 for full opacity)." )
90 #define POS_TEXT N_("Logo position")
91 #define POS_LONGTEXT N_( \
92   "Enforce the logo position on the video " \
93   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
94   "also use combinations of these values, eg 6 = top-right).")
95
96 #define CFG_PREFIX "logo-"
97
98 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
99 static const char *const ppsz_pos_descriptions[] =
100 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
101   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
102
103 vlc_module_begin();
104     set_capability( "sub filter", 0 );
105     set_callbacks( CreateFilter, DestroyFilter );
106     set_description( N_("Logo sub filter") );
107     set_shortname( N_("Logo overlay") );
108     set_category( CAT_VIDEO );
109     set_subcategory( SUBCAT_VIDEO_SUBPIC );
110     add_shortcut( "logo" );
111
112     add_file( CFG_PREFIX "file", NULL, NULL, FILE_TEXT, FILE_LONGTEXT, false );
113     add_integer( CFG_PREFIX "x", 0, NULL, POSX_TEXT, POSX_LONGTEXT, true );
114     add_integer( CFG_PREFIX "y", 0, NULL, POSY_TEXT, POSY_LONGTEXT, true );
115     /* default to 1000 ms per image, continuously cycle through them */
116     add_integer( CFG_PREFIX "delay", 1000, NULL, DELAY_TEXT, DELAY_LONGTEXT, true );
117     add_integer( CFG_PREFIX "repeat", -1, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, true );
118     add_integer_with_range( CFG_PREFIX "transparency", 255, 0, 255, NULL,
119         TRANS_TEXT, TRANS_LONGTEXT, false );
120     add_integer( CFG_PREFIX "position", -1, NULL, POS_TEXT, POS_LONGTEXT, false );
121         change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL );
122
123     /* video output filter submodule */
124     add_submodule();
125     set_capability( "video filter", 0 );
126     set_callbacks( Create, Destroy );
127     set_description( N_("Logo video filter") );
128 vlc_module_end();
129
130 static const char *const ppsz_filter_options[] = {
131     "file", "x", "y", "delay", "repeat", "transparency", "position", NULL
132 };
133
134 /*****************************************************************************
135  * Structure to hold the set of individual logo image names, times,
136  * transparencies
137  ****************************************************************************/
138 typedef struct
139 {
140     char *psz_file;    /* candidate for deletion -- not needed */
141     int i_delay;       /* -1 means use default delay */
142     int i_alpha;       /* -1 means use default alpha */
143     picture_t *p_pic;
144
145 } logo_t;
146
147 /*****************************************************************************
148  * Logo list structure. Common to both the vout and sub picture filter
149  ****************************************************************************/
150 typedef struct
151 {
152     logo_t *p_logo;         /* the parsing's result */
153     unsigned int i_count;   /* the number of logo images to be displayed */
154
155     int i_repeat;         /* how often to repeat the images, image time in ms */
156     mtime_t i_next_pic;     /* when to bring up a new logo image */
157
158     unsigned int i_counter; /* index into the list of logo images */
159
160     int i_delay;            /* default delay (0 - 60000 ms) */
161     int i_alpha;            /* default alpha */
162
163     char *psz_filename;     /* --logo-file string ( is it really useful
164                              * to store it ? ) */
165
166     vlc_mutex_t lock;
167 } logo_list_t;
168
169 /*****************************************************************************
170  * LoadImage: loads the logo image into memory
171  *****************************************************************************/
172 static picture_t *LoadImage( vlc_object_t *p_this, char *psz_filename )
173 {
174     picture_t *p_pic;
175     image_handler_t *p_image;
176     video_format_t fmt_in;
177     video_format_t fmt_out;
178
179     memset( &fmt_in, 0, sizeof(video_format_t) );
180     memset( &fmt_out, 0, sizeof(video_format_t) );
181
182     fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');
183     p_image = image_HandlerCreate( p_this );
184     p_pic = image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
185     image_HandlerDelete( p_image );
186
187     return p_pic;
188 }
189
190 /*****************************************************************************
191  * LoadLogoList: loads the logo images into memory
192  *****************************************************************************
193  * Read the logo-file input switch, obtaining a list of images and associated
194  * durations and transparencies.  Store the image(s), and times.  An image
195  * without a stated time or transparency will use the logo-delay and
196  * logo-transparency values.
197  *****************************************************************************/
198 #define LoadLogoList( a, b ) __LoadLogoList( VLC_OBJECT( a ), b )
199 static void __LoadLogoList( vlc_object_t *p_this, logo_list_t *p_logo_list )
200 {
201     char *psz_list; /* the list: <logo>[,[<delay>[,[<alpha>]]]][;...] */
202     unsigned int i;
203     logo_t *p_logo;         /* the parsing's result */
204
205     p_logo_list->i_counter = 0;
206     p_logo_list->i_next_pic = 0;
207
208     psz_list = strdup( p_logo_list->psz_filename );
209
210     /* Count the number logos == number of ';' + 1 */
211     p_logo_list->i_count = 1;
212     for( i = 0; i < strlen( psz_list ); i++ )
213     {
214         if( psz_list[i] == ';' ) p_logo_list->i_count++;
215     }
216
217     p_logo_list->p_logo = p_logo =
218         (logo_t *)malloc( p_logo_list->i_count * sizeof(logo_t) );
219
220     /* Fill the data */
221     for( i = 0; i < p_logo_list->i_count; i++ )
222     {
223         char *p_c;
224         char *p_c2;
225         p_c = strchr( psz_list, ';' );
226         p_c2 = strchr( psz_list, ',' );
227
228         p_logo[i].i_alpha = -1; /* use default settings */
229         p_logo[i].i_delay = -1; /* use default settings */
230
231         if( p_c2 && ( p_c2 < p_c || !p_c ) )
232         {
233             /* <logo>,<delay>[,<alpha>] type */
234             if( p_c2[1] != ',' && p_c2[1] != ';' && p_c2[1] != '\0' )
235                 p_logo[i].i_delay = atoi( p_c2+1 );
236             *p_c2 = '\0';
237             if( ( p_c2 = strchr( p_c2+1, ',' ) )
238                 && ( p_c2 < p_c || !p_c ) && p_c2[1] != ';' && p_c2[1] != '\0' )
239                 p_logo[i].i_alpha = atoi( p_c2 + 1 );
240         }
241         else
242         {
243             /* <logo> type */
244             if( p_c ) *p_c = '\0';
245         }
246
247         p_logo[i].psz_file = strdup( psz_list );
248         p_logo[i].p_pic = LoadImage( p_this, p_logo[i].psz_file );
249
250         if( !p_logo[i].p_pic )
251         {
252             msg_Warn( p_this, "error while loading logo %s, will be skipped",
253                       p_logo[i].psz_file );
254         }
255
256         if( p_c ) psz_list = p_c + 1;
257     }
258
259     for( i = 0; i < p_logo_list->i_count; i++ )
260     {
261        msg_Dbg( p_this, "logo file name %s, delay %d, alpha %d",
262                 p_logo[i].psz_file, p_logo[i].i_delay, p_logo[i].i_alpha );
263     }
264
265     /* initialize so that on the first update it will wrap back to 0 */
266     p_logo_list->i_counter = p_logo_list->i_count;
267 }
268
269 /*****************************************************************************
270  * FreeLogoList
271  *****************************************************************************/
272 static void FreeLogoList( logo_list_t *p_logo_list )
273 {
274     unsigned int i;
275     FREENULL( p_logo_list->psz_filename );
276     for( i = 0; i < p_logo_list->i_count; i++ )
277     {
278         logo_t *p_logo = &p_logo_list->p_logo[i];
279         FREENULL( p_logo->psz_file );
280         if( p_logo->p_pic )
281         {
282             picture_Release( p_logo->p_pic );
283             p_logo->p_pic = NULL;
284         }
285     }
286 }
287
288 /*****************************************************************************
289  * vout_sys_t: logo video output method descriptor
290  *****************************************************************************
291  * This structure is part of the video output thread descriptor.
292  * It describes the Invert specific properties of an output thread.
293  *****************************************************************************/
294 struct vout_sys_t
295 {
296     logo_list_t *p_logo_list;
297
298     vout_thread_t *p_vout;
299
300     filter_t *p_blend;
301
302     int i_width, i_height;
303     int pos, posx, posy;
304 };
305
306 /*****************************************************************************
307  * Create: allocates logo video thread output method
308  *****************************************************************************/
309 static int Create( vlc_object_t *p_this )
310 {
311     vout_thread_t *p_vout = (vout_thread_t *)p_this;
312     vout_sys_t *p_sys;
313     logo_list_t *p_logo_list;
314
315     /* Allocate structure */
316     p_sys = p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
317     if( p_sys == NULL )
318         return VLC_ENOMEM;
319     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
320     if( p_logo_list == NULL )
321     {
322         free( p_sys );
323         return VLC_ENOMEM;
324     }
325
326     config_ChainParse( p_vout, CFG_PREFIX, ppsz_filter_options,
327                        p_vout->p_cfg );
328
329     p_logo_list->psz_filename = var_CreateGetStringCommand( p_vout,
330                                                             "logo-file" );
331     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
332     {
333         msg_Err( p_vout, "logo file not specified" );
334         free( p_logo_list->psz_filename );
335         free( p_sys );
336         return VLC_EGENERIC;
337     }
338
339     p_vout->pf_init = Init;
340     p_vout->pf_end = End;
341     p_vout->pf_manage = NULL;
342     p_vout->pf_render = Render;
343     p_vout->pf_display = NULL;
344     p_vout->pf_control = Control;
345
346     p_sys->pos = var_CreateGetIntegerCommand( p_vout, "logo-position" );
347     p_sys->posx = var_CreateGetIntegerCommand( p_vout, "logo-x" );
348     p_sys->posy = var_CreateGetIntegerCommand( p_vout, "logo-y" );
349     p_logo_list->i_delay = __MAX( __MIN(
350         var_CreateGetIntegerCommand( p_vout, "logo-delay" ) , 60000 ), 0 );
351     p_logo_list->i_repeat = var_CreateGetIntegerCommand( p_vout, "logo-repeat");
352     p_logo_list->i_alpha = __MAX( __MIN(
353         var_CreateGetIntegerCommand( p_vout, "logo-transparency" ), 255 ), 0 );
354
355     LoadLogoList( p_vout, p_logo_list );
356
357     return VLC_SUCCESS;
358 }
359
360 /*****************************************************************************
361  * Init: initialize logo video thread output method
362  *****************************************************************************/
363 static int Init( vout_thread_t *p_vout )
364 {
365     vout_sys_t *p_sys = p_vout->p_sys;
366     picture_t *p_pic;
367     int i_index;
368     video_format_t fmt;
369     logo_list_t *p_logo_list = p_sys->p_logo_list;
370
371     I_OUTPUTPICTURES = 0;
372     memset( &fmt, 0, sizeof(video_format_t) );
373
374     /* adjust index to the next logo */
375     p_logo_list->i_counter =
376                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
377
378     p_pic = p_logo_list->p_logo[p_logo_list->i_counter].p_pic;
379     /* Initialize the output structure */
380     p_vout->output.i_chroma = p_vout->render.i_chroma;
381     p_vout->output.i_width  = p_vout->render.i_width;
382     p_vout->output.i_height = p_vout->render.i_height;
383     p_vout->output.i_aspect = p_vout->render.i_aspect;
384     p_vout->fmt_out = p_vout->fmt_in;
385     fmt = p_vout->fmt_out;
386
387     /* Load the video blending filter */
388     p_sys->p_blend = vlc_object_create( p_vout, sizeof(filter_t) );
389     vlc_object_attach( p_sys->p_blend, p_vout );
390     p_sys->p_blend->fmt_out.video.i_x_offset =
391         p_sys->p_blend->fmt_out.video.i_y_offset = 0;
392     p_sys->p_blend->fmt_in.video.i_x_offset =
393         p_sys->p_blend->fmt_in.video.i_y_offset = 0;
394     p_sys->p_blend->fmt_out.video.i_aspect = p_vout->render.i_aspect;
395     p_sys->p_blend->fmt_out.video.i_chroma = p_vout->output.i_chroma;
396     p_sys->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','A');
397     p_sys->p_blend->fmt_in.video.i_aspect = VOUT_ASPECT_FACTOR;
398     p_sys->i_width =
399         p_sys->p_blend->fmt_in.video.i_width =
400             p_sys->p_blend->fmt_in.video.i_visible_width =
401                 p_pic ? p_pic->p[Y_PLANE].i_visible_pitch : 0;
402     p_sys->i_height =
403         p_sys->p_blend->fmt_in.video.i_height =
404             p_sys->p_blend->fmt_in.video.i_visible_height =
405                 p_pic ? p_pic->p[Y_PLANE].i_visible_lines : 0;
406     p_sys->p_blend->fmt_out.video.i_width =
407         p_sys->p_blend->fmt_out.video.i_visible_width =
408            p_vout->output.i_width;
409     p_sys->p_blend->fmt_out.video.i_height =
410         p_sys->p_blend->fmt_out.video.i_visible_height =
411             p_vout->output.i_height;
412
413     p_sys->p_blend->p_module =
414         module_Need( p_sys->p_blend, "video blending", 0, 0 );
415     if( !p_sys->p_blend->p_module )
416     {
417         msg_Err( p_vout, "can't open blending filter, aborting" );
418         vlc_object_detach( p_sys->p_blend );
419         vlc_object_release( p_sys->p_blend );
420         return VLC_EGENERIC;
421     }
422
423     if( p_sys->posx < 0 || p_sys->posy < 0 )
424     {
425         p_sys->posx = 0; p_sys->posy = 0;
426
427         if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
428         {
429             p_sys->posy = p_vout->render.i_height - p_sys->i_height;
430         }
431         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
432         {
433             p_sys->posy = p_vout->render.i_height / 2 - p_sys->i_height / 2;
434         }
435
436         if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
437         {
438             p_sys->posx = p_vout->render.i_width - p_sys->i_width;
439         }
440         else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
441         {
442             p_sys->posx = p_vout->render.i_width / 2 - p_sys->i_width / 2;
443         }
444     }
445     else
446     {
447         p_sys->pos = 0;
448     }
449
450     /* Try to open the real video output */
451     msg_Dbg( p_vout, "spawning the real video output" );
452
453     p_sys->p_vout = vout_Create( p_vout, &fmt );
454
455     /* Everything failed */
456     if( p_sys->p_vout == NULL )
457     {
458         msg_Err( p_vout, "can't open vout, aborting" );
459         return VLC_EGENERIC;
460     }
461
462     var_AddCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
463     var_AddCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
464
465     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
466     ADD_CALLBACKS( p_sys->p_vout, SendEvents );
467     ADD_PARENT_CALLBACKS( SendEventsToChild );
468
469     return VLC_SUCCESS;
470 }
471
472 /*****************************************************************************
473  * End: terminate logo video thread output method
474  *****************************************************************************/
475 static void End( vout_thread_t *p_vout )
476 {
477     vout_sys_t *p_sys = p_vout->p_sys;
478     int i_index;
479
480     DEL_PARENT_CALLBACKS( SendEventsToChild );
481
482     DEL_CALLBACKS( p_sys->p_vout, SendEvents );
483
484     /* Free the fake output buffers we allocated */
485     for( i_index = I_OUTPUTPICTURES ; i_index ; )
486     {
487         i_index--;
488         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
489     }
490
491     var_DelCallback( p_sys->p_vout, "mouse-x", MouseEvent, p_vout);
492     var_DelCallback( p_sys->p_vout, "mouse-y", MouseEvent, p_vout);
493
494     vout_CloseAndRelease( p_sys->p_vout );
495
496     if( p_sys->p_blend->p_module )
497         module_Unneed( p_sys->p_blend, p_sys->p_blend->p_module );
498     vlc_object_detach( p_sys->p_blend );
499     vlc_object_release( p_sys->p_blend );
500 }
501
502 /*****************************************************************************
503  * Destroy: destroy logo video thread output method
504  *****************************************************************************/
505 static void Destroy( vlc_object_t *p_this )
506 {
507     vout_thread_t *p_vout = (vout_thread_t *)p_this;
508     vout_sys_t *p_sys = p_vout->p_sys;
509
510
511     FreeLogoList( p_sys->p_logo_list );
512     free( p_sys->p_logo_list );
513
514     free( p_sys );
515 }
516
517 /*****************************************************************************
518  * Render: render the logo onto the video
519  *****************************************************************************/
520 static void Render( vout_thread_t *p_vout, picture_t *p_inpic )
521 {
522     vout_sys_t *p_sys = p_vout->p_sys;
523     picture_t *p_outpic;
524     picture_t *p_pic;
525     logo_list_t *p_logo_list;
526     logo_t * p_logo;
527
528     p_logo_list = p_sys->p_logo_list;
529
530     if( p_logo_list->i_next_pic < p_inpic->date )
531     {
532         /* It's time to use a new logo */
533         p_logo_list->i_counter =
534                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
535         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
536         p_pic = p_logo->p_pic;
537         p_logo_list->i_next_pic = p_inpic->date + ( p_logo->i_delay != -1 ?
538                               p_logo->i_delay : p_logo_list->i_delay ) * 1000;
539         if( p_pic )
540         {
541
542             p_sys->i_width =
543                 p_sys->p_blend->fmt_in.video.i_width =
544                     p_sys->p_blend->fmt_in.video.i_visible_width =
545                         p_pic->p[Y_PLANE].i_visible_pitch;
546             p_sys->i_height =
547                 p_sys->p_blend->fmt_in.video.i_height =
548                     p_sys->p_blend->fmt_in.video.i_visible_height =
549                         p_pic->p[Y_PLANE].i_visible_lines;
550
551             if( p_sys->pos )
552             {
553                 if( p_sys->pos & SUBPICTURE_ALIGN_BOTTOM )
554                 {
555                     p_sys->posy = p_vout->render.i_height - p_sys->i_height;
556                 }
557                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_TOP) )
558                 {
559                     p_sys->posy = p_vout->render.i_height/2 - p_sys->i_height/2;
560                 }
561                 if( p_sys->pos & SUBPICTURE_ALIGN_RIGHT )
562                 {
563                     p_sys->posx = p_vout->render.i_width - p_sys->i_width;
564                 }
565                 else if ( !(p_sys->pos & SUBPICTURE_ALIGN_LEFT) )
566                 {
567                     p_sys->posx = p_vout->render.i_width/2 - p_sys->i_width/2;
568                 }
569             }
570         }
571
572     }
573     else
574     {
575         p_logo = &p_logo_list->p_logo[p_sys->p_logo_list->i_counter];
576         p_pic = p_logo->p_pic;
577     }
578
579     /* This is a new frame. Get a structure from the video_output. */
580     while( !(p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 0 )) )
581     {
582         if( !vlc_object_alive (p_vout) || p_vout->b_error ) return;
583         msleep( VOUT_OUTMEM_SLEEP );
584     }
585
586     vout_CopyPicture( p_vout, p_outpic, p_inpic );
587     vout_DatePicture( p_sys->p_vout, p_outpic, p_inpic->date );
588
589     if( p_pic )
590     p_sys->p_blend->pf_video_blend( p_sys->p_blend, p_outpic,
591                                     p_pic, p_sys->posx, p_sys->posy,
592                                     p_logo->i_alpha != -1 ? p_logo->i_alpha
593                                     : p_logo_list->i_alpha );
594
595     vout_DisplayPicture( p_sys->p_vout, p_outpic );
596 }
597
598 /*****************************************************************************
599  * SendEvents: forward mouse and keyboard events to the parent p_vout
600  *****************************************************************************/
601 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
602                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
603 {
604     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
605     var_Set( (vlc_object_t *)p_data, psz_var, newval );
606     return VLC_SUCCESS;
607 }
608
609 /*****************************************************************************
610  * MouseEvent: callback for mouse events
611  *****************************************************************************/
612 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
613                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
614 {
615     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
616     vout_thread_t *p_vout = (vout_thread_t*)p_data;
617     vout_sys_t *p_sys = p_vout->p_sys;
618     vlc_value_t valb;
619     int i_delta;
620
621     var_Get( p_vout->p_sys->p_vout, "mouse-button-down", &valb );
622
623     i_delta = newval.i_int - oldval.i_int;
624
625     if( (valb.i_int & 0x1) == 0 )
626     {
627         return VLC_SUCCESS;
628     }
629
630     if( psz_var[6] == 'x' )
631     {
632         vlc_value_t valy;
633         var_Get( p_vout->p_sys->p_vout, "mouse-y", &valy );
634         if( newval.i_int >= (int)p_sys->posx &&
635             valy.i_int >= (int)p_sys->posy &&
636             newval.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
637             valy.i_int <= (int)(p_sys->posy + p_sys->i_height) )
638         {
639             p_sys->posx = __MIN( __MAX( p_sys->posx + i_delta, 0 ),
640                           p_vout->output.i_width - p_sys->i_width );
641         }
642     }
643     else if( psz_var[6] == 'y' )
644     {
645         vlc_value_t valx;
646         var_Get( p_vout->p_sys->p_vout, "mouse-x", &valx );
647         if( valx.i_int >= (int)p_sys->posx &&
648             newval.i_int >= (int)p_sys->posy &&
649             valx.i_int <= (int)(p_sys->posx + p_sys->i_width) &&
650             newval.i_int <= (int)(p_sys->posy + p_sys->i_height) )
651         {
652             p_sys->posy = __MIN( __MAX( p_sys->posy + i_delta, 0 ),
653                           p_vout->output.i_height - p_sys->i_height );
654         }
655     }
656
657     return VLC_SUCCESS;
658 }
659
660 /*****************************************************************************
661  * Control: control facility for the vout (forwards to child vout)
662  *****************************************************************************/
663 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
664 {
665     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
666 }
667
668 /*****************************************************************************
669  * SendEventsToChild: forward events to the child/children vout
670  *****************************************************************************/
671 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
672                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
673 {
674     VLC_UNUSED(p_data); VLC_UNUSED(oldval);
675     vout_thread_t *p_vout = (vout_thread_t *)p_this;
676     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
677     return VLC_SUCCESS;
678 }
679
680 /*****************************************************************************
681  * filter_sys_t: logo filter descriptor
682  *****************************************************************************/
683 struct filter_sys_t
684 {
685     logo_list_t *p_logo_list;
686
687     int pos, posx, posy;
688
689     bool b_absolute;
690     mtime_t i_last_date;
691
692     /* On the fly control variable */
693     bool b_need_update;
694 };
695
696 static subpicture_t *Filter( filter_t *, mtime_t );
697
698 /*****************************************************************************
699  * CreateFilter: allocates logo video filter
700  *****************************************************************************/
701 static int CreateFilter( vlc_object_t *p_this )
702 {
703     filter_t *p_filter = (filter_t *)p_this;
704     filter_sys_t *p_sys;
705     logo_list_t *p_logo_list;
706
707     /* Allocate structure */
708     p_sys = p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
709     if( p_sys == NULL )
710         return VLC_ENOMEM;
711     p_logo_list = p_sys->p_logo_list = malloc( sizeof( logo_list_t ) );
712     if( p_logo_list == NULL )
713     {
714         free( p_sys );
715         return VLC_ENOMEM;
716     }
717
718     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
719                        p_filter->p_cfg );
720
721     /* Hook used for callback variables */
722     p_logo_list->psz_filename =
723         var_CreateGetStringCommand( p_filter, "logo-file" );
724     if( !p_logo_list->psz_filename || !*p_logo_list->psz_filename )
725     {
726         msg_Err( p_this, "logo file not specified" );
727         free( p_sys );
728         free( p_logo_list );
729         return VLC_EGENERIC;
730     }
731
732     p_sys->posx = var_CreateGetIntegerCommand( p_filter, "logo-x" );
733     p_sys->posy = var_CreateGetIntegerCommand( p_filter, "logo-y" );
734     p_sys->pos = var_CreateGetIntegerCommand( p_filter, "logo-position" );
735     p_logo_list->i_alpha = __MAX( __MIN( var_CreateGetIntegerCommand(
736                            p_filter, "logo-transparency"), 255 ), 0 );
737     p_logo_list->i_delay =
738         var_CreateGetIntegerCommand( p_filter, "logo-delay" );
739     p_logo_list->i_repeat =
740         var_CreateGetIntegerCommand( p_filter, "logo-repeat" );
741
742     var_AddCallback( p_filter, "logo-file", LogoCallback, p_sys );
743     var_AddCallback( p_filter, "logo-x", LogoCallback, p_sys );
744     var_AddCallback( p_filter, "logo-y", LogoCallback, p_sys );
745     var_AddCallback( p_filter, "logo-position", LogoCallback, p_sys );
746     var_AddCallback( p_filter, "logo-transparency", LogoCallback, p_sys );
747     var_AddCallback( p_filter, "logo-repeat", LogoCallback, p_sys );
748
749     vlc_mutex_init( &p_logo_list->lock );
750     vlc_mutex_lock( &p_logo_list->lock );
751
752     LoadLogoList( p_this, p_logo_list );
753
754     vlc_mutex_unlock( &p_logo_list->lock );
755
756     /* Misc init */
757     p_filter->pf_sub_filter = Filter;
758     p_sys->b_need_update = true;
759
760     p_sys->i_last_date = 0;
761
762     return VLC_SUCCESS;
763 }
764
765 /*****************************************************************************
766  * DestroyFilter: destroy logo video filter
767  *****************************************************************************/
768 static void DestroyFilter( vlc_object_t *p_this )
769 {
770     filter_t *p_filter = (filter_t *)p_this;
771     filter_sys_t *p_sys = p_filter->p_sys;
772
773     vlc_mutex_destroy( &p_sys->p_logo_list->lock );
774     FreeLogoList( p_sys->p_logo_list );
775     free( p_sys->p_logo_list );
776     free( p_sys );
777
778     /* Delete the logo variables from INPUT */
779     var_Destroy( p_filter->p_libvlc, "logo-file" );
780     var_Destroy( p_filter->p_libvlc, "logo-x" );
781     var_Destroy( p_filter->p_libvlc, "logo-y" );
782     var_Destroy( p_filter->p_libvlc, "logo-delay" );
783     var_Destroy( p_filter->p_libvlc, "logo-repeat" );
784     var_Destroy( p_filter->p_libvlc, "logo-position" );
785     var_Destroy( p_filter->p_libvlc, "logo-transparency" );
786 }
787
788 /*****************************************************************************
789  * Filter: the whole thing
790  *****************************************************************************
791  * This function outputs subpictures at regular time intervals.
792  *****************************************************************************/
793 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
794 {
795     filter_sys_t *p_sys = p_filter->p_sys;
796     logo_list_t *p_logo_list = p_sys->p_logo_list;
797     subpicture_t *p_spu;
798     subpicture_region_t *p_region;
799     video_format_t fmt;
800     picture_t *p_pic;
801     logo_t *p_logo;
802
803     vlc_mutex_lock( &p_logo_list->lock );
804     /* Basic test:  b_need_update occurs on a dynamic change,
805                     & i_next_pic is the general timer, when to
806                     look at updating the logo image */
807
808     if( ( ( !p_sys->b_need_update ) && ( p_logo_list->i_next_pic > date ) )
809         || !p_logo_list->i_repeat )
810     {
811         vlc_mutex_unlock( &p_logo_list->lock );
812         return 0;
813     }
814     /* prior code tested on && p_sys->i_last_date +5000000 > date ) return 0; */
815
816     /* adjust index to the next logo */
817     p_logo_list->i_counter =
818                         ( p_logo_list->i_counter + 1 )%p_logo_list->i_count;
819
820     p_logo = &p_logo_list->p_logo[p_logo_list->i_counter];
821     p_pic = p_logo->p_pic;
822
823     /* Allocate the subpicture internal data. */
824     p_spu = filter_NewSubpicture( p_filter );
825     if( !p_spu )
826     {
827         vlc_mutex_unlock( &p_logo_list->lock );
828         return NULL;
829     }
830
831     p_spu->b_absolute = p_sys->b_absolute;
832     p_spu->i_start = p_sys->i_last_date = date;
833     p_spu->i_stop = 0;
834     p_spu->b_ephemer = true;
835
836     p_sys->b_need_update = false;
837     p_logo_list->i_next_pic = date +
838     ( p_logo->i_delay != -1 ? p_logo->i_delay : p_logo_list->i_delay ) * 1000;
839
840     if( p_logo_list->i_repeat != -1
841         && p_logo_list->i_counter == 0 )
842     {
843         p_logo_list->i_repeat--;
844         if( p_logo_list->i_repeat == 0 )
845         {
846             vlc_mutex_unlock( &p_logo_list->lock );
847             return p_spu;
848         }
849     }
850
851     if( !p_pic || !p_logo->i_alpha
852         || ( p_logo->i_alpha == -1 && !p_logo_list->i_alpha ) )
853     {
854         /* Send an empty subpicture to clear the display */
855         vlc_mutex_unlock( &p_logo_list->lock );
856         return p_spu;
857     }
858
859     /* Create new SPU region */
860     memset( &fmt, 0, sizeof(video_format_t) );
861     fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
862     fmt.i_aspect = VOUT_ASPECT_FACTOR;
863     fmt.i_sar_num = fmt.i_sar_den = 1;
864     fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
865     fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
866     fmt.i_x_offset = fmt.i_y_offset = 0;
867     p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
868     if( !p_region )
869     {
870         msg_Err( p_filter, "cannot allocate SPU region" );
871         p_filter->pf_sub_buffer_del( p_filter, p_spu );
872         vlc_mutex_unlock( &p_logo_list->lock );
873         return NULL;
874     }
875
876     /* FIXME the copy is probably not needed anymore */
877     vout_CopyPicture( p_filter, &p_region->p_picture, p_pic );
878     vlc_mutex_unlock( &p_logo_list->lock );
879
880     /*  where to locate the logo: */
881     if( p_sys->pos < 0 )
882     {   /*  set to an absolute xy */
883         p_region->i_align = OSD_ALIGN_RIGHT | OSD_ALIGN_TOP;
884         p_spu->b_absolute = true;
885     }
886     else
887     {   /* set to one of the 9 relative locations */
888         p_region->i_align = p_sys->pos;
889         p_spu->b_absolute = false;
890     }
891
892     p_region->i_x = p_sys->posx;
893     p_region->i_y = p_sys->posy;
894
895     p_spu->p_region = p_region;
896
897     p_spu->i_alpha = ( p_logo->i_alpha != -1 ?
898                        p_logo->i_alpha : p_logo_list->i_alpha );
899
900     return p_spu;
901 }
902
903 /*****************************************************************************
904  * Callback to update params on the fly
905  *****************************************************************************/
906 static int LogoCallback( vlc_object_t *p_this, char const *psz_var,
907                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
908 {
909     VLC_UNUSED(oldval);
910     filter_sys_t *p_sys = (filter_sys_t *)p_data;
911     logo_list_t *p_logo_list = p_sys->p_logo_list;
912
913     if( !strncmp( psz_var, "logo-file", 6 ) )
914     {
915         vlc_mutex_lock( &p_logo_list->lock );
916         FreeLogoList( p_logo_list );
917         p_logo_list->psz_filename = strdup( newval.psz_string );
918         LoadLogoList( p_this, p_logo_list );
919         vlc_mutex_unlock( &p_logo_list->lock );
920         p_sys->b_need_update = true;
921     }
922     else if ( !strncmp( psz_var, "logo-x", 6 ) )
923     {
924         p_sys->posx = newval.i_int;
925     }
926     else if ( !strncmp( psz_var, "logo-y", 6 ) )
927     {
928         p_sys->posy = newval.i_int;
929     }
930     else if ( !strncmp( psz_var, "logo-position", 12 ) )
931     {
932         p_sys->pos = newval.i_int;
933     }
934     else if ( !strncmp( psz_var, "logo-transparency", 9 ) )
935     {
936         vlc_mutex_lock( &p_logo_list->lock );
937         p_logo_list->i_alpha = __MAX( __MIN( newval.i_int, 255 ), 0 );
938         vlc_mutex_unlock( &p_logo_list->lock );
939     }
940     else if ( !strncmp( psz_var, "logo-repeat", 11 ) )
941     {
942         vlc_mutex_lock( &p_logo_list->lock );
943         p_logo_list->i_repeat = newval.i_int;
944         vlc_mutex_unlock( &p_logo_list->lock );
945     }
946     p_sys->b_need_update = true;
947     return VLC_SUCCESS;
948 }