vout_subpictures.c 53.4 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2007 the VideoLAN team
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6 7 8
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
9
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
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
    /* */
    p_spu->i_subpicture_order = 1;
90 91
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
92
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
93 94
    }

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

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

104
    vlc_mutex_init( &p_spu->subpicture_lock );
105

106 107
    vlc_object_attach( p_spu, p_this );

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

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

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

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

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

    spu_ParseChain( p_spu );

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

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

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

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

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

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

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

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

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

185
    filter_chain_Delete( p_spu->p_chain );
186 187

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

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

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

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

218 219

/* */
220
static void RegionPictureRelease( picture_t *p_picture )
221
{
222 223 224 225 226 227 228
    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 );
229
}
230

231 232 233 234 235 236 237 238 239
/**
 * 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 )
{
240
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
241 242
    if( !p_region )
        return NULL;
243

244 245 246 247 248 249 250 251 252 253 254 255 256
    /* 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;

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

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

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

273 274 275 276 277 278 279 280 281 282 283
    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 )
{
284 285 286 287 288
    if( !p_region )
        return;

    picture_Release( &p_region->picture );

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

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

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

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

    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
325 326
}

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

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

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

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

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

382 383
    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
384

385
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
386 387
}

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

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

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

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

423 424 425 426 427 428
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

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

433 434 435 436 437 438 439 440 441
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 );
}

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 467 468
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
469
static void SpuRenderUpdateBlend( spu_t *p_spu, int i_out_width, int i_out_height, const video_format_t *p_in_fmt )
470 471 472 473 474 475
{
    filter_t *p_blend = p_spu->p_blend;

    assert( p_blend );

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
476
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
477 478 479 480 481 482 483 484
    {
        /* 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
485 486 487 488 489 490 491
    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;
492 493 494 495 496

    /* */
    if( !p_blend->p_module )
        p_blend->p_module = module_Need( p_blend, "video blending", 0, 0 );
}
497
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
{
    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 =
513
    p_text->fmt_out.video.i_visible_width = 32;
514
    p_text->fmt_out.video.i_height =
515
    p_text->fmt_out.video.i_visible_height = 32;
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535

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

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

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

    es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
546
    p_scale->fmt_in.video.i_chroma = i_chroma;
547 548 549 550
    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 );
551
    p_scale->fmt_out.video.i_chroma = i_chroma;
552 553 554 555 556 557
    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;

558 559 560 561 562 563 564 565 566 567 568 569 570
    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') );
571 572
}

Laurent Aimar's avatar
Laurent Aimar committed
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 632 633
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;
}

634 635 636
/**
 * A few scale functions helpers.
 */
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
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;
}
652 653 654 655
static spu_scale_t spu_scale_unit(void )
{
    return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
}
656 657 658 659 660 661 662 663 664 665 666 667 668
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;
}
669 670 671 672
static int spu_invscale_w( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.w;
}
673 674 675 676
static int spu_invscale_h( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.h;
}
677

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
/**
 * A few area functions helpers
 */

typedef struct
{
    int i_x;
    int i_y;
    int i_width;
    int i_height;

    spu_scale_t scale;
} spu_area_t;

static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t s )
{
    spu_area_t a = { .i_x = x, .i_y = y, .i_width = w, .i_height = h, .scale = s };
    return a;
}
static spu_area_t spu_area_scaled( spu_area_t a )
{
    if( a.scale.w == SCALE_UNIT && a.scale.h == SCALE_UNIT )
        return a;

    a.i_x = spu_scale_w( a.i_x, a.scale );
    a.i_y = spu_scale_h( a.i_y, a.scale );

    a.i_width  = spu_scale_w( a.i_width,  a.scale );
    a.i_height = spu_scale_h( a.i_height, a.scale );

    a.scale = spu_scale_unit();
    return a;
}
static spu_area_t spu_area_unscaled( spu_area_t a, spu_scale_t s )
{
    if( a.scale.w == s.w && a.scale.h == s.h )
        return a;

    a = spu_area_scaled( a );

    a.i_x = spu_invscale_w( a.i_x, s );
    a.i_y = spu_invscale_h( a.i_y, s );

    a.i_width  = spu_invscale_w( a.i_width, s );
    a.i_height = spu_invscale_h( a.i_height, s );

    a.scale = s;
    return a;
}
static bool spu_area_overlap( spu_area_t a, spu_area_t b )
{
    const int i_dx = 0;
    const int i_dy = 0;

    a = spu_area_scaled( a );
    b = spu_area_scaled( b );

    return  __MAX( a.i_x-i_dx, b.i_x ) < __MIN( a.i_x+a.i_width +i_dx, b.i_x+b.i_width  ) &&
            __MAX( a.i_y-i_dy, b.i_y ) < __MIN( a.i_y+a.i_height+i_dy, b.i_y+b.i_height );
}

/**
 * Avoid area overlapping
 */
static void SpuAreaFixOverlap( spu_area_t *p_dst,
                               const spu_area_t *p_master,
                               const spu_area_t *p_sub, int i_sub, int i_align )
{
    spu_area_t a = spu_area_scaled( *p_dst );
    bool b_moved = false;
    bool b_ok;

    assert( p_master->i_x == 0 && p_master->i_y == 0 );

    /* Check for overlap
     * XXX It is not fast O(n^2) but we should not have a lot of region */
    do
    {
        b_ok = true;
        for( int i = 0; i < i_sub; i++ )
        {
            spu_area_t sub = spu_area_scaled( p_sub[i] );

            if( !spu_area_overlap( a, sub ) )
                continue;

            if( i_align & SUBPICTURE_ALIGN_TOP )
            {
                /* We go down */
                int i_y = sub.i_y + sub.i_height;
                if( i_y + a.i_height > p_master->i_height )
                    break;
                a.i_y = i_y;
                b_moved = true;
            }
            else if( i_align & SUBPICTURE_ALIGN_BOTTOM )
            {
                /* We go up */
                int i_y = sub.i_y - a.i_height;
                if( i_y < 0 )
                    break;
                a.i_y = i_y;
                b_moved = true;
            }
            else
            {
                /* TODO what to do in this case? */
                //fprintf( stderr, "Overlap with unsupported alignment\n" );
                break;
            }

            b_ok = false;
            break;
        }
    } while( !b_ok );

    if( b_moved )
        *p_dst = spu_area_unscaled( a, p_dst->scale );
}


Laurent Aimar's avatar
Laurent Aimar committed
799 800 801 802 803
/**
 * Place a region
 */
static void SpuRegionPlace( int *pi_x, int *pi_y,
                            const subpicture_t *p_subpic,
804 805
                            const subpicture_region_t *p_region,
                            int i_margin_y )
Laurent Aimar's avatar
Laurent Aimar committed
806
{
807 808
    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
809 810
    int i_x, i_y;

811
    assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
Laurent Aimar's avatar
Laurent Aimar committed
812 813 814 815 816 817
    if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
    {
        i_y = i_delta_y;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
    {
818
        i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
819 820 821
    }
    else
    {
822
        i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
Laurent Aimar's avatar
Laurent Aimar committed
823 824 825 826 827 828 829 830
    }

    if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
    {
        i_x = i_delta_x;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
    {
831
        i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
Laurent Aimar's avatar
Laurent Aimar committed
832 833 834
    }
    else
    {
835
        i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
Laurent Aimar's avatar
Laurent Aimar committed
836 837 838 839
    }

    if( p_subpic->b_absolute )
    {
840 841
        i_x = i_delta_x;
        i_y = i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
842
    }
843

844
    /* Margin shifts all subpictures */
845
    if( i_margin_y != 0 )
846
        i_y -= i_margin_y;
847

848 849 850 851
    /* 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;
852 853
    if( i_x < 0 )
        i_x = 0;
854 855 856 857

    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;
858 859
    if( i_y < 0 )
        i_y = 0;
Laurent Aimar's avatar
Laurent Aimar committed
860

861 862
    *pi_x = i_x;
    *pi_y = i_y;
Laurent Aimar's avatar
Laurent Aimar committed
863 864
}

865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
/**
 * 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;
}

887 888 889 890
/**
 * It will render the provided region onto p_pic_dst.
 */

Laurent Aimar's avatar
Laurent Aimar committed
891
static void SpuRenderRegion( spu_t *p_spu,
892
                             picture_t *p_pic_dst, spu_area_t *p_area,
Laurent Aimar's avatar
Laurent Aimar committed
893
                             subpicture_t *p_subpic, subpicture_region_t *p_region,
894
                             const spu_scale_t scale_size,
895 896
                             const video_format_t *p_fmt,
                             const spu_area_t *p_subtitle_area, int i_subtitle_area )
Laurent Aimar's avatar
Laurent Aimar committed
897
{
898 899
    video_format_t fmt_original = p_region->fmt;
    bool b_rerender_text = false;
900
    bool b_restore_format = false;
Laurent Aimar's avatar
Laurent Aimar committed
901 902
    int i_x_offset;
    int i_y_offset;
903
    filter_t *p_scale;
Laurent Aimar's avatar
Laurent Aimar committed
904

905 906
    vlc_assert_locked( &p_spu->subpicture_lock );

907 908 909 910
    /* Invalidate area by default */
    *p_area = spu_area_create( 0,0, 0,0, scale_size );

    /* Render text region */
Laurent Aimar's avatar
Laurent Aimar committed
911
    if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
Laurent Aimar's avatar
Laurent Aimar committed
912
    {
913
        const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
914
        SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region, i_min_scale_ratio );
915
        b_restore_format = b_rerender_text;
Laurent Aimar's avatar
Laurent Aimar committed
916

Laurent Aimar's avatar
Laurent Aimar committed
917 918 919 920
        /* 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
921

922 923 924 925 926 927 928 929
    /* 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;

930

931 932 933 934 935 936 937
    /* 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 );

938 939 940
    /* Place the picture
     * We compute the position in the rendered size */
    SpuRegionPlace( &i_x_offset, &i_y_offset,
941 942
                    p_subpic, p_region, i_margin_y );

943 944 945 946 947 948 949 950 951 952 953 954 955
    /* Save this position for subtitle overlap support
     * it is really important that there are given without scale_size applied */
    *p_area = spu_area_create( i_x_offset, i_y_offset,
                               p_region->fmt.i_width, p_region->fmt.i_height,
                               scale_size );

    /* Handle overlapping subtitles when possible */
    if( p_subpic->b_subtitle && !p_subpic->b_absolute )
    {
        spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height, spu_scale_unit() );

        SpuAreaFixOverlap( p_area, &display, p_subtitle_area, i_subtitle_area, p_region->i_align );
    }
956 957

    /* Fix the position for the current scale_size */
958 959
    i_x_offset = spu_scale_w( p_area->i_x, p_area->scale );
    i_y_offset = spu_scale_h( p_area->i_y, p_area->scale );
960

961
    if( b_force_palette )
Laurent Aimar's avatar
Laurent Aimar committed
962
    {
Laurent Aimar's avatar
Laurent Aimar committed
963
        /* It looks so wrong I won't comment
Laurent Aimar's avatar
Laurent Aimar committed
964 965 966
         * p_palette->palette is [256][4] with a int i_entries
         * p_spu->palette is [4][4]
         * */
967 968
        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
969 970
    }

971 972 973 974 975
    if( b_using_palette )
        p_scale = p_spu->p_scale_yuvp;
    else
        p_scale = p_spu->p_scale;

976
    /* Scale from rendered size to destination size */
977
    if( p_scale &&
Laurent Aimar's avatar
Laurent Aimar committed
978
        ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_force_palette ) )
Laurent Aimar's avatar
Laurent Aimar committed
979
    {
980 981
        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
982

983 984 985
        /* 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
986 987 988 989
        /* Destroy if cache is unusable */
        if( p_region->p_cache )
        {
            if( p_region->p_cache->fmt.i_width  != i_dst_width ||
990
                p_region->p_cache->fmt.i_height != i_dst_height ||
991
                b_force_palette )
Laurent Aimar's avatar
Laurent Aimar committed
992 993 994 995 996 997 998 999
            {
                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
1000
        if( !p_region->p_cache )
Laurent Aimar's avatar
Laurent Aimar committed
1001
        {
Laurent Aimar's avatar
Laurent Aimar committed
1002 1003
            picture_t *p_pic;

1004 1005
            p_scale->fmt_in.video = p_region->fmt;
            p_scale->fmt_out.video = p_region->fmt;
Laurent Aimar's avatar
Laurent Aimar committed
1006

1007 1008
            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
1009

1010
            p_scale->fmt_out.video.i_visible_width =
1011
                spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1012
            p_scale->fmt_out.video.i_visible_height =
1013
                spu_scale_h( p_region->fmt.i_visible_height, scale_size );
Laurent Aimar's avatar
Laurent Aimar committed
1014

Laurent Aimar's avatar
Laurent Aimar committed
1015 1016 1017
            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
1018

1019 1020
            p_pic = NULL;
            if( p_scale->p_module )
Laurent Aimar's avatar
Laurent Aimar committed
1021
            {
1022 1023
                picture_Yield( &p_region->picture );
                p_pic = p_scale->pf_video_filter( p_scale, &p_region->picture );
Laurent Aimar's avatar
Laurent Aimar committed
1024
            }
Laurent Aimar's avatar
Laurent Aimar committed
1025 1026
            if( p_pic )
            {
1027
                picture_CopyPixels( &p_region->p_cache->picture, p_pic );
Laurent Aimar's avatar
Laurent Aimar committed
1028 1029
                picture_Release( p_pic );

1030 1031 1032
                if( p_region->p_cache->fmt.p_palette )
                    *p_region->p_cache->fmt.p_palette = *p_region->fmt.p_palette;

1033 1034 1035 1036
                /* 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
1037 1038
                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
1039
            }
1040 1041
            else
            {
Laurent Aimar's avatar
Laurent Aimar committed
1042
                msg_Err( p_spu, "scaling failed (module not loaded)" );
1043 1044 1045 1046
                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
1047 1048
        }

1049
        /* And use the scaled picture */
Laurent Aimar's avatar
Laurent Aimar committed
1050
        if( p_region->p_cache )
1051
        {
Laurent Aimar's avatar
Laurent Aimar committed
1052
            p_region = p_region->p_cache;
1053 1054
            fmt_original = p_region->fmt;
        }
Laurent Aimar's avatar
Laurent Aimar committed
1055 1056
    }

Laurent Aimar's avatar
Laurent Aimar committed
1057
    /* Force cropping if requested */
1058
    if( b_force_crop )
Laurent Aimar's avatar
Laurent Aimar committed
1059
    {
Laurent Aimar's avatar
Laurent Aimar committed
1060
        video_format_t *p_fmt = &p_region->fmt;
1061 1062 1063 1064
        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
1065 1066 1067 1068 1069 1070

        /* 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
1071
        {
Laurent Aimar's avatar
Laurent Aimar committed
1072 1073