vout_subpictures.c 39.4 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
dionoea's avatar
dionoea 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>
zorglub's avatar
zorglub 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

gbazin's avatar
gbazin committed
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

gbazin's avatar
gbazin committed
55 56 57 58 59 60
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

61
/**
62
 * Creates the subpicture unit
63
 *
64
 * \param p_this the parent object which creates the subpicture unit
65
 */
66
spu_t *__spu_Create( vlc_object_t *p_this )
67 68
{
    int i_index;
69
    spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
70 71 72

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
73
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
74 75
    }

76 77 78
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
79
    p_spu->i_filter = 0;
gbazin's avatar
gbazin committed
80
    p_spu->pf_control = spu_vaControlDefault;
81 82

    /* Register the default subpicture channel */
gbazin's avatar
gbazin committed
83
    p_spu->i_channel = 2;
84 85

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

87 88
    vlc_object_attach( p_spu, p_this );

89 90 91 92 93 94 95 96 97 98
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
dionoea's avatar
 
dionoea committed
99
    char *psz_parser;
100 101
    vlc_value_t val;

102 103 104
    /* 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 );
105 106 107 108
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_Get( p_spu, "sub-filter", &val );
dionoea's avatar
 
dionoea committed
109

gbazin's avatar
gbazin committed
110
    psz_parser = val.psz_string;
dionoea's avatar
 
dionoea committed
111 112

    while( psz_parser && *psz_parser )
113
    {
dionoea's avatar
 
dionoea committed
114 115 116 117
        config_chain_t *p_cfg; /* Do we ever need to free this ? */
        char *psz_name;

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

dionoea's avatar
 
dionoea committed
119
        msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
120

121 122 123 124 125
        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;
dionoea's avatar
 
dionoea committed
126
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;;
127 128
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
dionoea's avatar
 
dionoea committed
129
                         "sub filter", psz_name, 0 );
gbazin's avatar
gbazin committed
130 131 132 133 134 135 136 137
        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++;
        }
138 139
        else
        {
140
            msg_Dbg( p_spu, "no sub filter found" );
141 142 143
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
            vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
        }
144 145 146 147 148 149

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

dionoea's avatar
 
dionoea committed
150
        free( psz_name );
151
    }
gbazin's avatar
gbazin committed
152
    if( val.psz_string ) free( val.psz_string );
153

154
    return VLC_EGENERIC;
155 156 157
}

/**
158
 * Destroy the subpicture unit
159
 *
160
 * \param p_this the parent object which destroys the subpicture unit
161
 */
162
void spu_Destroy( spu_t *p_spu )
163 164 165
{
    int i_index;

166 167
    vlc_object_detach( p_spu );

168 169 170
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
171
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
172
        {
173
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
174 175 176
        }
    }

177
    if( p_spu->p_blend )
178
    {
179 180
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
181

182 183
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
184 185
    }

186
    if( p_spu->p_text )
187
    {
188 189
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
190

191 192
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
193 194
    }

195 196 197 198 199 200 201 202 203
    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 );
    }

204 205 206 207
    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 );
gbazin's avatar
gbazin committed
208
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
209 210 211 212
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }

213 214
    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
215 216 217 218 219
}

/**
 * Attach/Detach the SPU from any input
 *
220
 * \param p_this the object in which to destroy the subpicture unit
221 222
 * \param b_attach to select attach or detach
 */
223
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
224 225 226
{
    vlc_object_t *p_input;

227
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
228 229 230
    if( !p_input ) return;

    if( b_attach )
231
    {
232 233
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
234 235 236 237 238
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
239
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
240 241 242 243 244 245 246 247 248 249
        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
 */
250 251 252 253
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
254 255 256 257 258 259
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;
260
    p_region->p_cache = 0;
261
    p_region->fmt = *p_fmt;
262
    p_region->psz_text = 0;
hartman's avatar
hartman committed
263
    p_region->p_style = NULL;
264 265 266 267 268 269

    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;

270
    p_region->picture.p_data_orig = NULL;
271 272

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
273 274 275 276 277 278 279

    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 );
280
        free( p_fmt->p_palette );
281 282 283
        return NULL;
    }

284 285
    p_region->picture.pf_release = RegionPictureRelease;

286 287 288
    return p_region;
}

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/**
 * 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;
hartman's avatar
hartman committed
306
    p_region->p_style = NULL;
307 308 309 310 311 312 313 314 315 316 317 318

    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;
}

319 320 321 322 323 324 325 326 327
/**
 * 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;
328 329
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
330
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
331
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
332 333
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
334

335
/**
336
 * Display a subpicture
337
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
338 339
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
340
 * \param p_spu the subpicture unit object
341 342
 * \param p_subpic the subpicture to display
 */
343
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
344 345 346 347
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
348 349
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
350 351
    }

352 353
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
354

355
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
356
    {
357 358 359
        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
360
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
361 362
}

363
/**
364
 * Allocate a subpicture in the spu heap.
365
 *
366
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
367 368 369
 * 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.
370
 * \param p_spu the subpicture unit in which to create the subpicture
371 372
 * \return NULL on error, a reserved subpicture otherwise
 */
373
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
374 375
{
    int                 i_subpic;                        /* subpicture index */
376
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
377

378
    /* Get lock */
379
    vlc_mutex_lock( &p_spu->subpicture_lock );
380

Sam Hocevar's avatar
 
Sam Hocevar committed
381 382 383
    /*
     * Look for an empty place
     */
yoann's avatar
yoann committed
384
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
385 386
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
387
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
388 389
        {
            /* Subpicture is empty and ready for allocation */
390 391
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
392
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
393 394 395
        }
    }

396 397
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
398
    {
399 400
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
401
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
402
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
403

404
    /* Copy subpicture information, set some default values */
405 406 407
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
408
    p_subpic->b_pausable = VLC_FALSE;
409
    p_subpic->b_fade     = VLC_FALSE;
410 411
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = 0;
412 413 414 415
    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
416

417
    p_subpic->pf_create_region = __spu_CreateRegion;
418
    p_subpic->pf_make_region = __spu_MakeRegion;
419
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
420

421
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
422 423
}

424 425 426
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
427 428 429
 * 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
430
 * by the spu.
431
 */
432
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
433
{
gbazin's avatar
 
gbazin committed
434
    /* Get lock */
435
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
436 437 438 439

    /* There can be race conditions so we need to check the status */
    if( p_subpic->i_status == FREE_SUBPICTURE )
    {
440
        vlc_mutex_unlock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
441 442 443
        return;
    }

444 445 446 447
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
448
        msg_Err( p_spu, "subpicture %p has invalid status %d",
449 450 451
                         p_subpic, p_subpic->i_status );
    }

452 453 454 455
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
456
        spu_DestroyRegion( p_spu, p_region );
457 458
    }

459 460 461 462 463 464
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

    p_subpic->i_status = FREE_SUBPICTURE;
gbazin's avatar
 
gbazin committed
465

466
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
467 468 469
}

/*****************************************************************************
470
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
471
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
472
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
473
 *****************************************************************************/
474 475 476
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,
477
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
478
{
gbazin's avatar
 
gbazin committed
479
    /* Get lock */
480
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
481 482 483

    /* 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
484
    {
485
        subpicture_region_t *p_region = p_subpic->p_region;
486
        int i_scale_width, i_scale_height;
487
        int i_subpic_x = p_subpic->i_x;
488

489
        /* Load the blending module */
490
        if( !p_spu->p_blend && p_region )
491
        {
492
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
493 494 495 496 497 498 499 500 501
            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');

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

504
        /* Load the text rendering module */
505
        if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
506
        {
507 508
            char *psz_modulename = NULL;

509
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
510 511 512 513
            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 =
514
                p_fmt->i_width;
515 516
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
517
                p_fmt->i_height;
518

519 520
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
521 522 523 524 525 526 527 528 529 530 531 532 533

            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 );
534
        }
535
        if( p_spu->p_text )
536
        {
537 538 539 540 541 542 543 544 545 546 547 548 549 550
            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 =
551
                    p_fmt->i_width;
552 553
                p_spu->p_text->fmt_out.video.i_height =
                    p_spu->p_text->fmt_out.video.i_visible_height =
554
                    p_fmt->i_height;
555
            }
556
        }
557

558 559 560
        i_scale_width = i_scale_width_orig;
        i_scale_height = i_scale_height_orig;

hartman's avatar
hartman committed
561 562
        if( p_subpic->i_original_picture_height > 0 &&
            p_subpic->i_original_picture_width  > 0 )
563 564
        {
            i_scale_width = i_scale_width * p_fmt->i_width /
zorglub's avatar
zorglub committed
565
                             p_subpic->i_original_picture_width;
566
            i_scale_height = i_scale_height * p_fmt->i_height /
zorglub's avatar
zorglub committed
567
                             p_subpic->i_original_picture_height;
568
        }
hartman's avatar
hartman committed
569 570 571 572 573 574
        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;
            i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height; 
        }
575

576 577 578
        /* 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) )
zorglub's avatar
zorglub committed
579
        {
580 581 582 583 584 585 586 587 588
            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;
        }
589

590
        /* Take care of the aspect ratio */
591
        if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
592 593 594 595 596
            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;
597
            i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
598 599
        }

600
        /* Load the scaling module */
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
        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');
            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 );
618 619
        }

620
        while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
621
        {
622
            int i_fade_alpha = 255;
623 624
            int i_x_offset = p_region->i_x + i_subpic_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;
625

626 627
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
628
                if( p_spu->p_text && p_spu->p_text->p_module &&
629
                    p_spu->p_text->pf_render_text )
630 631
                {
                    p_region->i_align = p_subpic->i_flags;
632 633
                    p_spu->p_text->pf_render_text( p_spu->p_text,
                                                   p_region, p_region ); 
634 635 636
                }
            }

637
            /* Force palette if requested */
638
            if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
639
                p_region->fmt.i_chroma )
640
            {
641 642
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
643 644 645 646
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache )
647
            {
648 649 650 651 652 653 654 655 656
                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;
                }
657
            }
658

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
            if( (i_scale_width != 1000 || i_scale_height != 1000) &&
                p_spu->p_scale && !p_region->p_cache )
            {
                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;
687 688
                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;
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

                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;
            }

706 707 708 709 710 711 712 713 714 715 716 717 718
            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 -
719
                    i_subpic_x;
720 721 722 723 724 725
            }
            else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
            {
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
            }

726 727
            if( p_subpic->b_absolute )
            {
728
                i_x_offset = p_region->i_x +
729
                    i_subpic_x * i_scale_width / 1000;
730 731 732
                i_y_offset = p_region->i_y +
                    p_subpic->i_y * i_scale_height / 1000;

733
            }
734 735 736
            
            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );
737 738 739 740 741 742 743 744 745 746 747

            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 );
748 749 750
            }

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

752 753 754 755
            /* Force cropping if requested */
            if( p_spu->b_force_crop )
            {
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
756 757 758 759
                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;
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789

                /* 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;
                }
            }

790
            /* Update the output picture size */
791 792 793 794 795 796 797
            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;

798 799 800 801 802 803 804 805 806 807 808 809
            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 );
                }
            }

810 811
            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );
812

813 814
            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,
815
                i_fade_alpha * p_subpic->i_alpha / 255 );
816 817 818 819

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
820 821
        p_subpic = p_subpic->p_next;
    }
gbazin's avatar
 
gbazin committed
822

823
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
824 825 826
}

/*****************************************************************************
827
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
828 829 830 831 832 833 834 835 836
 *****************************************************************************
 * 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.
 *****************************************************************************/
837 838
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
                                   vlc_bool_t b_paused )
Sam Hocevar's avatar
 
Sam Hocevar committed
839
{
gbazin's avatar
gbazin committed
840 841 842 843
    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
844

845 846 847 848 849 850 851 852 853 854 855 856
    /* 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
857 858
    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
gbazin's avatar
gbazin committed
859
    for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
860
    {
gbazin's avatar
gbazin committed
861 862 863 864
        p_ephemer = 0;
        ephemer_date = 0;

        for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
865
        {
gbazin's avatar
gbazin committed
866 867
            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
868
            {
gbazin's avatar
gbazin committed
869 870 871 872 873 874 875 876
                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
877

gbazin's avatar
gbazin committed
878 879
            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
880

gbazin's avatar
gbazin committed
881 882 883
            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 >
884 885 886
                  p_spu->p_subpicture[i_index].i_start ) &&
                !( p_spu->p_subpicture[i_index].b_pausable &&
                   b_paused ) )
gbazin's avatar
gbazin committed
887 888 889 890 891
            {
                /* Too late, destroy the subpic */
                spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
892

gbazin's avatar
gbazin committed
893 894 895 896 897
            /* 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
898

gbazin's avatar
gbazin committed
899 900
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
901

gbazin's avatar
gbazin committed
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
            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
917 918 919
            }
            else
            {
gbazin's avatar
gbazin committed
920 921 922
                /* Ephemer subpicture can still live a bit */
                p_tmp->p_next = p_subpic;
                p_subpic = p_tmp;
Sam Hocevar's avatar
 
Sam Hocevar committed
923 924 925 926 927 928 929
            }
        }
    }

    return p_subpic;
}

930
/*****************************************************************************
931
 * SpuClearChannel: clear an spu channel
932
 *****************************************************************************
933
 * This function destroys the subpictures which belong to the spu channel
934 935
 * corresponding to i_channel_id.
 *****************************************************************************/
936
static void SpuClearChannel( spu_t *p_spu, int i_channel )