vout_subpictures.c 59.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"
Laurent Aimar's avatar
Laurent Aimar committed
39
#include "vout_internal.h"
40

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

44 45 46
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
47 48 49 50 51
#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
52
/* */
53 54 55 56 57 58 59 60 61 62 63 64
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
65 66 67 68 69 70
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 );

71 72
struct spu_private_t
{
73 74 75 76
    vlc_mutex_t lock;   /* lock to protect all followings fields */

    spu_heap_t heap;

77 78 79 80 81 82 83 84 85 86 87 88
    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 */

89
    /* Subpiture filters */
90
    filter_chain_t *p_chain;
91 92 93

    /* */
    mtime_t i_last_sort_date;
Laurent Aimar's avatar
Laurent Aimar committed
94 95
    /* */
    mtime_t i_last_render_date;
96 97
};

98 99 100 101 102 103
/* */
struct subpicture_region_private_t
{
    video_format_t fmt;
    picture_t      *p_picture;
};
Laurent Aimar's avatar
Laurent Aimar committed
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 135
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 );

136

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

Laurent Aimar's avatar
Laurent Aimar committed
144 145
#define SCALE_UNIT (1000)

146
static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
Laurent Aimar's avatar
Laurent Aimar committed
147 148 149 150 151 152 153 154
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 );
155

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

160
static int SpuControl( spu_t *, int, va_list );
161

162 163 164
static void SpuClearChannel( spu_t *p_spu, int i_channel, bool b_locked );

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

170
static int spu_ParseChain( spu_t * );
171 172

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

176 177
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
178

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

Laurent Aimar's avatar
Laurent Aimar committed
185 186 187
/*****************************************************************************
 * Public API
 *****************************************************************************/
188
/**
189
 * Creates the subpicture unit
190
 *
191
 * \param p_this the parent object which creates the subpicture unit
192
 */
193
spu_t *__spu_Create( vlc_object_t *p_this )
194
{
195 196
    spu_t *p_spu;
    spu_private_t *p_sys;
Laurent Aimar's avatar
Laurent Aimar committed
197
 
198 199 200 201 202 203 204 205 206 207 208
    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 */
209 210 211 212
    vlc_mutex_init( &p_sys->lock );

    SpuHeapInit( &p_sys->heap );

213 214 215 216
    p_sys->p_blend = NULL;
    p_sys->p_text = NULL;
    p_sys->p_scale = NULL;
    p_sys->p_scale_yuvp = NULL;
217 218

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

    vlc_object_attach( p_spu, p_this );

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

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

232 233
    /* */
    p_sys->i_last_sort_date = -1;
Laurent Aimar's avatar
Laurent Aimar committed
234
    p_sys->i_last_render_date = -1;
235

236 237 238 239 240 241 242 243 244 245
    return p_spu;
}

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

248
    /* If the user requested a sub margin, we force the position. */
249
    p_sys->i_margin = var_CreateGetInteger( p_spu, "sub-margin" );
250 251

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
252 253 254 255
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

256
    return VLC_SUCCESS;
257
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
258

259 260
int spu_ParseChain( spu_t *p_spu )
{
261
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
262 263 264
    int i_ret;

    if( !psz_parser )
265
        return VLC_EGENERIC;
266 267

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

269
    free( psz_parser );
270 271

    return i_ret;
272 273 274
}

/**
275
 * Destroy the subpicture unit
276
 *
277
 * \param p_this the parent object which destroys the subpicture unit
278
 */
279
void spu_Destroy( spu_t *p_spu )
280
{
281
    spu_private_t *p_sys = p_spu->p;
282

283 284 285 286 287
    if( p_sys->p_blend )
        FilterRelease( p_sys->p_blend );

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

289 290
    if( p_sys->p_scale_yuvp )
        FilterRelease( p_sys->p_scale_yuvp );
291

292 293
    if( p_sys->p_scale )
        FilterRelease( p_sys->p_scale );
294

295
    filter_chain_Delete( p_sys->p_chain );
296

297 298 299 300
    /* Destroy all remaining subpictures */
    SpuHeapClean( &p_sys->heap );

    vlc_mutex_destroy( &p_sys->lock );
301

302
    vlc_object_release( p_spu );
303 304
}

305 306 307
/**
 * Attach/Detach the SPU from any input
 *
308
 * \param p_this the object in which to destroy the subpicture unit
309 310
 * \param b_attach to select attach or detach
 */
311
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
312 313 314
{
    vlc_object_t *p_input;

315
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
316 317 318
    if( !p_input ) return;

    if( b_attach )
319
    {
320 321
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
322 323 324 325 326
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
327
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
328 329 330 331
        vlc_object_release( p_input );
    }
}

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

344
    /* DEFAULT_CHAN always reset itself */
345
    if( p_subpic->i_channel == DEFAULT_CHAN )
346 347 348 349 350 351 352 353 354
        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
355
    {
356 357 358 359
        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
360
    }
361
    vlc_mutex_unlock( &p_sys->lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
362 363
}

Laurent Aimar's avatar
Laurent Aimar committed
364 365 366 367 368 369
/**
 * 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,
Laurent Aimar's avatar
Laurent Aimar committed
370
                            const video_format_t *p_fmt_src, bool b_paused )
371
{
Laurent Aimar's avatar
Laurent Aimar committed
372
    spu_private_t *p_sys = p_spu->p;
373

Laurent Aimar's avatar
Laurent Aimar committed
374 375 376
    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();
377

Laurent Aimar's avatar
Laurent Aimar committed
378 379
    unsigned int i_subpicture;
    subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
380

Laurent Aimar's avatar
Laurent Aimar committed
381 382 383 384
    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;
385

Laurent Aimar's avatar
Laurent Aimar committed
386
    vlc_mutex_lock( &p_sys->lock );
387

Laurent Aimar's avatar
Laurent Aimar committed
388 389 390 391 392 393 394 395
    /* 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 )
    {
        /* */
Laurent Aimar's avatar
Laurent Aimar committed
396
        if( !b_paused && p_subpic->pf_pre_render )
Laurent Aimar's avatar
Laurent Aimar committed
397
            p_subpic->pf_pre_render( p_spu, p_subpic, p_fmt_dst );
398

Laurent Aimar's avatar
Laurent Aimar committed
399
        if( !b_paused && p_subpic->pf_update_regions )
Laurent Aimar's avatar
Laurent Aimar committed
400
        {
Laurent Aimar's avatar
Laurent Aimar committed
401
            mtime_t i_render_date;
Laurent Aimar's avatar
Laurent Aimar committed
402 403 404 405 406
            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;
407

Laurent Aimar's avatar
Laurent Aimar committed
408 409 410 411 412
            i_render_date = i_current_date;
            if( p_subpic->b_subtitle && b_paused && p_sys->i_last_render_date > 0 )
                i_render_date = p_sys->i_last_render_date;

            p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org, i_render_date );
Laurent Aimar's avatar
Laurent Aimar committed
413
        }
414

Laurent Aimar's avatar
Laurent Aimar committed
415 416 417 418 419 420
        /* */
        if( p_subpic->b_subtitle )
        {
            for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
                i_subtitle_region_count++;
        }
421

Laurent Aimar's avatar
Laurent Aimar committed
422 423 424
        /* */
        pp_subpicture[i_subpicture++] = p_subpic;
    }
425

Laurent Aimar's avatar
Laurent Aimar committed
426 427 428
    if( !b_paused )
        p_sys->i_last_render_date = i_current_date;

Laurent Aimar's avatar
Laurent Aimar committed
429 430
    /* Be sure we have at least 1 picture to process */
    if( i_subpicture <= 0 )
431
    {
Laurent Aimar's avatar
Laurent Aimar committed
432 433
        vlc_mutex_unlock( &p_sys->lock );
        return;
434 435
    }

Laurent Aimar's avatar
Laurent Aimar committed
436 437 438
    /* 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
439

Laurent Aimar's avatar
Laurent Aimar committed
440 441 442 443 444
    /* 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) );
445

Laurent Aimar's avatar
Laurent Aimar committed
446 447 448
    /* Create the blending module */
    if( !p_sys->p_blend )
        SpuRenderCreateBlend( p_spu, p_fmt_dst->i_chroma, p_fmt_dst->i_aspect );
449

Laurent Aimar's avatar
Laurent Aimar committed
450 451 452 453 454
    /* 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;
455

Laurent Aimar's avatar
Laurent Aimar committed
456 457
        if( !p_subpic->p_region )
            continue;
458

Laurent Aimar's avatar
Laurent Aimar committed
459 460 461 462 463 464 465 466 467
        /* 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 );
468

Laurent Aimar's avatar
Laurent Aimar committed
469 470 471
            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;
        }
472

Laurent Aimar's avatar
Laurent Aimar committed
473 474 475 476
        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;
477

Laurent Aimar's avatar
Laurent Aimar committed
478 479 480
            p_sys->p_text->fmt_out.video.i_height         =
            p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
        }
481

Laurent Aimar's avatar
Laurent Aimar committed
482 483 484
        /* 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 );
485

Laurent Aimar's avatar
Laurent Aimar committed
486 487 488
        /* 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;
489

Laurent Aimar's avatar
Laurent Aimar committed
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
        /* 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;
            }
        }
507

Laurent Aimar's avatar
Laurent Aimar committed
508 509 510 511 512 513 514 515 516
        /* 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;
        }
517

Laurent Aimar's avatar
Laurent Aimar committed
518 519 520 521 522 523 524
        /* 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;
525

Laurent Aimar's avatar
Laurent Aimar committed
526 527 528
            /* Check scale validity */
            if( scale.w <= 0 || scale.h <= 0 )
                continue;
529

Laurent Aimar's avatar
Laurent Aimar committed
530 531 532 533
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
                             p_subtitle_area, i_subtitle_area );
534

Laurent Aimar's avatar
Laurent Aimar committed
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
            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;
    }
550

Laurent Aimar's avatar
Laurent Aimar committed
551 552 553
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
554

Laurent Aimar's avatar
Laurent Aimar committed
555
    vlc_mutex_unlock( &p_sys->lock );
556 557
}

Laurent Aimar's avatar
Laurent Aimar committed
558 559 560 561 562 563 564 565 566 567 568 569
/*****************************************************************************
 * 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
570
{
Laurent Aimar's avatar
Laurent Aimar committed
571 572 573
    spu_private_t *p_sys = p_spu->p;
    int i_channel;
    subpicture_t *p_subpic = NULL;
574

Laurent Aimar's avatar
Laurent Aimar committed
575 576
    /* Run subpicture filters */
    filter_chain_SubFilter( p_sys->p_chain, display_date );
Laurent Aimar's avatar
Laurent Aimar committed
577

Laurent Aimar's avatar
Laurent Aimar committed
578
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
579

Laurent Aimar's avatar
Laurent Aimar committed
580 581 582
    /* 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
583
    {
584 585 586 587 588
        subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
        bool         pb_available_late[VOUT_MAX_SUBPICTURES];
        int          i_available = 0;

        mtime_t      start_date = display_date;
Laurent Aimar's avatar
Laurent Aimar committed
589 590 591
        mtime_t      ephemer_date = 0;
        int i_index;

592
        /* Select available pictures */
Laurent Aimar's avatar
Laurent Aimar committed
593 594 595 596
        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;
597 598
            bool b_stop_valid;
            bool b_late;
Laurent Aimar's avatar
Laurent Aimar committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621

            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;

622 623 624 625 626 627
            b_stop_valid = ( !p_current->b_ephemer || p_current->i_stop > p_current->i_start ) &&
                           ( !p_current->b_subtitle || !b_paused ); /* XXX Assume that subtitle are pausable */

            b_late = b_stop_valid && p_current->i_stop <= display_date;

            /* start_date will be used for correct automatic overlap support
Laurent Aimar's avatar
Laurent Aimar committed
628
             * in case picture that should not be displayed anymore (display_time)
629 630 631 632 633 634 635 636
             * overlap with a picture to be displayed (p_current->i_start)  */
            if( !b_late && !p_current->b_ephemer )
                start_date = p_current->i_start;

            /* */
            p_available_subpic[i_available] = p_current;
            pb_available_late[i_available] = b_late;
            i_available++;
Laurent Aimar's avatar
Laurent Aimar committed
637 638
        }

639 640 641 642 643 644 645 646
        /* Only forced old picture display at the transition */
        if( start_date < p_sys->i_last_sort_date )
            start_date = p_sys->i_last_sort_date;
        if( start_date <= 0 )
            start_date = INT64_MAX;

        /* Select pictures to be displayed */
        for( i_index = 0; i_index < i_available; i_index++ )
Laurent Aimar's avatar
Laurent Aimar committed
647
        {
648 649
            subpicture_t *p_current = p_available_subpic[i_index];
            bool b_late = pb_available_late[i_index];
Laurent Aimar's avatar
Laurent Aimar committed
650

651 652
            if( ( b_late && p_current->i_stop <= __MAX( start_date, p_sys->i_last_sort_date ) ) ||
                ( p_current->b_ephemer && p_current->i_start < ephemer_date ) )
Laurent Aimar's avatar
Laurent Aimar committed
653
            {
654 655
                /* Destroy late and obsolete ephemer subpictures */
                SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
656 657 658
            }
            else
            {
659
                SubpictureChain( &p_subpic, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
660 661
            }
        }
Laurent Aimar's avatar
Laurent Aimar committed
662
    }
663 664

    p_sys->i_last_sort_date = display_date;
Laurent Aimar's avatar
Laurent Aimar committed
665
    vlc_mutex_unlock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
666

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

Laurent Aimar's avatar
Laurent Aimar committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration )
{
    spu_private_t *p_sys = p_spu->p;

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

        if( p_current && p_current->b_subtitle )
        {
            if( p_current->i_start > 0 )
                p_current->i_start += i_duration;
            if( p_current->i_stop > 0 )
                p_current->i_stop += i_duration;
        }
    }
    vlc_mutex_unlock( &p_sys->lock );
}

Laurent Aimar's avatar
Laurent Aimar committed
691 692 693
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
694
subpicture_t *subpicture_New( void )
695
{
Laurent Aimar's avatar
Laurent Aimar committed
696 697 698
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
699

Laurent Aimar's avatar
Laurent Aimar committed
700 701 702 703 704 705 706 707 708 709 710
    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;
711
}
Laurent Aimar's avatar
Laurent Aimar committed
712

713
void subpicture_Delete( subpicture_t *p_subpic )
714
{
Laurent Aimar's avatar
Laurent Aimar committed
715 716 717 718 719 720 721 722
    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 );
723
}
Laurent Aimar's avatar
Laurent Aimar committed
724 725

static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
726
{
Laurent Aimar's avatar
Laurent Aimar committed
727 728 729
    p_subpic->p_next = *pp_head;

    *pp_head = p_subpic;
730
}
Laurent Aimar's avatar
Laurent Aimar committed
731 732 733 734 735

/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
736
{
Laurent Aimar's avatar
Laurent Aimar committed
737 738 739
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
740

Laurent Aimar's avatar
Laurent Aimar committed
741 742 743 744 745 746 747 748 749 750 751 752 753 754
    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;
755

Laurent Aimar's avatar
Laurent Aimar committed
756 757
    if( p_fmt->i_chroma == VLC_FOURCC_TEXT )
        return p_region;
758

Laurent Aimar's avatar
Laurent Aimar committed
759 760 761 762 763 764 765 766
    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;
    }
767

Laurent Aimar's avatar
Laurent Aimar committed
768
    return p_region;
769
}
Laurent Aimar's avatar
Laurent Aimar committed
770 771 772

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
773
{
Laurent Aimar's avatar
Laurent Aimar committed
774 775
    if( !p_region )
        return;
776

Laurent Aimar's avatar
Laurent Aimar committed
777 778
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
779

Laurent Aimar's avatar
Laurent Aimar committed
780 781
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
782

Laurent Aimar's avatar
Laurent Aimar committed
783 784 785 786 787 788
    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 );
789 790
}

Laurent Aimar's avatar
Laurent Aimar committed
791 792 793 794 795 796
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
797

Laurent Aimar's avatar
Laurent Aimar committed
798
        subpicture_region_Delete( p_head );
799

Laurent Aimar's avatar
Laurent Aimar committed
800 801
        p_head = p_next;
    }
802 803 804 805
}



Laurent Aimar's avatar
Laurent Aimar committed
806 807 808 809
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
810
{
Laurent Aimar's avatar
Laurent Aimar committed
811 812 813
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
814

Laurent Aimar's avatar
Laurent Aimar committed
815 816 817 818
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
819

Laurent Aimar's avatar
Laurent Aimar committed
820 821 822
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
823
    {
Laurent Aimar's avatar
Laurent Aimar committed
824
        spu_heap_entry_t *e = &p_heap->p_entry[i];
825

Laurent Aimar's avatar
Laurent Aimar committed
826 827
        if( e->p_subpicture )
            continue;
828

Laurent Aimar's avatar
Laurent Aimar committed
829 830 831 832 833 834
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
835

Laurent Aimar's avatar
Laurent Aimar committed
836 837 838
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
839

Laurent Aimar's avatar
Laurent Aimar committed
840 841
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
842

Laurent Aimar's avatar
Laurent Aimar committed
843 844
    e->p_subpicture = NULL;
}
845

Laurent Aimar's avatar
Laurent Aimar committed
846
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
847
{
Laurent Aimar's avatar
Laurent Aimar committed
848
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
849
    {
Laurent Aimar's avatar
Laurent Aimar committed
850
        spu_heap_entry_t *e = &p_heap->p_entry[i];
Laurent Aimar's avatar
Laurent Aimar committed
851

Laurent Aimar's avatar
Laurent Aimar committed
852 853 854 855 856
        if( e->p_subpicture != p_subpic )
            continue;

        SpuHeapDeleteAt( p_heap, i );
        return VLC_SUCCESS;
Laurent Aimar's avatar
Laurent Aimar committed
857
    }
Laurent Aimar's avatar
Laurent Aimar committed
858 859
    return VLC_EGENERIC;
}
Laurent Aimar's avatar
Laurent Aimar committed
860

Laurent Aimar's avatar
Laurent Aimar committed
861 862 863
static void SpuHeapClean( spu_heap_t *p_heap )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
864
    {
Laurent Aimar's avatar
Laurent Aimar committed
865 866 867
        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
868
    }
Laurent Aimar's avatar
Laurent Aimar committed
869
}
870

Laurent Aimar's avatar
Laurent Aimar committed
871 872 873
static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
{
    subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
874

Laurent Aimar's avatar
Laurent Aimar committed
875 876
    if( !p_private )
        return NULL;
877

Laurent Aimar's avatar
Laurent Aimar committed
878 879 880 881 882 883 884 885
    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
886

Laurent Aimar's avatar
Laurent Aimar committed
887 888 889 890 891 892 893 894
    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
895 896
}

Laurent Aimar's avatar
Laurent Aimar committed
897
static void FilterRelease( filter_t *p_filter )
898
{
Laurent Aimar's avatar
Laurent Aimar committed
899 900
    if( p_filter->p_module )
        module_unneed( p_filter, p_filter->p_module );
901

Laurent Aimar's avatar
Laurent Aimar committed
902 903
    vlc_object_detach( p_filter );
    vlc_object_release( p_filter );
904 905
}

Laurent Aimar's avatar
Laurent Aimar committed
906
static void SpuRenderCreateBlend( spu_t *p_spu, vlc_fourcc_t i_chroma, int i_aspect )
Laurent Aimar's avatar
Laurent Aimar committed
907
{
Laurent Aimar's avatar
Laurent Aimar committed
908
    filter_t *p_blend;
909

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

Laurent Aimar's avatar
Laurent Aimar committed
912 913 914 915 916
    p_spu->p->p_blend =
    p_blend        = vlc_custom_create( p_spu, sizeof(filter_t),
                                        VLC_OBJECT_GENERIC, "blend" );
    if( !p_blend )
        return;
917

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

Laurent Aimar's avatar
Laurent Aimar committed
920 921 922 923 924
    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
925

Laurent Aimar's avatar
Laurent Aimar committed
926 927 928
    /* 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
929

Laurent Aimar's avatar
Laurent Aimar committed
930 931 932 933 934 935 936
    /* */
    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;
937

Laurent Aimar's avatar
Laurent Aimar committed
938
    assert( p_blend );
939

Laurent Aimar's avatar
Laurent Aimar committed
940 941
    /* */
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
942
    {
Laurent Aimar's avatar
Laurent Aimar committed
943 944 945 946
        /* 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;
947
    }
948

949
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
950
    p_blend->fmt_in.video = *p_in_fmt;
951

Laurent Aimar's avatar
Laurent Aimar committed
952 953 954 955 956
    /* */
    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
957

958
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
959 960 961 962 963 964
    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;
965