vout_subpictures.c 50.8 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2007 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
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
29
#include <vlc/vlc.h>
zorglub's avatar
zorglub committed
30 31 32 33
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
#include <vlc_osd.h>
34

35 36 37 38 39 40
/*****************************************************************************
 * 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 * );
41

gbazin's avatar
gbazin committed
42 43
static int spu_vaControlDefault( spu_t *, int, va_list );

44 45
static subpicture_t *sub_new_buffer( filter_t * );
static void sub_del_buffer( filter_t *, subpicture_t * );
46 47
static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
48 49
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
50

51 52 53 54 55
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 * );

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

62 63 64 65 66
enum {
    SCALE_DEFAULT,
    SCALE_TEXT,
    SCALE_SIZE
};
67
/**
68
 * Creates the subpicture unit
69
 *
70
 * \param p_this the parent object which creates the subpicture unit
71
 */
72
spu_t *__spu_Create( vlc_object_t *p_this )
73 74
{
    int i_index;
75
    spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
76 77 78

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

82 83 84
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
85
    p_spu->i_filter = 0;
gbazin's avatar
gbazin committed
86
    p_spu->pf_control = spu_vaControlDefault;
87 88

    /* Register the default subpicture channel */
gbazin's avatar
gbazin committed
89
    p_spu->i_channel = 2;
90 91

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

93 94
    vlc_object_attach( p_spu, p_this );

95 96 97 98 99 100 101 102 103 104 105 106
    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;

107 108 109
    /* 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 );
110 111 112
    p_spu->i_margin = val.i_int;

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

    spu_ParseChain( p_spu );

117
    return VLC_SUCCESS;
118
}
dionoea's avatar
 
dionoea committed
119

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

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

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

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

136 137 138 139 140
        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
141
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
142 143
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
144
                         "sub filter", psz_name, VLC_TRUE );
gbazin's avatar
gbazin committed
145 146 147 148 149 150 151 152
        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++;
        }
153 154
        else
        {
155
            msg_Dbg( p_spu, "no sub filter found" );
156
            config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
157 158 159
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
            vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
        }
160 161 162 163 164 165

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

dionoea's avatar
 
dionoea committed
166
        free( psz_name );
167
    }
gbazin's avatar
gbazin committed
168
    if( val.psz_string ) free( val.psz_string );
169

170
    return VLC_SUCCESS;
171 172 173
}

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

182 183
    vlc_object_detach( p_spu );

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

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

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

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

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

211 212 213 214 215 216 217 218 219
    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 );
    }

220 221 222 223 224 225 226 227 228
    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 )
Rafaël Carré's avatar
Rafaël Carré committed
229
    while( p_spu->i_filter )
230
    {
Rafaël Carré's avatar
Rafaël Carré committed
231
        p_spu->i_filter--;
232 233
        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
234
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
235
        config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
236 237 238
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }
239 240 241 242 243
}

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

251
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
252 253 254
    if( !p_input ) return;

    if( b_attach )
255
    {
256 257
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
258 259 260 261 262
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
263
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
264 265 266 267 268 269 270 271 272 273
        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
 */
274 275 276 277
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
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) );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
282 283
    if( !p_region ) return NULL;

284
    memset( p_region, 0, sizeof(subpicture_region_t) );
285 286
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
287
    p_region->fmt = *p_fmt;
288
    p_region->psz_text = NULL;
hartman's avatar
hartman committed
289
    p_region->p_style = NULL;
290 291 292 293 294 295

    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;

296
    p_region->picture.p_data_orig = NULL;
297 298

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
299 300 301 302 303 304 305

    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 );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
306
        if( p_fmt->p_palette ) free( p_fmt->p_palette );
307 308 309
        return NULL;
    }

310 311
    p_region->picture.pf_release = RegionPictureRelease;

312 313 314
    return p_region;
}

315 316 317 318 319 320 321 322 323 324 325 326
/**
 * 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) );
327
    (void)p_this;
328 329 330 331 332
    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
333
    p_region->p_style = NULL;
334 335 336 337 338 339 340 341 342 343 344 345

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

346 347 348 349 350 351 352 353 354
/**
 * 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;
355 356
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
357
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
358
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
359 360 361

    if( p_region->psz_text )
        free( p_region->psz_text );
362 363
    if( p_region->psz_html )
        free( p_region->psz_html );
364
    //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
365 366
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
367

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

385 386
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
387

388
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
389
    {
390 391 392
        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
393
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
394 395
}

396
/**
397
 * Allocate a subpicture in the spu heap.
398
 *
399
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
400 401 402
 * 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.
403
 * \param p_spu the subpicture unit in which to create the subpicture
404 405
 * \return NULL on error, a reserved subpicture otherwise
 */
406
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
407 408
{
    int                 i_subpic;                        /* subpicture index */
409
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
410

411
    /* Get lock */
412
    vlc_mutex_lock( &p_spu->subpicture_lock );
413

Sam Hocevar's avatar
 
Sam Hocevar committed
414 415 416
    /*
     * Look for an empty place
     */
yoann's avatar
yoann committed
417
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
418 419
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
420
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
421 422
        {
            /* Subpicture is empty and ready for allocation */
423 424
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
425
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
426 427 428
        }
    }

429 430
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
431
    {
432 433
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
434
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
435
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
436

437
    /* Copy subpicture information, set some default values */
438 439 440
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
441
    p_subpic->b_pausable = VLC_FALSE;
442
    p_subpic->b_fade     = VLC_FALSE;
443
    p_subpic->i_alpha    = 0xFF;
444 445 446 447
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
448
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
449

450
    p_subpic->pf_create_region = __spu_CreateRegion;
451
    p_subpic->pf_make_region = __spu_MakeRegion;
452
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
453

454
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
455 456
}

457 458 459
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
460 461 462
 * 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
463
 * by the spu.
464
 */
465
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
466
{
gbazin's avatar
 
gbazin committed
467
    /* Get lock */
468
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
469 470 471 472

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

477 478 479 480
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
481
        msg_Err( p_spu, "subpicture %p has invalid status %d",
482 483 484
                         p_subpic, p_subpic->i_status );
    }

485 486 487 488
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
489
        spu_DestroyRegion( p_spu, p_region );
490 491
    }

492 493 494 495 496 497
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

499
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
500 501 502
}

/*****************************************************************************
503
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
504
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
505
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
506
 *****************************************************************************/
507 508 509
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,
510
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
511
{
512 513 514
    int i_source_video_width  = p_fmt->i_width  * 1000 / i_scale_width_orig;
    int i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;

gbazin's avatar
 
gbazin committed
515
    /* Get lock */
516
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
517 518

    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
519
    while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
520
    {
521
        subpicture_region_t *p_region = p_subpic->p_region;
522 523 524 525 526
        int pi_scale_width[ SCALE_SIZE ];
        int pi_scale_height[ SCALE_SIZE ];
        int pi_subpic_x[ SCALE_SIZE ];
        int k;

527 528 529 530 531 532 533 534 535 536 537
        /* If the source video and subtitles stream agree on the size of
         * the video then disregard all further references to the subtitle
         * stream.
         */
        if( ( i_source_video_height == p_subpic->i_original_picture_height ) &&
            ( i_source_video_width  == p_subpic->i_original_picture_width ) )
        {
            p_subpic->i_original_picture_height = 0;
            p_subpic->i_original_picture_width = 0;
        }

538
        for( k = 0; k < SCALE_SIZE ; k++ )
539
            pi_subpic_x[ k ] = p_subpic->i_x;
540

541
        /* Load the blending module */
542
        if( !p_spu->p_blend && p_region )
543
        {
544
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
545 546 547 548 549 550
            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;

551 552 553
            /* The blend module will be loaded when needed with the real input format */
            memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
            p_spu->p_blend->p_module = NULL;
554
        }
555

556 557 558 559 560
        /* Load the text rendering module; it is possible there is a
         * text region somewhere in the subpicture other than the first
         * element in the region list, so just load it anyway as we'll
         * probably want it sooner or later. */
        if( !p_spu->p_text && p_region )
561
        {
562 563
            char *psz_modulename = NULL;

564
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
565 566 567 568
            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 =
569
                p_fmt->i_width;
570 571
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
572
                p_fmt->i_height;
573

574 575
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
576 577 578 579 580

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
581 582
                    module_Need( p_spu->p_text, "text renderer",
                                 psz_modulename, VLC_TRUE );
583 584 585 586 587 588 589
            }
            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 );
590
        }
591

592
        if( p_spu->p_text )
593
        {
594 595 596 597 598 599 600 601 602 603
            subpicture_region_t *p_text_region = p_subpic->p_region;

            /* Only overwrite the size fields if the region is still in pre-rendered
             * TEXT format. We have to traverse the subregion list because if more
             * than one subregion is present, the text region isn't guarentteed to
             * be the first in the list, and only text regions use this flag.
             * All of this effort assists with the rescaling of text that has been
             * rendered at native resolution, rather than video resolution.
             */
            while( p_text_region &&
604
                   ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
605
            {
606
                p_text_region = p_text_region->p_next;
607
            }
608 609 610

            if( p_text_region && 
                ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
611
            {
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
                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 =
                        p_fmt->i_width;
                    p_spu->p_text->fmt_out.video.i_height =
                        p_spu->p_text->fmt_out.video.i_visible_height =
                        p_fmt->i_height;
                }
631
            }
632
        }
633

634 635
        pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
        pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
636

637 638 639 640 641 642 643
        if( p_spu->p_text )
        {
            pi_scale_width[ SCALE_TEXT ]     = ( p_fmt->i_width * 1000 ) /
                                          p_spu->p_text->fmt_out.video.i_width;
            pi_scale_height[ SCALE_TEXT ]    = ( p_fmt->i_height * 1000 ) /
                                          p_spu->p_text->fmt_out.video.i_height;
        }
644 645 646 647 648 649 650 651 652
        /* If we have an explicit size plane to render to, then turn off
         * the fontsize rescaling.
         */
        if( (p_subpic->i_original_picture_height > 0) &&
            (p_subpic->i_original_picture_width  > 0) )
        {
            i_scale_width_orig  = 1000;
            i_scale_height_orig = 1000;
        }
653 654

        for( k = 0; k < SCALE_SIZE ; k++ )
655
        {
656 657 658 659
            /* Case of both width and height being specified has been dealt with
             * above by instead rendering to an output pane of the explicit
             * dimensions specified - we don't need to scale it.
             */
660
            if( (p_subpic->i_original_picture_height > 0) &&
661
                (p_subpic->i_original_picture_width  <= 0) )
662 663 664 665 666 667
            {
                pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
                                 p_subpic->i_original_picture_height;
                pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_height /
                                 p_subpic->i_original_picture_height;
            }
hartman's avatar
hartman committed
668
        }
669

670

671 672
        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
673
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
zorglub's avatar
zorglub committed
674
        {
675 676 677 678
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
679
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
680 681 682 683
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }
684

685
        /* Take care of the aspect ratio */
686 687 688
        if( p_region && 
            ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
              ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
689
        {
690
            for( k = 0; k < SCALE_SIZE ; k++ )
691 692 693 694 695 696
            {
                pi_scale_width[ k ] = pi_scale_width[ k ] *
                    (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
                    p_region->fmt.i_sar_den / p_fmt->i_sar_num;
                pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
            }
697 698
        }

699
        /* Load the scaling module */
700
        if( !p_spu->p_scale &&
701 702 703 704
           ((((pi_scale_width[ SCALE_TEXT ]    > 0)     || (pi_scale_height[ SCALE_TEXT ]    > 0)) &&
             ((pi_scale_width[ SCALE_TEXT ]    != 1000) || (pi_scale_height[ SCALE_TEXT ]    != 1000))) ||
            (((pi_scale_width[ SCALE_DEFAULT ] > 0)     || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
             ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
705 706 707 708 709 710
        {
            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');
711 712
            /* FIXME: We'll also be using it for YUVA and RGBA blending ... */

713 714 715 716 717 718 719 720 721
            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 );
722 723
        }

724
        while( p_region )
725
        {
726 727
            video_format_t orig_fmt = p_region->fmt;
            vlc_bool_t b_rerender_text = VLC_FALSE;
728
            int i_fade_alpha = 255;
729 730 731 732 733
            int i_x_offset;
            int i_y_offset;
            int i_scale_idx   = SCALE_DEFAULT;
            int i_inv_scale_x = 1000;
            int i_inv_scale_y = 1000;
734

735 736
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
737
                if( p_spu->p_text && p_spu->p_text->p_module )
738
                {
739 740
                    vlc_value_t  val;

dionoea's avatar
dionoea committed
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
                    /* Setup 3 variables which can be used to render
                     * time-dependent text (and effects). The first indicates
                     * the total amount of time the text will be on screen,
                     * the second the amount of time it has already been on
                     * screen (can be a negative value as text is layed out
                     * before it is rendered) and the third is a feedback
                     * variable from the renderer - if the renderer sets it
                     * then this particular text is time-dependent, eg. the
                     * visual progress bar inside the text in karaoke and the
                     * text needs to be rendered multiple times in order for
                     * the effect to work - we therefore need to return the
                     * region to its original state at the end of the loop,
                     * instead of leaving it in YUVA or YUVP.
                     * Any renderer which is unaware of how to render
                     * time-dependent text can happily ignore the variables
                     * and render the text the same as usual - it should at
                     * least show up on screen, but the effect won't change
                     * the text over time.
759 760 761 762 763 764 765 766 767 768 769 770 771
                     */

                    var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
                    val.i_time = p_subpic->i_stop - p_subpic->i_start;
                    var_Set( p_spu->p_text, "spu-duration", val );

                    var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
                    val.i_time = mdate() - p_subpic->i_start;
                    var_Set( p_spu->p_text, "spu-elapsed", val );

                    var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
                    var_SetBool( p_spu->p_text, "text-rerender", VLC_FALSE );

772 773 774 775
                    var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
                    var_SetInteger( p_spu->p_text, "scale",
                              __MIN(i_scale_width_orig, i_scale_height_orig) );

776 777 778 779 780 781 782 783
                    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,
dionoea's avatar
dionoea committed
784
                                                       p_region, p_region );
785
                    }
786 787 788 789 790
                    b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );

                    var_Destroy( p_spu->p_text, "spu-duration" );
                    var_Destroy( p_spu->p_text, "spu-elapsed" );
                    var_Destroy( p_spu->p_text, "text-rerender" );
791
                    var_Destroy( p_spu->p_text, "scale" );
792
                }
793
                p_region->i_align |= SUBPICTURE_RENDERED;
794
            }
795

796 797 798 799 800 801 802 803 804
            if( p_region->i_align & SUBPICTURE_RENDERED )
            {
                i_scale_idx   = SCALE_TEXT;
                i_inv_scale_x = i_scale_width_orig;
                i_inv_scale_y = i_scale_height_orig;
            }

            i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
            i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;
805

806
            /* Force palette if requested */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
807
            if( p_spu->b_force_palette &&
808
                ( VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma ) )
809
            {
810 811
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
812 813 814
            }

            /* Scale SPU if necessary */
815 816
            if( p_region->p_cache && 
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
817
            {
818
                if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
819
                    p_region->p_cache->fmt.i_width ||
820
                    pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
821 822 823 824 825 826
                    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;
                }
827
            }
828

829 830 831 832 833 834
            if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) || 
                  ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
                ( ( pi_scale_width[ i_scale_idx ] > 0 ) || 
                  ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
                p_spu->p_scale && !p_region->p_cache &&
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
            {
                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 =
853
                    p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
854
                p_spu->p_scale->fmt_out.video.i_visible_width =
855
                    p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
856
                p_spu->p_scale->fmt_out.video.i_height =
857
                    p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
858
                p_spu->p_scale->fmt_out.video.i_visible_height =
859
                    p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
860
                p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
861 862
                p_region->p_cache->i_x = p_region->i_x * pi_scale_width[ i_scale_idx ] / 1000;
                p_region->p_cache->i_y = p_region->i_y * pi_scale_height[ i_scale_idx ] / 1000;
Laurent Aimar's avatar
Laurent Aimar committed
863
                p_region->p_cache->i_align = p_region->i_align;
864 865 866 867 868 869 870 871 872 873 874

                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 );
                }
            }
875 876 877 878 879 880 881

            if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
                  ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
                ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
                  ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
                p_spu->p_scale && p_region->p_cache &&
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )  )
882 883 884 885
            {
                p_region = p_region->p_cache;
            }

Laurent Aimar's avatar
Laurent Aimar committed
886
            if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
887 888
            {
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
889
                    (p_subpic->i_y + p_region->i_y) * i_inv_scale_y / 1000;