vout_subpictures.c 44.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
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 29 30 31 32
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>                                                /* free() */
#include <stdio.h>                                              /* sprintf() */
#include <string.h>                                            /* strerror() */

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>
38

39 40 41 42 43 44
/*****************************************************************************
 * 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 * );
45

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

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

55 56 57 58 59
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
60 61 62 63 64 65
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

66
/**
67
 * Creates the subpicture unit
68
 *
69
 * \param p_this the parent object which creates the subpicture unit
70
 */
71
spu_t *__spu_Create( vlc_object_t *p_this )
72 73
{
    int i_index;
74
    spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
75 76 77

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
78
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
79 80
    }

81 82 83
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
84
    p_spu->i_filter = 0;
gbazin's avatar
gbazin committed
85
    p_spu->pf_control = spu_vaControlDefault;
86 87

    /* Register the default subpicture channel */
gbazin's avatar
gbazin committed
88
    p_spu->i_channel = 2;
89 90

    vlc_mutex_init( p_this, &p_spu->subpicture_lock );
91

92 93
    vlc_object_attach( p_spu, p_this );

94 95 96 97 98 99 100 101 102 103 104 105
    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;

106 107 108
    /* 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 );
109 110 111
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
112 113 114 115 116 117
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

    return VLC_EGENERIC;
}
dionoea's avatar
 
dionoea committed
118

119 120 121 122 123
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
124
    psz_parser = val.psz_string;
dionoea's avatar
 
dionoea committed
125 126

    while( psz_parser && *psz_parser )
127
    {
128
        config_chain_t *p_cfg;
dionoea's avatar
 
dionoea committed
129 130 131
        char *psz_name;

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

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

135 136 137 138 139
        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
140
        p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
141 142
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
143
                         "sub filter", psz_name, VLC_TRUE );
gbazin's avatar
gbazin committed
144 145 146 147 148 149 150 151
        if( p_spu->pp_filter[p_spu->i_filter]->p_module )
        {
            filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
            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++;
        }
152 153
        else
        {
154
            msg_Dbg( p_spu, "no sub filter found" );
155
            config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
156 157 158
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
            vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
        }
159 160 161 162 163 164

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

dionoea's avatar
 
dionoea committed
165
        free( psz_name );
166
    }
gbazin's avatar
gbazin committed
167
    if( val.psz_string ) free( val.psz_string );
168

169
    return VLC_EGENERIC;
170 171 172
}

/**
173
 * Destroy the subpicture unit
174
 *
175
 * \param p_this the parent object which destroys the subpicture unit
176
 */
177
void spu_Destroy( spu_t *p_spu )
178 179 180
{
    int i_index;

181 182
    vlc_object_detach( p_spu );

183 184 185
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
186
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
187
        {
188
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
189 190 191
        }
    }

192
    if( p_spu->p_blend )
193
    {
194 195
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
196

197 198
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
199 200
    }

201
    if( p_spu->p_text )
202
    {
203 204
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
205

206 207
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
208 209
    }

210 211 212 213 214 215 216 217 218
    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 );
        vlc_object_destroy( p_spu->p_scale );
    }

219 220 221 222 223 224 225 226 227
    spu_DeleteChain( p_spu );

    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
}

static void spu_DeleteChain( spu_t *p_spu )
{
    if( p_spu->i_filter )
228 229 230 231
    while( p_spu->i_filter-- )
    {
        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
232
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
233
        config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
234 235 236
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }
237 238 239 240 241
}

/**
 * Attach/Detach the SPU from any input
 *
242
 * \param p_this the object in which to destroy the subpicture unit
243 244
 * \param b_attach to select attach or detach
 */
245
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
246 247 248
{
    vlc_object_t *p_input;

249
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
250 251 252
    if( !p_input ) return;

    if( b_attach )
253
    {
254 255
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
256 257 258 259 260
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
261
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
262 263 264 265 266 267 268 269 270 271
        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
 */
272 273 274 275
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
276 277 278 279
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
280 281
    if( !p_region ) return NULL;

282 283
    memset( p_region, 0, sizeof(subpicture_region_t) );
    p_region->p_next = 0;
284
    p_region->p_cache = 0;
285
    p_region->fmt = *p_fmt;
286
    p_region->psz_text = 0;
hartman's avatar
hartman committed
287
    p_region->p_style = NULL;
288 289 290 291 292 293

    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;

294
    p_region->picture.p_data_orig = NULL;
295 296

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
297 298 299 300 301 302 303

    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 );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
304
        if( p_fmt->p_palette ) free( p_fmt->p_palette );
305 306 307
        return NULL;
    }

308 309
    p_region->picture.pf_release = RegionPictureRelease;

310 311 312
    return p_region;
}

313 314 315 316 317 318 319 320 321 322 323 324
/**
 * 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) );
325
    (void)p_this;
326 327 328 329 330
    memset( p_region, 0, sizeof(subpicture_region_t) );
    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
331
    p_region->p_style = NULL;
332 333 334 335 336 337 338 339 340 341 342 343

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

344 345 346 347 348 349 350 351 352
/**
 * 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;
353 354
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
355
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
356
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
357 358 359

    if( p_region->psz_text )
        free( p_region->psz_text );
360 361
    if( p_region->psz_html )
        free( p_region->psz_html );
362
    //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
363 364
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
365

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

383 384
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
385

386
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
387
    {
388 389 390
        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
391
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
392 393
}

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

409
    /* Get lock */
410
    vlc_mutex_lock( &p_spu->subpicture_lock );
411

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

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

435
    /* Copy subpicture information, set some default values */
436 437 438
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
439
    p_subpic->b_pausable = VLC_FALSE;
440
    p_subpic->b_fade     = VLC_FALSE;
441 442
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = 0;
443 444 445 446
    p_subpic->pf_render  = 0;
    p_subpic->pf_destroy = 0;
    p_subpic->p_sys      = 0;
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
447

448
    p_subpic->pf_create_region = __spu_CreateRegion;
449
    p_subpic->pf_make_region = __spu_MakeRegion;
450
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
451

452
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
453 454
}

455 456 457
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
458 459 460
 * 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
461
 * by the spu.
462
 */
463
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
464
{
gbazin's avatar
 
gbazin committed
465
    /* Get lock */
466
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
467 468 469 470

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

475 476 477 478
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
479
        msg_Err( p_spu, "subpicture %p has invalid status %d",
480 481 482
                         p_subpic, p_subpic->i_status );
    }

483 484 485 486
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
487
        spu_DestroyRegion( p_spu, p_region );
488 489
    }

490 491 492 493 494 495
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

497
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
498 499 500
}

/*****************************************************************************
501
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
502
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
503
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
504
 *****************************************************************************/
505 506 507
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,
508
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
509
{
gbazin's avatar
 
gbazin committed
510
    /* Get lock */
511
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
512 513 514

    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
    while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
515
    {
516
        subpicture_region_t *p_region = p_subpic->p_region;
517
        int i_scale_width, i_scale_height;
518
        int i_subpic_x = p_subpic->i_x;
519

520
        /* Load the blending module */
521
        if( !p_spu->p_blend && p_region )
522
        {
523
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
524 525 526 527 528 529
            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;
            p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
530
            /* XXX: We'll also be using it for YUVA and RGBA blending ... */
531 532 533

            p_spu->p_blend->p_module =
                module_Need( p_spu->p_blend, "video blending", 0, 0 );
534
        }
535

536
        /* Load the text rendering module */
537
        if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
538
        {
539 540
            char *psz_modulename = NULL;

541
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
542 543 544 545
            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 =
546
                p_fmt->i_width;
547 548
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
549
                p_fmt->i_height;
550

551 552
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
553 554 555 556 557

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
558 559
                    module_Need( p_spu->p_text, "text renderer",
                                 psz_modulename, VLC_TRUE );
560 561 562 563 564 565 566
            }
            if( !p_spu->p_text->p_module )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
            }
            if( psz_modulename ) free( psz_modulename );
567
        }
568
        if( p_spu->p_text )
569
        {
570 571 572 573 574 575 576 577 578 579 580 581 582 583
            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 =
584
                    p_fmt->i_width;
585 586
                p_spu->p_text->fmt_out.video.i_height =
                    p_spu->p_text->fmt_out.video.i_visible_height =
587
                    p_fmt->i_height;
588
            }
589
        }
590

591 592 593
        i_scale_width = i_scale_width_orig;
        i_scale_height = i_scale_height_orig;

hartman's avatar
hartman committed
594 595
        if( p_subpic->i_original_picture_height > 0 &&
            p_subpic->i_original_picture_width  > 0 )
596 597
        {
            i_scale_width = i_scale_width * p_fmt->i_width /
zorglub's avatar
zorglub committed
598
                             p_subpic->i_original_picture_width;
599
            i_scale_height = i_scale_height * p_fmt->i_height /
zorglub's avatar
zorglub committed
600
                             p_subpic->i_original_picture_height;
601
        }
hartman's avatar
hartman committed
602 603 604 605
        else if( p_subpic->i_original_picture_height > 0 )
        {
            i_scale_height = i_scale_height * p_fmt->i_height /
                             p_subpic->i_original_picture_height;
dionoea's avatar
dionoea committed
606
            i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height;
hartman's avatar
hartman committed
607
        }
608

609 610 611
        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
            (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
zorglub's avatar
zorglub committed
612
        {
613 614 615 616 617 618 619 620 621
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
            (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }
622

623
        /* Take care of the aspect ratio */
624
        if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
625 626 627 628 629
            p_region->fmt.i_sar_den * p_fmt->i_sar_num )
        {
            i_scale_width = i_scale_width *
                (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
                p_region->fmt.i_sar_den / p_fmt->i_sar_num;
630
            i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
631 632
        }

633
        /* Load the scaling module */
634 635 636 637 638 639 640 641
        if( !p_spu->p_scale && (i_scale_width != 1000 ||
            i_scale_height != 1000) )
        {
            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');
642
            /* XXX: We'll also be using it for YUVA and RGBA blending ... */
643 644 645 646 647 648 649 650 651
            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 );
652 653
        }

654
        while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
655
        {
656 657
            video_format_t orig_fmt = p_region->fmt;
            vlc_bool_t b_rerender_text = VLC_FALSE;
658
            int i_fade_alpha = 255;
659 660
            int i_x_offset = p_region->i_x + i_subpic_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;
661

662 663
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
664
                if( p_spu->p_text && p_spu->p_text->p_module )
665
                {
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
                    vlc_value_t  val;

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

                    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 );
                    var_SetBool( p_spu->p_text, "text-rerender", VLC_FALSE );

696 697 698 699 700 701 702 703
                    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
704
                                                       p_region, p_region );
705
                    }
706 707 708 709 710 711
                    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" );

712 713 714
                }
            }

715
            /* Force palette if requested */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
716 717
            if( p_spu->b_force_palette &&
                (VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma) )
718
            {
719 720
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
721 722 723 724
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache )
725
            {
726 727 728 729 730 731 732 733 734
                if( i_scale_width * p_region->fmt.i_width / 1000 !=
                    p_region->p_cache->fmt.i_width ||
                    i_scale_height * p_region->fmt.i_height / 1000 !=
                    p_region->p_cache->fmt.i_height )
                {
                    p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
                                                 p_region->p_cache );
                    p_region->p_cache = 0;
                }
735
            }
736

737
            if( (i_scale_width != 1000 || i_scale_height != 1000) &&
dionoea's avatar
dionoea committed
738
                p_spu->p_scale && !p_region->p_cache )
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
            {
                picture_t *p_pic;

                p_spu->p_scale->fmt_in.video = p_region->fmt;
                p_spu->p_scale->fmt_out.video = p_region->fmt;

                p_region->p_cache =
                    p_subpic->pf_create_region( VLC_OBJECT(p_spu),
                        &p_spu->p_scale->fmt_out.video );
                if( p_spu->p_scale->fmt_out.video.p_palette )
                    *p_spu->p_scale->fmt_out.video.p_palette =
                        *p_region->fmt.p_palette;
                p_region->p_cache->p_next = p_region->p_next;

                vout_CopyPicture( p_spu, &p_region->p_cache->picture,
                                  &p_region->picture );

                p_spu->p_scale->fmt_out.video.i_width =
                    p_region->fmt.i_width * i_scale_width / 1000;
                p_spu->p_scale->fmt_out.video.i_visible_width =
                    p_region->fmt.i_visible_width * i_scale_width / 1000;
                p_spu->p_scale->fmt_out.video.i_height =
                    p_region->fmt.i_height * i_scale_height / 1000;
                p_spu->p_scale->fmt_out.video.i_visible_height =
                    p_region->fmt.i_visible_height * i_scale_height / 1000;
                p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
765 766
                p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
                p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
Laurent Aimar's avatar
Laurent Aimar committed
767
                p_region->p_cache->i_align = p_region->i_align;
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784

                p_pic = p_spu->p_scale->pf_video_filter(
                                 p_spu->p_scale, &p_region->p_cache->picture );
                if( p_pic )
                {
                    picture_t p_pic_tmp = p_region->p_cache->picture;
                    p_region->p_cache->picture = *p_pic;
                    *p_pic = p_pic_tmp;
                    free( p_pic );
                }
            }
            if( (i_scale_width != 1000 || i_scale_height != 1000) &&
                p_spu->p_scale && p_region->p_cache )
            {
                p_region = p_region->p_cache;
            }

Laurent Aimar's avatar
Laurent Aimar committed
785
            if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
786 787
            {
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
Laurent Aimar's avatar
Laurent Aimar committed
788
                    p_subpic->i_y - p_region->i_y;
789
            }
Laurent Aimar's avatar
Laurent Aimar committed
790
            else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
791 792 793 794
            {
                i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
            }

Laurent Aimar's avatar
Laurent Aimar committed
795
            if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
796 797
            {
                i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
Laurent Aimar's avatar
Laurent Aimar committed
798
                    i_subpic_x - p_region->i_x;
799
            }
Laurent Aimar's avatar
Laurent Aimar committed
800
            else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
801 802 803 804
            {
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
            }

805 806
            if( p_subpic->b_absolute )
            {
807
                i_x_offset = p_region->i_x +
808
                    i_subpic_x * i_scale_width / 1000;
809 810 811
                i_y_offset = p_region->i_y +
                    p_subpic->i_y * i_scale_height / 1000;

812
            }
dionoea's avatar
dionoea committed
813

814 815
            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );
816 817 818 819 820 821 822 823 824 825 826

            if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
            {
                int i_diff = 0;
                int i_low = i_y_offset - p_spu->i_margin;
                int i_high = i_y_offset + p_region->fmt.i_height - p_spu->i_margin;

                /* crop extra margin to keep within bounds */
                if( i_low < 0 ) i_diff = i_low;
                if( i_high > (int)p_fmt->i_height ) i_diff = i_high - p_fmt->i_height;
                i_y_offset -= ( p_spu->i_margin + i_diff );
827 828 829
            }

            p_spu->p_blend->fmt_in.video = p_region->fmt;
830

831 832 833 834
            /* Force cropping if requested */
            if( p_spu->b_force_crop )
            {
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
835 836 837 838
                int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
                int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
                int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
                int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
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 865 866 867 868

                /* Find the intersection */
                if( i_crop_x + i_crop_width <= i_x_offset ||
                    i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
                    i_crop_y + i_crop_height <= i_y_offset ||
                    i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
                {
                    /* No intersection */
                    p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
                }
                else
                {
                    int i_x, i_y, i_x_end, i_y_end;
                    i_x = __MAX( i_crop_x, i_x_offset );
                    i_y = __MAX( i_crop_y, i_y_offset );
                    i_x_end = __MIN( i_crop_x + i_crop_width,
                                   i_x_offset + (int)p_fmt->i_visible_width );
                    i_y_end = __MIN( i_crop_y + i_crop_height,
                                   i_y_offset + (int)p_fmt->i_visible_height );

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

                    i_x_offset = i_x;
                    i_y_offset = i_y;
                }
            }

869
            /* Update the output picture size */
870 871 872 873 874 875 876
            p_spu->p_blend->fmt_out.video.i_width =
                p_spu->p_blend->fmt_out.video.i_visible_width =
                    p_fmt->i_width;
            p_spu->p_blend->fmt_out.video.i_height =
                p_spu->p_blend->fmt_out.video.i_visible_height =
                    p_fmt->i_height;

877 878 879 880 881 882 883 884 885 886 887 888
            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 );
                }
            }

889 890
            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );
891

892 893
            p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
                p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
894
                i_fade_alpha * p_subpic->i_alpha / 255 );
895

896 897 898 899 900 901 902 903 904 905
            if( b_rerender_text )
            {
                /* Some forms of subtitles need to be re-rendered more than once,
                 * eg. karaoke. We therefore restore the region to its pre-rendered
                 * state, so the next time through everything is calculated again.
                 */
                p_region->picture.pf_release( &p_region->picture );
                memset( &p_region->picture, 0, sizeof( picture_t ) );
                p_region->fmt = orig_fmt;
            }
906 907 908
            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
909 910
        p_subpic = p_subpic->p_next;
    }
gbazin's avatar
 
gbazin committed
911

912
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
913 914 915
}

/*****************************************************************************
916
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
917 918 919 920 921 922