vout_subpictures.c 33.7 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
4
 * Copyright (C) 2000-2004 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 41
#include "vlc_filter.h"
#include "osd.h"

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

static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
51 52
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
53 54

/**
55
 * Initialise the subpicture unit
56
 *
57
 * \param p_this the parent object which creates the subpicture unit
58
 */
59
spu_t *__spu_Init( vlc_object_t *p_this )
60 61
{
    int i_index;
62
    spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
63 64 65

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
66 67
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
        p_spu->p_subpicture[i_index].i_type   = EMPTY_SUBPICTURE;
68 69
    }

70 71 72 73 74 75 76 77
    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;

    /* Register the default subpicture channel */
    p_spu->i_channel = 1;

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

79 80 81 82 83 84
    vlc_object_attach( p_spu, p_this );

    /* If the user requested an SPU margin, we force the position. */
    p_spu->i_margin = config_GetInt( p_spu, "spumargin" );

    return p_spu;
85 86 87
}

/**
88
 * Destroy the subpicture unit
89
 *
90
 * \param p_this the parent object which destroys the subpicture unit
91
 */
92
void spu_Destroy( spu_t *p_spu )
93 94 95
{
    int i_index;

96 97
    vlc_object_detach( p_spu );

98 99 100
    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
101
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
102
        {
103
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
104 105 106
        }
    }

107
    if( p_spu->p_blend )
108
    {
109 110
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
111

112 113
        vlc_object_detach( p_spu->p_blend );
        vlc_object_destroy( p_spu->p_blend );
114 115
    }

116
    if( p_spu->p_text )
117
    {
118 119
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
120

121 122
        vlc_object_detach( p_spu->p_text );
        vlc_object_destroy( p_spu->p_text );
123 124
    }

125 126 127 128 129 130 131 132 133 134 135
    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 );
    }

    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_destroy( p_spu );
136 137 138 139 140
}

/**
 * Attach/Detach the SPU from any input
 *
141
 * \param p_this the object in which to destroy the subpicture unit
142 143
 * \param b_attach to select attach or detach
 */
144
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
145 146 147
{
    vlc_object_t *p_input;

148
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
149 150 151
    if( !p_input ) return;

    if( b_attach )
152
    {
153 154
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
155 156 157 158 159
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
160
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
161 162 163 164 165 166 167 168 169 170
        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
 */
171 172 173 174
static void RegionPictureRelease( picture_t *p_pic )
{
    if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
}
175 176 177 178 179 180
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;
181
    p_region->p_cache = 0;
182
    p_region->fmt = *p_fmt;
183 184 185 186 187 188 189 190 191 192
    p_region->psz_text = 0;

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

    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 );
200
        free( p_fmt->p_palette );
201 202 203
        return NULL;
    }

204 205
    p_region->picture.pf_release = RegionPictureRelease;

206 207 208 209 210 211 212 213 214 215 216 217
    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;
218 219
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
220
    if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
221
    if( p_region->psz_text ) free( p_region->psz_text );
222
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
223 224
    free( p_region );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
225

226
/**
227
 * Display a subpicture
228
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
229 230
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
231
 * \param p_spu the subpicture unit object
232 233
 * \param p_subpic the subpicture to display
 */
234
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
235 236 237 238
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
239 240
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
241 242
    }

243 244
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
245

246
    if( p_subpic->i_channel == DEFAULT_CHAN )
Sam Hocevar's avatar
 
Sam Hocevar committed
247
    {
248 249 250
        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
251
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
252 253
}

254
/**
255
 * Allocate a subpicture in the spu heap.
256
 *
257
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
258 259 260
 * 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.
261
 * \param p_spu the subpicture unit in which to create the subpicture
262 263
 * \return NULL on error, a reserved subpicture otherwise
 */
264
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
265 266
{
    int                 i_subpic;                        /* subpicture index */
267
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
268

269
    /* Get lock */
270
    vlc_mutex_lock( &p_spu->subpicture_lock );
271

Sam Hocevar's avatar
 
Sam Hocevar committed
272 273 274
    /*
     * Look for an empty place
     */
275
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
276 277
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
278
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
279 280
        {
            /* Subpicture is empty and ready for allocation */
281 282
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
283
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
284 285 286
        }
    }

287 288
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
289
    {
290 291
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
292
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
293
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
294

295
    /* Copy subpicture information, set some default values */
296 297 298 299 300 301 302
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_type     = MEMORY_SUBPICTURE;
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = VLC_TRUE;
    p_subpic->pf_render  = 0;
    p_subpic->pf_destroy = 0;
    p_subpic->p_sys      = 0;
303

304
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
305

306 307 308
    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;

309
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
310 311
}

312 313 314
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
315 316 317
 * 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
318
 * by the spu.
319
 */
320
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
321
{
Gildas Bazin's avatar
 
Gildas Bazin committed
322
    /* Get lock */
323
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
324 325 326 327

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

332 333 334 335
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
336
        msg_Err( p_spu, "subpicture %p has invalid status %d",
337 338 339
                         p_subpic, p_subpic->i_status );
    }

340 341 342 343
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
344
        spu_DestroyRegion( p_spu, p_region );
345 346
    }

347 348 349 350 351 352
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

354
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
355 356 357
}

/*****************************************************************************
358
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
359
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
360
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
361
 *****************************************************************************/
362 363 364 365
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,
                            int i_scale_width, int i_scale_height )
Sam Hocevar's avatar
 
Sam Hocevar committed
366
{
Gildas Bazin's avatar
 
Gildas Bazin committed
367
    /* Get lock */
368
    vlc_mutex_lock( &p_spu->subpicture_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
369 370 371

    /* 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
372
    {
373 374
        subpicture_region_t *p_region = p_subpic->p_region;

375
        /* Load the blending module */
376
        if( !p_spu->p_blend && p_region )
377
        {
378 379 380 381 382 383 384 385 386 387 388
            p_spu->p_blend = vlc_object_create( p_spu, sizeof(filter_t) );
            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 );
389
        }
390

391
        /* Load the text rendering module */
392
        if( !p_spu->p_text && p_region )
393
        {
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
            p_spu->p_text = vlc_object_create( p_spu, sizeof(filter_t) );
            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;

            p_spu->p_text->pf_spu_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_spu_buffer_del = spu_del_buffer;

            p_spu->p_text->p_module =
                module_Need( p_spu->p_text, "text renderer", 0, 0 );
        }

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

431 432
        if( p_subpic->pf_render )
        {
433 434 435 436 437 438 439
            /* 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 );
            }
440
        }
441 442
        else while( p_region && p_spu->p_blend &&
                    p_spu->p_blend->pf_video_blend )
443 444 445 446
        {
            int i_x_offset = p_region->i_x + p_subpic->i_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;

447 448
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
449 450
                if( p_spu->p_text && p_spu->p_text->p_module &&
                    p_spu->p_text->pf_render_string )
451 452 453
                {
                    /* TODO: do it in a less hacky way
                     * (modify text renderer API) */
454
                    subpicture_t *p_subpic_tmp;
455 456
                    subpicture_region_t tmp_region;
                    block_t *p_new_block =
457
                        block_New( p_spu, strlen(p_region->psz_text) + 1 );
458 459 460 461 462 463 464 465 466

                    if( p_new_block )
                    {
                        memcpy( p_new_block->p_buffer, p_region->psz_text,
                                p_new_block->i_buffer );
                        p_new_block->i_pts = p_new_block->i_dts =
                            p_subpic->i_start;
                        p_new_block->i_length =
                            p_subpic->i_start - p_subpic->i_stop;
467 468
                        p_subpic_tmp = p_spu->p_text->pf_render_string(
                            p_spu->p_text, p_new_block );
469

470
                        if( p_subpic_tmp )
471 472
                        {
                            tmp_region = *p_region;
473
                            *p_region = *p_subpic_tmp->p_region;
474
                            p_region->p_next = tmp_region.p_next;
475 476 477
                            *p_subpic_tmp->p_region = tmp_region;
                            p_spu->p_text->pf_spu_buffer_del( p_spu->p_text,
                                                              p_subpic_tmp );
478 479 480 481 482
                        }
                    }
                }
            }

483 484
            if( p_subpic->i_flags & OSD_ALIGN_BOTTOM )
            {
485
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
486
                    p_subpic->i_y;
487 488 489
            }
            else if ( !(p_subpic->i_flags & OSD_ALIGN_TOP) )
            {
490
                i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
491 492 493 494
            }

            if( p_subpic->i_flags & OSD_ALIGN_RIGHT )
            {
495
                i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
496
                    p_subpic->i_x;
497 498 499
            }
            else if ( !(p_subpic->i_flags & OSD_ALIGN_LEFT) )
            {
500
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
501 502 503 504 505 506 507
            }

            if( p_subpic->b_absolute )
            {
                i_x_offset = p_region->i_x + p_subpic->i_x;
                i_y_offset = p_region->i_y + p_subpic->i_y;

508 509 510 511 512 513 514 515 516 517
                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;
                    }
                }
            }
518 519

            /* Force cropping if requested */
520
            if( p_spu->b_force_crop )
521
            {
522
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
523 524

                /* Find the intersection */
525
                if( p_spu->i_crop_x + p_spu->i_crop_width <= i_x_offset ||
526
                    i_x_offset + (int)p_fmt->i_visible_width <
527 528
                        p_spu->i_crop_x ||
                    p_spu->i_crop_y + p_spu->i_crop_height <= i_y_offset ||
529
                    i_y_offset + (int)p_fmt->i_visible_height <
530
                        p_spu->i_crop_y )
531 532 533 534 535 536 537
                {
                    /* 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;
538 539 540
                    i_x = __MAX( p_spu->i_crop_x, i_x_offset );
                    i_y = __MAX( p_spu->i_crop_y, i_y_offset );
                    i_x_end = __MIN( p_spu->i_crop_x + p_spu->i_crop_width,
541
                                   i_x_offset + (int)p_fmt->i_visible_width );
542
                    i_y_end = __MIN( p_spu->i_crop_y + p_spu->i_crop_height,
543 544 545 546 547 548 549 550 551 552
                                   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;
                }
553 554 555
            }

            /* Force palette if requested */
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
            if( p_spu->b_force_alpha && VLC_FOURCC('Y','U','V','P') ==
                p_spu->p_blend->fmt_in.video.i_chroma )
            {
                p_spu->p_blend->fmt_in.video.p_palette->palette[0][3] =
                    p_spu->pi_alpha[0];
                p_spu->p_blend->fmt_in.video.p_palette->palette[1][3] =
                    p_spu->pi_alpha[1];
                p_spu->p_blend->fmt_in.video.p_palette->palette[2][3] =
                    p_spu->pi_alpha[2];
                p_spu->p_blend->fmt_in.video.p_palette->palette[3][3] =
                    p_spu->pi_alpha[3];
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache )
571
            {
572 573 574 575 576 577 578 579 580
                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;
                }
581
            }
582 583 584 585 586 587 588 589 590 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 621 622 623 624 625 626 627 628 629 630 631 632 633
            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;

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

            if( p_subpic->b_absolute )
            {
                i_x_offset = i_x_offset * i_scale_width / 1000;
                i_y_offset = i_y_offset * i_scale_height / 1000;
            }

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

635
            /* Update the output picture size */
636 637 638 639 640 641 642 643
            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;

           p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
644
                p_pic_src, &p_region->picture, i_x_offset, i_y_offset );
645 646 647 648

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
649 650
        p_subpic = p_subpic->p_next;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
651

652
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
653 654 655
}

/*****************************************************************************
656
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
657 658 659 660 661 662 663 664 665
 *****************************************************************************
 * 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.
 *****************************************************************************/
666
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
Sam Hocevar's avatar
 
Sam Hocevar committed
667 668 669 670 671 672 673 674 675 676
{
    int i_index;
    subpicture_t *p_subpic     = NULL;
    subpicture_t *p_ephemer    = NULL;
    mtime_t       ephemer_date = 0;

    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
677
        if( p_spu->p_subpicture[i_index].i_status == READY_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
678 679
        {
            /* If it is a DVD subpicture, check its date */
680
            if( p_spu->p_subpicture[i_index].i_type == MEMORY_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
681
            {
682 683
                if( !p_spu->p_subpicture[i_index].b_ephemer
                     && display_date > p_spu->p_subpicture[i_index].i_stop )
Sam Hocevar's avatar
 
Sam Hocevar committed
684 685
                {
                    /* Too late, destroy the subpic */
686
                    spu_DestroySubpicture(p_spu,&p_spu->p_subpicture[i_index]);
Sam Hocevar's avatar
 
Sam Hocevar committed
687 688 689
                    continue;
                }

690
                if( display_date
691
                     && display_date < p_spu->p_subpicture[i_index].i_start )
Sam Hocevar's avatar
 
Sam Hocevar committed
692 693 694 695 696 697 698
                {
                    /* Too early, come back next monday */
                    continue;
                }

                /* If this is an ephemer subpic, see if it's the
                 * youngest we have */
699
                if( p_spu->p_subpicture[i_index].b_ephemer )
Sam Hocevar's avatar
 
Sam Hocevar committed
700 701 702
                {
                    if( p_ephemer == NULL )
                    {
703
                        p_ephemer = &p_spu->p_subpicture[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
704 705 706
                        continue;
                    }

707
                    if( p_spu->p_subpicture[i_index].i_start
Sam Hocevar's avatar
 
Sam Hocevar committed
708 709 710 711 712 713
                                                     < p_ephemer->i_start )
                    {
                        /* Link the previous ephemer subpicture and
                         * replace it with the current one */
                        p_ephemer->p_next = p_subpic;
                        p_subpic = p_ephemer;
714
                        p_ephemer = &p_spu->p_subpicture[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
715 716 717 718 719 720 721 722 723 724 725 726 727

                        /* If it's the 2nd youngest subpicture,
                         * register its date */
                        if( !ephemer_date
                              || ephemer_date > p_subpic->i_start )
                        {
                            ephemer_date = p_subpic->i_start;
                        }

                        continue;
                    }
                }

728 729
                p_spu->p_subpicture[i_index].p_next = p_subpic;
                p_subpic = &p_spu->p_subpicture[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
730

731 732
                /* If it's the 2nd youngest subpicture, register its date */
                if( !ephemer_date || ephemer_date > p_subpic->i_start )
Sam Hocevar's avatar
 
Sam Hocevar committed
733 734 735 736 737 738 739
                {
                    ephemer_date = p_subpic->i_start;
                }
            }
            /* If it's not a DVD subpicture, just register it */
            else
            {
740 741
                p_spu->p_subpicture[i_index].p_next = p_subpic;
                p_subpic = &p_spu->p_subpicture[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
742 743 744 745 746 747 748 749
            }
        }
    }

    /* If we found an ephemer subpicture, check if it has to be
     * displayed */
    if( p_ephemer != NULL )
    {
750
        if( p_ephemer->i_start <= ephemer_date )
Sam Hocevar's avatar
 
Sam Hocevar committed
751 752
        {
            /* Ephemer subpicture has lived too long */
753
            spu_DestroySubpicture( p_spu, p_ephemer );
Sam Hocevar's avatar
 
Sam Hocevar committed
754 755 756 757 758 759 760 761 762 763 764 765
        }
        else
        {
            /* Ephemer subpicture can still live a bit */
            p_ephemer->p_next = p_subpic;
            return p_ephemer;
        }
    }

    return p_subpic;
}

766
/*****************************************************************************
767
 * SpuClearChannel: clear an spu channel
768
 *****************************************************************************
769
 * This function destroys the subpictures which belong to the spu channel
770 771
 * corresponding to i_channel_id.
 *****************************************************************************/
772
static void SpuClearChannel( spu_t *p_spu, int i_channel )
773 774 775 776
{
    int                 i_subpic;                        /* subpicture index */
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */

777
    vlc_mutex_lock( &p_spu->subpicture_lock );
778 779 780

    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
781
        p_subpic = &p_spu->p_subpicture[i_subpic];
782 783 784 785 786 787
        if( p_subpic->i_status == FREE_SUBPICTURE
            || ( p_subpic->i_status != RESERVED_SUBPICTURE
                 && p_subpic->i_status != READY_SUBPICTURE ) )
        {
            continue;
        }
788

789 790
        if( p_subpic->i_channel == i_channel )
        {
791 792 793 794
            while( p_subpic->p_region )
            {
                subpicture_region_t *p_region = p_subpic->p_region;
                p_subpic->p_region = p_region->p_next;
795
                spu_DestroyRegion( p_spu, p_region );
796 797
            }

798
            if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
799 800 801 802
            p_subpic->i_status = FREE_SUBPICTURE;
        }
    }

803
    vlc_mutex_unlock( &p_spu->subpicture_lock );
804
}
805

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
/*****************************************************************************
 * spu_ControlDefault: default methods for the subpicture unit control.
 *****************************************************************************/
int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
{
    int *pi, i;

    switch( i_query )
    {
    case SPU_CHANNEL_REGISTER:
        pi = (int *)va_arg( args, int * );
        p_spu->i_channel++;
        if( pi ) *pi = p_spu->i_channel;
        msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
                 p_spu->i_channel );
        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
 *****************************************************************************/

840 841 842 843 844 845
/*****************************************************************************
 * UpdateSPU: update subpicture settings
 *****************************************************************************
 * This function is called from CropCallback and at initialization time, to
 * retrieve crop information from the input.
 *****************************************************************************/
846
static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
847 848 849
{
    vlc_value_t val;

850 851
    p_spu->b_force_alpha = VLC_FALSE;
    p_spu->b_force_crop = VLC_FALSE;
852 853 854

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

855
    p_spu->b_force_crop = VLC_TRUE;
856
    var_Get( p_object, "x-start", &val );
857
    p_spu->i_crop_x = val.i_int;
858
    var_Get( p_object, "y-start", &val );
859
    p_spu->i_crop_y = val.i_int;
860
    var_Get( p_object, "x-end", &val );
861
    p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
862
    var_Get( p_object, "y-end", &val );
863
    p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
864 865 866 867 868 869 870

#if 0
    if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
    {
        int i;
        for( i = 0; i < 4; i++ )
        {
871
            p_spu->pi_color[i] = ((uint8_t *)val.p_address)[i];
872 873 874 875 876 877 878 879 880
        }
    }
#endif

    if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
    {
        int i;
        for( i = 0; i < 4; i++ )
        {
881 882 883
            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;
884
        }
885
        p_spu->b_force_alpha = VLC_TRUE;
886 887
    }

888 889 890
    msg_Dbg( p_object, "crop: %i,%i,%i,%i, alpha: %i",
             p_spu->i_crop_x, p_spu->i_crop_y,
             p_spu->i_crop_width, p_spu->i_crop_height, p_spu->b_force_alpha );
891 892 893 894 895 896 897 898 899 900
}

/*****************************************************************************
 * CropCallback: called when the highlight properties are changed
 *****************************************************************************
 * This callback is called from the input thread when we need cropping
 *****************************************************************************/
static int CropCallback( vlc_object_t *p_object, char const *psz_var,
                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
901
    UpdateSPU( (spu_t *)p_data, p_object );
902 903 904 905 906 907 908 909
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Buffers allocation callbacks for the filters
 *****************************************************************************/
static subpicture_t *spu_new_buffer( filter_t *p_filter )
{
910 911 912 913 914 915
    subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->b_absolute = VLC_TRUE;

    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;
916

917
    return p_subpic;
918 919
}

920
static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
921
{
922 923 924 925 926 927 928 929
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
        p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
    }

    free( p_subpic );
930
}
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956

static picture_t *spu_new_video_buffer( filter_t *p_filter )
{
    picture_t *p_picture = malloc( sizeof(picture_t) );

    if( vout_AllocatePicture( p_filter, p_picture,
                              p_filter->fmt_out.video.i_chroma,
                              p_filter->fmt_out.video.i_width,
                              p_filter->fmt_out.video.i_height,
                              p_filter->fmt_out.video.i_aspect )
        != VLC_SUCCESS )
    {
        free( p_picture );
        return NULL;
    }

    p_picture->pf_release = RegionPictureRelease;

    return p_picture;
}

static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
{
    if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
    if( p_pic ) free( p_pic );
}