vout_subpictures.c 51.8 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
dionoea's avatar
dionoea committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
24 25 26 27 28
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
29 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33
#include <vlc/vlc.h>
zorglub's avatar
zorglub 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 41 42 43 44 45
/*****************************************************************************
 * 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 * );
46

gbazin's avatar
gbazin committed
47 48
static int spu_vaControlDefault( spu_t *, int, va_list );

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

56 57 58 59 60
static int spu_ParseChain( spu_t * );
static void spu_DeleteChain( spu_t * );
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

gbazin's avatar
gbazin committed
61 62 63 64 65 66
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

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

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

88 89 90
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
91
    p_spu->i_filter = 0;
gbazin's avatar
gbazin committed
92
    p_spu->pf_control = spu_vaControlDefault;
93 94

    /* Register the default subpicture channel */
gbazin's avatar
gbazin committed
95
    p_spu->i_channel = 2;
96

97
    vlc_mutex_init( &p_spu->subpicture_lock );
98

99 100
    vlc_object_attach( p_spu, p_this );

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

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

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

    spu_ParseChain( p_spu );

123
    return VLC_SUCCESS;
124
}
dionoea's avatar
 
dionoea committed
125

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

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

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

dionoea's avatar
 
dionoea committed
140
        msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
141

142 143 144 145 146
        p_spu->pp_filter[p_spu->i_filter] =
            vlc_object_create( p_spu, VLC_OBJECT_FILTER );
        vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
        p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
        p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
dionoea's avatar
dionoea committed
147
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
148 149
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
150
                         "sub filter", psz_name, true );
gbazin's avatar
gbazin committed
151 152 153
        if( p_spu->pp_filter[p_spu->i_filter]->p_module )
        {
            filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
154 155 156 157 158 159 160
            if( p_sys )
            {
                p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
                spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
                p_sys->p_spu = p_spu;
                p_spu->i_filter++;
            }
gbazin's avatar
gbazin committed
161
        }
162 163
        else
        {
164
            msg_Dbg( p_spu, "no sub filter found" );
165
            config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
166
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
167
            vlc_object_release( p_spu->pp_filter[p_spu->i_filter] );
168
        }
169 170 171 172 173 174

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

dionoea's avatar
 
dionoea committed
175
        free( psz_name );
176
    }
177
    free( val.psz_string );
178

179
    return VLC_SUCCESS;
180 181 182
}

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

191 192
    vlc_object_detach( p_spu );

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

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

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

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

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

220 221 222 223 224 225
    if( p_spu->p_scale )
    {
        if( p_spu->p_scale->p_module )
            module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );

        vlc_object_detach( p_spu->p_scale );
226
        vlc_object_release( p_spu->p_scale );
227 228
    }

229 230 231
    spu_DeleteChain( p_spu );

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

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

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

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

    if( b_attach )
264
    {
265 266
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
267 268 269 270 271
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
272
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
273 274 275 276 277 278 279 280 281 282
        vlc_object_release( p_input );
    }
}

/**
 * Create a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 */
283 284
static void RegionPictureRelease( picture_t *p_pic )
{
285
    free( p_pic->p_data_orig );
286
}
287 288 289 290
subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
                                         video_format_t *p_fmt )
{
    subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
291 292
    if( !p_region ) return NULL;

293
    memset( p_region, 0, sizeof(subpicture_region_t) );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
294
    p_region->i_alpha = 0xff;
295 296
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
297
    p_region->fmt = *p_fmt;
298
    p_region->psz_text = NULL;
hartman's avatar
hartman committed
299
    p_region->p_style = NULL;
300 301 302 303 304 305

    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = p_region->fmt.p_palette =
            malloc( sizeof(video_palette_t) );
    else p_fmt->p_palette = p_region->fmt.p_palette = NULL;

306
    p_region->picture.p_data_orig = NULL;
307 308

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

    vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
                          p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );

    if( !p_region->picture.i_planes )
    {
        free( p_region );
316
        free( p_fmt->p_palette );
317 318 319
        return NULL;
    }

320 321
    p_region->picture.pf_release = RegionPictureRelease;

322 323 324
    return p_region;
}

325 326 327 328 329 330 331 332 333 334 335 336
/**
 * Make a subpicture region from an existing picture_t
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 * \param p_pic a pointer to the picture creating the region (not freed)
 */
subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
                                       video_format_t *p_fmt,
                                       picture_t *p_pic )
{
    subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
337
    (void)p_this;
338
    if( !p_region ) return NULL;
339
    memset( p_region, 0, sizeof(subpicture_region_t) );
340
    p_region->i_alpha = 0xff;
341 342 343 344
    p_region->p_next = 0;
    p_region->p_cache = 0;
    p_region->fmt = *p_fmt;
    p_region->psz_text = 0;
hartman's avatar
hartman committed
345
    p_region->p_style = NULL;
346 347 348 349 350 351 352 353 354 355 356 357

    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = p_region->fmt.p_palette =
            malloc( sizeof(video_palette_t) );
    else p_fmt->p_palette = p_region->fmt.p_palette = NULL;

    memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
    p_region->picture.pf_release = RegionPictureRelease;

    return p_region;
}

358 359 360 361 362 363 364 365 366
/**
 * Destroy a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_region the subpicture region to destroy
 */
void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
{
    if( !p_region ) return;
367 368
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
369
    free( p_region->fmt.p_palette );
370
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
371

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

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

395 396
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
397

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

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

421
    /* Get lock */
422
    vlc_mutex_lock( &p_spu->subpicture_lock );
423

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

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

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

460
    p_subpic->pf_create_region = __spu_CreateRegion;
461
    p_subpic->pf_make_region = __spu_MakeRegion;
462
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
463

464
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
465 466
}

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

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

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

495 496 497 498
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
499
        spu_DestroyRegion( p_spu, p_region );
500 501
    }

502 503 504 505 506 507
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

    p_subpic->i_status = FREE_SUBPICTURE;
gbazin's avatar
 
gbazin committed
508

509
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
510 511 512
}

/*****************************************************************************
513
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
514
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
515
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
516
 *****************************************************************************/
517 518 519
void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                            picture_t *p_pic_dst, picture_t *p_pic_src,
                            subpicture_t *p_subpic,
520
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
521
{
522 523
    int i_source_video_width;
    int i_source_video_height;
524
    subpicture_t *p_subpic_v = p_subpic;
525

gbazin's avatar
 
gbazin committed
526
    /* Get lock */
527
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
528

529 530 531 532 533 534 535 536 537 538
    for( p_subpic_v = p_subpic;
            p_subpic_v != NULL && p_subpic_v->i_status != FREE_SUBPICTURE;
            p_subpic_v = p_subpic_v->p_next )
    {
        if( p_subpic_v->pf_pre_render )
        {
            p_subpic_v->pf_pre_render( p_fmt, p_spu, p_subpic_v, mdate() );
        }
    }

539 540 541 542 543 544 545 546
    if( i_scale_width_orig <= 0 )
        i_scale_width_orig = 1;
    if( i_scale_height_orig <= 0 )
        i_scale_height_orig = 1;

    i_source_video_width  = p_fmt->i_width  * 1000 / i_scale_width_orig;
    i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;

gbazin's avatar
 
gbazin committed
547
    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
548
    while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
549
    {
550
        subpicture_region_t *p_region;
551 552 553 554 555
        int pi_scale_width[ SCALE_SIZE ];
        int pi_scale_height[ SCALE_SIZE ];
        int pi_subpic_x[ SCALE_SIZE ];
        int k;

556 557 558 559 560 561 562 563 564 565 566
        /* If the source video and subtitles stream agree on the size of
         * the video then disregard all further references to the subtitle
         * stream.
         */
        if( ( i_source_video_height == p_subpic->i_original_picture_height ) &&
            ( i_source_video_width  == p_subpic->i_original_picture_width ) )
        {
            p_subpic->i_original_picture_height = 0;
            p_subpic->i_original_picture_width = 0;
        }

567
        for( k = 0; k < SCALE_SIZE ; k++ )
568
            pi_subpic_x[ k ] = p_subpic->i_x;
569

570 571 572 573 574 575 576 577 578 579 580 581
        if( p_subpic->pf_update_regions )
        {
            if ( p_subpic->p_region ) {
                spu_DestroyRegion( p_spu, p_subpic->p_region );
            }
            p_subpic->p_region = p_region = p_subpic->pf_update_regions( p_fmt, p_spu, p_subpic, mdate() );
        }
        else
        {
            p_region = p_subpic->p_region;
        }

582
        /* Load the blending module */
583
        if( !p_spu->p_blend && p_region )
584
        {
585
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
586 587 588 589 590 591
            vlc_object_attach( p_spu->p_blend, p_spu );
            p_spu->p_blend->fmt_out.video.i_x_offset =
                p_spu->p_blend->fmt_out.video.i_y_offset = 0;
            p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
            p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;

dionoea's avatar
dionoea committed
592 593
            /* The blend module will be loaded when needed with the real
            * input format */
594 595
            memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
            p_spu->p_blend->p_module = NULL;
596
        }
597

598 599 600 601 602
        /* Load the text rendering module; it is possible there is a
         * text region somewhere in the subpicture other than the first
         * element in the region list, so just load it anyway as we'll
         * probably want it sooner or later. */
        if( !p_spu->p_text && p_region )
603
        {
604 605
            char *psz_modulename = NULL;

606
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
607 608 609 610
            vlc_object_attach( p_spu->p_text, p_spu );

            p_spu->p_text->fmt_out.video.i_width =
                p_spu->p_text->fmt_out.video.i_visible_width =
611
                p_fmt->i_width;
612 613
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
614
                p_fmt->i_height;
615

616 617
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
618 619 620 621 622

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

634
        if( p_spu->p_text )
635
        {
636 637
            subpicture_region_t *p_text_region = p_subpic->p_region;

dionoea's avatar
dionoea committed
638 639 640 641 642 643 644
            /* Only overwrite the size fields if the region is still in
             * pre-rendered TEXT format. We have to traverse the subregion
             * list because if more than one subregion is present, the text
             * region isn't guarentteed to be the first in the list, and
             * only text regions use this flag. All of this effort assists
             * with the rescaling of text that has been rendered at native
             * resolution, rather than video resolution.
645 646
             */
            while( p_text_region &&
647
                   ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
648
            {
649
                p_text_region = p_text_region->p_next;
650
            }
651

dionoea's avatar
dionoea committed
652
            if( p_text_region &&
653
                ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
654
            {
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
                if( (p_subpic->i_original_picture_height > 0) &&
                    (p_subpic->i_original_picture_width  > 0) )
                {
                    p_spu->p_text->fmt_out.video.i_width =
                        p_spu->p_text->fmt_out.video.i_visible_width =
                        p_subpic->i_original_picture_width;
                    p_spu->p_text->fmt_out.video.i_height =
                        p_spu->p_text->fmt_out.video.i_visible_height =
                        p_subpic->i_original_picture_height;
                }
                else
                {
                    p_spu->p_text->fmt_out.video.i_width =
                        p_spu->p_text->fmt_out.video.i_visible_width =
                        p_fmt->i_width;
                    p_spu->p_text->fmt_out.video.i_height =
                        p_spu->p_text->fmt_out.video.i_visible_height =
                        p_fmt->i_height;
                }
674
            }
675
        }
676

677 678
        pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
        pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
679

680 681 682 683 684 685 686
        if( p_spu->p_text )
        {
            pi_scale_width[ SCALE_TEXT ]     = ( p_fmt->i_width * 1000 ) /
                                          p_spu->p_text->fmt_out.video.i_width;
            pi_scale_height[ SCALE_TEXT ]    = ( p_fmt->i_height * 1000 ) /
                                          p_spu->p_text->fmt_out.video.i_height;
        }
687 688 689 690 691 692 693 694 695
        /* If we have an explicit size plane to render to, then turn off
         * the fontsize rescaling.
         */
        if( (p_subpic->i_original_picture_height > 0) &&
            (p_subpic->i_original_picture_width  > 0) )
        {
            i_scale_width_orig  = 1000;
            i_scale_height_orig = 1000;
        }
696 697

        for( k = 0; k < SCALE_SIZE ; k++ )
698
        {
dionoea's avatar
dionoea committed
699 700 701
            /* Case of both width and height being specified has been dealt
             * with above by instead rendering to an output pane of the
             * explicit dimensions specified - we don't need to scale it.
702
             */
703
            if( (p_subpic->i_original_picture_height > 0) &&
Jean-Paul Saman's avatar
Jean-Paul Saman committed
704
                (p_subpic->i_original_picture_width <= 0) )
705 706 707 708 709 710
            {
                pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
                                 p_subpic->i_original_picture_height;
                pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_height /
                                 p_subpic->i_original_picture_height;
            }
hartman's avatar
hartman committed
711
        }
712

713 714
        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
715
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
zorglub's avatar
zorglub committed
716
        {
717 718 719 720
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
721
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
722 723 724 725
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }
726

727
        /* Take care of the aspect ratio */
dionoea's avatar
dionoea committed
728
        if( p_region &&
729 730
            ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
              ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
731
        {
732
            for( k = 0; k < SCALE_SIZE ; k++ )
733 734 735 736 737 738
            {
                pi_scale_width[ k ] = pi_scale_width[ k ] *
                    (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
                    p_region->fmt.i_sar_den / p_fmt->i_sar_num;
                pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
            }
739 740
        }

741
        /* Load the scaling module */
742
        if( !p_spu->p_scale &&
743 744 745 746
           ((((pi_scale_width[ SCALE_TEXT ]    > 0)     || (pi_scale_height[ SCALE_TEXT ]    > 0)) &&
             ((pi_scale_width[ SCALE_TEXT ]    != 1000) || (pi_scale_height[ SCALE_TEXT ]    != 1000))) ||
            (((pi_scale_width[ SCALE_DEFAULT ] > 0)     || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
             ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
747 748 749 750 751 752
        {
            p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
            vlc_object_attach( p_spu->p_scale, p_spu );
            p_spu->p_scale->fmt_out.video.i_chroma =
                p_spu->p_scale->fmt_in.video.i_chroma =
                    VLC_FOURCC('Y','U','V','P');
753 754
            /* FIXME: We'll also be using it for YUVA and RGBA blending ... */

755 756 757 758 759 760 761 762 763
            p_spu->p_scale->fmt_in.video.i_width =
                p_spu->p_scale->fmt_in.video.i_height = 32;
            p_spu->p_scale->fmt_out.video.i_width =
                p_spu->p_scale->fmt_out.video.i_height = 16;

            p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
            p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
            p_spu->p_scale->p_module =
                module_Need( p_spu->p_scale, "video filter2", 0, 0 );
764 765
        }

766
        while( p_region )
767
        {
768
            video_format_t orig_fmt = p_region->fmt;
769
            bool b_rerender_text = false;
770
            int i_fade_alpha = 255;
771 772 773 774 775
            int i_x_offset;
            int i_y_offset;
            int i_scale_idx   = SCALE_DEFAULT;
            int i_inv_scale_x = 1000;
            int i_inv_scale_y = 1000;
776

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

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

                    var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
                    val.i_time = p_subpic->i_stop - p_subpic->i_start;
                    var_Set( p_spu->p_text, "spu-duration", val );

                    var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
                    val.i_time = mdate() - p_subpic->i_start;
                    var_Set( p_spu->p_text, "spu-elapsed", val );

                    var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
812
                    var_SetBool( p_spu->p_text, "text-rerender", false );
813

814 815 816 817
                    var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
                    var_SetInteger( p_spu->p_text, "scale",
                              __MIN(i_scale_width_orig, i_scale_height_orig) );

818 819 820 821 822 823 824 825
                    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,
dionoea's avatar
dionoea committed
826
                                                       p_region, p_region );
827
                    }
828 829 830 831 832
                    b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );

                    var_Destroy( p_spu->p_text, "spu-duration" );
                    var_Destroy( p_spu->p_text, "spu-elapsed" );
                    var_Destroy( p_spu->p_text, "text-rerender" );
833
                    var_Destroy( p_spu->p_text, "scale" );
834
                }
835
                p_region->i_align |= SUBPICTURE_RENDERED;
836
            }
837

838 839 840 841 842 843 844 845 846
            if( p_region->i_align & SUBPICTURE_RENDERED )
            {
                i_scale_idx   = SCALE_TEXT;
                i_inv_scale_x = i_scale_width_orig;
                i_inv_scale_y = i_scale_height_orig;
            }

            i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
            i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;
847

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

            /* Scale SPU if necessary */
dionoea's avatar
dionoea committed
857
            if( p_region->p_cache &&
858
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
859
            {
860
                if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
gbazin's avatar