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

/*****************************************************************************
 * Preamble
 *****************************************************************************/
29 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
34 35 36 37
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
#include <vlc_osd.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
38
#include "../libvlc.h"
39

40
#include <assert.h>
41
#include <limits.h>
42

43 44 45
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
46 47 48 49 50
#define VLC_FOURCC_YUVP VLC_FOURCC('Y','U','V','P')
#define VLC_FOURCC_YUVA VLC_FOURCC('Y','U','V','A')
#define VLC_FOURCC_RGBA VLC_FOURCC('R','G','B','A')
#define VLC_FOURCC_TEXT VLC_FOURCC('T','E','X','T')

Laurent Aimar's avatar
Laurent Aimar committed
51 52 53 54 55 56
/* TODO export */
static subpicture_t *subpicture_New( void );
static void subpicture_Delete( subpicture_t *p_subpic );
static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );

/* */
57 58 59 60 61 62 63 64 65 66 67 68
typedef struct
{
    subpicture_t *p_subpicture;
    bool          b_reject;
} spu_heap_entry_t;

typedef struct
{
    spu_heap_entry_t p_entry[VOUT_MAX_SUBPICTURES];

} spu_heap_t;

Laurent Aimar's avatar
Laurent Aimar committed
69 70 71 72 73 74
static void SpuHeapInit( spu_heap_t * );
static int  SpuHeapPush( spu_heap_t *, subpicture_t * );
static void SpuHeapDeleteAt( spu_heap_t *, int i_index );
static int  SpuHeapDeleteSubpicture( spu_heap_t *, subpicture_t * );
static void SpuHeapClean( spu_heap_t *p_heap );

75 76
struct spu_private_t
{
77 78 79 80
    vlc_mutex_t lock;   /* lock to protect all followings fields */

    spu_heap_t heap;

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
    int i_channel;             /**< number of subpicture channels registered */
    filter_t *p_blend;                            /**< alpha blending module */
    filter_t *p_text;                              /**< text renderer module */
    filter_t *p_scale_yuvp;                     /**< scaling module for YUVP */
    filter_t *p_scale;                    /**< scaling module (all but YUVP) */
    bool b_force_crop;                     /**< force cropping of subpicture */
    int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */

    int i_margin;                        /**< force position of a subpicture */
    bool b_force_palette;             /**< force palette of subpicture */
    uint8_t palette[4][4];                               /**< forced palette */

    /* Supciture filters */
    filter_chain_t *p_chain;
};

97 98 99 100 101 102
/* */
struct subpicture_region_private_t
{
    video_format_t fmt;
    picture_t      *p_picture;
};
Laurent Aimar's avatar
Laurent Aimar committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t * );
static void SpuRegionPrivateDelete( subpicture_region_private_t * );

/* */
typedef struct
{
    int w;
    int h;
} spu_scale_t;
static spu_scale_t spu_scale_create( int w, int h );
static spu_scale_t spu_scale_unit(void );
static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd );
static int spu_scale_w( int v, const spu_scale_t s );
static int spu_scale_h( int v, const spu_scale_t s );
static int spu_invscale_w( int v, const spu_scale_t s );
static int spu_invscale_h( int v, const spu_scale_t s );

typedef struct
{
    int i_x;
    int i_y;
    int i_width;
    int i_height;

    spu_scale_t scale;
} spu_area_t;

static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t );
static spu_area_t spu_area_scaled( spu_area_t );
static spu_area_t spu_area_unscaled( spu_area_t, spu_scale_t );
static bool spu_area_overlap( spu_area_t, spu_area_t );

135

136 137 138
/* Subpicture rendered flag
 * FIXME ? it could be moved to private ? */
#define SUBPICTURE_RENDERED  (0x1000)
Laurent Aimar's avatar
Laurent Aimar committed
139
#if SUBPICTURE_RENDERED < SUBPICTURE_ALIGN_MASK
140 141 142
#   error SUBPICTURE_RENDERED too low
#endif

Laurent Aimar's avatar
Laurent Aimar committed
143 144 145 146 147 148 149 150 151 152
#define SCALE_UNIT (1000)

static int SubpictureCmp( const void *s0, const void *s1 );

static void SpuRenderRegion( spu_t *,
                             picture_t *p_pic_dst, spu_area_t *,
                             subpicture_t *, subpicture_region_t *,
                             const spu_scale_t scale_size,
                             const video_format_t *p_fmt,
                             const spu_area_t *p_subtitle_area, int i_subtitle_area );
153

154 155 156
static void UpdateSPU   ( spu_t *, vlc_object_t * );
static int  CropCallback( vlc_object_t *, char const *,
                          vlc_value_t, vlc_value_t, void * );
157

158
static int SpuControl( spu_t *, int, va_list );
159

160 161 162
static void SpuClearChannel( spu_t *p_spu, int i_channel, bool b_locked );

/* Buffer allocation for SPU filter (blend, scale, ...) */
163 164
static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
165 166
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
167

168
static int spu_ParseChain( spu_t * );
169 170

/* Buffer aloccation fir SUB filter */
171 172 173
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

174 175
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
176

177
/* */
Laurent Aimar's avatar
Laurent Aimar committed
178 179 180
static void SpuRenderCreateAndLoadText( spu_t * );
static void SpuRenderCreateAndLoadScale( spu_t * );
static void SpuRenderCreateBlend( spu_t *, vlc_fourcc_t i_chroma, int i_aspect );
181
static void FilterRelease( filter_t *p_filter );
182

Laurent Aimar's avatar
Laurent Aimar committed
183 184 185
/*****************************************************************************
 * Public API
 *****************************************************************************/
186
/**
187
 * Creates the subpicture unit
188
 *
189
 * \param p_this the parent object which creates the subpicture unit
190
 */
191
spu_t *__spu_Create( vlc_object_t *p_this )
192
{
193 194 195 196 197 198 199 200 201 202 203 204 205 206
    spu_t *p_spu;
    spu_private_t *p_sys;
    
    p_spu = vlc_custom_create( p_this, sizeof(spu_t) + sizeof(spu_private_t),
                               VLC_OBJECT_GENERIC, "subpicture" );

    if( !p_spu )
        return NULL;

    /* Initialize spu fields */
    p_spu->pf_control = SpuControl;
    p_spu->p = p_sys = (spu_private_t*)&p_spu[1];

    /* Initialize private fields */
207 208 209 210
    vlc_mutex_init( &p_sys->lock );

    SpuHeapInit( &p_sys->heap );

211 212 213 214
    p_sys->p_blend = NULL;
    p_sys->p_text = NULL;
    p_sys->p_scale = NULL;
    p_sys->p_scale_yuvp = NULL;
215 216

    /* Register the default subpicture channel */
217
    p_sys->i_channel = 2;
218 219 220

    vlc_object_attach( p_spu, p_this );

221
    p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
222 223
                                       SubFilterAllocationInit,
                                       SubFilterAllocationClean,
224
                                       p_spu );
225 226 227 228 229

    /* Load text and scale module */
    SpuRenderCreateAndLoadText( p_spu );
    SpuRenderCreateAndLoadScale( p_spu );

230 231 232 233 234 235 236 237 238 239
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
240
    spu_private_t *p_sys = p_spu->p;
241

242
    /* If the user requested a sub margin, we force the position. */
243
    p_sys->i_margin = var_CreateGetInteger( p_spu, "sub-margin" );
244 245

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
246 247 248 249
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

250
    return VLC_SUCCESS;
251
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
252

253 254
int spu_ParseChain( spu_t *p_spu )
{
255
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
256 257 258
    int i_ret;

    if( !psz_parser )
259
        return VLC_EGENERIC;
260 261

    i_ret = filter_chain_AppendFromString( p_spu->p->p_chain, psz_parser );
262

263
    free( psz_parser );
264 265

    return i_ret;
266 267 268
}

/**
269
 * Destroy the subpicture unit
270
 *
271
 * \param p_this the parent object which destroys the subpicture unit
272
 */
273
void spu_Destroy( spu_t *p_spu )
274
{
275
    spu_private_t *p_sys = p_spu->p;
276

277 278 279 280 281
    if( p_sys->p_blend )
        FilterRelease( p_sys->p_blend );

    if( p_sys->p_text )
        FilterRelease( p_sys->p_text );
282

283 284
    if( p_sys->p_scale_yuvp )
        FilterRelease( p_sys->p_scale_yuvp );
285

286 287
    if( p_sys->p_scale )
        FilterRelease( p_sys->p_scale );
288

289
    filter_chain_Delete( p_sys->p_chain );
290

291 292 293 294
    /* Destroy all remaining subpictures */
    SpuHeapClean( &p_sys->heap );

    vlc_mutex_destroy( &p_sys->lock );
295

296
    vlc_object_release( p_spu );
297 298
}

299 300 301
/**
 * Attach/Detach the SPU from any input
 *
302
 * \param p_this the object in which to destroy the subpicture unit
303 304
 * \param b_attach to select attach or detach
 */
305
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
306 307 308
{
    vlc_object_t *p_input;

309
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
310 311 312
    if( !p_input ) return;

    if( b_attach )
313
    {
314 315
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
316 317 318 319 320
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
321
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
322 323 324 325
        vlc_object_release( p_input );
    }
}

326
/**
327
 * Display a subpicture
328
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
329 330
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
331
 * \param p_spu the subpicture unit object
332 333
 * \param p_subpic the subpicture to display
 */
334
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
335
{
336
    spu_private_t *p_sys = p_spu->p;
Sam Hocevar's avatar
 
Sam Hocevar committed
337

338
    /* DEFAULT_CHAN always reset itself */
339
    if( p_subpic->i_channel == DEFAULT_CHAN )
340 341 342 343 344 345 346 347 348
        SpuClearChannel( p_spu, DEFAULT_CHAN, false );

    /* p_private is for spu only and cannot be non NULL here */
    for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
        assert( r->p_private == NULL );

    /* */
    vlc_mutex_lock( &p_sys->lock );
    if( SpuHeapPush( &p_sys->heap, p_subpic ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
349
    {
350 351 352 353
        vlc_mutex_unlock( &p_sys->lock );
        msg_Err( p_spu, "subpicture heap full" );
        subpicture_Delete( p_subpic );
        return;
Sam Hocevar's avatar
 
Sam Hocevar committed
354
    }
355
    vlc_mutex_unlock( &p_sys->lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
356 357
}

358
/**
359
 * Allocate a subpicture in the spu heap.
360
 *
361
 * This function create a reserved subpicture in the spu heap.
Sam Hocevar's avatar
 
Sam Hocevar committed
362 363 364
 * 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.
365
 * \param p_spu the subpicture unit in which to create the subpicture
366 367
 * \return NULL on error, a reserved subpicture otherwise
 */
368
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
Sam Hocevar's avatar
 
Sam Hocevar committed
369
{
370
    VLC_UNUSED(p_spu);
Sam Hocevar's avatar
 
Sam Hocevar committed
371

372
    return subpicture_New();
Sam Hocevar's avatar
 
Sam Hocevar committed
373 374
}

375 376 377
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
378 379 380
 * 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
381
 * by the spu.
382
 */
383
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
384
{
385
    VLC_UNUSED(p_spu);
386

387
    subpicture_Delete( p_subpic );
Sam Hocevar's avatar
 
Sam Hocevar committed
388 389
}

Laurent Aimar's avatar
Laurent Aimar committed
390 391 392 393 394 395 396
/**
 * This function renders all sub picture units in the list.
 */
void spu_RenderSubpictures( spu_t *p_spu,
                            picture_t *p_pic_dst, const video_format_t *p_fmt_dst,
                            subpicture_t *p_subpic_list,
                            const video_format_t *p_fmt_src )
397
{
Laurent Aimar's avatar
Laurent Aimar committed
398
    spu_private_t *p_sys = p_spu->p;
399

Laurent Aimar's avatar
Laurent Aimar committed
400 401 402
    const int i_source_video_width  = p_fmt_src->i_width;
    const int i_source_video_height = p_fmt_src->i_height;
    const mtime_t i_current_date = mdate();
403

Laurent Aimar's avatar
Laurent Aimar committed
404 405
    unsigned int i_subpicture;
    subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
406

Laurent Aimar's avatar
Laurent Aimar committed
407 408 409 410
    unsigned int i_subtitle_region_count;
    spu_area_t p_subtitle_area_buffer[VOUT_MAX_SUBPICTURES];
    spu_area_t *p_subtitle_area;
    int i_subtitle_area;
411

Laurent Aimar's avatar
Laurent Aimar committed
412
    vlc_mutex_lock( &p_sys->lock );
413

Laurent Aimar's avatar
Laurent Aimar committed
414 415 416 417 418 419 420 421 422 423
    /* Preprocess subpictures */
    i_subpicture = 0;
    i_subtitle_region_count = 0;
    for( subpicture_t * p_subpic = p_subpic_list;
            p_subpic != NULL;
                p_subpic = p_subpic->p_next )
    {
        /* */
        if( p_subpic->pf_pre_render )
            p_subpic->pf_pre_render( p_spu, p_subpic, p_fmt_dst );
424

Laurent Aimar's avatar
Laurent Aimar committed
425 426 427 428 429 430 431
        if( p_subpic->pf_update_regions )
        {
            video_format_t fmt_org = *p_fmt_dst;
            fmt_org.i_width =
            fmt_org.i_visible_width = i_source_video_width;
            fmt_org.i_height =
            fmt_org.i_visible_height = i_source_video_height;
432

Laurent Aimar's avatar
Laurent Aimar committed
433 434
            p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org, i_current_date );
        }
435

Laurent Aimar's avatar
Laurent Aimar committed
436 437 438 439 440 441
        /* */
        if( p_subpic->b_subtitle )
        {
            for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
                i_subtitle_region_count++;
        }
442

Laurent Aimar's avatar
Laurent Aimar committed
443 444 445
        /* */
        pp_subpicture[i_subpicture++] = p_subpic;
    }
446

Laurent Aimar's avatar
Laurent Aimar committed
447 448
    /* Be sure we have at least 1 picture to process */
    if( i_subpicture <= 0 )
449
    {
Laurent Aimar's avatar
Laurent Aimar committed
450 451
        vlc_mutex_unlock( &p_sys->lock );
        return;
452 453
    }

Laurent Aimar's avatar
Laurent Aimar committed
454 455 456
    /* Now order subpicture array
     * XXX The order is *really* important for overlap subtitles positionning */
    qsort( pp_subpicture, i_subpicture, sizeof(*pp_subpicture), SubpictureCmp );
Laurent Aimar's avatar
Laurent Aimar committed
457

Laurent Aimar's avatar
Laurent Aimar committed
458 459 460 461 462
    /* Allocate area array for subtitle overlap */
    i_subtitle_area = 0;
    p_subtitle_area = p_subtitle_area_buffer;
    if( i_subtitle_region_count > sizeof(p_subtitle_area_buffer)/sizeof(*p_subtitle_area_buffer) )
        p_subtitle_area = calloc( i_subtitle_region_count, sizeof(*p_subtitle_area) );
463

Laurent Aimar's avatar
Laurent Aimar committed
464 465 466
    /* Create the blending module */
    if( !p_sys->p_blend )
        SpuRenderCreateBlend( p_spu, p_fmt_dst->i_chroma, p_fmt_dst->i_aspect );
467

Laurent Aimar's avatar
Laurent Aimar committed
468 469 470 471 472
    /* Process all subpictures and regions (in the right order) */
    for( unsigned int i_index = 0; i_index < i_subpicture; i_index++ )
    {
        subpicture_t *p_subpic = pp_subpicture[i_index];
        subpicture_region_t *p_region;
473

Laurent Aimar's avatar
Laurent Aimar committed
474 475
        if( !p_subpic->p_region )
            continue;
476

Laurent Aimar's avatar
Laurent Aimar committed
477 478 479 480 481 482 483 484 485
        /* FIXME when possible use a better rendering size than source size
         * (max of display size and source size for example) FIXME */
        int i_render_width  = p_subpic->i_original_picture_width;
        int i_render_height = p_subpic->i_original_picture_height;
        if( !i_render_width || !i_render_height )
        {
            if( i_render_width != 0 || i_render_height != 0 )
                msg_Err( p_spu, "unsupported original picture size %dx%d",
                         i_render_width, i_render_height );
486

Laurent Aimar's avatar
Laurent Aimar committed
487 488 489
            p_subpic->i_original_picture_width  = i_render_width = i_source_video_width;
            p_subpic->i_original_picture_height = i_render_height = i_source_video_height;
        }
490

Laurent Aimar's avatar
Laurent Aimar committed
491 492 493 494
        if( p_sys->p_text )
        {
            p_sys->p_text->fmt_out.video.i_width          =
            p_sys->p_text->fmt_out.video.i_visible_width  = i_render_width;
495

Laurent Aimar's avatar
Laurent Aimar committed
496 497 498
            p_sys->p_text->fmt_out.video.i_height         =
            p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
        }
499

Laurent Aimar's avatar
Laurent Aimar committed
500 501 502
        /* Compute scaling from picture to source size */
        spu_scale_t scale = spu_scale_createq( i_source_video_width,  i_render_width,
                                               i_source_video_height, i_render_height );
503

Laurent Aimar's avatar
Laurent Aimar committed
504 505 506
        /* Update scaling from source size to display size(p_fmt_dst) */
        scale.w = scale.w * p_fmt_dst->i_width  / i_source_video_width;
        scale.h = scale.h * p_fmt_dst->i_height / i_source_video_height;
507

Laurent Aimar's avatar
Laurent Aimar committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
        /* Set default subpicture aspect ratio
         * FIXME if we only handle 1 aspect ratio per picture, why is it set per
         * region ? */
        p_region = p_subpic->p_region;
        if( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den )
        {
            if( p_region->fmt.i_aspect != 0 )
            {
                p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
                p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
            }
            else
            {
                p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
                p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
            }
        }
525

Laurent Aimar's avatar
Laurent Aimar committed
526 527 528 529 530 531 532 533 534
        /* Take care of the aspect ratio */
        if( p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den !=
            p_region->fmt.i_sar_den * p_fmt_dst->i_sar_num )
        {
            /* FIXME FIXME what about region->i_x/i_y ? */
            scale.w = scale.w *
                (int64_t)p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den /
                p_region->fmt.i_sar_den / p_fmt_dst->i_sar_num;
        }
535

Laurent Aimar's avatar
Laurent Aimar committed
536 537 538 539 540 541 542
        /* Render all regions
         * We always transform non absolute subtitle into absolute one on the
         * first rendering to allow good subtitle overlap support.
         */
        for( p_region = p_subpic->p_region; p_region != NULL; p_region = p_region->p_next )
        {
            spu_area_t area;
543

Laurent Aimar's avatar
Laurent Aimar committed
544 545 546
            /* Check scale validity */
            if( scale.w <= 0 || scale.h <= 0 )
                continue;
547

Laurent Aimar's avatar
Laurent Aimar committed
548 549 550 551
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
                             p_subtitle_area, i_subtitle_area );
552

Laurent Aimar's avatar
Laurent Aimar committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
            if( p_subpic->b_subtitle )
            {
                area = spu_area_unscaled( area, scale );
                if( !p_subpic->b_absolute && area.i_width > 0 && area.i_height > 0 )
                {
                    p_region->i_x = area.i_x;
                    p_region->i_y = area.i_y;
                }
                if( p_subtitle_area )
                    p_subtitle_area[i_subtitle_area++] = area;
            }
        }
        if( p_subpic->b_subtitle )
            p_subpic->b_absolute = true;
    }
568

Laurent Aimar's avatar
Laurent Aimar committed
569 570 571
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
572

Laurent Aimar's avatar
Laurent Aimar committed
573
    vlc_mutex_unlock( &p_sys->lock );
574 575
}

Laurent Aimar's avatar
Laurent Aimar committed
576 577 578 579 580 581 582 583 584 585 586 587
/*****************************************************************************
 * spu_SortSubpictures: find the subpictures to display
 *****************************************************************************
 * This function parses all subpictures and decides which ones need to be
 * displayed. 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.
 *****************************************************************************/
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
                                   bool b_paused, bool b_subtitle_only )
Laurent Aimar's avatar
Laurent Aimar committed
588
{
Laurent Aimar's avatar
Laurent Aimar committed
589 590 591
    spu_private_t *p_sys = p_spu->p;
    int i_channel;
    subpicture_t *p_subpic = NULL;
592

Laurent Aimar's avatar
Laurent Aimar committed
593 594
    /* Run subpicture filters */
    filter_chain_SubFilter( p_sys->p_chain, display_date );
Laurent Aimar's avatar
Laurent Aimar committed
595

Laurent Aimar's avatar
Laurent Aimar committed
596
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
597

Laurent Aimar's avatar
Laurent Aimar committed
598 599 600
    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
    for( i_channel = 0; i_channel < p_sys->i_channel; i_channel++ )
Laurent Aimar's avatar
Laurent Aimar committed
601
    {
Laurent Aimar's avatar
Laurent Aimar committed
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 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
        subpicture_t *p_ephemer = NULL;
        mtime_t      ephemer_date = 0;
        int i_index;

        for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
        {
            spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
            subpicture_t *p_current = p_entry->p_subpicture;

            if( !p_current || p_entry->b_reject )
            {
                if( p_entry->b_reject )
                    SpuHeapDeleteAt( &p_sys->heap, i_index );
                continue;
            }

            if( p_current->i_channel != i_channel ||
                ( b_subtitle_only && !p_current->b_subtitle ) )
            {
                continue;
            }
            if( display_date &&
                display_date < p_current->i_start )
            {
                /* Too early, come back next monday */
                continue;
            }

            if( p_current->i_start > ephemer_date )
                ephemer_date = p_current->i_start;

            if( display_date > p_current->i_stop &&
                ( !p_current->b_ephemer || p_current->i_stop > p_current->i_start ) &&
                !( p_current->b_subtitle && b_paused ) ) /* XXX Assume that subtitle are pausable */
            {
                SpuHeapDeleteAt( &p_sys->heap, i_index );
            }
            else if( p_current->b_ephemer )
            {
                SubpictureChain( &p_ephemer, p_current );
            }
            else
            {
                SubpictureChain( &p_subpic, p_current );
            }
        }

        /* 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 )
            {
                SpuHeapDeleteSubpicture( &p_sys->heap, p_tmp );
            }
            else
            {
                SubpictureChain( &p_subpic, p_tmp );
            }
        }
Laurent Aimar's avatar
Laurent Aimar committed
665
    }
Laurent Aimar's avatar
Laurent Aimar committed
666
    vlc_mutex_unlock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
667

Laurent Aimar's avatar
Laurent Aimar committed
668
    return p_subpic;
Laurent Aimar's avatar
Laurent Aimar committed
669 670
}

Laurent Aimar's avatar
Laurent Aimar committed
671 672 673
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
674
/**
Laurent Aimar's avatar
Laurent Aimar committed
675
 * This function create a new empty subpicture.
676
 */
Laurent Aimar's avatar
Laurent Aimar committed
677
static subpicture_t *subpicture_New( void )
678
{
Laurent Aimar's avatar
Laurent Aimar committed
679 680 681
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
682

Laurent Aimar's avatar
Laurent Aimar committed
683 684 685 686 687 688 689 690 691 692 693
    p_subpic->i_order    = 0;
    p_subpic->b_absolute = true;
    p_subpic->b_fade     = false;
    p_subpic->b_subtitle = false;
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;

    return p_subpic;
694
}
Laurent Aimar's avatar
Laurent Aimar committed
695 696

static void subpicture_Delete( subpicture_t *p_subpic )
697
{
Laurent Aimar's avatar
Laurent Aimar committed
698 699 700 701 702 703 704 705
    subpicture_region_ChainDelete( p_subpic->p_region );
    p_subpic->p_region = NULL;

    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }
    free( p_subpic );
706
}
Laurent Aimar's avatar
Laurent Aimar committed
707 708

static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
709
{
Laurent Aimar's avatar
Laurent Aimar committed
710 711 712
    p_subpic->p_next = *pp_head;

    *pp_head = p_subpic;
713
}
Laurent Aimar's avatar
Laurent Aimar committed
714 715 716 717 718

/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
719
{
Laurent Aimar's avatar
Laurent Aimar committed
720 721 722
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
723

Laurent Aimar's avatar
Laurent Aimar committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737
    p_region->fmt = *p_fmt;
    p_region->fmt.p_palette = NULL;
    if( p_fmt->i_chroma == VLC_FOURCC_YUVP )
    {
        p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
        if( p_fmt->p_palette )
            *p_region->fmt.p_palette = *p_fmt->p_palette;
    }
    p_region->i_alpha = 0xff;
    p_region->p_next = NULL;
    p_region->p_private = NULL;
    p_region->psz_text = NULL;
    p_region->p_style = NULL;
    p_region->p_picture = NULL;
738

Laurent Aimar's avatar
Laurent Aimar committed
739 740
    if( p_fmt->i_chroma == VLC_FOURCC_TEXT )
        return p_region;
741

Laurent Aimar's avatar
Laurent Aimar committed
742 743 744 745 746 747 748 749
    p_region->p_picture = picture_New( p_fmt->i_chroma, p_fmt->i_width, p_fmt->i_height,
                                       p_fmt->i_aspect );
    if( !p_region->p_picture )
    {
        free( p_fmt->p_palette );
        free( p_region );
        return NULL;
    }
750

Laurent Aimar's avatar
Laurent Aimar committed
751
    return p_region;
752
}
Laurent Aimar's avatar
Laurent Aimar committed
753 754 755

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
756
{
Laurent Aimar's avatar
Laurent Aimar committed
757 758
    if( !p_region )
        return;
759

Laurent Aimar's avatar
Laurent Aimar committed
760 761
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
762

Laurent Aimar's avatar
Laurent Aimar committed
763 764
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
765

Laurent Aimar's avatar
Laurent Aimar committed
766 767 768 769 770 771
    free( p_region->fmt.p_palette );

    free( p_region->psz_text );
    free( p_region->psz_html );
    //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
    free( p_region );
772 773
}

Laurent Aimar's avatar
Laurent Aimar committed
774 775 776 777 778 779
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
780

Laurent Aimar's avatar
Laurent Aimar committed
781
        subpicture_region_Delete( p_head );
782

Laurent Aimar's avatar
Laurent Aimar committed
783 784
        p_head = p_next;
    }
785 786 787 788
}



Laurent Aimar's avatar
Laurent Aimar committed
789 790 791 792
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
793
{
Laurent Aimar's avatar
Laurent Aimar committed
794 795 796
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
797

Laurent Aimar's avatar
Laurent Aimar committed
798 799 800 801
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
802

Laurent Aimar's avatar
Laurent Aimar committed
803 804 805
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
806
    {
Laurent Aimar's avatar
Laurent Aimar committed
807
        spu_heap_entry_t *e = &p_heap->p_entry[i];
808

Laurent Aimar's avatar
Laurent Aimar committed
809 810
        if( e->p_subpicture )
            continue;
811

Laurent Aimar's avatar
Laurent Aimar committed
812 813 814 815 816 817
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
818

Laurent Aimar's avatar
Laurent Aimar committed
819 820 821
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
822

Laurent Aimar's avatar
Laurent Aimar committed
823 824
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
825

Laurent Aimar's avatar
Laurent Aimar committed
826 827
    e->p_subpicture = NULL;
}
828

Laurent Aimar's avatar
Laurent Aimar committed
829
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
830
{
Laurent Aimar's avatar
Laurent Aimar committed
831
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
832
    {
Laurent Aimar's avatar
Laurent Aimar committed
833
        spu_heap_entry_t *e = &p_heap->p_entry[i];
Laurent Aimar's avatar
Laurent Aimar committed
834

Laurent Aimar's avatar
Laurent Aimar committed
835 836 837 838 839
        if( e->p_subpicture != p_subpic )
            continue;

        SpuHeapDeleteAt( p_heap, i );
        return VLC_SUCCESS;
Laurent Aimar's avatar
Laurent Aimar committed
840
    }
Laurent Aimar's avatar
Laurent Aimar committed
841 842
    return VLC_EGENERIC;
}
Laurent Aimar's avatar
Laurent Aimar committed
843

Laurent Aimar's avatar
Laurent Aimar committed
844 845 846
static void SpuHeapClean( spu_heap_t *p_heap )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
847
    {
Laurent Aimar's avatar
Laurent Aimar committed
848 849 850
        spu_heap_entry_t *e = &p_heap->p_entry[i];
        if( e->p_subpicture )
            subpicture_Delete( e->p_subpicture );
Laurent Aimar's avatar
Laurent Aimar committed
851
    }
Laurent Aimar's avatar
Laurent Aimar committed
852
}
853

Laurent Aimar's avatar
Laurent Aimar committed
854 855 856
static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
{
    subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
857

Laurent Aimar's avatar
Laurent Aimar committed
858 859
    if( !p_private )
        return NULL;
860

Laurent Aimar's avatar
Laurent Aimar committed
861 862 863 864 865 866 867 868
    p_private->fmt = *p_fmt;
    if( p_fmt->p_palette )
    {
        p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
        if( p_private->fmt.p_palette )
            *p_private->fmt.p_palette = *p_fmt->p_palette;
    }
    p_private->p_picture = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
869

Laurent Aimar's avatar
Laurent Aimar committed
870 871 872 873 874 875 876 877
    return p_private;
}
static void SpuRegionPrivateDelete( subpicture_region_private_t *p_private )
{
    if( p_private->p_picture )
        picture_Release( p_private->p_picture );
    free( p_private->fmt.p_palette );
    free( p_private );
Laurent Aimar's avatar
Laurent Aimar committed
878 879
}

Laurent Aimar's avatar
Laurent Aimar committed
880
static void FilterRelease( filter_t *p_filter )
881
{
Laurent Aimar's avatar
Laurent Aimar committed
882 883
    if( p_filter->p_module )
        module_unneed( p_filter, p_filter->p_module );
884

Laurent Aimar's avatar
Laurent Aimar committed
885 886
    vlc_object_detach( p_filter );
    vlc_object_release( p_filter );
887 888
}

Laurent Aimar's avatar
Laurent Aimar committed
889
static void SpuRenderCreateBlend( spu_t *p_spu, vlc_fourcc_t i_chroma, int i_aspect )
Laurent Aimar's avatar
Laurent Aimar committed
890
{
Laurent Aimar's avatar
Laurent Aimar committed
891
    filter_t *p_blend;
892

Laurent Aimar's avatar
Laurent Aimar committed
893
    assert( !p_spu->p->p_blend );
Laurent Aimar's avatar
Laurent Aimar committed
894

Laurent Aimar's avatar
Laurent Aimar committed
895 896 897 898 899
    p_spu->p->p_blend =
    p_blend        = vlc_custom_create( p_spu, sizeof(filter_t),
                                        VLC_OBJECT_GENERIC, "blend" );
    if( !p_blend )
        return;
900

Laurent Aimar's avatar
Laurent Aimar committed
901
    es_format_Init( &p_blend->fmt_in, VIDEO_ES, 0 );
902

Laurent Aimar's avatar
Laurent Aimar committed
903 904 905 906 907
    es_format_Init( &p_blend->fmt_out, VIDEO_ES, 0 );
    p_blend->fmt_out.video.i_x_offset = 0;
    p_blend->fmt_out.video.i_y_offset = 0;
    p_blend->fmt_out.video.i_chroma = i_chroma;
    p_blend->fmt_out.video.i_aspect = i_aspect;
Laurent Aimar's avatar
Laurent Aimar committed
908

Laurent Aimar's avatar
Laurent Aimar committed
909 910 911
    /* The blend module will be loaded when needed with the real
    * input format */
    p_blend->p_module = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
912

Laurent Aimar's avatar
Laurent Aimar committed
913 914 915 916 917 918 919
    /* */
    vlc_object_attach( p_blend, p_spu );
}
static void SpuRenderUpdateBlend( spu_t *p_spu, int i_out_width, int i_out_height,
                                  const video_format_t *p_in_fmt )
{
    filter_t *p_blend = p_spu->p->p_blend;
920

Laurent Aimar's avatar
Laurent Aimar committed
921
    assert( p_blend );
922

Laurent Aimar's avatar
Laurent Aimar committed
923 924
    /* */
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
925
    {
Laurent Aimar's avatar
Laurent Aimar committed
926 927 928 929
        /* The chroma is not the same, we need to reload the blend module
         * XXX to match the old behaviour just test !p_blend->fmt_in.video.i_chroma */
        module_unneed( p_blend, p_blend->p_module );
        p_blend->p_module = NULL;
930
    }
931

932
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
933
    p_blend->fmt_in.video = *p_in_fmt;
934

Laurent Aimar's avatar
Laurent Aimar committed
935 936 937 938 939
    /* */
    p_blend->fmt_out.video.i_width =
    p_blend->fmt_out.video.i_visible_width = i_out_width;
    p_blend->fmt_out.video.i_height =
    p_blend->fmt_out.video.i_visible_height = i_out_height;
Laurent Aimar's avatar
Laurent Aimar committed
940

941
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
942 943 944 945 946 947
    if( !p_blend->p_module )
        p_blend->p_module = module_need( p_blend, "video blending", 0, 0 );
}
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
{
    filter_t *p_text;
948

Laurent Aimar's avatar
Laurent Aimar committed
949
    assert( !p_spu->p->p_text );
950

Laurent Aimar's avatar
Laurent Aimar committed
951 952 953 954 955
    p_spu->p->p_text =
    p_text        = vlc_custom_create( p_spu, sizeof(filter_t),
                                       VLC_OBJECT_GENERIC, "spu text" );
    if( !p_text )
        return;
Laurent Aimar's avatar
Laurent Aimar committed
956

Laurent Aimar's avatar
Laurent Aimar committed
957
    es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );
958

Laurent Aimar's avatar
Laurent Aimar committed
959 960 961 962 963
    es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
    p_text->fmt_out.video.i_width =
    p_text->fmt_out.video.i_visible_width = 32;
    p_text->fmt_out.video.i_height =
    p_text->fmt_out.video.i_visible_height = 32;
964

Laurent Aimar's avatar
Laurent Aimar committed
965 966
    p_text->pf_sub_buffer_new = spu_new_buffer;
    p_text->pf_sub_buffer_del = spu_del_buffer;
967

Laurent Aimar's avatar
Laurent Aimar committed
968
    vlc_object_attach( p_text, p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
969

Laurent Aimar's avatar
Laurent Aimar committed
970 971 972 973 974 975 976 977 978
    /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
     * same than these 2 calls ? */
    char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
    if( psz_modulename && *psz_modulename )
    {
        p_text->p_module = module_need( p_text, "text renderer",
                                        psz_modulename, true );
    }
    free( psz_modulename );
979

Laurent Aimar's avatar
Laurent Aimar committed
980 981
    if( !p_text->p_module )
        p_text->p_module = module_need( p_text, "text renderer", NULL, false );
982

Laurent Aimar's avatar
Laurent Aimar committed
983 984 985 986 987 988
    /* Create a few variables used for enhanced text rendering */
    var_Create( p_text, "spu-duration", VLC_VAR_TIME );
    var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
    var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
    var_Create( p_text, "scale", VLC_VAR_INTEGER );
}
989

Laurent Aimar's avatar
Laurent Aimar committed
990 991 992 993 994
static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
                                     vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
                                     bool b_resize )
{
    filter_t *p_scale;
995

Laurent Aimar's avatar
Laurent Aimar committed
996 997 998 999
    p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
                                 VLC_OBJECT_GENERIC, "scale" );
    if( !p_scale )
        return NULL;
1000

Laurent Aimar's avatar
Laurent Aimar committed
1001 1002 1003 1004
    es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
    p_scale->fmt_in.video.i_chroma = i_src_chroma;
    p_scale->fmt_in.video.i_width =
    p_scale->fmt_in.video.i_height = 32;
Laurent Aimar's avatar
Laurent Aimar committed
1005

Laurent Aimar's avatar
Laurent Aimar committed
1006 1007 1008 1009
    es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
    p_scale->fmt_out.video.i_chroma = i_dst_chroma;
    p_scale->fmt_out.video.i_width =
    p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
Laurent Aimar's avatar
Laurent Aimar committed
1010

Laurent Aimar's avatar
Laurent Aimar committed
1011 1012
    p_scale->pf_vout_buffer_new = spu_new_video_buffer;
    p_scale->pf_vout_buffer_del = spu_del_video_buffer;
Laurent Aimar's avatar
Laurent Aimar committed
1013

Laurent Aimar's avatar
Laurent Aimar committed