vout_subpictures.c 50.4 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 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33
#include <vlc_common.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>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
38
#include "../libvlc.h"
39

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

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

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

56 57 58 59 60
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 * );

dionoea's avatar
dionoea committed
61 62
static int sub_filter_allocation_init( filter_t *, void * );
static void sub_filter_allocation_clear( filter_t * );
gbazin's avatar
gbazin committed
63 64 65 66 67 68
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

69 70 71 72 73
enum {
    SCALE_DEFAULT,
    SCALE_TEXT,
    SCALE_SIZE
};
dionoea's avatar
dionoea committed
74

75
/**
76
 * Creates the subpicture unit
77
 *
78
 * \param p_this the parent object which creates the subpicture unit
79
 */
80
spu_t *__spu_Create( vlc_object_t *p_this )
81 82
{
    int i_index;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
83 84
    spu_t *p_spu = vlc_custom_create( p_this, sizeof( spu_t ),
                                      VLC_OBJECT_GENERIC, "subpicture" );
85 86 87

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
88
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
89 90
    }

91 92 93
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
gbazin's avatar
gbazin committed
94
    p_spu->pf_control = spu_vaControlDefault;
95 96

    /* Register the default subpicture channel */
gbazin's avatar
gbazin committed
97
    p_spu->i_channel = 2;
98

99
    vlc_mutex_init( &p_spu->subpicture_lock );
100

101 102
    vlc_object_attach( p_spu, p_this );

dionoea's avatar
dionoea committed
103 104 105 106
    p_spu->p_chain = filter_chain_New( p_spu, "sub filter", false,
                                       sub_filter_allocation_init,
                                       sub_filter_allocation_clear,
                                       p_spu );
107 108 109 110 111 112 113 114 115 116 117 118
    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;

119 120 121
    /* 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 );
122 123 124
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
125 126 127 128
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

129
    return VLC_SUCCESS;
130
}
dionoea's avatar
 
dionoea committed
131

132 133
int spu_ParseChain( spu_t *p_spu )
{
dionoea's avatar
dionoea committed
134 135
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
    if( filter_chain_AppendFromString( p_spu->p_chain, psz_parser ) < 0 )
136
    {
dionoea's avatar
dionoea committed
137 138
        free( psz_parser );
        return VLC_EGENERIC;
139
    }
140

dionoea's avatar
dionoea committed
141
    free( psz_parser );
142
    return VLC_SUCCESS;
143 144 145
}

/**
146
 * Destroy the subpicture unit
147
 *
148
 * \param p_this the parent object which destroys the subpicture unit
149
 */
150
void spu_Destroy( spu_t *p_spu )
151 152 153
{
    int i_index;

154 155
    vlc_object_detach( p_spu );

156 157 158
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
159
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
160
        {
161
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
162 163 164
        }
    }

165
    if( p_spu->p_blend )
166
    {
167 168
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
169

170
        vlc_object_detach( p_spu->p_blend );
171
        vlc_object_release( p_spu->p_blend );
172 173
    }

174
    if( p_spu->p_text )
175
    {
176 177
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
178

179
        vlc_object_detach( p_spu->p_text );
180
        vlc_object_release( p_spu->p_text );
181 182
    }

183 184 185 186 187 188
    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 );
189
        vlc_object_release( p_spu->p_scale );
190 191
    }

192 193 194
    spu_DeleteChain( p_spu );

    vlc_mutex_destroy( &p_spu->subpicture_lock );
195
    vlc_object_release( p_spu );
196 197 198 199
}

static void spu_DeleteChain( spu_t *p_spu )
{
dionoea's avatar
dionoea committed
200
    filter_chain_Delete( p_spu->p_chain );
201 202 203 204 205
}

/**
 * Attach/Detach the SPU from any input
 *
206
 * \param p_this the object in which to destroy the subpicture unit
207 208
 * \param b_attach to select attach or detach
 */
209
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
210 211 212
{
    vlc_object_t *p_input;

213
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
214 215 216
    if( !p_input ) return;

    if( b_attach )
217
    {
218 219
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
220 221 222 223 224
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
225
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
226 227 228 229 230 231 232 233 234 235
        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
 */
236 237
static void RegionPictureRelease( picture_t *p_pic )
{
238
    free( p_pic->p_data_orig );
239
}
240 241 242 243
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
244 245
    if( !p_region ) return NULL;

246
    memset( p_region, 0, sizeof(subpicture_region_t) );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
247
    p_region->i_alpha = 0xff;
248 249
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
250
    p_region->fmt = *p_fmt;
251
    p_region->psz_text = NULL;
hartman's avatar
hartman committed
252
    p_region->p_style = NULL;
253 254 255 256 257 258

    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;

259
    p_region->picture.p_data_orig = NULL;
260 261

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
262 263 264 265 266 267 268

    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 );
269
        free( p_fmt->p_palette );
270 271 272
        return NULL;
    }

273 274
    p_region->picture.pf_release = RegionPictureRelease;

275 276 277
    return p_region;
}

278 279 280 281 282 283 284 285 286 287 288 289
/**
 * 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) );
290
    (void)p_this;
291
    if( !p_region ) return NULL;
292
    memset( p_region, 0, sizeof(subpicture_region_t) );
293
    p_region->i_alpha = 0xff;
294 295 296 297
    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
298
    p_region->p_style = NULL;
299 300 301 302 303 304 305 306 307 308 309 310

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

311 312 313 314 315 316 317 318 319
/**
 * 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;
320 321
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
322
    free( p_region->fmt.p_palette );
323
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
324

325 326
    free( p_region->psz_text );
    free( p_region->psz_html );
327
    //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
328 329
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
330

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

348 349
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
350

351
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
352
    {
353 354 355
        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
356
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
357 358
}

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

374
    /* Get lock */
375
    vlc_mutex_lock( &p_spu->subpicture_lock );
376

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

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

400
    /* Copy subpicture information, set some default values */
401 402
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
403 404 405
    p_subpic->b_absolute = true;
    p_subpic->b_pausable = false;
    p_subpic->b_fade     = false;
406
    p_subpic->i_alpha    = 0xFF;
407 408 409 410
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
411
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
412

413
    p_subpic->pf_create_region = __spu_CreateRegion;
414
    p_subpic->pf_make_region = __spu_MakeRegion;
415
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
416

417
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
418 419
}

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

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

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

448 449 450 451
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
452
        spu_DestroyRegion( p_spu, p_region );
453 454
    }

455 456 457 458 459 460
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

462
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
463 464 465
}

/*****************************************************************************
466
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
467
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
468
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
469
 *****************************************************************************/
470 471 472
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,
473
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
474
{
475 476
    int i_source_video_width;
    int i_source_video_height;
477
    subpicture_t *p_subpic_v = p_subpic;
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 484 485 486 487 488 489 490 491
    for( p_subpic_v = p_subpic;
            p_subpic_v != NULL && p_subpic_v->i_status != FREE_SUBPICTURE;
            p_subpic_v = p_subpic_v->p_next )
    {
        if( p_subpic_v->pf_pre_render )
        {
            p_subpic_v->pf_pre_render( p_fmt, p_spu, p_subpic_v, mdate() );
        }
    }

492 493 494 495 496 497 498 499
    if( i_scale_width_orig <= 0 )
        i_scale_width_orig = 1;
    if( i_scale_height_orig <= 0 )
        i_scale_height_orig = 1;

    i_source_video_width  = p_fmt->i_width  * 1000 / i_scale_width_orig;
    i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;

gbazin's avatar
 
gbazin committed
500
    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
501
    while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
502
    {
503
        subpicture_region_t *p_region;
504 505 506 507 508
        int pi_scale_width[ SCALE_SIZE ];
        int pi_scale_height[ SCALE_SIZE ];
        int pi_subpic_x[ SCALE_SIZE ];
        int k;

509 510 511 512 513 514 515 516 517 518 519
        /* 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;
        }

520
        for( k = 0; k < SCALE_SIZE ; k++ )
521
            pi_subpic_x[ k ] = p_subpic->i_x;
522

523 524 525 526 527 528 529 530 531 532 533 534
        if( p_subpic->pf_update_regions )
        {
            if ( p_subpic->p_region ) {
                spu_DestroyRegion( p_spu, p_subpic->p_region );
            }
            p_subpic->p_region = p_region = p_subpic->pf_update_regions( p_fmt, p_spu, p_subpic, mdate() );
        }
        else
        {
            p_region = p_subpic->p_region;
        }

535
        /* Load the blending module */
536
        if( !p_spu->p_blend && p_region )
537
        {
538
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
539 540 541 542 543 544
            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;

dionoea's avatar
dionoea committed
545 546
            /* The blend module will be loaded when needed with the real
            * input format */
547 548
            memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
            p_spu->p_blend->p_module = NULL;
549
        }
550

551 552 553 554 555
        /* 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 )
556
        {
557 558
            char *psz_modulename = NULL;

559
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
560 561 562 563
            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 =
564
                p_fmt->i_width;
565 566
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
567
                p_fmt->i_height;
568

569 570
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
571 572 573 574 575

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
576
                    module_Need( p_spu->p_text, "text renderer",
577
                                 psz_modulename, true );
578 579 580 581 582 583
            }
            if( !p_spu->p_text->p_module )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
            }
584
            free( psz_modulename );
585
        }
586

587
        if( p_spu->p_text )
588
        {
589 590
            subpicture_region_t *p_text_region = p_subpic->p_region;

dionoea's avatar
dionoea committed
591 592 593 594 595 596 597
            /* 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.
598 599
             */
            while( p_text_region &&
600
                   ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
601
            {
602
                p_text_region = p_text_region->p_next;
603
            }
604

dionoea's avatar
dionoea committed
605
            if( p_text_region &&
606
                ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
607
            {
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
                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;
                }
627
            }
628
        }
629

630 631
        pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
        pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
632

633 634 635 636 637 638 639
        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;
        }
640 641 642 643 644 645 646 647 648
        /* 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;
        }
649 650

        for( k = 0; k < SCALE_SIZE ; k++ )
651
        {
dionoea's avatar
dionoea committed
652 653 654
            /* 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.
655
             */
656
            if( (p_subpic->i_original_picture_height > 0) &&
Jean-Paul Saman's avatar
Jean-Paul Saman committed
657
                (p_subpic->i_original_picture_width <= 0) )
658 659 660 661 662 663
            {
                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
664
        }
665

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

680
        /* Take care of the aspect ratio */
dionoea's avatar
dionoea committed
681
        if( p_region &&
682 683
            ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
              ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
684
        {
685
            for( k = 0; k < SCALE_SIZE ; k++ )
686 687 688 689 690 691
            {
                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;
            }
692 693
        }

694
        /* Load the scaling module */
695
        if( !p_spu->p_scale &&
696 697 698 699
           ((((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)))) )
700 701 702 703 704 705
        {
            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');
706 707
            /* FIXME: We'll also be using it for YUVA and RGBA blending ... */

708 709 710 711 712 713 714 715 716
            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 );
717 718
        }

719
        while( p_region )
720
        {
721
            video_format_t orig_fmt = p_region->fmt;
722
            bool b_rerender_text = false;
723
            int i_fade_alpha = 255;
724 725 726 727 728
            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;
729

730 731
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
732
                if( p_spu->p_text && p_spu->p_text->p_module )
733
                {
734 735
                    vlc_value_t  val;

dionoea's avatar
dionoea committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
                    /* 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.
754 755 756 757 758 759 760 761 762 763 764
                     */

                    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 );
765
                    var_SetBool( p_spu->p_text, "text-rerender", false );
766

767 768 769 770
                    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) );

771 772 773 774 775 776 777 778
                    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
779
                                                       p_region, p_region );
780
                    }
781 782 783 784 785
                    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" );
786
                    var_Destroy( p_spu->p_text, "scale" );
787
                }
788
                p_region->i_align |= SUBPICTURE_RENDERED;
789
            }
790

791 792 793 794 795 796 797 798 799
            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;
800

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

            /* Scale SPU if necessary */
dionoea's avatar
dionoea committed
810
            if( p_region->p_cache &&
811
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
812
            {
813
                if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
814
                    p_region->p_cache->fmt.i_width ||
815
                    pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
816 817 818 819 820 821
                    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;
                }
822
            }
823

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

                p_pic = p_spu->p_scale->pf_video_filter(
                                 p_spu->p_scale, &p_region->