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 #include <vlc/vlc.h>
  30 #include <vlc_vout.h>
  31 #include <vlc_block.h>
  32 #include <vlc_filter.h>
  33 #include <vlc_osd.h>
  34
  35 /*****************************************************************************
  36  * Local prototypes
  37  *****************************************************************************/
  38 static void UpdateSPU   ( spu_t *, vlc_object_t * );
  39 static int  CropCallback( vlc_object_t *, char const *,
  40                           vlc_value_t, vlc_value_t, void * );
  41
  42 static int spu_vaControlDefault( spu_t *, int, va_list );
  43
  44 static subpicture_t *sub_new_buffer( filter_t * );
  45 static void sub_del_buffer( filter_t *, subpicture_t * );
  46 static subpicture_t *spu_new_buffer( filter_t * );
  47 static void spu_del_buffer( filter_t *, subpicture_t * );
  48 static picture_t *spu_new_video_buffer( filter_t * );
  49 static void spu_del_video_buffer( filter_t *, picture_t * );
  50
  51 static int spu_ParseChain( spu_t * );
  52 static void spu_DeleteChain( spu_t * );
  53 static int SubFilterCallback( vlc_object_t *, char const *,
  54                               vlc_value_t, vlc_value_t, void * );
  55
  56 struct filter_owner_sys_t
  57 {
  58     spu_t *p_spu;
  59     int i_channel;
  60 };
  61
  62 enum {
  63     SCALE_DEFAULT,
  64     SCALE_TEXT,
  65     SCALE_SIZE
  66 };
  67 /**
  68  * Creates the subpicture unit
  69  *
  70  * \param p_this the parent object which creates the subpicture unit
  71  */
  72 spu_t *__spu_Create( vlc_object_t *p_this )
  73 {
  74     int i_index;
  75     spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
  76
  77     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
  78     {
  79         p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
  80     }
  81
  82     p_spu->p_blend = NULL;
  83     p_spu->p_text = NULL;
  84     p_spu->p_scale = NULL;
  85     p_spu->i_filter = 0;
  86     p_spu->pf_control = spu_vaControlDefault;
  87
  88     /* Register the default subpicture channel */
  89     p_spu->i_channel = 2;
  90
  91     vlc_mutex_init( p_this, &p_spu->subpicture_lock );
  92
  93     vlc_object_attach( p_spu, p_this );
  94
  95     return p_spu;
  96 }
  97
  98 /**
  99  * Initialise the subpicture unit
 100  *
 101  * \param p_spu the subpicture unit object
 102  */
 103 int spu_Init( spu_t *p_spu )
 104 {
 105     vlc_value_t val;
 106
 107     /* If the user requested a sub margin, we force the position. */
 108     var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 109     var_Get( p_spu, "sub-margin", &val );
 110     p_spu->i_margin = val.i_int;
 111
 112     var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 113     var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
 114
 115     spu_ParseChain( p_spu );
 116
 117     return VLC_SUCCESS;
 118 }
 119
 120 int spu_ParseChain( spu_t *p_spu )
 121 {
 122     char *psz_parser;
 123     vlc_value_t val;
 124     var_Get( p_spu, "sub-filter", &val );
 125     psz_parser = val.psz_string;
 126
 127     while( psz_parser && *psz_parser )
 128     {
 129         config_chain_t *p_cfg;
 130         char *psz_name;
 131
 132         psz_parser = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 133
 134         msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
 135
 136         p_spu->pp_filter[p_spu->i_filter] =
 137             vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 138         vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
 139         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
 140         p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
 141         p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
 142         p_spu->pp_filter[p_spu->i_filter]->p_module =
 143             module_Need( p_spu->pp_filter[p_spu->i_filter],
 144                          "sub filter", psz_name, VLC_TRUE );
 145         if( p_spu->pp_filter[p_spu->i_filter]->p_module )
 146         {
 147             filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
 148             if( p_sys )
 149             {
 150                 p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
 151                 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
 152                 p_sys->p_spu = p_spu;
 153                 p_spu->i_filter++;
 154             }
 155         }
 156         else
 157         {
 158             msg_Dbg( p_spu, "no sub filter found" );
 159             config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
 160             vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
 161             vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
 162         }
 163
 164         if( p_spu->i_filter >= 10 )
 165         {
 166             msg_Dbg( p_spu, "can't add anymore filters" );
 167         }
 168
 169         free( psz_name );
 170     }
 171     if( val.psz_string ) free( val.psz_string );
 172
 173     return VLC_SUCCESS;
 174 }
 175
 176 /**
 177  * Destroy the subpicture unit
 178  *
 179  * \param p_this the parent object which destroys the subpicture unit
 180  */
 181 void spu_Destroy( spu_t *p_spu )
 182 {
 183     int i_index;
 184
 185     vlc_object_detach( p_spu );
 186
 187     /* Destroy all remaining subpictures */
 188     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
 189     {
 190         if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
 191         {
 192             spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
 193         }
 194     }
 195
 196     if( p_spu->p_blend )
 197     {
 198         if( p_spu->p_blend->p_module )
 199             module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
 200
 201         vlc_object_detach( p_spu->p_blend );
 202         vlc_object_destroy( p_spu->p_blend );
 203     }
 204
 205     if( p_spu->p_text )
 206     {
 207         if( p_spu->p_text->p_module )
 208             module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
 209
 210         vlc_object_detach( p_spu->p_text );
 211         vlc_object_destroy( p_spu->p_text );
 212     }
 213
 214     if( p_spu->p_scale )
 215     {
 216         if( p_spu->p_scale->p_module )
 217             module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
 218
 219         vlc_object_detach( p_spu->p_scale );
 220         vlc_object_destroy( p_spu->p_scale );
 221     }
 222
 223     spu_DeleteChain( p_spu );
 224
 225     vlc_mutex_destroy( &p_spu->subpicture_lock );
 226     vlc_object_destroy( p_spu );
 227 }
 228
 229 static void spu_DeleteChain( spu_t *p_spu )
 230 {
 231     if( p_spu->i_filter )
 232     while( p_spu->i_filter )
 233     {
 234         p_spu->i_filter--;
 235         module_Unneed( p_spu->pp_filter[p_spu->i_filter],
 236                        p_spu->pp_filter[p_spu->i_filter]->p_module );
 237         free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
 238         config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
 239         vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
 240         vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
 241     }
 242 }
 243
 244 /**
 245  * Attach/Detach the SPU from any input
 246  *
 247  * \param p_this the object in which to destroy the subpicture unit
 248  * \param b_attach to select attach or detach
 249  */
 250 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
 251 {
 252     vlc_object_t *p_input;
 253
 254     p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
 255     if( !p_input ) return;
 256
 257     if( b_attach )
 258     {
 259         UpdateSPU( p_spu, VLC_OBJECT(p_input) );
 260         var_AddCallback( p_input, "highlight", CropCallback, p_spu );
 261         vlc_object_release( p_input );
 262     }
 263     else
 264     {
 265         /* Delete callback */
 266         var_DelCallback( p_input, "highlight", CropCallback, p_spu );
 267         vlc_object_release( p_input );
 268     }
 269 }
 270
 271 /**
 272  * Create a subpicture region
 273  *
 274  * \param p_this vlc_object_t
 275  * \param p_fmt the format that this subpicture region should have
 276  */
 277 static void RegionPictureRelease( picture_t *p_pic )
 278 {
 279     if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
 280 }
 281 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
 282                                          video_format_t *p_fmt )
 283 {
 284     subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
 285     if( !p_region ) return NULL;
 286
 287     memset( p_region, 0, sizeof(subpicture_region_t) );
 288     p_region->p_next = NULL;
 289     p_region->p_cache = NULL;
 290     p_region->fmt = *p_fmt;
 291     p_region->psz_text = NULL;
 292     p_region->p_style = NULL;
 293
 294     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
 295         p_fmt->p_palette = p_region->fmt.p_palette =
 296             malloc( sizeof(video_palette_t) );
 297     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
 298
 299     p_region->picture.p_data_orig = NULL;
 300
 301     if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
 302
 303     vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
 304                           p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
 305
 306     if( !p_region->picture.i_planes )
 307     {
 308         free( p_region );
 309         if( p_fmt->p_palette ) free( p_fmt->p_palette );
 310         return NULL;
 311     }
 312
 313     p_region->picture.pf_release = RegionPictureRelease;
 314
 315     return p_region;
 316 }
 317
 318 /**
 319  * Make a subpicture region from an existing picture_t
 320  *
 321  * \param p_this vlc_object_t
 322  * \param p_fmt the format that this subpicture region should have
 323  * \param p_pic a pointer to the picture creating the region (not freed)
 324  */
 325 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
 326                                        video_format_t *p_fmt,
 327                                        picture_t *p_pic )
 328 {
 329     subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
 330     (void)p_this;
 331     if( !p_region ) return NULL;
 332     memset( p_region, 0, sizeof(subpicture_region_t) );
 333     p_region->p_next = 0;
 334     p_region->p_cache = 0;
 335     p_region->fmt = *p_fmt;
 336     p_region->psz_text = 0;
 337     p_region->p_style = NULL;
 338
 339     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
 340         p_fmt->p_palette = p_region->fmt.p_palette =
 341             malloc( sizeof(video_palette_t) );
 342     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
 343
 344     memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
 345     p_region->picture.pf_release = RegionPictureRelease;
 346
 347     return p_region;
 348 }
 349
 350 /**
 351  * Destroy a subpicture region
 352  *
 353  * \param p_this vlc_object_t
 354  * \param p_region the subpicture region to destroy
 355  */
 356 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
 357 {
 358     if( !p_region ) return;
 359     if( p_region->picture.pf_release )
 360         p_region->picture.pf_release( &p_region->picture );
 361     if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
 362     if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
 363
 364     if( p_region->psz_text )
 365         free( p_region->psz_text );
 366     if( p_region->psz_html )
 367         free( p_region->psz_html );
 368     //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
 369     free( p_region );
 370 }
 371
 372 /**
 373  * Display a subpicture
 374  *
 375  * Remove the reservation flag of a subpicture, which will cause it to be
 376  * ready for display.
 377  * \param p_spu the subpicture unit object
 378  * \param p_subpic the subpicture to display
 379  */
 380 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
 381 {
 382     /* Check if status is valid */
 383     if( p_subpic->i_status != RESERVED_SUBPICTURE )
 384     {
 385         msg_Err( p_spu, "subpicture %p has invalid status #%d",
 386                  p_subpic, p_subpic->i_status );
 387     }
 388
 389     /* Remove reservation flag */
 390     p_subpic->i_status = READY_SUBPICTURE;
 391
 392     if( p_subpic->i_channel == DEFAULT_CHAN )
 393     {
 394         p_subpic->i_channel = 0xFFFF;
 395         spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
 396         p_subpic->i_channel = DEFAULT_CHAN;
 397     }
 398 }
 399
 400 /**
 401  * Allocate a subpicture in the spu heap.
 402  *
 403  * This function create a reserved subpicture in the spu heap.
 404  * A null pointer is returned if the function fails. This method provides an
 405  * already allocated zone of memory in the spu data fields. It needs locking
 406  * since several pictures can be created by several producers threads.
 407  * \param p_spu the subpicture unit in which to create the subpicture
 408  * \return NULL on error, a reserved subpicture otherwise
 409  */
 410 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
 411 {
 412     int                 i_subpic;                        /* subpicture index */
 413     subpicture_t *      p_subpic = NULL;            /* first free subpicture */
 414
 415     /* Get lock */
 416     vlc_mutex_lock( &p_spu->subpicture_lock );
 417
 418     /*
 419      * Look for an empty place
 420      */
 421     p_subpic = NULL;
 422     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 423     {
 424         if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
 425         {
 426             /* Subpicture is empty and ready for allocation */
 427             p_subpic = &p_spu->p_subpicture[i_subpic];
 428             p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
 429             break;
 430         }
 431     }
 432
 433     /* If no free subpicture could be found */
 434     if( p_subpic == NULL )
 435     {
 436         msg_Err( p_spu, "subpicture heap is full" );
 437         vlc_mutex_unlock( &p_spu->subpicture_lock );
 438         return NULL;
 439     }
 440
 441     /* Copy subpicture information, set some default values */
 442     memset( p_subpic, 0, sizeof(subpicture_t) );
 443     p_subpic->i_status   = RESERVED_SUBPICTURE;
 444     p_subpic->b_absolute = VLC_TRUE;
 445     p_subpic->b_pausable = VLC_FALSE;
 446     p_subpic->b_fade     = VLC_FALSE;
 447     p_subpic->i_alpha    = 0xFF;
 448     p_subpic->p_region   = NULL;
 449     p_subpic->pf_render  = NULL;
 450     p_subpic->pf_destroy = NULL;
 451     p_subpic->p_sys      = NULL;
 452     vlc_mutex_unlock( &p_spu->subpicture_lock );
 453
 454     p_subpic->pf_create_region = __spu_CreateRegion;
 455     p_subpic->pf_make_region = __spu_MakeRegion;
 456     p_subpic->pf_destroy_region = __spu_DestroyRegion;
 457
 458     return p_subpic;
 459 }
 460
 461 /**
 462  * Remove a subpicture from the heap
 463  *
 464  * This function frees a previously reserved subpicture.
 465  * It is meant to be used when the construction of a picture aborted.
 466  * This function does not need locking since reserved subpictures are ignored
 467  * by the spu.
 468  */
 469 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
 470 {
 471     /* Get lock */
 472     vlc_mutex_lock( &p_spu->subpicture_lock );
 473
 474     /* There can be race conditions so we need to check the status */
 475     if( p_subpic->i_status == FREE_SUBPICTURE )
 476     {
 477         vlc_mutex_unlock( &p_spu->subpicture_lock );
 478         return;
 479     }
 480
 481     /* Check if status is valid */
 482     if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
 483            && ( p_subpic->i_status != READY_SUBPICTURE ) )
 484     {
 485         msg_Err( p_spu, "subpicture %p has invalid status %d",
 486                          p_subpic, p_subpic->i_status );
 487     }
 488
 489     while( p_subpic->p_region )
 490     {
 491         subpicture_region_t *p_region = p_subpic->p_region;
 492         p_subpic->p_region = p_region->p_next;
 493         spu_DestroyRegion( p_spu, p_region );
 494     }
 495
 496     if( p_subpic->pf_destroy )
 497     {
 498         p_subpic->pf_destroy( p_subpic );
 499     }
 500
 501     p_subpic->i_status = FREE_SUBPICTURE;
 502
 503     vlc_mutex_unlock( &p_spu->subpicture_lock );
 504 }
 505
 506 /*****************************************************************************
 507  * spu_RenderSubpictures: render a subpicture list
 508  *****************************************************************************
 509  * This function renders all sub picture units in the list.
 510  *****************************************************************************/
 511 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
 512                             picture_t *p_pic_dst, picture_t *p_pic_src,
 513                             subpicture_t *p_subpic,
 514                             int i_scale_width_orig, int i_scale_height_orig )
 515 {
 516     int i_source_video_width;
 517     int i_source_video_height;
 518
 519     /* Get lock */
 520     vlc_mutex_lock( &p_spu->subpicture_lock );
 521
 522     if( i_scale_width_orig <= 0 )
 523         i_scale_width_orig = 1;
 524     if( i_scale_height_orig <= 0 )
 525         i_scale_height_orig = 1;
 526
 527     i_source_video_width  = p_fmt->i_width  * 1000 / i_scale_width_orig;
 528     i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;
 529
 530     /* Check i_status again to make sure spudec hasn't destroyed the subpic */
 531     while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
 532     {
 533         subpicture_region_t *p_region = p_subpic->p_region;
 534         int pi_scale_width[ SCALE_SIZE ];
 535         int pi_scale_height[ SCALE_SIZE ];
 536         int pi_subpic_x[ SCALE_SIZE ];
 537         int k;
 538
 539         /* If the source video and subtitles stream agree on the size of
 540          * the video then disregard all further references to the subtitle
 541          * stream.
 542          */
 543         if( ( i_source_video_height == p_subpic->i_original_picture_height ) &&
 544             ( i_source_video_width  == p_subpic->i_original_picture_width ) )
 545         {
 546             p_subpic->i_original_picture_height = 0;
 547             p_subpic->i_original_picture_width = 0;
 548         }
 549
 550         for( k = 0; k < SCALE_SIZE ; k++ )
 551             pi_subpic_x[ k ] = p_subpic->i_x;
 552
 553         /* Load the blending module */
 554         if( !p_spu->p_blend && p_region )
 555         {
 556             p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 557             vlc_object_attach( p_spu->p_blend, p_spu );
 558             p_spu->p_blend->fmt_out.video.i_x_offset =
 559                 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
 560             p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
 561             p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
 562
 563             /* The blend module will be loaded when needed with the real
 564             * input format */
 565             memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
 566             p_spu->p_blend->p_module = NULL;
 567         }
 568
 569         /* Load the text rendering module; it is possible there is a
 570          * text region somewhere in the subpicture other than the first
 571          * element in the region list, so just load it anyway as we'll
 572          * probably want it sooner or later. */
 573         if( !p_spu->p_text && p_region )
 574         {
 575             char *psz_modulename = NULL;
 576
 577             p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 578             vlc_object_attach( p_spu->p_text, p_spu );
 579
 580             p_spu->p_text->fmt_out.video.i_width =
 581                 p_spu->p_text->fmt_out.video.i_visible_width =
 582                 p_fmt->i_width;
 583             p_spu->p_text->fmt_out.video.i_height =
 584                 p_spu->p_text->fmt_out.video.i_visible_height =
 585                 p_fmt->i_height;
 586
 587             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
 588             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
 589
 590             psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
 591             if( psz_modulename && *psz_modulename )
 592             {
 593                 p_spu->p_text->p_module =
 594                     module_Need( p_spu->p_text, "text renderer",
 595                                  psz_modulename, VLC_TRUE );
 596             }
 597             if( !p_spu->p_text->p_module )
 598             {
 599                 p_spu->p_text->p_module =
 600                     module_Need( p_spu->p_text, "text renderer", 0, 0 );
 601             }
 602             if( psz_modulename ) free( psz_modulename );
 603         }
 604
 605         if( p_spu->p_text )
 606         {
 607             subpicture_region_t *p_text_region = p_subpic->p_region;
 608
 609             /* Only overwrite the size fields if the region is still in
 610              * pre-rendered TEXT format. We have to traverse the subregion
 611              * list because if more than one subregion is present, the text
 612              * region isn't guarentteed to be the first in the list, and
 613              * only text regions use this flag. All of this effort assists
 614              * with the rescaling of text that has been rendered at native
 615              * resolution, rather than video resolution.
 616              */
 617             while( p_text_region &&
 618                    ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
 619             {
 620                 p_text_region = p_text_region->p_next;
 621             }
 622
 623             if( p_text_region &&
 624                 ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
 625             {
 626                 if( (p_subpic->i_original_picture_height > 0) &&
 627                     (p_subpic->i_original_picture_width  > 0) )
 628                 {
 629                     p_spu->p_text->fmt_out.video.i_width =
 630                         p_spu->p_text->fmt_out.video.i_visible_width =
 631                         p_subpic->i_original_picture_width;
 632                     p_spu->p_text->fmt_out.video.i_height =
 633                         p_spu->p_text->fmt_out.video.i_visible_height =
 634                         p_subpic->i_original_picture_height;
 635                 }
 636                 else
 637                 {
 638                     p_spu->p_text->fmt_out.video.i_width =
 639                         p_spu->p_text->fmt_out.video.i_visible_width =
 640                         p_fmt->i_width;
 641                     p_spu->p_text->fmt_out.video.i_height =
 642                         p_spu->p_text->fmt_out.video.i_visible_height =
 643                         p_fmt->i_height;
 644                 }
 645             }
 646         }
 647
 648         pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
 649         pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
 650
 651         if( p_spu->p_text )
 652         {
 653             pi_scale_width[ SCALE_TEXT ]     = ( p_fmt->i_width * 1000 ) /
 654                                           p_spu->p_text->fmt_out.video.i_width;
 655             pi_scale_height[ SCALE_TEXT ]    = ( p_fmt->i_height * 1000 ) /
 656                                           p_spu->p_text->fmt_out.video.i_height;
 657         }
 658         /* If we have an explicit size plane to render to, then turn off
 659          * the fontsize rescaling.
 660          */
 661         if( (p_subpic->i_original_picture_height > 0) &&
 662             (p_subpic->i_original_picture_width  > 0) )
 663         {
 664             i_scale_width_orig  = 1000;
 665             i_scale_height_orig = 1000;
 666         }
 667
 668         for( k = 0; k < SCALE_SIZE ; k++ )
 669         {
 670             /* Case of both width and height being specified has been dealt
 671              * with above by instead rendering to an output pane of the
 672              * explicit dimensions specified - we don't need to scale it.
 673              */
 674             if( (p_subpic->i_original_picture_height > 0) &&
 675                 (p_subpic->i_original_picture_width <= 0) )
 676             {
 677                 pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
 678                                  p_subpic->i_original_picture_height;
 679                 pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_height /
 680                                  p_subpic->i_original_picture_height;
 681             }
 682         }
 683
 684         /* Set default subpicture aspect ratio */
 685         if( p_region && p_region->fmt.i_aspect &&
 686             ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
 687         {
 688             p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
 689             p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
 690         }
 691         if( p_region &&
 692             ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
 693         {
 694             p_region->fmt.i_sar_den = p_fmt->i_sar_den;
 695             p_region->fmt.i_sar_num = p_fmt->i_sar_num;
 696         }
 697
 698         /* Take care of the aspect ratio */
 699         if( p_region &&
 700             ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
 701               ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
 702         {
 703             for( k = 0; k < SCALE_SIZE ; k++ )
 704             {
 705                 pi_scale_width[ k ] = pi_scale_width[ k ] *
 706                     (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
 707                     p_region->fmt.i_sar_den / p_fmt->i_sar_num;
 708                 pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
 709             }
 710         }
 711
 712         /* Load the scaling module */
 713         if( !p_spu->p_scale &&
 714            ((((pi_scale_width[ SCALE_TEXT ]    > 0)     || (pi_scale_height[ SCALE_TEXT ]    > 0)) &&
 715              ((pi_scale_width[ SCALE_TEXT ]    != 1000) || (pi_scale_height[ SCALE_TEXT ]    != 1000))) ||
 716             (((pi_scale_width[ SCALE_DEFAULT ] > 0)     || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
 717              ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
 718         {
 719             p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 720             vlc_object_attach( p_spu->p_scale, p_spu );
 721             p_spu->p_scale->fmt_out.video.i_chroma =
 722                 p_spu->p_scale->fmt_in.video.i_chroma =
 723                     VLC_FOURCC('Y','U','V','P');
 724             /* FIXME: We'll also be using it for YUVA and RGBA blending ... */
 725
 726             p_spu->p_scale->fmt_in.video.i_width =
 727                 p_spu->p_scale->fmt_in.video.i_height = 32;
 728             p_spu->p_scale->fmt_out.video.i_width =
 729                 p_spu->p_scale->fmt_out.video.i_height = 16;
 730
 731             p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
 732             p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
 733             p_spu->p_scale->p_module =
 734                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
 735         }
 736
 737         while( p_region )
 738         {
 739             video_format_t orig_fmt = p_region->fmt;
 740             vlc_bool_t b_rerender_text = VLC_FALSE;
 741             int i_fade_alpha = 255;
 742             int i_x_offset;
 743             int i_y_offset;
 744             int i_scale_idx   = SCALE_DEFAULT;
 745             int i_inv_scale_x = 1000;
 746             int i_inv_scale_y = 1000;
 747
 748             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
 749             {
 750                 if( p_spu->p_text && p_spu->p_text->p_module )
 751                 {
 752                     vlc_value_t  val;
 753
 754                     /* Setup 3 variables which can be used to render
 755                      * time-dependent text (and effects). The first indicates
 756                      * the total amount of time the text will be on screen,
 757                      * the second the amount of time it has already been on
 758                      * screen (can be a negative value as text is layed out
 759                      * before it is rendered) and the third is a feedback
 760                      * variable from the renderer - if the renderer sets it
 761                      * then this particular text is time-dependent, eg. the
 762                      * visual progress bar inside the text in karaoke and the
 763                      * text needs to be rendered multiple times in order for
 764                      * the effect to work - we therefore need to return the
 765                      * region to its original state at the end of the loop,
 766                      * instead of leaving it in YUVA or YUVP.
 767                      * Any renderer which is unaware of how to render
 768                      * time-dependent text can happily ignore the variables
 769                      * and render the text the same as usual - it should at
 770                      * least show up on screen, but the effect won't change
 771                      * the text over time.
 772                      */
 773
 774                     var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
 775                     val.i_time = p_subpic->i_stop - p_subpic->i_start;
 776                     var_Set( p_spu->p_text, "spu-duration", val );
 777
 778                     var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
 779                     val.i_time = mdate() - p_subpic->i_start;
 780                     var_Set( p_spu->p_text, "spu-elapsed", val );
 781
 782                     var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
 783                     var_SetBool( p_spu->p_text, "text-rerender", VLC_FALSE );
 784
 785                     var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
 786                     var_SetInteger( p_spu->p_text, "scale",
 787                               __MIN(i_scale_width_orig, i_scale_height_orig) );
 788
 789                     if( p_spu->p_text->pf_render_html && p_region->psz_html )
 790                     {
 791                         p_spu->p_text->pf_render_html( p_spu->p_text,
 792                                                        p_region, p_region );
 793                     }
 794                     else if( p_spu->p_text->pf_render_text )
 795                     {
 796                         p_spu->p_text->pf_render_text( p_spu->p_text,
 797                                                        p_region, p_region );
 798                     }
 799                     b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );
 800
 801                     var_Destroy( p_spu->p_text, "spu-duration" );
 802                     var_Destroy( p_spu->p_text, "spu-elapsed" );
 803                     var_Destroy( p_spu->p_text, "text-rerender" );
 804                     var_Destroy( p_spu->p_text, "scale" );
 805                 }
 806                 p_region->i_align |= SUBPICTURE_RENDERED;
 807             }
 808
 809             if( p_region->i_align & SUBPICTURE_RENDERED )
 810             {
 811                 i_scale_idx   = SCALE_TEXT;
 812                 i_inv_scale_x = i_scale_width_orig;
 813                 i_inv_scale_y = i_scale_height_orig;
 814             }
 815
 816             i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
 817             i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;
 818
 819             /* Force palette if requested */
 820             if( p_spu->b_force_palette &&
 821                 ( VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma ) )
 822             {
 823                 memcpy( p_region->fmt.p_palette->palette,
 824                         p_spu->palette, 16 );
 825             }
 826
 827             /* Scale SPU if necessary */
 828             if( p_region->p_cache &&
 829                 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
 830             {
 831                 if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
 832                     p_region->p_cache->fmt.i_width ||
 833                     pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
 834                     p_region->p_cache->fmt.i_height )
 835                 {
 836                     p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
 837                                                  p_region->p_cache );
 838                     p_region->p_cache = 0;
 839                 }
 840             }
 841
 842             if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
 843                   ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
 844                 ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
 845                   ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
 846                 p_spu->p_scale && !p_region->p_cache &&
 847                 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
 848             {
 849                 picture_t *p_pic;
 850
 851                 p_spu->p_scale->fmt_in.video = p_region->fmt;
 852                 p_spu->p_scale->fmt_out.video = p_region->fmt;
 853
 854                 p_region->p_cache =
 855                     p_subpic->pf_create_region( VLC_OBJECT(p_spu),
 856                         &p_spu->p_scale->fmt_out.video );
 857                 if( p_spu->p_scale->fmt_out.video.p_palette )
 858                     *p_spu->p_scale->fmt_out.video.p_palette =
 859                         *p_region->fmt.p_palette;
 860                 p_region->p_cache->p_next = p_region->p_next;
 861
 862                 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
 863                                   &p_region->picture );
 864
 865                 p_spu->p_scale->fmt_out.video.i_width =
 866                     p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
 867                 p_spu->p_scale->fmt_out.video.i_visible_width =
 868                     p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
 869                 p_spu->p_scale->fmt_out.video.i_height =
 870                     p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
 871                 p_spu->p_scale->fmt_out.video.i_visible_height =
 872                     p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
 873                 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
 874                 p_region->p_cache->i_x = p_region->i_x * pi_scale_width[ i_scale_idx ] / 1000;
 875                 p_region->p_cache->i_y = p_region->i_y * pi_scale_height[ i_scale_idx ] / 1000;
 876                 p_region->p_cache->i_align = p_region->i_align;
 877
 878                 p_pic = p_spu->p_scale->pf_video_filter(
 879                                  p_spu->p_scale, &p_region->p_cache->picture );
 880                 if( p_pic )
 881                 {
 882                     picture_t p_pic_tmp = p_region->p_cache->picture;
 883                     p_region->p_cache->picture = *p_pic;
 884                     *p_pic = p_pic_tmp;
 885                     free( p_pic );
 886                 }
 887             }
 888
 889             if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
 890                   ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
 891                 ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
 892                   ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
 893                 p_spu->p_scale && p_region->p_cache &&
 894                 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )  )
 895             {
 896                 p_region = p_region->p_cache;
 897             }
 898
 899             if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
 900             {
 901                 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
 902                     (p_subpic->i_y + p_region->i_y) * i_inv_scale_y / 1000;
 903             }
 904             else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
 905             {
 906                 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
 907             }
 908
 909             if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
 910             {
 911                 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
 912                     (pi_subpic_x[ i_scale_idx ] + p_region->i_x)
 913                     * i_inv_scale_x / 1000;
 914             }
 915             else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
 916             {
 917                 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
 918             }
 919
 920             if( p_subpic->b_absolute )
 921             {
 922                 i_x_offset = (p_region->i_x +
 923                     pi_subpic_x[ i_scale_idx ] *
 924                                      pi_scale_width[ i_scale_idx ] / 1000)
 925                     * i_inv_scale_x / 1000;
 926                 i_y_offset = (p_region->i_y +
 927                     p_subpic->i_y * pi_scale_height[ i_scale_idx ] / 1000)
 928                     * i_inv_scale_y / 1000;
 929
 930             }
 931
 932             i_x_offset = __MAX( i_x_offset, 0 );
 933             i_y_offset = __MAX( i_y_offset, 0 );
 934
 935             if( ( p_spu->i_margin != 0 ) &&
 936                 ( p_spu->b_force_crop == VLC_FALSE ) )
 937             {
 938                 int i_diff = 0;
 939                 int i_low = (i_y_offset - p_spu->i_margin) * i_inv_scale_y / 1000;
 940                 int i_high = i_low + p_region->fmt.i_height;
 941
 942                 /* crop extra margin to keep within bounds */
 943                 if( i_low < 0 )
 944                     i_diff = i_low;
 945                 if( i_high > (int)p_fmt->i_height )
 946                     i_diff = i_high - p_fmt->i_height;
 947                 i_y_offset -= ( p_spu->i_margin * i_inv_scale_y / 1000 + i_diff );
 948             }
 949
 950             if( p_subpic->b_fade )
 951             {
 952                 mtime_t i_fade_start = ( p_subpic->i_stop +
 953                                          p_subpic->i_start ) / 2;
 954                 mtime_t i_now = mdate();
 955                 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
 956                 {
 957                     i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
 958                                    ( p_subpic->i_stop - i_fade_start );
 959                 }
 960             }
 961
 962             if( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )
 963             {
 964                 if( p_spu->p_blend->fmt_in.video.i_chroma != p_region->fmt.i_chroma )
 965                 {
 966                     /* The chroma is not the same, we need to reload the blend module
 967                      * XXX to match the old behaviour just test !p_spu->p_blend->fmt_in.video.i_chroma */
 968                     if( p_spu->p_blend->p_module )
 969                         module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
 970
 971                     p_spu->p_blend->fmt_in.video = p_region->fmt;
 972                     p_spu->p_blend->p_module = module_Need( p_spu->p_blend, "video blending", 0, 0 );
 973                 }
 974                 else
 975                 {
 976                     p_spu->p_blend->fmt_in.video = p_region->fmt;
 977                 }
 978
 979                 /* Force cropping if requested */
 980                 if( p_spu->b_force_crop )
 981                 {
 982                     video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
 983                     int i_crop_x = p_spu->i_crop_x * pi_scale_width[ i_scale_idx ] / 1000
 984                                         * i_inv_scale_x / 1000;
 985                     int i_crop_y = p_spu->i_crop_y * pi_scale_height[ i_scale_idx ] / 1000
 986                                         * i_inv_scale_y / 1000;
 987                     int i_crop_width = p_spu->i_crop_width * pi_scale_width[ i_scale_idx ] / 1000
 988                                         * i_inv_scale_x / 1000;
 989                     int i_crop_height = p_spu->i_crop_height * pi_scale_height[ i_scale_idx ] / 1000
 990                                         * i_inv_scale_y / 1000;
 991
 992                     /* Find the intersection */
 993                     if( i_crop_x + i_crop_width <= i_x_offset ||
 994                         i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
 995                         i_crop_y + i_crop_height <= i_y_offset ||
 996                         i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
 997                     {
 998                         /* No intersection */
 999                         p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
1000                     }
1001                     else
1002                     {
1003                         int i_x, i_y, i_x_end, i_y_end;
1004                         i_x = __MAX( i_crop_x, i_x_offset );
1005                         i_y = __MAX( i_crop_y, i_y_offset );
1006                         i_x_end = __MIN( i_crop_x + i_crop_width,
1007                                        i_x_offset + (int)p_fmt->i_visible_width );
1008                         i_y_end = __MIN( i_crop_y + i_crop_height,
1009                                        i_y_offset + (int)p_fmt->i_visible_height );
1010
1011                         p_fmt->i_x_offset = i_x - i_x_offset;
1012                         p_fmt->i_y_offset = i_y - i_y_offset;
1013                         p_fmt->i_visible_width = i_x_end - i_x;
1014                         p_fmt->i_visible_height = i_y_end - i_y;
1015
1016                         i_x_offset = i_x;
1017                         i_y_offset = i_y;
1018                     }
1019                 }
1020
1021                 i_x_offset = __MAX( i_x_offset, 0 );
1022                 i_y_offset = __MAX( i_y_offset, 0 );
1023
1024                 /* Update the output picture size */
1025                 p_spu->p_blend->fmt_out.video.i_width =
1026                     p_spu->p_blend->fmt_out.video.i_visible_width =
1027                         p_fmt->i_width;
1028                 p_spu->p_blend->fmt_out.video.i_height =
1029                     p_spu->p_blend->fmt_out.video.i_visible_height =
1030                         p_fmt->i_height;
1031
1032                 if( p_spu->p_blend->p_module )
1033                 {
1034                     p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
1035                         p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
1036                         i_fade_alpha * p_subpic->i_alpha / 255 );
1037                 }
1038                 else
1039                 {
1040                     msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1041                              (char *)&p_spu->p_blend->fmt_out.video.i_chroma,
1042                              (char *)&p_spu->p_blend->fmt_out.video.i_chroma );
1043                 }
1044             }
1045
1046             if( b_rerender_text )
1047             {
1048                 /* Some forms of subtitles need to be re-rendered more than
1049                  * once, eg. karaoke. We therefore restore the region to its
1050                  * pre-rendered state, so the next time through everything is
1051                  * calculated again.
1052                  */
1053                 p_region->picture.pf_release( &p_region->picture );
1054                 memset( &p_region->picture, 0, sizeof( picture_t ) );
1055                 p_region->fmt = orig_fmt;
1056                 p_region->i_align &= ~SUBPICTURE_RENDERED;
1057             }
1058             p_region = p_region->p_next;
1059         }
1060
1061         p_subpic = p_subpic->p_next;
1062     }
1063
1064     vlc_mutex_unlock( &p_spu->subpicture_lock );
1065 }
1066
1067 /*****************************************************************************
1068  * spu_SortSubpictures: find the subpictures to display
1069  *****************************************************************************
1070  * This function parses all subpictures and decides which ones need to be
1071  * displayed. This operation does not need lock, since only READY_SUBPICTURE
1072  * are handled. If no picture has been selected, display_date will depend on
1073  * the subpicture.
1074  * We also check for ephemer DVD subpictures (subpictures that have
1075  * to be removed if a newer one is available), which makes it a lot
1076  * more difficult to guess if a subpicture has to be rendered or not.
1077  *****************************************************************************/
1078 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
1079                                    vlc_bool_t b_paused )
1080 {
1081     int i_index, i_channel;
1082     subpicture_t *p_subpic = NULL;
1083     subpicture_t *p_ephemer;
1084     mtime_t      ephemer_date;
1085
1086     /* Run subpicture filters */
1087     for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
1088     {
1089         subpicture_t *p_subpic_filter;
1090         p_subpic_filter = p_spu->pp_filter[i_index]->
1091             pf_sub_filter( p_spu->pp_filter[i_index], display_date );
1092         if( p_subpic_filter )
1093         {
1094             spu_DisplaySubpicture( p_spu, p_subpic_filter );
1095         }
1096     }
1097
1098     /* We get an easily parsable chained list of subpictures which
1099      * ends with NULL since p_subpic was initialized to NULL. */
1100     for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
1101     {
1102         p_ephemer = 0;
1103         ephemer_date = 0;
1104
1105         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1106         {
1107             if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
1108                 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
1109             {
1110                 continue;
1111             }
1112             if( display_date &&
1113                 display_date < p_spu->p_subpicture[i_index].i_start )
1114             {
1115                 /* Too early, come back next monday */
1116                 continue;
1117             }
1118
1119             if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
1120                 ephemer_date = p_spu->p_subpicture[i_index].i_start;
1121
1122             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
1123                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
1124                   p_spu->p_subpicture[i_index].i_stop >
1125                   p_spu->p_subpicture[i_index].i_start ) &&
1126                 !( p_spu->p_subpicture[i_index].b_pausable &&
1127                    b_paused ) )
1128             {
1129                 /* Too late, destroy the subpic */
1130                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
1131                 continue;
1132             }
1133
1134             /* If this is an ephemer subpic, add it to our list */
1135             if( p_spu->p_subpicture[i_index].b_ephemer )
1136             {
1137                 p_spu->p_subpicture[i_index].p_next = p_ephemer;
1138                 p_ephemer = &p_spu->p_subpicture[i_index];
1139
1140                 continue;
1141             }
1142
1143             p_spu->p_subpicture[i_index].p_next = p_subpic;
1144             p_subpic = &p_spu->p_subpicture[i_index];
1145         }
1146
1147         /* If we found ephemer subpictures, check if they have to be
1148          * displayed or destroyed */
1149         while( p_ephemer != NULL )
1150         {
1151             subpicture_t *p_tmp = p_ephemer;
1152             p_ephemer = p_ephemer->p_next;
1153
1154             if( p_tmp->i_start < ephemer_date )
1155             {
1156                 /* Ephemer subpicture has lived too long */
1157                 spu_DestroySubpicture( p_spu, p_tmp );
1158             }
1159             else
1160             {
1161                 /* Ephemer subpicture can still live a bit */
1162                 p_tmp->p_next = p_subpic;
1163                 p_subpic = p_tmp;
1164             }
1165         }
1166     }
1167
1168     return p_subpic;
1169 }
1170
1171 /*****************************************************************************
1172  * SpuClearChannel: clear an spu channel
1173  *****************************************************************************
1174  * This function destroys the subpictures which belong to the spu channel
1175  * corresponding to i_channel_id.
1176  *****************************************************************************/
1177 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1178 {
1179     int          i_subpic;                               /* subpicture index */
1180     subpicture_t *p_subpic = NULL;                  /* first free subpicture */
1181
1182     vlc_mutex_lock( &p_spu->subpicture_lock );
1183
1184     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1185     {
1186         p_subpic = &p_spu->p_subpicture[i_subpic];
1187         if( p_subpic->i_status == FREE_SUBPICTURE
1188             || ( p_subpic->i_status != RESERVED_SUBPICTURE
1189                  && p_subpic->i_status != READY_SUBPICTURE ) )
1190         {
1191             continue;
1192         }
1193
1194         if( p_subpic->i_channel == i_channel )
1195         {
1196             while( p_subpic->p_region )
1197             {
1198                 subpicture_region_t *p_region = p_subpic->p_region;
1199                 p_subpic->p_region = p_region->p_next;
1200                 spu_DestroyRegion( p_spu, p_region );
1201             }
1202
1203             if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
1204             p_subpic->i_status = FREE_SUBPICTURE;
1205         }
1206     }
1207
1208     vlc_mutex_unlock( &p_spu->subpicture_lock );
1209 }
1210
1211 /*****************************************************************************
1212  * spu_ControlDefault: default methods for the subpicture unit control.
1213  *****************************************************************************/
1214 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
1215 {
1216     int *pi, i;
1217
1218     switch( i_query )
1219     {
1220     case SPU_CHANNEL_REGISTER:
1221         pi = (int *)va_arg( args, int * );
1222         if( pi ) *pi = p_spu->i_channel++;
1223         break;
1224
1225     case SPU_CHANNEL_CLEAR:
1226         i = (int)va_arg( args, int );
1227         SpuClearChannel( p_spu, i );
1228         break;
1229
1230     default:
1231         msg_Dbg( p_spu, "control query not supported" );
1232         return VLC_EGENERIC;
1233     }
1234
1235     return VLC_SUCCESS;
1236 }
1237
1238 /*****************************************************************************
1239  * Object variables callbacks
1240  *****************************************************************************/
1241
1242 /*****************************************************************************
1243  * UpdateSPU: update subpicture settings
1244  *****************************************************************************
1245  * This function is called from CropCallback and at initialization time, to
1246  * retrieve crop information from the input.
1247  *****************************************************************************/
1248 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1249 {
1250     vlc_value_t val;
1251
1252     p_spu->b_force_palette = VLC_FALSE;
1253     p_spu->b_force_crop = VLC_FALSE;
1254
1255     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1256
1257     p_spu->b_force_crop = VLC_TRUE;
1258     var_Get( p_object, "x-start", &val );
1259     p_spu->i_crop_x = val.i_int;
1260     var_Get( p_object, "y-start", &val );
1261     p_spu->i_crop_y = val.i_int;
1262     var_Get( p_object, "x-end", &val );
1263     p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1264     var_Get( p_object, "y-end", &val );
1265     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1266
1267     if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1268     {
1269         memcpy( p_spu->palette, val.p_address, 16 );
1270         p_spu->b_force_palette = VLC_TRUE;
1271     }
1272
1273     msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1274              p_spu->i_crop_x, p_spu->i_crop_y,
1275              p_spu->i_crop_width, p_spu->i_crop_height,
1276              p_spu->b_force_palette );
1277 }
1278
1279 /*****************************************************************************
1280  * CropCallback: called when the highlight properties are changed
1281  *****************************************************************************
1282  * This callback is called from the input thread when we need cropping
1283  *****************************************************************************/
1284 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1285                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1286 {
1287     (void)psz_var; (void)oldval; (void)newval;
1288     UpdateSPU( (spu_t *)p_data, p_object );
1289     return VLC_SUCCESS;
1290 }
1291
1292 /*****************************************************************************
1293  * Buffers allocation callbacks for the filters
1294  *****************************************************************************/
1295 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1296 {
1297     filter_owner_sys_t *p_sys = p_filter->p_owner;
1298     subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1299     if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1300     return p_subpicture;
1301 }
1302
1303 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1304 {
1305     filter_owner_sys_t *p_sys = p_filter->p_owner;
1306     spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1307 }
1308
1309 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1310 {
1311     (void)p_filter;
1312     subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1313     if( !p_subpic ) return NULL;
1314     memset( p_subpic, 0, sizeof(subpicture_t) );
1315     p_subpic->b_absolute = VLC_TRUE;
1316
1317     p_subpic->pf_create_region = __spu_CreateRegion;
1318     p_subpic->pf_make_region = __spu_MakeRegion;
1319     p_subpic->pf_destroy_region = __spu_DestroyRegion;
1320
1321     return p_subpic;
1322 }
1323
1324 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1325 {
1326     while( p_subpic->p_region )
1327     {
1328         subpicture_region_t *p_region = p_subpic->p_region;
1329         p_subpic->p_region = p_region->p_next;
1330         p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1331     }
1332
1333     free( p_subpic );
1334 }
1335
1336 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1337 {
1338     picture_t *p_picture = malloc( sizeof(picture_t) );
1339     if( !p_picture ) return NULL;
1340     if( vout_AllocatePicture( p_filter, p_picture,
1341                               p_filter->fmt_out.video.i_chroma,
1342                               p_filter->fmt_out.video.i_width,
1343                               p_filter->fmt_out.video.i_height,
1344                               p_filter->fmt_out.video.i_aspect )
1345         != VLC_SUCCESS )
1346     {
1347         free( p_picture );
1348         return NULL;
1349     }
1350
1351     p_picture->pf_release = RegionPictureRelease;
1352
1353     return p_picture;
1354 }
1355
1356 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1357 {
1358     (void)p_filter;
1359     if( p_pic )
1360     {
1361         if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
1362         free( p_pic );
1363     }
1364 }
1365
1366 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1367                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1368 {
1369     (void)p_object; (void)oldval; (void)newval;
1370
1371     spu_t *p_spu = (spu_t *)p_data;
1372     vlc_mutex_lock( &p_spu->subpicture_lock );
1373     spu_DeleteChain( p_spu );
1374     spu_ParseChain( p_spu );
1375     vlc_mutex_unlock( &p_spu->subpicture_lock );
1376     return VLC_SUCCESS;
1377 }