vout_subpictures.c 58.9 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;
94 95
};

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

134

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

Laurent Aimar's avatar
Laurent Aimar committed
142 143
#define SCALE_UNIT (1000)

144
static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
Laurent Aimar's avatar
Laurent Aimar committed
145 146 147 148 149 150 151 152
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
    spu_t *p_spu;
    spu_private_t *p_sys;
Laurent Aimar's avatar
Laurent Aimar committed
195
 
196 197 198 199 200 201 202 203 204 205 206
    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
    /* */
    p_sys->i_last_sort_date = -1;

233 234 235 236 237 238 239 240 241 242
    return p_spu;
}

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

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

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
249 250 251 252
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

253
    return VLC_SUCCESS;
254
}
Antoine Cellerier's avatar
 
Antoine Cellerier committed
255

256 257
int spu_ParseChain( spu_t *p_spu )
{
258
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
259 260 261
    int i_ret;

    if( !psz_parser )
262
        return VLC_EGENERIC;
263 264

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

266
    free( psz_parser );
267 268

    return i_ret;
269 270 271
}

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

280 281 282 283 284
    if( p_sys->p_blend )
        FilterRelease( p_sys->p_blend );

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

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

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

292
    filter_chain_Delete( p_sys->p_chain );
293

294 295 296 297
    /* Destroy all remaining subpictures */
    SpuHeapClean( &p_sys->heap );

    vlc_mutex_destroy( &p_sys->lock );
298

299
    vlc_object_release( p_spu );
300 301
}

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

312
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
313 314 315
    if( !p_input ) return;

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
371 372 373
    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();
374

Laurent Aimar's avatar
Laurent Aimar committed
375 376
    unsigned int i_subpicture;
    subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
377

Laurent Aimar's avatar
Laurent Aimar committed
378 379 380 381
    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;
382

Laurent Aimar's avatar
Laurent Aimar committed
383
    vlc_mutex_lock( &p_sys->lock );
384

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

Laurent Aimar's avatar
Laurent Aimar committed
396
        if( !b_paused && p_subpic->pf_update_regions )
Laurent Aimar's avatar
Laurent Aimar committed
397 398 399 400 401 402
        {
            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;
403

404
            p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org, i_current_date );
Laurent Aimar's avatar
Laurent Aimar committed
405
        }
406

Laurent Aimar's avatar
Laurent Aimar committed
407 408 409 410 411 412
        /* */
        if( p_subpic->b_subtitle )
        {
            for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
                i_subtitle_region_count++;
        }
413

Laurent Aimar's avatar
Laurent Aimar committed
414 415 416
        /* */
        pp_subpicture[i_subpicture++] = p_subpic;
    }
417

Laurent Aimar's avatar
Laurent Aimar committed
418 419
    /* Be sure we have at least 1 picture to process */
    if( i_subpicture <= 0 )
420
    {
Laurent Aimar's avatar
Laurent Aimar committed
421 422
        vlc_mutex_unlock( &p_sys->lock );
        return;
423 424
    }

Laurent Aimar's avatar
Laurent Aimar committed
425 426 427
    /* 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
428

Laurent Aimar's avatar
Laurent Aimar committed
429 430 431 432 433
    /* 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) );
434

Laurent Aimar's avatar
Laurent Aimar committed
435 436 437
    /* Create the blending module */
    if( !p_sys->p_blend )
        SpuRenderCreateBlend( p_spu, p_fmt_dst->i_chroma, p_fmt_dst->i_aspect );
438

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

Laurent Aimar's avatar
Laurent Aimar committed
445 446
        if( !p_subpic->p_region )
            continue;
447

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

Laurent Aimar's avatar
Laurent Aimar committed
458 459 460
            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;
        }
461

Laurent Aimar's avatar
Laurent Aimar committed
462 463 464 465
        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;
466

Laurent Aimar's avatar
Laurent Aimar committed
467 468 469
            p_sys->p_text->fmt_out.video.i_height         =
            p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
        }
470

Laurent Aimar's avatar
Laurent Aimar committed
471 472 473
        /* 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 );
474

Laurent Aimar's avatar
Laurent Aimar committed
475 476 477
        /* 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;
478

Laurent Aimar's avatar
Laurent Aimar committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
        /* 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;
            }
        }
496

Laurent Aimar's avatar
Laurent Aimar committed
497 498 499 500 501 502 503 504 505
        /* 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;
        }
506

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

Laurent Aimar's avatar
Laurent Aimar committed
515 516 517
            /* Check scale validity */
            if( scale.w <= 0 || scale.h <= 0 )
                continue;
518

Laurent Aimar's avatar
Laurent Aimar committed
519 520 521 522
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
                             p_subtitle_area, i_subtitle_area );
523

Laurent Aimar's avatar
Laurent Aimar committed
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
            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;
    }
539

Laurent Aimar's avatar
Laurent Aimar committed
540 541 542
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
543

Laurent Aimar's avatar
Laurent Aimar committed
544
    vlc_mutex_unlock( &p_sys->lock );
545 546
}

Laurent Aimar's avatar
Laurent Aimar committed
547 548 549 550 551 552 553 554 555 556 557 558
/*****************************************************************************
 * 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
559
{
Laurent Aimar's avatar
Laurent Aimar committed
560 561 562
    spu_private_t *p_sys = p_spu->p;
    int i_channel;
    subpicture_t *p_subpic = NULL;
563

Laurent Aimar's avatar
Laurent Aimar committed
564 565
    /* Run subpicture filters */
    filter_chain_SubFilter( p_sys->p_chain, display_date );
Laurent Aimar's avatar
Laurent Aimar committed
566

Laurent Aimar's avatar
Laurent Aimar committed
567
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
568

Laurent Aimar's avatar
Laurent Aimar committed
569 570 571
    /* 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
572
    {
573 574 575 576 577
        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
578 579 580
        mtime_t      ephemer_date = 0;
        int i_index;

581
        /* Select available pictures */
Laurent Aimar's avatar
Laurent Aimar committed
582 583 584 585
        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;
586 587
            bool b_stop_valid;
            bool b_late;
Laurent Aimar's avatar
Laurent Aimar committed
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610

            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;

611 612 613 614 615 616
            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
617
             * in case picture that should not be displayed anymore (display_time)
618 619 620 621 622 623 624 625
             * 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
626 627
        }

628 629 630 631 632 633 634 635
        /* 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
636
        {
637 638
            subpicture_t *p_current = p_available_subpic[i_index];
            bool b_late = pb_available_late[i_index];
Laurent Aimar's avatar
Laurent Aimar committed
639

640 641
            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
642
            {
643 644
                /* Destroy late and obsolete ephemer subpictures */
                SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
645 646 647
            }
            else
            {
648
                SubpictureChain( &p_subpic, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
649 650
            }
        }
Laurent Aimar's avatar
Laurent Aimar committed
651
    }
652 653

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

Laurent Aimar's avatar
Laurent Aimar committed
656
    return p_subpic;
Laurent Aimar's avatar
Laurent Aimar committed
657 658
}

Laurent Aimar's avatar
Laurent Aimar committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
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
680 681 682
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
683
subpicture_t *subpicture_New( void )
684
{
Laurent Aimar's avatar
Laurent Aimar committed
685 686 687
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
688

Laurent Aimar's avatar
Laurent Aimar committed
689 690 691 692 693 694 695 696 697 698 699
    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;
700
}
Laurent Aimar's avatar
Laurent Aimar committed
701

702
void subpicture_Delete( subpicture_t *p_subpic )
703
{
Laurent Aimar's avatar
Laurent Aimar committed
704 705 706 707 708 709 710 711
    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 );
712
}
Laurent Aimar's avatar
Laurent Aimar committed
713 714

static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
715
{
Laurent Aimar's avatar
Laurent Aimar committed
716 717 718
    p_subpic->p_next = *pp_head;

    *pp_head = p_subpic;
719
}
Laurent Aimar's avatar
Laurent Aimar committed
720 721 722 723 724

/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
725
{
Laurent Aimar's avatar
Laurent Aimar committed
726 727 728
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
729

Laurent Aimar's avatar
Laurent Aimar committed
730 731 732 733 734 735 736 737 738 739 740 741 742 743
    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;
744

Laurent Aimar's avatar
Laurent Aimar committed
745 746
    if( p_fmt->i_chroma == VLC_FOURCC_TEXT )
        return p_region;
747

Laurent Aimar's avatar
Laurent Aimar committed
748 749 750 751 752 753 754 755
    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;
    }
756

Laurent Aimar's avatar
Laurent Aimar committed
757
    return p_region;
758
}
Laurent Aimar's avatar
Laurent Aimar committed
759 760 761

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
762
{
Laurent Aimar's avatar
Laurent Aimar committed
763 764
    if( !p_region )
        return;
765

Laurent Aimar's avatar
Laurent Aimar committed
766 767
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
768

Laurent Aimar's avatar
Laurent Aimar committed
769 770
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
771

Laurent Aimar's avatar
Laurent Aimar committed
772 773 774 775 776 777
    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 );
778 779
}

Laurent Aimar's avatar
Laurent Aimar committed
780 781 782 783 784 785
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
786

Laurent Aimar's avatar
Laurent Aimar committed
787
        subpicture_region_Delete( p_head );
788

Laurent Aimar's avatar
Laurent Aimar committed
789 790
        p_head = p_next;
    }
791 792 793 794
}



Laurent Aimar's avatar
Laurent Aimar committed
795 796 797 798
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
799
{
Laurent Aimar's avatar
Laurent Aimar committed
800 801 802
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
803

Laurent Aimar's avatar
Laurent Aimar committed
804 805 806 807
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
808

Laurent Aimar's avatar
Laurent Aimar committed
809 810 811
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
812
    {
Laurent Aimar's avatar
Laurent Aimar committed
813
        spu_heap_entry_t *e = &p_heap->p_entry[i];
814

Laurent Aimar's avatar
Laurent Aimar committed
815 816
        if( e->p_subpicture )
            continue;
817

Laurent Aimar's avatar
Laurent Aimar committed
818 819 820 821 822 823
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
824

Laurent Aimar's avatar
Laurent Aimar committed
825 826 827
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
828

Laurent Aimar's avatar
Laurent Aimar committed
829 830
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
831

Laurent Aimar's avatar
Laurent Aimar committed
832 833
    e->p_subpicture = NULL;
}
834

Laurent Aimar's avatar
Laurent Aimar committed
835
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
836
{
Laurent Aimar's avatar
Laurent Aimar committed
837
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
838
    {
Laurent Aimar's avatar
Laurent Aimar committed
839
        spu_heap_entry_t *e = &p_heap->p_entry[i];
Laurent Aimar's avatar
Laurent Aimar committed
840

Laurent Aimar's avatar
Laurent Aimar committed
841 842 843 844 845
        if( e->p_subpicture != p_subpic )
            continue;

        SpuHeapDeleteAt( p_heap, i );
        return VLC_SUCCESS;
Laurent Aimar's avatar
Laurent Aimar committed
846
    }
Laurent Aimar's avatar
Laurent Aimar committed
847 848
    return VLC_EGENERIC;
}
Laurent Aimar's avatar
Laurent Aimar committed
849

Laurent Aimar's avatar
Laurent Aimar committed
850 851 852
static void SpuHeapClean( spu_heap_t *p_heap )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
853
    {
Laurent Aimar's avatar
Laurent Aimar committed
854 855 856
        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
857
    }
Laurent Aimar's avatar
Laurent Aimar committed
858
}
859

Laurent Aimar's avatar
Laurent Aimar committed
860 861 862
static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
{
    subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
863

Laurent Aimar's avatar
Laurent Aimar committed
864 865
    if( !p_private )
        return NULL;
866

Laurent Aimar's avatar
Laurent Aimar committed
867 868 869 870 871 872 873 874
    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
875

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

Laurent Aimar's avatar
Laurent Aimar committed
886
static void FilterRelease( filter_t *p_filter )
887
{
Laurent Aimar's avatar
Laurent Aimar committed
888 889
    if( p_filter->p_module )
        module_unneed( p_filter, p_filter->p_module );
890

Laurent Aimar's avatar
Laurent Aimar committed
891 892
    vlc_object_detach( p_filter );
    vlc_object_release( p_filter );
893 894
}

Laurent Aimar's avatar
Laurent Aimar committed
895
static void SpuRenderCreateBlend( spu_t *p_spu, vlc_fourcc_t i_chroma, int i_aspect )
Laurent Aimar's avatar
Laurent Aimar committed
896
{
Laurent Aimar's avatar
Laurent Aimar committed
897
    filter_t *p_blend;
898

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

Laurent Aimar's avatar
Laurent Aimar committed
901 902 903 904 905
    p_spu->p->p_blend =
    p_blend        = vlc_custom_create( p_spu, sizeof(filter_t),
                                        VLC_OBJECT_GENERIC, "blend" );
    if( !p_blend )
        return;
906

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

Laurent Aimar's avatar
Laurent Aimar committed
909 910 911 912 913
    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
914

Laurent Aimar's avatar
Laurent Aimar committed
915 916 917
    /* 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
918

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

Laurent Aimar's avatar
Laurent Aimar committed
927
    assert( p_blend );
928

Laurent Aimar's avatar
Laurent Aimar committed
929 930
    /* */
    if( p_blend->p_module && p_blend->fmt_in.video.i_chroma != p_in_fmt->i_chroma )
931
    {
Laurent Aimar's avatar
Laurent Aimar committed
932 933 934 935
        /* 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;
936
    }
937

938
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
939
    p_blend->fmt_in.video = *p_in_fmt;
940

Laurent Aimar's avatar
Laurent Aimar committed
941 942 943 944 945
    /* */
    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
946

947
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
948 949 950 951 952 953
    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;
954

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

Laurent Aimar's avatar
Laurent Aimar committed
957 958 959 960 961
    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
962

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

Laurent Aimar's avatar
Laurent Aimar committed
965 966 967 968 969
    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;
970

Laurent Aimar's avatar
Laurent Aimar committed
971 972
    p_text->pf_sub_buffer_new = spu_new_buffer;
    p_text->pf_sub_buffer_del = spu_del_buffer;
973

Laurent Aimar's avatar
Laurent Aimar committed
974
    vlc_object_attach( p_text, p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
975

Laurent Aimar's avatar
Laurent Aimar committed
976 977 978 979 980 981 982 983 984
    /* 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 );
985

Laurent Aimar's avatar
Laurent Aimar committed
986 987
    if( !p_text->p_module )
        p_text->p_module = module_need( p_text, "text renderer", NULL, false );
988

Laurent Aimar's avatar
Laurent Aimar committed
989 990 991 992 993 994
    /* 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 );
}
995

Laurent Aimar's avatar
Laurent Aimar committed
996 997 998 999 1000
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;