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

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