Support blending of RGBA and YUVA subpicture in addition to YUVP
[vlc.git] / 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 <vlc/vlc.h>
30 #include <vlc_vout.h>
31 #include <vlc_block.h>
32 #include <vlc_filter.h>
33 #include <vlc_osd.h>
34
35 /*****************************************************************************
36  * Local prototypes
37  *****************************************************************************/
38 static void UpdateSPU   ( spu_t *, vlc_object_t * );
39 static int  CropCallback( vlc_object_t *, char const *,
40                           vlc_value_t, vlc_value_t, void * );
41
42 static int spu_vaControlDefault( spu_t *, int, va_list );
43
44 static subpicture_t *sub_new_buffer( filter_t * );
45 static void sub_del_buffer( filter_t *, subpicture_t * );
46 static subpicture_t *spu_new_buffer( filter_t * );
47 static void spu_del_buffer( filter_t *, subpicture_t * );
48 static picture_t *spu_new_video_buffer( filter_t * );
49 static void spu_del_video_buffer( filter_t *, picture_t * );
50
51 static int spu_ParseChain( spu_t * );
52 static void spu_DeleteChain( spu_t * );
53 static int SubFilterCallback( vlc_object_t *, char const *,
54                               vlc_value_t, vlc_value_t, void * );
55
56 struct filter_owner_sys_t
57 {
58     spu_t *p_spu;
59     int i_channel;
60 };
61
62 enum {
63     SCALE_DEFAULT,
64     SCALE_TEXT,
65     SCALE_SIZE
66 };
67 /**
68  * Creates the subpicture unit
69  *
70  * \param p_this the parent object which creates the subpicture unit
71  */
72 spu_t *__spu_Create( vlc_object_t *p_this )
73 {
74     int i_index;
75     spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
76
77     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
78     {
79         p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
80     }
81
82     p_spu->p_blend = NULL;
83     p_spu->p_text = NULL;
84     p_spu->p_scale = NULL;
85     p_spu->i_filter = 0;
86     p_spu->pf_control = spu_vaControlDefault;
87
88     /* Register the default subpicture channel */
89     p_spu->i_channel = 2;
90
91     vlc_mutex_init( p_this, &p_spu->subpicture_lock );
92
93     vlc_object_attach( p_spu, p_this );
94
95     return p_spu;
96 }
97
98 /**
99  * Initialise the subpicture unit
100  *
101  * \param p_spu the subpicture unit object
102  */
103 int spu_Init( spu_t *p_spu )
104 {
105     vlc_value_t val;
106
107     /* If the user requested a sub margin, we force the position. */
108     var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
109     var_Get( p_spu, "sub-margin", &val );
110     p_spu->i_margin = val.i_int;
111
112     var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
113     var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
114
115     spu_ParseChain( p_spu );
116
117     return VLC_SUCCESS;
118 }
119
120 int spu_ParseChain( spu_t *p_spu )
121 {
122     char *psz_parser;
123     vlc_value_t val;
124     var_Get( p_spu, "sub-filter", &val );
125     psz_parser = val.psz_string;
126
127     while( psz_parser && *psz_parser )
128     {
129         config_chain_t *p_cfg;
130         char *psz_name;
131
132         psz_parser = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
133
134         msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
135
136         p_spu->pp_filter[p_spu->i_filter] =
137             vlc_object_create( p_spu, VLC_OBJECT_FILTER );
138         vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
139         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
140         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
141         p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
142         p_spu->pp_filter[p_spu->i_filter]->p_module =
143             module_Need( p_spu->pp_filter[p_spu->i_filter],
144                          "sub filter", psz_name, VLC_TRUE );
145         if( p_spu->pp_filter[p_spu->i_filter]->p_module )
146         {
147             filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
148             p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
149             spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
150             p_sys->p_spu = p_spu;
151             p_spu->i_filter++;
152         }
153         else
154         {
155             msg_Dbg( p_spu, "no sub filter found" );
156             config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
157             vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
158             vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
159         }
160
161         if( p_spu->i_filter >= 10 )
162         {
163             msg_Dbg( p_spu, "can't add anymore filters" );
164         }
165
166         free( psz_name );
167     }
168     if( val.psz_string ) free( val.psz_string );
169
170     return VLC_SUCCESS;
171 }
172
173 /**
174  * Destroy the subpicture unit
175  *
176  * \param p_this the parent object which destroys the subpicture unit
177  */
178 void spu_Destroy( spu_t *p_spu )
179 {
180     int i_index;
181
182     vlc_object_detach( p_spu );
183
184     /* Destroy all remaining subpictures */
185     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
186     {
187         if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
188         {
189             spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
190         }
191     }
192
193     if( p_spu->p_blend )
194     {
195         if( p_spu->p_blend->p_module )
196             module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
197
198         vlc_object_detach( p_spu->p_blend );
199         vlc_object_destroy( p_spu->p_blend );
200     }
201
202     if( p_spu->p_text )
203     {
204         if( p_spu->p_text->p_module )
205             module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
206
207         vlc_object_detach( p_spu->p_text );
208         vlc_object_destroy( p_spu->p_text );
209     }
210
211     if( p_spu->p_scale )
212     {
213         if( p_spu->p_scale->p_module )
214             module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
215
216         vlc_object_detach( p_spu->p_scale );
217         vlc_object_destroy( p_spu->p_scale );
218     }
219
220     spu_DeleteChain( p_spu );
221
222     vlc_mutex_destroy( &p_spu->subpicture_lock );
223     vlc_object_destroy( p_spu );
224 }
225
226 static void spu_DeleteChain( spu_t *p_spu )
227 {
228     if( p_spu->i_filter )
229     while( p_spu->i_filter )
230     {
231         p_spu->i_filter--;
232         module_Unneed( p_spu->pp_filter[p_spu->i_filter],
233                        p_spu->pp_filter[p_spu->i_filter]->p_module );
234         free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
235         config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
236         vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
237         vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
238     }
239 }
240
241 /**
242  * Attach/Detach the SPU from any input
243  *
244  * \param p_this the object in which to destroy the subpicture unit
245  * \param b_attach to select attach or detach
246  */
247 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
248 {
249     vlc_object_t *p_input;
250
251     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
252     if( !p_input ) return;
253
254     if( b_attach )
255     {
256         UpdateSPU( p_spu, VLC_OBJECT(p_input) );
257         var_AddCallback( p_input, "highlight", CropCallback, p_spu );
258         vlc_object_release( p_input );
259     }
260     else
261     {
262         /* Delete callback */
263         var_DelCallback( p_input, "highlight", CropCallback, p_spu );
264         vlc_object_release( p_input );
265     }
266 }
267
268 /**
269  * Create a subpicture region
270  *
271  * \param p_this vlc_object_t
272  * \param p_fmt the format that this subpicture region should have
273  */
274 static void RegionPictureRelease( picture_t *p_pic )
275 {
276     if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
277 }
278 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
279                                          video_format_t *p_fmt )
280 {
281     subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
282     if( !p_region ) return NULL;
283
284     memset( p_region, 0, sizeof(subpicture_region_t) );
285     p_region->p_next = NULL;
286     p_region->p_cache = NULL;
287     p_region->fmt = *p_fmt;
288     p_region->psz_text = NULL;
289     p_region->p_style = NULL;
290
291     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
292         p_fmt->p_palette = p_region->fmt.p_palette =
293             malloc( sizeof(video_palette_t) );
294     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
295
296     p_region->picture.p_data_orig = NULL;
297
298     if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
299
300     vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
301                           p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
302
303     if( !p_region->picture.i_planes )
304     {
305         free( p_region );
306         if( p_fmt->p_palette ) free( p_fmt->p_palette );
307         return NULL;
308     }
309
310     p_region->picture.pf_release = RegionPictureRelease;
311
312     return p_region;
313 }
314
315 /**
316  * Make a subpicture region from an existing picture_t
317  *
318  * \param p_this vlc_object_t
319  * \param p_fmt the format that this subpicture region should have
320  * \param p_pic a pointer to the picture creating the region (not freed)
321  */
322 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
323                                        video_format_t *p_fmt,
324                                        picture_t *p_pic )
325 {
326     subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
327     (void)p_this;
328     memset( p_region, 0, sizeof(subpicture_region_t) );
329     p_region->p_next = 0;
330     p_region->p_cache = 0;
331     p_region->fmt = *p_fmt;
332     p_region->psz_text = 0;
333     p_region->p_style = NULL;
334
335     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
336         p_fmt->p_palette = p_region->fmt.p_palette =
337             malloc( sizeof(video_palette_t) );
338     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
339
340     memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
341     p_region->picture.pf_release = RegionPictureRelease;
342
343     return p_region;
344 }
345
346 /**
347  * Destroy a subpicture region
348  *
349  * \param p_this vlc_object_t
350  * \param p_region the subpicture region to destroy
351  */
352 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
353 {
354     if( !p_region ) return;
355     if( p_region->picture.pf_release )
356         p_region->picture.pf_release( &p_region->picture );
357     if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
358     if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
359
360     if( p_region->psz_text )
361         free( p_region->psz_text );
362     if( p_region->psz_html )
363         free( p_region->psz_html );
364     //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
365     free( p_region );
366 }
367
368 /**
369  * Display a subpicture
370  *
371  * Remove the reservation flag of a subpicture, which will cause it to be
372  * ready for display.
373  * \param p_spu the subpicture unit object
374  * \param p_subpic the subpicture to display
375  */
376 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
377 {
378     /* Check if status is valid */
379     if( p_subpic->i_status != RESERVED_SUBPICTURE )
380     {
381         msg_Err( p_spu, "subpicture %p has invalid status #%d",
382                  p_subpic, p_subpic->i_status );
383     }
384
385     /* Remove reservation flag */
386     p_subpic->i_status = READY_SUBPICTURE;
387
388     if( p_subpic->i_channel == DEFAULT_CHAN )
389     {
390         p_subpic->i_channel = 0xFFFF;
391         spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
392         p_subpic->i_channel = DEFAULT_CHAN;
393     }
394 }
395
396 /**
397  * Allocate a subpicture in the spu heap.
398  *
399  * This function create a reserved subpicture in the spu heap.
400  * A null pointer is returned if the function fails. This method provides an
401  * already allocated zone of memory in the spu data fields. It needs locking
402  * since several pictures can be created by several producers threads.
403  * \param p_spu the subpicture unit in which to create the subpicture
404  * \return NULL on error, a reserved subpicture otherwise
405  */
406 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
407 {
408     int                 i_subpic;                        /* subpicture index */
409     subpicture_t *      p_subpic = NULL;            /* first free subpicture */
410
411     /* Get lock */
412     vlc_mutex_lock( &p_spu->subpicture_lock );
413
414     /*
415      * Look for an empty place
416      */
417     p_subpic = NULL;
418     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
419     {
420         if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
421         {
422             /* Subpicture is empty and ready for allocation */
423             p_subpic = &p_spu->p_subpicture[i_subpic];
424             p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
425             break;
426         }
427     }
428
429     /* If no free subpicture could be found */
430     if( p_subpic == NULL )
431     {
432         msg_Err( p_spu, "subpicture heap is full" );
433         vlc_mutex_unlock( &p_spu->subpicture_lock );
434         return NULL;
435     }
436
437     /* Copy subpicture information, set some default values */
438     memset( p_subpic, 0, sizeof(subpicture_t) );
439     p_subpic->i_status   = RESERVED_SUBPICTURE;
440     p_subpic->b_absolute = VLC_TRUE;
441     p_subpic->b_pausable = VLC_FALSE;
442     p_subpic->b_fade     = VLC_FALSE;
443     p_subpic->i_alpha    = 0xFF;
444     p_subpic->p_region   = NULL;
445     p_subpic->pf_render  = NULL;
446     p_subpic->pf_destroy = NULL;
447     p_subpic->p_sys      = NULL;
448     vlc_mutex_unlock( &p_spu->subpicture_lock );
449
450     p_subpic->pf_create_region = __spu_CreateRegion;
451     p_subpic->pf_make_region = __spu_MakeRegion;
452     p_subpic->pf_destroy_region = __spu_DestroyRegion;
453
454     return p_subpic;
455 }
456
457 /**
458  * Remove a subpicture from the heap
459  *
460  * This function frees a previously reserved subpicture.
461  * It is meant to be used when the construction of a picture aborted.
462  * This function does not need locking since reserved subpictures are ignored
463  * by the spu.
464  */
465 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
466 {
467     /* Get lock */
468     vlc_mutex_lock( &p_spu->subpicture_lock );
469
470     /* There can be race conditions so we need to check the status */
471     if( p_subpic->i_status == FREE_SUBPICTURE )
472     {
473         vlc_mutex_unlock( &p_spu->subpicture_lock );
474         return;
475     }
476
477     /* Check if status is valid */
478     if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
479            && ( p_subpic->i_status != READY_SUBPICTURE ) )
480     {
481         msg_Err( p_spu, "subpicture %p has invalid status %d",
482                          p_subpic, p_subpic->i_status );
483     }
484
485     while( p_subpic->p_region )
486     {
487         subpicture_region_t *p_region = p_subpic->p_region;
488         p_subpic->p_region = p_region->p_next;
489         spu_DestroyRegion( p_spu, p_region );
490     }
491
492     if( p_subpic->pf_destroy )
493     {
494         p_subpic->pf_destroy( p_subpic );
495     }
496
497     p_subpic->i_status = FREE_SUBPICTURE;
498
499     vlc_mutex_unlock( &p_spu->subpicture_lock );
500 }
501
502 /*****************************************************************************
503  * spu_RenderSubpictures: render a subpicture list
504  *****************************************************************************
505  * This function renders all sub picture units in the list.
506  *****************************************************************************/
507 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
508                             picture_t *p_pic_dst, picture_t *p_pic_src,
509                             subpicture_t *p_subpic,
510                             int i_scale_width_orig, int i_scale_height_orig )
511 {
512     int i_source_video_width  = p_fmt->i_width  * 1000 / i_scale_width_orig;
513     int i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;
514
515     /* Get lock */
516     vlc_mutex_lock( &p_spu->subpicture_lock );
517
518     /* Check i_status again to make sure spudec hasn't destroyed the subpic */
519     while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
520     {
521         subpicture_region_t *p_region = p_subpic->p_region;
522         int pi_scale_width[ SCALE_SIZE ];
523         int pi_scale_height[ SCALE_SIZE ];
524         int pi_subpic_x[ SCALE_SIZE ];
525         int k;
526
527         /* If the source video and subtitles stream agree on the size of
528          * the video then disregard all further references to the subtitle
529          * stream.
530          */
531         if( ( i_source_video_height == p_subpic->i_original_picture_height ) &&
532             ( i_source_video_width  == p_subpic->i_original_picture_width ) )
533         {
534             p_subpic->i_original_picture_height = 0;
535             p_subpic->i_original_picture_width = 0;
536         }
537
538         for( k = 0; k < SCALE_SIZE ; k++ )
539             pi_subpic_x[ k ] = p_subpic->i_x;
540
541         /* Load the blending module */
542         if( !p_spu->p_blend && p_region )
543         {
544             p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
545             vlc_object_attach( p_spu->p_blend, p_spu );
546             p_spu->p_blend->fmt_out.video.i_x_offset =
547                 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
548             p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
549             p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
550             p_spu->p_blend->fmt_in.video.i_chroma = p_region->fmt.i_chroma;
551
552             p_spu->p_blend->p_module =
553                 module_Need( p_spu->p_blend, "video blending", 0, 0 );
554         }
555
556         /* Load the text rendering module; it is possible there is a
557          * text region somewhere in the subpicture other than the first
558          * element in the region list, so just load it anyway as we'll
559          * probably want it sooner or later. */
560         if( !p_spu->p_text && p_region )
561         {
562             char *psz_modulename = NULL;
563
564             p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
565             vlc_object_attach( p_spu->p_text, p_spu );
566
567             p_spu->p_text->fmt_out.video.i_width =
568                 p_spu->p_text->fmt_out.video.i_visible_width =
569                 p_fmt->i_width;
570             p_spu->p_text->fmt_out.video.i_height =
571                 p_spu->p_text->fmt_out.video.i_visible_height =
572                 p_fmt->i_height;
573
574             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
575             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
576
577             psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
578             if( psz_modulename && *psz_modulename )
579             {
580                 p_spu->p_text->p_module =
581                     module_Need( p_spu->p_text, "text renderer",
582                                  psz_modulename, VLC_TRUE );
583             }
584             if( !p_spu->p_text->p_module )
585             {
586                 p_spu->p_text->p_module =
587                     module_Need( p_spu->p_text, "text renderer", 0, 0 );
588             }
589             if( psz_modulename ) free( psz_modulename );
590         }
591
592         if( p_spu->p_text )
593         {
594             subpicture_region_t *p_text_region = p_subpic->p_region;
595
596             /* Only overwrite the size fields if the region is still in pre-rendered
597              * TEXT format. We have to traverse the subregion list because if more
598              * than one subregion is present, the text region isn't guarentteed to
599              * be the first in the list, and only text regions use this flag.
600              * All of this effort assists with the rescaling of text that has been
601              * rendered at native resolution, rather than video resolution.
602              */
603             while( p_text_region &&
604                    ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
605             {
606                 p_text_region = p_text_region->p_next;
607             }
608
609             if( p_text_region && 
610                 ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
611             {
612                 if( (p_subpic->i_original_picture_height > 0) &&
613                     (p_subpic->i_original_picture_width  > 0) )
614                 {
615                     p_spu->p_text->fmt_out.video.i_width =
616                         p_spu->p_text->fmt_out.video.i_visible_width =
617                         p_subpic->i_original_picture_width;
618                     p_spu->p_text->fmt_out.video.i_height =
619                         p_spu->p_text->fmt_out.video.i_visible_height =
620                         p_subpic->i_original_picture_height;
621                 }
622                 else
623                 {
624                     p_spu->p_text->fmt_out.video.i_width =
625                         p_spu->p_text->fmt_out.video.i_visible_width =
626                         p_fmt->i_width;
627                     p_spu->p_text->fmt_out.video.i_height =
628                         p_spu->p_text->fmt_out.video.i_visible_height =
629                         p_fmt->i_height;
630                 }
631             }
632         }
633
634         pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
635         pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
636
637         if( p_spu->p_text )
638         {
639             pi_scale_width[ SCALE_TEXT ]     = ( p_fmt->i_width * 1000 ) /
640                                           p_spu->p_text->fmt_out.video.i_width;
641             pi_scale_height[ SCALE_TEXT ]    = ( p_fmt->i_height * 1000 ) /
642                                           p_spu->p_text->fmt_out.video.i_height;
643         }
644         /* If we have an explicit size plane to render to, then turn off
645          * the fontsize rescaling.
646          */
647         if( (p_subpic->i_original_picture_height > 0) &&
648             (p_subpic->i_original_picture_width  > 0) )
649         {
650             i_scale_width_orig  = 1000;
651             i_scale_height_orig = 1000;
652         }
653
654         for( k = 0; k < SCALE_SIZE ; k++ )
655         {
656             /* Case of both width and height being specified has been dealt with
657              * above by instead rendering to an output pane of the explicit
658              * dimensions specified - we don't need to scale it.
659              */
660             if( (p_subpic->i_original_picture_height > 0) &&
661                 (p_subpic->i_original_picture_width  <= 0) )
662             {
663                 pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
664                                  p_subpic->i_original_picture_height;
665                 pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_height /
666                                  p_subpic->i_original_picture_height;
667             }
668         }
669
670
671         /* Set default subpicture aspect ratio */
672         if( p_region && p_region->fmt.i_aspect &&
673             ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
674         {
675             p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
676             p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
677         }
678         if( p_region &&
679             ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
680         {
681             p_region->fmt.i_sar_den = p_fmt->i_sar_den;
682             p_region->fmt.i_sar_num = p_fmt->i_sar_num;
683         }
684
685         /* Take care of the aspect ratio */
686         if( p_region && 
687             ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
688               ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
689         {
690             for( k = 0; k < SCALE_SIZE ; k++ )
691             {
692                 pi_scale_width[ k ] = pi_scale_width[ k ] *
693                     (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
694                     p_region->fmt.i_sar_den / p_fmt->i_sar_num;
695                 pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
696             }
697         }
698
699         /* Load the scaling module */
700         if( !p_spu->p_scale &&
701            ((((pi_scale_width[ SCALE_TEXT ]    > 0)     || (pi_scale_height[ SCALE_TEXT ]    > 0)) &&
702              ((pi_scale_width[ SCALE_TEXT ]    != 1000) || (pi_scale_height[ SCALE_TEXT ]    != 1000))) ||
703             (((pi_scale_width[ SCALE_DEFAULT ] > 0)     || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
704              ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
705         {
706             p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
707             vlc_object_attach( p_spu->p_scale, p_spu );
708             p_spu->p_scale->fmt_out.video.i_chroma =
709                 p_spu->p_scale->fmt_in.video.i_chroma =
710                     VLC_FOURCC('Y','U','V','P');
711             /* FIXME: We'll also be using it for YUVA and RGBA blending ... */
712
713             p_spu->p_scale->fmt_in.video.i_width =
714                 p_spu->p_scale->fmt_in.video.i_height = 32;
715             p_spu->p_scale->fmt_out.video.i_width =
716                 p_spu->p_scale->fmt_out.video.i_height = 16;
717
718             p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
719             p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
720             p_spu->p_scale->p_module =
721                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
722         }
723
724         while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
725         {
726             video_format_t orig_fmt = p_region->fmt;
727             vlc_bool_t b_rerender_text = VLC_FALSE;
728             int i_fade_alpha = 255;
729             int i_x_offset;
730             int i_y_offset;
731             int i_scale_idx   = SCALE_DEFAULT;
732             int i_inv_scale_x = 1000;
733             int i_inv_scale_y = 1000;
734
735             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
736             {
737                 if( p_spu->p_text && p_spu->p_text->p_module )
738                 {
739                     vlc_value_t  val;
740
741                     /* Setup 3 variables which can be used to render
742                      * time-dependent text (and effects). The first indicates
743                      * the total amount of time the text will be on screen,
744                      * the second the amount of time it has already been on
745                      * screen (can be a negative value as text is layed out
746                      * before it is rendered) and the third is a feedback
747                      * variable from the renderer - if the renderer sets it
748                      * then this particular text is time-dependent, eg. the
749                      * visual progress bar inside the text in karaoke and the
750                      * text needs to be rendered multiple times in order for
751                      * the effect to work - we therefore need to return the
752                      * region to its original state at the end of the loop,
753                      * instead of leaving it in YUVA or YUVP.
754                      * Any renderer which is unaware of how to render
755                      * time-dependent text can happily ignore the variables
756                      * and render the text the same as usual - it should at
757                      * least show up on screen, but the effect won't change
758                      * the text over time.
759                      */
760
761                     var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
762                     val.i_time = p_subpic->i_stop - p_subpic->i_start;
763                     var_Set( p_spu->p_text, "spu-duration", val );
764
765                     var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
766                     val.i_time = mdate() - p_subpic->i_start;
767                     var_Set( p_spu->p_text, "spu-elapsed", val );
768
769                     var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
770                     var_SetBool( p_spu->p_text, "text-rerender", VLC_FALSE );
771
772                     var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
773                     var_SetInteger( p_spu->p_text, "scale",
774                               __MIN(i_scale_width_orig, i_scale_height_orig) );
775
776                     if( p_spu->p_text->pf_render_html && p_region->psz_html )
777                     {
778                         p_spu->p_text->pf_render_html( p_spu->p_text,
779                                                        p_region, p_region );
780                     }
781                     else if( p_spu->p_text->pf_render_text )
782                     {
783                         p_spu->p_text->pf_render_text( p_spu->p_text,
784                                                        p_region, p_region );
785                     }
786                     b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );
787
788                     var_Destroy( p_spu->p_text, "spu-duration" );
789                     var_Destroy( p_spu->p_text, "spu-elapsed" );
790                     var_Destroy( p_spu->p_text, "text-rerender" );
791                     var_Destroy( p_spu->p_text, "scale" );
792                 }
793                 p_region->i_align |= SUBPICTURE_RENDERED;
794             }
795
796             if( p_region->i_align & SUBPICTURE_RENDERED )
797             {
798                 i_scale_idx   = SCALE_TEXT;
799                 i_inv_scale_x = i_scale_width_orig;
800                 i_inv_scale_y = i_scale_height_orig;
801             }
802
803             i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
804             i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;
805
806             /* Force palette if requested */
807             if( p_spu->b_force_palette &&
808                 ( VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma ) )
809             {
810                 memcpy( p_region->fmt.p_palette->palette,
811                         p_spu->palette, 16 );
812             }
813
814             /* Scale SPU if necessary */
815             if( p_region->p_cache && 
816                 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
817             {
818                 if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
819                     p_region->p_cache->fmt.i_width ||
820                     pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
821                     p_region->p_cache->fmt.i_height )
822                 {
823                     p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
824                                                  p_region->p_cache );
825                     p_region->p_cache = 0;
826                 }
827             }
828
829             if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) || 
830                   ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
831                 ( ( pi_scale_width[ i_scale_idx ] > 0 ) || 
832                   ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
833                 p_spu->p_scale && !p_region->p_cache &&
834                 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
835             {
836                 picture_t *p_pic;
837
838                 p_spu->p_scale->fmt_in.video = p_region->fmt;
839                 p_spu->p_scale->fmt_out.video = p_region->fmt;
840
841                 p_region->p_cache =
842                     p_subpic->pf_create_region( VLC_OBJECT(p_spu),
843                         &p_spu->p_scale->fmt_out.video );
844                 if( p_spu->p_scale->fmt_out.video.p_palette )
845                     *p_spu->p_scale->fmt_out.video.p_palette =
846                         *p_region->fmt.p_palette;
847                 p_region->p_cache->p_next = p_region->p_next;
848
849                 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
850                                   &p_region->picture );
851
852                 p_spu->p_scale->fmt_out.video.i_width =
853                     p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
854                 p_spu->p_scale->fmt_out.video.i_visible_width =
855                     p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
856                 p_spu->p_scale->fmt_out.video.i_height =
857                     p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
858                 p_spu->p_scale->fmt_out.video.i_visible_height =
859                     p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
860                 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
861                 p_region->p_cache->i_x = p_region->i_x * pi_scale_width[ i_scale_idx ] / 1000;
862                 p_region->p_cache->i_y = p_region->i_y * pi_scale_height[ i_scale_idx ] / 1000;
863                 p_region->p_cache->i_align = p_region->i_align;
864
865                 p_pic = p_spu->p_scale->pf_video_filter(
866                                  p_spu->p_scale, &p_region->p_cache->picture );
867                 if( p_pic )
868                 {
869                     picture_t p_pic_tmp = p_region->p_cache->picture;
870                     p_region->p_cache->picture = *p_pic;
871                     *p_pic = p_pic_tmp;
872                     free( p_pic );
873                 }
874             }
875
876             if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
877                   ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
878                 ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
879                   ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
880                 p_spu->p_scale && p_region->p_cache &&
881                 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )  )
882             {
883                 p_region = p_region->p_cache;
884             }
885
886             if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
887             {
888                 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
889                     (p_subpic->i_y + p_region->i_y) * i_inv_scale_y / 1000;
890             }
891             else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
892             {
893                 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
894             }
895
896             if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
897             {
898                 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
899                     (pi_subpic_x[ i_scale_idx ] + p_region->i_x)
900                     * i_inv_scale_x / 1000;
901             }
902             else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
903             {
904                 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
905             }
906
907             if( p_subpic->b_absolute )
908             {
909                 i_x_offset = (p_region->i_x +
910                     pi_subpic_x[ i_scale_idx ] *
911                                      pi_scale_width[ i_scale_idx ] / 1000)
912                     * i_inv_scale_x / 1000;
913                 i_y_offset = (p_region->i_y +
914                     p_subpic->i_y * pi_scale_height[ i_scale_idx ] / 1000)
915                     * i_inv_scale_y / 1000;
916
917             }
918
919             i_x_offset = __MAX( i_x_offset, 0 );
920             i_y_offset = __MAX( i_y_offset, 0 );
921
922             if( ( p_spu->i_margin != 0 ) &&
923                 ( p_spu->b_force_crop == VLC_FALSE ) )
924             {
925                 int i_diff = 0;
926                 int i_low = (i_y_offset - p_spu->i_margin) * i_inv_scale_y / 1000;
927                 int i_high = i_low + p_region->fmt.i_height;
928
929                 /* crop extra margin to keep within bounds */
930                 if( i_low < 0 )
931                     i_diff = i_low;
932                 if( i_high > (int)p_fmt->i_height )
933                     i_diff = i_high - p_fmt->i_height;
934                 i_y_offset -= ( p_spu->i_margin * i_inv_scale_y / 1000 + i_diff );
935             }
936
937             p_spu->p_blend->fmt_in.video = p_region->fmt;
938
939             /* Force cropping if requested */
940             if( p_spu->b_force_crop )
941             {
942                 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
943                 int i_crop_x = p_spu->i_crop_x * pi_scale_width[ i_scale_idx ] / 1000
944                                     * i_inv_scale_x / 1000;
945                 int i_crop_y = p_spu->i_crop_y * pi_scale_height[ i_scale_idx ] / 1000
946                                     * i_inv_scale_y / 1000;
947                 int i_crop_width = p_spu->i_crop_width * pi_scale_width[ i_scale_idx ] / 1000
948                                     * i_inv_scale_x / 1000;
949                 int i_crop_height = p_spu->i_crop_height * pi_scale_height[ i_scale_idx ] / 1000
950                                     * i_inv_scale_y / 1000;
951
952                 /* Find the intersection */
953                 if( i_crop_x + i_crop_width <= i_x_offset ||
954                     i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
955                     i_crop_y + i_crop_height <= i_y_offset ||
956                     i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
957                 {
958                     /* No intersection */
959                     p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
960                 }
961                 else
962                 {
963                     int i_x, i_y, i_x_end, i_y_end;
964                     i_x = __MAX( i_crop_x, i_x_offset );
965                     i_y = __MAX( i_crop_y, i_y_offset );
966                     i_x_end = __MIN( i_crop_x + i_crop_width,
967                                    i_x_offset + (int)p_fmt->i_visible_width );
968                     i_y_end = __MIN( i_crop_y + i_crop_height,
969                                    i_y_offset + (int)p_fmt->i_visible_height );
970
971                     p_fmt->i_x_offset = i_x - i_x_offset;
972                     p_fmt->i_y_offset = i_y - i_y_offset;
973                     p_fmt->i_visible_width = i_x_end - i_x;
974                     p_fmt->i_visible_height = i_y_end - i_y;
975
976                     i_x_offset = i_x;
977                     i_y_offset = i_y;
978                 }
979             }
980
981             if( p_subpic->b_fade )
982             {
983                 mtime_t i_fade_start = ( p_subpic->i_stop +
984                                          p_subpic->i_start ) / 2;
985                 mtime_t i_now = mdate();
986                 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
987                 {
988                     i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
989                                    ( p_subpic->i_stop - i_fade_start );
990                 }
991             }
992
993             i_x_offset = __MAX( i_x_offset, 0 );
994             i_y_offset = __MAX( i_y_offset, 0 );
995
996             if( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )
997             {
998                 /* Update the output picture size */
999                 p_spu->p_blend->fmt_out.video.i_width =
1000                     p_spu->p_blend->fmt_out.video.i_visible_width =
1001                         p_fmt->i_width;
1002                 p_spu->p_blend->fmt_out.video.i_height =
1003                     p_spu->p_blend->fmt_out.video.i_visible_height =
1004                         p_fmt->i_height;
1005
1006                 p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
1007                     p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
1008                     i_fade_alpha * p_subpic->i_alpha / 255 );
1009             }
1010
1011             if( b_rerender_text )
1012             {
1013                 /* Some forms of subtitles need to be re-rendered more than
1014                  * once, eg. karaoke. We therefore restore the region to its
1015                  * pre-rendered state, so the next time through everything is
1016                  * calculated again.
1017                  */
1018                 p_region->picture.pf_release( &p_region->picture );
1019                 memset( &p_region->picture, 0, sizeof( picture_t ) );
1020                 p_region->fmt = orig_fmt;
1021                 p_region->i_align &= ~SUBPICTURE_RENDERED;
1022             }
1023             p_region = p_region->p_next;
1024         }
1025
1026         p_subpic = p_subpic->p_next;
1027     }
1028
1029     vlc_mutex_unlock( &p_spu->subpicture_lock );
1030 }
1031
1032 /*****************************************************************************
1033  * spu_SortSubpictures: find the subpictures to display
1034  *****************************************************************************
1035  * This function parses all subpictures and decides which ones need to be
1036  * displayed. This operation does not need lock, since only READY_SUBPICTURE
1037  * are handled. If no picture has been selected, display_date will depend on
1038  * the subpicture.
1039  * We also check for ephemer DVD subpictures (subpictures that have
1040  * to be removed if a newer one is available), which makes it a lot
1041  * more difficult to guess if a subpicture has to be rendered or not.
1042  *****************************************************************************/
1043 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
1044                                    vlc_bool_t b_paused )
1045 {
1046     int i_index, i_channel;
1047     subpicture_t *p_subpic = NULL;
1048     subpicture_t *p_ephemer;
1049     mtime_t      ephemer_date;
1050
1051     /* Run subpicture filters */
1052     for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
1053     {
1054         subpicture_t *p_subpic_filter;
1055         p_subpic_filter = p_spu->pp_filter[i_index]->
1056             pf_sub_filter( p_spu->pp_filter[i_index], display_date );
1057         if( p_subpic_filter )
1058         {
1059             spu_DisplaySubpicture( p_spu, p_subpic_filter );
1060         }
1061     }
1062
1063     /* We get an easily parsable chained list of subpictures which
1064      * ends with NULL since p_subpic was initialized to NULL. */
1065     for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
1066     {
1067         p_ephemer = 0;
1068         ephemer_date = 0;
1069
1070         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1071         {
1072             if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
1073                 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
1074             {
1075                 continue;
1076             }
1077             if( display_date &&
1078                 display_date < p_spu->p_subpicture[i_index].i_start )
1079             {
1080                 /* Too early, come back next monday */
1081                 continue;
1082             }
1083
1084             if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
1085                 ephemer_date = p_spu->p_subpicture[i_index].i_start;
1086
1087             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
1088                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
1089                   p_spu->p_subpicture[i_index].i_stop >
1090                   p_spu->p_subpicture[i_index].i_start ) &&
1091                 !( p_spu->p_subpicture[i_index].b_pausable &&
1092                    b_paused ) )
1093             {
1094                 /* Too late, destroy the subpic */
1095                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
1096                 continue;
1097             }
1098
1099             /* If this is an ephemer subpic, add it to our list */
1100             if( p_spu->p_subpicture[i_index].b_ephemer )
1101             {
1102                 p_spu->p_subpicture[i_index].p_next = p_ephemer;
1103                 p_ephemer = &p_spu->p_subpicture[i_index];
1104
1105                 continue;
1106             }
1107
1108             p_spu->p_subpicture[i_index].p_next = p_subpic;
1109             p_subpic = &p_spu->p_subpicture[i_index];
1110         }
1111
1112         /* If we found ephemer subpictures, check if they have to be
1113          * displayed or destroyed */
1114         while( p_ephemer != NULL )
1115         {
1116             subpicture_t *p_tmp = p_ephemer;
1117             p_ephemer = p_ephemer->p_next;
1118
1119             if( p_tmp->i_start < ephemer_date )
1120             {
1121                 /* Ephemer subpicture has lived too long */
1122                 spu_DestroySubpicture( p_spu, p_tmp );
1123             }
1124             else
1125             {
1126                 /* Ephemer subpicture can still live a bit */
1127                 p_tmp->p_next = p_subpic;
1128                 p_subpic = p_tmp;
1129             }
1130         }
1131     }
1132
1133     return p_subpic;
1134 }
1135
1136 /*****************************************************************************
1137  * SpuClearChannel: clear an spu channel
1138  *****************************************************************************
1139  * This function destroys the subpictures which belong to the spu channel
1140  * corresponding to i_channel_id.
1141  *****************************************************************************/
1142 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1143 {
1144     int          i_subpic;                               /* subpicture index */
1145     subpicture_t *p_subpic = NULL;                  /* first free subpicture */
1146
1147     vlc_mutex_lock( &p_spu->subpicture_lock );
1148
1149     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1150     {
1151         p_subpic = &p_spu->p_subpicture[i_subpic];
1152         if( p_subpic->i_status == FREE_SUBPICTURE
1153             || ( p_subpic->i_status != RESERVED_SUBPICTURE
1154                  && p_subpic->i_status != READY_SUBPICTURE ) )
1155         {
1156             continue;
1157         }
1158
1159         if( p_subpic->i_channel == i_channel )
1160         {
1161             while( p_subpic->p_region )
1162             {
1163                 subpicture_region_t *p_region = p_subpic->p_region;
1164                 p_subpic->p_region = p_region->p_next;
1165                 spu_DestroyRegion( p_spu, p_region );
1166             }
1167
1168             if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
1169             p_subpic->i_status = FREE_SUBPICTURE;
1170         }
1171     }
1172
1173     vlc_mutex_unlock( &p_spu->subpicture_lock );
1174 }
1175
1176 /*****************************************************************************
1177  * spu_ControlDefault: default methods for the subpicture unit control.
1178  *****************************************************************************/
1179 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
1180 {
1181     int *pi, i;
1182
1183     switch( i_query )
1184     {
1185     case SPU_CHANNEL_REGISTER:
1186         pi = (int *)va_arg( args, int * );
1187         if( pi ) *pi = p_spu->i_channel++;
1188         break;
1189
1190     case SPU_CHANNEL_CLEAR:
1191         i = (int)va_arg( args, int );
1192         SpuClearChannel( p_spu, i );
1193         break;
1194
1195     default:
1196         msg_Dbg( p_spu, "control query not supported" );
1197         return VLC_EGENERIC;
1198     }
1199
1200     return VLC_SUCCESS;
1201 }
1202
1203 /*****************************************************************************
1204  * Object variables callbacks
1205  *****************************************************************************/
1206
1207 /*****************************************************************************
1208  * UpdateSPU: update subpicture settings
1209  *****************************************************************************
1210  * This function is called from CropCallback and at initialization time, to
1211  * retrieve crop information from the input.
1212  *****************************************************************************/
1213 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1214 {
1215     vlc_value_t val;
1216
1217     p_spu->b_force_palette = VLC_FALSE;
1218     p_spu->b_force_crop = VLC_FALSE;
1219
1220     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1221
1222     p_spu->b_force_crop = VLC_TRUE;
1223     var_Get( p_object, "x-start", &val );
1224     p_spu->i_crop_x = val.i_int;
1225     var_Get( p_object, "y-start", &val );
1226     p_spu->i_crop_y = val.i_int;
1227     var_Get( p_object, "x-end", &val );
1228     p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1229     var_Get( p_object, "y-end", &val );
1230     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1231
1232     if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1233     {
1234         memcpy( p_spu->palette, val.p_address, 16 );
1235         p_spu->b_force_palette = VLC_TRUE;
1236     }
1237
1238     msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1239              p_spu->i_crop_x, p_spu->i_crop_y,
1240              p_spu->i_crop_width, p_spu->i_crop_height,
1241              p_spu->b_force_palette );
1242 }
1243
1244 /*****************************************************************************
1245  * CropCallback: called when the highlight properties are changed
1246  *****************************************************************************
1247  * This callback is called from the input thread when we need cropping
1248  *****************************************************************************/
1249 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1250                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1251 {
1252     (void)psz_var; (void)oldval; (void)newval;
1253     UpdateSPU( (spu_t *)p_data, p_object );
1254     return VLC_SUCCESS;
1255 }
1256
1257 /*****************************************************************************
1258  * Buffers allocation callbacks for the filters
1259  *****************************************************************************/
1260 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1261 {
1262     filter_owner_sys_t *p_sys = p_filter->p_owner;
1263     subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1264     if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1265     return p_subpicture;
1266 }
1267
1268 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1269 {
1270     filter_owner_sys_t *p_sys = p_filter->p_owner;
1271     spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1272 }
1273
1274 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1275 {
1276     subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1277     (void)p_filter;
1278     memset( p_subpic, 0, sizeof(subpicture_t) );
1279     p_subpic->b_absolute = VLC_TRUE;
1280
1281     p_subpic->pf_create_region = __spu_CreateRegion;
1282     p_subpic->pf_make_region = __spu_MakeRegion;
1283     p_subpic->pf_destroy_region = __spu_DestroyRegion;
1284
1285     return p_subpic;
1286 }
1287
1288 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1289 {
1290     while( p_subpic->p_region )
1291     {
1292         subpicture_region_t *p_region = p_subpic->p_region;
1293         p_subpic->p_region = p_region->p_next;
1294         p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1295     }
1296
1297     free( p_subpic );
1298 }
1299
1300 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1301 {
1302     picture_t *p_picture = malloc( sizeof(picture_t) );
1303
1304     if( vout_AllocatePicture( p_filter, p_picture,
1305                               p_filter->fmt_out.video.i_chroma,
1306                               p_filter->fmt_out.video.i_width,
1307                               p_filter->fmt_out.video.i_height,
1308                               p_filter->fmt_out.video.i_aspect )
1309         != VLC_SUCCESS )
1310     {
1311         free( p_picture );
1312         return NULL;
1313     }
1314
1315     p_picture->pf_release = RegionPictureRelease;
1316
1317     return p_picture;
1318 }
1319
1320 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1321 {
1322     (void)p_filter;
1323     if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1324     if( p_pic ) free( p_pic );
1325 }
1326
1327 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1328                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1329 {
1330     (void)p_object; (void)oldval; (void)newval;
1331
1332     if( !strcmp( psz_var, "sub-filter" ) )
1333     {
1334         spu_t *p_spu = (spu_t *)p_data;
1335         vlc_mutex_lock( &p_spu->subpicture_lock );
1336         spu_DeleteChain( p_spu );
1337         spu_ParseChain( p_spu );
1338         vlc_mutex_unlock( &p_spu->subpicture_lock );
1339     }
1340     return VLC_SUCCESS;
1341 }