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