Fixes segfault
[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_EGENERIC;
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_EGENERIC;
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 = 0;
286     p_region->p_cache = 0;
287     p_region->fmt = *p_fmt;
288     p_region->psz_text = 0;
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   = 0;
445     p_subpic->pf_render  = 0;
446     p_subpic->pf_destroy = 0;
447     p_subpic->p_sys      = 0;
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         for( k=0; k< SCALE_SIZE ; k++ )
528             pi_subpic_x[ k ] = p_subpic->i_x;
529
530         /* Load the blending module */
531         if( !p_spu->p_blend && p_region )
532         {
533             p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
534             vlc_object_attach( p_spu->p_blend, p_spu );
535             p_spu->p_blend->fmt_out.video.i_x_offset =
536                 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
537             p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
538             p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
539             p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
540             /* XXX: We'll also be using it for YUVA and RGBA blending ... */
541
542             p_spu->p_blend->p_module =
543                 module_Need( p_spu->p_blend, "video blending", 0, 0 );
544         }
545
546         /* Load the text rendering module; it is possible there is a
547          * text region somewhere in the subpicture other than the first
548          * element in the region list, so just load it anyway as we'll
549          * probably want it sooner or later. */
550         if( !p_spu->p_text && p_region )
551         {
552             char *psz_modulename = NULL;
553
554             p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
555             vlc_object_attach( p_spu->p_text, p_spu );
556
557             p_spu->p_text->fmt_out.video.i_width =
558                 p_spu->p_text->fmt_out.video.i_visible_width =
559                 p_fmt->i_width;
560             p_spu->p_text->fmt_out.video.i_height =
561                 p_spu->p_text->fmt_out.video.i_visible_height =
562                 p_fmt->i_height;
563
564             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
565             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
566
567             psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
568             if( psz_modulename && *psz_modulename )
569             {
570                 p_spu->p_text->p_module =
571                     module_Need( p_spu->p_text, "text renderer",
572                                  psz_modulename, VLC_TRUE );
573             }
574             if( !p_spu->p_text->p_module )
575             {
576                 p_spu->p_text->p_module =
577                     module_Need( p_spu->p_text, "text renderer", 0, 0 );
578             }
579             if( psz_modulename ) free( psz_modulename );
580         }
581         if( p_spu->p_text )
582         {
583             subpicture_region_t *p_text_region = p_subpic->p_region;
584
585             /* Only overwrite the size fields if the region is still in pre-rendered
586              * TEXT format. We have to traverse the subregion list because if more
587              * than one subregion is present, the text region isn't guarentteed to
588              * be the first in the list, and only text regions use this flag.
589              * All of this effort assists with the rescaling of text that has been
590              * rendered at native resolution, rather than video resolution.
591              */
592             while( p_text_region &&
593                 p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )
594             {
595                 p_text_region = p_text_region->p_next;
596             }
597             if( p_text_region && ((p_text_region->i_align & SUBPICTURE_RENDERED) == 0) )
598             {
599                 p_spu->p_text->fmt_out.video.i_width =
600                     p_spu->p_text->fmt_out.video.i_visible_width =
601                     p_fmt->i_width;
602                 p_spu->p_text->fmt_out.video.i_height =
603                     p_spu->p_text->fmt_out.video.i_visible_height =
604                     p_fmt->i_height;
605             }
606         }
607
608         pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
609         pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
610         pi_scale_width[ SCALE_TEXT ]     = p_fmt->i_width  * 1000 / p_spu->p_text->fmt_out.video.i_width;
611         pi_scale_height[ SCALE_TEXT ]    = p_fmt->i_height * 1000 / p_spu->p_text->fmt_out.video.i_height;
612
613         for( k=0; k< SCALE_SIZE ; k++ )
614         {
615             if( (p_subpic->i_original_picture_height > 0) &&
616                 (p_subpic->i_original_picture_width  > 0) )
617             {
618                 pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_width /
619                                  p_subpic->i_original_picture_width;
620                 pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
621                                  p_subpic->i_original_picture_height;
622             }
623             else if( p_subpic->i_original_picture_height > 0 )
624             {
625                 pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
626                                  p_subpic->i_original_picture_height;
627                 pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_height /
628                                  p_subpic->i_original_picture_height;
629             }
630         }
631
632         /* Set default subpicture aspect ratio */
633         if( p_region && p_region->fmt.i_aspect &&
634             (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
635         {
636             p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
637             p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
638         }
639         if( p_region &&
640             (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
641         {
642             p_region->fmt.i_sar_den = p_fmt->i_sar_den;
643             p_region->fmt.i_sar_num = p_fmt->i_sar_num;
644         }
645
646         /* Take care of the aspect ratio */
647         if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
648             p_region->fmt.i_sar_den * p_fmt->i_sar_num )
649         {
650             for( k=0; k< SCALE_SIZE ; k++ )
651             {
652                 pi_scale_width[ k ] = pi_scale_width[ k ] *
653                     (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
654                     p_region->fmt.i_sar_den / p_fmt->i_sar_num;
655                 pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
656             }
657         }
658
659         /* Load the scaling module */
660         if( !p_spu->p_scale &&
661            ((((pi_scale_width[ SCALE_TEXT ]    > 0)     || (pi_scale_height[ SCALE_TEXT ]    > 0)) &&
662              ((pi_scale_width[ SCALE_TEXT ]    != 1000) || (pi_scale_height[ SCALE_TEXT ]    != 1000))) ||
663             (((pi_scale_width[ SCALE_DEFAULT ] > 0)     || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
664              ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
665         {
666             p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
667             vlc_object_attach( p_spu->p_scale, p_spu );
668             p_spu->p_scale->fmt_out.video.i_chroma =
669                 p_spu->p_scale->fmt_in.video.i_chroma =
670                     VLC_FOURCC('Y','U','V','P');
671             /* XXX: We'll also be using it for YUVA and RGBA blending ... */
672             p_spu->p_scale->fmt_in.video.i_width =
673                 p_spu->p_scale->fmt_in.video.i_height = 32;
674             p_spu->p_scale->fmt_out.video.i_width =
675                 p_spu->p_scale->fmt_out.video.i_height = 16;
676
677             p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
678             p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
679             p_spu->p_scale->p_module =
680                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
681         }
682
683         while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
684         {
685             video_format_t orig_fmt = p_region->fmt;
686             vlc_bool_t b_rerender_text = VLC_FALSE;
687             int i_fade_alpha = 255;
688             int i_x_offset;
689             int i_y_offset;
690             int i_scale_idx   = SCALE_DEFAULT;
691             int i_inv_scale_x = 1000;
692             int i_inv_scale_y = 1000;
693
694             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
695             {
696                 if( p_spu->p_text && p_spu->p_text->p_module )
697                 {
698                     vlc_value_t  val;
699
700                     /* Setup 3 variables which can be used to render
701                      * time-dependent text (and effects). The first indicates
702                      * the total amount of time the text will be on screen,
703                      * the second the amount of time it has already been on
704                      * screen (can be a negative value as text is layed out
705                      * before it is rendered) and the third is a feedback
706                      * variable from the renderer - if the renderer sets it
707                      * then this particular text is time-dependent, eg. the
708                      * visual progress bar inside the text in karaoke and the
709                      * text needs to be rendered multiple times in order for
710                      * the effect to work - we therefore need to return the
711                      * region to its original state at the end of the loop,
712                      * instead of leaving it in YUVA or YUVP.
713                      * Any renderer which is unaware of how to render
714                      * time-dependent text can happily ignore the variables
715                      * and render the text the same as usual - it should at
716                      * least show up on screen, but the effect won't change
717                      * the text over time.
718                      */
719
720                     var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
721                     val.i_time = p_subpic->i_stop - p_subpic->i_start;
722                     var_Set( p_spu->p_text, "spu-duration", val );
723
724                     var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
725                     val.i_time = mdate() - p_subpic->i_start;
726                     var_Set( p_spu->p_text, "spu-elapsed", val );
727
728                     var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
729                     var_SetBool( p_spu->p_text, "text-rerender", VLC_FALSE );
730
731                     var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
732                     var_SetInteger( p_spu->p_text, "scale",
733                               __MIN(i_scale_width_orig, i_scale_height_orig) );
734
735                     if( p_spu->p_text->pf_render_html && p_region->psz_html )
736                     {
737                         p_spu->p_text->pf_render_html( p_spu->p_text,
738                                                        p_region, p_region );
739                     }
740                     else if( p_spu->p_text->pf_render_text )
741                     {
742                         p_spu->p_text->pf_render_text( p_spu->p_text,
743                                                        p_region, p_region );
744                     }
745                     b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );
746
747                     var_Destroy( p_spu->p_text, "spu-duration" );
748                     var_Destroy( p_spu->p_text, "spu-elapsed" );
749                     var_Destroy( p_spu->p_text, "text-rerender" );
750                     var_Destroy( p_spu->p_text, "scale" );
751                 }
752                 p_region->i_align |= SUBPICTURE_RENDERED;
753             }
754             if( p_region->i_align & SUBPICTURE_RENDERED )
755             {
756                 i_scale_idx   = SCALE_TEXT;
757                 i_inv_scale_x = i_scale_width_orig;
758                 i_inv_scale_y = i_scale_height_orig;
759             }
760
761             i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
762             i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;
763
764             /* Force palette if requested */
765             if( p_spu->b_force_palette &&
766                 (VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma) )
767             {
768                 memcpy( p_region->fmt.p_palette->palette,
769                         p_spu->palette, 16 );
770             }
771
772             /* Scale SPU if necessary */
773             if( p_region->p_cache )
774             {
775                 if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
776                     p_region->p_cache->fmt.i_width ||
777                     pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
778                     p_region->p_cache->fmt.i_height )
779                 {
780                     p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
781                                                  p_region->p_cache );
782                     p_region->p_cache = 0;
783                 }
784             }
785
786             if( ((pi_scale_width[ i_scale_idx ] != 1000) || (pi_scale_height[ i_scale_idx ] != 1000)) &&
787                 ((pi_scale_width[ i_scale_idx ] > 0) || (pi_scale_height[ i_scale_idx ] > 0)) &&
788                 p_spu->p_scale && !p_region->p_cache )
789             {
790                 picture_t *p_pic;
791
792                 p_spu->p_scale->fmt_in.video = p_region->fmt;
793                 p_spu->p_scale->fmt_out.video = p_region->fmt;
794
795                 p_region->p_cache =
796                     p_subpic->pf_create_region( VLC_OBJECT(p_spu),
797                         &p_spu->p_scale->fmt_out.video );
798                 if( p_spu->p_scale->fmt_out.video.p_palette )
799                     *p_spu->p_scale->fmt_out.video.p_palette =
800                         *p_region->fmt.p_palette;
801                 p_region->p_cache->p_next = p_region->p_next;
802
803                 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
804                                   &p_region->picture );
805
806                 p_spu->p_scale->fmt_out.video.i_width =
807                     p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
808                 p_spu->p_scale->fmt_out.video.i_visible_width =
809                     p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
810                 p_spu->p_scale->fmt_out.video.i_height =
811                     p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
812                 p_spu->p_scale->fmt_out.video.i_visible_height =
813                     p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
814                 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
815                 p_region->p_cache->i_x = p_region->i_x * pi_scale_width[ i_scale_idx ] / 1000;
816                 p_region->p_cache->i_y = p_region->i_y * pi_scale_height[ i_scale_idx ] / 1000;
817                 p_region->p_cache->i_align = p_region->i_align;
818
819                 p_pic = p_spu->p_scale->pf_video_filter(
820                                  p_spu->p_scale, &p_region->p_cache->picture );
821                 if( p_pic )
822                 {
823                     picture_t p_pic_tmp = p_region->p_cache->picture;
824                     p_region->p_cache->picture = *p_pic;
825                     *p_pic = p_pic_tmp;
826                     free( p_pic );
827                 }
828             }
829             if( ((pi_scale_width[ i_scale_idx ] != 1000) || (pi_scale_height[ i_scale_idx ] != 1000)) &&
830                 ((pi_scale_width[ i_scale_idx ] > 0) || (pi_scale_height[ i_scale_idx ] > 0)) &&
831                 p_spu->p_scale && p_region->p_cache )
832             {
833                 p_region = p_region->p_cache;
834             }
835
836             if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
837             {
838                 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
839                     (p_subpic->i_y + p_region->i_y) * i_inv_scale_y / 1000;
840             }
841             else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
842             {
843                 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
844             }
845
846             if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
847             {
848                 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
849                     (pi_subpic_x[ i_scale_idx ] + p_region->i_x)
850                     * i_inv_scale_x / 1000;
851             }
852             else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
853             {
854                 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
855             }
856
857             if( p_subpic->b_absolute )
858             {
859                 i_x_offset = (p_region->i_x +
860                     pi_subpic_x[ i_scale_idx ] *
861                                      pi_scale_width[ i_scale_idx ] / 1000)
862                     * i_inv_scale_x / 1000;
863                 i_y_offset = (p_region->i_y +
864                     p_subpic->i_y * pi_scale_height[ i_scale_idx ] / 1000)
865                     * i_inv_scale_y / 1000;
866
867             }
868
869             i_x_offset = __MAX( i_x_offset, 0 );
870             i_y_offset = __MAX( i_y_offset, 0 );
871
872             if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
873             {
874                 int i_diff = 0;
875                 int i_low = (i_y_offset - p_spu->i_margin) * i_inv_scale_y / 1000;
876                 int i_high = i_low + p_region->fmt.i_height;
877
878                 /* crop extra margin to keep within bounds */
879                 if( i_low < 0 )
880                     i_diff = i_low;
881                 if( i_high > (int)p_fmt->i_height )
882                     i_diff = i_high - p_fmt->i_height;
883                 i_y_offset -= ( p_spu->i_margin * i_inv_scale_y / 1000 + i_diff );
884             }
885
886             p_spu->p_blend->fmt_in.video = p_region->fmt;
887
888             /* Force cropping if requested */
889             if( p_spu->b_force_crop )
890             {
891                 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
892                 int i_crop_x = p_spu->i_crop_x * pi_scale_width[ i_scale_idx ] / 1000
893                                     * i_inv_scale_x / 1000;
894                 int i_crop_y = p_spu->i_crop_y * pi_scale_height[ i_scale_idx ] / 1000
895                                     * i_inv_scale_y / 1000;
896                 int i_crop_width = p_spu->i_crop_width * pi_scale_width[ i_scale_idx ] / 1000
897                                     * i_inv_scale_x / 1000;
898                 int i_crop_height = p_spu->i_crop_height * pi_scale_height[ i_scale_idx ] / 1000
899                                     * i_inv_scale_y / 1000;
900
901                 /* Find the intersection */
902                 if( i_crop_x + i_crop_width <= i_x_offset ||
903                     i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
904                     i_crop_y + i_crop_height <= i_y_offset ||
905                     i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
906                 {
907                     /* No intersection */
908                     p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
909                 }
910                 else
911                 {
912                     int i_x, i_y, i_x_end, i_y_end;
913                     i_x = __MAX( i_crop_x, i_x_offset );
914                     i_y = __MAX( i_crop_y, i_y_offset );
915                     i_x_end = __MIN( i_crop_x + i_crop_width,
916                                    i_x_offset + (int)p_fmt->i_visible_width );
917                     i_y_end = __MIN( i_crop_y + i_crop_height,
918                                    i_y_offset + (int)p_fmt->i_visible_height );
919
920                     p_fmt->i_x_offset = i_x - i_x_offset;
921                     p_fmt->i_y_offset = i_y - i_y_offset;
922                     p_fmt->i_visible_width = i_x_end - i_x;
923                     p_fmt->i_visible_height = i_y_end - i_y;
924
925                     i_x_offset = i_x;
926                     i_y_offset = i_y;
927                 }
928             }
929
930             /* Update the output picture size */
931             p_spu->p_blend->fmt_out.video.i_width =
932                 p_spu->p_blend->fmt_out.video.i_visible_width =
933                     p_fmt->i_width;
934             p_spu->p_blend->fmt_out.video.i_height =
935                 p_spu->p_blend->fmt_out.video.i_visible_height =
936                     p_fmt->i_height;
937
938             if( p_subpic->b_fade )
939             {
940                 mtime_t i_fade_start = ( p_subpic->i_stop +
941                                          p_subpic->i_start ) / 2;
942                 mtime_t i_now = mdate();
943                 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
944                 {
945                     i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
946                                    ( p_subpic->i_stop - i_fade_start );
947                 }
948             }
949
950             i_x_offset = __MAX( i_x_offset, 0 );
951             i_y_offset = __MAX( i_y_offset, 0 );
952
953             p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
954                 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
955                 i_fade_alpha * p_subpic->i_alpha / 255 );
956
957             if( b_rerender_text )
958             {
959                 /* Some forms of subtitles need to be re-rendered more than
960                  * once, eg. karaoke. We therefore restore the region to its
961                  * pre-rendered state, so the next time through everything is
962                  * calculated again.
963                  */
964                 p_region->picture.pf_release( &p_region->picture );
965                 memset( &p_region->picture, 0, sizeof( picture_t ) );
966                 p_region->fmt = orig_fmt;
967                 p_region->i_align &= ~SUBPICTURE_RENDERED;
968             }
969             p_region = p_region->p_next;
970         }
971
972         p_subpic = p_subpic->p_next;
973     }
974
975     vlc_mutex_unlock( &p_spu->subpicture_lock );
976 }
977
978 /*****************************************************************************
979  * spu_SortSubpictures: find the subpictures to display
980  *****************************************************************************
981  * This function parses all subpictures and decides which ones need to be
982  * displayed. This operation does not need lock, since only READY_SUBPICTURE
983  * are handled. If no picture has been selected, display_date will depend on
984  * the subpicture.
985  * We also check for ephemer DVD subpictures (subpictures that have
986  * to be removed if a newer one is available), which makes it a lot
987  * more difficult to guess if a subpicture has to be rendered or not.
988  *****************************************************************************/
989 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
990                                    vlc_bool_t b_paused )
991 {
992     int i_index, i_channel;
993     subpicture_t *p_subpic = NULL;
994     subpicture_t *p_ephemer;
995     mtime_t      ephemer_date;
996
997     /* Run subpicture filters */
998     for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
999     {
1000         subpicture_t *p_subpic_filter;
1001         p_subpic_filter = p_spu->pp_filter[i_index]->
1002             pf_sub_filter( p_spu->pp_filter[i_index], display_date );
1003         if( p_subpic_filter )
1004         {
1005             spu_DisplaySubpicture( p_spu, p_subpic_filter );
1006         }
1007     }
1008
1009     /* We get an easily parsable chained list of subpictures which
1010      * ends with NULL since p_subpic was initialized to NULL. */
1011     for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
1012     {
1013         p_ephemer = 0;
1014         ephemer_date = 0;
1015
1016         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1017         {
1018             if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
1019                 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
1020             {
1021                 continue;
1022             }
1023             if( display_date &&
1024                 display_date < p_spu->p_subpicture[i_index].i_start )
1025             {
1026                 /* Too early, come back next monday */
1027                 continue;
1028             }
1029
1030             if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
1031                 ephemer_date = p_spu->p_subpicture[i_index].i_start;
1032
1033             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
1034                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
1035                   p_spu->p_subpicture[i_index].i_stop >
1036                   p_spu->p_subpicture[i_index].i_start ) &&
1037                 !( p_spu->p_subpicture[i_index].b_pausable &&
1038                    b_paused ) )
1039             {
1040                 /* Too late, destroy the subpic */
1041                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
1042                 continue;
1043             }
1044
1045             /* If this is an ephemer subpic, add it to our list */
1046             if( p_spu->p_subpicture[i_index].b_ephemer )
1047             {
1048                 p_spu->p_subpicture[i_index].p_next = p_ephemer;
1049                 p_ephemer = &p_spu->p_subpicture[i_index];
1050
1051                 continue;
1052             }
1053
1054             p_spu->p_subpicture[i_index].p_next = p_subpic;
1055             p_subpic = &p_spu->p_subpicture[i_index];
1056         }
1057
1058         /* If we found ephemer subpictures, check if they have to be
1059          * displayed or destroyed */
1060         while( p_ephemer != NULL )
1061         {
1062             subpicture_t *p_tmp = p_ephemer;
1063             p_ephemer = p_ephemer->p_next;
1064
1065             if( p_tmp->i_start < ephemer_date )
1066             {
1067                 /* Ephemer subpicture has lived too long */
1068                 spu_DestroySubpicture( p_spu, p_tmp );
1069             }
1070             else
1071             {
1072                 /* Ephemer subpicture can still live a bit */
1073                 p_tmp->p_next = p_subpic;
1074                 p_subpic = p_tmp;
1075             }
1076         }
1077     }
1078
1079     return p_subpic;
1080 }
1081
1082 /*****************************************************************************
1083  * SpuClearChannel: clear an spu channel
1084  *****************************************************************************
1085  * This function destroys the subpictures which belong to the spu channel
1086  * corresponding to i_channel_id.
1087  *****************************************************************************/
1088 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1089 {
1090     int          i_subpic;                               /* subpicture index */
1091     subpicture_t *p_subpic = NULL;                  /* first free subpicture */
1092
1093     vlc_mutex_lock( &p_spu->subpicture_lock );
1094
1095     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1096     {
1097         p_subpic = &p_spu->p_subpicture[i_subpic];
1098         if( p_subpic->i_status == FREE_SUBPICTURE
1099             || ( p_subpic->i_status != RESERVED_SUBPICTURE
1100                  && p_subpic->i_status != READY_SUBPICTURE ) )
1101         {
1102             continue;
1103         }
1104
1105         if( p_subpic->i_channel == i_channel )
1106         {
1107             while( p_subpic->p_region )
1108             {
1109                 subpicture_region_t *p_region = p_subpic->p_region;
1110                 p_subpic->p_region = p_region->p_next;
1111                 spu_DestroyRegion( p_spu, p_region );
1112             }
1113
1114             if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
1115             p_subpic->i_status = FREE_SUBPICTURE;
1116         }
1117     }
1118
1119     vlc_mutex_unlock( &p_spu->subpicture_lock );
1120 }
1121
1122 /*****************************************************************************
1123  * spu_ControlDefault: default methods for the subpicture unit control.
1124  *****************************************************************************/
1125 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
1126 {
1127     int *pi, i;
1128
1129     switch( i_query )
1130     {
1131     case SPU_CHANNEL_REGISTER:
1132         pi = (int *)va_arg( args, int * );
1133         if( pi ) *pi = p_spu->i_channel++;
1134         break;
1135
1136     case SPU_CHANNEL_CLEAR:
1137         i = (int)va_arg( args, int );
1138         SpuClearChannel( p_spu, i );
1139         break;
1140
1141     default:
1142         msg_Dbg( p_spu, "control query not supported" );
1143         return VLC_EGENERIC;
1144     }
1145
1146     return VLC_SUCCESS;
1147 }
1148
1149 /*****************************************************************************
1150  * Object variables callbacks
1151  *****************************************************************************/
1152
1153 /*****************************************************************************
1154  * UpdateSPU: update subpicture settings
1155  *****************************************************************************
1156  * This function is called from CropCallback and at initialization time, to
1157  * retrieve crop information from the input.
1158  *****************************************************************************/
1159 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1160 {
1161     vlc_value_t val;
1162
1163     p_spu->b_force_palette = VLC_FALSE;
1164     p_spu->b_force_crop = VLC_FALSE;
1165
1166     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1167
1168     p_spu->b_force_crop = VLC_TRUE;
1169     var_Get( p_object, "x-start", &val );
1170     p_spu->i_crop_x = val.i_int;
1171     var_Get( p_object, "y-start", &val );
1172     p_spu->i_crop_y = val.i_int;
1173     var_Get( p_object, "x-end", &val );
1174     p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1175     var_Get( p_object, "y-end", &val );
1176     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1177
1178     if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1179     {
1180         memcpy( p_spu->palette, val.p_address, 16 );
1181         p_spu->b_force_palette = VLC_TRUE;
1182     }
1183
1184     msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1185              p_spu->i_crop_x, p_spu->i_crop_y,
1186              p_spu->i_crop_width, p_spu->i_crop_height,
1187              p_spu->b_force_palette );
1188 }
1189
1190 /*****************************************************************************
1191  * CropCallback: called when the highlight properties are changed
1192  *****************************************************************************
1193  * This callback is called from the input thread when we need cropping
1194  *****************************************************************************/
1195 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1196                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1197 {
1198     (void)psz_var; (void)oldval; (void)newval;
1199     UpdateSPU( (spu_t *)p_data, p_object );
1200     return VLC_SUCCESS;
1201 }
1202
1203 /*****************************************************************************
1204  * Buffers allocation callbacks for the filters
1205  *****************************************************************************/
1206 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1207 {
1208     filter_owner_sys_t *p_sys = p_filter->p_owner;
1209     subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1210     if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1211     return p_subpicture;
1212 }
1213
1214 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1215 {
1216     filter_owner_sys_t *p_sys = p_filter->p_owner;
1217     spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1218 }
1219
1220 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1221 {
1222     subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1223     (void)p_filter;
1224     memset( p_subpic, 0, sizeof(subpicture_t) );
1225     p_subpic->b_absolute = VLC_TRUE;
1226
1227     p_subpic->pf_create_region = __spu_CreateRegion;
1228     p_subpic->pf_make_region = __spu_MakeRegion;
1229     p_subpic->pf_destroy_region = __spu_DestroyRegion;
1230
1231     return p_subpic;
1232 }
1233
1234 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1235 {
1236     while( p_subpic->p_region )
1237     {
1238         subpicture_region_t *p_region = p_subpic->p_region;
1239         p_subpic->p_region = p_region->p_next;
1240         p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1241     }
1242
1243     free( p_subpic );
1244 }
1245
1246 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1247 {
1248     picture_t *p_picture = malloc( sizeof(picture_t) );
1249
1250     if( vout_AllocatePicture( p_filter, p_picture,
1251                               p_filter->fmt_out.video.i_chroma,
1252                               p_filter->fmt_out.video.i_width,
1253                               p_filter->fmt_out.video.i_height,
1254                               p_filter->fmt_out.video.i_aspect )
1255         != VLC_SUCCESS )
1256     {
1257         free( p_picture );
1258         return NULL;
1259     }
1260
1261     p_picture->pf_release = RegionPictureRelease;
1262
1263     return p_picture;
1264 }
1265
1266 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1267 {
1268     (void)p_filter;
1269     if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1270     if( p_pic ) free( p_pic );
1271 }
1272
1273 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1274                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1275 {
1276     (void)p_object; (void)oldval; (void)newval;
1277
1278     if( !strcmp( psz_var, "sub-filter" ) )
1279     {
1280         spu_t *p_spu = (spu_t *)p_data;
1281         vlc_mutex_lock( &p_spu->subpicture_lock );
1282         spu_DeleteChain( p_spu );
1283         spu_ParseChain( p_spu );
1284         vlc_mutex_unlock( &p_spu->subpicture_lock );
1285     }
1286     return VLC_SUCCESS;
1287 }