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