git.sesse.net Git - vlc/blob - src/video_output/vout_subpictures.c

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