vout_subpictures.c 61 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
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
40
#include <vlc_spu.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
#include <vlc_input.h>
45

46 47 48
/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
49

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

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

72 73
struct spu_private_t
{
74
    vlc_mutex_t lock;   /* lock to protect all followings fields */
75
    vlc_object_t *p_input;
76 77 78

    spu_heap_t heap;

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

91
    /* Subpiture filters */
Laurent Aimar's avatar
Laurent Aimar committed
92
    char           *psz_chain_update;
93
    vlc_mutex_t    chain_lock;
94
    filter_chain_t *p_chain;
95 96 97

    /* */
    mtime_t i_last_sort_date;
98 99
};

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

138

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

Laurent Aimar's avatar
Laurent Aimar committed
146 147
#define SCALE_UNIT (1000)

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

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

167
/* Buffer allocation for SPU filter (blend, scale, ...) */
168 169 170 171 172 173 174
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};
static int spu_get_attachments( filter_t *,
                                input_attachment_t ***, int * );
175 176
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );
177

178
/* Buffer aloccation fir SUB filter */
179 180
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
181

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

Laurent Aimar's avatar
Laurent Aimar committed
187 188 189
/*****************************************************************************
 * Public API
 *****************************************************************************/
190 191

#undef spu_Create
192
/**
193
 * Creates the subpicture unit
194
 *
195
 * \param p_this the parent object which creates the subpicture unit
196
 */
197
spu_t *spu_Create( vlc_object_t *p_this )
198
{
199 200
    spu_t *p_spu;
    spu_private_t *p_sys;
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;
206
    vlc_object_attach( p_spu, p_this );
207 208 209 210 211

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

    /* Initialize private fields */
212 213 214 215
    vlc_mutex_init( &p_sys->lock );

    SpuHeapInit( &p_sys->heap );

216 217 218 219
    p_sys->p_blend = NULL;
    p_sys->p_text = NULL;
    p_sys->p_scale = NULL;
    p_sys->p_scale_yuvp = NULL;
220

221
    p_sys->i_margin = var_InheritInteger( p_spu, "sub-margin" );
222

223
    /* Register the default subpicture channel */
Laurent Aimar's avatar
Laurent Aimar committed
224
    p_sys->i_channel = SPU_DEFAULT_CHANNEL + 1;
225

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

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

237 238 239
    /* */
    p_sys->i_last_sort_date = -1;

240 241 242
    return p_spu;
}

243
/**
244
 * Destroy the subpicture unit
245
 *
246
 * \param p_this the parent object which destroys the subpicture unit
247
 */
248
void spu_Destroy( spu_t *p_spu )
249
{
250
    spu_private_t *p_sys = p_spu->p;
251

252
    if( p_sys->p_blend )
253
        filter_DeleteBlend( p_sys->p_blend );
254 255 256

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

258 259
    if( p_sys->p_scale_yuvp )
        FilterRelease( p_sys->p_scale_yuvp );
260

261 262
    if( p_sys->p_scale )
        FilterRelease( p_sys->p_scale );
263

264
    filter_chain_Delete( p_sys->p_chain );
265
    vlc_mutex_destroy( &p_sys->chain_lock );
Laurent Aimar's avatar
Laurent Aimar committed
266
    free( p_sys->psz_chain_update );
267

268 269 270 271
    /* Destroy all remaining subpictures */
    SpuHeapClean( &p_sys->heap );

    vlc_mutex_destroy( &p_sys->lock );
272

273
    vlc_object_release( p_spu );
274 275
}

276 277 278
/**
 * Attach/Detach the SPU from any input
 *
279
 * \param p_this the object in which to destroy the subpicture unit
280 281
 * \param b_attach to select attach or detach
 */
282
void spu_Attach( spu_t *p_spu, vlc_object_t *p_input, bool b_attach )
283 284
{
    if( b_attach )
285
    {
286
        UpdateSPU( p_spu, p_input );
287
        var_Create( p_input, "highlight", VLC_VAR_BOOL );
288
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
289 290

        vlc_mutex_lock( &p_spu->p->lock );
291 292 293 294 295 296
        p_spu->p->p_input = p_input;

        FilterRelease( p_spu->p->p_text );
        p_spu->p->p_text = NULL;
        SpuRenderCreateAndLoadText( p_spu );

297
        vlc_mutex_unlock( &p_spu->p->lock );
298 299 300
    }
    else
    {
301 302 303 304
        vlc_mutex_lock( &p_spu->p->lock );
        p_spu->p->p_input = NULL;
        vlc_mutex_unlock( &p_spu->p->lock );

305 306 307
        /* Delete callbacks */
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
        var_Destroy( p_input, "highlight" );
308 309 310
    }
}

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
/**
 * 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;
}

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

Laurent Aimar's avatar
Laurent Aimar committed
339 340 341
    /* SPU_DEFAULT_CHANNEL always reset itself */
    if( p_subpic->i_channel == SPU_DEFAULT_CHANNEL )
        spu_ClearChannel( p_spu, SPU_DEFAULT_CHANNEL );
342 343 344 345 346 347 348 349

    /* 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
350
    {
351 352 353 354
        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
355
    }
356
    vlc_mutex_unlock( &p_sys->lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
357 358
}

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

370
    const mtime_t render_osd_date = mdate();
371

Laurent Aimar's avatar
Laurent Aimar committed
372 373
    const int i_source_video_width  = p_fmt_src->i_width;
    const int i_source_video_height = p_fmt_src->i_height;
374

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

Laurent Aimar's avatar
Laurent Aimar committed
378 379 380 381
    unsigned int i_subtitle_region_count;
    spu_area_t p_subtitle_area_buffer[VOUT_MAX_SUBPICTURES];
    spu_area_t *p_subtitle_area;
    int i_subtitle_area;
382

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

Laurent Aimar's avatar
Laurent Aimar committed
385 386 387 388 389 390 391
    /* 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 )
    {
392 393 394
        SubpictureUpdate( p_subpic,
                          p_fmt_src, p_fmt_dst,
                          p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
395

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
468 469 470 471 472 473
        /* 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
474 475
            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
476
        }
477

Laurent Aimar's avatar
Laurent Aimar committed
478 479 480 481 482 483 484 485 486
        /* 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;
        }
487

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

Laurent Aimar's avatar
Laurent Aimar committed
496 497 498
            /* Check scale validity */
            if( scale.w <= 0 || scale.h <= 0 )
                continue;
499

Laurent Aimar's avatar
Laurent Aimar committed
500 501 502
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
503
                             p_subtitle_area, i_subtitle_area,
504
                             p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
505

Laurent Aimar's avatar
Laurent Aimar committed
506 507 508
            if( p_subpic->b_subtitle )
            {
                area = spu_area_unscaled( area, scale );
509 510 511 512 513
                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
514 515 516 517
                if( p_subtitle_area )
                    p_subtitle_area[i_subtitle_area++] = area;
            }
        }
518 519
        if( p_subpic->b_subtitle )
            p_subpic->b_absolute = true;
Laurent Aimar's avatar
Laurent Aimar committed
520
    }
521

Laurent Aimar's avatar
Laurent Aimar committed
522 523 524
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
525

Laurent Aimar's avatar
Laurent Aimar committed
526
    vlc_mutex_unlock( &p_sys->lock );
527 528
}

Laurent Aimar's avatar
Laurent Aimar committed
529 530 531 532 533 534 535 536 537 538
/*****************************************************************************
 * 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.
 *****************************************************************************/
539
subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
540
                                   bool b_subtitle_only )
Laurent Aimar's avatar
Laurent Aimar committed
541
{
Laurent Aimar's avatar
Laurent Aimar committed
542 543
    spu_private_t *p_sys = p_spu->p;
    subpicture_t *p_subpic = NULL;
544
    const mtime_t render_osd_date = mdate();
545

Laurent Aimar's avatar
Laurent Aimar committed
546 547 548 549 550 551
    /* 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 );

552
    vlc_mutex_lock( &p_sys->chain_lock );
Laurent Aimar's avatar
Laurent Aimar committed
553 554 555 556 557 558 559 560
    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
561
    /* Run subpicture filters */
562
    filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
563
    vlc_mutex_unlock( &p_sys->chain_lock );
Laurent Aimar's avatar
Laurent Aimar committed
564

Laurent Aimar's avatar
Laurent Aimar committed
565
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
566

Laurent Aimar's avatar
Laurent Aimar committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
    /* Create a list of channels */
    int pi_channel[VOUT_MAX_SUBPICTURES];
    int i_channel_count = 0;

    for( int i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
        spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
        if( !p_entry->p_subpicture || p_entry->b_reject )
            continue;
        const int i_channel = p_entry->p_subpicture->i_channel;
        int i;
        for( i = 0; i < i_channel_count; i++ )
        {
            if( pi_channel[i] == i_channel )
                break;
        }
        if( i_channel_count <= i )
            pi_channel[i_channel_count++] = i_channel;
    }

Laurent Aimar's avatar
Laurent Aimar committed
587 588
    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
Laurent Aimar's avatar
Laurent Aimar committed
589
    for( int i = 0; i < i_channel_count; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
590
    {
Laurent Aimar's avatar
Laurent Aimar committed
591
        const int i_channel = pi_channel[i];
592 593 594 595
        subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
        bool         pb_available_late[VOUT_MAX_SUBPICTURES];
        int          i_available = 0;

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

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

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

631
            mtime_t *pi_ephemer_date  = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
632 633 634
            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 )
            {
635
                *pi_ephemer_date = p_current->i_start;
636 637 638
                if( p_current->i_order > *pi_ephemer_order )
                    *pi_ephemer_order = p_current->i_order;
            }
Laurent Aimar's avatar
Laurent Aimar committed
639

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

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

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

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

668 669
            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;
670
            const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
671

672 673 674
            /* 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
675
            {
676 677 678 679 680
                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
681
            }
682 683 684

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
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
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
int spu_RegisterChannel( spu_t *p_spu )
{
    spu_private_t *p_sys = p_spu->p;

    vlc_mutex_lock( &p_sys->lock );
    int i_channel = p_sys->i_channel++;
    vlc_mutex_unlock( &p_sys->lock );

    return i_channel;
}

void spu_ClearChannel( spu_t *p_spu, int i_channel )
{
    spu_private_t *p_sys = p_spu->p;

    vlc_mutex_lock( &p_sys->lock );

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

        if( !p_subpic )
            continue;
        if( p_subpic->i_channel != i_channel && ( i_channel != -1 || p_subpic->i_channel == SPU_DEFAULT_CHANNEL ) )
            continue;

        /* You cannot delete subpicture outside of spu_SortSubpictures */
        p_entry->b_reject = true;
    }

    vlc_mutex_unlock( &p_sys->lock );
}

751 752 753 754 755 756 757 758 759 760 761 762
void spu_ChangeFilters( spu_t *p_spu, const char *psz_filters )
{
    spu_private_t *p_sys = p_spu->p;

    vlc_mutex_lock( &p_sys->lock );

    free( p_sys->psz_chain_update );
    p_sys->psz_chain_update = strdup( psz_filters );

    vlc_mutex_unlock( &p_sys->lock );
}

Laurent Aimar's avatar
Laurent Aimar committed
763 764 765 766 767 768 769 770 771
void spu_ChangeMargin( spu_t *p_spu, int i_margin )
{
    spu_private_t *p_sys = p_spu->p;

    vlc_mutex_lock( &p_sys->lock );
    p_sys->i_margin = i_margin;
    vlc_mutex_unlock( &p_sys->lock );
}

Laurent Aimar's avatar
Laurent Aimar committed
772 773 774
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
775 776 777 778 779 780 781
struct subpicture_private_t
{
    video_format_t src;
    video_format_t dst;
};

subpicture_t *subpicture_New( const subpicture_updater_t *p_upd )
782
{
Laurent Aimar's avatar
Laurent Aimar committed
783 784 785
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
786

Laurent Aimar's avatar
Laurent Aimar committed
787 788 789 790 791 792 793
    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;

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
    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
817
    return p_subpic;
818
}
Laurent Aimar's avatar
Laurent Aimar committed
819

820
void subpicture_Delete( subpicture_t *p_subpic )
821
{
Laurent Aimar's avatar
Laurent Aimar committed
822 823 824
    subpicture_region_ChainDelete( p_subpic->p_region );
    p_subpic->p_region = NULL;

825 826 827 828
    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
829
    free( p_subpic );
830
}
Laurent Aimar's avatar
Laurent Aimar committed
831 832

static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
833
{
Laurent Aimar's avatar
Laurent Aimar committed
834 835 836
    p_subpic->p_next = *pp_head;

    *pp_head = p_subpic;
837
}
Laurent Aimar's avatar
Laurent Aimar committed
838

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
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;

862
    subpicture_t *p_subpic = subpicture_New( NULL );
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    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;
}

888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
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
918 919 920 921
/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
922
{
Laurent Aimar's avatar
Laurent Aimar committed
923 924 925
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
926

Laurent Aimar's avatar
Laurent Aimar committed
927 928
    p_region->fmt = *p_fmt;
    p_region->fmt.p_palette = NULL;
929
    if( p_fmt->i_chroma == VLC_CODEC_YUVP )
Laurent Aimar's avatar
Laurent Aimar committed
930 931 932 933 934 935 936 937 938 939 940
    {
        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;
941

942
    if( p_fmt->i_chroma == VLC_CODEC_TEXT )
Laurent Aimar's avatar
Laurent Aimar committed
943
        return p_region;
944

945
    p_region->p_picture = picture_NewFromFormat( p_fmt );
Laurent Aimar's avatar
Laurent Aimar committed
946 947
    if( !p_region->p_picture )
    {
948
        free( p_region->fmt.p_palette );
Laurent Aimar's avatar
Laurent Aimar committed
949 950 951
        free( p_region );
        return NULL;
    }
952

Laurent Aimar's avatar
Laurent Aimar committed
953
    return p_region;
954
}
Laurent Aimar's avatar
Laurent Aimar committed
955 956 957

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
958
{
Laurent Aimar's avatar
Laurent Aimar committed
959 960
    if( !p_region )
        return;
961

Laurent Aimar's avatar
Laurent Aimar committed
962 963
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
964

Laurent Aimar's avatar
Laurent Aimar committed
965 966
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
967

Laurent Aimar's avatar
Laurent Aimar committed
968 969 970 971
    free( p_region->fmt.p_palette );

    free( p_region->psz_text );
    free( p_region->psz_html );
basOS G's avatar
basOS G committed
972 973
    if( p_region->p_style )
        text_style_Delete( p_region->p_style );
Laurent Aimar's avatar
Laurent Aimar committed
974
    free( p_region );
975 976
}

Laurent Aimar's avatar
Laurent Aimar committed
977 978 979 980 981 982
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
983

Laurent Aimar's avatar
Laurent Aimar committed
984
        subpicture_region_Delete( p_head );
985

Laurent Aimar's avatar
Laurent Aimar committed
986 987
        p_head = p_next;
    }
988 989 990 991
}



Laurent Aimar's avatar
Laurent Aimar committed
992 993 994 995
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
996
{
Laurent Aimar's avatar
Laurent Aimar committed
997 998 999
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
1000

Laurent Aimar's avatar
Laurent Aimar committed
1001 1002 1003 1004
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
1005

Laurent Aimar's avatar
Laurent Aimar committed
1006 1007 1008
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
1009
    {
Laurent Aimar's avatar
Laurent Aimar committed
1010
        spu_heap_entry_t *e = &p_heap->p_entry[i];
1011

Laurent Aimar's avatar
Laurent Aimar committed
1012 1013
        if( e->p_subpicture )
            continue;
1014

Laurent Aimar's avatar
Laurent Aimar committed
1015 1016 1017 1018 1019 1020
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
1021

Laurent Aimar's avatar
Laurent Aimar committed
1022 1023 1024
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
1025

Laurent Aimar's avatar
Laurent Aimar committed
1026 1027
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
1028

Laurent Aimar's avatar
Laurent Aimar committed
1029 1030
    e->p_subpicture = NULL;
}
1031

Laurent Aimar's avatar
Laurent Aimar committed
1032
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
1033
{
Laurent Aimar's avatar
Laurent Aimar committed
1034
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
1035
    {
Laurent Aimar's avatar
Laurent Aimar committed
1036
        spu_heap_entry_t *e =