vout_subpictures.c 39.3 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2005 the VideoLAN team
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6 7 8
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
9
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
24 25 26 27 28 29 30 31 32
 *****************************************************************************/

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

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

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;
82
    p_spu->pf_control = spu_vaControlDefault;
83 84

    /* Register the default subpicture channel */
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
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
Antoine Cellerier's avatar
 
Antoine Cellerier committed
101
    char *psz_parser;
102 103
    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
    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 );
Antoine Cellerier's avatar
 
Antoine Cellerier committed
111

112
    psz_parser = val.psz_string;
Antoine Cellerier's avatar
 
Antoine Cellerier committed
113 114

    while( psz_parser && *psz_parser )
115
    {
Antoine Cellerier's avatar
 
Antoine Cellerier committed
116 117 118 119
        config_chain_t *p_cfg; /* Do we ever need to free this ? */
        char *psz_name;

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

Antoine Cellerier's avatar
 
Antoine Cellerier committed
121
        msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
122

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

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

Antoine Cellerier's avatar
 
Antoine Cellerier committed
152
        free( psz_name );
153
    }
154
    if( val.psz_string ) free( val.psz_string );
155

156
    return VLC_EGENERIC;
157 158 159
}

/**
160
 * Destroy the subpicture unit
161
 *
162
 * \param p_this the parent object which destroys the subpicture unit
163
 */
164
void spu_Destroy( spu_t *p_spu )
165 166 167
{
    int i_index;

168 169
    vlc_object_detach( p_spu );

170 171 172
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
173
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
174
        {
175
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
176 177 178
        }
    }

179
    if( p_spu->p_blend )
180
    {
181 182
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
183

184 185
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
186 187
    }

188
    if( p_spu->p_text )
189
    {
190 191
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
192

193 194
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
195 196
    }

197 198 199 200 201 202 203 204 205
    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 );
    }

206 207 208 209
    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 );
210
        free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
211 212 213 214
        vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
        vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
    }

215 216
    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
217 218 219 220 221
}

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

229
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
230 231 232
    if( !p_input ) return;

    if( b_attach )
233
    {
234 235
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
236 237 238 239 240
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
241
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
242 243 244 245 246 247 248 249 250 251
        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
 */
252 253 254 255
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
256 257 258 259 260 261
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;
262
    p_region->p_cache = 0;
263
    p_region->fmt = *p_fmt;
264
    p_region->psz_text = 0;
265
    p_region->p_style = NULL;
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;

272
    p_region->picture.p_data_orig = NULL;
273 274

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

    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 );
282
        free( p_fmt->p_palette );
283 284 285
        return NULL;
    }

286 287
    p_region->picture.pf_release = RegionPictureRelease;

288 289 290
    return p_region;
}

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
/**
 * 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) );
    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;
308
    p_region->p_style = NULL;
309 310 311 312 313 314 315 316 317 318 319 320

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

321 322 323 324 325 326 327 328 329
/**
 * 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;
330 331
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
332
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
333
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
334 335
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
336

337
/**
338
 * Display a subpicture
339
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
340 341
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
342
 * \param p_spu the subpicture unit object
343 344
 * \param p_subpic the subpicture to display
 */
345
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
346 347 348 349
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
350 351
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
352 353
    }

354 355
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
356

357
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
358
    {
359 360 361
        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
362
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
363 364
}

365
/**
366
 * Allocate a subpicture in the spu heap.
367
 *
368
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
369 370 371
 * 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.
372
 * \param p_spu the subpicture unit in which to create the subpicture
373 374
 * \return NULL on error, a reserved subpicture otherwise
 */
375
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
376 377
{
    int                 i_subpic;                        /* subpicture index */
378
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
379

380
    /* Get lock */
381
    vlc_mutex_lock( &p_spu->subpicture_lock );
382

Sam Hocevar's avatar
 
Sam Hocevar committed
383 384 385
    /*
     * Look for an empty place
     */
386
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
387 388
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
389
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
390 391
        {
            /* Subpicture is empty and ready for allocation */
392 393
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
394
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
395 396 397
        }
    }

398 399
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
400
    {
401 402
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
403
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
404
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
405

406
    /* Copy subpicture information, set some default values */
407 408 409
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
410
    p_subpic->b_pausable = VLC_FALSE;
411
    p_subpic->b_fade     = VLC_FALSE;
412 413
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = 0;
414 415 416 417
    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
418

419
    p_subpic->pf_create_region = __spu_CreateRegion;
420
    p_subpic->pf_make_region = __spu_MakeRegion;
421
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
422

423
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
424 425
}

426 427 428
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
429 430 431
 * 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
432
 * by the spu.
433
 */
434
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
435
{
Gildas Bazin's avatar
 
Gildas Bazin committed
436
    /* Get lock */
437
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
438 439 440 441

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

446 447 448 449
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
450
        msg_Err( p_spu, "subpicture %p has invalid status %d",
451 452 453
                         p_subpic, p_subpic->i_status );
    }

454 455 456 457
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
458
        spu_DestroyRegion( p_spu, p_region );
459 460
    }

461 462 463 464 465 466
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

468
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
469 470 471
}

/*****************************************************************************
472
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
473
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
474
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
475
 *****************************************************************************/
476 477 478
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,
479
                            int i_scale_width_orig, int i_scale_height_orig )
Sam Hocevar's avatar
 
Sam Hocevar committed
480
{
Gildas Bazin's avatar
 
Gildas Bazin committed
481
    /* Get lock */
482
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
483 484 485

    /* 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
486
    {
487
        subpicture_region_t *p_region = p_subpic->p_region;
488
        int i_scale_width, i_scale_height;
489
        int i_subpic_x = p_subpic->i_x;
490

491
        /* Load the blending module */
492
        if( !p_spu->p_blend && p_region )
493
        {
494
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
495 496 497 498 499 500 501 502 503
            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 );
504
        }
505

506
        /* Load the text rendering module */
507
        if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
508
        {
509 510
            char *psz_modulename = NULL;

511
            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
512 513 514 515
            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 =
516
                p_fmt->i_width;
517 518
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
519
                p_fmt->i_height;
520

521 522
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
523 524 525 526 527 528 529 530 531 532 533 534 535

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", psz_modulename, VLC_TRUE );
            }
            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 );
536
        }
537
        if( p_spu->p_text )
538
        {
539 540 541 542 543 544 545 546 547 548 549 550 551 552
            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 =
553
                    p_fmt->i_width;
554 555
                p_spu->p_text->fmt_out.video.i_height =
                    p_spu->p_text->fmt_out.video.i_visible_height =
556
                    p_fmt->i_height;
557
            }
558
        }
559

560 561 562
        i_scale_width = i_scale_width_orig;
        i_scale_height = i_scale_height_orig;

563 564
        if( p_subpic->i_original_picture_height > 0 &&
            p_subpic->i_original_picture_width  > 0 )
565 566
        {
            i_scale_width = i_scale_width * p_fmt->i_width /
567
                             p_subpic->i_original_picture_width;
568
            i_scale_height = i_scale_height * p_fmt->i_height /
569
                             p_subpic->i_original_picture_height;
570
        }
571 572 573 574 575 576
        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;
            i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height; 
        }
577

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

592
        /* Take care of the aspect ratio */
593
        if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
594 595 596 597 598
            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;
599
            i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
600 601
        }

602
        /* Load the scaling module */
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
        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 );
620 621
        }

622
        while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
623
        {
624
            int i_fade_alpha = 255;
625 626
            int i_x_offset = p_region->i_x + i_subpic_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;
627

628 629
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
630
                if( p_spu->p_text && p_spu->p_text->p_module &&
631
                    p_spu->p_text->pf_render_text )
632 633
                {
                    p_region->i_align = p_subpic->i_flags;
634 635
                    p_spu->p_text->pf_render_text( p_spu->p_text,
                                                   p_region, p_region ); 
636 637 638
                }
            }

639
            /* Force palette if requested */
640
            if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
641
                p_region->fmt.i_chroma )
642
            {
643 644
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
645 646 647 648
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache )
649
            {
650 651 652 653 654 655 656 657 658
                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;
                }
659
            }
660

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
            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;
689 690
                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;
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707

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

708 709 710 711 712 713 714 715 716 717 718 719 720
            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 -
721
                    i_subpic_x;
722 723 724 725 726 727
            }
            else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
            {
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
            }

728 729
            if( p_subpic->b_absolute )
            {
730
                i_x_offset = p_region->i_x +
731
                    i_subpic_x * i_scale_width / 1000;
732 733 734
                i_y_offset = p_region->i_y +
                    p_subpic->i_y * i_scale_height / 1000;

735 736 737 738 739 740 741 742 743 744 745 746
            }

            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 );
747 748 749
            }

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

751 752 753 754
            /* Force cropping if requested */
            if( p_spu->b_force_crop )
            {
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
755 756 757 758
                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;
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788

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

789
            /* Update the output picture size */
790 791 792 793 794 795 796
            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;

797 798 799 800 801 802 803 804 805 806 807 808 809 810
            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,
811
                i_fade_alpha * p_subpic->i_alpha / 255 );
812 813 814 815

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
816 817
        p_subpic = p_subpic->p_next;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
818

819
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
820 821 822
}

/*****************************************************************************
823
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
824 825 826 827 828 829 830 831 832
 *****************************************************************************
 * 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.
 *****************************************************************************/
833 834
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
                                   vlc_bool_t b_paused )
Sam Hocevar's avatar
 
Sam Hocevar committed
835
{
836 837 838 839
    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
840

841 842 843 844 845 846 847 848 849 850 851 852
    /* 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
853 854
    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
855
    for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
856
    {
857 858 859 860
        p_ephemer = 0;
        ephemer_date = 0;

        for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
861
        {
862 863
            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
864
            {
865 866 867 868 869 870 871 872
                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
873

874 875
            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
876

877 878 879
            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 >
880 881 882
                  p_spu->p_subpicture[i_index].i_start ) &&
                !( p_spu->p_subpicture[i_index].b_pausable &&
                   b_paused ) )
883 884 885 886 887
            {
                /* Too late, destroy the subpic */
                spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
888

889 890 891 892 893
            /* 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
894

895 896
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
897

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
            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
913 914 915
            }
            else
            {
916 917 918
                /* Ephemer subpicture can still live a bit */
                p_tmp->p_next = p_subpic;
                p_subpic = p_tmp;
Sam Hocevar's avatar
 
Sam Hocevar committed
919 920 921 922 923 924 925
            }
        }
    }

    return p_subpic;
}

926
/*****************************************************************************
927
 * SpuClearChannel: clear an spu channel
928
 *****************************************************************************
929
 * This function destroys the subpictures which belong to the spu channel
930 931
 * corresponding to i_channel_id.
 *****************************************************************************/
932
static void SpuClearChannel( spu_t *p_spu, int i_channel )
933
{
934 935
    int          i_subpic;                               /* subpicture index */
    subpicture_t *p_subpic = NULL;                  /* first free subpicture */
936

937
    vlc_mutex_lock( &p_spu->subpicture_lock );
938 939 940

    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
941
        p_subpic = &p_spu->p_subpicture[i_subpic];
942 943 944 945 946 947
        if( p_subpic->i_status == FREE_SUBPICTURE
            || ( p_subpic->i_status != RESERVED_SUBPICTURE
                 && p_subpic->i_status != READY_SUBPICTURE ) )
        {
            continue;
        }
948

949 950
        if( p_subpic->i_channel == i_channel )
        {
951 952 953 954
            while( p_subpic->p_region )
            {
                subpicture_region_t *p_region = p_subpic->p_region;
                p_subpic->p_region = p_region->p_next;
955
                spu_DestroyRegion( p_spu, p_region );
956 957
            }

958
            if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
959 960 961 962
            p_subpic->i_status = FREE_SUBPICTURE;
        }
    }

963
    vlc_mutex_unlock( &p_spu->subpicture_lock );
964
}
965

966 967 968
/*****************************************************************************
 * spu_ControlDefault: default methods for the subpicture unit control.
 *****************************************************************************/
969
static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
970 971 972 973 974 975 976
{
    int *pi, i;

    switch( i_query )
    {
    case SPU_CHANNEL_REGISTER:
        pi = (int *)va_arg( args, int * );
977
        if( pi ) *pi = p_spu->i_channel++;
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
        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;
}

/************************************************************