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