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-2004 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 an SPU margin, we force the position. */
 105     var_Create( p_spu, "spumargin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 106     var_Get( p_spu, "spumargin", &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
 261     if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
 262         p_fmt->p_palette = p_region->fmt.p_palette =
 263             malloc( sizeof(video_palette_t) );
 264     else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
 265
 266     p_region->picture.p_data_orig = 0;
 267
 268     if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
 269
 270     vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
 271                           p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
 272
 273     if( !p_region->picture.i_planes )
 274     {
 275         free( p_region );
 276         free( p_fmt->p_palette );
 277         return NULL;
 278     }
 279
 280     p_region->picture.pf_release = RegionPictureRelease;
 281
 282     return p_region;
 283 }
 284
 285 /**
 286  * Destroy a subpicture region
 287  *
 288  * \param p_this vlc_object_t
 289  * \param p_region the subpicture region to destroy
 290  */
 291 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
 292 {
 293     if( !p_region ) return;
 294     if( p_region->picture.pf_release )
 295         p_region->picture.pf_release( &p_region->picture );
 296     if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
 297     if( p_region->psz_text ) free( p_region->psz_text );
 298     if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
 299     free( p_region );
 300 }
 301
 302 /**
 303  * Display a subpicture
 304  *
 305  * Remove the reservation flag of a subpicture, which will cause it to be
 306  * ready for display.
 307  * \param p_spu the subpicture unit object
 308  * \param p_subpic the subpicture to display
 309  */
 310 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
 311 {
 312     /* Check if status is valid */
 313     if( p_subpic->i_status != RESERVED_SUBPICTURE )
 314     {
 315         msg_Err( p_spu, "subpicture %p has invalid status #%d",
 316                  p_subpic, p_subpic->i_status );
 317     }
 318
 319     /* Remove reservation flag */
 320     p_subpic->i_status = READY_SUBPICTURE;
 321
 322     if( p_subpic->i_channel == DEFAULT_CHAN )
 323     {
 324         p_subpic->i_channel = 0xFFFF;
 325         spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
 326         p_subpic->i_channel = DEFAULT_CHAN;
 327     }
 328 }
 329
 330 /**
 331  * Allocate a subpicture in the spu heap.
 332  *
 333  * This function create a reserved subpicture in the spu heap.
 334  * A null pointer is returned if the function fails. This method provides an
 335  * already allocated zone of memory in the spu data fields. It needs locking
 336  * since several pictures can be created by several producers threads.
 337  * \param p_spu the subpicture unit in which to create the subpicture
 338  * \return NULL on error, a reserved subpicture otherwise
 339  */
 340 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
 341 {
 342     int                 i_subpic;                        /* subpicture index */
 343     subpicture_t *      p_subpic = NULL;            /* first free subpicture */
 344
 345     /* Get lock */
 346     vlc_mutex_lock( &p_spu->subpicture_lock );
 347
 348     /*
 349      * Look for an empty place
 350      */
 351     p_subpic = NULL;
 352     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 353     {
 354         if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
 355         {
 356             /* Subpicture is empty and ready for allocation */
 357             p_subpic = &p_spu->p_subpicture[i_subpic];
 358             p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
 359             break;
 360         }
 361     }
 362
 363     /* If no free subpicture could be found */
 364     if( p_subpic == NULL )
 365     {
 366         msg_Err( p_spu, "subpicture heap is full" );
 367         vlc_mutex_unlock( &p_spu->subpicture_lock );
 368         return NULL;
 369     }
 370
 371     /* Copy subpicture information, set some default values */
 372     memset( p_subpic, 0, sizeof(subpicture_t) );
 373     p_subpic->i_status   = RESERVED_SUBPICTURE;
 374     p_subpic->b_absolute = VLC_TRUE;
 375     p_subpic->b_fade     = VLC_FALSE;
 376     p_subpic->pf_render  = 0;
 377     p_subpic->pf_destroy = 0;
 378     p_subpic->p_sys      = 0;
 379
 380     vlc_mutex_unlock( &p_spu->subpicture_lock );
 381
 382     p_subpic->pf_create_region = __spu_CreateRegion;
 383     p_subpic->pf_destroy_region = __spu_DestroyRegion;
 384
 385     return p_subpic;
 386 }
 387
 388 /**
 389  * Remove a subpicture from the heap
 390  *
 391  * This function frees a previously reserved subpicture.
 392  * It is meant to be used when the construction of a picture aborted.
 393  * This function does not need locking since reserved subpictures are ignored
 394  * by the spu.
 395  */
 396 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
 397 {
 398     /* Get lock */
 399     vlc_mutex_lock( &p_spu->subpicture_lock );
 400
 401     /* There can be race conditions so we need to check the status */
 402     if( p_subpic->i_status == FREE_SUBPICTURE )
 403     {
 404         vlc_mutex_unlock( &p_spu->subpicture_lock );
 405         return;
 406     }
 407
 408     /* Check if status is valid */
 409     if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
 410            && ( p_subpic->i_status != READY_SUBPICTURE ) )
 411     {
 412         msg_Err( p_spu, "subpicture %p has invalid status %d",
 413                          p_subpic, p_subpic->i_status );
 414     }
 415
 416     while( p_subpic->p_region )
 417     {
 418         subpicture_region_t *p_region = p_subpic->p_region;
 419         p_subpic->p_region = p_region->p_next;
 420         spu_DestroyRegion( p_spu, p_region );
 421     }
 422
 423     if( p_subpic->pf_destroy )
 424     {
 425         p_subpic->pf_destroy( p_subpic );
 426     }
 427
 428     p_subpic->i_status = FREE_SUBPICTURE;
 429
 430     vlc_mutex_unlock( &p_spu->subpicture_lock );
 431 }
 432
 433 /*****************************************************************************
 434  * spu_RenderSubpictures: render a subpicture list
 435  *****************************************************************************
 436  * This function renders all sub picture units in the list.
 437  *****************************************************************************/
 438 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
 439                             picture_t *p_pic_dst, picture_t *p_pic_src,
 440                             subpicture_t *p_subpic,
 441                             int i_scale_width_orig, int i_scale_height_orig )
 442 {
 443     /* Get lock */
 444     vlc_mutex_lock( &p_spu->subpicture_lock );
 445
 446     /* Check i_status again to make sure spudec hasn't destroyed the subpic */
 447     while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
 448     {
 449         subpicture_region_t *p_region = p_subpic->p_region;
 450         int i_scale_width, i_scale_height;
 451
 452         /* Load the blending module */
 453         if( !p_spu->p_blend && p_region )
 454         {
 455             p_spu->p_blend = vlc_object_create( p_spu, sizeof(filter_t) );
 456             vlc_object_attach( p_spu->p_blend, p_spu );
 457             p_spu->p_blend->fmt_out.video.i_x_offset =
 458                 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
 459             p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
 460             p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
 461
 462             p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
 463
 464             p_spu->p_blend->p_module =
 465                 module_Need( p_spu->p_blend, "video blending", 0, 0 );
 466         }
 467
 468         /* Load the text rendering module */
 469         if( !p_spu->p_text && p_region )
 470         {
 471             p_spu->p_text = vlc_object_create( p_spu, sizeof(filter_t) );
 472             vlc_object_attach( p_spu->p_text, p_spu );
 473
 474             p_spu->p_text->fmt_out.video.i_width =
 475                 p_spu->p_text->fmt_out.video.i_visible_width =
 476                     p_fmt->i_width;
 477             p_spu->p_text->fmt_out.video.i_height =
 478                 p_spu->p_text->fmt_out.video.i_visible_height =
 479                     p_fmt->i_height;
 480
 481             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
 482             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
 483
 484             p_spu->p_text->p_module =
 485                 module_Need( p_spu->p_text, "text renderer", 0, 0 );
 486         }
 487
 488         i_scale_width = i_scale_width_orig;
 489         i_scale_height = i_scale_height_orig;
 490
 491         if( p_subpic->i_original_picture_width &&
 492             p_subpic->i_original_picture_height )
 493         {
 494             i_scale_width = i_scale_width * p_fmt->i_width /
 495                 p_subpic->i_original_picture_width;
 496             i_scale_height = i_scale_height * p_fmt->i_height /
 497                 p_subpic->i_original_picture_height;
 498         }
 499
 500         /* Load the scaling module */
 501         if( !p_spu->p_scale && (i_scale_width != 1000 ||
 502             i_scale_height != 1000) )
 503         {
 504             p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 505             vlc_object_attach( p_spu->p_scale, p_spu );
 506             p_spu->p_scale->fmt_out.video.i_chroma =
 507                 p_spu->p_scale->fmt_in.video.i_chroma =
 508                     VLC_FOURCC('Y','U','V','P');
 509             p_spu->p_scale->fmt_in.video.i_width =
 510                 p_spu->p_scale->fmt_in.video.i_height = 32;
 511             p_spu->p_scale->fmt_out.video.i_width =
 512                 p_spu->p_scale->fmt_out.video.i_height = 16;
 513
 514             p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
 515             p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
 516             p_spu->p_scale->p_module =
 517                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
 518         }
 519
 520         if( p_subpic->pf_render )
 521         {
 522             /* HACK to remove when the ogt subpic decoder is gone */
 523             if( p_spu->p_parent &&
 524                 p_spu->p_parent->i_object_type == VLC_OBJECT_VOUT )
 525             {
 526                 vout_thread_t *p_vout = (vout_thread_t *)p_spu->p_parent;
 527                 p_subpic->pf_render( p_vout, p_pic_dst, p_subpic );
 528             }
 529         }
 530         else while( p_region && p_spu->p_blend &&
 531                     p_spu->p_blend->pf_video_blend )
 532         {
 533             int i_fade_alpha = 255;
 534             int i_x_offset = p_region->i_x + p_subpic->i_x;
 535             int i_y_offset = p_region->i_y + p_subpic->i_y;
 536
 537             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
 538             {
 539                 if( p_spu->p_text && p_spu->p_text->p_module &&
 540                     p_spu->p_text->pf_render_string )
 541                 {
 542                     /* TODO: do it in a less hacky way
 543                      * (modify text renderer API) */
 544                     subpicture_t *p_subpic_tmp;
 545                     subpicture_region_t tmp_region;
 546                     block_t *p_new_block =
 547                         block_New( p_spu, strlen(p_region->psz_text) + 1 );
 548
 549                     if( p_new_block )
 550                     {
 551                         memcpy( p_new_block->p_buffer, p_region->psz_text,
 552                                 p_new_block->i_buffer );
 553                         p_new_block->i_pts = p_new_block->i_dts =
 554                             p_subpic->i_start;
 555                         p_new_block->i_length =
 556                             p_subpic->i_start - p_subpic->i_stop;
 557                         p_subpic_tmp = p_spu->p_text->pf_render_string(
 558                             p_spu->p_text, p_new_block );
 559
 560                         if( p_subpic_tmp )
 561                         {
 562                             tmp_region = *p_region;
 563                             *p_region = *p_subpic_tmp->p_region;
 564                             p_region->p_next = tmp_region.p_next;
 565                             *p_subpic_tmp->p_region = tmp_region;
 566                             p_spu->p_text->pf_sub_buffer_del( p_spu->p_text,
 567                                                               p_subpic_tmp );
 568                         }
 569                     }
 570                 }
 571             }
 572
 573             /* Force palette if requested */
 574             if( p_spu->b_force_alpha && VLC_FOURCC('Y','U','V','P') ==
 575                 p_region->fmt.i_chroma )
 576             {
 577                 p_region->fmt.p_palette->palette[0][3] = p_spu->pi_alpha[0];
 578                 p_region->fmt.p_palette->palette[1][3] = p_spu->pi_alpha[1];
 579                 p_region->fmt.p_palette->palette[2][3] = p_spu->pi_alpha[2];
 580                 p_region->fmt.p_palette->palette[3][3] = p_spu->pi_alpha[3];
 581             }
 582
 583             /* Scale SPU if necessary */
 584             if( p_region->p_cache )
 585             {
 586                 if( i_scale_width * p_region->fmt.i_width / 1000 !=
 587                     p_region->p_cache->fmt.i_width ||
 588                     i_scale_height * p_region->fmt.i_height / 1000 !=
 589                     p_region->p_cache->fmt.i_height )
 590                 {
 591                     p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
 592                                                  p_region->p_cache );
 593                     p_region->p_cache = 0;
 594                 }
 595             }
 596             if( (i_scale_width != 1000 || i_scale_height != 1000) &&
 597                 p_spu->p_scale && !p_region->p_cache )
 598             {
 599                 picture_t *p_pic;
 600
 601                 p_spu->p_scale->fmt_in.video = p_region->fmt;
 602                 p_spu->p_scale->fmt_out.video = p_region->fmt;
 603
 604                 p_region->p_cache =
 605                     p_subpic->pf_create_region( VLC_OBJECT(p_spu),
 606                         &p_spu->p_scale->fmt_out.video );
 607                 if( p_spu->p_scale->fmt_out.video.p_palette )
 608                     *p_spu->p_scale->fmt_out.video.p_palette =
 609                         *p_region->fmt.p_palette;
 610                 p_region->p_cache->p_next = p_region->p_next;
 611
 612                 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
 613                                   &p_region->picture );
 614
 615                 p_spu->p_scale->fmt_out.video.i_width =
 616                     p_region->fmt.i_width * i_scale_width / 1000;
 617                 p_spu->p_scale->fmt_out.video.i_visible_width =
 618                     p_region->fmt.i_visible_width * i_scale_width / 1000;
 619                 p_spu->p_scale->fmt_out.video.i_height =
 620                     p_region->fmt.i_height * i_scale_height / 1000;
 621                 p_spu->p_scale->fmt_out.video.i_visible_height =
 622                     p_region->fmt.i_visible_height * i_scale_height / 1000;
 623                 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
 624                 p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
 625                 p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
 626
 627                 p_pic = p_spu->p_scale->pf_video_filter(
 628                                  p_spu->p_scale, &p_region->p_cache->picture );
 629                 if( p_pic )
 630                 {
 631                     picture_t p_pic_tmp = p_region->p_cache->picture;
 632                     p_region->p_cache->picture = *p_pic;
 633                     *p_pic = p_pic_tmp;
 634                     free( p_pic );
 635                 }
 636             }
 637             if( (i_scale_width != 1000 || i_scale_height != 1000) &&
 638                 p_spu->p_scale && p_region->p_cache )
 639             {
 640                 p_region = p_region->p_cache;
 641             }
 642
 643             if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
 644             {
 645                 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
 646                     p_subpic->i_y;
 647             }
 648             else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
 649             {
 650                 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
 651             }
 652
 653             if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
 654             {
 655                 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
 656                     p_subpic->i_x;
 657             }
 658             else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
 659             {
 660                 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
 661             }
 662
 663             if( p_subpic->b_absolute )
 664             {
 665                 i_x_offset = p_region->i_x +
 666                     p_subpic->i_x * i_scale_width / 1000;
 667                 i_y_offset = p_region->i_y +
 668                     p_subpic->i_y * i_scale_height / 1000;
 669
 670                 if( p_spu->i_margin >= 0 )
 671                 {
 672                     if( p_subpic->i_height + (unsigned int)p_spu->i_margin <=
 673                         p_fmt->i_height )
 674                     {
 675                         i_y_offset = p_fmt->i_height -
 676                             p_spu->i_margin - p_subpic->i_height;
 677                     }
 678                 }
 679             }
 680
 681             p_spu->p_blend->fmt_in.video = p_region->fmt;
 682
 683             /* Force cropping if requested */
 684             if( p_spu->b_force_crop )
 685             {
 686                 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
 687                 int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
 688                 int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
 689                 int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
 690                 int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
 691
 692                 /* Find the intersection */
 693                 if( i_crop_x + i_crop_width <= i_x_offset ||
 694                     i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
 695                     i_crop_y + i_crop_height <= i_y_offset ||
 696                     i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
 697                 {
 698                     /* No intersection */
 699                     p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
 700                 }
 701                 else
 702                 {
 703                     int i_x, i_y, i_x_end, i_y_end;
 704                     i_x = __MAX( i_crop_x, i_x_offset );
 705                     i_y = __MAX( i_crop_y, i_y_offset );
 706                     i_x_end = __MIN( i_crop_x + i_crop_width,
 707                                    i_x_offset + (int)p_fmt->i_visible_width );
 708                     i_y_end = __MIN( i_crop_y + i_crop_height,
 709                                    i_y_offset + (int)p_fmt->i_visible_height );
 710
 711                     p_fmt->i_x_offset = i_x - i_x_offset;
 712                     p_fmt->i_y_offset = i_y - i_y_offset;
 713                     p_fmt->i_visible_width = i_x_end - i_x;
 714                     p_fmt->i_visible_height = i_y_end - i_y;
 715
 716                     i_x_offset = i_x;
 717                     i_y_offset = i_y;
 718                 }
 719             }
 720
 721             /* Update the output picture size */
 722             p_spu->p_blend->fmt_out.video.i_width =
 723                 p_spu->p_blend->fmt_out.video.i_visible_width =
 724                     p_fmt->i_width;
 725             p_spu->p_blend->fmt_out.video.i_height =
 726                 p_spu->p_blend->fmt_out.video.i_visible_height =
 727                     p_fmt->i_height;
 728
 729             if( p_subpic->b_fade )
 730             {
 731                 mtime_t i_fade_start = ( p_subpic->i_stop +
 732                                          p_subpic->i_start ) / 2;
 733                 mtime_t i_now = mdate();
 734                 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
 735                 {
 736                     i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
 737                                    ( p_subpic->i_stop - i_fade_start );
 738                 }
 739             }
 740
 741             p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
 742                 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
 743                 i_fade_alpha );
 744
 745             p_region = p_region->p_next;
 746         }
 747
 748         p_subpic = p_subpic->p_next;
 749     }
 750
 751     vlc_mutex_unlock( &p_spu->subpicture_lock );
 752 }
 753
 754 /*****************************************************************************
 755  * spu_SortSubpictures: find the subpictures to display
 756  *****************************************************************************
 757  * This function parses all subpictures and decides which ones need to be
 758  * displayed. This operation does not need lock, since only READY_SUBPICTURE
 759  * are handled. If no picture has been selected, display_date will depend on
 760  * the subpicture.
 761  * We also check for ephemer DVD subpictures (subpictures that have
 762  * to be removed if a newer one is available), which makes it a lot
 763  * more difficult to guess if a subpicture has to be rendered or not.
 764  *****************************************************************************/
 765 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
 766 {
 767     int i_index, i_channel;
 768     subpicture_t *p_subpic = NULL;
 769     subpicture_t *p_ephemer;
 770     mtime_t      ephemer_date;
 771
 772     /* Run subpicture filters */
 773     for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
 774     {
 775         subpicture_t *p_subpic_filter;
 776         p_subpic_filter = p_spu->pp_filter[i_index]->
 777             pf_sub_filter( p_spu->pp_filter[i_index], display_date );
 778         if( p_subpic_filter )
 779         {
 780             spu_DisplaySubpicture( p_spu, p_subpic_filter );
 781         }
 782     }
 783
 784     /* We get an easily parsable chained list of subpictures which
 785      * ends with NULL since p_subpic was initialized to NULL. */
 786     for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
 787     {
 788         p_ephemer = 0;
 789         ephemer_date = 0;
 790
 791         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
 792         {
 793             if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
 794                 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
 795             {
 796                 continue;
 797             }
 798
 799             if( display_date &&
 800                 display_date < p_spu->p_subpicture[i_index].i_start )
 801             {
 802                 /* Too early, come back next monday */
 803                 continue;
 804             }
 805
 806             if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
 807                 ephemer_date = p_spu->p_subpicture[i_index].i_start;
 808
 809             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
 810                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
 811                   p_spu->p_subpicture[i_index].i_stop >
 812                   p_spu->p_subpicture[i_index].i_start ) )
 813             {
 814                 /* Too late, destroy the subpic */
 815                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
 816                 continue;
 817             }
 818
 819             /* If this is an ephemer subpic, add it to our list */
 820             if( p_spu->p_subpicture[i_index].b_ephemer )
 821             {
 822                 p_spu->p_subpicture[i_index].p_next = p_ephemer;
 823                 p_ephemer = &p_spu->p_subpicture[i_index];
 824
 825                 continue;
 826             }
 827
 828             p_spu->p_subpicture[i_index].p_next = p_subpic;
 829             p_subpic = &p_spu->p_subpicture[i_index];
 830         }
 831
 832         /* If we found ephemer subpictures, check if they have to be
 833          * displayed or destroyed */
 834         while( p_ephemer != NULL )
 835         {
 836             subpicture_t *p_tmp = p_ephemer;
 837             p_ephemer = p_ephemer->p_next;
 838
 839             if( p_tmp->i_start < ephemer_date )
 840             {
 841                 /* Ephemer subpicture has lived too long */
 842                 spu_DestroySubpicture( p_spu, p_tmp );
 843             }
 844             else
 845             {
 846                 /* Ephemer subpicture can still live a bit */
 847                 p_tmp->p_next = p_subpic;
 848                 p_subpic = p_tmp;
 849             }
 850         }
 851     }
 852
 853     return p_subpic;
 854 }
 855
 856 /*****************************************************************************
 857  * SpuClearChannel: clear an spu channel
 858  *****************************************************************************
 859  * This function destroys the subpictures which belong to the spu channel
 860  * corresponding to i_channel_id.
 861  *****************************************************************************/
 862 static void SpuClearChannel( spu_t *p_spu, int i_channel )
 863 {
 864     int          i_subpic;                               /* subpicture index */
 865     subpicture_t *p_subpic = NULL;                  /* first free subpicture */
 866
 867     vlc_mutex_lock( &p_spu->subpicture_lock );
 868
 869     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 870     {
 871         p_subpic = &p_spu->p_subpicture[i_subpic];
 872         if( p_subpic->i_status == FREE_SUBPICTURE
 873             || ( p_subpic->i_status != RESERVED_SUBPICTURE
 874                  && p_subpic->i_status != READY_SUBPICTURE ) )
 875         {
 876             continue;
 877         }
 878
 879         if( p_subpic->i_channel == i_channel )
 880         {
 881             while( p_subpic->p_region )
 882             {
 883                 subpicture_region_t *p_region = p_subpic->p_region;
 884                 p_subpic->p_region = p_region->p_next;
 885                 spu_DestroyRegion( p_spu, p_region );
 886             }
 887
 888             if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
 889             p_subpic->i_status = FREE_SUBPICTURE;
 890         }
 891     }
 892
 893     vlc_mutex_unlock( &p_spu->subpicture_lock );
 894 }
 895
 896 /*****************************************************************************
 897  * spu_ControlDefault: default methods for the subpicture unit control.
 898  *****************************************************************************/
 899 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
 900 {
 901     int *pi, i;
 902
 903     switch( i_query )
 904     {
 905     case SPU_CHANNEL_REGISTER:
 906         pi = (int *)va_arg( args, int * );
 907         if( pi ) *pi = p_spu->i_channel++;
 908         msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
 909                  p_spu->i_channel - 1 );
 910         break;
 911
 912     case SPU_CHANNEL_CLEAR:
 913         i = (int)va_arg( args, int );
 914         SpuClearChannel( p_spu, i );
 915         break;
 916
 917     default:
 918         msg_Dbg( p_spu, "control query not supported" );
 919         return VLC_EGENERIC;
 920     }
 921
 922     return VLC_SUCCESS;
 923 }
 924
 925 /*****************************************************************************
 926  * Object variables callbacks
 927  *****************************************************************************/
 928
 929 /*****************************************************************************
 930  * UpdateSPU: update subpicture settings
 931  *****************************************************************************
 932  * This function is called from CropCallback and at initialization time, to
 933  * retrieve crop information from the input.
 934  *****************************************************************************/
 935 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
 936 {
 937     vlc_value_t val;
 938
 939     p_spu->b_force_alpha = VLC_FALSE;
 940     p_spu->b_force_crop = VLC_FALSE;
 941
 942     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
 943
 944     p_spu->b_force_crop = VLC_TRUE;
 945     var_Get( p_object, "x-start", &val );
 946     p_spu->i_crop_x = val.i_int;
 947     var_Get( p_object, "y-start", &val );
 948     p_spu->i_crop_y = val.i_int;
 949     var_Get( p_object, "x-end", &val );
 950     p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
 951     var_Get( p_object, "y-end", &val );
 952     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
 953
 954 #if 0
 955     if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
 956     {
 957         int i;
 958         for( i = 0; i < 4; i++ )
 959         {
 960             p_spu->pi_color[i] = ((uint8_t *)val.p_address)[i];
 961         }
 962     }
 963 #endif
 964
 965     if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
 966     {
 967         int i;
 968         for( i = 0; i < 4; i++ )
 969         {
 970             p_spu->pi_alpha[i] = ((uint8_t *)val.p_address)[i];
 971             p_spu->pi_alpha[i] = p_spu->pi_alpha[i] == 0xf ?
 972                 0xff : p_spu->pi_alpha[i] << 4;
 973         }
 974         p_spu->b_force_alpha = VLC_TRUE;
 975     }
 976
 977     msg_Dbg( p_object, "crop: %i,%i,%i,%i, alpha: %i",
 978              p_spu->i_crop_x, p_spu->i_crop_y,
 979              p_spu->i_crop_width, p_spu->i_crop_height, p_spu->b_force_alpha );
 980 }
 981
 982 /*****************************************************************************
 983  * CropCallback: called when the highlight properties are changed
 984  *****************************************************************************
 985  * This callback is called from the input thread when we need cropping
 986  *****************************************************************************/
 987 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
 988                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 989 {
 990     UpdateSPU( (spu_t *)p_data, p_object );
 991     return VLC_SUCCESS;
 992 }
 993
 994 /*****************************************************************************
 995  * Buffers allocation callbacks for the filters
 996  *****************************************************************************/
 997 static subpicture_t *sub_new_buffer( filter_t *p_filter )
 998 {
 999     filter_owner_sys_t *p_sys = p_filter->p_owner;
1000     subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1001     if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1002     return p_subpicture;
1003 }
1004
1005 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1006 {
1007     filter_owner_sys_t *p_sys = p_filter->p_owner;
1008     spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1009 }
1010
1011 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1012 {
1013     subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1014     memset( p_subpic, 0, sizeof(subpicture_t) );
1015     p_subpic->b_absolute = VLC_TRUE;
1016
1017     p_subpic->pf_create_region = __spu_CreateRegion;
1018     p_subpic->pf_destroy_region = __spu_DestroyRegion;
1019
1020     return p_subpic;
1021 }
1022
1023 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1024 {
1025     while( p_subpic->p_region )
1026     {
1027         subpicture_region_t *p_region = p_subpic->p_region;
1028         p_subpic->p_region = p_region->p_next;
1029         p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1030     }
1031
1032     free( p_subpic );
1033 }
1034
1035 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1036 {
1037     picture_t *p_picture = malloc( sizeof(picture_t) );
1038
1039     if( vout_AllocatePicture( p_filter, p_picture,
1040                               p_filter->fmt_out.video.i_chroma,
1041                               p_filter->fmt_out.video.i_width,
1042                               p_filter->fmt_out.video.i_height,
1043                               p_filter->fmt_out.video.i_aspect )
1044         != VLC_SUCCESS )
1045     {
1046         free( p_picture );
1047         return NULL;
1048     }
1049
1050     p_picture->pf_release = RegionPictureRelease;
1051
1052     return p_picture;
1053 }
1054
1055 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1056 {
1057     if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1058     if( p_pic ) free( p_pic );
1059 }