vout_subpictures.c 59.1 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
#include <vlc_image.h>
41

42
#include <assert.h>
43
#include <limits.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
    filter_chain_t *p_chain;
92 93 94

    /* */
    mtime_t i_last_sort_date;
95 96
};

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

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

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

    spu_scale_t scale;
} spu_area_t;

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

135

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

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

145
static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
Laurent Aimar's avatar
Laurent Aimar committed
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,
153 154
                             const spu_area_t *p_subtitle_area, int i_subtitle_area,
                             mtime_t render_date );
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

Joseph Tulou's avatar
Joseph Tulou committed
162
static void SpuClearChannel( spu_t *p_spu, int i_channel );
163 164

/* 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
/* 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
static void SpuRenderCreateAndLoadText( spu_t * );
static void SpuRenderCreateAndLoadScale( spu_t * );
180
static void FilterRelease( filter_t *p_filter );
181

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

    SpuHeapInit( &p_sys->heap );

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

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

    vlc_object_attach( p_spu, p_this );

Laurent Aimar's avatar
Laurent Aimar committed
220
    p_sys->psz_chain_update = NULL;
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
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
250
    var_TriggerCallback( p_spu, "sub-filter" );
251

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

255
/**
256
 * Destroy the subpicture unit
257
 *
258
 * \param p_this the parent object which destroys the subpicture unit
259
 */
260
void spu_Destroy( spu_t *p_spu )
261
{
262
    spu_private_t *p_sys = p_spu->p;
263

264 265
    var_DelCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

266
    if( p_sys->p_blend )
267
        filter_DeleteBlend( p_sys->p_blend );
268 269 270

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

272 273
    if( p_sys->p_scale_yuvp )
        FilterRelease( p_sys->p_scale_yuvp );
274

275 276
    if( p_sys->p_scale )
        FilterRelease( p_sys->p_scale );
277

278
    filter_chain_Delete( p_sys->p_chain );
Laurent Aimar's avatar
Laurent Aimar committed
279
    free( p_sys->psz_chain_update );
280

281 282 283 284
    /* Destroy all remaining subpictures */
    SpuHeapClean( &p_sys->heap );

    vlc_mutex_destroy( &p_sys->lock );
285

286
    vlc_object_release( p_spu );
287 288
}

289 290 291
/**
 * Attach/Detach the SPU from any input
 *
292
 * \param p_this the object in which to destroy the subpicture unit
293 294
 * \param b_attach to select attach or detach
 */
295
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
296 297 298
{
    vlc_object_t *p_input;

299
    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
300 301
    if( !p_input )
        return;
302 303

    if( b_attach )
304
    {
305 306
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
307 308 309 310 311
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
312
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
313 314 315 316
        vlc_object_release( p_input );
    }
}

317
/**
318
 * Display a subpicture
319
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
320 321
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
322
 * \param p_spu the subpicture unit object
323 324
 * \param p_subpic the subpicture to display
 */
325
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
326
{
327
    spu_private_t *p_sys = p_spu->p;
Sam Hocevar's avatar
 
Sam Hocevar committed
328

329
    /* DEFAULT_CHAN always reset itself */
330
    if( p_subpic->i_channel == DEFAULT_CHAN )
Joseph Tulou's avatar
Joseph Tulou committed
331
        SpuClearChannel( p_spu, DEFAULT_CHAN );
332 333 334 335 336 337 338 339

    /* 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
340
    {
341 342 343 344
        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
345
    }
346
    vlc_mutex_unlock( &p_sys->lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
347 348
}

Laurent Aimar's avatar
Laurent Aimar committed
349 350 351 352 353 354
/**
 * 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,
355 356
                            const video_format_t *p_fmt_src,
                            mtime_t render_date )
357
{
Laurent Aimar's avatar
Laurent Aimar committed
358
    spu_private_t *p_sys = p_spu->p;
359

360 361
    const mtime_t system_date = mdate();

Laurent Aimar's avatar
Laurent Aimar committed
362 363
    const int i_source_video_width  = p_fmt_src->i_width;
    const int i_source_video_height = p_fmt_src->i_height;
364

Laurent Aimar's avatar
Laurent Aimar committed
365 366
    unsigned int i_subpicture;
    subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
367

Laurent Aimar's avatar
Laurent Aimar committed
368 369 370 371
    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;
372

Laurent Aimar's avatar
Laurent Aimar committed
373
    vlc_mutex_lock( &p_sys->lock );
374

Laurent Aimar's avatar
Laurent Aimar committed
375 376 377 378 379 380 381
    /* 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 )
    {
382 383
        /* TODO remove pre-render */
        if( p_subpic->pf_pre_render )
Laurent Aimar's avatar
Laurent Aimar committed
384
            p_subpic->pf_pre_render( p_spu, p_subpic, p_fmt_dst );
385

386
        if( p_subpic->pf_update_regions )
Laurent Aimar's avatar
Laurent Aimar committed
387 388 389 390 391 392
        {
            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;
393

394 395
            p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org,
                                         p_subpic->b_subtitle ? render_date : system_date );
Laurent Aimar's avatar
Laurent Aimar committed
396
        }
397

Laurent Aimar's avatar
Laurent Aimar committed
398 399 400 401 402 403
        /* */
        if( p_subpic->b_subtitle )
        {
            for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
                i_subtitle_region_count++;
        }
404

Laurent Aimar's avatar
Laurent Aimar committed
405 406 407
        /* */
        pp_subpicture[i_subpicture++] = p_subpic;
    }
408

Laurent Aimar's avatar
Laurent Aimar committed
409 410
    /* Be sure we have at least 1 picture to process */
    if( i_subpicture <= 0 )
411
    {
Laurent Aimar's avatar
Laurent Aimar committed
412 413
        vlc_mutex_unlock( &p_sys->lock );
        return;
414 415
    }

Laurent Aimar's avatar
Laurent Aimar committed
416 417 418
    /* 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
419

Laurent Aimar's avatar
Laurent Aimar committed
420 421 422 423 424
    /* 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) );
425

Laurent Aimar's avatar
Laurent Aimar committed
426 427
    /* Create the blending module */
    if( !p_sys->p_blend )
428
        p_spu->p->p_blend = filter_NewBlend( VLC_OBJECT(p_spu), p_fmt_dst->i_chroma );
429

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

Laurent Aimar's avatar
Laurent Aimar committed
436 437
        if( !p_subpic->p_region )
            continue;
438

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

Laurent Aimar's avatar
Laurent Aimar committed
449 450 451
            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;
        }
452

Laurent Aimar's avatar
Laurent Aimar committed
453 454 455 456
        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;
457

Laurent Aimar's avatar
Laurent Aimar committed
458 459 460
            p_sys->p_text->fmt_out.video.i_height         =
            p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
        }
461

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

Laurent Aimar's avatar
Laurent Aimar committed
466 467 468
        /* 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;
469

Laurent Aimar's avatar
Laurent Aimar committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
        /* 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;
            }
        }
487

Laurent Aimar's avatar
Laurent Aimar committed
488 489 490 491 492 493 494 495 496
        /* 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;
        }
497

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

Laurent Aimar's avatar
Laurent Aimar committed
506 507 508
            /* Check scale validity */
            if( scale.w <= 0 || scale.h <= 0 )
                continue;
509

Laurent Aimar's avatar
Laurent Aimar committed
510 511 512
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
513 514
                             p_subtitle_area, i_subtitle_area,
                             p_subpic->b_subtitle ? render_date : system_date );
515

Laurent Aimar's avatar
Laurent Aimar committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
            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;
    }
531

Laurent Aimar's avatar
Laurent Aimar committed
532 533 534
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
535

Laurent Aimar's avatar
Laurent Aimar committed
536
    vlc_mutex_unlock( &p_sys->lock );
537 538
}

Laurent Aimar's avatar
Laurent Aimar committed
539 540 541 542 543 544 545 546 547 548
/*****************************************************************************
 * 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.
 *****************************************************************************/
549 550
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_date,
                                   bool b_subtitle_only )
Laurent Aimar's avatar
Laurent Aimar committed
551
{
Laurent Aimar's avatar
Laurent Aimar committed
552 553 554
    spu_private_t *p_sys = p_spu->p;
    int i_channel;
    subpicture_t *p_subpic = NULL;
555
    const mtime_t system_date = mdate();
556

Laurent Aimar's avatar
Laurent Aimar committed
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
    /* 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 );

    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
572
    /* Run subpicture filters */
573
    filter_chain_SubFilter( p_sys->p_chain, render_date );
Laurent Aimar's avatar
Laurent Aimar committed
574

Laurent Aimar's avatar
Laurent Aimar committed
575
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
576

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

585 586 587
        mtime_t      start_date = render_date;
        mtime_t      ephemer_subtitle_date = 0;
        mtime_t      ephemer_system_date = 0;
Laurent Aimar's avatar
Laurent Aimar committed
588 589
        int i_index;

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

            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;
            }
610 611
            if( render_date &&
                render_date < p_current->i_start )
Laurent Aimar's avatar
Laurent Aimar committed
612 613 614 615 616
            {
                /* Too early, come back next monday */
                continue;
            }

617 618 619
            mtime_t *pi_ephemer_date = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_system_date;
            if( p_current->i_start > *pi_ephemer_date )
                *pi_ephemer_date = p_current->i_start;
Laurent Aimar's avatar
Laurent Aimar committed
620

621
            b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
622

623
            b_late = b_stop_valid && p_current->i_stop <= p_current->b_subtitle ? render_date : system_date;
624 625

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

637 638 639 640 641 642 643 644
        /* 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
645
        {
646 647
            subpicture_t *p_current = p_available_subpic[i_index];
            bool b_late = pb_available_late[i_index];
Laurent Aimar's avatar
Laurent Aimar committed
648

649 650 651 652
            const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : system_date;
            const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_system_date;

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
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
692 693 694
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
695
subpicture_t *subpicture_New( void )
696
{
Laurent Aimar's avatar
Laurent Aimar committed
697 698 699
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
700

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

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

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

    *pp_head = p_subpic;
731
}
Laurent Aimar's avatar
Laurent Aimar committed
732

733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
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;

    subpicture_t *p_subpic = subpicture_New();
    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_aspect = 0;
    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;
}

Laurent Aimar's avatar
Laurent Aimar committed
783 784 785 786
/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
787
{
Laurent Aimar's avatar
Laurent Aimar committed
788 789 790
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
791

Laurent Aimar's avatar
Laurent Aimar committed
792 793
    p_region->fmt = *p_fmt;
    p_region->fmt.p_palette = NULL;
794
    if( p_fmt->i_chroma == VLC_CODEC_YUVP )
Laurent Aimar's avatar
Laurent Aimar committed
795 796 797 798 799 800 801 802 803 804 805
    {
        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;
806

807
    if( p_fmt->i_chroma == VLC_CODEC_TEXT )
Laurent Aimar's avatar
Laurent Aimar committed
808
        return p_region;
809

Laurent Aimar's avatar
Laurent Aimar committed
810 811 812 813 814 815 816 817
    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;
    }
818

Laurent Aimar's avatar
Laurent Aimar committed
819
    return p_region;
820
}
Laurent Aimar's avatar
Laurent Aimar committed
821 822 823

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
824
{
Laurent Aimar's avatar
Laurent Aimar committed
825 826
    if( !p_region )
        return;
827

Laurent Aimar's avatar
Laurent Aimar committed
828 829
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
830

Laurent Aimar's avatar
Laurent Aimar committed
831 832
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
833

Laurent Aimar's avatar
Laurent Aimar committed
834 835 836 837
    free( p_region->fmt.p_palette );

    free( p_region->psz_text );
    free( p_region->psz_html );
basOS G's avatar
basOS G committed
838 839
    if( p_region->p_style )
        text_style_Delete( p_region->p_style );
Laurent Aimar's avatar
Laurent Aimar committed
840
    free( p_region );
841 842
}

Laurent Aimar's avatar
Laurent Aimar committed
843 844 845 846 847 848
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
849

Laurent Aimar's avatar
Laurent Aimar committed
850
        subpicture_region_Delete( p_head );
851

Laurent Aimar's avatar
Laurent Aimar committed
852 853
        p_head = p_next;
    }
854 855 856 857
}



Laurent Aimar's avatar
Laurent Aimar committed
858 859 860 861
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
862
{
Laurent Aimar's avatar
Laurent Aimar committed
863 864 865
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
866

Laurent Aimar's avatar
Laurent Aimar committed
867 868 869 870
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
871

Laurent Aimar's avatar
Laurent Aimar committed
872 873 874
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
875
    {
Laurent Aimar's avatar
Laurent Aimar committed
876
        spu_heap_entry_t *e = &p_heap->p_entry[i];
877

Laurent Aimar's avatar
Laurent Aimar committed
878 879
        if( e->p_subpicture )
            continue;
880

Laurent Aimar's avatar
Laurent Aimar committed
881 882 883 884 885 886
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
887

Laurent Aimar's avatar
Laurent Aimar committed
888 889 890
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
891

Laurent Aimar's avatar
Laurent Aimar committed
892 893
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
894

Laurent Aimar's avatar
Laurent Aimar committed
895 896
    e->p_subpicture = NULL;
}
897

Laurent Aimar's avatar
Laurent Aimar committed
898
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
899
{
Laurent Aimar's avatar
Laurent Aimar committed
900
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
901
    {
Laurent Aimar's avatar
Laurent Aimar committed
902
        spu_heap_entry_t *e = &p_heap->p_entry[i];
Laurent Aimar's avatar
Laurent Aimar committed
903

Laurent Aimar's avatar
Laurent Aimar committed
904 905 906 907 908
        if( e->p_subpicture != p_subpic )
            continue;

        SpuHeapDeleteAt( p_heap, i );
        return VLC_SUCCESS;
Laurent Aimar's avatar
Laurent Aimar committed
909
    }
Laurent Aimar's avatar
Laurent Aimar committed
910 911
    return VLC_EGENERIC;
}
Laurent Aimar's avatar
Laurent Aimar committed
912

Laurent Aimar's avatar
Laurent Aimar committed
913 914 915
static void SpuHeapClean( spu_heap_t *p_heap )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
916
    {
Laurent Aimar's avatar
Laurent Aimar committed
917 918 919
        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
920
    }
Laurent Aimar's avatar
Laurent Aimar committed
921
}
922

Laurent Aimar's avatar
Laurent Aimar committed
923 924 925
static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
{
    subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
926

Laurent Aimar's avatar
Laurent Aimar committed
927 928
    if( !p_private )
        return NULL;
929

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

Laurent Aimar's avatar
Laurent Aimar committed
939 940 941 942 943 944 945 946
    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
947 948
}

Laurent Aimar's avatar
Laurent Aimar committed
949
static void FilterRelease( filter_t *p_filter )
950
{
Laurent Aimar's avatar
Laurent Aimar committed
951 952
    if( p_filter->p_module )
        module_unneed( p_filter, p_filter->p_module );
953

Laurent Aimar's avatar
Laurent Aimar committed
954 955
    vlc_object_detach( p_filter );
    vlc_object_release( p_filter );
956 957
}

Laurent Aimar's avatar
Laurent Aimar committed
958 959 960
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
{
    filter_t *p_text;
961

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
972 973 974 975 976
    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;
977

Laurent Aimar's avatar
Laurent Aimar committed
978 979
    p_text->pf_sub_buffer_new = spu_new_buffer;
    p_text->pf_sub_buffer_del = spu_del_buffer;
980

Laurent Aimar's avatar
Laurent Aimar committed
981
    vlc_object_attach( p_text, p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
982

Laurent Aimar's avatar
Laurent Aimar committed
983 984 985 986 987 988 989 990 991
    /* 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 );
992

Laurent Aimar's avatar
Laurent Aimar committed
993 994
    if( !p_text->p_module )
        p_text->p_module = module_need( p_text, "text renderer", NULL, false );
995

Laurent Aimar's avatar
Laurent Aimar committed