vout_subpictures.c 51.7 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>
38

39 40 41 42 43 44
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static void UpdateSPU   ( spu_t *, vlc_object_t * );
static int  CropCallback( vlc_object_t *, char const *,
                          vlc_value_t, vlc_value_t, void * );
45

46 47
static int spu_vaControlDefault( spu_t *, int, va_list );

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

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

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

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

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

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

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

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

98 99
    vlc_object_attach( p_spu, p_this );

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

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

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

    spu_ParseChain( p_spu );

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

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

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

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

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

141 142 143 144 145
        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
146
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
147 148
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
149
                         "sub filter", psz_name, VLC_TRUE );
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) );
153 154 155 156 157 158 159
            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++;
            }
160
        }
161 162
        else
        {
163
            msg_Dbg( p_spu, "no sub filter found" );
164
            config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
165
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
166
            vlc_object_release( p_spu->pp_filter[p_spu->i_filter] );
167
        }
168 169 170 171 172 173

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

Antoine Cellerier's avatar
 
Antoine Cellerier committed
174
        free( psz_name );
175
    }
176
    free( val.psz_string );
177

178
    return VLC_SUCCESS;
179 180 181
}

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

190 191
    vlc_object_detach( p_spu );

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

201
    if( p_spu->p_blend )
202
    {
203 204
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
205

206
        vlc_object_detach( p_spu->p_blend );
207
        vlc_object_release( p_spu->p_blend );
208 209
    }

210
    if( p_spu->p_text )
211
    {
212 213
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
214

215
        vlc_object_detach( p_spu->p_text );
216
        vlc_object_release( p_spu->p_text );
217 218
    }

219 220 221 222 223 224
    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 );
225
        vlc_object_release( p_spu->p_scale );
226 227
    }

228 229 230
    spu_DeleteChain( p_spu );

    vlc_mutex_destroy( &p_spu->subpicture_lock );
231
    vlc_object_release( p_spu );
232 233 234 235 236
}

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

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

259
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
260 261 262
    if( !p_input ) return;

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

292
    memset( p_region, 0, sizeof(subpicture_region_t) );
293 294
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
295
    p_region->fmt = *p_fmt;
296
    p_region->psz_text = NULL;
297
    p_region->p_style = NULL;
298 299 300 301 302 303

    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;

304
    p_region->picture.p_data_orig = NULL;
305 306

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
307 308 309 310 311 312 313

    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 );
314
        free( p_fmt->p_palette );
315 316 317
        return NULL;
    }

318 319
    p_region->picture.pf_release = RegionPictureRelease;

320 321 322
    return p_region;
}

323 324 325 326 327 328 329 330 331 332 333 334
/**
 * 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) );
335
    (void)p_this;
336
    if( !p_region ) return NULL;
337 338 339 340 341
    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;
342
    p_region->p_style = NULL;
343 344 345 346 347 348 349 350 351 352 353 354

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

355 356 357 358 359 360 361 362 363
/**
 * 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;
364 365
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
366
    free( p_region->fmt.p_palette );
367
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
368

369 370
    free( p_region->psz_text );
    free( p_region->psz_html );
371
    //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
372 373
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
374

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

392 393
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
394

395
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
396
    {
397 398 399
        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
400
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
401 402
}

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

418
    /* Get lock */
419
    vlc_mutex_lock( &p_spu->subpicture_lock );
420

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

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

444
    /* Copy subpicture information, set some default values */
445 446 447
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
448
    p_subpic->b_pausable = VLC_FALSE;
449
    p_subpic->b_fade     = VLC_FALSE;
450
    p_subpic->i_alpha    = 0xFF;
451 452 453 454
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
455
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
456

457
    p_subpic->pf_create_region = __spu_CreateRegion;
458
    p_subpic->pf_make_region = __spu_MakeRegion;
459
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
460

461
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
462 463
}

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

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

484 485 486 487
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
488
        msg_Err( p_spu, "subpicture %p has invalid status %d",
489 490 491
                         p_subpic, p_subpic->i_status );
    }

492 493 494 495
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
496
        spu_DestroyRegion( p_spu, p_region );
497 498
    }

499 500 501 502 503 504
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

506
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
507 508 509
}

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

Gildas Bazin's avatar
 
Gildas Bazin committed
523
    /* Get lock */
524
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
525

526 527 528 529 530 531 532 533 534 535
    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() );
        }
    }

536 537 538 539 540 541 542 543
    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
544
    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
545
    while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
546
    {
547
        subpicture_region_t *p_region;
548 549 550 551 552
        int pi_scale_width[ SCALE_SIZE ];
        int pi_scale_height[ SCALE_SIZE ];
        int pi_subpic_x[ SCALE_SIZE ];
        int k;

553 554 555 556 557 558 559 560 561 562 563
        /* 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;
        }

564
        for( k = 0; k < SCALE_SIZE ; k++ )
565
            pi_subpic_x[ k ] = p_subpic->i_x;
566

567 568 569 570 571 572 573 574 575 576 577 578
        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;
        }

579
        /* Load the blending module */
580
        if( !p_spu->p_blend && p_region )
581
        {
582
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
583 584 585 586 587 588
            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;

589 590
            /* The blend module will be loaded when needed with the real
            * input format */
591 592
            memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
            p_spu->p_blend->p_module = NULL;
593
        }
594

595 596 597 598 599
        /* 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 )
600
        {
601 602
            char *psz_modulename = NULL;

603
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
604 605 606 607
            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 =
608
                p_fmt->i_width;
609 610
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
611
                p_fmt->i_height;
612

613 614
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
615 616 617 618 619

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
620 621
                    module_Need( p_spu->p_text, "text renderer",
                                 psz_modulename, VLC_TRUE );
622 623 624 625 626 627
            }
            if( !p_spu->p_text->p_module )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
            }
628
            free( psz_modulename );
629
        }
630

631
        if( p_spu->p_text )
632
        {
633 634
            subpicture_region_t *p_text_region = p_subpic->p_region;

635 636 637 638 639 640 641
            /* 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.
642 643
             */
            while( p_text_region &&
644
                   ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
645
            {
646
                p_text_region = p_text_region->p_next;
647
            }
648

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

674 675
        pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
        pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
676

677 678 679 680 681 682 683
        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;
        }
684 685 686 687 688 689 690 691 692
        /* 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;
        }
693 694

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

710 711
        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
712
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
713
        {
714 715 716 717
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
718
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
719 720 721 722
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }
723

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

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

752 753 754 755 756 757 758 759 760
            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 );
761 762
        }

763
        while( p_region )
764
        {
765 766
            video_format_t orig_fmt = p_region->fmt;
            vlc_bool_t b_rerender_text = VLC_FALSE;
767
            int i_fade_alpha = 255;
768 769 770 771 772
            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;
773

774 775
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
776
                if( p_spu->p_text && p_spu->p_text->p_module )
777
                {
778 779
                    vlc_value_t  val;

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

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

811 812 813 814
                    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) );

815 816 817 818 819 820 821 822
                    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
823
                                                       p_region, p_region );
824
                    }
825 826 827 828 829
                    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" );
830
                    var_Destroy( p_spu->p_text, "scale" );
831
                }
832
                p_region->i_align |= SUBPICTURE_RENDERED;
833
            }
834

835 836 837 838 839 840 841 842 843
            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;
844

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

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

868
            if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
869
                  ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
870
                ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
871 872 873
                  ( 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') ) )
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
            {
                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 =
892
                    p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
893
                p_spu->p_scale->fmt_out.video.i_visible_width =
894
                    p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
895
                p_spu->p_scale->fmt_out.video.i_height =
896
                    p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
897
                p_spu->p_scale->fmt_out.video.i_visible_height =
898
                    p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
899
                p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
900 901
                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
902
                p_region->p_cache->i_align = p_region->i_align;
903 904 905 906 907 908 909 910 911 912 913

                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 );
                }
            }
914 915 916 917 918