vout_subpictures.c 63.4 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 34 35
#include <assert.h>
#include <limits.h>

36
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
37 38 39 40
#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
41
#include "../libvlc.h"
Laurent Aimar's avatar
Laurent Aimar committed
42
#include "vout_internal.h"
43
#include <vlc_image.h>
44

45 46 47
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
48

49
/* Number of simultaneous subpictures */
50
#define VOUT_MAX_SUBPICTURES (__MAX(VOUT_MAX_PICTURES, SPU_MAX_PREPARE_TIME/5000))
51

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 */
Laurent Aimar's avatar
Laurent Aimar committed
90
    char           *psz_chain_update;
91
    vlc_mutex_t    chain_lock;
92
    filter_chain_t *p_chain;
93 94 95

    /* */
    mtime_t i_last_sort_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 147 148 149
static void SubpictureUpdate( subpicture_t *,
                              const video_format_t *p_fmt_src,
                              const video_format_t *p_fmt_dst,
                              mtime_t i_ts );
150
static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
Laurent Aimar's avatar
Laurent Aimar committed
151 152 153 154 155 156 157
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,
158 159
                             const spu_area_t *p_subtitle_area, int i_subtitle_area,
                             mtime_t render_date );
160

161 162 163
static void UpdateSPU   ( spu_t *, vlc_object_t * );
static int  CropCallback( vlc_object_t *, char const *,
                          vlc_value_t, vlc_value_t, void * );
164 165
static int MarginCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
166

167
static int SpuControl( spu_t *, int, va_list );
168

Joseph Tulou's avatar
Joseph Tulou committed
169
static void SpuClearChannel( spu_t *p_spu, int i_channel );
170 171

/* Buffer allocation for SPU filter (blend, scale, ...) */
172 173
static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
174 175
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
176

177
/* Buffer aloccation fir SUB filter */
178 179 180
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

181 182
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
183

184
/* */
Laurent Aimar's avatar
Laurent Aimar committed
185 186
static void SpuRenderCreateAndLoadText( spu_t * );
static void SpuRenderCreateAndLoadScale( spu_t * );
187
static void FilterRelease( filter_t *p_filter );
188

Laurent Aimar's avatar
Laurent Aimar committed
189 190 191
/*****************************************************************************
 * Public API
 *****************************************************************************/
192 193

#undef spu_Create
194
/**
195
 * Creates the subpicture unit
196
 *
197
 * \param p_this the parent object which creates the subpicture unit
198
 */
199
spu_t *spu_Create( vlc_object_t *p_this )
200
{
201 202
    spu_t *p_spu;
    spu_private_t *p_sys;
203

204 205 206 207
    p_spu = vlc_custom_create( p_this, sizeof(spu_t) + sizeof(spu_private_t),
                               VLC_OBJECT_GENERIC, "subpicture" );
    if( !p_spu )
        return NULL;
208
    vlc_object_attach( p_spu, p_this );
209 210 211 212 213 214

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

    /* Initialize private fields */
215 216 217 218
    vlc_mutex_init( &p_sys->lock );

    SpuHeapInit( &p_sys->heap );

219 220 221 222
    p_sys->p_blend = NULL;
    p_sys->p_text = NULL;
    p_sys->p_scale = NULL;
    p_sys->p_scale_yuvp = NULL;
223

224
    p_sys->i_margin = var_InheritInteger( p_spu, "sub-margin" );
225

226
    /* Register the default subpicture channel */
227
    p_sys->i_channel = 2;
228

Laurent Aimar's avatar
Laurent Aimar committed
229
    p_sys->psz_chain_update = NULL;
230
    vlc_mutex_init( &p_sys->chain_lock );
231
    p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
232 233
                                       SubFilterAllocationInit,
                                       SubFilterAllocationClean,
234
                                       p_spu );
235 236 237 238 239

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

240 241 242
    /* */
    p_sys->i_last_sort_date = -1;

243 244 245 246 247 248 249 250 251 252 253
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
254
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
255
    var_TriggerCallback( p_spu, "sub-filter" );
256

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

260
/**
261
 * Destroy the subpicture unit
262
 *
263
 * \param p_this the parent object which destroys the subpicture unit
264
 */
265
void spu_Destroy( spu_t *p_spu )
266
{
267
    spu_private_t *p_sys = p_spu->p;
268

269 270
    var_DelCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

271
    if( p_sys->p_blend )
272
        filter_DeleteBlend( p_sys->p_blend );
273 274 275

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

277 278
    if( p_sys->p_scale_yuvp )
        FilterRelease( p_sys->p_scale_yuvp );
279

280 281
    if( p_sys->p_scale )
        FilterRelease( p_sys->p_scale );
282

283
    filter_chain_Delete( p_sys->p_chain );
284
    vlc_mutex_destroy( &p_sys->chain_lock );
Laurent Aimar's avatar
Laurent Aimar committed
285
    free( p_sys->psz_chain_update );
286

287 288 289 290
    /* Destroy all remaining subpictures */
    SpuHeapClean( &p_sys->heap );

    vlc_mutex_destroy( &p_sys->lock );
291

292
    vlc_object_release( p_spu );
293 294
}

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

305
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
306 307
    if( !p_input )
        return;
308 309

    if( b_attach )
310
    {
311
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
312
        var_Create( p_input, "highlight", VLC_VAR_BOOL );
313
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
314
        var_AddCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
315 316 317 318 319

        vlc_mutex_lock( &p_spu->p->lock );
        p_spu->p->i_margin = var_GetInteger( p_input, "sub-margin" );
        vlc_mutex_unlock( &p_spu->p->lock );

320 321 322 323
        vlc_object_release( p_input );
    }
    else
    {
324
        /* Delete callbacks */
325
        var_DelCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
326 327
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
        var_Destroy( p_input, "highlight" );
328 329 330 331
        vlc_object_release( p_input );
    }
}

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
/**
 * Inform the SPU filters of mouse event
 */
int spu_ProcessMouse( spu_t *p_spu,
                      const vlc_mouse_t *p_mouse,
                      const video_format_t *p_fmt )
{
    spu_private_t *p_sys = p_spu->p;

    vlc_mutex_lock( &p_sys->chain_lock );
    filter_chain_MouseEvent( p_sys->p_chain, p_mouse, p_fmt );
    vlc_mutex_unlock( &p_sys->chain_lock );

    return VLC_SUCCESS;
}

348
/**
349
 * Display a subpicture
350
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
351 352
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
353
 * \param p_spu the subpicture unit object
354 355
 * \param p_subpic the subpicture to display
 */
356
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
357
{
358
    spu_private_t *p_sys = p_spu->p;
Sam Hocevar's avatar
 
Sam Hocevar committed
359

360
    /* DEFAULT_CHAN always reset itself */
361
    if( p_subpic->i_channel == DEFAULT_CHAN )
Joseph Tulou's avatar
Joseph Tulou committed
362
        SpuClearChannel( p_spu, DEFAULT_CHAN );
363 364 365 366 367 368 369 370

    /* 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
371
    {
372 373 374 375
        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
376
    }
377
    vlc_mutex_unlock( &p_sys->lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
378 379
}

Laurent Aimar's avatar
Laurent Aimar committed
380 381 382 383 384 385
/**
 * 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,
386
                            const video_format_t *p_fmt_src,
387
                            mtime_t render_subtitle_date )
388
{
Laurent Aimar's avatar
Laurent Aimar committed
389
    spu_private_t *p_sys = p_spu->p;
390

391
    const mtime_t render_osd_date = mdate();
392

Laurent Aimar's avatar
Laurent Aimar committed
393 394
    const int i_source_video_width  = p_fmt_src->i_width;
    const int i_source_video_height = p_fmt_src->i_height;
395

Laurent Aimar's avatar
Laurent Aimar committed
396 397
    unsigned int i_subpicture;
    subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
398

Laurent Aimar's avatar
Laurent Aimar committed
399 400 401 402
    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;
403

Laurent Aimar's avatar
Laurent Aimar committed
404
    vlc_mutex_lock( &p_sys->lock );
405

Laurent Aimar's avatar
Laurent Aimar committed
406 407 408 409 410 411 412
    /* 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 )
    {
413 414 415
        SubpictureUpdate( p_subpic,
                          p_fmt_src, p_fmt_dst,
                          p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
416

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

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
445 446
    /* Create the blending module */
    if( !p_sys->p_blend )
447
        p_spu->p->p_blend = filter_NewBlend( VLC_OBJECT(p_spu), p_fmt_dst );
448

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

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

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

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

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
489 490 491 492 493 494
        /* 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 )
        {
Laurent Aimar's avatar
Laurent Aimar committed
495 496
            p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
Laurent Aimar's avatar
Laurent Aimar committed
497
        }
498

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
521 522 523
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
524
                             p_subtitle_area, i_subtitle_area,
525
                             p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
526

Laurent Aimar's avatar
Laurent Aimar committed
527 528 529
            if( p_subpic->b_subtitle )
            {
                area = spu_area_unscaled( area, scale );
530 531 532 533 534
                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;
                }
Laurent Aimar's avatar
Laurent Aimar committed
535 536 537 538
                if( p_subtitle_area )
                    p_subtitle_area[i_subtitle_area++] = area;
            }
        }
539 540
        if( p_subpic->b_subtitle )
            p_subpic->b_absolute = true;
Laurent Aimar's avatar
Laurent Aimar committed
541
    }
542

Laurent Aimar's avatar
Laurent Aimar committed
543 544 545
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
546

Laurent Aimar's avatar
Laurent Aimar committed
547
    vlc_mutex_unlock( &p_sys->lock );
548 549
}

Laurent Aimar's avatar
Laurent Aimar committed
550 551 552 553 554 555 556 557 558 559
/*****************************************************************************
 * 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.
 *****************************************************************************/
560
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
561
                                   bool b_subtitle_only )
Laurent Aimar's avatar
Laurent Aimar committed
562
{
Laurent Aimar's avatar
Laurent Aimar committed
563 564 565
    spu_private_t *p_sys = p_spu->p;
    int i_channel;
    subpicture_t *p_subpic = NULL;
566
    const mtime_t render_osd_date = mdate();
567

Laurent Aimar's avatar
Laurent Aimar committed
568 569 570 571 572 573
    /* Update sub-filter chain */
    vlc_mutex_lock( &p_sys->lock );
    char *psz_chain_update = p_sys->psz_chain_update;
    p_sys->psz_chain_update = NULL;
    vlc_mutex_unlock( &p_sys->lock );

574
    vlc_mutex_lock( &p_sys->chain_lock );
Laurent Aimar's avatar
Laurent Aimar committed
575 576 577 578 579 580 581 582
    if( psz_chain_update )
    {
        filter_chain_Reset( p_sys->p_chain, NULL, NULL );

        filter_chain_AppendFromString( p_spu->p->p_chain, psz_chain_update );

        free( psz_chain_update );
    }
Laurent Aimar's avatar
Laurent Aimar committed
583
    /* Run subpicture filters */
584
    filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
585
    vlc_mutex_unlock( &p_sys->chain_lock );
Laurent Aimar's avatar
Laurent Aimar committed
586

Laurent Aimar's avatar
Laurent Aimar committed
587
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
588

Laurent Aimar's avatar
Laurent Aimar committed
589 590 591
    /* 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
592
    {
593 594 595 596
        subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
        bool         pb_available_late[VOUT_MAX_SUBPICTURES];
        int          i_available = 0;

597
        mtime_t      start_date = render_subtitle_date;
598
        mtime_t      ephemer_subtitle_date = 0;
599
        mtime_t      ephemer_osd_date = 0;
600 601
        int64_t      i_ephemer_subtitle_order = INT64_MIN;
        int64_t      i_ephemer_system_order = INT64_MIN;
Laurent Aimar's avatar
Laurent Aimar committed
602 603
        int i_index;

604
        /* Select available pictures */
Laurent Aimar's avatar
Laurent Aimar committed
605 606 607 608
        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;
609 610
            bool b_stop_valid;
            bool b_late;
Laurent Aimar's avatar
Laurent Aimar committed
611 612 613 614 615 616 617 618 619 620 621 622 623

            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;
            }
624
            const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
625 626
            if( render_date &&
                render_date < p_current->i_start )
Laurent Aimar's avatar
Laurent Aimar committed
627 628 629 630 631
            {
                /* Too early, come back next monday */
                continue;
            }

632
            mtime_t *pi_ephemer_date  = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
633 634 635
            int64_t *pi_ephemer_order = p_current->b_subtitle ? &i_ephemer_subtitle_order : &i_ephemer_system_order;
            if( p_current->i_start >= *pi_ephemer_date )
            {
636
                *pi_ephemer_date = p_current->i_start;
637 638 639
                if( p_current->i_order > *pi_ephemer_order )
                    *pi_ephemer_order = p_current->i_order;
            }
Laurent Aimar's avatar
Laurent Aimar committed
640

641
            b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
642

643
            b_late = b_stop_valid && p_current->i_stop <= render_date;
644 645

            /* start_date will be used for correct automatic overlap support
Laurent Aimar's avatar
Laurent Aimar committed
646
             * in case picture that should not be displayed anymore (display_time)
647
             * overlap with a picture to be displayed (p_current->i_start)  */
648
            if( p_current->b_subtitle && !b_late && !p_current->b_ephemer )
649 650 651 652 653 654
                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
655 656
        }

657 658 659 660 661 662 663 664
        /* 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
665
        {
666 667
            subpicture_t *p_current = p_available_subpic[i_index];
            bool b_late = pb_available_late[i_index];
Laurent Aimar's avatar
Laurent Aimar committed
668

669 670
            const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : render_osd_date;
            const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_osd_date;
671
            const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
672

673 674 675
            /* Destroy late and obsolete ephemer subpictures */
            bool b_rejet = b_late && p_current->i_stop <= stop_date;
            if( p_current->b_ephemer )
Laurent Aimar's avatar
Laurent Aimar committed
676
            {
677 678 679 680 681
                if( p_current->i_start < ephemer_date )
                    b_rejet = true;
                else if( p_current->i_start == ephemer_date &&
                         p_current->i_order < i_ephemer_order )
                    b_rejet = true;
Laurent Aimar's avatar
Laurent Aimar committed
682
            }
683 684 685

            if( b_rejet )
                SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
686
            else
687
                SubpictureChain( &p_subpic, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
688
        }
Laurent Aimar's avatar
Laurent Aimar committed
689
    }
690

691
    p_sys->i_last_sort_date = render_subtitle_date;
Laurent Aimar's avatar
Laurent Aimar committed
692
    vlc_mutex_unlock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
693

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

Laurent Aimar's avatar
Laurent Aimar committed
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
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
718 719 720
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
721 722 723 724 725 726 727
struct subpicture_private_t
{
    video_format_t src;
    video_format_t dst;
};

subpicture_t *subpicture_New( const subpicture_updater_t *p_upd )
728
{
Laurent Aimar's avatar
Laurent Aimar committed
729 730 731
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
732

Laurent Aimar's avatar
Laurent Aimar committed
733 734 735 736 737 738 739
    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;

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
    if( p_upd )
    {
        subpicture_private_t *p_private = malloc( sizeof(*p_private) );
        if( !p_private )
        {
            free( p_subpic );
            return NULL;
        }
        video_format_Init( &p_private->src, 0 );
        video_format_Init( &p_private->dst, 0 );

        p_subpic->updater   = *p_upd;
        p_subpic->p_private = p_private;
    }
    else
    {
        p_subpic->p_private = NULL;

        p_subpic->updater.pf_validate = NULL;
        p_subpic->updater.pf_update   = NULL;
        p_subpic->updater.pf_destroy  = NULL;
        p_subpic->updater.p_sys       = NULL;
    }
Laurent Aimar's avatar
Laurent Aimar committed
763
    return p_subpic;
764
}
Laurent Aimar's avatar
Laurent Aimar committed
765

766
void subpicture_Delete( subpicture_t *p_subpic )
767
{
Laurent Aimar's avatar
Laurent Aimar committed
768 769 770
    subpicture_region_ChainDelete( p_subpic->p_region );
    p_subpic->p_region = NULL;

771 772 773 774
    if( p_subpic->updater.pf_destroy )
        p_subpic->updater.pf_destroy( p_subpic );

    free( p_subpic->p_private );
Laurent Aimar's avatar
Laurent Aimar committed
775
    free( p_subpic );
776
}
Laurent Aimar's avatar
Laurent Aimar committed
777 778

static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
779
{
Laurent Aimar's avatar
Laurent Aimar committed
780 781 782
    p_subpic->p_next = *pp_head;

    *pp_head = p_subpic;
783
}
Laurent Aimar's avatar
Laurent Aimar committed
784

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
                                         picture_t *p_picture, vlc_fourcc_t i_chroma )
{
    /* */
    video_format_t fmt_in = p_picture->format;

    /* */
    video_format_t fmt_out;
    fmt_out = fmt_in;
    fmt_out.i_chroma = i_chroma;

    /* */
    image_handler_t *p_image = image_HandlerCreate( p_obj );
    if( !p_image )
        return NULL;

    picture_t *p_pip = image_Convert( p_image, p_picture, &fmt_in, &fmt_out );

    image_HandlerDelete( p_image );

    if( !p_pip )
        return NULL;

808
    subpicture_t *p_subpic = subpicture_New( NULL );
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
    if( !p_subpic )
    {
         picture_Release( p_pip );
         return NULL;
    }

    p_subpic->i_original_picture_width  = fmt_out.i_width;
    p_subpic->i_original_picture_height = fmt_out.i_height;

    fmt_out.i_sar_num =
    fmt_out.i_sar_den = 0;

    p_subpic->p_region = subpicture_region_New( &fmt_out );
    if( p_subpic->p_region )
    {
        picture_Release( p_subpic->p_region->p_picture );
        p_subpic->p_region->p_picture = p_pip;
    }
    else
    {
        picture_Release( p_pip );
    }
    return p_subpic;
}

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
static void SubpictureUpdate( subpicture_t *p_subpicture,
                              const video_format_t *p_fmt_src,
                              const video_format_t *p_fmt_dst,
                              mtime_t i_ts )
{
    subpicture_updater_t *p_upd = &p_subpicture->updater;
    subpicture_private_t *p_private = p_subpicture->p_private;

    if( !p_upd->pf_validate )
        return;
    if( !p_upd->pf_validate( p_subpicture,
                          !video_format_IsSimilar( p_fmt_src,
                                                   &p_private->src ), p_fmt_src,
                          !video_format_IsSimilar( p_fmt_dst,
                                                   &p_private->dst ), p_fmt_dst,
                          i_ts ) )
        return;

    subpicture_region_ChainDelete( p_subpicture->p_region );
    p_subpicture->p_region = NULL;

    p_upd->pf_update( p_subpicture, p_fmt_src, p_fmt_dst, i_ts );

    video_format_Clean( &p_private->src );
    video_format_Clean( &p_private->dst );

    video_format_Copy( &p_private->src, p_fmt_src );
    video_format_Copy( &p_private->dst, p_fmt_dst );
}

Laurent Aimar's avatar
Laurent Aimar committed
864 865 866 867
/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
868
{
Laurent Aimar's avatar
Laurent Aimar committed
869 870 871
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
872

Laurent Aimar's avatar
Laurent Aimar committed
873 874
    p_region->fmt = *p_fmt;
    p_region->fmt.p_palette = NULL;
875
    if( p_fmt->i_chroma == VLC_CODEC_YUVP )
Laurent Aimar's avatar
Laurent Aimar committed
876 877 878 879 880 881 882 883 884 885 886
    {
        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;
887

888
    if( p_fmt->i_chroma == VLC_CODEC_TEXT )
Laurent Aimar's avatar
Laurent Aimar committed
889
        return p_region;
890

891
    p_region->p_picture = picture_NewFromFormat( p_fmt );
Laurent Aimar's avatar
Laurent Aimar committed
892 893
    if( !p_region->p_picture )
    {
894
        free( p_region->fmt.p_palette );
Laurent Aimar's avatar
Laurent Aimar committed
895 896 897
        free( p_region );
        return NULL;
    }
898

Laurent Aimar's avatar
Laurent Aimar committed
899
    return p_region;
900
}
Laurent Aimar's avatar
Laurent Aimar committed
901 902 903

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
904
{
Laurent Aimar's avatar
Laurent Aimar committed
905 906
    if( !p_region )
        return;
907

Laurent Aimar's avatar
Laurent Aimar committed
908 909
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
910

Laurent Aimar's avatar
Laurent Aimar committed
911 912
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
913

Laurent Aimar's avatar
Laurent Aimar committed
914 915 916 917
    free( p_region->fmt.p_palette );

    free( p_region->psz_text );
    free( p_region->psz_html );
basOS G's avatar
basOS G committed
918 919
    if( p_region->p_style )
        text_style_Delete( p_region->p_style );
Laurent Aimar's avatar
Laurent Aimar committed
920
    free( p_region );
921 922
}

Laurent Aimar's avatar
Laurent Aimar committed
923 924 925 926 927 928
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
929

Laurent Aimar's avatar
Laurent Aimar committed
930
        subpicture_region_Delete( p_head );
931

Laurent Aimar's avatar
Laurent Aimar committed
932 933
        p_head = p_next;
    }
934 935 936 937
}



Laurent Aimar's avatar
Laurent Aimar committed
938 939 940 941
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
942
{
Laurent Aimar's avatar
Laurent Aimar committed
943 944 945
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
946

Laurent Aimar's avatar
Laurent Aimar committed
947 948 949 950
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
951

Laurent Aimar's avatar
Laurent Aimar committed
952 953 954
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
955
    {
Laurent Aimar's avatar
Laurent Aimar committed
956
        spu_heap_entry_t *e = &p_heap->p_entry[i];
957

Laurent Aimar's avatar
Laurent Aimar committed
958 959
        if( e->p_subpicture )
            continue;
960

Laurent Aimar's avatar
Laurent Aimar committed
961 962 963 964 965 966
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
967

Laurent Aimar's avatar
Laurent Aimar committed
968 969 970
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
971

Laurent Aimar's avatar
Laurent Aimar committed
972 973
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
974

Laurent Aimar's avatar
Laurent Aimar committed
975 976
    e->p_subpicture = NULL;
}
977

Laurent Aimar's avatar
Laurent Aimar committed
978
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
979
{
Laurent Aimar's avatar
Laurent Aimar committed
980
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
981
    {
Laurent Aimar's avatar
Laurent Aimar committed
982
        spu_heap_entry_t *e = &p_heap->p_entry[i];
Laurent Aimar's avatar
Laurent Aimar committed
983

Laurent Aimar's avatar
Laurent Aimar committed
984 985 986 987 988
        if( e->p_subpicture != p_subpic )
            continue;

        SpuHeapDeleteAt( p_heap, i );
        return VLC_SUCCESS;
Laurent Aimar's avatar
Laurent Aimar committed
989
    }
Laurent Aimar's avatar
Laurent Aimar committed
990 991
    return VLC_EGENERIC;
}
Laurent Aimar's avatar
Laurent Aimar committed
992