vout_subpictures.c 41.2 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2005 the VideoLAN team
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6 7 8
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
9
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
24 25 26 27 28 29 30 31 32
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>                                                /* free() */
#include <stdio.h>                                              /* sprintf() */
#include <string.h>                                            /* strerror() */

33
#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
34 35 36 37
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
#include <vlc_osd.h>
38

39 40 41 42 43 44
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static void UpdateSPU   ( spu_t *, vlc_object_t * );
static int  CropCallback( vlc_object_t *, char const *,
                          vlc_value_t, vlc_value_t, void * );
45

46 47
static int spu_vaControlDefault( spu_t *, int, va_list );

48 49
static subpicture_t *sub_new_buffer( filter_t * );
static void sub_del_buffer( filter_t *, subpicture_t * );
50 51
static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
52 53
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
54

55 56 57 58 59
static int spu_ParseChain( spu_t * );
static void spu_DeleteChain( spu_t * );
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

60 61 62 63 64 65
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

66
/**
67
 * Creates the subpicture unit
68
 *
69
 * \param p_this the parent object which creates the subpicture unit
70
 */
71
spu_t *__spu_Create( vlc_object_t *p_this )
72 73
{
    int i_index;
74
    spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
75 76 77

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
78
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
79 80
    }

81 82 83
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
84
    p_spu->i_filter = 0;
85
    p_spu->pf_control = spu_vaControlDefault;
86 87

    /* Register the default subpicture channel */
88
    p_spu->i_channel = 2;
89 90

    vlc_mutex_init( p_this, &p_spu->subpicture_lock );
91

92 93
    vlc_object_attach( p_spu, p_this );

94 95 96 97 98 99 100 101 102 103 104 105
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
    vlc_value_t val;

106 107 108
    /* If the user requested a sub margin, we force the position. */
    var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_spu, "sub-margin", &val );
109 110 111
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
112 113 114 115 116 117
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

    return VLC_EGENERIC;
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
118

119 120 121 122 123
int spu_ParseChain( spu_t *p_spu )
{
    char *psz_parser;
    vlc_value_t val;
    var_Get( p_spu, "sub-filter", &val );
124
    psz_parser = val.psz_string;
Antoine Cellerier's avatar
 
Antoine Cellerier committed
125 126

    while( psz_parser && *psz_parser )
127
    {
128
        config_chain_t *p_cfg;
Antoine Cellerier's avatar
 
Antoine Cellerier committed
129 130 131
        char *psz_name;

        psz_parser = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
132

Antoine Cellerier's avatar
 
Antoine Cellerier committed
133
        msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
134

135 136 137 138 139
        p_spu->pp_filter[p_spu->i_filter] =
            vlc_object_create( p_spu, VLC_OBJECT_FILTER );
        vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
        p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
        p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
Antoine Cellerier's avatar
Antoine Cellerier committed
140
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
141 142
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
Antoine Cellerier's avatar
 
Antoine Cellerier committed
143
                         "sub filter", psz_name, 0 );
144 145 146 147 148 149 150 151
        if( p_spu->pp_filter[p_spu->i_filter]->p_module )
        {
            filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
            p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
            spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
            p_sys->p_spu = p_spu;
            p_spu->i_filter++;
        }
152 153
        else
        {
154
            msg_Dbg( p_spu, "no sub filter found" );
155
            config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
156 157 158
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
            vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
        }
159 160 161 162 163 164

        if( p_spu->i_filter >= 10 )
        {
            msg_Dbg( p_spu, "can't add anymore filters" );
        }

Antoine Cellerier's avatar
 
Antoine Cellerier committed
165
        free( psz_name );
166
    }
167
    if( val.psz_string ) free( val.psz_string );
168

169
    return VLC_EGENERIC;
170 171 172
}

/**
173
 * Destroy the subpicture unit
174
 *
175
 * \param p_this the parent object which destroys the subpicture unit
176
 */
177
void spu_Destroy( spu_t *p_spu )
178 179 180
{
    int i_index;

181 182
    vlc_object_detach( p_spu );

183 184 185
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
186
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
187
        {
188
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
189 190 191
        }
    }

192
    if( p_spu->p_blend )
193
    {
194 195
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
196

197 198
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
199 200
    }

201
    if( p_spu->p_text )
202
    {
203 204
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
205

206 207
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
208 209
    }

210 211 212 213 214 215 216 217 218
    if( p_spu->p_scale )
    {
        if( p_spu->p_scale->p_module )
            module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );

        vlc_object_detach( p_spu->p_scale );
        vlc_object_destroy( p_spu->p_scale );
    }

219 220 221 222 223 224 225 226 227
    spu_DeleteChain( p_spu );

    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
}

static void spu_DeleteChain( spu_t *p_spu )
{
    if( p_spu->i_filter )
228 229 230 231
    while( p_spu->i_filter-- )
    {
        module_Unneed( p_spu->pp_filter[p_spu->i_filter],
                       p_spu->pp_filter[p_spu->i_filter]->p_module );
232
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
233
        config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
234 235 236
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }
237 238 239 240 241
}

/**
 * Attach/Detach the SPU from any input
 *
242
 * \param p_this the object in which to destroy the subpicture unit
243 244
 * \param b_attach to select attach or detach
 */
245
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
246 247 248
{
    vlc_object_t *p_input;

249
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
250 251 252
    if( !p_input ) return;

    if( b_attach )
253
    {
254 255
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
256 257 258 259 260
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
261
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
262 263 264 265 266 267 268 269 270 271
        vlc_object_release( p_input );
    }
}

/**
 * Create a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 */
272 273 274 275
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
276 277 278 279 280 281
subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
                                         video_format_t *p_fmt )
{
    subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
    memset( p_region, 0, sizeof(subpicture_region_t) );
    p_region->p_next = 0;
282
    p_region->p_cache = 0;
283
    p_region->fmt = *p_fmt;
284
    p_region->psz_text = 0;
285
    p_region->p_style = NULL;
286 287 288 289 290 291

    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = p_region->fmt.p_palette =
            malloc( sizeof(video_palette_t) );
    else p_fmt->p_palette = p_region->fmt.p_palette = NULL;

292
    p_region->picture.p_data_orig = NULL;
293 294

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
295 296 297 298 299 300 301

    vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
                          p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );

    if( !p_region->picture.i_planes )
    {
        free( p_region );
302
        free( p_fmt->p_palette );
303 304 305
        return NULL;
    }

306 307
    p_region->picture.pf_release = RegionPictureRelease;

308 309 310
    return p_region;
}

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
/**
 * Make a subpicture region from an existing picture_t
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 * \param p_pic a pointer to the picture creating the region (not freed)
 */
subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
                                       video_format_t *p_fmt,
                                       picture_t *p_pic )
{
    subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
    memset( p_region, 0, sizeof(subpicture_region_t) );
    p_region->p_next = 0;
    p_region->p_cache = 0;
    p_region->fmt = *p_fmt;
    p_region->psz_text = 0;
328
    p_region->p_style = NULL;
329 330 331 332 333 334 335 336 337 338 339 340

    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = p_region->fmt.p_palette =
            malloc( sizeof(video_palette_t) );
    else p_fmt->p_palette = p_region->fmt.p_palette = NULL;

    memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
    p_region->picture.pf_release = RegionPictureRelease;

    return p_region;
}

341 342 343 344 345 346 347 348 349
/**
 * Destroy a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_region the subpicture region to destroy
 */
void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
{
    if( !p_region ) return;
350 351
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
352
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
353
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
354 355 356 357

    if( p_region->psz_text )
        free( p_region->psz_text );
    //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
358 359
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
360

361
/**
362
 * Display a subpicture
363
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
364 365
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
366
 * \param p_spu the subpicture unit object
367 368
 * \param p_subpic the subpicture to display
 */
369
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
370 371 372 373
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
374 375
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
376 377
    }

378 379
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
380

381
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
382
    {
383 384 385
        p_subpic->i_channel = 0xFFFF;
        spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
        p_subpic->i_channel = DEFAULT_CHAN;
Sam Hocevar's avatar
 
Sam Hocevar committed
386
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
387 388
}

389
/**
390
 * Allocate a subpicture in the spu heap.
391
 *
392
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
393 394 395
 * A null pointer is returned if the function fails. This method provides an
 * already allocated zone of memory in the spu data fields. It needs locking
 * since several pictures can be created by several producers threads.
396
 * \param p_spu the subpicture unit in which to create the subpicture
397 398
 * \return NULL on error, a reserved subpicture otherwise
 */
399
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
400 401
{
    int                 i_subpic;                        /* subpicture index */
402
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
403

404
    /* Get lock */
405
    vlc_mutex_lock( &p_spu->subpicture_lock );
406

Sam Hocevar's avatar
 
Sam Hocevar committed
407 408 409
    /*
     * Look for an empty place
     */
410
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
411 412
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
413
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
414 415
        {
            /* Subpicture is empty and ready for allocation */
416 417
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
418
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
419 420 421
        }
    }

422 423
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
424
    {
425 426
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
427
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
428
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
429

430
    /* Copy subpicture information, set some default values */
431 432 433
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
434
    p_subpic->b_pausable = VLC_FALSE;
435
    p_subpic->b_fade     = VLC_FALSE;
436 437
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = 0;
438 439 440 441
    p_subpic->pf_render  = 0;
    p_subpic->pf_destroy = 0;
    p_subpic->p_sys      = 0;
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
442

443
    p_subpic->pf_create_region = __spu_CreateRegion;
444
    p_subpic->pf_make_region = __spu_MakeRegion;
445
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
446

447
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
448 449
}

450 451 452
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
453 454 455
 * This function frees a previously reserved subpicture.
 * It is meant to be used when the construction of a picture aborted.
 * This function does not need locking since reserved subpictures are ignored
456
 * by the spu.
457
 */
458
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
459
{
Gildas Bazin's avatar
 
Gildas Bazin committed
460
    /* Get lock */
461
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
462 463 464 465

    /* There can be race conditions so we need to check the status */
    if( p_subpic->i_status == FREE_SUBPICTURE )
    {
466
        vlc_mutex_unlock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
467 468 469
        return;
    }

470 471 472 473
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
474
        msg_Err( p_spu, "subpicture %p has invalid status %d",
475 476 477
                         p_subpic, p_subpic->i_status );
    }

478 479 480 481
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
482
        spu_DestroyRegion( p_spu, p_region );
483 484
    }

485 486 487 488 489 490
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

    p_subpic->i_status = FREE_SUBPICTURE;
Gildas Bazin's avatar
 
Gildas Bazin committed
491

492
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
493 494 495
}

/*****************************************************************************
496
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
497
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
498
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
499
 *****************************************************************************/
500 501 502
void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                            picture_t *p_pic_dst, picture_t *p_pic_src,
                            subpicture_t *p_subpic,
503
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
504
{
Gildas Bazin's avatar
 
Gildas Bazin committed
505
    /* Get lock */
506
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
507 508 509

    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
    while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
510
    {
511
        subpicture_region_t *p_region = p_subpic->p_region;
512
        int i_scale_width, i_scale_height;
513
        int i_subpic_x = p_subpic->i_x;
514

515
        /* Load the blending module */
516
        if( !p_spu->p_blend && p_region )
517
        {
518
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
519 520 521 522 523 524
            vlc_object_attach( p_spu->p_blend, p_spu );
            p_spu->p_blend->fmt_out.video.i_x_offset =
                p_spu->p_blend->fmt_out.video.i_y_offset = 0;
            p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
            p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
            p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
525
            /* XXX: We'll also be using it for YUVA and RGBA blending ... */
526 527 528

            p_spu->p_blend->p_module =
                module_Need( p_spu->p_blend, "video blending", 0, 0 );
529
        }
530

531
        /* Load the text rendering module */
532
        if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
533
        {
534 535
            char *psz_modulename = NULL;

536
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
537 538 539 540
            vlc_object_attach( p_spu->p_text, p_spu );

            p_spu->p_text->fmt_out.video.i_width =
                p_spu->p_text->fmt_out.video.i_visible_width =
541
                p_fmt->i_width;
542 543
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
544
                p_fmt->i_height;
545

546 547
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
548 549 550 551 552 553 554 555 556 557 558 559 560

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", psz_modulename, VLC_TRUE );
            }
            if( !p_spu->p_text->p_module )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
            }
            if( psz_modulename ) free( psz_modulename );
561
        }
562
        if( p_spu->p_text )
563
        {
564 565 566 567 568 569 570 571 572 573 574 575 576 577
            if( p_subpic->i_original_picture_height > 0 &&
                p_subpic->i_original_picture_width  > 0 )
            {
                p_spu->p_text->fmt_out.video.i_width =
                    p_spu->p_text->fmt_out.video.i_visible_width =
                    p_subpic->i_original_picture_width;
                p_spu->p_text->fmt_out.video.i_height =
                    p_spu->p_text->fmt_out.video.i_visible_height =
                    p_subpic->i_original_picture_height;
            }
            else
            {
                p_spu->p_text->fmt_out.video.i_width =
                    p_spu->p_text->fmt_out.video.i_visible_width =
578
                    p_fmt->i_width;
579 580
                p_spu->p_text->fmt_out.video.i_height =
                    p_spu->p_text->fmt_out.video.i_visible_height =
581
                    p_fmt->i_height;
582
            }
583
        }
584

585 586 587
        i_scale_width = i_scale_width_orig;
        i_scale_height = i_scale_height_orig;

588 589
        if( p_subpic->i_original_picture_height > 0 &&
            p_subpic->i_original_picture_width  > 0 )
590 591
        {
            i_scale_width = i_scale_width * p_fmt->i_width /
592
                             p_subpic->i_original_picture_width;
593
            i_scale_height = i_scale_height * p_fmt->i_height /
594
                             p_subpic->i_original_picture_height;
595
        }
596 597 598 599
        else if( p_subpic->i_original_picture_height > 0 )
        {
            i_scale_height = i_scale_height * p_fmt->i_height /
                             p_subpic->i_original_picture_height;
Antoine Cellerier's avatar
Antoine Cellerier committed
600
            i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height;
601
        }
602

603 604 605
        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
            (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
606
        {
607 608 609 610 611 612 613 614 615
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
            (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }
616

617
        /* Take care of the aspect ratio */
618
        if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
619 620 621 622 623
            p_region->fmt.i_sar_den * p_fmt->i_sar_num )
        {
            i_scale_width = i_scale_width *
                (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
                p_region->fmt.i_sar_den / p_fmt->i_sar_num;
624
            i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
625 626
        }

627
        /* Load the scaling module */
628 629 630 631 632 633 634 635
        if( !p_spu->p_scale && (i_scale_width != 1000 ||
            i_scale_height != 1000) )
        {
            p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
            vlc_object_attach( p_spu->p_scale, p_spu );
            p_spu->p_scale->fmt_out.video.i_chroma =
                p_spu->p_scale->fmt_in.video.i_chroma =
                    VLC_FOURCC('Y','U','V','P');
636
            /* XXX: We'll also be using it for YUVA and RGBA blending ... */
637 638 639 640 641 642 643 644 645
            p_spu->p_scale->fmt_in.video.i_width =
                p_spu->p_scale->fmt_in.video.i_height = 32;
            p_spu->p_scale->fmt_out.video.i_width =
                p_spu->p_scale->fmt_out.video.i_height = 16;

            p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
            p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
            p_spu->p_scale->p_module =
                module_Need( p_spu->p_scale, "video filter2", 0, 0 );
646 647
        }

648
        while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
649
        {
650
            int i_fade_alpha = 255;
651 652
            int i_x_offset = p_region->i_x + i_subpic_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;
653

654 655
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
656
                if( p_spu->p_text && p_spu->p_text->p_module )
657 658
                {
                    p_region->i_align = p_subpic->i_flags;
659 660 661 662 663 664 665 666 667

                    if( p_spu->p_text->pf_render_html && p_region->psz_html )
                    {
                        p_spu->p_text->pf_render_html( p_spu->p_text,
                                                       p_region, p_region );
                    }
                    else if( p_spu->p_text->pf_render_text )
                    {
                        p_spu->p_text->pf_render_text( p_spu->p_text,
Antoine Cellerier's avatar
Antoine Cellerier committed
668
                                                       p_region, p_region );
669
                    }
670 671 672
                }
            }

673
            /* Force palette if requested */
674
            if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
675
                p_region->fmt.i_chroma )
676
            {
677 678
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
679 680 681 682
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache )
683
            {
684 685 686 687 688 689 690 691 692
                if( i_scale_width * p_region->fmt.i_width / 1000 !=
                    p_region->p_cache->fmt.i_width ||
                    i_scale_height * p_region->fmt.i_height / 1000 !=
                    p_region->p_cache->fmt.i_height )
                {
                    p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
                                                 p_region->p_cache );
                    p_region->p_cache = 0;
                }
693
            }
694

695
            if( (i_scale_width != 1000 || i_scale_height != 1000) &&
696
                p_spu->p_scale && !p_region->p_cache )
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
            {
                picture_t *p_pic;

                p_spu->p_scale->fmt_in.video = p_region->fmt;
                p_spu->p_scale->fmt_out.video = p_region->fmt;

                p_region->p_cache =
                    p_subpic->pf_create_region( VLC_OBJECT(p_spu),
                        &p_spu->p_scale->fmt_out.video );
                if( p_spu->p_scale->fmt_out.video.p_palette )
                    *p_spu->p_scale->fmt_out.video.p_palette =
                        *p_region->fmt.p_palette;
                p_region->p_cache->p_next = p_region->p_next;

                vout_CopyPicture( p_spu, &p_region->p_cache->picture,
                                  &p_region->picture );

                p_spu->p_scale->fmt_out.video.i_width =
                    p_region->fmt.i_width * i_scale_width / 1000;
                p_spu->p_scale->fmt_out.video.i_visible_width =
                    p_region->fmt.i_visible_width * i_scale_width / 1000;
                p_spu->p_scale->fmt_out.video.i_height =
                    p_region->fmt.i_height * i_scale_height / 1000;
                p_spu->p_scale->fmt_out.video.i_visible_height =
                    p_region->fmt.i_visible_height * i_scale_height / 1000;
                p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
723 724
                p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
                p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741

                p_pic = p_spu->p_scale->pf_video_filter(
                                 p_spu->p_scale, &p_region->p_cache->picture );
                if( p_pic )
                {
                    picture_t p_pic_tmp = p_region->p_cache->picture;
                    p_region->p_cache->picture = *p_pic;
                    *p_pic = p_pic_tmp;
                    free( p_pic );
                }
            }
            if( (i_scale_width != 1000 || i_scale_height != 1000) &&
                p_spu->p_scale && p_region->p_cache )
            {
                p_region = p_region->p_cache;
            }

742 743 744 745 746 747 748 749 750 751 752 753 754
            if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
            {
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
                    p_subpic->i_y;
            }
            else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
            {
                i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
            }

            if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
            {
                i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
755
                    i_subpic_x;
756 757 758 759 760 761
            }
            else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
            {
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
            }

762 763
            if( p_subpic->b_absolute )
            {
764
                i_x_offset = p_region->i_x +
765
                    i_subpic_x * i_scale_width / 1000;
766 767 768
                i_y_offset = p_region->i_y +
                    p_subpic->i_y * i_scale_height / 1000;

769
            }
Antoine Cellerier's avatar
Antoine Cellerier committed
770

771 772
            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );
773 774 775 776 777 778 779 780 781 782 783

            if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
            {
                int i_diff = 0;
                int i_low = i_y_offset - p_spu->i_margin;
                int i_high = i_y_offset + p_region->fmt.i_height - p_spu->i_margin;

                /* crop extra margin to keep within bounds */
                if( i_low < 0 ) i_diff = i_low;
                if( i_high > (int)p_fmt->i_height ) i_diff = i_high - p_fmt->i_height;
                i_y_offset -= ( p_spu->i_margin + i_diff );
784 785 786
            }

            p_spu->p_blend->fmt_in.video = p_region->fmt;
787

788 789 790 791
            /* Force cropping if requested */
            if( p_spu->b_force_crop )
            {
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
792 793 794 795
                int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
                int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
                int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
                int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

                /* Find the intersection */
                if( i_crop_x + i_crop_width <= i_x_offset ||
                    i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
                    i_crop_y + i_crop_height <= i_y_offset ||
                    i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
                {
                    /* No intersection */
                    p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
                }
                else
                {
                    int i_x, i_y, i_x_end, i_y_end;
                    i_x = __MAX( i_crop_x, i_x_offset );
                    i_y = __MAX( i_crop_y, i_y_offset );
                    i_x_end = __MIN( i_crop_x + i_crop_width,
                                   i_x_offset + (int)p_fmt->i_visible_width );
                    i_y_end = __MIN( i_crop_y + i_crop_height,
                                   i_y_offset + (int)p_fmt->i_visible_height );

                    p_fmt->i_x_offset = i_x - i_x_offset;
                    p_fmt->i_y_offset = i_y - i_y_offset;
                    p_fmt->i_visible_width = i_x_end - i_x;
                    p_fmt->i_visible_height = i_y_end - i_y;

                    i_x_offset = i_x;
                    i_y_offset = i_y;
                }
            }

826
            /* Update the output picture size */
827 828 829 830 831 832 833
            p_spu->p_blend->fmt_out.video.i_width =
                p_spu->p_blend->fmt_out.video.i_visible_width =
                    p_fmt->i_width;
            p_spu->p_blend->fmt_out.video.i_height =
                p_spu->p_blend->fmt_out.video.i_visible_height =
                    p_fmt->i_height;

834 835 836 837 838 839 840 841 842 843 844 845
            if( p_subpic->b_fade )
            {
                mtime_t i_fade_start = ( p_subpic->i_stop +
                                         p_subpic->i_start ) / 2;
                mtime_t i_now = mdate();
                if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
                {
                    i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
                                   ( p_subpic->i_stop - i_fade_start );
                }
            }

846 847
            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );
848

849 850
            p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
                p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
851
                i_fade_alpha * p_subpic->i_alpha / 255 );
852 853 854 855

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
856 857
        p_subpic = p_subpic->p_next;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
858

859
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
860 861 862
}

/*****************************************************************************
863
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
864 865 866 867 868 869 870 871 872
 *****************************************************************************
 * This function parses all subpictures and decides which ones need to be
 * displayed. This operation does not need lock, since only READY_SUBPICTURE
 * are handled. If no picture has been selected, display_date will depend on
 * the subpicture.
 * We also check for ephemer DVD subpictures (subpictures that have
 * to be removed if a newer one is available), which makes it a lot
 * more difficult to guess if a subpicture has to be rendered or not.
 *****************************************************************************/
873 874
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
                                   vlc_bool_t b_paused )
Sam Hocevar's avatar
 
Sam Hocevar committed
875
{
876 877 878 879
    int i_index, i_channel;
    subpicture_t *p_subpic = NULL;
    subpicture_t *p_ephemer;
    mtime_t      ephemer_date;
Sam Hocevar's avatar
 
Sam Hocevar committed
880

881 882 883 884 885 886 887 888 889 890 891 892
    /* Run subpicture filters */
    for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
    {
        subpicture_t *p_subpic_filter;
        p_subpic_filter = p_spu->pp_filter[i_index]->
            pf_sub_filter( p_spu->pp_filter[i_index], display_date );
        if( p_subpic_filter )
        {
            spu_DisplaySubpicture( p_spu, p_subpic_filter );
        }
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
893 894
    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
895
    for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
896
    {
897 898 899 900
        p_ephemer = 0;
        ephemer_date = 0;

        for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
901
        {
902 903
            if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
                p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
904
            {
905 906 907 908 909 910 911 912
                continue;
            }
            if( display_date &&
                display_date < p_spu->p_subpicture[i_index].i_start )
            {
                /* Too early, come back next monday */
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
913

914 915
            if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
                ephemer_date = p_spu->p_subpicture[i_index].i_start;
Sam Hocevar's avatar
 
Sam Hocevar committed
916

917 918 919
            if( display_date > p_spu->p_subpicture[i_index].i_stop &&
                ( !p_spu->p_subpicture[i_index].b_ephemer ||
                  p_spu->p_subpicture[i_index].i_stop >
920 921 922
                  p_spu->p_subpicture[i_index].i_start ) &&
                !( p_spu->p_subpicture[i_index].b_pausable &&
                   b_paused ) )
923 924 925 926 927
            {
                /* Too late, destroy the subpic */
                spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
928

929 930 931 932 933
            /* If this is an ephemer subpic, add it to our list */
            if( p_spu->p_subpicture[i_index].b_ephemer )
            {
                p_spu->p_subpicture[i_index].p_next = p_ephemer;
                p_ephemer = &p_spu->p_subpicture[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
934

935 936
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
937

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
            p_spu->p_subpicture[i_index].p_next = p_subpic;
            p_subpic = &p_spu->p_subpicture[i_index];
        }

        /* If we found ephemer subpictures, check if they have to be
         * displayed or destroyed */
        while( p_ephemer != NULL )
        {
            subpicture_t *p_tmp = p_ephemer;
            p_ephemer = p_ephemer->p_next;

            if( p_tmp->i_start < ephemer_date )
            {
                /* Ephemer subpicture has lived too long */
                spu_DestroySubpicture( p_spu, p_tmp );
Sam Hocevar's avatar
 
Sam Hocevar committed
953 954 955
            }
            else
            {
956 957 958
                /* Ephemer subpicture can still live a bit */
                p_tmp->p_next = p_subpic;
                p_subpic = p_tmp;
Sam Hocevar's avatar
 
Sam Hocevar committed
959 960 961 962 963 964 965
            }
        }
    }

    return p_subpic;
}

966
/*****************************************************************************
967
 * SpuClearChannel: clear an spu channel
968
 *****************************************************************************
969
 * This function destroys the subpictures which belong to the spu channel
970 971
 * corresponding to i_channel_id.
 *****************************************************************************/
972
static void SpuClearChannel( spu_t *p_spu, int i_channel )
973
{
974 975
    int          i_subpic;                               /* subpicture index */
    subpicture_t *p_subpic = NULL;                  /* first free subpicture */
976

977
    vlc_mutex_lock( &p_spu->subpicture_lock );
978 979 980

    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
981
        p_subpic = &p_spu->p_subpicture[i_subpic];
982 983 984 985 986 987
        if( p_subpic->i_status == FREE_SUBPICTURE
            || ( p_subpic->i_status != RESERVED_SUBPICTURE