vout_subpictures.c 39.3 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>
Sam Hocevar's avatar
 
Sam Hocevar committed
34

35
#include "vlc_block.h"
36
#include "vlc_video.h"
Sam Hocevar's avatar
 
Sam Hocevar committed
37
#include "video_output.h"
38
#include "vlc_spu.h"
39 40
#include "vlc_filter.h"

41 42 43 44 45 46
/*****************************************************************************
 * 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 * );
47

gbazin's avatar
gbazin committed
48 49
static int spu_vaControlDefault( spu_t *, int, va_list );

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

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

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 74

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

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

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

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

89 90
    vlc_object_attach( p_spu, p_this );

91 92 93 94 95 96 97 98 99 100
    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
101 102
    char *psz_filter;
    char *psz_parser;
103 104
    vlc_value_t val;

105 106 107
    /* 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 );
108 109 110 111
    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
112 113 114 115 116

    psz_filter = val.psz_string;
    psz_parser = psz_filter;

    while( psz_parser && *psz_parser )
117
    {
dionoea's avatar
 
dionoea committed
118 119 120 121
        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 );
122

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

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

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

dionoea's avatar
 
dionoea committed
154
        free( psz_name );
155
    }
156

157
    return VLC_EGENERIC;
158 159 160
}

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

169 170
    vlc_object_detach( p_spu );

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

180
    if( p_spu->p_blend )
181
    {
182 183
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
184

185 186
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
187 188
    }

189
    if( p_spu->p_text )
190
    {
191 192
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
193

194 195
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
196 197
    }

198 199 200 201 202 203 204 205 206
    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 );
    }

207 208 209 210
    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
211
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
212 213 214 215
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }

216 217
    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
218 219 220 221 222
}

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

230
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
231 232 233
    if( !p_input ) return;

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

    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;

273
    p_region->picture.p_data_orig = NULL;
274 275

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
276 277 278 279 280 281 282

    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 );
283
        free( p_fmt->p_palette );
284 285 286
        return NULL;
    }

287 288
    p_region->picture.pf_release = RegionPictureRelease;

289 290 291
    return p_region;
}

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
/**
 * 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
309
    p_region->p_style = NULL;
310 311 312 313 314 315 316 317 318 319 320 321

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

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

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

355 356
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
357

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

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

381
    /* Get lock */
382
    vlc_mutex_lock( &p_spu->subpicture_lock );
383

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

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

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

420
    p_subpic->pf_create_region = __spu_CreateRegion;
421
    p_subpic->pf_make_region = __spu_MakeRegion;
422
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
423

424
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
425 426
}

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

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

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

455 456 457 458
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
459
        spu_DestroyRegion( p_spu, p_region );
460 461
    }

462 463 464 465 466 467
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

469
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
470 471 472
}

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

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

492
        /* Load the blending module */
493
        if( !p_spu->p_blend && p_region )
494
        {
495
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
496 497 498 499 500 501 502 503 504
            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 );
505
        }
506

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

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

522 523
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
524 525 526 527 528 529 530 531 532 533 534 535 536

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

561 562 563
        i_scale_width = i_scale_width_orig;
        i_scale_height = i_scale_height_orig;

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

579 580 581
        /* 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
582
        {
583 584 585 586 587 588 589 590 591
            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;
        }
592

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

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

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

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

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

            /* Scale SPU if necessary */
            if( p_region->p_cache )
650
            {
651 652 653 654 655 656 657 658 659
                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;
                }
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 687 688 689
            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;
690 691
                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;
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

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

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

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

736 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 810 811
            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 );
                }
            }

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

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
817 818
        p_subpic = p_subpic->p_next;
    }
gbazin's avatar
 
gbazin committed
819

820
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
821 822 823
}

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

842 843 844 845 846 847 848 849 850 851 852 853
    /* 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
854 855
    /* 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
856
    for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
857
    {
gbazin's avatar
gbazin committed
858 859 860 861
        p_ephemer = 0;
        ephemer_date = 0;

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

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

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

gbazin's avatar
gbazin committed
890 891 892 893 894
            /* 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
895

gbazin's avatar
gbazin committed
896 897
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
898

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

    return p_subpic;
}

927
/*****************************************************************************
928
 * SpuClearChannel: clear an spu channel
929
 *****************************************************************************
930
 * This function destroys the subpictures which belong to the spu channel
931 932
 * corresponding to i_channel_id.
 *****************************************************************************/
933
static void SpuClearChannel( spu_t *p_spu, int i_channel )
934
{
gbazin's avatar
gbazin committed
935 936
    int          i_subpic;                               /* subpicture index */
    subpicture_t *p_subpic = NULL;                  /* first free subpicture */
937

938
    vlc_mutex_lock( &p_spu->subpicture_lock );