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