vout_subpictures.c 46.6 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_common.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
#include <assert.h>
41
#include <limits.h>
42

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

50 51
static int spu_vaControlDefault( spu_t *, int, va_list );

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

59 60 61 62
static int spu_ParseChain( spu_t * );
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

63 64
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
65 66 67 68 69 70
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

Laurent Aimar's avatar
Laurent Aimar committed
71 72
#define SCALE_UNIT (1000)

73 74 75 76
/* */
static void SpuRenderCreateAndLoadText( spu_t *p_spu );
static void SpuRenderCreateAndLoadScale( spu_t *p_spu );
static void FilterRelease( filter_t *p_filter );
77

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

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
91
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
92 93
    }

94 95 96
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
97
    p_spu->p_scale_yuvp = NULL;
98
    p_spu->pf_control = spu_vaControlDefault;
99 100

    /* Register the default subpicture channel */
101
    p_spu->i_channel = 2;
102

103
    vlc_mutex_init( &p_spu->subpicture_lock );
104

105 106
    vlc_object_attach( p_spu, p_this );

107
    p_spu->p_chain = filter_chain_New( p_spu, "sub filter", false,
108 109
                                       SubFilterAllocationInit,
                                       SubFilterAllocationClean,
110
                                       p_spu );
111 112 113 114 115

    /* Load text and scale module */
    SpuRenderCreateAndLoadText( p_spu );
    SpuRenderCreateAndLoadScale( p_spu );

116 117 118 119 120 121 122 123 124 125 126 127
    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;

128 129 130
    /* 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 );
131 132 133
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
134 135 136 137
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

138
    return VLC_SUCCESS;
139
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
140

141 142
int spu_ParseChain( spu_t *p_spu )
{
143 144
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
    if( filter_chain_AppendFromString( p_spu->p_chain, psz_parser ) < 0 )
145
    {
146 147
        free( psz_parser );
        return VLC_EGENERIC;
148
    }
149

150
    free( psz_parser );
151
    return VLC_SUCCESS;
152 153 154
}

/**
155
 * Destroy the subpicture unit
156
 *
157
 * \param p_this the parent object which destroys the subpicture unit
158
 */
159
void spu_Destroy( spu_t *p_spu )
160 161 162 163 164 165
{
    int i_index;

    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
166
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
167
        {
168
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
169 170 171
        }
    }

172
    if( p_spu->p_blend )
173
        FilterRelease( p_spu->p_blend );
174

175
    if( p_spu->p_text )
176
        FilterRelease( p_spu->p_text );
177

178 179
    if( p_spu->p_scale_yuvp )
        FilterRelease( p_spu->p_scale_yuvp );
180

181
    if( p_spu->p_scale )
182
        FilterRelease( p_spu->p_scale );
183

184
    filter_chain_Delete( p_spu->p_chain );
185 186

    vlc_mutex_destroy( &p_spu->subpicture_lock );
187
    vlc_object_release( p_spu );
188 189
}

190 191 192
/**
 * Attach/Detach the SPU from any input
 *
193
 * \param p_this the object in which to destroy the subpicture unit
194 195
 * \param b_attach to select attach or detach
 */
196
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
197 198 199
{
    vlc_object_t *p_input;

200
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
201 202 203
    if( !p_input ) return;

    if( b_attach )
204
    {
205 206
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
207 208 209 210 211
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
212
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
213 214 215 216
        vlc_object_release( p_input );
    }
}

217 218

/* */
219
static void RegionPictureRelease( picture_t *p_picture )
220
{
221 222 223 224 225 226 227
    if( --p_picture->i_refcount > 0 )
        return;

    assert( p_picture->i_refcount == 0 );
    free( p_picture->p_q );
    free( p_picture->p_data_orig );
    free( p_picture->p_sys );
228
}
229

230 231 232 233 234 235 236 237 238
/**
 * Create a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 */
subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
                                         video_format_t *p_fmt )
{
239
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
240 241
    if( !p_region )
        return NULL;
242

243 244 245 246 247 248 249 250 251 252 253 254 255
    /* FIXME is that *really* wanted? */
    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = calloc( 1, sizeof(video_palette_t) );
    else
        p_fmt->p_palette = NULL;    /* XXX and that above all? */

    p_region->fmt = *p_fmt;
    p_region->i_alpha = 0xff;
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
    p_region->psz_text = NULL;
    p_region->p_style = NULL;

256 257
    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') )
        return p_region;
258 259 260 261 262 263

    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 )
    {
264
        free( p_fmt->p_palette );
265
        free( p_region );
266 267 268
        return NULL;
    }

269
    p_region->picture.i_refcount = 1;
270 271
    p_region->picture.pf_release = RegionPictureRelease;

272 273 274 275 276 277 278 279 280 281 282
    return p_region;
}

/**
 * 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 )
{
283 284 285 286 287
    if( !p_region )
        return;

    picture_Release( &p_region->picture );

288
    free( p_region->fmt.p_palette );
289 290
    if( p_region->p_cache )
        __spu_DestroyRegion( p_this, p_region->p_cache );
291

292 293
    free( p_region->psz_text );
    free( p_region->psz_html );
294
    //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
295 296
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
297

298
/**
299
 * Display a subpicture
300
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
301 302
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
303
 * \param p_spu the subpicture unit object
304 305
 * \param p_subpic the subpicture to display
 */
306
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
307 308 309 310
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
311 312
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
313 314
    }

315 316
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
317

318
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
319
    {
320 321 322
        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
323
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
324 325
}

326
/**
327
 * Allocate a subpicture in the spu heap.
328
 *
329
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
330 331 332
 * 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.
333
 * \param p_spu the subpicture unit in which to create the subpicture
334 335
 * \return NULL on error, a reserved subpicture otherwise
 */
336
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
337 338
{
    int                 i_subpic;                        /* subpicture index */
339
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
340

341
    /* Get lock */
342
    vlc_mutex_lock( &p_spu->subpicture_lock );
343

Sam Hocevar's avatar
 
Sam Hocevar committed
344 345 346
    /*
     * Look for an empty place
     */
347
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
348 349
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
350
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
351 352
        {
            /* Subpicture is empty and ready for allocation */
353 354
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
355
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
356 357 358
        }
    }

359 360
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
361
    {
362 363
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
364
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
365
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
366

367
    /* Copy subpicture information, set some default values */
368 369
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
370 371
    p_subpic->b_absolute = true;
    p_subpic->b_fade     = false;
372
    p_subpic->b_subtitle = false;
373
    p_subpic->i_alpha    = 0xFF;
374 375 376 377
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
378
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
379

380 381
    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
382

383
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
384 385
}

386 387 388
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
389 390 391
 * 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
392
 * by the spu.
393
 */
394
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
395
{
Gildas Bazin's avatar
 
Gildas Bazin committed
396
    /* Get lock */
397
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
398 399 400 401

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

406 407 408 409
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
410
        msg_Err( p_spu, "subpicture %p has invalid status %d",
411 412 413
                         p_subpic, p_subpic->i_status );
    }

414 415 416 417
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
418
        spu_DestroyRegion( p_spu, p_region );
419 420
    }

421 422 423 424 425 426
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

428
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
429 430
}

431 432 433 434 435 436 437 438 439
static void FilterRelease( filter_t *p_filter )
{
    if( p_filter->p_module )
        module_Unneed( p_filter, p_filter->p_module );

    vlc_object_detach( p_filter );
    vlc_object_release( p_filter );
}

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
static void SpuRenderCreateBlend( spu_t *p_spu, vlc_fourcc_t i_chroma, int i_aspect )
{
    filter_t *p_blend;

    assert( !p_spu->p_blend );

    p_spu->p_blend =
    p_blend        = vlc_custom_create( p_spu, sizeof(filter_t),
                                        VLC_OBJECT_GENERIC, "blend" );
    if( !p_blend )
        return;

    es_format_Init( &p_blend->fmt_in, VIDEO_ES, 0 );

    es_format_Init( &p_blend->fmt_out, VIDEO_ES, 0 );
    p_blend->fmt_out.video.i_x_offset = 0;
    p_blend->fmt_out.video.i_y_offset = 0;
    p_blend->fmt_out.video.i_chroma = i_chroma;
    p_blend->fmt_out.video.i_aspect = i_aspect;

    /* The blend module will be loaded when needed with the real
    * input format */
    p_blend->p_module = NULL;

    /* */
    vlc_object_attach( p_blend, p_spu );
}
Laurent Aimar's avatar
Laurent Aimar committed
467
static void SpuRenderUpdateBlend( spu_t *p_spu, int i_out_width, int i_out_height, const video_format_t *p_in_fmt )
468 469 470 471 472 473
{
    filter_t *p_blend = p_spu->p_blend;

    assert( p_blend );

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
474
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
475 476 477 478 479 480 481 482
    {
        /* The chroma is not the same, we need to reload the blend module
         * XXX to match the old behaviour just test !p_blend->fmt_in.video.i_chroma */
        module_Unneed( p_blend, p_blend->p_module );
        p_blend->p_module = NULL;
    }

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
483 484 485 486 487 488 489
    p_blend->fmt_in.video = *p_in_fmt;

    /* */
    p_blend->fmt_out.video.i_width =
    p_blend->fmt_out.video.i_visible_width = i_out_width;
    p_blend->fmt_out.video.i_height =
    p_blend->fmt_out.video.i_visible_height = i_out_height;
490 491 492 493 494

    /* */
    if( !p_blend->p_module )
        p_blend->p_module = module_Need( p_blend, "video blending", 0, 0 );
}
495
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
{
    filter_t *p_text;

    assert( !p_spu->p_text );

    p_spu->p_text =
    p_text        = vlc_custom_create( p_spu, sizeof(filter_t),
                                       VLC_OBJECT_GENERIC, "spu text" );
    if( !p_text )
        return;

    es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );

    es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
    p_text->fmt_out.video.i_width =
511
    p_text->fmt_out.video.i_visible_width = 32;
512
    p_text->fmt_out.video.i_height =
513
    p_text->fmt_out.video.i_visible_height = 32;
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

    p_text->pf_sub_buffer_new = spu_new_buffer;
    p_text->pf_sub_buffer_del = spu_del_buffer;

    vlc_object_attach( p_text, p_spu );

    /* FIXME TOCHECK shouldn't module_Need( , , psz_modulename, false ) do the
     * same than these 2 calls ? */
    char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
    if( psz_modulename && *psz_modulename )
    {
        p_text->p_module = module_Need( p_text, "text renderer",
                                        psz_modulename, true );
    }
    free( psz_modulename );

    if( !p_text->p_module )
        p_text->p_module = module_Need( p_text, "text renderer", NULL, false );
}

534
static filter_t *CreateAndLoadScale( vlc_object_t *p_obj, vlc_fourcc_t i_chroma )
535 536 537
{
    filter_t *p_scale;

538 539
    p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
                                 VLC_OBJECT_GENERIC, "scale" );
540
    if( !p_scale )
541
        return NULL;
542 543

    es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
544
    p_scale->fmt_in.video.i_chroma = i_chroma;
545 546 547 548
    p_scale->fmt_in.video.i_width =
    p_scale->fmt_in.video.i_height = 32;

    es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
549
    p_scale->fmt_out.video.i_chroma = i_chroma;
550 551 552 553 554 555
    p_scale->fmt_out.video.i_width =
    p_scale->fmt_out.video.i_height = 16;

    p_scale->pf_vout_buffer_new = spu_new_video_buffer;
    p_scale->pf_vout_buffer_del = spu_del_video_buffer;

556 557 558 559 560 561 562 563 564 565 566 567 568
    vlc_object_attach( p_scale, p_obj );
    p_scale->p_module = module_Need( p_scale, "video filter2", 0, 0 );

    return p_scale;
}
static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
{
    /* FIXME: We'll also be using it for YUVA and RGBA blending ... */

    assert( !p_spu->p_scale );
    assert( !p_spu->p_scale_yuvp );
    p_spu->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu), VLC_FOURCC('Y','U','V','A') );
    p_spu->p_scale_yuvp = p_spu->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu), VLC_FOURCC('Y','U','V','P') );
569 570
}

Laurent Aimar's avatar
Laurent Aimar committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
                           subpicture_t *p_subpic, subpicture_region_t *p_region, int i_min_scale_ratio )
{
    assert( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') );

    if( !p_spu->p_text || !p_spu->p_text->p_module )
        goto exit;

    /* 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.
     */

    /* FIXME why these variables are recreated every time and not
     * when text renderer module was created ? */
    var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
    var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
    var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
    var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );

    var_SetTime( p_spu->p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
    var_SetTime( p_spu->p_text, "spu-elapsed", mdate() - p_subpic->i_start );
    var_SetBool( p_spu->p_text, "text-rerender", false );
    var_SetInteger( p_spu->p_text, "scale", i_min_scale_ratio );

    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,
                                       p_region, p_region );
    }
    *pb_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" );
    var_Destroy( p_spu->p_text, "scale" );

exit:
    p_region->i_align |= SUBPICTURE_RENDERED;
}

632 633 634
/**
 * A few scale functions helpers.
 */
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
typedef struct
{
    int w;
    int h;
} spu_scale_t;

static spu_scale_t spu_scale_create( int w, int h )
{
    spu_scale_t s = { .w = w, .h = h };
    if( s.w <= 0 )
        s.w = SCALE_UNIT;
    if( s.h <= 0 )
        s.h = SCALE_UNIT;
    return s;
}
static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd )
{
    return spu_scale_create( wn * SCALE_UNIT / wd,
                             hn * SCALE_UNIT / hd );
}
static int spu_scale_w( int v, const spu_scale_t s )
{
    return v * s.w / SCALE_UNIT;
}
static int spu_scale_h( int v, const spu_scale_t s )
{
    return v * s.h / SCALE_UNIT;
}
663 664 665 666
static int spu_invscale_h( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.h;
}
667

Laurent Aimar's avatar
Laurent Aimar committed
668 669 670 671 672
/**
 * Place a region
 */
static void SpuRegionPlace( int *pi_x, int *pi_y,
                            const subpicture_t *p_subpic,
673 674
                            const subpicture_region_t *p_region,
                            int i_margin_y )
Laurent Aimar's avatar
Laurent Aimar committed
675
{
676 677
    const int i_delta_x = p_region->i_x;
    const int i_delta_y = p_region->i_y;
Laurent Aimar's avatar
Laurent Aimar committed
678 679
    int i_x, i_y;

680
    assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
Laurent Aimar's avatar
Laurent Aimar committed
681 682 683 684 685 686
    if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
    {
        i_y = i_delta_y;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
    {
687
        i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
688 689 690
    }
    else
    {
691
        i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
Laurent Aimar's avatar
Laurent Aimar committed
692 693 694 695 696 697 698 699
    }

    if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
    {
        i_x = i_delta_x;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
    {
700
        i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
Laurent Aimar's avatar
Laurent Aimar committed
701 702 703
    }
    else
    {
704
        i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
Laurent Aimar's avatar
Laurent Aimar committed
705 706 707 708
    }

    if( p_subpic->b_absolute )
    {
709 710
        i_x = i_delta_x;
        i_y = i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
711
    }
712

713
    /* Margin shifts all subpictures */
714
    if( i_margin_y != 0 )
715
        i_y -= i_margin_y;
716

717 718 719 720
    /* Clamp offset to not go out of the screen (when possible) */
    const int i_error_x = (i_x + p_region->fmt.i_width) - p_subpic->i_original_picture_width;
    if( i_error_x > 0 )
        i_x -= i_error_x;
721 722
    if( i_x < 0 )
        i_x = 0;
723 724 725 726

    const int i_error_y = (i_y + p_region->fmt.i_height) - p_subpic->i_original_picture_height;
    if( i_error_y > 0 )
        i_y -= i_error_y;
727 728
    if( i_y < 0 )
        i_y = 0;
Laurent Aimar's avatar
Laurent Aimar committed
729

730 731
    *pi_x = i_x;
    *pi_y = i_y;
Laurent Aimar's avatar
Laurent Aimar committed
732 733
}

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
/**
 * This function computes the current alpha value for a given region.
 */
static int SpuRegionAlpha( subpicture_t *p_subpic, subpicture_region_t *p_region )
{
    /* Compute alpha blend value */
    int i_fade_alpha = 255;
    if( p_subpic->b_fade )
    {
        mtime_t i_fade_start = ( p_subpic->i_stop +
                                 p_subpic->i_start ) / 2;
        mtime_t i_now = mdate();

        if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
        {
            i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
                           ( p_subpic->i_stop - i_fade_start );
        }
    }
    return i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025;
}

Laurent Aimar's avatar
Laurent Aimar committed
756
static void SpuRenderRegion( spu_t *p_spu,
757
                             picture_t *p_pic_dst,
Laurent Aimar's avatar
Laurent Aimar committed
758
                             subpicture_t *p_subpic, subpicture_region_t *p_region,
759
                             const spu_scale_t scale_size,
Laurent Aimar's avatar
Laurent Aimar committed
760 761
                             const video_format_t *p_fmt )
{
762
    video_format_t fmt_original;
Laurent Aimar's avatar
Laurent Aimar committed
763
    bool b_rerender_text;
764
    bool b_restore_format = false;
Laurent Aimar's avatar
Laurent Aimar committed
765 766
    int i_x_offset;
    int i_y_offset;
767
    filter_t *p_scale;
Laurent Aimar's avatar
Laurent Aimar committed
768

769 770 771
    vlc_assert_locked( &p_spu->subpicture_lock );

    fmt_original = p_region->fmt;
Laurent Aimar's avatar
Laurent Aimar committed
772
    b_rerender_text = false;
Laurent Aimar's avatar
Laurent Aimar committed
773
    if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
Laurent Aimar's avatar
Laurent Aimar committed
774
    {
775 776
        const int i_min_scale_ratio = __MIN( scale_size.w, scale_size.h );
        SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region, i_min_scale_ratio );
777
        b_restore_format = b_rerender_text;
Laurent Aimar's avatar
Laurent Aimar committed
778

Laurent Aimar's avatar
Laurent Aimar committed
779 780 781 782
        /* Check if the rendering has failed ... */
        if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            goto exit;
    }
Laurent Aimar's avatar
Laurent Aimar committed
783

784 785 786 787 788 789 790 791
    /* Force palette if requested
     * FIXME b_force_palette and b_force_crop are applied to all subpictures using palette
     * instead of only the right one (being the dvd spu).
     */
    const bool b_using_palette = p_region->fmt.i_chroma == VLC_FOURCC('Y','U','V','P');
    const bool b_force_palette = b_using_palette && p_spu->b_force_palette;
    const bool b_force_crop    = b_force_palette && p_spu->b_force_crop;

792

793 794 795 796 797 798 799
    /* Compute the margin which is expressed in destination pixel unit
     * The margin is applied only to subtitle and when no forced crop is
     * requested (dvd menu) */
    int i_margin_y = 0;
    if( !b_force_crop && p_subpic->b_subtitle )
        i_margin_y = spu_invscale_h( p_spu->i_margin, scale_size );

800 801 802
    /* Place the picture
     * We compute the position in the rendered size */
    SpuRegionPlace( &i_x_offset, &i_y_offset,
803 804 805
                    p_subpic, p_region, i_margin_y );

    /* TODO save this position for subtitle overlap support */
806 807 808 809 810

    /* Fix the position for the current scale_size */
    i_x_offset = spu_scale_w( i_x_offset, scale_size );
    i_y_offset = spu_scale_h( i_y_offset, scale_size );

811
    if( b_force_palette )
Laurent Aimar's avatar
Laurent Aimar committed
812
    {
Laurent Aimar's avatar
Laurent Aimar committed
813
        /* It looks so wrong I won't comment
Laurent Aimar's avatar
Laurent Aimar committed
814 815 816
         * p_palette->palette is [256][4] with a int i_entries
         * p_spu->palette is [4][4]
         * */
817 818
        p_region->fmt.p_palette->i_entries = 4;
        memcpy( p_region->fmt.p_palette->palette, p_spu->palette, 4*sizeof(uint32_t) );
Laurent Aimar's avatar
Laurent Aimar committed
819 820
    }

821 822 823 824 825
    if( b_using_palette )
        p_scale = p_spu->p_scale_yuvp;
    else
        p_scale = p_spu->p_scale;

826
    /* Scale from rendered size to destination size */
827
    if( p_scale &&
Laurent Aimar's avatar
Laurent Aimar committed
828
        ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_force_palette ) )
Laurent Aimar's avatar
Laurent Aimar committed
829
    {
830 831
        const unsigned i_dst_width  = spu_scale_w( p_region->fmt.i_width, scale_size );
        const unsigned i_dst_height = spu_scale_h( p_region->fmt.i_height, scale_size );
Laurent Aimar's avatar
Laurent Aimar committed
832

833 834 835
        /* TODO when b_using_palette is true, we should first convert it to YUVA to allow
         * a proper rescaling */

Laurent Aimar's avatar
Laurent Aimar committed
836 837 838 839
        /* Destroy if cache is unusable */
        if( p_region->p_cache )
        {
            if( p_region->p_cache->fmt.i_width  != i_dst_width ||
840
                p_region->p_cache->fmt.i_height != i_dst_height ||
841
                b_force_palette )
Laurent Aimar's avatar
Laurent Aimar committed
842 843 844 845 846 847 848 849
            {
                p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
                                             p_region->p_cache );
                p_region->p_cache = NULL;
            }
        }

        /* Scale if needed into cache */
Laurent Aimar's avatar
Laurent Aimar committed
850
        if( !p_region->p_cache )
Laurent Aimar's avatar
Laurent Aimar committed
851
        {
Laurent Aimar's avatar
Laurent Aimar committed
852 853
            picture_t *p_pic;

854 855
            p_scale->fmt_in.video = p_region->fmt;
            p_scale->fmt_out.video = p_region->fmt;
Laurent Aimar's avatar
Laurent Aimar committed
856

857 858
            if( p_scale->fmt_out.video.p_palette )
                *p_scale->fmt_out.video.p_palette =
Laurent Aimar's avatar
Laurent Aimar committed
859 860
                    *p_region->fmt.p_palette;

861 862
            p_scale->fmt_out.video.i_width = i_dst_width;
            p_scale->fmt_out.video.i_height = i_dst_height;
Laurent Aimar's avatar
Laurent Aimar committed
863

864
            p_scale->fmt_out.video.i_visible_width =
865
                spu_scale_w( p_region->fmt.i_visible_width, scale_size );
866
            p_scale->fmt_out.video.i_visible_height =
867
                spu_scale_h( p_region->fmt.i_visible_height, scale_size );
Laurent Aimar's avatar
Laurent Aimar committed
868

Laurent Aimar's avatar
Laurent Aimar committed
869 870 871
            p_region->p_cache =
                p_subpic->pf_create_region( VLC_OBJECT(p_spu),
                                            &p_scale->fmt_out.video );
Laurent Aimar's avatar
Laurent Aimar committed
872

873 874
            p_pic = NULL;
            if( p_scale->p_module )
Laurent Aimar's avatar
Laurent Aimar committed
875
            {
876 877
                picture_Yield( &p_region->picture );
                p_pic = p_scale->pf_video_filter( p_scale, &p_region->picture );
Laurent Aimar's avatar
Laurent Aimar committed
878
            }
Laurent Aimar's avatar
Laurent Aimar committed
879 880
            if( p_pic )
            {
Laurent Aimar's avatar
Laurent Aimar committed
881 882 883 884
                picture_Copy( &p_region->p_cache->picture, p_pic );
                picture_Release( p_pic );

                p_region->p_cache->fmt = p_scale->fmt_out.video;
885 886 887 888
                /* i_x/i_y of cached region should NOT be used. I set them to
                 * an invalid value to catch it (assert) */
                p_region->p_cache->i_x = INT_MAX;
                p_region->p_cache->i_y = INT_MAX;
Laurent Aimar's avatar
Laurent Aimar committed
889 890
                p_region->p_cache->i_align = p_region->i_align;
                p_region->p_cache->i_alpha = p_region->i_alpha;
Laurent Aimar's avatar
Laurent Aimar committed
891
            }
892 893
            else
            {
Laurent Aimar's avatar
Laurent Aimar committed
894
                msg_Err( p_spu, "scaling failed (module not loaded)" );
895 896 897 898
                p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
                                             p_region->p_cache );
                p_region->p_cache = NULL;
            }
Laurent Aimar's avatar
Laurent Aimar committed
899 900
        }

901
        /* And use the scaled picture */
Laurent Aimar's avatar
Laurent Aimar committed
902
        if( p_region->p_cache )
903
        {
Laurent Aimar's avatar
Laurent Aimar committed
904
            p_region = p_region->p_cache;
905 906
            fmt_original = p_region->fmt;
        }
Laurent Aimar's avatar
Laurent Aimar committed
907 908
    }

Laurent Aimar's avatar
Laurent Aimar committed
909
    /* Force cropping if requested */
910
    if( b_force_crop )
Laurent Aimar's avatar
Laurent Aimar committed
911
    {
Laurent Aimar's avatar
Laurent Aimar committed
912
        video_format_t *p_fmt = &p_region->fmt;
913 914 915 916
        int i_crop_x = spu_scale_w( p_spu->i_crop_x, scale_size );
        int i_crop_y = spu_scale_h( p_spu->i_crop_y, scale_size );
        int i_crop_width = spu_scale_w( p_spu->i_crop_width, scale_size );
        int i_crop_height= spu_scale_h( p_spu->i_crop_height,scale_size );
Laurent Aimar's avatar
Laurent Aimar committed
917 918 919 920 921 922

        /* Find the intersection */
        if( i_crop_x + i_crop_width <= i_x_offset ||
            i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
            i_crop_y + i_crop_height <= i_y_offset ||
            i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
Laurent Aimar's avatar
Laurent Aimar committed
923
        {
Laurent Aimar's avatar
Laurent Aimar committed
924 925
            /* No intersection */
            p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
Laurent Aimar's avatar
Laurent Aimar committed
926 927 928
        }
        else
        {
Laurent Aimar's avatar
Laurent Aimar committed
929 930 931 932 933 934 935 936 937 938 939 940 941
            int i_x, i_y, i_x_end, i_y_end;
            i_x = __MAX( i_crop_x, i_x_offset );
            i_y = __MAX( i_crop_y, i_y_offset );
            i_x_end = __MIN( i_crop_x + i_crop_width,
                           i_x_offset + (int)p_fmt->i_visible_width );
            i_y_end = __MIN( i_crop_y + i_crop_height,
                           i_y_offset + (int)p_fmt->i_visible_height );

            p_fmt->i_x_offset = i_x - i_x_offset;
            p_fmt->i_y_offset = i_y - i_y_offset;
            p_fmt->i_visible_width = i_x_end - i_x;
            p_fmt->i_visible_height = i_y_end - i_y;

942 943
            i_x_offset = __MAX( i_x, 0 );
            i_y_offset = __MAX( i_y, 0 );
Laurent Aimar's avatar
Laurent Aimar committed
944
        }
945
        b_restore_format = true;
Laurent Aimar's avatar
Laurent Aimar committed
946 947
    }

Laurent Aimar's avatar
Laurent Aimar committed
948 949
    /* Update the blender */
    SpuRenderUpdateBlend( p_spu, p_fmt->i_width, p_fmt->i_height, &p_region->fmt );
Laurent Aimar's avatar
Laurent Aimar committed
950 951 952

    if( p_spu->p_blend->p_module )
    {
953 954
        const int i_alpha = SpuRegionAlpha( p_subpic, p_region );

Laurent Aimar's avatar
Laurent Aimar committed
955
        p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
956
            &p_region->picture, i_x_offset, i_y_offset, i_alpha );
Laurent Aimar's avatar
Laurent Aimar committed
957 958 959 960 961 962 963 964 965
    }
    else
    {
        msg_Err( p_spu, "blending %4.4s to %4.4s failed",
                 (char *)&p_spu->p_blend->fmt_out.video.i_chroma,
                 (char *)&p_spu->p_blend->fmt_out.video.i_chroma );
    }

exit:
Laurent Aimar's avatar
Laurent Aimar committed
966 967 968 969 970 971 972 973 974 975 976
    if( b_rerender_text )
    {
        /* Some forms of subtitles need to be re-rendered more than
         * once, eg. karaoke. We therefore restore the region to its
         * pre-rendered state, so the next time through everything is
         * calculated again.
         */
        p_region->picture.pf_release( &p_region->picture );
        memset( &p_region->picture, 0, sizeof( picture_t ) );
        p_region->i_align &= ~SUBPICTURE_RENDERED;
    }
977
    if( b_restore_format )
978
        p_region->fmt = fmt_original;
Laurent Aimar's avatar
Laurent Aimar committed
979
}
980

Laurent Aimar's avatar
Laurent Aimar committed
981 982 983
/**
 * This function renders all sub picture units in the list.
 */
984
void spu_RenderSubpictures( spu_t *p_spu,
985
                            picture_t *p_pic_dst, const video_format_t *p_fmt_dst,
986
                            subpicture_t *p_subpic_list,
987
                            const video_format_t *p_fmt_src )
Sam Hocevar's avatar
 
Sam Hocevar committed
988
{
989 990
    const int i_source_video_width  = p_fmt_src->i_width;
    const int i_source_video_height = p_fmt_src->i_height;
991
    const mtime_t i_current_date = mdate();
992

993
    subpicture_t *p_subpic;
994

Gildas Bazin's avatar
 
Gildas Bazin committed
995
    /* Get lock */
996
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
997

998 999 1000 1001 1002 1003 1004