vout_subpictures.c 51.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
Antoine Cellerier's avatar
Antoine Cellerier committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
24 25 26 27 28
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
29 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33
#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
34 35 36 37
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
#include <vlc_osd.h>
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

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 * );

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

67 68 69 70 71
enum {
    SCALE_DEFAULT,
    SCALE_TEXT,
    SCALE_SIZE
};
72
/**
73
 * Creates the subpicture unit
74
 *
75
 * \param p_this the parent object which creates the subpicture unit
76
 */
77
spu_t *__spu_Create( vlc_object_t *p_this )
78 79
{
    int i_index;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
80 81
    spu_t *p_spu = vlc_custom_create( p_this, sizeof( spu_t ),
                                      VLC_OBJECT_GENERIC, "subpicture" );
82 83 84

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
85
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
86 87
    }

88 89 90
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
91
    p_spu->i_filter = 0;
92
    p_spu->pf_control = spu_vaControlDefault;
93 94

    /* Register the default subpicture channel */
95
    p_spu->i_channel = 2;
96

97
    vlc_mutex_init( &p_spu->subpicture_lock );
98

99 100
    vlc_object_attach( p_spu, p_this );

101 102 103 104 105 106 107 108 109 110 111 112
    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;

113 114 115
    /* 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 );
116 117 118
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
119 120 121 122
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

123
    return VLC_SUCCESS;
124
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
125

126 127 128 129 130
int spu_ParseChain( spu_t *p_spu )
{
    char *psz_parser;
    vlc_value_t val;
    var_Get( p_spu, "sub-filter", &val );
131
    psz_parser = val.psz_string;
Antoine Cellerier's avatar
 
Antoine Cellerier committed
132 133

    while( psz_parser && *psz_parser )
134
    {
135
        config_chain_t *p_cfg;
Antoine Cellerier's avatar
 
Antoine Cellerier committed
136 137 138
        char *psz_name;

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

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

142 143 144 145 146
        p_spu->pp_filter[p_spu->i_filter] =
            vlc_object_create( p_spu, VLC_OBJECT_FILTER );
        vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
        p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
        p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
Antoine Cellerier's avatar
Antoine Cellerier committed
147
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
148 149
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
150
                         "sub filter", psz_name, true );
151 152
        free( psz_name );

153 154 155
        if( p_spu->pp_filter[p_spu->i_filter]->p_module )
        {
            filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
156 157 158 159 160 161 162
            if( p_sys )
            {
                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++;
            }
163
        }
164 165
        else
        {
166
            msg_Dbg( p_spu, "no sub filter found" );
167
            config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
168
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
169
            vlc_object_release( p_spu->pp_filter[p_spu->i_filter] );
170
        }
171 172 173 174

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

178
    }
179
    free( val.psz_string );
180

181
    return VLC_SUCCESS;
182 183 184
}

/**
185
 * Destroy the subpicture unit
186
 *
187
 * \param p_this the parent object which destroys the subpicture unit
188
 */
189
void spu_Destroy( spu_t *p_spu )
190 191 192
{
    int i_index;

193 194
    vlc_object_detach( p_spu );

195 196 197
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
198
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
199
        {
200
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
201 202 203
        }
    }

204
    if( p_spu->p_blend )
205
    {
206 207
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
208

209
        vlc_object_detach( p_spu->p_blend );
210
        vlc_object_release( p_spu->p_blend );
211 212
    }

213
    if( p_spu->p_text )
214
    {
215 216
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
217

218
        vlc_object_detach( p_spu->p_text );
219
        vlc_object_release( p_spu->p_text );
220 221
    }

222 223 224 225 226 227
    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 );
228
        vlc_object_release( p_spu->p_scale );
229 230
    }

231 232 233
    spu_DeleteChain( p_spu );

    vlc_mutex_destroy( &p_spu->subpicture_lock );
234
    vlc_object_release( p_spu );
235 236 237 238 239
}

static void spu_DeleteChain( spu_t *p_spu )
{
    if( p_spu->i_filter )
Rafaël Carré's avatar
Rafaël Carré committed
240
    while( p_spu->i_filter )
241
    {
Rafaël Carré's avatar
Rafaël Carré committed
242
        p_spu->i_filter--;
243 244
        module_Unneed( p_spu->pp_filter[p_spu->i_filter],
                       p_spu->pp_filter[p_spu->i_filter]->p_module );
245
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
246
        config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
247
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
248
        vlc_object_release( p_spu->pp_filter[p_spu->i_filter] );
249
    }
250 251 252 253 254
}

/**
 * Attach/Detach the SPU from any input
 *
255
 * \param p_this the object in which to destroy the subpicture unit
256 257
 * \param b_attach to select attach or detach
 */
258
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
259 260 261
{
    vlc_object_t *p_input;

262
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
263 264 265
    if( !p_input ) return;

    if( b_attach )
266
    {
267 268
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
269 270 271 272 273
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
274
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
275 276 277 278 279 280 281 282 283 284
        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
 */
285 286
static void RegionPictureRelease( picture_t *p_pic )
{
287
    free( p_pic->p_data_orig );
288
}
289 290 291 292
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
293 294
    if( !p_region ) return NULL;

295
    memset( p_region, 0, sizeof(subpicture_region_t) );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
296
    p_region->i_alpha = 0xff;
297 298
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
299
    p_region->fmt = *p_fmt;
300
    p_region->psz_text = NULL;
301
    p_region->p_style = NULL;
302 303 304 305 306 307

    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;

308
    p_region->picture.p_data_orig = NULL;
309 310

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
311 312 313 314 315 316 317

    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 );
318
        free( p_fmt->p_palette );
319 320 321
        return NULL;
    }

322 323
    p_region->picture.pf_release = RegionPictureRelease;

324 325 326
    return p_region;
}

327 328 329 330 331 332 333 334 335 336 337 338
/**
 * 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) );
339
    (void)p_this;
340
    if( !p_region ) return NULL;
341
    memset( p_region, 0, sizeof(subpicture_region_t) );
342
    p_region->i_alpha = 0xff;
343 344 345 346
    p_region->p_next = 0;
    p_region->p_cache = 0;
    p_region->fmt = *p_fmt;
    p_region->psz_text = 0;
347
    p_region->p_style = NULL;
348 349 350 351 352 353 354 355 356 357 358 359

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

360 361 362 363 364 365 366 367 368
/**
 * 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;
369 370
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
371
    free( p_region->fmt.p_palette );
372
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
373

374 375
    free( p_region->psz_text );
    free( p_region->psz_html );
376
    //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
377 378
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
379

380
/**
381
 * Display a subpicture
382
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
383 384
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
385
 * \param p_spu the subpicture unit object
386 387
 * \param p_subpic the subpicture to display
 */
388
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
389 390 391 392
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
393 394
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
395 396
    }

397 398
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
399

400
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
401
    {
402 403 404
        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
405
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
406 407
}

408
/**
409
 * Allocate a subpicture in the spu heap.
410
 *
411
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
412 413 414
 * 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.
415
 * \param p_spu the subpicture unit in which to create the subpicture
416 417
 * \return NULL on error, a reserved subpicture otherwise
 */
418
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
419 420
{
    int                 i_subpic;                        /* subpicture index */
421
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
422

423
    /* Get lock */
424
    vlc_mutex_lock( &p_spu->subpicture_lock );
425

Sam Hocevar's avatar
 
Sam Hocevar committed
426 427 428
    /*
     * Look for an empty place
     */
429
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
430 431
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
432
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
433 434
        {
            /* Subpicture is empty and ready for allocation */
435 436
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
437
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
438 439 440
        }
    }

441 442
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
443
    {
444 445
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
446
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
447
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
448

449
    /* Copy subpicture information, set some default values */
450 451
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
452 453 454
    p_subpic->b_absolute = true;
    p_subpic->b_pausable = false;
    p_subpic->b_fade     = false;
455
    p_subpic->i_alpha    = 0xFF;
456 457 458 459
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
460
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
461

462
    p_subpic->pf_create_region = __spu_CreateRegion;
463
    p_subpic->pf_make_region = __spu_MakeRegion;
464
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
465

466
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
467 468
}

469 470 471
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
472 473 474
 * 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
475
 * by the spu.
476
 */
477
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
478
{
Gildas Bazin's avatar
 
Gildas Bazin committed
479
    /* Get lock */
480
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
481 482 483 484

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

489 490 491 492
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
493
        msg_Err( p_spu, "subpicture %p has invalid status %d",
494 495 496
                         p_subpic, p_subpic->i_status );
    }

497 498 499 500
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
501
        spu_DestroyRegion( p_spu, p_region );
502 503
    }

504 505 506 507 508 509
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

511
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
512 513 514
}

/*****************************************************************************
515
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
516
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
517
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
518
 *****************************************************************************/
519 520 521
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,
522
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
523
{
524 525
    int i_source_video_width;
    int i_source_video_height;
526
    subpicture_t *p_subpic_v = p_subpic;
527

Gildas Bazin's avatar
 
Gildas Bazin committed
528
    /* Get lock */
529
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
530

531 532 533 534 535 536 537 538 539 540
    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() );
        }
    }

541 542 543 544 545 546 547 548
    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;

Gildas Bazin's avatar
 
Gildas Bazin committed
549
    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
550
    while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
551
    {
552
        subpicture_region_t *p_region;
553 554 555 556 557
        int pi_scale_width[ SCALE_SIZE ];
        int pi_scale_height[ SCALE_SIZE ];
        int pi_subpic_x[ SCALE_SIZE ];
        int k;

558 559 560 561 562 563 564 565 566 567 568
        /* 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;
        }

569
        for( k = 0; k < SCALE_SIZE ; k++ )
570
            pi_subpic_x[ k ] = p_subpic->i_x;
571

572 573 574 575 576 577 578 579 580 581 582 583
        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;
        }

584
        /* Load the blending module */
585
        if( !p_spu->p_blend && p_region )
586
        {
587
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
588 589 590 591 592 593
            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;

594 595
            /* The blend module will be loaded when needed with the real
            * input format */
596 597
            memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
            p_spu->p_blend->p_module = NULL;
598
        }
599

600 601 602 603 604
        /* 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 )
605
        {
606 607
            char *psz_modulename = NULL;

608
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
609 610 611 612
            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 =
613
                p_fmt->i_width;
614 615
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
616
                p_fmt->i_height;
617

618 619
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
620 621 622 623 624

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
625
                    module_Need( p_spu->p_text, "text renderer",
626
                                 psz_modulename, true );
627 628 629 630 631 632
            }
            if( !p_spu->p_text->p_module )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
            }
633
            free( psz_modulename );
634
        }
635

636
        if( p_spu->p_text )
637
        {
638 639
            subpicture_region_t *p_text_region = p_subpic->p_region;

640 641 642 643 644 645 646
            /* 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.
647 648
             */
            while( p_text_region &&
649
                   ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
650
            {
651
                p_text_region = p_text_region->p_next;
652
            }
653

654
            if( p_text_region &&
655
                ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
656
            {
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
                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;
                }
676
            }
677
        }
678

679 680
        pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
        pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
681

682 683 684 685 686 687 688
        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;
        }
689 690 691 692 693 694 695 696 697
        /* 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;
        }
698 699

        for( k = 0; k < SCALE_SIZE ; k++ )
700
        {
701 702 703
            /* 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.
704
             */
705
            if( (p_subpic->i_original_picture_height > 0) &&
Jean-Paul Saman's avatar
Jean-Paul Saman committed
706
                (p_subpic->i_original_picture_width <= 0) )
707 708 709 710 711 712
            {
                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;
            }
713
        }
714

715 716
        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
717
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
718
        {
719 720 721 722
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
723
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
724 725 726 727
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }
728

729
        /* Take care of the aspect ratio */
730
        if( p_region &&
731 732
            ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
              ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
733
        {
734
            for( k = 0; k < SCALE_SIZE ; k++ )
735 736 737 738 739 740
            {
                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;
            }
741 742
        }

743
        /* Load the scaling module */
744
        if( !p_spu->p_scale &&
745 746 747 748
           ((((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)))) )
749 750 751 752 753 754
        {
            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');
755 756
            /* FIXME: We'll also be using it for YUVA and RGBA blending ... */

757 758 759 760 761 762 763 764 765
            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 );
766 767
        }

768
        while( p_region )
769
        {
770
            video_format_t orig_fmt = p_region->fmt;
771
            bool b_rerender_text = false;
772
            int i_fade_alpha = 255;
773 774 775 776 777
            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;
778

779 780
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
781
                if( p_spu->p_text && p_spu->p_text->p_module )
782
                {
783 784
                    vlc_value_t  val;

Antoine Cellerier's avatar
Antoine Cellerier committed
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
                    /* 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.
803 804 805 806 807 808 809 810 811 812 813
                     */

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

816 817 818 819
                    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) );

820 821 822 823 824 825 826 827
                    if( p_spu->p_text->pf_render_html && p_region->psz_html )
                    {
                        p_spu->p_text->pf_render_html( p_spu->p_text,
                                                       p_region, p_region );
                    }
                    else if( p_spu->p_text->pf_render_text )
                    {
                        p_spu->p_text->pf_render_text( p_spu->p_text,
Antoine Cellerier's avatar
Antoine Cellerier committed
828
                                                       p_region, p_region );
829
                    }
830 831 832 833 834
                    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" );
835
                    var_Destroy( p_spu->p_text, "scale" );
836
                }
837
                p_region->i_align |= SUBPICTURE_RENDERED;
838
            }
839

840 841 842 843 844 845 846 847 848
            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;
849

850
            /* Force palette if requested */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
851
            if( p_spu->b_force_palette &&
852
                ( VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma ) )
853
            {
854 855
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
856 857 858
            }

            /* Scale SPU if necessary */
859
            if( p_region->p_cache &&
860
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
861
            {
862
                if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
863
                    p_region->p_cache->fmt.i_width ||
864
                    pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
865 866 867 868 869 870
                    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;
                }
871
            }
872

873
            if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
874
                  ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
875
                ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
876 877 878
                  ( 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') ) )
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
            {
                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 =
897
                    p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
898
                p_spu->p_scale->fmt_out.video.i_visible_width =
899
                    p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
900
                p_spu->p_scale->fmt_out.video.i_height =
901
                    p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
902
                p_spu->p_scale->fmt_out.video.i_visible_height =