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