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 && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
 501         {
 502             char *psz_modulename = NULL;
 503
 504             p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 505             vlc_object_attach( p_spu->p_text, p_spu );
 506
 507             p_spu->p_text->fmt_out.video.i_width =
 508                 p_spu->p_text->fmt_out.video.i_visible_width =
 509                 p_fmt->i_width;
 510             p_spu->p_text->fmt_out.video.i_height =
 511                 p_spu->p_text->fmt_out.video.i_visible_height =
 512                 p_fmt->i_height;
 513
 514             p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
 515             p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
 516
 517             psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
 518             if( psz_modulename && *psz_modulename )
 519             {
 520                 p_spu->p_text->p_module =
 521                     module_Need( p_spu->p_text, "text renderer", psz_modulename, VLC_TRUE );
 522             }
 523             if( !p_spu->p_text->p_module )
 524             {
 525                 p_spu->p_text->p_module =
 526                     module_Need( p_spu->p_text, "text renderer", 0, 0 );
 527             }
 528             if( psz_modulename ) free( psz_modulename );
 529         }
 530         if( p_spu->p_text )
 531         {
 532             if( p_subpic->i_original_picture_height > 0 &&
 533                 p_subpic->i_original_picture_width  > 0 )
 534             {
 535                 p_spu->p_text->fmt_out.video.i_width =
 536                     p_spu->p_text->fmt_out.video.i_visible_width =
 537                     p_subpic->i_original_picture_width;
 538                 p_spu->p_text->fmt_out.video.i_height =
 539                     p_spu->p_text->fmt_out.video.i_visible_height =
 540                     p_subpic->i_original_picture_height;
 541             }
 542             else
 543             {
 544                 p_spu->p_text->fmt_out.video.i_width =
 545                     p_spu->p_text->fmt_out.video.i_visible_width =
 546                     p_fmt->i_width;
 547                 p_spu->p_text->fmt_out.video.i_height =
 548                     p_spu->p_text->fmt_out.video.i_visible_height =
 549                     p_fmt->i_height;
 550             }
 551         }
 552
 553         i_scale_width = i_scale_width_orig;
 554         i_scale_height = i_scale_height_orig;
 555
 556         if( p_subpic->i_original_picture_height > 0 &&
 557             p_subpic->i_original_picture_width  > 0 )
 558         {
 559             i_scale_width = i_scale_width * p_fmt->i_width /
 560                              p_subpic->i_original_picture_width;
 561             i_scale_height = i_scale_height * p_fmt->i_height /
 562                              p_subpic->i_original_picture_height;
 563         }
 564         else if( p_subpic->i_original_picture_height > 0 )
 565         {
 566             i_scale_height = i_scale_height * p_fmt->i_height /
 567                              p_subpic->i_original_picture_height;
 568             i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height;
 569         }
 570
 571         /* Set default subpicture aspect ratio */
 572         if( p_region && p_region->fmt.i_aspect &&
 573             (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
 574         {
 575             p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
 576             p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
 577         }
 578         if( p_region &&
 579             (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
 580         {
 581             p_region->fmt.i_sar_den = p_fmt->i_sar_den;
 582             p_region->fmt.i_sar_num = p_fmt->i_sar_num;
 583         }
 584
 585         /* Take care of the aspect ratio */
 586         if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
 587             p_region->fmt.i_sar_den * p_fmt->i_sar_num )
 588         {
 589             i_scale_width = i_scale_width *
 590                 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
 591                 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
 592             i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
 593         }
 594
 595         /* Load the scaling module */
 596         if( !p_spu->p_scale && (i_scale_width != 1000 ||
 597             i_scale_height != 1000) )
 598         {
 599             p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
 600             vlc_object_attach( p_spu->p_scale, p_spu );
 601             p_spu->p_scale->fmt_out.video.i_chroma =
 602                 p_spu->p_scale->fmt_in.video.i_chroma =
 603                     VLC_FOURCC('Y','U','V','P');
 604             p_spu->p_scale->fmt_in.video.i_width =
 605                 p_spu->p_scale->fmt_in.video.i_height = 32;
 606             p_spu->p_scale->fmt_out.video.i_width =
 607                 p_spu->p_scale->fmt_out.video.i_height = 16;
 608
 609             p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
 610             p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
 611             p_spu->p_scale->p_module =
 612                 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
 613         }
 614
 615         while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
 616         {
 617             int i_fade_alpha = 255;
 618             int i_x_offset = p_region->i_x + i_subpic_x;
 619             int i_y_offset = p_region->i_y + p_subpic->i_y;
 620
 621             if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
 622             {
 623                 if( p_spu->p_text && p_spu->p_text->p_module &&
 624                     p_spu->p_text->pf_render_text )
 625                 {
 626                     p_region->i_align = p_subpic->i_flags;
 627                     p_spu->p_text->pf_render_text( p_spu->p_text,
 628                                                    p_region, p_region );
 629                 }
 630             }
 631
 632             /* Force palette if requested */
 633             if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
 634                 p_region->fmt.i_chroma )
 635             {
 636                 memcpy( p_region->fmt.p_palette->palette,
 637                         p_spu->palette, 16 );
 638             }
 639
 640             /* Scale SPU if necessary */
 641             if( p_region->p_cache )
 642             {
 643                 if( i_scale_width * p_region->fmt.i_width / 1000 !=
 644                     p_region->p_cache->fmt.i_width ||
 645                     i_scale_height * p_region->fmt.i_height / 1000 !=
 646                     p_region->p_cache->fmt.i_height )
 647                 {
 648                     p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
 649                                                  p_region->p_cache );
 650                     p_region->p_cache = 0;
 651                 }
 652             }
 653
 654             if( (i_scale_width != 1000 || i_scale_height != 1000) &&
 655                 p_spu->p_scale && !p_region->p_cache )
 656             {
 657                 picture_t *p_pic;
 658
 659                 p_spu->p_scale->fmt_in.video = p_region->fmt;
 660                 p_spu->p_scale->fmt_out.video = p_region->fmt;
 661
 662                 p_region->p_cache =
 663                     p_subpic->pf_create_region( VLC_OBJECT(p_spu),
 664                         &p_spu->p_scale->fmt_out.video );
 665                 if( p_spu->p_scale->fmt_out.video.p_palette )
 666                     *p_spu->p_scale->fmt_out.video.p_palette =
 667                         *p_region->fmt.p_palette;
 668                 p_region->p_cache->p_next = p_region->p_next;
 669
 670                 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
 671                                   &p_region->picture );
 672
 673                 p_spu->p_scale->fmt_out.video.i_width =
 674                     p_region->fmt.i_width * i_scale_width / 1000;
 675                 p_spu->p_scale->fmt_out.video.i_visible_width =
 676                     p_region->fmt.i_visible_width * i_scale_width / 1000;
 677                 p_spu->p_scale->fmt_out.video.i_height =
 678                     p_region->fmt.i_height * i_scale_height / 1000;
 679                 p_spu->p_scale->fmt_out.video.i_visible_height =
 680                     p_region->fmt.i_visible_height * i_scale_height / 1000;
 681                 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
 682                 p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
 683                 p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
 684
 685                 p_pic = p_spu->p_scale->pf_video_filter(
 686                                  p_spu->p_scale, &p_region->p_cache->picture );
 687                 if( p_pic )
 688                 {
 689                     picture_t p_pic_tmp = p_region->p_cache->picture;
 690                     p_region->p_cache->picture = *p_pic;
 691                     *p_pic = p_pic_tmp;
 692                     free( p_pic );
 693                 }
 694             }
 695             if( (i_scale_width != 1000 || i_scale_height != 1000) &&
 696                 p_spu->p_scale && p_region->p_cache )
 697             {
 698                 p_region = p_region->p_cache;
 699             }
 700
 701             if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
 702             {
 703                 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
 704                     p_subpic->i_y;
 705             }
 706             else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
 707             {
 708                 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
 709             }
 710
 711             if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
 712             {
 713                 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
 714                     i_subpic_x;
 715             }
 716             else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
 717             {
 718                 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
 719             }
 720
 721             if( p_subpic->b_absolute )
 722             {
 723                 i_x_offset = p_region->i_x +
 724                     i_subpic_x * i_scale_width / 1000;
 725                 i_y_offset = p_region->i_y +
 726                     p_subpic->i_y * i_scale_height / 1000;
 727
 728             }
 729
 730             if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
 731             {
 732                 int i_diff = 0;
 733                 int i_low = i_y_offset - p_spu->i_margin;
 734                 int i_high = i_y_offset + p_region->fmt.i_height - p_spu->i_margin;
 735
 736                 /* crop extra margin to keep within bounds */
 737                 if( i_low < 0 ) i_diff = i_low;
 738                 if( i_high > (int)p_fmt->i_height ) i_diff = i_high - p_fmt->i_height;
 739                 i_y_offset -= ( p_spu->i_margin + i_diff );
 740             }
 741
 742             p_spu->p_blend->fmt_in.video = p_region->fmt;
 743
 744             /* Force cropping if requested */
 745             if( p_spu->b_force_crop )
 746             {
 747                 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
 748                 int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
 749                 int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
 750                 int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
 751                 int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
 752
 753                 /* Find the intersection */
 754                 if( i_crop_x + i_crop_width <= i_x_offset ||
 755                     i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
 756                     i_crop_y + i_crop_height <= i_y_offset ||
 757                     i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
 758                 {
 759                     /* No intersection */
 760                     p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
 761                 }
 762                 else
 763                 {
 764                     int i_x, i_y, i_x_end, i_y_end;
 765                     i_x = __MAX( i_crop_x, i_x_offset );
 766                     i_y = __MAX( i_crop_y, i_y_offset );
 767                     i_x_end = __MIN( i_crop_x + i_crop_width,
 768                                    i_x_offset + (int)p_fmt->i_visible_width );
 769                     i_y_end = __MIN( i_crop_y + i_crop_height,
 770                                    i_y_offset + (int)p_fmt->i_visible_height );
 771
 772                     p_fmt->i_x_offset = i_x - i_x_offset;
 773                     p_fmt->i_y_offset = i_y - i_y_offset;
 774                     p_fmt->i_visible_width = i_x_end - i_x;
 775                     p_fmt->i_visible_height = i_y_end - i_y;
 776
 777                     i_x_offset = i_x;
 778                     i_y_offset = i_y;
 779                 }
 780             }
 781
 782             /* Update the output picture size */
 783             p_spu->p_blend->fmt_out.video.i_width =
 784                 p_spu->p_blend->fmt_out.video.i_visible_width =
 785                     p_fmt->i_width;
 786             p_spu->p_blend->fmt_out.video.i_height =
 787                 p_spu->p_blend->fmt_out.video.i_visible_height =
 788                     p_fmt->i_height;
 789
 790             if( p_subpic->b_fade )
 791             {
 792                 mtime_t i_fade_start = ( p_subpic->i_stop +
 793                                          p_subpic->i_start ) / 2;
 794                 mtime_t i_now = mdate();
 795                 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
 796                 {
 797                     i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
 798                                    ( p_subpic->i_stop - i_fade_start );
 799                 }
 800             }
 801
 802             p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
 803                 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
 804                 i_fade_alpha * p_subpic->i_alpha / 255 );
 805
 806             p_region = p_region->p_next;
 807         }
 808
 809         p_subpic = p_subpic->p_next;
 810     }
 811
 812     vlc_mutex_unlock( &p_spu->subpicture_lock );
 813 }
 814
 815 /*****************************************************************************
 816  * spu_SortSubpictures: find the subpictures to display
 817  *****************************************************************************
 818  * This function parses all subpictures and decides which ones need to be
 819  * displayed. This operation does not need lock, since only READY_SUBPICTURE
 820  * are handled. If no picture has been selected, display_date will depend on
 821  * the subpicture.
 822  * We also check for ephemer DVD subpictures (subpictures that have
 823  * to be removed if a newer one is available), which makes it a lot
 824  * more difficult to guess if a subpicture has to be rendered or not.
 825  *****************************************************************************/
 826 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
 827 {
 828     int i_index, i_channel;
 829     subpicture_t *p_subpic = NULL;
 830     subpicture_t *p_ephemer;
 831     mtime_t      ephemer_date;
 832
 833     /* Run subpicture filters */
 834     for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
 835     {
 836         subpicture_t *p_subpic_filter;
 837         p_subpic_filter = p_spu->pp_filter[i_index]->
 838             pf_sub_filter( p_spu->pp_filter[i_index], display_date );
 839         if( p_subpic_filter )
 840         {
 841             spu_DisplaySubpicture( p_spu, p_subpic_filter );
 842         }
 843     }
 844
 845     /* We get an easily parsable chained list of subpictures which
 846      * ends with NULL since p_subpic was initialized to NULL. */
 847     for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
 848     {
 849         p_ephemer = 0;
 850         ephemer_date = 0;
 851
 852         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
 853         {
 854             if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
 855                 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
 856             {
 857                 continue;
 858             }
 859             if( display_date &&
 860                 display_date < p_spu->p_subpicture[i_index].i_start )
 861             {
 862                 /* Too early, come back next monday */
 863                 continue;
 864             }
 865
 866             if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
 867                 ephemer_date = p_spu->p_subpicture[i_index].i_start;
 868
 869             if( display_date > p_spu->p_subpicture[i_index].i_stop &&
 870                 ( !p_spu->p_subpicture[i_index].b_ephemer ||
 871                   p_spu->p_subpicture[i_index].i_stop >
 872                   p_spu->p_subpicture[i_index].i_start ) )
 873             {
 874                 /* Too late, destroy the subpic */
 875                 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
 876                 continue;
 877             }
 878
 879             /* If this is an ephemer subpic, add it to our list */
 880             if( p_spu->p_subpicture[i_index].b_ephemer )
 881             {
 882                 p_spu->p_subpicture[i_index].p_next = p_ephemer;
 883                 p_ephemer = &p_spu->p_subpicture[i_index];
 884
 885                 continue;
 886             }
 887
 888             p_spu->p_subpicture[i_index].p_next = p_subpic;
 889             p_subpic = &p_spu->p_subpicture[i_index];
 890         }
 891
 892         /* If we found ephemer subpictures, check if they have to be
 893          * displayed or destroyed */
 894         while( p_ephemer != NULL )
 895         {
 896             subpicture_t *p_tmp = p_ephemer;
 897             p_ephemer = p_ephemer->p_next;
 898
 899             if( p_tmp->i_start < ephemer_date )
 900             {
 901                 /* Ephemer subpicture has lived too long */
 902                 spu_DestroySubpicture( p_spu, p_tmp );
 903             }
 904             else
 905             {
 906                 /* Ephemer subpicture can still live a bit */
 907                 p_tmp->p_next = p_subpic;
 908                 p_subpic = p_tmp;
 909             }
 910         }
 911     }
 912
 913     return p_subpic;
 914 }
 915
 916 /*****************************************************************************
 917  * SpuClearChannel: clear an spu channel
 918  *****************************************************************************
 919  * This function destroys the subpictures which belong to the spu channel
 920  * corresponding to i_channel_id.
 921  *****************************************************************************/
 922 static void SpuClearChannel( spu_t *p_spu, int i_channel )
 923 {
 924     int          i_subpic;                               /* subpicture index */
 925     subpicture_t *p_subpic = NULL;                  /* first free subpicture */
 926
 927     vlc_mutex_lock( &p_spu->subpicture_lock );
 928
 929     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 930     {
 931         p_subpic = &p_spu->p_subpicture[i_subpic];
 932         if( p_subpic->i_status == FREE_SUBPICTURE
 933             || ( p_subpic->i_status != RESERVED_SUBPICTURE
 934                  && p_subpic->i_status != READY_SUBPICTURE ) )
 935         {
 936             continue;
 937         }
 938
 939         if( p_subpic->i_channel == i_channel )
 940         {
 941             while( p_subpic->p_region )
 942             {
 943                 subpicture_region_t *p_region = p_subpic->p_region;
 944                 p_subpic->p_region = p_region->p_next;
 945                 spu_DestroyRegion( p_spu, p_region );
 946             }
 947
 948             if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
 949             p_subpic->i_status = FREE_SUBPICTURE;
 950         }
 951     }
 952
 953     vlc_mutex_unlock( &p_spu->subpicture_lock );
 954 }
 955
 956 /*****************************************************************************
 957  * spu_ControlDefault: default methods for the subpicture unit control.
 958  *****************************************************************************/
 959 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
 960 {
 961     int *pi, i;
 962
 963     switch( i_query )
 964     {
 965     case SPU_CHANNEL_REGISTER:
 966         pi = (int *)va_arg( args, int * );
 967         if( pi ) *pi = p_spu->i_channel++;
 968         msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
 969                  p_spu->i_channel - 1 );
 970         break;
 971
 972     case SPU_CHANNEL_CLEAR:
 973         i = (int)va_arg( args, int );
 974         SpuClearChannel( p_spu, i );
 975         break;
 976
 977     default:
 978         msg_Dbg( p_spu, "control query not supported" );
 979         return VLC_EGENERIC;
 980     }
 981
 982     return VLC_SUCCESS;
 983 }
 984
 985 /*****************************************************************************
 986  * Object variables callbacks
 987  *****************************************************************************/
 988
 989 /*****************************************************************************
 990  * UpdateSPU: update subpicture settings
 991  *****************************************************************************
 992  * This function is called from CropCallback and at initialization time, to
 993  * retrieve crop information from the input.
 994  *****************************************************************************/
 995 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
 996 {
 997     vlc_value_t val;
 998
 999     p_spu->b_force_palette = VLC_FALSE;
1000     p_spu->b_force_crop = VLC_FALSE;
1001
1002     if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1003
1004     p_spu->b_force_crop = VLC_TRUE;
1005     var_Get( p_object, "x-start", &val );
1006     p_spu->i_crop_x = val.i_int;
1007     var_Get( p_object, "y-start", &val );
1008     p_spu->i_crop_y = val.i_int;
1009     var_Get( p_object, "x-end", &val );
1010     p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1011     var_Get( p_object, "y-end", &val );
1012     p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1013
1014     if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1015     {
1016         memcpy( p_spu->palette, val.p_address, 16 );
1017         p_spu->b_force_palette = VLC_TRUE;
1018     }
1019
1020     msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1021              p_spu->i_crop_x, p_spu->i_crop_y,
1022              p_spu->i_crop_width, p_spu->i_crop_height,
1023              p_spu->b_force_palette );
1024 }
1025
1026 /*****************************************************************************
1027  * CropCallback: called when the highlight properties are changed
1028  *****************************************************************************
1029  * This callback is called from the input thread when we need cropping
1030  *****************************************************************************/
1031 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1032                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
1033 {
1034     UpdateSPU( (spu_t *)p_data, p_object );
1035     return VLC_SUCCESS;
1036 }
1037
1038 /*****************************************************************************
1039  * Buffers allocation callbacks for the filters
1040  *****************************************************************************/
1041 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1042 {
1043     filter_owner_sys_t *p_sys = p_filter->p_owner;
1044     subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1045     if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1046     return p_subpicture;
1047 }
1048
1049 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1050 {
1051     filter_owner_sys_t *p_sys = p_filter->p_owner;
1052     spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1053 }
1054
1055 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1056 {
1057     subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1058     memset( p_subpic, 0, sizeof(subpicture_t) );
1059     p_subpic->b_absolute = VLC_TRUE;
1060
1061     p_subpic->pf_create_region = __spu_CreateRegion;
1062     p_subpic->pf_make_region = __spu_MakeRegion;
1063     p_subpic->pf_destroy_region = __spu_DestroyRegion;
1064
1065     return p_subpic;
1066 }
1067
1068 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1069 {
1070     while( p_subpic->p_region )
1071     {
1072         subpicture_region_t *p_region = p_subpic->p_region;
1073         p_subpic->p_region = p_region->p_next;
1074         p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1075     }
1076
1077     free( p_subpic );
1078 }
1079
1080 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1081 {
1082     picture_t *p_picture = malloc( sizeof(picture_t) );
1083
1084     if( vout_AllocatePicture( p_filter, p_picture,
1085                               p_filter->fmt_out.video.i_chroma,
1086                               p_filter->fmt_out.video.i_width,
1087                               p_filter->fmt_out.video.i_height,
1088                               p_filter->fmt_out.video.i_aspect )
1089         != VLC_SUCCESS )
1090     {
1091         free( p_picture );
1092         return NULL;
1093     }
1094
1095     p_picture->pf_release = RegionPictureRelease;
1096
1097     return p_picture;
1098 }
1099
1100 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1101 {
1102     if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1103     if( p_pic ) free( p_pic );
1104 }