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