]> git.sesse.net Git - vlc/blob - src/video_output/vout_subpictures.c
* Switch b_strict to true in module_Need calls (we're requiring a specific module)
[vlc] / src / video_output / vout_subpictures.c
1 /*****************************************************************************
2  * vout_subpictures.c : subpicture management functions
3  *****************************************************************************
4  * Copyright (C) 2000-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@zoy.org>
9  *          Gildas Bazin <gbazin@videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #include <stdlib.h>                                                /* free() */
30 #include <stdio.h>                                              /* sprintf() */
31 #include <string.h>                                            /* strerror() */
32
33 #include <vlc/vlc.h>
34 #include <vlc_vout.h>
35 #include <vlc_block.h>
36 #include <vlc_filter.h>
37 #include <vlc_osd.h>
38
39 /*****************************************************************************
40  * Local prototypes
41  *****************************************************************************/
42 static void UpdateSPU   ( spu_t *, vlc_object_t * );
43 static int  CropCallback( vlc_object_t *, char const *,
44                           vlc_value_t, vlc_value_t, void * );
45
46 static int spu_vaControlDefault( spu_t *, int, va_list );
47
48 static subpicture_t *sub_new_buffer( filter_t * );
49 static void sub_del_buffer( filter_t *, subpicture_t * );
50 static subpicture_t *spu_new_buffer( filter_t * );
51 static void spu_del_buffer( filter_t *, subpicture_t * );
52 static picture_t *spu_new_video_buffer( filter_t * );
53 static void spu_del_video_buffer( filter_t *, picture_t * );
54
55 static int spu_ParseChain( spu_t * );
56 static void spu_DeleteChain( spu_t * );
57 static int SubFilterCallback( vlc_object_t *, char const *,
58                               vlc_value_t, vlc_value_t, void * );
59
60 struct filter_owner_sys_t
61 {
62     spu_t *p_spu;
63     int i_channel;
64 };
65
66 /**
67  * Creates the subpicture unit
68  *
69  * \param p_this the parent object which creates the subpicture unit
70  */
71 spu_t *__spu_Create( vlc_object_t *p_this )
72 {
73     int i_index;
74     spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
75
76     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
77     {
78         p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
79     }
80
81     p_spu->p_blend = NULL;
82     p_spu->p_text = NULL;
83     p_spu->p_scale = NULL;
84     p_spu->i_filter = 0;
85     p_spu->pf_control = spu_vaControlDefault;
86
87     /* Register the default subpicture channel */
88     p_spu->i_channel = 2;
89
90     vlc_mutex_init( p_this, &p_spu->subpicture_lock );
91
92     vlc_object_attach( p_spu, p_this );
93
94     return p_spu;
95 }
96
97 /**
98  * Initialise the subpicture unit
99  *
100  * \param p_spu the subpicture unit object
101  */
102 int spu_Init( spu_t *p_spu )
103 {
104     vlc_value_t val;
105
106     /* If the user requested a sub margin, we force the position. */
107     var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
108     var_Get( p_spu, "sub-margin", &val );
109     p_spu->i_margin = val.i_int;
110
111     var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
112     var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
113
114     spu_ParseChain( p_spu );
115
116     return VLC_EGENERIC;
117 }
118
119 int spu_ParseChain( spu_t *p_spu )
120 {
121     char *psz_parser;
122     vlc_value_t val;
123     var_Get( p_spu, "sub-filter", &val );
124     psz_parser = val.psz_string;
125
126     while( psz_parser && *psz_parser )
127     {
128         config_chain_t *p_cfg;
129         char *psz_name;
130
131         psz_parser = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
132
133         msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
134
135         p_spu->pp_filter[p_spu->i_filter] =
136             vlc_object_create( p_spu, VLC_OBJECT_FILTER );
137         vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
138         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
139         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
140         p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
141         p_spu->pp_filter[p_spu->i_filter]->p_module =
142             module_Need( p_spu->pp_filter[p_spu->i_filter],
143                          "sub filter", psz_name, VLC_TRUE );
144         if( p_spu->pp_filter[p_spu->i_filter]->p_module )
145         {
146             filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
147             p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
148             spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
149             p_sys->p_spu = p_spu;
150             p_spu->i_filter++;
151         }
152         else
153         {
154             msg_Dbg( p_spu, "no sub filter found" );
155             config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
156             vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
157             vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
158         }
159
160         if( p_spu->i_filter >= 10 )
161         {
162             msg_Dbg( p_spu, "can't add anymore filters" );
163         }
164
165         free( psz_name );
166     }
167     if( val.psz_string ) free( val.psz_string );
168
169     return VLC_EGENERIC;
170 }
171
172 /**
173  * Destroy the subpicture unit
174  *
175  * \param p_this the parent object which destroys the subpicture unit
176  */
177 void spu_Destroy( spu_t *p_spu )
178 {
179     int i_index;
180
181     vlc_object_detach( p_spu );
182
183     /* Destroy all remaining subpictures */
184     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
185     {
186         if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
187         {
188             spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
189         }
190     }
191
192     if( p_spu->p_blend )
193     {
194         if( p_spu->p_blend->p_module )
195             module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
196
197         vlc_object_detach( p_spu->p_blend );
198         vlc_object_destroy( p_spu->p_blend );
199     }
200
201     if( p_spu->p_text )
202     {
203         if( p_spu->p_text->p_module )
204             module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
205
206         vlc_object_detach( p_spu->p_text );
207         vlc_object_destroy( p_spu->p_text );
208     }
209
210     if( p_spu->p_scale )
211     {
212         if( p_spu->p_scale->p_module )
213             module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
214
215         vlc_object_detach( p_spu->p_scale );
216         vlc_object_destroy( p_spu->p_scale );
217     }
218
219     spu_DeleteChain( p_spu );
220
221     vlc_mutex_destroy( &p_spu->subpicture_lock );
222     vlc_object_destroy( p_spu );
223 }
224
225 static void spu_DeleteChain( spu_t *p_spu )
226 {
227     if( p_spu->i_filter )
228     while( p_spu->i_filter-- )
229     {
230         module_Unneed( p_spu->pp_filter[p_spu->i_filter],
231                        p_spu->pp_filter[p_spu->i_filter]->p_module );
232         free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
233         config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
234         vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
235         vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
236     }
237 }
238
239 /**
240  * Attach/Detach the SPU from any input
241  *
242  * \param p_this the object in which to destroy the subpicture unit
243  * \param b_attach to select attach or detach
244  */
245 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
246 {
247     vlc_object_t *p_input;
248
249     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
250     if( !p_input ) return;
251
252     if( b_attach )
253     {
254         UpdateSPU( p_spu, VLC_OBJECT(p_input) );
255         var_AddCallback( p_input, "highlight", CropCallback, p_spu );
256         vlc_object_release( p_input );
257     }
258     else
259     {
260         /* Delete callback */
261         var_DelCallback( p_input, "highlight", CropCallback, p_spu );
262         vlc_object_release( p_input );
263     }
264 }
265
266 /**
267  * Create a subpicture region
268  *
269  * \param p_this vlc_object_t
270  * \param p_fmt the format that this subpicture region should have
271  */
272 static void RegionPictureRelease( picture_t *p_pic )
273 {
274     if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
275 }
276 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
277                                          video_format_t *p_fmt )
278 {
279     subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
280     memset( p_region, 0, sizeof(subpicture_region_t) );
281     p_region->p_next = 0;
282     p_region->p_cache = 0;
283     p_region->fmt = *p_fmt;
284     p_region->psz_text = 0;
285     p_region->p_style = NULL;
286
287     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
288         p_fmt->p_palette = p_region->fmt.p_palette =
289             malloc( sizeof(video_palette_t) );
290     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
291
292     p_region->picture.p_data_orig = NULL;
293
294     if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
295
296     vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
297                           p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
298
299     if( !p_region->picture.i_planes )
300     {
301         free( p_region );
302         free( p_fmt->p_palette );
303         return NULL;
304     }
305
306     p_region->picture.pf_release = RegionPictureRelease;
307
308     return p_region;
309 }
310
311 /**
312  * Make a subpicture region from an existing picture_t
313  *
314  * \param p_this vlc_object_t
315  * \param p_fmt the format that this subpicture region should have
316  * \param p_pic a pointer to the picture creating the region (not freed)
317  */
318 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
319                                        video_format_t *p_fmt,
320                                        picture_t *p_pic )
321 {
322     subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
323     (void)p_this;
324     memset( p_region, 0, sizeof(subpicture_region_t) );
325     p_region->p_next = 0;
326     p_region->p_cache = 0;
327     p_region->fmt = *p_fmt;
328     p_region->psz_text = 0;
329     p_region->p_style = NULL;
330
331     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
332         p_fmt->p_palette = p_region->fmt.p_palette =
333             malloc( sizeof(video_palette_t) );
334     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
335
336     memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
337     p_region->picture.pf_release = RegionPictureRelease;
338
339     return p_region;
340 }
341
342 /**
343  * Destroy a subpicture region
344  *
345  * \param p_this vlc_object_t
346  * \param p_region the subpicture region to destroy
347  */
348 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
349 {
350     if( !p_region ) return;
351     if( p_region->picture.pf_release )
352         p_region->picture.pf_release( &p_region->picture );
353     if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
354     if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
355
356     if( p_region->psz_text )
357         free( p_region->psz_text );
358     //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
359     free( p_region );
360 }
361
362 /**
363  * Display a subpicture
364  *
365  * Remove the reservation flag of a subpicture, which will cause it to be
366  * ready for display.
367  * \param p_spu the subpicture unit object
368  * \param p_subpic the subpicture to display
369  */
370 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
371 {
372     /* Check if status is valid */
373     if( p_subpic->i_status != RESERVED_SUBPICTURE )
374     {
375         msg_Err( p_spu, "subpicture %p has invalid status #%d",
376                  p_subpic, p_subpic->i_status );
377     }
378
379     /* Remove reservation flag */
380     p_subpic->i_status = READY_SUBPICTURE;
381
382     if( p_subpic->i_channel == DEFAULT_CHAN )
383     {
384         p_subpic->i_channel = 0xFFFF;
385         spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
386         p_subpic->i_channel = DEFAULT_CHAN;
387     }
388 }
389
390 /**
391  * Allocate a subpicture in the spu heap.
392  *
393  * This function create a reserved subpicture in the spu heap.
394  * A null pointer is returned if the function fails. This method provides an
395  * already allocated zone of memory in the spu data fields. It needs locking
396  * since several pictures can be created by several producers threads.
397  * \param p_spu the subpicture unit in which to create the subpicture
398  * \return NULL on error, a reserved subpicture otherwise
399  */
400 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
401 {
402     int                 i_subpic;                        /* subpicture index */
403     subpicture_t *      p_subpic = NULL;            /* first free subpicture */
404
405     /* Get lock */
406     vlc_mutex_lock( &p_spu->subpicture_lock );
407
408     /*
409      * Look for an empty place
410      */
411     p_subpic = NULL;
412     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
413     {
414         if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
415         {
416             /* Subpicture is empty and ready for allocation */
417             p_subpic = &p_spu->p_subpicture[i_subpic];
418             p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
419             break;
420         }
421     }
422
423     /* If no free subpicture could be found */
424     if( p_subpic == NULL )
425     {
426         msg_Err( p_spu, "subpicture heap is full" );
427         vlc_mutex_unlock( &p_spu->subpicture_lock );
428         return NULL;
429     }
430
431     /* Copy subpicture information, set some default values */
432     memset( p_subpic, 0, sizeof(subpicture_t) );
433     p_subpic->i_status   = RESERVED_SUBPICTURE;
434     p_subpic->b_absolute = VLC_TRUE;
435     p_subpic->b_pausable = VLC_FALSE;
436     p_subpic->b_fade     = VLC_FALSE;
437     p_subpic->i_alpha    = 0xFF;
438     p_subpic->p_region   = 0;
439     p_subpic->pf_render  = 0;
440     p_subpic->pf_destroy = 0;
441     p_subpic->p_sys      = 0;
442     vlc_mutex_unlock( &p_spu->subpicture_lock );
443
444     p_subpic->pf_create_region = __spu_CreateRegion;
445     p_subpic->pf_make_region = __spu_MakeRegion;
446     p_subpic->pf_destroy_region = __spu_DestroyRegion;
447
448     return p_subpic;
449 }
450
451 /**
452  * Remove a subpicture from the heap
453  *
454  * This function frees a previously reserved subpicture.
455  * It is meant to be used when the construction of a picture aborted.
456  * This function does not need locking since reserved subpictures are ignored
457  * by the spu.
458  */
459 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
460 {
461     /* Get lock */
462     vlc_mutex_lock( &p_spu->subpicture_lock );
463
464     /* There can be race conditions so we need to check the status */
465     if( p_subpic->i_status == FREE_SUBPICTURE )
466     {
467         vlc_mutex_unlock( &p_spu->subpicture_lock );
468         return;
469     }
470
471     /* Check if status is valid */
472     if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
473            && ( p_subpic->i_status != READY_SUBPICTURE ) )
474     {
475         msg_Err( p_spu, "subpicture %p has invalid status %d",
476                          p_subpic, p_subpic->i_status );
477     }
478
479     while( p_subpic->p_region )
480     {
481         subpicture_region_t *p_region = p_subpic->p_region;
482         p_subpic->p_region = p_region->p_next;
483         spu_DestroyRegion( p_spu, p_region );
484     }
485
486     if( p_subpic->pf_destroy )
487     {
488         p_subpic->pf_destroy( p_subpic );
489     }
490
491     p_subpic->i_status = FREE_SUBPICTURE;
492
493     vlc_mutex_unlock( &p_spu->subpicture_lock );
494 }
495
496 /*****************************************************************************
497  * spu_RenderSubpictures: render a subpicture list
498  *****************************************************************************
499  * This function renders all sub picture units in the list.
500  *****************************************************************************/
501 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
502                             picture_t *p_pic_dst, picture_t *p_pic_src,
503                             subpicture_t *p_subpic,
504                             int i_scale_width_orig, int i_scale_height_orig )
505 {
506     /* Get lock */
507     vlc_mutex_lock( &p_spu->subpicture_lock );
508
509     /* Check i_status again to make sure spudec hasn't destroyed the subpic */
510     while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
511     {
512         subpicture_region_t *p_region = p_subpic->p_region;
513         int i_scale_width, i_scale_height;
514         int i_subpic_x = p_subpic->i_x;
515
516         /* Load the blending module */
517         if( !p_spu->p_blend && p_region )
518         {
519             p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
520             vlc_object_attach( p_spu->p_blend, p_spu );
521             p_spu->p_blend->fmt_out.video.i_x_offset =
522                 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
523             p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
524             p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
525             p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
526             /* XXX: We'll also be using it for YUVA and RGBA blending ... */
527
528             p_spu->p_blend->p_module =
529                 module_Need( p_spu->p_blend, "video blending", 0, 0 );
530         }
531
532         /* Load the text rendering module */
533         if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
534         {
535             char *psz_modulename = NULL;
536
537             p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
538             vlc_object_attach( p_spu->p_text, p_spu );
539
540             p_spu->p_text->fmt_out.video.i_width =
541                 p_spu->p_text->fmt_out.video.i_visible_width =
542                 p_fmt->i_width;
543             p_spu->p_text->fmt_out.video.i_height =
544                 p_spu->p_text->fmt_out.video.i_visible_height =
545                 p_fmt->i_height;
546
547             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
548             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
549
550             psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
551             if( psz_modulename && *psz_modulename )
552             {
553                 p_spu->p_text->p_module =
554                     module_Need( p_spu->p_text, "text renderer",
555                                  psz_modulename, VLC_TRUE );
556             }
557             if( !p_spu->p_text->p_module )
558             {
559                 p_spu->p_text->p_module =
560                     module_Need( p_spu->p_text, "text renderer", 0, 0 );
561             }
562             if( psz_modulename ) free( psz_modulename );
563         }
564         if( p_spu->p_text )
565         {
566             if( p_subpic->i_original_picture_height > 0 &&
567                 p_subpic->i_original_picture_width  > 0 )
568             {
569                 p_spu->p_text->fmt_out.video.i_width =
570                     p_spu->p_text->fmt_out.video.i_visible_width =
571                     p_subpic->i_original_picture_width;
572                 p_spu->p_text->fmt_out.video.i_height =
573                     p_spu->p_text->fmt_out.video.i_visible_height =
574                     p_subpic->i_original_picture_height;
575             }
576             else
577             {
578                 p_spu->p_text->fmt_out.video.i_width =
579                     p_spu->p_text->fmt_out.video.i_visible_width =
580                     p_fmt->i_width;
581                 p_spu->p_text->fmt_out.video.i_height =
582                     p_spu->p_text->fmt_out.video.i_visible_height =
583                     p_fmt->i_height;
584             }
585         }
586
587         i_scale_width = i_scale_width_orig;
588         i_scale_height = i_scale_height_orig;
589
590         if( p_subpic->i_original_picture_height > 0 &&
591             p_subpic->i_original_picture_width  > 0 )
592         {
593             i_scale_width = i_scale_width * p_fmt->i_width /
594                              p_subpic->i_original_picture_width;
595             i_scale_height = i_scale_height * p_fmt->i_height /
596                              p_subpic->i_original_picture_height;
597         }
598         else if( p_subpic->i_original_picture_height > 0 )
599         {
600             i_scale_height = i_scale_height * p_fmt->i_height /
601                              p_subpic->i_original_picture_height;
602             i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height;
603         }
604
605         /* Set default subpicture aspect ratio */
606         if( p_region && p_region->fmt.i_aspect &&
607             (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
608         {
609             p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
610             p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
611         }
612         if( p_region &&
613             (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
614         {
615             p_region->fmt.i_sar_den = p_fmt->i_sar_den;
616             p_region->fmt.i_sar_num = p_fmt->i_sar_num;
617         }
618
619         /* Take care of the aspect ratio */
620         if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
621             p_region->fmt.i_sar_den * p_fmt->i_sar_num )
622         {
623             i_scale_width = i_scale_width *
624                 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
625                 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
626             i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
627         }
628
629         /* Load the scaling module */
630         if( !p_spu->p_scale && (i_scale_width != 1000 ||
631             i_scale_height != 1000) )
632         {
633             p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
634             vlc_object_attach( p_spu->p_scale, p_spu );
635             p_spu->p_scale->fmt_out.video.i_chroma =
636                 p_spu->p_scale->fmt_in.video.i_chroma =
637                     VLC_FOURCC('Y','U','V','P');
638             /* XXX: We'll also be using it for YUVA and RGBA blending ... */
639             p_spu->p_scale->fmt_in.video.i_width =
640                 p_spu->p_scale->fmt_in.video.i_height = 32;
641             p_spu->p_scale->fmt_out.video.i_width =
642                 p_spu->p_scale->fmt_out.video.i_height = 16;
643
644             p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
645             p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
646             p_spu->p_scale->p_module =
647                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
648         }
649
650         while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
651         {
652             int i_fade_alpha = 255;
653             int i_x_offset = p_region->i_x + i_subpic_x;
654             int i_y_offset = p_region->i_y + p_subpic->i_y;
655
656             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
657             {
658                 if( p_spu->p_text && p_spu->p_text->p_module )
659                 {
660                     p_region->i_align = p_subpic->i_flags;
661
662                     if( p_spu->p_text->pf_render_html && p_region->psz_html )
663                     {
664                         p_spu->p_text->pf_render_html( p_spu->p_text,
665                                                        p_region, p_region );
666                     }
667                     else if( p_spu->p_text->pf_render_text )
668                     {
669                         p_spu->p_text->pf_render_text( p_spu->p_text,
670                                                        p_region, p_region );
671                     }
672                 }
673             }
674
675             /* Force palette if requested */
676             if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
677                 p_region->fmt.i_chroma )
678             {
679                 memcpy( p_region->fmt.p_palette->palette,
680                         p_spu->palette, 16 );
681             }
682
683             /* Scale SPU if necessary */
684             if( p_region->p_cache )
685             {
686                 if( i_scale_width * p_region->fmt.i_width / 1000 !=
687                     p_region->p_cache->fmt.i_width ||
688                     i_scale_height * p_region->fmt.i_height / 1000 !=
689                     p_region->p_cache->fmt.i_height )
690                 {
691                     p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
692                                                  p_region->p_cache );
693                     p_region->p_cache = 0;
694                 }
695             }
696
697             if( (i_scale_width != 1000 || i_scale_height != 1000) &&
698                 p_spu->p_scale && !p_region->p_cache )
699             {
700                 picture_t *p_pic;
701
702                 p_spu->p_scale->fmt_in.video = p_region->fmt;
703                 p_spu->p_scale->fmt_out.video = p_region->fmt;
704
705                 p_region->p_cache =
706                     p_subpic->pf_create_region( VLC_OBJECT(p_spu),
707                         &p_spu->p_scale->fmt_out.video );
708                 if( p_spu->p_scale->fmt_out.video.p_palette )
709                     *p_spu->p_scale->fmt_out.video.p_palette =
710                         *p_region->fmt.p_palette;
711                 p_region->p_cache->p_next = p_region->p_next;
712
713                 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
714                                   &p_region->picture );
715
716                 p_spu->p_scale->fmt_out.video.i_width =
717                     p_region->fmt.i_width * i_scale_width / 1000;
718                 p_spu->p_scale->fmt_out.video.i_visible_width =
719                     p_region->fmt.i_visible_width * i_scale_width / 1000;
720                 p_spu->p_scale->fmt_out.video.i_height =
721                     p_region->fmt.i_height * i_scale_height / 1000;
722                 p_spu->p_scale->fmt_out.video.i_visible_height =
723                     p_region->fmt.i_visible_height * i_scale_height / 1000;
724                 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
725                 p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
726                 p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
727
728                 p_pic = p_spu->p_scale->pf_video_filter(
729                                  p_spu->p_scale, &p_region->p_cache->picture );
730                 if( p_pic )
731                 {
732                     picture_t p_pic_tmp = p_region->p_cache->picture;
733                     p_region->p_cache->picture = *p_pic;
734                     *p_pic = p_pic_tmp;
735                     free( p_pic );
736                 }
737             }
738             if( (i_scale_width != 1000 || i_scale_height != 1000) &&
739                 p_spu->p_scale && p_region->p_cache )
740             {
741                 p_region = p_region->p_cache;
742             }
743
744             if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
745             {
746                 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
747                     p_subpic->i_y;
748             }
749             else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
750             {
751                 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
752             }
753
754             if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
755             {
756                 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
757                     i_subpic_x;
758             }
759             else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
760             {
761                 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
762             }
763
764             if( p_subpic->b_absolute )
765             {
766                 i_x_offset = p_region->i_x +
767                     i_subpic_x * i_scale_width / 1000;
768                 i_y_offset = p_region->i_y +
769                     p_subpic->i_y * i_scale_height / 1000;
770
771             }
772
773             i_x_offset = __MAX( i_x_offset, 0 );
774             i_y_offset = __MAX( i_y_offset, 0 );
775
776             if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
777             {
778                 int i_diff = 0;
779                 int i_low = i_y_offset - p_spu->i_margin;
780                 int i_high = i_y_offset + p_region->fmt.i_height - p_spu->i_margin;
781
782                 /* crop extra margin to keep within bounds */
783                 if( i_low < 0 ) i_diff = i_low;
784                 if( i_high > (int)p_fmt->i_height ) i_diff = i_high - p_fmt->i_height;
785                 i_y_offset -= ( p_spu->i_margin + i_diff );
786             }
787
788             p_spu->p_blend->fmt_in.video = p_region->fmt;
789
790             /* Force cropping if requested */
791             if( p_spu->b_force_crop )
792             {
793                 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
794                 int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
795                 int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
796                 int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
797                 int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
798
799                 /* Find the intersection */
800                 if( i_crop_x + i_crop_width <= i_x_offset ||
801                     i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
802                     i_crop_y + i_crop_height <= i_y_offset ||
803                     i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
804                 {
805                     /* No intersection */
806                     p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
807                 }
808                 else
809                 {
810                     int i_x, i_y, i_x_end, i_y_end;
811                     i_x = __MAX( i_crop_x, i_x_offset );
812                     i_y = __MAX( i_crop_y, i_y_offset );
813                     i_x_end = __MIN( i_crop_x + i_crop_width,
814                                    i_x_offset + (int)p_fmt->i_visible_width );
815                     i_y_end = __MIN( i_crop_y + i_crop_height,
816                                    i_y_offset + (int)p_fmt->i_visible_height );
817
818                     p_fmt->i_x_offset = i_x - i_x_offset;
819                     p_fmt->i_y_offset = i_y - i_y_offset;
820                     p_fmt->i_visible_width = i_x_end - i_x;
821                     p_fmt->i_visible_height = i_y_end - i_y;
822
823                     i_x_offset = i_x;
824                     i_y_offset = i_y;
825                 }
826             }
827
828             /* Update the output picture size */
829             p_spu->p_blend->fmt_out.video.i_width =
830                 p_spu->p_blend->fmt_out.video.i_visible_width =
831                     p_fmt->i_width;
832             p_spu->p_blend->fmt_out.video.i_height =
833                 p_spu->p_blend->fmt_out.video.i_visible_height =
834                     p_fmt->i_height;
835
836             if( p_subpic->b_fade )
837             {
838                 mtime_t i_fade_start = ( p_subpic->i_stop +
839                                          p_subpic->i_start ) / 2;
840                 mtime_t i_now = mdate();
841                 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
842                 {
843                     i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
844                                    ( p_subpic->i_stop - i_fade_start );
845                 }
846             }
847
848             i_x_offset = __MAX( i_x_offset, 0 );
849             i_y_offset = __MAX( i_y_offset, 0 );
850
851             p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
852                 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
853                 i_fade_alpha * p_subpic->i_alpha / 255 );
854
855             p_region = p_region->p_next;
856         }
857
858         p_subpic = p_subpic->p_next;
859     }
860
861     vlc_mutex_unlock( &p_spu->subpicture_lock );
862 }
863
864 /*****************************************************************************
865  * spu_SortSubpictures: find the subpictures to display
866  *****************************************************************************
867  * This function parses all subpictures and decides which ones need to be
868  * displayed. This operation does not need lock, since only READY_SUBPICTURE
869  * are handled. If no picture has been selected, display_date will depend on
870  * the subpicture.
871  * We also check for ephemer DVD subpictures (subpictures that have
872  * to be removed if a newer one is available), which makes it a lot
873  * more difficult to guess if a subpicture has to be rendered or not.
874  *****************************************************************************/
875 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
876                                    vlc_bool_t b_paused )
877 {
878     int i_index, i_channel;
879     subpicture_t *p_subpic = NULL;
880     subpicture_t *p_ephemer;
881     mtime_t      ephemer_date;
882
883     /* Run subpicture filters */
884     for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
885     {
886         subpicture_t *p_subpic_filter;
887         p_subpic_filter = p_spu->pp_filter[i_index]->
888             pf_sub_filter( p_spu->pp_filter[i_index], display_date );
889         if( p_subpic_filter )
890         {
891             spu_DisplaySubpicture( p_spu, p_subpic_filter );
892         }
893     }
894
895     /* We get an easily parsable chained list of subpictures which
896      * ends with NULL since p_subpic was initialized to NULL. */
897     for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
898     {
899         p_ephemer = 0;
900         ephemer_date = 0;
901
902         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
903         {
904             if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
905                 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
906             {
907                 continue;
908             }
909             if( display_date &&
910                 display_date < p_spu->p_subpicture[i_index].i_start )
911             {
912                 /* Too early, come back next monday */
913                 continue;
914             }
915
916             if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
917                 ephemer_date = p_spu->p_subpicture[i_index].i_start;
918
919             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
920                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
921                   p_spu->p_subpicture[i_index].i_stop >
922                   p_spu->p_subpicture[i_index].i_start ) &&
923                 !( p_spu->p_subpicture[i_index].b_pausable &&
924                    b_paused ) )
925             {
926                 /* Too late, destroy the subpic */
927                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
928                 continue;
929             }
930
931             /* If this is an ephemer subpic, add it to our list */
932             if( p_spu->p_subpicture[i_index].b_ephemer )
933             {
934                 p_spu->p_subpicture[i_index].p_next = p_ephemer;
935                 p_ephemer = &p_spu->p_subpicture[i_index];
936
937                 continue;
938             }
939
940             p_spu->p_subpicture[i_index].p_next = p_subpic;
941             p_subpic = &p_spu->p_subpicture[i_index];
942         }
943
944         /* If we found ephemer subpictures, check if they have to be
945          * displayed or destroyed */
946         while( p_ephemer != NULL )
947         {
948             subpicture_t *p_tmp = p_ephemer;
949             p_ephemer = p_ephemer->p_next;
950
951             if( p_tmp->i_start < ephemer_date )
952             {
953                 /* Ephemer subpicture has lived too long */
954                 spu_DestroySubpicture( p_spu, p_tmp );
955             }
956             else
957             {
958                 /* Ephemer subpicture can still live a bit */
959                 p_tmp->p_next = p_subpic;
960                 p_subpic = p_tmp;
961             }
962         }
963     }
964
965     return p_subpic;
966 }
967
968 /*****************************************************************************
969  * SpuClearChannel: clear an spu channel
970  *****************************************************************************
971  * This function destroys the subpictures which belong to the spu channel
972  * corresponding to i_channel_id.
973  *****************************************************************************/
974 static void SpuClearChannel( spu_t *p_spu, int i_channel )
975 {
976     int          i_subpic;                               /* subpicture index */
977     subpicture_t *p_subpic = NULL;                  /* first free subpicture */
978
979     vlc_mutex_lock( &p_spu->subpicture_lock );
980
981     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
982     {
983         p_subpic = &p_spu->p_subpicture[i_subpic];
984         if( p_subpic->i_status == FREE_SUBPICTURE
985             || ( p_subpic->i_status != RESERVED_SUBPICTURE
986                  && p_subpic->i_status != READY_SUBPICTURE ) )
987         {
988             continue;
989         }
990
991         if( p_subpic->i_channel == i_channel )
992         {
993             while( p_subpic->p_region )
994             {
995                 subpicture_region_t *p_region = p_subpic->p_region;
996                 p_subpic->p_region = p_region->p_next;
997                 spu_DestroyRegion( p_spu, p_region );
998             }
999
1000             if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
1001             p_subpic->i_status = FREE_SUBPICTURE;
1002         }
1003     }
1004
1005     vlc_mutex_unlock( &p_spu->subpicture_lock );
1006 }
1007
1008 /*****************************************************************************
1009  * spu_ControlDefault: default methods for the subpicture unit control.
1010  *****************************************************************************/
1011 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
1012 {
1013     int *pi, i;
1014
1015     switch( i_query )
1016     {
1017     case SPU_CHANNEL_REGISTER:
1018         pi = (int *)va_arg( args, int * );
1019         if( pi ) *pi = p_spu->i_channel++;
1020         break;
1021
1022     case SPU_CHANNEL_CLEAR:
1023         i = (int)va_arg( args, int );
1024         SpuClearChannel( p_spu, i );
1025         break;
1026
1027     default:
1028         msg_Dbg( p_spu, "control query not supported" );
1029         return VLC_EGENERIC;
1030     }
1031
1032     return VLC_SUCCESS;
1033 }
1034
1035 /*****************************************************************************
1036  * Object variables callbacks
1037  *****************************************************************************/
1038
1039 /*****************************************************************************
1040  * UpdateSPU: update subpicture settings
1041  *****************************************************************************
1042  * This function is called from CropCallback and at initialization time, to
1043  * retrieve crop information from the input.
1044  *****************************************************************************/
1045 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1046 {
1047     vlc_value_t val;
1048
1049     p_spu->b_force_palette = VLC_FALSE;
1050     p_spu->b_force_crop = VLC_FALSE;
1051
1052     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1053
1054     p_spu->b_force_crop = VLC_TRUE;
1055     var_Get( p_object, "x-start", &val );
1056     p_spu->i_crop_x = val.i_int;
1057     var_Get( p_object, "y-start", &val );
1058     p_spu->i_crop_y = val.i_int;
1059     var_Get( p_object, "x-end", &val );
1060     p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1061     var_Get( p_object, "y-end", &val );
1062     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1063
1064     if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1065     {
1066         memcpy( p_spu->palette, val.p_address, 16 );
1067         p_spu->b_force_palette = VLC_TRUE;
1068     }
1069
1070     msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1071              p_spu->i_crop_x, p_spu->i_crop_y,
1072              p_spu->i_crop_width, p_spu->i_crop_height,
1073              p_spu->b_force_palette );
1074 }
1075
1076 /*****************************************************************************
1077  * CropCallback: called when the highlight properties are changed
1078  *****************************************************************************
1079  * This callback is called from the input thread when we need cropping
1080  *****************************************************************************/
1081 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1082                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1083 {
1084     (void)psz_var; (void)oldval; (void)newval;
1085     UpdateSPU( (spu_t *)p_data, p_object );
1086     return VLC_SUCCESS;
1087 }
1088
1089 /*****************************************************************************
1090  * Buffers allocation callbacks for the filters
1091  *****************************************************************************/
1092 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1093 {
1094     filter_owner_sys_t *p_sys = p_filter->p_owner;
1095     subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1096     if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1097     return p_subpicture;
1098 }
1099
1100 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1101 {
1102     filter_owner_sys_t *p_sys = p_filter->p_owner;
1103     spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1104 }
1105
1106 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1107 {
1108     subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1109     (void)p_filter;
1110     memset( p_subpic, 0, sizeof(subpicture_t) );
1111     p_subpic->b_absolute = VLC_TRUE;
1112
1113     p_subpic->pf_create_region = __spu_CreateRegion;
1114     p_subpic->pf_make_region = __spu_MakeRegion;
1115     p_subpic->pf_destroy_region = __spu_DestroyRegion;
1116
1117     return p_subpic;
1118 }
1119
1120 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1121 {
1122     while( p_subpic->p_region )
1123     {
1124         subpicture_region_t *p_region = p_subpic->p_region;
1125         p_subpic->p_region = p_region->p_next;
1126         p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1127     }
1128
1129     free( p_subpic );
1130 }
1131
1132 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1133 {
1134     picture_t *p_picture = malloc( sizeof(picture_t) );
1135
1136     if( vout_AllocatePicture( p_filter, p_picture,
1137                               p_filter->fmt_out.video.i_chroma,
1138                               p_filter->fmt_out.video.i_width,
1139                               p_filter->fmt_out.video.i_height,
1140                               p_filter->fmt_out.video.i_aspect )
1141         != VLC_SUCCESS )
1142     {
1143         free( p_picture );
1144         return NULL;
1145     }
1146
1147     p_picture->pf_release = RegionPictureRelease;
1148
1149     return p_picture;
1150 }
1151
1152 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1153 {
1154     (void)p_filter;
1155     if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1156     if( p_pic ) free( p_pic );
1157 }
1158
1159 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1160                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1161 {
1162     (void)p_object; (void)oldval; (void)newval;
1163
1164     if( !strcmp( psz_var, "sub-filter" ) )
1165     {
1166         spu_t *p_spu = (spu_t *)p_data;
1167         vlc_mutex_lock( &p_spu->subpicture_lock );
1168         spu_DeleteChain( p_spu );
1169         spu_ParseChain( p_spu );
1170         vlc_mutex_unlock( &p_spu->subpicture_lock );
1171     }
1172     return VLC_SUCCESS;
1173 }