vout_subpictures.c 54.2 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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
/* */
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 );
}

106 107 108 109
/* */
static void SpuRenderCreateAndLoadText( spu_t *p_spu );
static void SpuRenderCreateAndLoadScale( spu_t *p_spu );
static void FilterRelease( filter_t *p_filter );
110

111
/**
112
 * Creates the subpicture unit
113
 *
114
 * \param p_this the parent object which creates the subpicture unit
115
 */
116
spu_t *__spu_Create( vlc_object_t *p_this )
117 118
{
    int i_index;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
119 120
    spu_t *p_spu = vlc_custom_create( p_this, sizeof( spu_t ),
                                      VLC_OBJECT_GENERIC, "subpicture" );
121 122
    /* */
    p_spu->i_subpicture_order = 1;
123 124
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
125
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
126 127
    }

128 129 130
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
131
    p_spu->p_scale_yuvp = NULL;
132
    p_spu->pf_control = spu_vaControlDefault;
133 134

    /* Register the default subpicture channel */
135
    p_spu->i_channel = 2;
136

137
    vlc_mutex_init( &p_spu->subpicture_lock );
138

139 140
    vlc_object_attach( p_spu, p_this );

141
    p_spu->p_chain = filter_chain_New( p_spu, "sub filter", false,
142 143
                                       SubFilterAllocationInit,
                                       SubFilterAllocationClean,
144
                                       p_spu );
145 146 147 148 149

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

150 151 152 153 154 155 156 157 158 159 160 161
    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;

162 163 164
    /* 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 );
165 166 167
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
168 169 170 171
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

172
    return VLC_SUCCESS;
173
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
174

175 176
int spu_ParseChain( spu_t *p_spu )
{
177 178
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
    if( filter_chain_AppendFromString( p_spu->p_chain, psz_parser ) < 0 )
179
    {
180 181
        free( psz_parser );
        return VLC_EGENERIC;
182
    }
183

184
    free( psz_parser );
185
    return VLC_SUCCESS;
186 187 188
}

/**
189
 * Destroy the subpicture unit
190
 *
191
 * \param p_this the parent object which destroys the subpicture unit
192
 */
193
void spu_Destroy( spu_t *p_spu )
194 195 196 197 198 199
{
    int i_index;

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

206
    if( p_spu->p_blend )
207
        FilterRelease( p_spu->p_blend );
208

209
    if( p_spu->p_text )
210
        FilterRelease( p_spu->p_text );
211

212 213
    if( p_spu->p_scale_yuvp )
        FilterRelease( p_spu->p_scale_yuvp );
214

215
    if( p_spu->p_scale )
216
        FilterRelease( p_spu->p_scale );
217

218
    filter_chain_Delete( p_spu->p_chain );
219 220

    vlc_mutex_destroy( &p_spu->subpicture_lock );
221
    vlc_object_release( p_spu );
222 223
}

224 225 226
/**
 * Attach/Detach the SPU from any input
 *
227
 * \param p_this the object in which to destroy the subpicture unit
228 229
 * \param b_attach to select attach or detach
 */
230
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
231 232 233
{
    vlc_object_t *p_input;

234
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
235 236 237
    if( !p_input ) return;

    if( b_attach )
238
    {
239 240
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
241 242 243 244 245
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
246
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
247 248 249 250
        vlc_object_release( p_input );
    }
}

251 252 253 254 255 256 257 258 259
/**
 * 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 )
{
260
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
261 262
    if( !p_region )
        return NULL;
263

264 265 266 267 268 269 270 271 272
    /* 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;
273
    p_region->p_private = NULL;
274 275
    p_region->psz_text = NULL;
    p_region->p_style = NULL;
276
    p_region->p_picture = NULL;
277

278 279
    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') )
        return p_region;
280

281 282 283
    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 )
284
    {
285
        free( p_fmt->p_palette );
286
        free( p_region );
287 288 289 290 291 292 293 294 295 296 297 298 299 300
        return NULL;
    }

    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 )
{
301 302 303
    if( !p_region )
        return;

304 305 306 307 308
    if( p_region->p_private )
        SpuRegionPrivateDestroy( p_region->p_private );

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

310
    free( p_region->fmt.p_palette );
311

312 313
    free( p_region->psz_text );
    free( p_region->psz_html );
314
    //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
315 316
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
317

318
/**
319
 * Display a subpicture
320
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
321 322
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
323
 * \param p_spu the subpicture unit object
324 325
 * \param p_subpic the subpicture to display
 */
326
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
327 328 329 330
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
331 332
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
333 334
    }

335
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
336
    {
337 338 339
        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
340
    }
341 342 343

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

346
/**
347
 * Allocate a subpicture in the spu heap.
348
 *
349
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
350 351 352
 * 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.
353
 * \param p_spu the subpicture unit in which to create the subpicture
354 355
 * \return NULL on error, a reserved subpicture otherwise
 */
356
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
357 358
{
    int                 i_subpic;                        /* subpicture index */
359
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
360

361
    /* Get lock */
362
    vlc_mutex_lock( &p_spu->subpicture_lock );
363

Sam Hocevar's avatar
 
Sam Hocevar committed
364 365 366
    /*
     * Look for an empty place
     */
367
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
368 369
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
370
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
371 372
        {
            /* Subpicture is empty and ready for allocation */
373 374
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
375
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
376 377 378
        }
    }

379 380
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
381
    {
382 383
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
384
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
385
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
386

387
    /* Copy subpicture information, set some default values */
388
    memset( p_subpic, 0, sizeof(subpicture_t) );
389
    p_subpic->i_order    = p_spu->i_subpicture_order++;
390
    p_subpic->i_status   = RESERVED_SUBPICTURE;
391 392
    p_subpic->b_absolute = true;
    p_subpic->b_fade     = false;
393
    p_subpic->b_subtitle = false;
394
    p_subpic->i_alpha    = 0xFF;
395 396 397 398
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
399
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
400

401 402
    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
403

404
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
405 406
}

407 408 409
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
410 411 412
 * 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
413
 * by the spu.
414
 */
415
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
416
{
Gildas Bazin's avatar
 
Gildas Bazin committed
417
    /* Get lock */
418
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
419 420 421 422

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

427 428 429 430
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
431
        msg_Err( p_spu, "subpicture %p has invalid status %d",
432 433 434
                         p_subpic, p_subpic->i_status );
    }

435 436 437 438
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
439
        spu_DestroyRegion( p_spu, p_region );
440 441
    }

442 443 444 445 446 447
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

449
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
450 451
}

452 453 454 455 456 457 458 459 460
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 );
}

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
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
488
static void SpuRenderUpdateBlend( spu_t *p_spu, int i_out_width, int i_out_height, const video_format_t *p_in_fmt )
489 490 491 492 493 494
{
    filter_t *p_blend = p_spu->p_blend;

    assert( p_blend );

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
495
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
496 497 498 499 500 501 502 503
    {
        /* 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
504 505 506 507 508 509 510
    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;
511 512 513 514 515

    /* */
    if( !p_blend->p_module )
        p_blend->p_module = module_Need( p_blend, "video blending", 0, 0 );
}
516
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
{
    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 =
532
    p_text->fmt_out.video.i_visible_width = 32;
533
    p_text->fmt_out.video.i_height =
534
    p_text->fmt_out.video.i_visible_height = 32;
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554

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

555
static filter_t *CreateAndLoadScale( vlc_object_t *p_obj, vlc_fourcc_t i_chroma )
556 557 558
{
    filter_t *p_scale;

559 560
    p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
                                 VLC_OBJECT_GENERIC, "scale" );
561
    if( !p_scale )
562
        return NULL;
563 564

    es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
565
    p_scale->fmt_in.video.i_chroma = i_chroma;
566 567 568 569
    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 );
570
    p_scale->fmt_out.video.i_chroma = i_chroma;
571 572 573 574 575 576
    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;

577 578 579 580 581 582 583 584 585 586 587 588 589
    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') );
590 591
}

Laurent Aimar's avatar
Laurent Aimar committed
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 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
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;
}

653 654 655
/**
 * A few scale functions helpers.
 */
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
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;
}
671 672 673 674
static spu_scale_t spu_scale_unit(void )
{
    return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
}
675 676 677 678 679 680 681 682 683 684 685 686 687
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;
}
688 689 690 691
static int spu_invscale_w( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.w;
}
692 693 694 695
static int spu_invscale_h( int v, const spu_scale_t s )
{
    return v * SCALE_UNIT / s.h;
}
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 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
/**
 * 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
818 819 820 821 822
/**
 * Place a region
 */
static void SpuRegionPlace( int *pi_x, int *pi_y,
                            const subpicture_t *p_subpic,
823 824
                            const subpicture_region_t *p_region,
                            int i_margin_y )
Laurent Aimar's avatar
Laurent Aimar committed
825
{
826 827
    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
828 829
    int i_x, i_y;

830
    assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
Laurent Aimar's avatar
Laurent Aimar committed
831 832 833 834 835 836
    if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
    {
        i_y = i_delta_y;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
    {
837
        i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
838 839 840
    }
    else
    {
841
        i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
Laurent Aimar's avatar
Laurent Aimar committed
842 843 844 845 846 847 848 849
    }

    if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
    {
        i_x = i_delta_x;
    }
    else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
    {
850
        i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
Laurent Aimar's avatar
Laurent Aimar committed
851 852 853
    }
    else
    {
854
        i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
Laurent Aimar's avatar
Laurent Aimar committed
855 856 857 858
    }

    if( p_subpic->b_absolute )
    {
859 860
        i_x = i_delta_x;
        i_y = i_delta_y;
Laurent Aimar's avatar
Laurent Aimar committed
861
    }
862

863
    /* Margin shifts all subpictures */
864
    if( i_margin_y != 0 )
865
        i_y -= i_margin_y;
866

867 868 869 870
    /* 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;
871 872
    if( i_x < 0 )
        i_x = 0;
873 874 875 876

    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;
877 878
    if( i_y < 0 )
        i_y = 0;
Laurent Aimar's avatar
Laurent Aimar committed
879

880 881
    *pi_x = i_x;
    *pi_y = i_y;
Laurent Aimar's avatar
Laurent Aimar committed
882 883
}

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
/**
 * 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;
}

906 907 908 909
/**
 * It will render the provided region onto p_pic_dst.
 */

Laurent Aimar's avatar
Laurent Aimar committed
910
static void SpuRenderRegion( spu_t *p_spu,
911
                             picture_t *p_pic_dst, spu_area_t *p_area,
Laurent Aimar's avatar
Laurent Aimar committed
912
                             subpicture_t *p_subpic, subpicture_region_t *p_region,
913
                             const spu_scale_t scale_size,
914 915
                             const video_format_t *p_fmt,
                             const spu_area_t *p_subtitle_area, int i_subtitle_area )
Laurent Aimar's avatar
Laurent Aimar committed
916
{
917 918
    video_format_t fmt_original = p_region->fmt;
    bool b_rerender_text = false;
919
    bool b_restore_format = false;
Laurent Aimar's avatar
Laurent Aimar committed
920 921
    int i_x_offset;
    int i_y_offset;
922
    filter_t *p_scale;
Laurent Aimar's avatar
Laurent Aimar committed
923

924
    video_format_t region_fmt;
925 926
    picture_t *p_region_picture;

927 928
    vlc_assert_locked( &p_spu->subpicture_lock );

929 930 931 932
    /* 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
933
    if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
Laurent Aimar's avatar
Laurent Aimar committed
934
    {
935
        const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
936
        SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region, i_min_scale_ratio );
937
        b_restore_format = b_rerender_text;
Laurent Aimar's avatar
Laurent Aimar committed
938

Laurent Aimar's avatar
Laurent Aimar committed
939 940 941 942
        /* 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
943

944 945 946 947 948 949 950 951
    /* 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;

952

953 954 955 956 957 958 959
    /* 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 );

960 961 962
    /* Place the picture
     * We compute the position in the rendered size */
    SpuRegionPlace( &i_x_offset, &i_y_offset,
963 964
                    p_subpic, p_region, i_margin_y );

965 966 967 968 969 970 971 972 973 974 975 976 977
    /* 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 );
    }
978 979

    /* Fix the position for the current scale_size */
980 981
    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 );
982

983
    /* */
984
    if( b_force_palette )
Laurent Aimar's avatar
Laurent Aimar committed
985
    {
Laurent Aimar's avatar
Laurent Aimar committed
986
        /* It looks so wrong I won't comment
Laurent Aimar's avatar
Laurent Aimar committed
987 988 989
         * p_palette->palette is [256][4] with a int i_entries
         * p_spu->palette is [4][4]
         * */
990 991
        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
992 993
    }

994
    /* */
995
    region_fmt = p_region->fmt;
996 997
    p_region_picture = p_region->p_picture;

998

999
    /* Scale from rendered size to destination size */
1000 1001
    p_scale = b_using_palette ? p_spu->p_scale_yuvp : p_spu->p_scale;

1002
    if( p_scale &&
Laurent Aimar's avatar
Laurent Aimar committed
1003
        ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_force_palette ) )
Laurent Aimar's avatar
Laurent Aimar committed
1004
    {
1005 1006
        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
1007

1008 1009 1010
        /* TODO when b_using_palette is true, we should first convert it to YUVA to allow
         * a proper rescaling */

1011 1012 1013
        /* Destroy the cache if unusable
         * FIXME we should not use b_force_palette but check that the palettes
         * are not the identical */
1014
        if( p_region->p_private )
Laurent Aimar's avatar
Laurent Aimar committed
1015
        {
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
            subpicture_region_private_t *p_private = p_region->p_private;
            bool b_changed = false;

            /* Check resize changes */
            if( i_dst_width  != p_private->fmt.i_width ||
                i_dst_height != p_private->fmt.i_height )
                b_changed = true;

            /* Check palette changes */
            if( b_using_palette )
            {
                const video_palette_t *p_palette0 = p_region->fmt.p_palette;
                const video_palette_t *p_palette1 = p_private->fmt.p_palette;

                if( p_palette0->i_entries == p_palette1->i_entries )
                {
                    for( int i = 0; i < p_palette0->i_entries; i++ )
                        for( int j = 0; j < 4; j++ )
                            b_changed |= p_palette0->palette[i][j] != p_palette1->palette[i][j];
                }
                else
                {
                    b_changed = true;
                }
            }

            if( b_changed )
            {
                SpuRegionPrivateDestroy( p_private );
                p_region->p_private = NULL;
            }
Laurent Aimar's avatar
Laurent Aimar committed
1047 1048 1049
        }

        /* Scale if needed into cache */
1050
        if( !p_region->p_private )
Laurent Aimar's avatar
Laurent Aimar committed
1051
        {
Laurent Aimar's avatar
Laurent Aimar committed
1052 1053
            picture_t *p_pic;

1054 1055
            p_scale->fmt_in.video = p_region->fmt;
            p_scale->fmt_out.video = p_region->fmt;
Laurent Aimar's avatar
Laurent Aimar committed
1056

1057 1058
            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
1059

1060
            p_scale->fmt_out.video.i_visible_width =
1061
                spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1062
            p_scale->fmt_out.video.i_visible_height =
1063
                spu_scale_h( p_region->fmt.i_visible_height, scale_size );
Laurent Aimar's avatar
Laurent Aimar committed
1064

1065
            p_region->p_private = SpuRegionPrivateCreate( &p_scale->fmt_out.video );
Laurent Aimar's avatar
Laurent Aimar committed
1066

1067
            if( p_scale->p_module )
Laurent Aimar's avatar
Laurent Aimar committed
1068
            {
1069 1070
                picture_Yield( p_region->p_picture );
                p_region->p_private->p_picture = p_scale->pf_video_filter( p_scale, p_region->p_picture );
Laurent Aimar's avatar
Laurent Aimar committed
1071
            }
1072
            if( !p_region->p_private->p_picture )
1073
            {
Laurent Aimar's avatar
Laurent Aimar committed
1074
                msg_Err( p_spu, "scaling failed (module not loaded)" );
1075 1076
                SpuRegionPrivateDestroy( p_region->p_private );
                p_region->p_private = NULL;
1077
            }
Laurent Aimar's avatar
Laurent Aimar committed
1078 1079
        }

1080
        /* And use the scaled picture */
1081
        if( p_region->p_private )
1082
        {
1083
            region_fmt = p_region->p_private->fmt;
1084
            p_region_picture = p_region->p_private->p_picture;
1085
        }
Laurent Aimar's avatar
Laurent Aimar committed
1086 1087
    }

Laurent Aimar's avatar
Laurent Aimar committed
1088
    /* Force cropping if requested */