vout_subpictures.c 37 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2005 VideoLAN
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 23 24 25 26 27 28 29 30 31 32
 *
 * 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
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

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

33
#include <vlc/vlc.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
34

35
#include "vlc_block.h"
36
#include "vlc_video.h"
Sam Hocevar's avatar
 
Sam Hocevar committed
37
#include "video_output.h"
38
#include "vlc_spu.h"
39 40
#include "vlc_filter.h"

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

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

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

gbazin's avatar
gbazin committed
57 58 59 60 61 62
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

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

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
75
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
76 77
    }

78 79 80
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
81
    p_spu->i_filter = 0;
gbazin's avatar
gbazin committed
82
    p_spu->pf_control = spu_vaControlDefault;
83 84

    /* Register the default subpicture channel */
gbazin's avatar
gbazin committed
85
    p_spu->i_channel = 2;
86 87

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

89 90
    vlc_object_attach( p_spu, p_this );

91 92 93 94 95 96 97 98 99 100 101 102 103
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
    char *psz_filter, *psz_filter_orig;
    vlc_value_t val;

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

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_Get( p_spu, "sub-filter", &val );
    psz_filter = psz_filter_orig = val.psz_string;
112
    while( psz_filter && *psz_filter )
113
    {
114 115 116 117 118
        char *psz_parser = strchr( psz_filter, ',' );
        if( !psz_parser ) psz_parser = strchr( psz_filter, ':' );

        if( psz_parser ) *psz_parser++ = 0;

119 120 121 122 123 124 125
        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;
        p_spu->pp_filter[p_spu->i_filter]->p_module =
            module_Need( p_spu->pp_filter[p_spu->i_filter],
126
                         "sub filter", psz_filter, 0 );
gbazin's avatar
gbazin committed
127 128 129 130 131 132 133 134
        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++;
        }
135 136
        else
        {
137
            msg_Dbg( p_spu, "no sub filter found" );
138 139 140
            vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
            vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
        }
141 142 143 144 145 146 147

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

        psz_filter = psz_parser;
148 149
    }
    if( psz_filter_orig ) free( psz_filter_orig );
150

151
    return VLC_EGENERIC;
152 153 154
}

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

163 164
    vlc_object_detach( p_spu );

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

174
    if( p_spu->p_blend )
175
    {
176 177
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
178

179 180
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
181 182
    }

183
    if( p_spu->p_text )
184
    {
185 186
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
187

188 189
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
190 191
    }

192 193 194 195 196 197 198 199 200
    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 );
    }

201 202 203 204
    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
205
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
206 207 208 209
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }

210 211
    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
212 213 214 215 216
}

/**
 * Attach/Detach the SPU from any input
 *
217
 * \param p_this the object in which to destroy the subpicture unit
218 219
 * \param b_attach to select attach or detach
 */
220
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
221 222 223
{
    vlc_object_t *p_input;

224
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
225 226 227
    if( !p_input ) return;

    if( b_attach )
228
    {
229 230
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
231 232 233 234 235
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
236
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
237 238 239 240 241 242 243 244 245 246
        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
 */
247 248 249 250
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
251 252 253 254 255 256
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) );
    memset( p_region, 0, sizeof(subpicture_region_t) );
    p_region->p_next = 0;
257
    p_region->p_cache = 0;
258
    p_region->fmt = *p_fmt;
259
    p_region->psz_text = 0;
260 261
    p_region->i_font_color = -1; /* default to using freetype-color -opacity */
    p_region->i_font_opacity = -1;
262
    p_region->i_font_size = -1; /* and the freetype fontsize */
263 264 265 266 267 268 269 270 271

    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;

    p_region->picture.p_data_orig = 0;

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
272 273 274 275 276 277 278

    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 );
279
        free( p_fmt->p_palette );
280 281 282
        return NULL;
    }

283 284
    p_region->picture.pf_release = RegionPictureRelease;

285 286 287 288 289 290 291 292 293 294 295 296
    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 )
{
    if( !p_region ) return;
297 298
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
299
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
300
    if( p_region->psz_text ) free( p_region->psz_text );
301
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
302 303
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
304

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

322 323
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
324

325
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
326
    {
327 328 329
        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
330
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
331 332
}

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

348
    /* Get lock */
349
    vlc_mutex_lock( &p_spu->subpicture_lock );
350

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

366 367
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
368
    {
369 370
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
371
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
372
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
373

374
    /* Copy subpicture information, set some default values */
375 376 377
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
378
    p_subpic->b_fade     = VLC_FALSE;
379 380
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = 0;
381 382 383 384
    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
385

386 387
    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
388
    
389
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
390 391
}

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

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

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

420 421 422 423
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
424
        spu_DestroyRegion( p_spu, p_region );
425 426
    }

427 428 429 430 431 432
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

434
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
435 436 437
}

/*****************************************************************************
438
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
439
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
440
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
441
 *****************************************************************************/
442 443 444
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,
445
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
446
{
447

gbazin's avatar
 
gbazin committed
448
    /* Get lock */
449
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
450 451 452

    /* 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
453
    {
454
        subpicture_region_t *p_region = p_subpic->p_region;
455
        int i_scale_width, i_scale_height;
456

457
        /* Load the blending module */
458
        if( !p_spu->p_blend && p_region )
459
        {
460
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
461 462 463 464 465 466 467 468 469
            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');

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

472
        /* Load the text rendering module */
473
        if( !p_spu->p_text && p_region )
474
        {
475
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
476 477 478 479 480 481 482 483
            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 =
                    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;
484
                
485 486
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
487 488 489 490
            p_spu->p_text->p_module =
                module_Need( p_spu->p_text, "text renderer", 0, 0 );
        }

491 492 493
        i_scale_width = i_scale_width_orig;
        i_scale_height = i_scale_height_orig;

494
        if( p_subpic->i_original_picture_width &&
495 496 497 498 499 500 501 502
            p_subpic->i_original_picture_height )
        {
            i_scale_width = i_scale_width * p_fmt->i_width /
                p_subpic->i_original_picture_width;
            i_scale_height = i_scale_height * p_fmt->i_height /
                p_subpic->i_original_picture_height;
        }

503
        /* Take care of the aspect ratio */
504
        if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
505 506 507 508 509 510 511
            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;
        }

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
        /* Load the scaling module */
        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');
            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 );
530 531
        }

532 533
        if( p_subpic->pf_render )
        {
534 535 536 537 538 539 540
            /* HACK to remove when the ogt subpic decoder is gone */
            if( p_spu->p_parent &&
                p_spu->p_parent->i_object_type == VLC_OBJECT_VOUT )
            {
                vout_thread_t *p_vout = (vout_thread_t *)p_spu->p_parent;
                p_subpic->pf_render( p_vout, p_pic_dst, p_subpic );
            }
541
        }
542 543
        else while( p_region && p_spu->p_blend &&
                    p_spu->p_blend->pf_video_blend )
544
        {
545
            int i_fade_alpha = 255;
546 547 548
            int i_x_offset = p_region->i_x + p_subpic->i_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;

549 550
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
551 552
                if( p_spu->p_text && p_spu->p_text->p_module &&
                    p_spu->p_text->pf_render_string )
553 554 555
                {
                    /* TODO: do it in a less hacky way
                     * (modify text renderer API) */
556
                    subpicture_region_t *p_tmp_region;
557
                    /*  the actual call  to RenderText in freetype.c: */
558 559 560 561 562 563 564
                    p_tmp_region = p_spu->p_text->pf_render_string(
                        p_spu->p_text, p_subpic, p_region ); 

                    if( p_tmp_region )
                    {
//                        p_subpic->pf_destroy_region( p_spu, p_region );
                        p_region = p_tmp_region;
565 566 567 568
                    }
                }
            }

569
            /* Force palette if requested */
570
            if( p_spu->b_force_alpha && VLC_FOURCC('Y','U','V','P') ==
571
                p_region->fmt.i_chroma )
572
            {
573 574 575 576
                p_region->fmt.p_palette->palette[0][3] = p_spu->pi_alpha[0];
                p_region->fmt.p_palette->palette[1][3] = p_spu->pi_alpha[1];
                p_region->fmt.p_palette->palette[2][3] = p_spu->pi_alpha[2];
                p_region->fmt.p_palette->palette[3][3] = p_spu->pi_alpha[3];
577 578 579 580
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache )
581
            {
582 583 584 585 586 587 588 589 590
                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;
                }
591
            }
592

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
            if( (i_scale_width != 1000 || i_scale_height != 1000) &&
                p_spu->p_scale && !p_region->p_cache )
            {
                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;
621 622
                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;
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639

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

640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
            if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
            {
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
                    p_subpic->i_y;
            }
            else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
            {
                i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
            }

            if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
            {
                i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
                    p_subpic->i_x;
            }
            else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
            {
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
            }

660 661
            if( p_subpic->b_absolute )
            {
662 663 664 665 666 667 668 669 670 671 672 673 674 675
                i_x_offset = p_region->i_x +
                    p_subpic->i_x * i_scale_width / 1000;
                i_y_offset = p_region->i_y +
                    p_subpic->i_y * i_scale_height / 1000;

                if( p_spu->i_margin >= 0 )
                {
                    if( p_subpic->i_height + (unsigned int)p_spu->i_margin <=
                        p_fmt->i_height )
                    {
                        i_y_offset = p_fmt->i_height -
                            p_spu->i_margin - p_subpic->i_height;
                    }
                }
676 677 678
            }

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

680 681 682 683
            /* Force cropping if requested */
            if( p_spu->b_force_crop )
            {
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
684 685 686 687
                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;
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

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

718
            /* Update the output picture size */
719 720 721 722 723 724 725
            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;

726 727 728 729 730 731 732 733 734 735 736 737 738 739
            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 );
                }
            }

            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,
740
                i_fade_alpha * p_subpic->i_alpha / 255 );
741 742 743 744

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
745 746
        p_subpic = p_subpic->p_next;
    }
gbazin's avatar
 
gbazin committed
747

748
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
749 750 751
}

/*****************************************************************************
752
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
753 754 755 756 757 758 759 760 761
 *****************************************************************************
 * This function parses all subpictures and decides which ones need to be
 * displayed. This operation does not need lock, since only READY_SUBPICTURE
 * are handled. If no picture has been selected, display_date will depend on
 * the subpicture.
 * We also check for ephemer DVD subpictures (subpictures that have
 * to be removed if a newer one is available), which makes it a lot
 * more difficult to guess if a subpicture has to be rendered or not.
 *****************************************************************************/
762
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
Sam Hocevar's avatar
 
Sam Hocevar committed
763
{
gbazin's avatar
gbazin committed
764 765 766 767
    int i_index, i_channel;
    subpicture_t *p_subpic = NULL;
    subpicture_t *p_ephemer;
    mtime_t      ephemer_date;
Sam Hocevar's avatar
 
Sam Hocevar committed
768

769 770 771 772 773 774 775 776 777 778 779 780
    /* Run subpicture filters */
    for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
    {
        subpicture_t *p_subpic_filter;
        p_subpic_filter = p_spu->pp_filter[i_index]->
            pf_sub_filter( p_spu->pp_filter[i_index], display_date );
        if( p_subpic_filter )
        {
            spu_DisplaySubpicture( p_spu, p_subpic_filter );
        }
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
781 782
    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
gbazin's avatar
gbazin committed
783
    for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
784
    {
gbazin's avatar
gbazin committed
785 786 787 788
        p_ephemer = 0;
        ephemer_date = 0;

        for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
789
        {
gbazin's avatar
gbazin committed
790 791
            if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
                p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
792
            {
gbazin's avatar
gbazin committed
793 794 795 796 797 798 799 800
                continue;
            }
            if( display_date &&
                display_date < p_spu->p_subpicture[i_index].i_start )
            {
                /* Too early, come back next monday */
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
801

gbazin's avatar
gbazin committed
802 803
            if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
                ephemer_date = p_spu->p_subpicture[i_index].i_start;
Sam Hocevar's avatar
 
Sam Hocevar committed
804

gbazin's avatar
gbazin committed
805 806 807 808 809 810 811 812 813
            if( display_date > p_spu->p_subpicture[i_index].i_stop &&
                ( !p_spu->p_subpicture[i_index].b_ephemer ||
                  p_spu->p_subpicture[i_index].i_stop >
                  p_spu->p_subpicture[i_index].i_start ) )
            {
                /* Too late, destroy the subpic */
                spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
814

gbazin's avatar
gbazin committed
815 816 817 818 819
            /* If this is an ephemer subpic, add it to our list */
            if( p_spu->p_subpicture[i_index].b_ephemer )
            {
                p_spu->p_subpicture[i_index].p_next = p_ephemer;
                p_ephemer = &p_spu->p_subpicture[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
820

gbazin's avatar
gbazin committed
821 822
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
823

gbazin's avatar
gbazin committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
            p_spu->p_subpicture[i_index].p_next = p_subpic;
            p_subpic = &p_spu->p_subpicture[i_index];
        }

        /* If we found ephemer subpictures, check if they have to be
         * displayed or destroyed */
        while( p_ephemer != NULL )
        {
            subpicture_t *p_tmp = p_ephemer;
            p_ephemer = p_ephemer->p_next;

            if( p_tmp->i_start < ephemer_date )
            {
                /* Ephemer subpicture has lived too long */
                spu_DestroySubpicture( p_spu, p_tmp );
Sam Hocevar's avatar
 
Sam Hocevar committed
839 840 841
            }
            else
            {
gbazin's avatar
gbazin committed
842 843 844
                /* Ephemer subpicture can still live a bit */
                p_tmp->p_next = p_subpic;
                p_subpic = p_tmp;
Sam Hocevar's avatar
 
Sam Hocevar committed
845 846 847 848 849 850 851
            }
        }
    }

    return p_subpic;
}

852
/*****************************************************************************
853
 * SpuClearChannel: clear an spu channel
854
 *****************************************************************************
855
 * This function destroys the subpictures which belong to the spu channel
856 857
 * corresponding to i_channel_id.
 *****************************************************************************/
858
static void SpuClearChannel( spu_t *p_spu, int i_channel )
859
{
gbazin's avatar
gbazin committed
860 861
    int          i_subpic;                               /* subpicture index */
    subpicture_t *p_subpic = NULL;                  /* first free subpicture */
862

863
    vlc_mutex_lock( &p_spu->subpicture_lock );
864 865 866

    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
867
        p_subpic = &p_spu->p_subpicture[i_subpic];
868 869 870 871 872 873
        if( p_subpic->i_status == FREE_SUBPICTURE
            || ( p_subpic->i_status != RESERVED_SUBPICTURE
                 && p_subpic->i_status != READY_SUBPICTURE ) )
        {
            continue;
        }
874

875 876
        if( p_subpic->i_channel == i_channel )
        {
877 878 879 880
            while( p_subpic->p_region )
            {
                subpicture_region_t *p_region = p_subpic->p_region;
                p_subpic->p_region = p_region->p_next;
881
                spu_DestroyRegion( p_spu, p_region );
882 883
            }

884
            if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
885 886 887 888
            p_subpic->i_status = FREE_SUBPICTURE;
        }
    }

889
    vlc_mutex_unlock( &p_spu->subpicture_lock );
890
}
891

892 893 894
/*****************************************************************************
 * spu_ControlDefault: default methods for the subpicture unit control.
 *****************************************************************************/
gbazin's avatar
gbazin committed
895
static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
896 897 898 899 900 901 902
{
    int *pi, i;

    switch( i_query )
    {
    case SPU_CHANNEL_REGISTER:
        pi = (int *)va_arg( args, int * );
gbazin's avatar
gbazin committed
903
        if( pi ) *pi = p_spu->i_channel++;
904
        msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
gbazin's avatar
gbazin committed
905
                 p_spu->i_channel - 1 );
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
        break;

    case SPU_CHANNEL_CLEAR:
        i = (int)va_arg( args, int );
        SpuClearChannel( p_spu, i );
        break;

    default:
        msg_Dbg( p_spu, "control query not supported" );
        return VLC_EGENERIC;
    }

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Object variables callbacks
 *****************************************************************************/

925 926 927 928 929 930
/*****************************************************************************
 * UpdateSPU: update subpicture settings
 *****************************************************************************
 * This function is called from CropCallback and at initialization time, to
 * retrieve crop information from the input.
 *****************************************************************************/
931
static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
932 933 934
{
    vlc_value_t val;

935 936
    p_spu->b_force_alpha = VLC_FALSE;
    p_spu->b_force_crop = VLC_FALSE;
937 938 939

    if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;

940
    p_spu->b_force_crop = VLC_TRUE;
941
    var_Get( p_object, "x-start", &val );
942
    p_spu->i_crop_x = val.i_int;
943
    var_Get( p_object, "y-start", &val );
944
    p_spu->i_crop_y = val.i_int;
945
    var_Get( p_object, "x-end", &val );
946
    p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
947
    var_Get( p_object, "y-end", &val );
948
    p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
949 950 951 952 953 954 955

#if 0
    if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
    {
        int i;
        for( i = 0; i < 4; i++ )
        {
956
            p_spu->pi_color[i] = ((uint8_t *)val.p_address)[i];
957 958 959 960 961 962 963 964 965
        }
    }
#endif

    if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
    {
        int i;
        for( i = 0; i < 4; i++ )
        {
966 967 968
            p_spu->pi_alpha[i] = ((uint8_t *)val.p_address)[i];
            p_spu->pi_alpha[i] = p_spu->pi_alpha[i] == 0xf ?
                0xff : p_spu->pi_alpha[i] << 4;
969
        }
970
        p_spu->b_force_alpha = VLC_TRUE;