vout_subpictures.c 60.9 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2007 the VideoLAN team
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6 7 8
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
9
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
24 25 26 27 28
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
29 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
34 35 36 37
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
#include <vlc_osd.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
38
#include "../libvlc.h"
Laurent Aimar's avatar
Laurent Aimar committed
39
#include "vout_internal.h"
40
#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 MarginCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
161

162
static int SpuControl( spu_t *, int, va_list );
163

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

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

172
/* Buffer aloccation fir SUB filter */
173 174 175
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

176 177
static int SubFilterAllocationInit( filter_t *, void * );
static void SubFilterAllocationClean( filter_t * );
178

179
/* */
Laurent Aimar's avatar
Laurent Aimar committed
180 181
static void SpuRenderCreateAndLoadText( spu_t * );
static void SpuRenderCreateAndLoadScale( spu_t * );
182
static void FilterRelease( filter_t *p_filter );
183

Laurent Aimar's avatar
Laurent Aimar committed
184 185 186
/*****************************************************************************
 * Public API
 *****************************************************************************/
187 188

#undef spu_Create
189
/**
190
 * Creates the subpicture unit
191
 *
192
 * \param p_this the parent object which creates the subpicture unit
193
 */
194
spu_t *spu_Create( vlc_object_t *p_this )
195
{
196 197
    spu_t *p_spu;
    spu_private_t *p_sys;
Laurent Aimar's avatar
Laurent Aimar committed
198
 
199 200 201 202 203 204 205 206 207 208 209
    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 */
210 211 212 213
    vlc_mutex_init( &p_sys->lock );

    SpuHeapInit( &p_sys->heap );

214 215 216 217
    p_sys->p_blend = NULL;
    p_sys->p_text = NULL;
    p_sys->p_scale = NULL;
    p_sys->p_scale_yuvp = NULL;
218

219
    p_sys->i_margin = var_InheritInteger( p_spu, "sub-margin" );
220

221
    /* Register the default subpicture channel */
222
    p_sys->i_channel = 2;
223 224 225

    vlc_object_attach( p_spu, p_this );

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

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

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

239 240 241 242 243 244 245 246 247 248 249
    return p_spu;
}

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

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

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

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

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

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

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

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

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

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

    vlc_mutex_destroy( &p_sys->lock );
286

287
    vlc_object_release( p_spu );
288 289
}

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

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

    if( b_attach )
305
    {
306 307
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
308
        var_AddCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
309 310 311 312 313

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

314 315 316 317 318
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
319
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
320
        var_DelCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
321 322 323 324
        vlc_object_release( p_input );
    }
}

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

337
    /* DEFAULT_CHAN always reset itself */
338
    if( p_subpic->i_channel == DEFAULT_CHAN )
Joseph Tulou's avatar
Joseph Tulou committed
339
        SpuClearChannel( p_spu, DEFAULT_CHAN );
340 341 342 343 344 345 346 347

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

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

368
    const mtime_t render_osd_date = mdate();
369

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
381
    vlc_mutex_lock( &p_sys->lock );
382

Laurent Aimar's avatar
Laurent Aimar committed
383 384 385 386 387 388 389
    /* 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 )
    {
390
        if( p_subpic->pf_update_regions )
Laurent Aimar's avatar
Laurent Aimar committed
391 392 393 394 395 396
        {
            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;
397

398
            p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org,
399
                                         p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
Laurent Aimar's avatar
Laurent Aimar committed
400
        }
401

Laurent Aimar's avatar
Laurent Aimar committed
402 403 404 405 406 407
        /* */
        if( p_subpic->b_subtitle )
        {
            for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
                i_subtitle_region_count++;
        }
408

Laurent Aimar's avatar
Laurent Aimar committed
409 410 411
        /* */
        pp_subpicture[i_subpicture++] = p_subpic;
    }
412

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

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

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

Laurent Aimar's avatar
Laurent Aimar committed
430 431
    /* Create the blending module */
    if( !p_sys->p_blend )
432
        p_spu->p->p_blend = filter_NewBlend( VLC_OBJECT(p_spu), p_fmt_dst );
433

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

Laurent Aimar's avatar
Laurent Aimar committed
440 441
        if( !p_subpic->p_region )
            continue;
442

Laurent Aimar's avatar
Laurent Aimar committed
443 444 445 446 447 448 449 450 451
        /* 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 );
452

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

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

Laurent Aimar's avatar
Laurent Aimar committed
462 463 464
            p_sys->p_text->fmt_out.video.i_height         =
            p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
        }
465

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

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

Laurent Aimar's avatar
Laurent Aimar committed
474 475 476 477 478 479
        /* 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
480 481
            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
482
        }
483

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

Laurent Aimar's avatar
Laurent Aimar committed
494 495 496 497 498 499 500
        /* 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;
501

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

Laurent Aimar's avatar
Laurent Aimar committed
506 507 508
            /* */
            SpuRenderRegion( p_spu, p_pic_dst, &area,
                             p_subpic, p_region, scale, p_fmt_dst,
509
                             p_subtitle_area, i_subtitle_area,
510
                             p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
511

Laurent Aimar's avatar
Laurent Aimar committed
512 513 514
            if( p_subpic->b_subtitle )
            {
                area = spu_area_unscaled( area, scale );
515 516 517 518 519
                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
520 521 522 523
                if( p_subtitle_area )
                    p_subtitle_area[i_subtitle_area++] = area;
            }
        }
524 525
        if( p_subpic->b_subtitle )
            p_subpic->b_absolute = true;
Laurent Aimar's avatar
Laurent Aimar committed
526
    }
527

Laurent Aimar's avatar
Laurent Aimar committed
528 529 530
    /* */
    if( p_subtitle_area != p_subtitle_area_buffer )
        free( p_subtitle_area );
531

Laurent Aimar's avatar
Laurent Aimar committed
532
    vlc_mutex_unlock( &p_sys->lock );
533 534
}

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

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

Laurent Aimar's avatar
Laurent Aimar committed
571
    vlc_mutex_lock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
572

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

581
        mtime_t      start_date = render_subtitle_date;
582
        mtime_t      ephemer_subtitle_date = 0;
583
        mtime_t      ephemer_osd_date = 0;
584 585
        int64_t      i_ephemer_subtitle_order = INT64_MIN;
        int64_t      i_ephemer_system_order = INT64_MIN;
Laurent Aimar's avatar
Laurent Aimar committed
586 587
        int i_index;

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

            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;
            }
608
            const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
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
            mtime_t *pi_ephemer_date  = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
617 618 619
            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 )
            {
620
                *pi_ephemer_date = p_current->i_start;
621 622 623
                if( p_current->i_order > *pi_ephemer_order )
                    *pi_ephemer_order = p_current->i_order;
            }
Laurent Aimar's avatar
Laurent Aimar committed
624

625
            b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
626

627
            b_late = b_stop_valid && p_current->i_stop <= render_date;
628 629

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

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

653 654
            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;
655
            const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
656

657 658 659
            /* 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
660
            {
661 662 663 664 665
                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
666
            }
667 668 669

            if( b_rejet )
                SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
670
            else
671
                SubpictureChain( &p_subpic, p_current );
Laurent Aimar's avatar
Laurent Aimar committed
672
        }
Laurent Aimar's avatar
Laurent Aimar committed
673
    }
674

675
    p_sys->i_last_sort_date = render_subtitle_date;
Laurent Aimar's avatar
Laurent Aimar committed
676
    vlc_mutex_unlock( &p_sys->lock );
Laurent Aimar's avatar
Laurent Aimar committed
677

Laurent Aimar's avatar
Laurent Aimar committed
678
    return p_subpic;
Laurent Aimar's avatar
Laurent Aimar committed
679 680
}

Laurent Aimar's avatar
Laurent Aimar committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
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
702 703 704
/*****************************************************************************
 * subpicture_t allocation
 *****************************************************************************/
705
subpicture_t *subpicture_New( void )
706
{
Laurent Aimar's avatar
Laurent Aimar committed
707 708 709
    subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
    if( !p_subpic )
        return NULL;
710

Laurent Aimar's avatar
Laurent Aimar committed
711 712 713 714 715 716 717 718 719 720
    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_destroy = NULL;
    p_subpic->p_sys      = NULL;

    return p_subpic;
721
}
Laurent Aimar's avatar
Laurent Aimar committed
722

723
void subpicture_Delete( subpicture_t *p_subpic )
724
{
Laurent Aimar's avatar
Laurent Aimar committed
725 726 727 728 729 730 731 732
    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 );
733
}
Laurent Aimar's avatar
Laurent Aimar committed
734 735

static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
736
{
Laurent Aimar's avatar
Laurent Aimar committed
737 738 739
    p_subpic->p_next = *pp_head;

    *pp_head = p_subpic;
740
}
Laurent Aimar's avatar
Laurent Aimar committed
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 783 784 785 786 787 788 789 790
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_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
791 792 793 794
/*****************************************************************************
 * subpicture_region_t allocation
 *****************************************************************************/
subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
795
{
Laurent Aimar's avatar
Laurent Aimar committed
796 797 798
    subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
    if( !p_region )
        return NULL;
799

Laurent Aimar's avatar
Laurent Aimar committed
800 801
    p_region->fmt = *p_fmt;
    p_region->fmt.p_palette = NULL;
802
    if( p_fmt->i_chroma == VLC_CODEC_YUVP )
Laurent Aimar's avatar
Laurent Aimar committed
803 804 805 806 807 808 809 810 811 812 813
    {
        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;
814

815
    if( p_fmt->i_chroma == VLC_CODEC_TEXT )
Laurent Aimar's avatar
Laurent Aimar committed
816
        return p_region;
817

818
    p_region->p_picture = picture_NewFromFormat( p_fmt );
Laurent Aimar's avatar
Laurent Aimar committed
819 820 821 822 823 824
    if( !p_region->p_picture )
    {
        free( p_fmt->p_palette );
        free( p_region );
        return NULL;
    }
825

Laurent Aimar's avatar
Laurent Aimar committed
826
    return p_region;
827
}
Laurent Aimar's avatar
Laurent Aimar committed
828 829 830

/* */
void subpicture_region_Delete( subpicture_region_t *p_region )
831
{
Laurent Aimar's avatar
Laurent Aimar committed
832 833
    if( !p_region )
        return;
834

Laurent Aimar's avatar
Laurent Aimar committed
835 836
    if( p_region->p_private )
        SpuRegionPrivateDelete( p_region->p_private );
837

Laurent Aimar's avatar
Laurent Aimar committed
838 839
    if( p_region->p_picture )
        picture_Release( p_region->p_picture );
840

Laurent Aimar's avatar
Laurent Aimar committed
841 842 843 844
    free( p_region->fmt.p_palette );

    free( p_region->psz_text );
    free( p_region->psz_html );
basOS G's avatar
basOS G committed
845 846
    if( p_region->p_style )
        text_style_Delete( p_region->p_style );
Laurent Aimar's avatar
Laurent Aimar committed
847
    free( p_region );
848 849
}

Laurent Aimar's avatar
Laurent Aimar committed
850 851 852 853 854 855
/* */
void subpicture_region_ChainDelete( subpicture_region_t *p_head )
{
    while( p_head )
    {
        subpicture_region_t *p_next = p_head->p_next;
856

Laurent Aimar's avatar
Laurent Aimar committed
857
        subpicture_region_Delete( p_head );
858

Laurent Aimar's avatar
Laurent Aimar committed
859 860
        p_head = p_next;
    }
861 862 863 864
}



Laurent Aimar's avatar
Laurent Aimar committed
865 866 867 868
/*****************************************************************************
 * heap managment
 *****************************************************************************/
static void SpuHeapInit( spu_heap_t *p_heap )
869
{
Laurent Aimar's avatar
Laurent Aimar committed
870 871 872
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
    {
        spu_heap_entry_t *e = &p_heap->p_entry[i];
873

Laurent Aimar's avatar
Laurent Aimar committed
874 875 876 877
        e->p_subpicture = NULL;
        e->b_reject = false;
    }
}
878

Laurent Aimar's avatar
Laurent Aimar committed
879 880 881
static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
882
    {
Laurent Aimar's avatar
Laurent Aimar committed
883
        spu_heap_entry_t *e = &p_heap->p_entry[i];
884

Laurent Aimar's avatar
Laurent Aimar committed
885 886
        if( e->p_subpicture )
            continue;
887

Laurent Aimar's avatar
Laurent Aimar committed
888 889 890 891 892 893
        e->p_subpicture = p_subpic;
        e->b_reject = false;
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}
894

Laurent Aimar's avatar
Laurent Aimar committed
895 896 897
static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
{
    spu_heap_entry_t *e = &p_heap->p_entry[i_index];
898

Laurent Aimar's avatar
Laurent Aimar committed
899 900
    if( e->p_subpicture )
        subpicture_Delete( e->p_subpicture );
901

Laurent Aimar's avatar
Laurent Aimar committed
902 903
    e->p_subpicture = NULL;
}
904

Laurent Aimar's avatar
Laurent Aimar committed
905
static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
Laurent Aimar's avatar
Laurent Aimar committed
906
{
Laurent Aimar's avatar
Laurent Aimar committed
907
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
908
    {
Laurent Aimar's avatar
Laurent Aimar committed
909
        spu_heap_entry_t *e = &p_heap->p_entry[i];
Laurent Aimar's avatar
Laurent Aimar committed
910

Laurent Aimar's avatar
Laurent Aimar committed
911 912 913 914 915
        if( e->p_subpicture != p_subpic )
            continue;

        SpuHeapDeleteAt( p_heap, i );
        return VLC_SUCCESS;
Laurent Aimar's avatar
Laurent Aimar committed
916
    }
Laurent Aimar's avatar
Laurent Aimar committed
917 918
    return VLC_EGENERIC;
}
Laurent Aimar's avatar
Laurent Aimar committed
919

Laurent Aimar's avatar
Laurent Aimar committed
920 921 922
static void SpuHeapClean( spu_heap_t *p_heap )
{
    for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
Laurent Aimar's avatar
Laurent Aimar committed
923
    {
Laurent Aimar's avatar
Laurent Aimar committed
924 925 926
        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
927
    }
Laurent Aimar's avatar
Laurent Aimar committed
928
}
929

Laurent Aimar's avatar
Laurent Aimar committed
930 931 932
static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
{
    subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
933

Laurent Aimar's avatar
Laurent Aimar committed
934 935
    if( !p_private )
        return NULL;
936

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

Laurent Aimar's avatar
Laurent Aimar committed
946 947 948 949 950 951 952 953
    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
954 955
}

Laurent Aimar's avatar
Laurent Aimar committed
956
static void FilterRelease( filter_t *p_filter )
957
{
Laurent Aimar's avatar
Laurent Aimar committed
958 959
    if( p_filter->p_module )
        module_unneed( p_filter, p_filter->p_module );
960

Laurent Aimar's avatar
Laurent Aimar committed
961
    vlc_object_release( p_filter );
962 963
}

Laurent Aimar's avatar
Laurent Aimar committed
964 965 966
static void SpuRenderCreateAndLoadText( spu_t *p_spu )
{
    filter_t *p_text;
967

Laurent Aimar's avatar
Laurent Aimar committed