vout_subpictures.c 36.1 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
zorglub's avatar
zorglub 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

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

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

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

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

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

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

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

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

90 91
    vlc_object_attach( p_spu, p_this );

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

105
    /* If the user requested an SPU margin, we force the position. */
106 107 108 109 110 111 112
    var_Create( p_spu, "spumargin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_spu, "spumargin", &val );
    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;
113
    while( psz_filter && *psz_filter )
114
    {
115 116 117 118 119
        char *psz_parser = strchr( psz_filter, ',' );
        if( !psz_parser ) psz_parser = strchr( psz_filter, ':' );

        if( psz_parser ) *psz_parser++ = 0;

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

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

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

152
    return VLC_EGENERIC;
153 154 155
}

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

164 165
    vlc_object_detach( p_spu );

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

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

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

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

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

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

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

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

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

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

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

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

281 282
    p_region->picture.pf_release = RegionPictureRelease;

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

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

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

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

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

346
    /* Get lock */
347
    vlc_mutex_lock( &p_spu->subpicture_lock );
348

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

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

372
    /* Copy subpicture information, set some default values */
373 374 375 376 377 378
    memset( p_subpic, 0, sizeof(subpicture_t) );
    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;
379

380
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
381

382 383 384
    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;

385
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
386 387
}

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

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

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

416 417 418 419
    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
420
        spu_DestroyRegion( p_spu, p_region );
421 422
    }

423 424 425 426 427 428
    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

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

430
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
431 432 433
}

/*****************************************************************************
434
 * spu_RenderSubpictures: render a subpicture list
Sam Hocevar's avatar
 
Sam Hocevar committed
435
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
436
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
437
 *****************************************************************************/
438 439 440 441
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
442
{
gbazin's avatar
 
gbazin committed
443
    /* Get lock */
444
    vlc_mutex_lock( &p_spu->subpicture_lock );
gbazin's avatar
 
gbazin committed
445 446 447

    /* 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
448
    {
449 450
        subpicture_region_t *p_region = p_subpic->p_region;

451
        /* Load the blending module */
452
        if( !p_spu->p_blend && p_region )
453
        {
454 455 456 457 458 459 460 461 462 463 464
            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 );
465
        }
466

467
        /* Load the text rendering module */
468
        if( !p_spu->p_text && p_region )
469
        {
470 471 472 473 474 475 476 477 478 479
            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;

480 481
            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504

            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 );
505 506
        }

507 508
        if( p_subpic->pf_render )
        {
509 510 511 512 513 514 515
            /* 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 );
            }
516
        }
517 518
        else while( p_region && p_spu->p_blend &&
                    p_spu->p_blend->pf_video_blend )
519 520 521 522
        {
            int i_x_offset = p_region->i_x + p_subpic->i_x;
            int i_y_offset = p_region->i_y + p_subpic->i_y;

523 524
            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
525 526
                if( p_spu->p_text && p_spu->p_text->p_module &&
                    p_spu->p_text->pf_render_string )
527 528 529
                {
                    /* TODO: do it in a less hacky way
                     * (modify text renderer API) */
530
                    subpicture_t *p_subpic_tmp;
531 532
                    subpicture_region_t tmp_region;
                    block_t *p_new_block =
533
                        block_New( p_spu, strlen(p_region->psz_text) + 1 );
534 535 536 537 538 539 540 541 542

                    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;
543 544
                        p_subpic_tmp = p_spu->p_text->pf_render_string(
                            p_spu->p_text, p_new_block );
545

546
                        if( p_subpic_tmp )
547 548
                        {
                            tmp_region = *p_region;
549
                            *p_region = *p_subpic_tmp->p_region;
550
                            p_region->p_next = tmp_region.p_next;
551
                            *p_subpic_tmp->p_region = tmp_region;
552
                            p_spu->p_text->pf_sub_buffer_del( p_spu->p_text,
553
                                                              p_subpic_tmp );
554 555 556 557 558
                        }
                    }
                }
            }

559 560
            if( p_subpic->i_flags & OSD_ALIGN_BOTTOM )
            {
561
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
562
                    p_subpic->i_y;
563 564 565
            }
            else if ( !(p_subpic->i_flags & OSD_ALIGN_TOP) )
            {
566
                i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
567 568 569 570
            }

            if( p_subpic->i_flags & OSD_ALIGN_RIGHT )
            {
571
                i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
572
                    p_subpic->i_x;
573 574 575
            }
            else if ( !(p_subpic->i_flags & OSD_ALIGN_LEFT) )
            {
576
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
577 578 579 580 581 582 583
            }

            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;

584 585 586 587 588 589 590 591 592 593
                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;
                    }
                }
            }
594 595

            /* Force cropping if requested */
596
            if( p_spu->b_force_crop )
597
            {
598
                video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
599 600

                /* Find the intersection */
601
                if( p_spu->i_crop_x + p_spu->i_crop_width <= i_x_offset ||
602
                    i_x_offset + (int)p_fmt->i_visible_width <
603 604
                        p_spu->i_crop_x ||
                    p_spu->i_crop_y + p_spu->i_crop_height <= i_y_offset ||
605
                    i_y_offset + (int)p_fmt->i_visible_height <
606
                        p_spu->i_crop_y )
607 608 609 610 611 612 613
                {
                    /* 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;
614 615 616
                    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,
617
                                   i_x_offset + (int)p_fmt->i_visible_width );
618
                    i_y_end = __MIN( p_spu->i_crop_y + p_spu->i_crop_height,
619 620 621 622 623 624 625 626 627 628
                                   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;
                }
629 630 631
            }

            /* Force palette if requested */
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
            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 )
647
            {
648 649 650 651 652 653 654 655 656
                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;
                }
657
            }
658 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 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
            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;
710

711
            /* Update the output picture size */
712 713 714 715 716 717 718 719
            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,
720
                p_pic_src, &p_region->picture, i_x_offset, i_y_offset );
721 722 723 724

            p_region = p_region->p_next;
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
725 726
        p_subpic = p_subpic->p_next;
    }
gbazin's avatar
 
gbazin committed
727

728
    vlc_mutex_unlock( &p_spu->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
729 730 731
}

/*****************************************************************************
732
 * spu_SortSubpictures: find the subpictures to display
Sam Hocevar's avatar
 
Sam Hocevar committed
733 734 735 736 737 738 739 740 741
 *****************************************************************************
 * 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.
 *****************************************************************************/
742
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
Sam Hocevar's avatar
 
Sam Hocevar committed
743
{
gbazin's avatar
gbazin committed
744 745 746 747
    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
748

749 750 751 752 753 754 755 756 757 758 759 760
    /* 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
761 762
    /* 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
763
    for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
764
    {
gbazin's avatar
gbazin committed
765 766 767 768
        p_ephemer = 0;
        ephemer_date = 0;

        for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
769
        {
gbazin's avatar
gbazin committed
770 771
            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
772
            {
gbazin's avatar
gbazin committed
773 774
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
775

gbazin's avatar
gbazin committed
776 777 778 779 780 781
            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
782

gbazin's avatar
gbazin committed
783 784
            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
785

gbazin's avatar
gbazin committed
786 787 788 789 790 791 792 793 794
            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
795

gbazin's avatar
gbazin committed
796 797 798 799 800
            /* 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
801

gbazin's avatar
gbazin committed
802 803
                continue;
            }
Sam Hocevar's avatar
 
Sam Hocevar committed
804

gbazin's avatar
gbazin committed
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
            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
820 821 822
            }
            else
            {
gbazin's avatar
gbazin committed
823 824 825
                /* Ephemer subpicture can still live a bit */
                p_tmp->p_next = p_subpic;
                p_subpic = p_tmp;
Sam Hocevar's avatar
 
Sam Hocevar committed
826 827 828 829 830 831 832
            }
        }
    }

    return p_subpic;
}

833
/*****************************************************************************
834
 * SpuClearChannel: clear an spu channel
835
 *****************************************************************************
836
 * This function destroys the subpictures which belong to the spu channel
837 838
 * corresponding to i_channel_id.
 *****************************************************************************/
839
static void SpuClearChannel( spu_t *p_spu, int i_channel )
840
{
gbazin's avatar
gbazin committed
841 842
    int          i_subpic;                               /* subpicture index */
    subpicture_t *p_subpic = NULL;                  /* first free subpicture */
843

844
    vlc_mutex_lock( &p_spu->subpicture_lock );
845 846 847

    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
848
        p_subpic = &p_spu->p_subpicture[i_subpic];
849 850 851 852 853 854
        if( p_subpic->i_status == FREE_SUBPICTURE
            || ( p_subpic->i_status != RESERVED_SUBPICTURE
                 && p_subpic->i_status != READY_SUBPICTURE ) )
        {
            continue;
        }
855

856 857
        if( p_subpic->i_channel == i_channel )
        {
858 859 860 861
            while( p_subpic->p_region )
            {
                subpicture_region_t *p_region = p_subpic->p_region;
                p_subpic->p_region = p_region->p_next;
862
                spu_DestroyRegion( p_spu, p_region );
863 864
            }

865
            if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
866 867 868 869
            p_subpic->i_status = FREE_SUBPICTURE;
        }
    }

870
    vlc_mutex_unlock( &p_spu->subpicture_lock );
871
}
872

873 874 875
/*****************************************************************************
 * spu_ControlDefault: default methods for the subpicture unit control.
 *****************************************************************************/
gbazin's avatar
gbazin committed
876
static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
877 878 879 880 881 882 883
{
    int *pi, i;

    switch( i_query )
    {
    case SPU_CHANNEL_REGISTER:
        pi = (int *)va_arg( args, int * );
gbazin's avatar
gbazin committed
884
        if( pi ) *pi = p_spu->i_channel++;
885
        msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
gbazin's avatar
gbazin committed
886
                 p_spu->i_channel - 1 );
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
        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
 *****************************************************************************/

906 907 908 909 910 911
/*****************************************************************************
 * UpdateSPU: update subpicture settings
 *****************************************************************************
 * This function is called from CropCallback and at initialization time, to
 * retrieve crop information from the input.
 *****************************************************************************/
912
static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
913 914 915
{
    vlc_value_t val;

916 917
    p_spu->b_force_alpha = VLC_FALSE;
    p_spu->b_force_crop = VLC_FALSE;
918 919 920

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

921
    p_spu->b_force_crop = VLC_TRUE;
922
    var_Get( p_object, "x-start", &val );
923
    p_spu->i_crop_x = val.i_int;
924
    var_Get( p_object, "y-start", &val );
925
    p_spu->i_crop_y = val.i_int;
926
    var_Get( p_object, "x-end", &val );
927
    p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
928
    var_Get( p_object, "y-end", &val );
929
    p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
930 931 932 933 934 935 936

#if 0
    if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
    {
        int i;
        for( i = 0; i < 4; i++ )
        {
937
            p_spu->pi_color[i] = ((uint8_t *)val.p_address)[i];
938 939 940 941 942 943 944 945 946
        }
    }
#endif

    if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
    {
        int i;
        for( i = 0; i < 4; i++ )
        {
947 948 949
            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;
950
        }
951
        p_spu->b_force_alpha = VLC_TRUE;
952 953
    }

954 955 956
    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 );
957 958 959 960 961 962