vout_subpictures.c 56.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
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
struct spu_private_t
{
    vlc_mutex_t  subpicture_lock;                  /**< subpicture heap lock */
    subpicture_t p_subpicture[VOUT_MAX_SUBPICTURES];        /**< subpictures */
    int i_channel;             /**< number of subpicture channels registered */
    int64_t i_subpicture_order; /**< number of created subpicture since spu creation */

    filter_t *p_blend;                            /**< alpha blending module */
    filter_t *p_text;                              /**< text renderer module */
    filter_t *p_scale_yuvp;                     /**< scaling module for YUVP */
    filter_t *p_scale;                    /**< scaling module (all but YUVP) */
    bool b_force_crop;                     /**< force cropping of subpicture */
    int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */

    int i_margin;                        /**< force position of a subpicture */
    bool b_force_palette;             /**< force palette of subpicture */
    uint8_t palette[4][4];                               /**< forced palette */

    /* Supciture filters */
    filter_chain_t *p_chain;
};

68 69 70
static void UpdateSPU   ( spu_t *, vlc_object_t * );
static int  CropCallback( vlc_object_t *, char const *,
                          vlc_value_t, vlc_value_t, void * );
71

72
static int SpuControl( spu_t *, int, va_list );
73

74 75
static subpicture_t *sub_new_buffer( filter_t * );
static void sub_del_buffer( filter_t *, subpicture_t * );
76 77
static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
78 79
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
80

81 82 83 84
static int spu_ParseChain( spu_t * );
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

85 86
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
87 88 89 90 91 92
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

Laurent Aimar's avatar
Laurent Aimar committed
93 94
#define SCALE_UNIT (1000)

95 96 97 98 99
#define VLC_FOURCC_YUVP VLC_FOURCC('Y','U','V','P')
#define VLC_FOURCC_YUVA VLC_FOURCC('Y','U','V','A')
#define VLC_FOURCC_RGBA VLC_FOURCC('R','G','B','A')
#define VLC_FOURCC_TEXT VLC_FOURCC('T','E','X','T')

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
/* */
struct subpicture_region_private_t
{
    video_format_t fmt;
    picture_t      *p_picture;
};

static subpicture_region_private_t *SpuRegionPrivateCreate( video_format_t *p_fmt )
{
    subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );

    if( !p_private )
        return NULL;

    p_private->fmt = *p_fmt;
    if( p_fmt->p_palette )
    {
        p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
        if( p_private->fmt.p_palette )
            *p_private->fmt.p_palette = *p_fmt->p_palette;
    }
    p_private->p_picture = NULL;

    return p_private;
}
static void SpuRegionPrivateDestroy( subpicture_region_private_t *p_private )
{
    if( p_private->p_picture )
        picture_Release( p_private->p_picture );
    free( p_private->fmt.p_palette );
    free( p_private );
}

133 134 135 136
/* */
static void SpuRenderCreateAndLoadText( spu_t *p_spu );
static void SpuRenderCreateAndLoadScale( spu_t *p_spu );
static void FilterRelease( filter_t *p_filter );
137

138
/**
139
 * Creates the subpicture unit
140
 *
141
 * \param p_this the parent object which creates the subpicture unit
142
 */
143
spu_t *__spu_Create( vlc_object_t *p_this )
144 145
{
    int i_index;
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

    spu_t *p_spu;
    spu_private_t *p_sys;
    
    p_spu = vlc_custom_create( p_this, sizeof(spu_t) + sizeof(spu_private_t),
                               VLC_OBJECT_GENERIC, "subpicture" );

    if( !p_spu )
        return NULL;

    /* Initialize spu fields */
    p_spu->pf_control = SpuControl;
    p_spu->p = p_sys = (spu_private_t*)&p_spu[1];

    /* Initialize private fields */
    p_sys->i_subpicture_order = 1;
162 163
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
164
        p_sys->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
165 166
    }

167 168 169 170
    p_sys->p_blend = NULL;
    p_sys->p_text = NULL;
    p_sys->p_scale = NULL;
    p_sys->p_scale_yuvp = NULL;
171 172

    /* Register the default subpicture channel */
173
    p_sys->i_channel = 2;
174

175
    vlc_mutex_init( &p_sys->subpicture_lock );
176

177 178
    vlc_object_attach( p_spu, p_this );

179
    p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
180 181
                                       SubFilterAllocationInit,
                                       SubFilterAllocationClean,
182
                                       p_spu );
183 184 185 186 187

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

188 189 190 191 192 193 194 195 196 197
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
198
    spu_private_t *p_sys = p_spu->p;
199

200
    /* If the user requested a sub margin, we force the position. */
201
    p_sys->i_margin = var_CreateGetInteger( p_spu, "sub-margin" );
202 203

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
204 205 206 207
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

208
    return VLC_SUCCESS;
209
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
210

211 212
int spu_ParseChain( spu_t *p_spu )
{
213
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
214 215 216
    int i_ret;

    if( !psz_parser )
217
        return VLC_EGENERIC;
218 219

    i_ret = filter_chain_AppendFromString( p_spu->p->p_chain, psz_parser );
220

221
    free( psz_parser );
222 223

    return i_ret;
224 225 226
}

/**
227
 * Destroy the subpicture unit
228
 *
229
 * \param p_this the parent object which destroys the subpicture unit
230
 */
231
void spu_Destroy( spu_t *p_spu )
232
{
233
    spu_private_t *p_sys = p_spu->p;
234 235 236 237 238
    int i_index;

    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
239
        if( p_sys->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
240
        {
241
            spu_DestroySubpicture( p_spu, &p_sys->p_subpicture[i_index] );
242 243 244
        }
    }

245 246 247 248 249
    if( p_sys->p_blend )
        FilterRelease( p_sys->p_blend );

    if( p_sys->p_text )
        FilterRelease( p_sys->p_text );
250

251 252
    if( p_sys->p_scale_yuvp )
        FilterRelease( p_sys->p_scale_yuvp );
253

254 255
    if( p_sys->p_scale )
        FilterRelease( p_sys->p_scale );
256

257
    filter_chain_Delete( p_sys->p_chain );
258

259
    vlc_mutex_destroy( &p_sys->subpicture_lock );
260

261
    vlc_object_release( p_spu );
262 263
}

264 265 266
/**
 * Attach/Detach the SPU from any input
 *
267
 * \param p_this the object in which to destroy the subpicture unit
268 269
 * \param b_attach to select attach or detach
 */
270
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
271 272 273
{
    vlc_object_t *p_input;

274
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
275 276 277
    if( !p_input ) return;

    if( b_attach )
278
    {
279 280
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
281 282 283 284 285
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
286
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
287 288 289 290
        vlc_object_release( p_input );
    }
}

291 292
/* */
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
293
{
294
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
295 296
    if( !p_region )
        return NULL;
297

298
    p_region->fmt = *p_fmt;
299 300 301 302 303 304 305
    p_region->fmt.p_palette = NULL;
    if( p_fmt->i_chroma == VLC_FOURCC_YUVP )
    {
        p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
        if( p_fmt->p_palette )
            *p_region->fmt.p_palette = *p_fmt->p_palette;
    }
306 307
    p_region->i_alpha = 0xff;
    p_region->p_next = NULL;
308
    p_region->p_private = NULL;
309 310
    p_region->psz_text = NULL;
    p_region->p_style = NULL;
311
    p_region->p_picture = NULL;
312

313
    if( p_fmt->i_chroma == VLC_FOURCC_TEXT )
314
        return p_region;
315

316 317 318
    p_region->p_picture = picture_New( p_fmt->i_chroma, p_fmt->i_width, p_fmt->i_height,
                                       p_fmt->i_aspect );
    if( !p_region->p_picture )
319
    {
320
        free( p_fmt->p_palette );
321
        free( p_region );
322 323 324 325 326 327
        return NULL;
    }

    return p_region;
}

328 329
/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
330
{
331 332 333
    if( !p_region )
        return;

334 335 336 337 338
    if( p_region->p_private )
        SpuRegionPrivateDestroy( p_region->p_private );

    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
339

340
    free( p_region->fmt.p_palette );
341

342 343
    free( p_region->psz_text );
    free( p_region->psz_html );
344
    //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
345 346
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
347

348 349 350 351 352 353 354 355 356 357 358 359 360
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;

        subpicture_region_Delete( p_head );

        p_head = p_next;
    }
}

361
/**
362
 * Display a subpicture
363
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
364 365
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
366
 * \param p_spu the subpicture unit object
367 368
 * \param p_subpic the subpicture to display
 */
369
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
370 371 372 373
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
374 375
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
376 377
    }

378
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
379
    {
380 381 382
        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
383
    }
384 385 386

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

389
/**
390
 * Allocate a subpicture in the spu heap.
391
 *
392
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
393 394 395
 * 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.
396
 * \param p_spu the subpicture unit in which to create the subpicture
397 398
 * \return NULL on error, a reserved subpicture otherwise
 */
399
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
400
{
401
    spu_private_t *p_sys = p_spu->p;
Sam Hocevar's avatar
 
Sam Hocevar committed
402
    int                 i_subpic;                        /* subpicture index */
403
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
404

405
    /* Get lock */
406
    vlc_mutex_lock( &p_sys->subpicture_lock );
407

Sam Hocevar's avatar
 
Sam Hocevar committed
408 409 410
    /*
     * Look for an empty place
     */
411
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
412 413
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
414
        if( p_sys->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
415 416
        {
            /* Subpicture is empty and ready for allocation */
417 418
            p_subpic = &p_sys->p_subpicture[i_subpic];
            p_sys->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
419
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
420 421 422
        }
    }

423 424
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
425
    {
426
        msg_Err( p_spu, "subpicture heap is full" );
427
        vlc_mutex_unlock( &p_sys->subpicture_lock );
428
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
429
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
430

431
    /* Copy subpicture information, set some default values */
432
    memset( p_subpic, 0, sizeof(subpicture_t) );
433
    p_subpic->i_order    = p_sys->i_subpicture_order++;
434
    p_subpic->i_status   = RESERVED_SUBPICTURE;
435 436
    p_subpic->b_absolute = true;
    p_subpic->b_fade     = false;
437
    p_subpic->b_subtitle = false;
438
    p_subpic->i_alpha    = 0xFF;
439 440 441 442
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
443
    vlc_mutex_unlock( &p_sys->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
444

445
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
446 447
}

448 449 450
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
451 452 453
 * 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
454
 * by the spu.
455
 */
456
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
457
{
458 459
    spu_private_t *p_sys = p_spu->p;

Gildas Bazin's avatar
 
Gildas Bazin committed
460
    /* Get lock */
461
    vlc_mutex_lock( &p_sys->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
462 463 464 465

    /* There can be race conditions so we need to check the status */
    if( p_subpic->i_status == FREE_SUBPICTURE )
    {
466
        vlc_mutex_unlock( &p_sys->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
467 468 469
        return;
    }

470 471 472 473
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
474
        msg_Err( p_spu, "subpicture %p has invalid status %d",
475 476 477
                         p_subpic, p_subpic->i_status );
    }

478 479
    subpicture_region_ChainDelete( p_subpic->p_region );
    p_subpic->p_region = NULL;
480

481 482 483 484 485 486
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

488
    vlc_mutex_unlock( &p_sys->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
489 490
}

491 492 493
static void FilterRelease( filter_t *p_filter )
{
    if( p_filter->p_module )
494
        module_unneed( p_filter, p_filter->p_module );
495 496 497 498 499

    vlc_object_detach( p_filter );
    vlc_object_release( p_filter );
}

500 501 502 503
static void SpuRenderCreateBlend( spu_t *p_spu, vlc_fourcc_t i_chroma, int i_aspect )
{
    filter_t *p_blend;

504
    assert( !p_spu->p->p_blend );
505

506
    p_spu->p->p_blend =
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
    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 );
}
527 528
static void SpuRenderUpdateBlend( spu_t *p_spu, int i_out_width, int i_out_height,
                                  const video_format_t *p_in_fmt )
529
{
530
    filter_t *p_blend = p_spu->p->p_blend;
531 532 533 534

    assert( p_blend );

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
535
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
536 537 538
    {
        /* 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 */
539
        module_unneed( p_blend, p_blend->p_module );
540 541 542 543
        p_blend->p_module = NULL;
    }

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
544 545 546 547 548 549 550
    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;
551 552 553

    /* */
    if( !p_blend->p_module )
554
        p_blend->p_module = module_need( p_blend, "video blending", 0, 0 );
555
}
556
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
557 558 559
{
    filter_t *p_text;

560
    assert( !p_spu->p->p_text );
561

562
    p_spu->p->p_text =
563 564 565 566 567 568 569 570 571
    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 =
572
    p_text->fmt_out.video.i_visible_width = 32;
573
    p_text->fmt_out.video.i_height =
574
    p_text->fmt_out.video.i_visible_height = 32;
575 576 577 578 579 580

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

581
    /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
582 583 584 585
     * same than these 2 calls ? */
    char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
    if( psz_modulename && *psz_modulename )
    {
586
        p_text->p_module = module_need( p_text, "text renderer",
587 588 589 590 591
                                        psz_modulename, true );
    }
    free( psz_modulename );

    if( !p_text->p_module )
592
        p_text->p_module = module_need( p_text, "text renderer", NULL, false );
593 594
}

595 596 597
static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
                                     vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
                                     bool b_resize )
598 599 600
{
    filter_t *p_scale;

601 602
    p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
                                 VLC_OBJECT_GENERIC, "scale" );
603
    if( !p_scale )
604
        return NULL;
605 606

    es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
607
    p_scale->fmt_in.video.i_chroma = i_src_chroma;
608 609 610 611
    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 );
612
    p_scale->fmt_out.video.i_chroma = i_dst_chroma;
613
    p_scale->fmt_out.video.i_width =
614
    p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
615 616 617 618

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

619
    vlc_object_attach( p_scale, p_obj );
620
    p_scale->p_module = module_need( p_scale, "video filter2", 0, 0 );
621 622 623 624 625

    return p_scale;
}
static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
{
626 627
    assert( !p_spu->p->p_scale );
    assert( !p_spu->p->p_scale_yuvp );
628 629
    /* XXX p_spu->p_scale is used for all conversion/scaling except yuvp to
     * yuva/rgba */
630 631
    p_spu->p->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu),
                                            VLC_FOURCC_YUVA, VLC_FOURCC_YUVA, true );
632 633
    /* This one is used for YUVP to YUVA/RGBA without scaling
     * FIXME rename it */
634 635
    p_spu->p->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu),
                                                 VLC_FOURCC_YUVP, VLC_FOURCC_YUVA, false );
636 637
}

Laurent Aimar's avatar
Laurent Aimar committed
638
static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
639 640
                           subpicture_t *p_subpic, subpicture_region_t *p_region,
                           int i_min_scale_ratio )
Laurent Aimar's avatar
Laurent Aimar committed
641
{
642 643
    filter_t *p_text = p_spu->p->p_text;

644
    assert( p_region->fmt.i_chroma == VLC_FOURCC_TEXT );
Laurent Aimar's avatar
Laurent Aimar committed
645

646
    if( !p_text || !p_text->p_module )
Laurent Aimar's avatar
Laurent Aimar committed
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
        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 ? */
671 672 673 674
    var_Create( p_text, "spu-duration", VLC_VAR_TIME );
    var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
    var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
    var_Create( p_text, "scale", VLC_VAR_INTEGER );
Laurent Aimar's avatar
Laurent Aimar committed
675

676 677 678 679
    var_SetTime( p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
    var_SetTime( p_text, "spu-elapsed", mdate() - p_subpic->i_start );
    var_SetBool( p_text, "text-rerender", false );
    var_SetInteger( p_text, "scale", i_min_scale_ratio );
Laurent Aimar's avatar
Laurent Aimar committed
680

681
    if( p_text->pf_render_html && p_region->psz_html )
Laurent Aimar's avatar
Laurent Aimar committed
682
    {
683
        p_text->pf_render_html( p_text, p_region, p_region );
Laurent Aimar's avatar
Laurent Aimar committed
684
    }
685
    else if( p_text->pf_render_text )
Laurent Aimar's avatar
Laurent Aimar committed
686
    {
687
        p_text->pf_render_text( p_text, p_region, p_region );
Laurent Aimar's avatar
Laurent Aimar committed
688
    }
689
    *pb_rerender_text = var_GetBool( p_text, "text-rerender" );
Laurent Aimar's avatar
Laurent Aimar committed
690

691 692 693 694
    var_Destroy( p_text, "spu-duration" );
    var_Destroy( p_text, "spu-elapsed" );
    var_Destroy( p_text, "text-rerender" );
    var_Destroy( p_text, "scale" );
Laurent Aimar's avatar
Laurent Aimar committed
695 696 697 698 699

exit:
    p_region->i_align |= SUBPICTURE_RENDERED;
}

700 701 702
/**
 * A few scale functions helpers.
 */
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
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;
}
718 719 720 721
static spu_scale_t spu_scale_unit(void )
{
    return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
}
722 723 724 725 726 727 728 729 730 731 732 733 734
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;
}
735 736 737 738
static int spu_invscale_w( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.w;
}
739 740 741 742
static int spu_invscale_h( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.h;
}
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 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
/**
 * 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
865 866 867 868 869
/**
 * Place a region
 */
static void SpuRegionPlace( int *pi_x, int *pi_y,
                            const subpicture_t *p_subpic,
870 871
                            const subpicture_region_t *p_region,
                            int i_margin_y )
Laurent Aimar's avatar
Laurent Aimar committed
872
{
873 874
    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
875 876
    int i_x, i_y;

877
    assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
Laurent Aimar's avatar
Laurent Aimar committed
878 879 880 881 882 883
    if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
    {
        i_y = i_delta_y;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
    {
884
        i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
885 886 887
    }
    else
    {
888
        i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
Laurent Aimar's avatar
Laurent Aimar committed
889 890 891 892 893 894 895 896
    }

    if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
    {
        i_x = i_delta_x;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
    {
897
        i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
Laurent Aimar's avatar
Laurent Aimar committed
898 899 900
    }
    else
    {
901
        i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
Laurent Aimar's avatar
Laurent Aimar committed
902 903 904 905
    }

    if( p_subpic->b_absolute )
    {
906 907
        i_x = i_delta_x;
        i_y = i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
908
    }
909

910
    /* Margin shifts all subpictures */
911
    if( i_margin_y != 0 )
912
        i_y -= i_margin_y;
913

914 915 916 917
    /* 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;
918 919
    if( i_x < 0 )
        i_x = 0;
920 921 922 923

    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;
924 925
    if( i_y < 0 )
        i_y = 0;
Laurent Aimar's avatar
Laurent Aimar committed
926

927 928
    *pi_x = i_x;
    *pi_y = i_y;
Laurent Aimar's avatar
Laurent Aimar committed
929 930
}

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
/**
 * 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;
}

953 954 955 956
/**
 * It will render the provided region onto p_pic_dst.
 */

Laurent Aimar's avatar
Laurent Aimar committed
957
static void SpuRenderRegion( spu_t *p_spu,
958
                             picture_t *p_pic_dst, spu_area_t *p_area,
Laurent Aimar's avatar
Laurent Aimar committed
959
                             subpicture_t *p_subpic, subpicture_region_t *p_region,
960
                             const spu_scale_t scale_size,
961 962
                             const video_format_t *p_fmt,
                             const spu_area_t *p_subtitle_area, int i_subtitle_area )
Laurent Aimar's avatar
Laurent Aimar committed
963
{
964 965
    spu_private_t *p_sys = p_spu->p;

966 967
    video_format_t fmt_original = p_region->fmt;
    bool b_rerender_text = false;
968
    bool b_restore_format = false;
Laurent Aimar's avatar
Laurent Aimar committed
969 970 971
    int i_x_offset;
    int i_y_offset;

972
    video_format_t region_fmt;
973 974
    picture_t *p_region_picture;

975
    vlc_assert_locked( &p_sys->subpicture_lock );
976

977 978 979 980
    /* Invalidate area by default */
    *p_area = spu_area_create( 0,0, 0,0, scale_size );

    /* Render text region */
981
    if( p_region->fmt.i_chroma == VLC_FOURCC_TEXT )
Laurent Aimar's avatar
Laurent Aimar committed
982
    {
983
        const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
984
        SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region, i_min_scale_ratio );
985
        b_restore_format = b_rerender_text;
Laurent Aimar's avatar
Laurent Aimar committed
986

Laurent Aimar's avatar
Laurent Aimar committed
987
        /* Check if the rendering has failed ... */
988
        if( p_region->fmt.i_chroma == VLC_FOURCC_TEXT )
Laurent Aimar's avatar
Laurent Aimar committed
989 990
            goto exit;
    }
Laurent Aimar's avatar
Laurent Aimar committed
991

992 993 994 995
    /* 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).
     */
996
    const bool b_using_palette = p_region->fmt.i_chroma == VLC_FOURCC_YUVP;
997 998
    const bool b_force_palette = b_using_palette && p_sys->b_force_palette;
    const bool b_force_crop    = b_force_palette && p_sys->b_force_crop;
999
    bool b_changed_palette     = false;
1000

1001

1002 1003 1004 1005 1006
    /* 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 )
1007
        i_margin_y = spu_invscale_h( p_sys->i_margin, scale_size );
1008

1009 1010 1011
    /* Place the picture
     * We compute the position in the rendered size */
    SpuRegionPlace( &i_x_offset, &i_y_offset,
1012 1013
                    p_subpic, p_region, i_margin_y );

1014 1015 1016 1017 1018 1019 1020 1021 1022
    /* 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 )
    {
1023 1024
        spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
                                              spu_scale_unit() );
1025

1026 1027
        SpuAreaFixOverlap( p_area, &display, p_subtitle_area, i_subtitle_area,
                           p_region->i_align );
1028
    }
1029 1030

    /* Fix the position for the current scale_size */
1031