d844ef1cc6a154321ad7405fc4a9e7c781e8caa4
[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 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_vout.h>
35 #include <vlc_block.h>
36 #include <vlc_filter.h>
37 #include <vlc_osd.h>
38 #include "../libvlc.h"
39 #include "vout_internal.h"
40 #include <vlc_image.h>
41
42 #include <assert.h>
43 #include <limits.h>
44
45 /*****************************************************************************
46  * Local prototypes
47  *****************************************************************************/
48
49 /* Number of simultaneous subpictures */
50 #define VOUT_MAX_SUBPICTURES (__MAX(VOUT_MAX_PICTURES, SPU_MAX_PREPARE_TIME/5000))
51
52 /* */
53 typedef struct
54 {
55     subpicture_t *p_subpicture;
56     bool          b_reject;
57 } spu_heap_entry_t;
58
59 typedef struct
60 {
61     spu_heap_entry_t p_entry[VOUT_MAX_SUBPICTURES];
62
63 } spu_heap_t;
64
65 static void SpuHeapInit( spu_heap_t * );
66 static int  SpuHeapPush( spu_heap_t *, subpicture_t * );
67 static void SpuHeapDeleteAt( spu_heap_t *, int i_index );
68 static int  SpuHeapDeleteSubpicture( spu_heap_t *, subpicture_t * );
69 static void SpuHeapClean( spu_heap_t *p_heap );
70
71 struct spu_private_t
72 {
73     vlc_mutex_t lock;   /* lock to protect all followings fields */
74
75     spu_heap_t heap;
76
77     int i_channel;             /**< number of subpicture channels registered */
78     filter_t *p_blend;                            /**< alpha blending module */
79     filter_t *p_text;                              /**< text renderer module */
80     filter_t *p_scale_yuvp;                     /**< scaling module for YUVP */
81     filter_t *p_scale;                    /**< scaling module (all but YUVP) */
82     bool b_force_crop;                     /**< force cropping of subpicture */
83     int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */
84
85     int i_margin;                        /**< force position of a subpicture */
86     bool b_force_palette;             /**< force palette of subpicture */
87     uint8_t palette[4][4];                               /**< forced palette */
88
89     /* Subpiture filters */
90     char           *psz_chain_update;
91     filter_chain_t *p_chain;
92
93     /* */
94     mtime_t i_last_sort_date;
95 };
96
97 /* */
98 struct subpicture_region_private_t
99 {
100     video_format_t fmt;
101     picture_t      *p_picture;
102 };
103 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t * );
104 static void SpuRegionPrivateDelete( subpicture_region_private_t * );
105
106 /* */
107 typedef struct
108 {
109     int w;
110     int h;
111 } spu_scale_t;
112 static spu_scale_t spu_scale_create( int w, int h );
113 static spu_scale_t spu_scale_unit(void );
114 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd );
115 static int spu_scale_w( int v, const spu_scale_t s );
116 static int spu_scale_h( int v, const spu_scale_t s );
117 static int spu_invscale_w( int v, const spu_scale_t s );
118 static int spu_invscale_h( int v, const spu_scale_t s );
119
120 typedef struct
121 {
122     int i_x;
123     int i_y;
124     int i_width;
125     int i_height;
126
127     spu_scale_t scale;
128 } spu_area_t;
129
130 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t );
131 static spu_area_t spu_area_scaled( spu_area_t );
132 static spu_area_t spu_area_unscaled( spu_area_t, spu_scale_t );
133 static bool spu_area_overlap( spu_area_t, spu_area_t );
134
135
136 /* Subpicture rendered flag
137  * FIXME ? it could be moved to private ? */
138 #define SUBPICTURE_RENDERED  (0x1000)
139 #if SUBPICTURE_RENDERED < SUBPICTURE_ALIGN_MASK
140 #   error SUBPICTURE_RENDERED too low
141 #endif
142
143 #define SCALE_UNIT (1000)
144
145 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
146 static int SubpictureCmp( const void *s0, const void *s1 );
147
148 static void SpuRenderRegion( spu_t *,
149                              picture_t *p_pic_dst, spu_area_t *,
150                              subpicture_t *, subpicture_region_t *,
151                              const spu_scale_t scale_size,
152                              const video_format_t *p_fmt,
153                              const spu_area_t *p_subtitle_area, int i_subtitle_area,
154                              mtime_t render_date );
155
156 static void UpdateSPU   ( spu_t *, vlc_object_t * );
157 static int  CropCallback( vlc_object_t *, char const *,
158                           vlc_value_t, vlc_value_t, void * );
159
160 static int SpuControl( spu_t *, int, va_list );
161
162 static void SpuClearChannel( spu_t *p_spu, int i_channel );
163
164 /* Buffer allocation for SPU filter (blend, scale, ...) */
165 static subpicture_t *spu_new_buffer( filter_t * );
166 static void spu_del_buffer( filter_t *, subpicture_t * );
167 static picture_t *spu_new_video_buffer( filter_t * );
168 static void spu_del_video_buffer( filter_t *, picture_t * );
169
170 /* Buffer aloccation fir SUB filter */
171 static int SubFilterCallback( vlc_object_t *, char const *,
172                               vlc_value_t, vlc_value_t, void * );
173
174 static int SubFilterAllocationInit( filter_t *, void * );
175 static void SubFilterAllocationClean( filter_t * );
176
177 /* */
178 static void SpuRenderCreateAndLoadText( spu_t * );
179 static void SpuRenderCreateAndLoadScale( spu_t * );
180 static void FilterRelease( filter_t *p_filter );
181
182 /*****************************************************************************
183  * Public API
184  *****************************************************************************/
185 /**
186  * Creates the subpicture unit
187  *
188  * \param p_this the parent object which creates the subpicture unit
189  */
190 spu_t *__spu_Create( vlc_object_t *p_this )
191 {
192     spu_t *p_spu;
193     spu_private_t *p_sys;
194  
195     p_spu = vlc_custom_create( p_this, sizeof(spu_t) + sizeof(spu_private_t),
196                                VLC_OBJECT_GENERIC, "subpicture" );
197
198     if( !p_spu )
199         return NULL;
200
201     /* Initialize spu fields */
202     p_spu->pf_control = SpuControl;
203     p_spu->p = p_sys = (spu_private_t*)&p_spu[1];
204
205     /* Initialize private fields */
206     vlc_mutex_init( &p_sys->lock );
207
208     SpuHeapInit( &p_sys->heap );
209
210     p_sys->p_blend = NULL;
211     p_sys->p_text = NULL;
212     p_sys->p_scale = NULL;
213     p_sys->p_scale_yuvp = NULL;
214
215     /* Register the default subpicture channel */
216     p_sys->i_channel = 2;
217
218     vlc_object_attach( p_spu, p_this );
219
220     p_sys->psz_chain_update = NULL;
221     p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
222                                        SubFilterAllocationInit,
223                                        SubFilterAllocationClean,
224                                        p_spu );
225
226     /* Load text and scale module */
227     SpuRenderCreateAndLoadText( p_spu );
228     SpuRenderCreateAndLoadScale( p_spu );
229
230     /* */
231     p_sys->i_last_sort_date = -1;
232
233     return p_spu;
234 }
235
236 /**
237  * Initialise the subpicture unit
238  *
239  * \param p_spu the subpicture unit object
240  */
241 int spu_Init( spu_t *p_spu )
242 {
243     spu_private_t *p_sys = p_spu->p;
244
245     /* If the user requested a sub margin, we force the position. */
246     p_sys->i_margin = var_CreateGetInteger( p_spu, "sub-margin" );
247
248     var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
249     var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
250     var_TriggerCallback( p_spu, "sub-filter" );
251
252     return VLC_SUCCESS;
253 }
254
255 /**
256  * Destroy the subpicture unit
257  *
258  * \param p_this the parent object which destroys the subpicture unit
259  */
260 void spu_Destroy( spu_t *p_spu )
261 {
262     spu_private_t *p_sys = p_spu->p;
263
264     var_DelCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
265
266     if( p_sys->p_blend )
267         filter_DeleteBlend( p_sys->p_blend );
268
269     if( p_sys->p_text )
270         FilterRelease( p_sys->p_text );
271
272     if( p_sys->p_scale_yuvp )
273         FilterRelease( p_sys->p_scale_yuvp );
274
275     if( p_sys->p_scale )
276         FilterRelease( p_sys->p_scale );
277
278     filter_chain_Delete( p_sys->p_chain );
279     free( p_sys->psz_chain_update );
280
281     /* Destroy all remaining subpictures */
282     SpuHeapClean( &p_sys->heap );
283
284     vlc_mutex_destroy( &p_sys->lock );
285
286     vlc_object_release( p_spu );
287 }
288
289 /**
290  * Attach/Detach the SPU from any input
291  *
292  * \param p_this the object in which to destroy the subpicture unit
293  * \param b_attach to select attach or detach
294  */
295 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
296 {
297     vlc_object_t *p_input;
298
299     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
300     if( !p_input )
301         return;
302
303     if( b_attach )
304     {
305         UpdateSPU( p_spu, VLC_OBJECT(p_input) );
306         var_AddCallback( p_input, "highlight", CropCallback, p_spu );
307         vlc_object_release( p_input );
308     }
309     else
310     {
311         /* Delete callback */
312         var_DelCallback( p_input, "highlight", CropCallback, p_spu );
313         vlc_object_release( p_input );
314     }
315 }
316
317 /**
318  * Display a subpicture
319  *
320  * Remove the reservation flag of a subpicture, which will cause it to be
321  * ready for display.
322  * \param p_spu the subpicture unit object
323  * \param p_subpic the subpicture to display
324  */
325 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
326 {
327     spu_private_t *p_sys = p_spu->p;
328
329     /* DEFAULT_CHAN always reset itself */
330     if( p_subpic->i_channel == DEFAULT_CHAN )
331         SpuClearChannel( p_spu, DEFAULT_CHAN );
332
333     /* p_private is for spu only and cannot be non NULL here */
334     for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
335         assert( r->p_private == NULL );
336
337     /* */
338     vlc_mutex_lock( &p_sys->lock );
339     if( SpuHeapPush( &p_sys->heap, p_subpic ) )
340     {
341         vlc_mutex_unlock( &p_sys->lock );
342         msg_Err( p_spu, "subpicture heap full" );
343         subpicture_Delete( p_subpic );
344         return;
345     }
346     vlc_mutex_unlock( &p_sys->lock );
347 }
348
349 /**
350  * This function renders all sub picture units in the list.
351  */
352 void spu_RenderSubpictures( spu_t *p_spu,
353                             picture_t *p_pic_dst, const video_format_t *p_fmt_dst,
354                             subpicture_t *p_subpic_list,
355                             const video_format_t *p_fmt_src,
356                             mtime_t render_date )
357 {
358     spu_private_t *p_sys = p_spu->p;
359
360     const mtime_t system_date = mdate();
361
362     const int i_source_video_width  = p_fmt_src->i_width;
363     const int i_source_video_height = p_fmt_src->i_height;
364
365     unsigned int i_subpicture;
366     subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
367
368     unsigned int i_subtitle_region_count;
369     spu_area_t p_subtitle_area_buffer[VOUT_MAX_SUBPICTURES];
370     spu_area_t *p_subtitle_area;
371     int i_subtitle_area;
372
373     vlc_mutex_lock( &p_sys->lock );
374
375     /* Preprocess subpictures */
376     i_subpicture = 0;
377     i_subtitle_region_count = 0;
378     for( subpicture_t * p_subpic = p_subpic_list;
379             p_subpic != NULL;
380                 p_subpic = p_subpic->p_next )
381     {
382         /* TODO remove pre-render */
383         if( p_subpic->pf_pre_render )
384             p_subpic->pf_pre_render( p_spu, p_subpic, p_fmt_dst );
385
386         if( p_subpic->pf_update_regions )
387         {
388             video_format_t fmt_org = *p_fmt_dst;
389             fmt_org.i_width =
390             fmt_org.i_visible_width = i_source_video_width;
391             fmt_org.i_height =
392             fmt_org.i_visible_height = i_source_video_height;
393
394             p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org,
395                                          p_subpic->b_subtitle ? render_date : system_date );
396         }
397
398         /* */
399         if( p_subpic->b_subtitle )
400         {
401             for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
402                 i_subtitle_region_count++;
403         }
404
405         /* */
406         pp_subpicture[i_subpicture++] = p_subpic;
407     }
408
409     /* Be sure we have at least 1 picture to process */
410     if( i_subpicture <= 0 )
411     {
412         vlc_mutex_unlock( &p_sys->lock );
413         return;
414     }
415
416     /* Now order subpicture array
417      * XXX The order is *really* important for overlap subtitles positionning */
418     qsort( pp_subpicture, i_subpicture, sizeof(*pp_subpicture), SubpictureCmp );
419
420     /* Allocate area array for subtitle overlap */
421     i_subtitle_area = 0;
422     p_subtitle_area = p_subtitle_area_buffer;
423     if( i_subtitle_region_count > sizeof(p_subtitle_area_buffer)/sizeof(*p_subtitle_area_buffer) )
424         p_subtitle_area = calloc( i_subtitle_region_count, sizeof(*p_subtitle_area) );
425
426     /* Create the blending module */
427     if( !p_sys->p_blend )
428         p_spu->p->p_blend = filter_NewBlend( VLC_OBJECT(p_spu), p_fmt_dst->i_chroma );
429
430     /* Process all subpictures and regions (in the right order) */
431     for( unsigned int i_index = 0; i_index < i_subpicture; i_index++ )
432     {
433         subpicture_t *p_subpic = pp_subpicture[i_index];
434         subpicture_region_t *p_region;
435
436         if( !p_subpic->p_region )
437             continue;
438
439         /* FIXME when possible use a better rendering size than source size
440          * (max of display size and source size for example) FIXME */
441         int i_render_width  = p_subpic->i_original_picture_width;
442         int i_render_height = p_subpic->i_original_picture_height;
443         if( !i_render_width || !i_render_height )
444         {
445             if( i_render_width != 0 || i_render_height != 0 )
446                 msg_Err( p_spu, "unsupported original picture size %dx%d",
447                          i_render_width, i_render_height );
448
449             p_subpic->i_original_picture_width  = i_render_width = i_source_video_width;
450             p_subpic->i_original_picture_height = i_render_height = i_source_video_height;
451         }
452
453         if( p_sys->p_text )
454         {
455             p_sys->p_text->fmt_out.video.i_width          =
456             p_sys->p_text->fmt_out.video.i_visible_width  = i_render_width;
457
458             p_sys->p_text->fmt_out.video.i_height         =
459             p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
460         }
461
462         /* Compute scaling from picture to source size */
463         spu_scale_t scale = spu_scale_createq( i_source_video_width,  i_render_width,
464                                                i_source_video_height, i_render_height );
465
466         /* Update scaling from source size to display size(p_fmt_dst) */
467         scale.w = scale.w * p_fmt_dst->i_width  / i_source_video_width;
468         scale.h = scale.h * p_fmt_dst->i_height / i_source_video_height;
469
470         /* Set default subpicture aspect ratio
471          * FIXME if we only handle 1 aspect ratio per picture, why is it set per
472          * region ? */
473         p_region = p_subpic->p_region;
474         if( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den )
475         {
476             if( p_region->fmt.i_aspect != 0 )
477             {
478                 p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
479                 p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
480             }
481             else
482             {
483                 p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
484                 p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
485             }
486         }
487
488         /* Take care of the aspect ratio */
489         if( p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den !=
490             p_region->fmt.i_sar_den * p_fmt_dst->i_sar_num )
491         {
492             /* FIXME FIXME what about region->i_x/i_y ? */
493             scale.w = scale.w *
494                 (int64_t)p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den /
495                 p_region->fmt.i_sar_den / p_fmt_dst->i_sar_num;
496         }
497
498         /* Render all regions
499          * We always transform non absolute subtitle into absolute one on the
500          * first rendering to allow good subtitle overlap support.
501          */
502         for( p_region = p_subpic->p_region; p_region != NULL; p_region = p_region->p_next )
503         {
504             spu_area_t area;
505
506             /* Check scale validity */
507             if( scale.w <= 0 || scale.h <= 0 )
508                 continue;
509
510             /* */
511             SpuRenderRegion( p_spu, p_pic_dst, &area,
512                              p_subpic, p_region, scale, p_fmt_dst,
513                              p_subtitle_area, i_subtitle_area,
514                              p_subpic->b_subtitle ? render_date : system_date );
515
516             if( p_subpic->b_subtitle )
517             {
518                 area = spu_area_unscaled( area, scale );
519                 if( !p_subpic->b_absolute && area.i_width > 0 && area.i_height > 0 )
520                 {
521                     p_region->i_x = area.i_x;
522                     p_region->i_y = area.i_y;
523                 }
524                 if( p_subtitle_area )
525                     p_subtitle_area[i_subtitle_area++] = area;
526             }
527         }
528         if( p_subpic->b_subtitle )
529             p_subpic->b_absolute = true;
530     }
531
532     /* */
533     if( p_subtitle_area != p_subtitle_area_buffer )
534         free( p_subtitle_area );
535
536     vlc_mutex_unlock( &p_sys->lock );
537 }
538
539 /*****************************************************************************
540  * spu_SortSubpictures: find the subpictures to display
541  *****************************************************************************
542  * This function parses all subpictures and decides which ones need to be
543  * displayed. If no picture has been selected, display_date will depend on
544  * the subpicture.
545  * We also check for ephemer DVD subpictures (subpictures that have
546  * to be removed if a newer one is available), which makes it a lot
547  * more difficult to guess if a subpicture has to be rendered or not.
548  *****************************************************************************/
549 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
550                                    bool b_subtitle_only )
551 {
552     spu_private_t *p_sys = p_spu->p;
553     int i_channel;
554     subpicture_t *p_subpic = NULL;
555     const mtime_t system_date = mdate();
556
557     /* Update sub-filter chain */
558     vlc_mutex_lock( &p_sys->lock );
559     char *psz_chain_update = p_sys->psz_chain_update;
560     p_sys->psz_chain_update = NULL;
561     vlc_mutex_unlock( &p_sys->lock );
562
563     if( psz_chain_update )
564     {
565         filter_chain_Reset( p_sys->p_chain, NULL, NULL );
566
567         filter_chain_AppendFromString( p_spu->p->p_chain, psz_chain_update );
568
569         free( psz_chain_update );
570     }
571
572     /* Run subpicture filters */
573     filter_chain_SubFilter( p_sys->p_chain, render_date );
574
575     vlc_mutex_lock( &p_sys->lock );
576
577     /* We get an easily parsable chained list of subpictures which
578      * ends with NULL since p_subpic was initialized to NULL. */
579     for( i_channel = 0; i_channel < p_sys->i_channel; i_channel++ )
580     {
581         subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
582         bool         pb_available_late[VOUT_MAX_SUBPICTURES];
583         int          i_available = 0;
584
585         mtime_t      start_date = render_date;
586         mtime_t      ephemer_subtitle_date = 0;
587         mtime_t      ephemer_system_date = 0;
588         int i_index;
589
590         /* Select available pictures */
591         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
592         {
593             spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
594             subpicture_t *p_current = p_entry->p_subpicture;
595             bool b_stop_valid;
596             bool b_late;
597
598             if( !p_current || p_entry->b_reject )
599             {
600                 if( p_entry->b_reject )
601                     SpuHeapDeleteAt( &p_sys->heap, i_index );
602                 continue;
603             }
604
605             if( p_current->i_channel != i_channel ||
606                 ( b_subtitle_only && !p_current->b_subtitle ) )
607             {
608                 continue;
609             }
610             if( render_date &&
611                 render_date < p_current->i_start )
612             {
613                 /* Too early, come back next monday */
614                 continue;
615             }
616
617             mtime_t *pi_ephemer_date = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_system_date;
618             if( p_current->i_start > *pi_ephemer_date )
619                 *pi_ephemer_date = p_current->i_start;
620
621             b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
622
623             b_late = b_stop_valid && p_current->i_stop <= p_current->b_subtitle ? render_date : system_date;
624
625             /* start_date will be used for correct automatic overlap support
626              * in case picture that should not be displayed anymore (display_time)
627              * overlap with a picture to be displayed (p_current->i_start)  */
628             if( p_current->b_subtitle && !b_late && !p_current->b_ephemer )
629                 start_date = p_current->i_start;
630
631             /* */
632             p_available_subpic[i_available] = p_current;
633             pb_available_late[i_available] = b_late;
634             i_available++;
635         }
636
637         /* Only forced old picture display at the transition */
638         if( start_date < p_sys->i_last_sort_date )
639             start_date = p_sys->i_last_sort_date;
640         if( start_date <= 0 )
641             start_date = INT64_MAX;
642
643         /* Select pictures to be displayed */
644         for( i_index = 0; i_index < i_available; i_index++ )
645         {
646             subpicture_t *p_current = p_available_subpic[i_index];
647             bool b_late = pb_available_late[i_index];
648
649             const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : system_date;
650             const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_system_date;
651
652             if( ( b_late && p_current->i_stop <= stop_date ) ||
653                 ( p_current->b_ephemer && p_current->i_start < ephemer_date ) )
654             {
655                 /* Destroy late and obsolete ephemer subpictures */
656                 SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
657             }
658             else
659             {
660                 SubpictureChain( &p_subpic, p_current );
661             }
662         }
663     }
664
665     p_sys->i_last_sort_date = render_date;
666     vlc_mutex_unlock( &p_sys->lock );
667
668     return p_subpic;
669 }
670
671 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration )
672 {
673     spu_private_t *p_sys = p_spu->p;
674
675     vlc_mutex_lock( &p_sys->lock );
676     for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
677     {
678         spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i];
679         subpicture_t *p_current = p_entry->p_subpicture;
680
681         if( p_current && p_current->b_subtitle )
682         {
683             if( p_current->i_start > 0 )
684                 p_current->i_start += i_duration;
685             if( p_current->i_stop > 0 )
686                 p_current->i_stop += i_duration;
687         }
688     }
689     vlc_mutex_unlock( &p_sys->lock );
690 }
691
692 /*****************************************************************************
693  * subpicture_t allocation
694  *****************************************************************************/
695 subpicture_t *subpicture_New( void )
696 {
697     subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
698     if( !p_subpic )
699         return NULL;
700
701     p_subpic->i_order    = 0;
702     p_subpic->b_absolute = true;
703     p_subpic->b_fade     = false;
704     p_subpic->b_subtitle = false;
705     p_subpic->i_alpha    = 0xFF;
706     p_subpic->p_region   = NULL;
707     p_subpic->pf_render  = NULL;
708     p_subpic->pf_destroy = NULL;
709     p_subpic->p_sys      = NULL;
710
711     return p_subpic;
712 }
713
714 void subpicture_Delete( subpicture_t *p_subpic )
715 {
716     subpicture_region_ChainDelete( p_subpic->p_region );
717     p_subpic->p_region = NULL;
718
719     if( p_subpic->pf_destroy )
720     {
721         p_subpic->pf_destroy( p_subpic );
722     }
723     free( p_subpic );
724 }
725
726 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
727 {
728     p_subpic->p_next = *pp_head;
729
730     *pp_head = p_subpic;
731 }
732
733 subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
734                                          picture_t *p_picture, vlc_fourcc_t i_chroma )
735 {
736     /* */
737     video_format_t fmt_in = p_picture->format;
738
739     /* */
740     video_format_t fmt_out;
741     fmt_out = fmt_in;
742     fmt_out.i_chroma = i_chroma;
743
744     /* */
745     image_handler_t *p_image = image_HandlerCreate( p_obj );
746     if( !p_image )
747         return NULL;
748
749     picture_t *p_pip = image_Convert( p_image, p_picture, &fmt_in, &fmt_out );
750
751     image_HandlerDelete( p_image );
752
753     if( !p_pip )
754         return NULL;
755
756     subpicture_t *p_subpic = subpicture_New();
757     if( !p_subpic )
758     {
759          picture_Release( p_pip );
760          return NULL;
761     }
762
763     p_subpic->i_original_picture_width  = fmt_out.i_width;
764     p_subpic->i_original_picture_height = fmt_out.i_height;
765
766     fmt_out.i_aspect = 0;
767     fmt_out.i_sar_num =
768     fmt_out.i_sar_den = 0;
769
770     p_subpic->p_region = subpicture_region_New( &fmt_out );
771     if( p_subpic->p_region )
772     {
773         picture_Release( p_subpic->p_region->p_picture );
774         p_subpic->p_region->p_picture = p_pip;
775     }
776     else
777     {
778         picture_Release( p_pip );
779     }
780     return p_subpic;
781 }
782
783 /*****************************************************************************
784  * subpicture_region_t allocation
785  *****************************************************************************/
786 subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
787 {
788     subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
789     if( !p_region )
790         return NULL;
791
792     p_region->fmt = *p_fmt;
793     p_region->fmt.p_palette = NULL;
794     if( p_fmt->i_chroma == VLC_CODEC_YUVP )
795     {
796         p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
797         if( p_fmt->p_palette )
798             *p_region->fmt.p_palette = *p_fmt->p_palette;
799     }
800     p_region->i_alpha = 0xff;
801     p_region->p_next = NULL;
802     p_region->p_private = NULL;
803     p_region->psz_text = NULL;
804     p_region->p_style = NULL;
805     p_region->p_picture = NULL;
806
807     if( p_fmt->i_chroma == VLC_CODEC_TEXT )
808         return p_region;
809
810     p_region->p_picture = picture_New( p_fmt->i_chroma, p_fmt->i_width, p_fmt->i_height,
811                                        p_fmt->i_aspect );
812     if( !p_region->p_picture )
813     {
814         free( p_fmt->p_palette );
815         free( p_region );
816         return NULL;
817     }
818
819     return p_region;
820 }
821
822 /* */
823 void subpicture_region_Delete( subpicture_region_t *p_region )
824 {
825     if( !p_region )
826         return;
827
828     if( p_region->p_private )
829         SpuRegionPrivateDelete( p_region->p_private );
830
831     if( p_region->p_picture )
832         picture_Release( p_region->p_picture );
833
834     free( p_region->fmt.p_palette );
835
836     free( p_region->psz_text );
837     free( p_region->psz_html );
838     if( p_region->p_style )
839         text_style_Delete( p_region->p_style );
840     free( p_region );
841 }
842
843 /* */
844 void subpicture_region_ChainDelete( subpicture_region_t *p_head )
845 {
846     while( p_head )
847     {
848         subpicture_region_t *p_next = p_head->p_next;
849
850         subpicture_region_Delete( p_head );
851
852         p_head = p_next;
853     }
854 }
855
856
857
858 /*****************************************************************************
859  * heap managment
860  *****************************************************************************/
861 static void SpuHeapInit( spu_heap_t *p_heap )
862 {
863     for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
864     {
865         spu_heap_entry_t *e = &p_heap->p_entry[i];
866
867         e->p_subpicture = NULL;
868         e->b_reject = false;
869     }
870 }
871
872 static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
873 {
874     for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
875     {
876         spu_heap_entry_t *e = &p_heap->p_entry[i];
877
878         if( e->p_subpicture )
879             continue;
880
881         e->p_subpicture = p_subpic;
882         e->b_reject = false;
883         return VLC_SUCCESS;
884     }
885     return VLC_EGENERIC;
886 }
887
888 static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
889 {
890     spu_heap_entry_t *e = &p_heap->p_entry[i_index];
891
892     if( e->p_subpicture )
893         subpicture_Delete( e->p_subpicture );
894
895     e->p_subpicture = NULL;
896 }
897
898 static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
899 {
900     for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
901     {
902         spu_heap_entry_t *e = &p_heap->p_entry[i];
903
904         if( e->p_subpicture != p_subpic )
905             continue;
906
907         SpuHeapDeleteAt( p_heap, i );
908         return VLC_SUCCESS;
909     }
910     return VLC_EGENERIC;
911 }
912
913 static void SpuHeapClean( spu_heap_t *p_heap )
914 {
915     for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
916     {
917         spu_heap_entry_t *e = &p_heap->p_entry[i];
918         if( e->p_subpicture )
919             subpicture_Delete( e->p_subpicture );
920     }
921 }
922
923 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
924 {
925     subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
926
927     if( !p_private )
928         return NULL;
929
930     p_private->fmt = *p_fmt;
931     if( p_fmt->p_palette )
932     {
933         p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
934         if( p_private->fmt.p_palette )
935             *p_private->fmt.p_palette = *p_fmt->p_palette;
936     }
937     p_private->p_picture = NULL;
938
939     return p_private;
940 }
941 static void SpuRegionPrivateDelete( subpicture_region_private_t *p_private )
942 {
943     if( p_private->p_picture )
944         picture_Release( p_private->p_picture );
945     free( p_private->fmt.p_palette );
946     free( p_private );
947 }
948
949 static void FilterRelease( filter_t *p_filter )
950 {
951     if( p_filter->p_module )
952         module_unneed( p_filter, p_filter->p_module );
953
954     vlc_object_detach( p_filter );
955     vlc_object_release( p_filter );
956 }
957
958 static void SpuRenderCreateAndLoadText( spu_t *p_spu )
959 {
960     filter_t *p_text;
961
962     assert( !p_spu->p->p_text );
963
964     p_spu->p->p_text =
965     p_text        = vlc_custom_create( p_spu, sizeof(filter_t),
966                                        VLC_OBJECT_GENERIC, "spu text" );
967     if( !p_text )
968         return;
969
970     es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );
971
972     es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
973     p_text->fmt_out.video.i_width =
974     p_text->fmt_out.video.i_visible_width = 32;
975     p_text->fmt_out.video.i_height =
976     p_text->fmt_out.video.i_visible_height = 32;
977
978     p_text->pf_sub_buffer_new = spu_new_buffer;
979     p_text->pf_sub_buffer_del = spu_del_buffer;
980
981     vlc_object_attach( p_text, p_spu );
982
983     /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
984      * same than these 2 calls ? */
985     char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
986     if( psz_modulename && *psz_modulename )
987     {
988         p_text->p_module = module_need( p_text, "text renderer",
989                                         psz_modulename, true );
990     }
991     free( psz_modulename );
992
993     if( !p_text->p_module )
994         p_text->p_module = module_need( p_text, "text renderer", NULL, false );
995
996     /* Create a few variables used for enhanced text rendering */
997     var_Create( p_text, "spu-duration", VLC_VAR_TIME );
998     var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
999     var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
1000     var_Create( p_text, "scale", VLC_VAR_INTEGER );
1001 }
1002
1003 static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
1004                                      vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
1005                                      bool b_resize )
1006 {
1007     filter_t *p_scale;
1008
1009     p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
1010                                  VLC_OBJECT_GENERIC, "scale" );
1011     if( !p_scale )
1012         return NULL;
1013
1014     es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
1015     p_scale->fmt_in.video.i_chroma = i_src_chroma;
1016     p_scale->fmt_in.video.i_width =
1017     p_scale->fmt_in.video.i_height = 32;
1018
1019     es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
1020     p_scale->fmt_out.video.i_chroma = i_dst_chroma;
1021     p_scale->fmt_out.video.i_width =
1022     p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
1023
1024     p_scale->pf_vout_buffer_new = spu_new_video_buffer;
1025     p_scale->pf_vout_buffer_del = spu_del_video_buffer;
1026
1027     vlc_object_attach( p_scale, p_obj );
1028     p_scale->p_module = module_need( p_scale, "video filter2", NULL, false );
1029
1030     return p_scale;
1031 }
1032 static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
1033 {
1034     assert( !p_spu->p->p_scale );
1035     assert( !p_spu->p->p_scale_yuvp );
1036     /* XXX p_spu->p_scale is used for all conversion/scaling except yuvp to
1037      * yuva/rgba */
1038     p_spu->p->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu),
1039                                             VLC_CODEC_YUVA, VLC_CODEC_YUVA, true );
1040     /* This one is used for YUVP to YUVA/RGBA without scaling
1041      * FIXME rename it */
1042     p_spu->p->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu),
1043                                                  VLC_CODEC_YUVP, VLC_CODEC_YUVA, false );
1044 }
1045
1046 static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
1047                            subpicture_t *p_subpic, subpicture_region_t *p_region,
1048                            int i_min_scale_ratio, mtime_t render_date )
1049 {
1050     filter_t *p_text = p_spu->p->p_text;
1051
1052     assert( p_region->fmt.i_chroma == VLC_CODEC_TEXT );
1053
1054     if( !p_text || !p_text->p_module )
1055         goto exit;
1056
1057     /* Setup 3 variables which can be used to render
1058      * time-dependent text (and effects). The first indicates
1059      * the total amount of time the text will be on screen,
1060      * the second the amount of time it has already been on
1061      * screen (can be a negative value as text is layed out
1062      * before it is rendered) and the third is a feedback
1063      * variable from the renderer - if the renderer sets it
1064      * then this particular text is time-dependent, eg. the
1065      * visual progress bar inside the text in karaoke and the
1066      * text needs to be rendered multiple times in order for
1067      * the effect to work - we therefore need to return the
1068      * region to its original state at the end of the loop,
1069      * instead of leaving it in YUVA or YUVP.
1070      * Any renderer which is unaware of how to render
1071      * time-dependent text can happily ignore the variables
1072      * and render the text the same as usual - it should at
1073      * least show up on screen, but the effect won't change
1074      * the text over time.
1075      */
1076     var_SetTime( p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
1077     var_SetTime( p_text, "spu-elapsed", render_date );
1078     var_SetBool( p_text, "text-rerender", false );
1079     var_SetInteger( p_text, "scale", i_min_scale_ratio );
1080
1081     if( p_text->pf_render_html && p_region->psz_html )
1082     {
1083         p_text->pf_render_html( p_text, p_region, p_region );
1084     }
1085     else if( p_text->pf_render_text )
1086     {
1087         p_text->pf_render_text( p_text, p_region, p_region );
1088     }
1089     *pb_rerender_text = var_GetBool( p_text, "text-rerender" );
1090
1091 exit:
1092     p_region->i_align |= SUBPICTURE_RENDERED;
1093 }
1094
1095 /**
1096  * A few scale functions helpers.
1097  */
1098 static spu_scale_t spu_scale_create( int w, int h )
1099 {
1100     spu_scale_t s = { .w = w, .h = h };
1101     if( s.w <= 0 )
1102         s.w = SCALE_UNIT;
1103     if( s.h <= 0 )
1104         s.h = SCALE_UNIT;
1105     return s;
1106 }
1107 static spu_scale_t spu_scale_unit( void )
1108 {
1109     return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
1110 }
1111 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd )
1112 {
1113     return spu_scale_create( wn * SCALE_UNIT / wd,
1114                              hn * SCALE_UNIT / hd );
1115 }
1116 static int spu_scale_w( int v, const spu_scale_t s )
1117 {
1118     return v * s.w / SCALE_UNIT;
1119 }
1120 static int spu_scale_h( int v, const spu_scale_t s )
1121 {
1122     return v * s.h / SCALE_UNIT;
1123 }
1124 static int spu_invscale_w( int v, const spu_scale_t s )
1125 {
1126     return v * SCALE_UNIT / s.w;
1127 }
1128 static int spu_invscale_h( int v, const spu_scale_t s )
1129 {
1130     return v * SCALE_UNIT / s.h;
1131 }
1132
1133 /**
1134  * A few area functions helpers
1135  */
1136 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t s )
1137 {
1138     spu_area_t a = { .i_x = x, .i_y = y, .i_width = w, .i_height = h, .scale = s };
1139     return a;
1140 }
1141 static spu_area_t spu_area_scaled( spu_area_t a )
1142 {
1143     if( a.scale.w == SCALE_UNIT && a.scale.h == SCALE_UNIT )
1144         return a;
1145
1146     a.i_x = spu_scale_w( a.i_x, a.scale );
1147     a.i_y = spu_scale_h( a.i_y, a.scale );
1148
1149     a.i_width  = spu_scale_w( a.i_width,  a.scale );
1150     a.i_height = spu_scale_h( a.i_height, a.scale );
1151
1152     a.scale = spu_scale_unit();
1153     return a;
1154 }
1155 static spu_area_t spu_area_unscaled( spu_area_t a, spu_scale_t s )
1156 {
1157     if( a.scale.w == s.w && a.scale.h == s.h )
1158         return a;
1159
1160     a = spu_area_scaled( a );
1161
1162     a.i_x = spu_invscale_w( a.i_x, s );
1163     a.i_y = spu_invscale_h( a.i_y, s );
1164
1165     a.i_width  = spu_invscale_w( a.i_width, s );
1166     a.i_height = spu_invscale_h( a.i_height, s );
1167
1168     a.scale = s;
1169     return a;
1170 }
1171 static bool spu_area_overlap( spu_area_t a, spu_area_t b )
1172 {
1173     const int i_dx = 0;
1174     const int i_dy = 0;
1175
1176     a = spu_area_scaled( a );
1177     b = spu_area_scaled( b );
1178
1179     return  __MAX( a.i_x-i_dx, b.i_x ) < __MIN( a.i_x+a.i_width +i_dx, b.i_x+b.i_width  ) &&
1180             __MAX( a.i_y-i_dy, b.i_y ) < __MIN( a.i_y+a.i_height+i_dy, b.i_y+b.i_height );
1181 }
1182
1183 /**
1184  * Avoid area overlapping
1185  */
1186 static void SpuAreaFixOverlap( spu_area_t *p_dst,
1187                                const spu_area_t *p_master,
1188                                const spu_area_t *p_sub, int i_sub, int i_align )
1189 {
1190     spu_area_t a = spu_area_scaled( *p_dst );
1191     bool b_moved = false;
1192     bool b_ok;
1193
1194     assert( p_master->i_x == 0 && p_master->i_y == 0 );
1195
1196     /* Check for overlap
1197      * XXX It is not fast O(n^2) but we should not have a lot of region */
1198     do
1199     {
1200         b_ok = true;
1201         for( int i = 0; i < i_sub; i++ )
1202         {
1203             spu_area_t sub = spu_area_scaled( p_sub[i] );
1204
1205             if( !spu_area_overlap( a, sub ) )
1206                 continue;
1207
1208             if( i_align & SUBPICTURE_ALIGN_TOP )
1209             {
1210                 /* We go down */
1211                 int i_y = sub.i_y + sub.i_height;
1212                 if( i_y + a.i_height > p_master->i_height )
1213                     break;
1214                 a.i_y = i_y;
1215                 b_moved = true;
1216             }
1217             else if( i_align & SUBPICTURE_ALIGN_BOTTOM )
1218             {
1219                 /* We go up */
1220                 int i_y = sub.i_y - a.i_height;
1221                 if( i_y < 0 )
1222                     break;
1223                 a.i_y = i_y;
1224                 b_moved = true;
1225             }
1226             else
1227             {
1228                 /* TODO what to do in this case? */
1229                 //fprintf( stderr, "Overlap with unsupported alignment\n" );
1230                 break;
1231             }
1232
1233             b_ok = false;
1234             break;
1235         }
1236     } while( !b_ok );
1237
1238     if( b_moved )
1239         *p_dst = spu_area_unscaled( a, p_dst->scale );
1240 }
1241
1242
1243 /**
1244  * Place a region
1245  */
1246 static void SpuRegionPlace( int *pi_x, int *pi_y,
1247                             const subpicture_t *p_subpic,
1248                             const subpicture_region_t *p_region,
1249                             int i_margin_y )
1250 {
1251     const int i_delta_x = p_region->i_x;
1252     const int i_delta_y = p_region->i_y;
1253     int i_x, i_y;
1254
1255     assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
1256     if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
1257     {
1258         i_y = i_delta_y;
1259     }
1260     else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
1261     {
1262         i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
1263     }
1264     else
1265     {
1266         i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
1267     }
1268
1269     if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
1270     {
1271         i_x = i_delta_x;
1272     }
1273     else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
1274     {
1275         i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
1276     }
1277     else
1278     {
1279         i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
1280     }
1281
1282     if( p_subpic->b_absolute )
1283     {
1284         i_x = i_delta_x;
1285         i_y = i_delta_y;
1286     }
1287
1288     /* Margin shifts all subpictures */
1289     if( i_margin_y != 0 )
1290         i_y -= i_margin_y;
1291
1292     /* Clamp offset to not go out of the screen (when possible) */
1293     const int i_error_x = (i_x + p_region->fmt.i_width) - p_subpic->i_original_picture_width;
1294     if( i_error_x > 0 )
1295         i_x -= i_error_x;
1296     if( i_x < 0 )
1297         i_x = 0;
1298
1299     const int i_error_y = (i_y + p_region->fmt.i_height) - p_subpic->i_original_picture_height;
1300     if( i_error_y > 0 )
1301         i_y -= i_error_y;
1302     if( i_y < 0 )
1303         i_y = 0;
1304
1305     *pi_x = i_x;
1306     *pi_y = i_y;
1307 }
1308
1309 /**
1310  * This function computes the current alpha value for a given region.
1311  */
1312 static int SpuRegionAlpha( subpicture_t *p_subpic, subpicture_region_t *p_region )
1313 {
1314     /* Compute alpha blend value */
1315     int i_fade_alpha = 255;
1316     if( p_subpic->b_fade )
1317     {
1318         mtime_t i_fade_start = ( p_subpic->i_stop +
1319                                  p_subpic->i_start ) / 2;
1320         mtime_t i_now = mdate();
1321
1322         if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
1323         {
1324             i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
1325                            ( p_subpic->i_stop - i_fade_start );
1326         }
1327     }
1328     return i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025;
1329 }
1330
1331 /**
1332  * It will render the provided region onto p_pic_dst.
1333  */
1334
1335 static void SpuRenderRegion( spu_t *p_spu,
1336                              picture_t *p_pic_dst, spu_area_t *p_area,
1337                              subpicture_t *p_subpic, subpicture_region_t *p_region,
1338                              const spu_scale_t scale_size,
1339                              const video_format_t *p_fmt,
1340                              const spu_area_t *p_subtitle_area, int i_subtitle_area,
1341                              mtime_t render_date )
1342 {
1343     spu_private_t *p_sys = p_spu->p;
1344
1345     video_format_t fmt_original = p_region->fmt;
1346     bool b_rerender_text = false;
1347     bool b_restore_format = false;
1348     int i_x_offset;
1349     int i_y_offset;
1350
1351     video_format_t region_fmt;
1352     picture_t *p_region_picture;
1353
1354     /* Invalidate area by default */
1355     *p_area = spu_area_create( 0,0, 0,0, scale_size );
1356
1357     /* Render text region */
1358     if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1359     {
1360         const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
1361         SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region,
1362                        i_min_scale_ratio, render_date );
1363         b_restore_format = b_rerender_text;
1364
1365         /* Check if the rendering has failed ... */
1366         if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1367             goto exit;
1368     }
1369
1370     /* Force palette if requested
1371      * FIXME b_force_palette and b_force_crop are applied to all subpictures using palette
1372      * instead of only the right one (being the dvd spu).
1373      */
1374     const bool b_using_palette = p_region->fmt.i_chroma == VLC_CODEC_YUVP;
1375     const bool b_force_palette = b_using_palette && p_sys->b_force_palette;
1376     const bool b_force_crop    = b_force_palette && p_sys->b_force_crop;
1377     bool b_changed_palette     = false;
1378
1379
1380     /* Compute the margin which is expressed in destination pixel unit
1381      * The margin is applied only to subtitle and when no forced crop is
1382      * requested (dvd menu) */
1383     int i_margin_y = 0;
1384     if( !b_force_crop && p_subpic->b_subtitle )
1385         i_margin_y = spu_invscale_h( p_sys->i_margin, scale_size );
1386
1387     /* Place the picture
1388      * We compute the position in the rendered size */
1389     SpuRegionPlace( &i_x_offset, &i_y_offset,
1390                     p_subpic, p_region, i_margin_y );
1391
1392     /* Save this position for subtitle overlap support
1393      * it is really important that there are given without scale_size applied */
1394     *p_area = spu_area_create( i_x_offset, i_y_offset,
1395                                p_region->fmt.i_width, p_region->fmt.i_height,
1396                                scale_size );
1397
1398     /* Handle overlapping subtitles when possible */
1399     if( p_subpic->b_subtitle && !p_subpic->b_absolute )
1400     {
1401         spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
1402                                               spu_scale_unit() );
1403
1404         SpuAreaFixOverlap( p_area, &display, p_subtitle_area, i_subtitle_area,
1405                            p_region->i_align );
1406     }
1407
1408     /* Fix the position for the current scale_size */
1409     i_x_offset = spu_scale_w( p_area->i_x, p_area->scale );
1410     i_y_offset = spu_scale_h( p_area->i_y, p_area->scale );
1411
1412     /* */
1413     if( b_force_palette )
1414     {
1415         video_palette_t *p_palette = p_region->fmt.p_palette;
1416         video_palette_t palette;
1417
1418         /* We suppose DVD palette here */
1419         palette.i_entries = 4;
1420         for( int i = 0; i < 4; i++ )
1421             for( int j = 0; j < 4; j++ )
1422                 palette.palette[i][j] = p_sys->palette[i][j];
1423
1424         if( p_palette->i_entries == palette.i_entries )
1425         {
1426             for( int i = 0; i < p_palette->i_entries; i++ )
1427                 for( int j = 0; j < 4; j++ )
1428                     b_changed_palette |= p_palette->palette[i][j] != palette.palette[i][j];
1429         }
1430         else
1431         {
1432             b_changed_palette = true;
1433         }
1434         *p_palette = palette;
1435     }
1436
1437     /* */
1438     region_fmt = p_region->fmt;
1439     p_region_picture = p_region->p_picture;
1440
1441
1442     /* Scale from rendered size to destination size */
1443     if( p_sys->p_scale && p_sys->p_scale->p_module &&
1444         ( !b_using_palette || ( p_sys->p_scale_yuvp && p_sys->p_scale_yuvp->p_module ) ) &&
1445         ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_using_palette ) )
1446     {
1447         const unsigned i_dst_width  = spu_scale_w( p_region->fmt.i_width, scale_size );
1448         const unsigned i_dst_height = spu_scale_h( p_region->fmt.i_height, scale_size );
1449
1450         /* Destroy the cache if unusable */
1451         if( p_region->p_private )
1452         {
1453             subpicture_region_private_t *p_private = p_region->p_private;
1454             bool b_changed = false;
1455
1456             /* Check resize changes */
1457             if( i_dst_width  != p_private->fmt.i_width ||
1458                 i_dst_height != p_private->fmt.i_height )
1459                 b_changed = true;
1460
1461             /* Check forced palette changes */
1462             if( b_changed_palette )
1463                 b_changed = true;
1464
1465             if( b_changed )
1466             {
1467                 SpuRegionPrivateDelete( p_private );
1468                 p_region->p_private = NULL;
1469             }
1470         }
1471
1472         /* Scale if needed into cache */
1473         if( !p_region->p_private && i_dst_width > 0 && i_dst_height > 0 )
1474         {
1475             filter_t *p_scale = p_sys->p_scale;
1476
1477             picture_t *p_picture = p_region->p_picture;
1478             picture_Hold( p_picture );
1479
1480             /* Convert YUVP to YUVA/RGBA first for better scaling quality */
1481             if( b_using_palette )
1482             {
1483                 filter_t *p_scale_yuvp = p_sys->p_scale_yuvp;
1484
1485                 p_scale_yuvp->fmt_in.video = p_region->fmt;
1486
1487                 /* TODO converting to RGBA for RGB video output is better */
1488                 p_scale_yuvp->fmt_out.video = p_region->fmt;
1489                 p_scale_yuvp->fmt_out.video.i_chroma = VLC_CODEC_YUVA;
1490
1491                 p_picture = p_scale_yuvp->pf_video_filter( p_scale_yuvp, p_picture );
1492                 if( !p_picture )
1493                 {
1494                     /* Well we will try conversion+scaling */
1495                     msg_Warn( p_spu, "%4.4s to %4.4s conversion failed",
1496                              (const char*)&p_scale_yuvp->fmt_in.video.i_chroma,
1497                              (const char*)&p_scale_yuvp->fmt_out.video.i_chroma );
1498                 }
1499             }
1500
1501             /* Conversion(except from YUVP)/Scaling */
1502             if( p_picture &&
1503                 ( p_picture->format.i_width != i_dst_width ||
1504                   p_picture->format.i_height != i_dst_height ) )
1505             {
1506                 p_scale->fmt_in.video = p_picture->format;
1507                 p_scale->fmt_out.video = p_picture->format;
1508
1509                 p_scale->fmt_out.video.i_width = i_dst_width;
1510                 p_scale->fmt_out.video.i_height = i_dst_height;
1511
1512                 p_scale->fmt_out.video.i_visible_width =
1513                     spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1514                 p_scale->fmt_out.video.i_visible_height =
1515                     spu_scale_h( p_region->fmt.i_visible_height, scale_size );
1516
1517                 p_picture = p_scale->pf_video_filter( p_scale, p_picture );
1518                 if( !p_picture )
1519                     msg_Err( p_spu, "scaling failed" );
1520             }
1521
1522             /* */
1523             if( p_picture )
1524             {
1525                 p_region->p_private = SpuRegionPrivateNew( &p_picture->format );
1526                 if( p_region->p_private )
1527                 {
1528                     p_region->p_private->p_picture = p_picture;
1529                     if( !p_region->p_private->p_picture )
1530                     {
1531                         SpuRegionPrivateDelete( p_region->p_private );
1532                         p_region->p_private = NULL;
1533                     }
1534                 }
1535                 else
1536                 {
1537                     picture_Release( p_picture );
1538                 }
1539             }
1540         }
1541
1542         /* And use the scaled picture */
1543         if( p_region->p_private )
1544         {
1545             region_fmt = p_region->p_private->fmt;
1546             p_region_picture = p_region->p_private->p_picture;
1547         }
1548     }
1549
1550     /* Force cropping if requested */
1551     if( b_force_crop )
1552     {
1553         int i_crop_x = spu_scale_w( p_sys->i_crop_x, scale_size );
1554         int i_crop_y = spu_scale_h( p_sys->i_crop_y, scale_size );
1555         int i_crop_width = spu_scale_w( p_sys->i_crop_width, scale_size );
1556         int i_crop_height= spu_scale_h( p_sys->i_crop_height,scale_size );
1557
1558         /* Find the intersection */
1559         if( i_crop_x + i_crop_width <= i_x_offset ||
1560             i_x_offset + (int)region_fmt.i_visible_width < i_crop_x ||
1561             i_crop_y + i_crop_height <= i_y_offset ||
1562             i_y_offset + (int)region_fmt.i_visible_height < i_crop_y )
1563         {
1564             /* No intersection */
1565             region_fmt.i_visible_width =
1566             region_fmt.i_visible_height = 0;
1567         }
1568         else
1569         {
1570             int i_x, i_y, i_x_end, i_y_end;
1571             i_x = __MAX( i_crop_x, i_x_offset );
1572             i_y = __MAX( i_crop_y, i_y_offset );
1573             i_x_end = __MIN( i_crop_x + i_crop_width,
1574                            i_x_offset + (int)region_fmt.i_visible_width );
1575             i_y_end = __MIN( i_crop_y + i_crop_height,
1576                            i_y_offset + (int)region_fmt.i_visible_height );
1577
1578             region_fmt.i_x_offset = i_x - i_x_offset;
1579             region_fmt.i_y_offset = i_y - i_y_offset;
1580             region_fmt.i_visible_width = i_x_end - i_x;
1581             region_fmt.i_visible_height = i_y_end - i_y;
1582
1583             i_x_offset = __MAX( i_x, 0 );
1584             i_y_offset = __MAX( i_y, 0 );
1585         }
1586     }
1587
1588     /* Update the blender */
1589     if( filter_ConfigureBlend( p_spu->p->p_blend,
1590                                p_fmt->i_width, p_fmt->i_height,
1591                                &region_fmt ) ||
1592         filter_Blend( p_spu->p->p_blend,
1593                       p_pic_dst, i_x_offset, i_y_offset,
1594                       p_region_picture, SpuRegionAlpha( p_subpic, p_region ) ) )
1595     {
1596         msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1597                  (char *)&p_sys->p_blend->fmt_in.video.i_chroma,
1598                  (char *)&p_sys->p_blend->fmt_out.video.i_chroma );
1599     }
1600
1601 exit:
1602     if( b_rerender_text )
1603     {
1604         /* Some forms of subtitles need to be re-rendered more than
1605          * once, eg. karaoke. We therefore restore the region to its
1606          * pre-rendered state, so the next time through everything is
1607          * calculated again.
1608          */
1609         if( p_region->p_picture )
1610         {
1611             picture_Release( p_region->p_picture );
1612             p_region->p_picture = NULL;
1613         }
1614         if( p_region->p_private )
1615         {
1616             SpuRegionPrivateDelete( p_region->p_private );
1617             p_region->p_private = NULL;
1618         }
1619         p_region->i_align &= ~SUBPICTURE_RENDERED;
1620     }
1621     if( b_restore_format )
1622         p_region->fmt = fmt_original;
1623 }
1624
1625 /**
1626  * This function compares two 64 bits integers.
1627  * It can be used by qsort.
1628  */
1629 static int IntegerCmp( int64_t i0, int64_t i1 )
1630 {
1631     return i0 < i1 ? -1 : i0 > i1 ? 1 : 0;
1632 }
1633 /**
1634  * This function compares 2 subpictures using the following properties
1635  * (ordered by priority)
1636  * 1. absolute positionning
1637  * 2. start time
1638  * 3. creation order (per channel)
1639  *
1640  * It can be used by qsort.
1641  *
1642  * XXX spu_RenderSubpictures depends heavily on this order.
1643  */
1644 static int SubpictureCmp( const void *s0, const void *s1 )
1645 {
1646     subpicture_t *p_subpic0 = *(subpicture_t**)s0;
1647     subpicture_t *p_subpic1 = *(subpicture_t**)s1;
1648     int r;
1649
1650     r = IntegerCmp( !p_subpic0->b_absolute, !p_subpic1->b_absolute );
1651     if( !r )
1652         r = IntegerCmp( p_subpic0->i_start, p_subpic1->i_start );
1653     if( !r )
1654         r = IntegerCmp( p_subpic0->i_channel, p_subpic1->i_channel );
1655     if( !r )
1656         r = IntegerCmp( p_subpic0->i_order, p_subpic1->i_order );
1657     return r;
1658 }
1659
1660 /*****************************************************************************
1661  * SpuClearChannel: clear an spu channel
1662  *****************************************************************************
1663  * This function destroys the subpictures which belong to the spu channel
1664  * corresponding to i_channel_id.
1665  *****************************************************************************/
1666 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1667 {
1668     spu_private_t *p_sys = p_spu->p;
1669     int          i_subpic;                               /* subpicture index */
1670
1671     vlc_mutex_lock( &p_sys->lock );
1672
1673     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1674     {
1675         spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_subpic];
1676         subpicture_t *p_subpic = p_entry->p_subpicture;
1677
1678         if( !p_subpic )
1679             continue;
1680         if( p_subpic->i_channel != i_channel && ( i_channel != -1 || p_subpic->i_channel == DEFAULT_CHAN ) )
1681             continue;
1682
1683         /* You cannot delete subpicture outside of spu_SortSubpictures */
1684         p_entry->b_reject = true;
1685     }
1686
1687     vlc_mutex_unlock( &p_sys->lock );
1688 }
1689
1690 /*****************************************************************************
1691  * spu_ControlDefault: default methods for the subpicture unit control.
1692  *****************************************************************************/
1693 static int SpuControl( spu_t *p_spu, int i_query, va_list args )
1694 {
1695     spu_private_t *p_sys = p_spu->p;
1696     int *pi, i;
1697
1698     switch( i_query )
1699     {
1700     case SPU_CHANNEL_REGISTER:
1701         pi = (int *)va_arg( args, int * );
1702         vlc_mutex_lock( &p_sys->lock );
1703         if( pi )
1704             *pi = p_sys->i_channel++;
1705         vlc_mutex_unlock( &p_sys->lock );
1706         break;
1707
1708     case SPU_CHANNEL_CLEAR:
1709         i = (int)va_arg( args, int );
1710         SpuClearChannel( p_spu, i );
1711         break;
1712
1713     default:
1714         msg_Dbg( p_spu, "control query not supported" );
1715         return VLC_EGENERIC;
1716     }
1717
1718     return VLC_SUCCESS;
1719 }
1720
1721 /*****************************************************************************
1722  * Object variables callbacks
1723  *****************************************************************************/
1724
1725 /*****************************************************************************
1726  * UpdateSPU: update subpicture settings
1727  *****************************************************************************
1728  * This function is called from CropCallback and at initialization time, to
1729  * retrieve crop information from the input.
1730  *****************************************************************************/
1731 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1732 {
1733     spu_private_t *p_sys = p_spu->p;
1734     vlc_value_t val;
1735
1736     vlc_mutex_lock( &p_sys->lock );
1737
1738     p_sys->b_force_palette = false;
1739     p_sys->b_force_crop = false;
1740
1741     if( var_Get( p_object, "highlight", &val ) || !val.b_bool )
1742     {
1743         vlc_mutex_unlock( &p_sys->lock );
1744         return;
1745     }
1746
1747     p_sys->b_force_crop = true;
1748     p_sys->i_crop_x = var_GetInteger( p_object, "x-start" );
1749     p_sys->i_crop_y = var_GetInteger( p_object, "y-start" );
1750     p_sys->i_crop_width  = var_GetInteger( p_object, "x-end" ) - p_sys->i_crop_x;
1751     p_sys->i_crop_height = var_GetInteger( p_object, "y-end" ) - p_sys->i_crop_y;
1752
1753     if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1754     {
1755         memcpy( p_sys->palette, val.p_address, 16 );
1756         p_sys->b_force_palette = true;
1757     }
1758     vlc_mutex_unlock( &p_sys->lock );
1759
1760     msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1761              p_sys->i_crop_x, p_sys->i_crop_y,
1762              p_sys->i_crop_width, p_sys->i_crop_height,
1763              p_sys->b_force_palette );
1764 }
1765
1766 /*****************************************************************************
1767  * CropCallback: called when the highlight properties are changed
1768  *****************************************************************************
1769  * This callback is called from the input thread when we need cropping
1770  *****************************************************************************/
1771 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1772                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1773 {
1774     VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1775
1776     UpdateSPU( (spu_t *)p_data, p_object );
1777     return VLC_SUCCESS;
1778 }
1779
1780 /*****************************************************************************
1781  * Buffers allocation callbacks for the filters
1782  *****************************************************************************/
1783 struct filter_owner_sys_t
1784 {
1785     spu_t *p_spu;
1786     int i_channel;
1787 };
1788
1789 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1790 {
1791     filter_owner_sys_t *p_sys = p_filter->p_owner;
1792
1793     subpicture_t *p_subpicture = subpicture_New();
1794     if( p_subpicture )
1795         p_subpicture->i_channel = p_sys->i_channel;
1796     return p_subpicture;
1797 }
1798 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1799 {
1800     VLC_UNUSED( p_filter );
1801     subpicture_Delete( p_subpic );
1802 }
1803
1804 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1805 {
1806     VLC_UNUSED(p_filter);
1807     return subpicture_New();
1808 }
1809 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1810 {
1811     VLC_UNUSED(p_filter);
1812     subpicture_Delete( p_subpic );
1813 }
1814
1815 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1816 {
1817     const video_format_t *p_fmt = &p_filter->fmt_out.video;
1818
1819     VLC_UNUSED(p_filter);
1820     return picture_New( p_fmt->i_chroma,
1821                         p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
1822 }
1823 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_picture )
1824 {
1825     VLC_UNUSED(p_filter);
1826     picture_Release( p_picture );
1827 }
1828
1829 static int SubFilterAllocationInit( filter_t *p_filter, void *p_data )
1830 {
1831     spu_t *p_spu = p_data;
1832
1833     filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
1834     if( !p_sys )
1835         return VLC_EGENERIC;
1836
1837     p_filter->pf_sub_buffer_new = sub_new_buffer;
1838     p_filter->pf_sub_buffer_del = sub_del_buffer;
1839
1840     p_filter->p_owner = p_sys;
1841     spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
1842     p_sys->p_spu = p_spu;
1843
1844     return VLC_SUCCESS;
1845 }
1846
1847 static void SubFilterAllocationClean( filter_t *p_filter )
1848 {
1849     filter_owner_sys_t *p_sys = p_filter->p_owner;
1850
1851     SpuClearChannel( p_sys->p_spu, p_sys->i_channel );
1852     free( p_filter->p_owner );
1853 }
1854
1855 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1856                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1857 {
1858     spu_t *p_spu = p_data;
1859     spu_private_t *p_sys = p_spu->p;
1860
1861     VLC_UNUSED(p_object); VLC_UNUSED(oldval); VLC_UNUSED(psz_var);
1862
1863     vlc_mutex_lock( &p_sys->lock );
1864
1865     free( p_sys->psz_chain_update );
1866     p_sys->psz_chain_update = strdup( newval.psz_string );
1867
1868     vlc_mutex_unlock( &p_sys->lock );
1869     return VLC_SUCCESS;
1870 }
1871