vout_subpictures.c 59 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 50
/* Number of simultaneous subpictures */
#define VOUT_MAX_SUBPICTURES (VOUT_MAX_PICTURES)

Laurent Aimar's avatar
Laurent Aimar committed
51
/* */
52 53 54 55 56 57 58 59 60 61 62 63
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
64 65 66 67 68 69
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 );

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

    spu_heap_t heap;

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

88
    /* Subpiture filters */
Laurent Aimar's avatar
Laurent Aimar committed
89
    char           *psz_chain_update;
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
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,
152 153
                             const spu_area_t *p_subtitle_area, int i_subtitle_area,
                             mtime_t render_date );
154

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

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

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

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

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

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

176
/* */
Laurent Aimar's avatar
Laurent Aimar committed
177 178
static void SpuRenderCreateAndLoadText( spu_t * );
static void SpuRenderCreateAndLoadScale( spu_t * );
179
static void FilterRelease( filter_t *p_filter );
180

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

    SpuHeapInit( &p_sys->heap );

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

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

    vlc_object_attach( p_spu, p_this );

Laurent Aimar's avatar
Laurent Aimar committed
219
    p_sys->psz_chain_update = NULL;
220
    p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
221 222
                                       SubFilterAllocationInit,
                                       SubFilterAllocationClean,
223
                                       p_spu );
224 225 226 227 228

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

229 230 231
    /* */
    p_sys->i_last_sort_date = -1;

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

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

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

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
248
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
249
    var_TriggerCallback( p_spu, "sub-filter" );
250

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

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

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

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

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

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

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

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

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

    vlc_mutex_destroy( &p_sys->lock );
284

285
    vlc_object_release( p_spu );
286 287
}

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

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

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

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

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

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

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

359 360
    const mtime_t system_date = mdate();

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

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

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

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

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

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

393 394
            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
395
        }
396

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
    /* 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
571
    /* Run subpicture filters */
572
    filter_chain_SubFilter( p_sys->p_chain, render_date );
Laurent Aimar's avatar
Laurent Aimar committed
573

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

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

584 585 586
        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
587 588
        int i_index;

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

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

616 617 618
            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
619

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

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

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

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

648 649 650 651
            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 ) ||
652
                ( p_current->b_ephemer && p_current->i_start < ephemer_date ) )
Laurent Aimar's avatar
Laurent Aimar committed
653
            {
654 655
                /* Destroy late and obsolete ephemer subpictures */
                SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
656 657 658
            }
            else
            {
659
                SubpictureChain( &p_subpic, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
660 661
            }
        }
Laurent Aimar's avatar
Laurent Aimar committed
662
    }
663

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

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

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
700 701 702 703 704 705 706 707 708 709 710
    p_subpic->i_order    = 0;
    p_subpic->b_absolute = true;
    p_subpic->b_fade     = false;
    p_subpic->b_subtitle = false;
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;

    return p_subpic;
711
}
Laurent Aimar's avatar
Laurent Aimar committed
712

713
void subpicture_Delete( subpicture_t *p_subpic )
714
{
Laurent Aimar's avatar
Laurent Aimar committed
715 716 717 718 719 720 721 722
    subpicture_region_ChainDelete( p_subpic->p_region );
    p_subpic->p_region = NULL;

    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }
    free( p_subpic );
723
}
Laurent Aimar's avatar
Laurent Aimar committed
724 725

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

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

732 733 734 735 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
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
782 783 784 785
/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
786
{
Laurent Aimar's avatar
Laurent Aimar committed
787 788 789
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
790

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
995 996 997 998 999 1000
    /* 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 );
}
1001