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