video_output.c 37.4 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * video_output.c : video output thread
3
 *
Michel Kaempf's avatar
Michel Kaempf committed
4 5
 * This module describes the programming interface for video output threads.
 * It includes functions allowing to open a new thread, send pictures to a
6 7
 * thread, and destroy a previously oppened video output thread.
 *****************************************************************************
8
 * Copyright (C) 2000-2007 the VideoLAN team
Gildas Bazin's avatar
Gildas Bazin committed
9
 * $Id$
10
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
11
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
12
 *          Gildas Bazin <gbazin@videolan.org>
13
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
14 15 16 17 18
 *
 * 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.
19
 *
20 21
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 23
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
24
 *
25 26
 * 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
27
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
29

30
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
31
 * Preamble
32
 *****************************************************************************/
33 34 35 36
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

37
#include <vlc_common.h>
38

39
#include <stdlib.h>                                                /* free() */
40
#include <string.h>
41
#include <assert.h>
Vincent Seguin's avatar
Vincent Seguin committed
42

Clément Stenac's avatar
Clément Stenac committed
43
#include <vlc_vout.h>
44

Clément Stenac's avatar
Clément Stenac committed
45 46 47
#include <vlc_filter.h>
#include <vlc_osd.h>

48 49
#include <libvlc.h>
#include <vlc_input.h>
50
#include "vout_pictures.h"
Laurent Aimar's avatar
Laurent Aimar committed
51
#include "vout_internal.h"
52 53
#include "interlacing.h"
#include "postprocessing.h"
54

55
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
56
 * Local prototypes
57
 *****************************************************************************/
58 59
static void     *Thread(void *);
static void     vout_Destructor(vlc_object_t *);
60

Gildas Bazin's avatar
 
Gildas Bazin committed
61
/* Object variables callbacks */
62 63
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
64 65
static int VideoFilter2Callback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
66

67 68 69
/* Display media title in OSD */
static void DisplayTitleOnOSD( vout_thread_t *p_vout );

70 71 72 73 74 75 76
/* */
static void PrintVideoFormat(vout_thread_t *, const char *, const video_format_t *);

/* Maximum delay between 2 displayed pictures.
 * XXX it is needed for now but should be removed in the long term.
 */
#define VOUT_REDISPLAY_DELAY (INT64_C(80000))
77

78 79 80 81
/**
 * Late pictures having a delay higher than this value are thrashed.
 */
#define VOUT_DISPLAY_LATE_THRESHOLD (INT64_C(20000))
82 83

/* Better be in advance when awakening than late... */
84
#define VOUT_MWAIT_TOLERANCE (INT64_C(1000))
85

86 87 88 89 90
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
91
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
92
    return picture_pool_Get(p_vout->p->private_pool);
93 94 95 96
}

static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
{
97
    VLC_UNUSED(p_filter);
98
    picture_Release(p_pic);
99 100 101 102
}

static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
{
103 104
    p_filter->pf_video_buffer_new = video_new_buffer_filter;
    p_filter->pf_video_buffer_del = video_del_buffer_filter;
105 106
    p_filter->p_owner = p_data; /* p_vout */
    return VLC_SUCCESS;
107 108
}

109
#undef vout_Request
110
/*****************************************************************************
111 112 113 114 115
 * vout_Request: find a video output thread, create one, or destroy one.
 *****************************************************************************
 * This function looks for a video output thread matching the current
 * properties. If not found, it spawns a new one.
 *****************************************************************************/
116 117
vout_thread_t *vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                             video_format_t *p_fmt )
118
{
119
    if( !p_fmt )
120
    {
121 122 123
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
124
        if( p_vout )
125
            vout_CloseAndRelease( p_vout );
126 127 128 129 130 131
        return NULL;
    }

    /* If a video output was provided, lock it, otherwise look for one. */
    if( p_vout )
    {
132
        vlc_object_hold( p_vout );
133 134
    }

135
    /* TODO: find a suitable unused video output */
136 137 138 139

    /* If we now have a video output, check it has the right properties */
    if( p_vout )
    {
140
        vlc_mutex_lock( &p_vout->p->change_lock );
141

142
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
143
         * performance reasons. */
144
        if( p_vout->p->b_filter_change )
Gildas Bazin's avatar
 
Gildas Bazin committed
145
        {
146
            char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
147

148
            if( psz_filter_chain && !*psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
149 150 151 152
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
153
            if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
154
            {
155 156
                free( p_vout->p->psz_filter_chain );
                p_vout->p->psz_filter_chain = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
157 158
            }

159
            if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
160
            {
161
                p_vout->p->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
162 163
            }

164
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
165 166
        }

167 168
#warning "FIXME: Check RGB masks in vout_Request"
        /* FIXME: check RGB masks */
169
        if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
170 171
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
172
            p_vout->p->b_filter_change )
173
        {
174
            vlc_mutex_unlock( &p_vout->p->change_lock );
175

176
            /* We are not interested in this format, close this vout */
177
            vout_CloseAndRelease( p_vout );
178
            vlc_object_release( p_vout );
179 180 181 182 183
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
184 185 186 187 188 189
            /* Correct aspect ratio on change
             * FIXME factorize this code with other aspect ration related code */
            unsigned int i_sar_num;
            unsigned int i_sar_den;
            vlc_ureduce( &i_sar_num, &i_sar_den,
                         p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
190
#if 0
191 192 193 194 195 196
            /* What's that, it does not seems to be used correcly everywhere */
            if( p_vout->i_par_num > 0 && p_vout->i_par_den > 0 )
            {
                i_sar_num *= p_vout->i_par_den;
                i_sar_den *= p_vout->i_par_num;
            }
197 198
#endif

199 200 201 202 203 204 205 206 207
            if( i_sar_num > 0 && i_sar_den > 0 &&
                ( i_sar_num != p_vout->fmt_render.i_sar_num ||
                  i_sar_den != p_vout->fmt_render.i_sar_den ) )
            {
                p_vout->fmt_in.i_sar_num = i_sar_num;
                p_vout->fmt_in.i_sar_den = i_sar_den;

                p_vout->fmt_render.i_sar_num = i_sar_num;
                p_vout->fmt_render.i_sar_den = i_sar_den;
208
                p_vout->p->i_changes |= VOUT_ASPECT_CHANGE;
209
            }
210
            vlc_mutex_unlock( &p_vout->p->change_lock );
211 212 213 214 215 216 217 218

            vlc_object_release( p_vout );
        }

        if( p_vout )
        {
            msg_Dbg( p_this, "reusing provided vout" );

219
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
220
            vlc_object_detach( p_vout );
221

222
            vlc_object_attach( p_vout, p_this );
223
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
224 225 226 227 228 229 230
        }
    }

    if( !p_vout )
    {
        msg_Dbg( p_this, "no usable vout present, spawning one" );

231
        p_vout = vout_Create( p_this, p_fmt );
232 233 234 235 236 237 238
    }

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
239
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
240 241
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
242
 *****************************************************************************/
243
vout_thread_t * (vout_Create)( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
244
{
245 246
    vout_thread_t  *p_vout;                            /* thread descriptor */
    vlc_value_t     text;
Michel Kaempf's avatar
Michel Kaempf committed
247

248

249 250 251 252
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

253
    if( p_fmt->i_width <= 0 || p_fmt->i_height <= 0 )
254
        return NULL;
255
    const vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
256 257 258 259 260 261

    vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
                 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
    if( p_fmt->i_sar_num <= 0 || p_fmt->i_sar_den <= 0 )
        return NULL;

262
    /* Allocate descriptor */
263 264 265
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
266
    if( p_vout == NULL )
267
        return NULL;
268

269
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
270
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
271 272 273 274 275 276
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

277
    /* */
278 279
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
280

281 282
    p_vout->fmt_render.i_chroma = 
    p_vout->fmt_in.i_chroma     = i_chroma;
283 284 285
    video_format_FixRgb( &p_vout->fmt_render );
    video_format_FixRgb( &p_vout->fmt_in );

Gildas Bazin's avatar
 
Gildas Bazin committed
286
    /* Initialize misc stuff */
287 288
    p_vout->p->i_changes    = 0;
    p_vout->p->b_fullscreen = 0;
289
    vout_chrono_Init( &p_vout->p->render, 5, 10000 ); /* Arbitrary initial time */
290
    vout_statistic_Init( &p_vout->p->statistic );
291 292 293
    p_vout->p->b_filter_change = 0;
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
294
    p_vout->p->b_picture_empty = false;
295
    p_vout->p->displayed.date = VLC_TS_INVALID;
296
    p_vout->p->displayed.decoded = NULL;
297
    p_vout->p->displayed.timestamp = VLC_TS_INVALID;
298 299
    p_vout->p->displayed.qtype = QTYPE_NONE;
    p_vout->p->displayed.is_interlaced = false;
300

301
    p_vout->p->step.is_requested = false;
302 303 304 305 306
    p_vout->p->step.last         = VLC_TS_INVALID;
    p_vout->p->step.timestamp    = VLC_TS_INVALID;

    p_vout->p->pause.is_on  = false;
    p_vout->p->pause.date   = VLC_TS_INVALID;
307 308 309

    p_vout->p->decoder_fifo = picture_fifo_New();
    p_vout->p->decoder_pool = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
310

311 312
    vlc_mouse_Init( &p_vout->p->mouse );

313
    vout_snapshot_Init( &p_vout->p->snapshot );
314

Gildas Bazin's avatar
 
Gildas Bazin committed
315
    /* Initialize locks */
316
    vlc_mutex_init( &p_vout->p->picture_lock );
317
    vlc_cond_init( &p_vout->p->picture_wait );
318
    vlc_mutex_init( &p_vout->p->change_lock );
319
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
320

321 322
    /* Mouse coordinates */
    var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
323 324
    var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
    var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
325 326
    /* Mouse object (area of interest in a video filter) */
    var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
327

Gildas Bazin's avatar
 
Gildas Bazin committed
328 329 330
    /* Attach the new object now so we can use var inheritance below */
    vlc_object_attach( p_vout, p_parent );

331
    /* Initialize subpicture unit */
332
    p_vout->p->p_spu = spu_Create( p_vout );
333

334
    /* */
335
    spu_Init( p_vout->p->p_spu );
336

337
    spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
338

339 340
    p_vout->p->is_late_dropped = var_InheritBool( p_vout, "drop-late-frames" );

341 342
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
343

Laurent Aimar's avatar
Laurent Aimar committed
344 345 346
    /* Look for the default filter configuration */
    p_vout->p->psz_filter_chain =
        var_CreateGetStringCommand( p_vout, "vout-filter" );
347

Laurent Aimar's avatar
Laurent Aimar committed
348 349 350
    /* Apply video filter2 objects on the first vout */
    p_vout->p->psz_vf2 =
        var_CreateGetStringCommand( p_vout, "video-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
351

352
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
353
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
354
        false, video_filter_buffer_allocation_init, NULL, p_vout );
355

Gildas Bazin's avatar
 
Gildas Bazin committed
356
    /* Choose the video output module */
357
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
358
    {
359
        psz_parser = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
360 361 362
    }
    else
    {
363
        psz_parser = strdup( p_vout->p->psz_filter_chain );
364
        p_vout->p->title.show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
365 366
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
367
    /* Create the vout thread */
368
    char *psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
369
    free( psz_parser );
370
    free( psz_tmp );
371
    p_vout->p->p_cfg = p_cfg;
Laurent Aimar's avatar
Laurent Aimar committed
372 373 374 375 376 377 378 379

    /* Create a few object variables for interface interaction */
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    text.psz_string = _("Filters");
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );

    /* */
380
    vout_InitInterlacingSupport( p_vout, p_vout->p->displayed.is_interlaced );
Laurent Aimar's avatar
Laurent Aimar committed
381

382
    if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
383 384 385 386 387 388 389
    {
        char *psz_tmp;
        if( asprintf( &psz_tmp, "%s,none", psz_name ) < 0 )
            psz_tmp = strdup( "" );
        free( psz_name );
        psz_name = psz_tmp;
    }
390
    p_vout->p->psz_module_name = psz_name;
Laurent Aimar's avatar
Laurent Aimar committed
391 392

    /* */
393
    vlc_object_set_destructor( p_vout, vout_Destructor );
Gildas Bazin's avatar
 
Gildas Bazin committed
394

395
    /* */
396
    vlc_cond_init( &p_vout->p->change_wait );
397
    if( vlc_clone( &p_vout->p->thread, Thread, p_vout,
398
                   VLC_THREAD_PRIORITY_OUTPUT ) )
Michel Kaempf's avatar
Michel Kaempf committed
399
    {
400 401 402
        spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
        spu_Destroy( p_vout->p->p_spu );
        p_vout->p->p_spu = NULL;
403
        vlc_object_release( p_vout );
404 405 406
        return NULL;
    }

407
    vlc_mutex_lock( &p_vout->p->change_lock );
408 409 410 411
    while( !p_vout->p->b_ready )
    {   /* We are (ab)using the same condition in opposite directions for
         * b_ready and b_done. This works because of the strict ordering. */
        assert( !p_vout->p->b_done );
412
        vlc_cond_wait( &p_vout->p->change_wait, &p_vout->p->change_lock );
413
    }
414
    vlc_mutex_unlock( &p_vout->p->change_lock );
415

416
    if( p_vout->p->b_error )
417 418
    {
        msg_Err( p_vout, "video output creation failed" );
419
        vout_CloseAndRelease( p_vout );
420
        return NULL;
421
    }
Michel Kaempf's avatar
Michel Kaempf committed
422

423
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
424 425
}

426
/*****************************************************************************
427
 * vout_Close: Close a vout created by vout_Create.
428
 *****************************************************************************
429
 * You HAVE to call it on vout created by vout_Create before vlc_object_release.
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
430
 * You should NEVER call it on vout not obtained through vout_Create
431
 * (like with vout_Request or vlc_object_find.)
432
 * You can use vout_CloseAndRelease() as a convenience method.
433
 *****************************************************************************/
434
void vout_Close( vout_thread_t *p_vout )
435 436 437
{
    assert( p_vout );

438
    vlc_mutex_lock( &p_vout->p->change_lock );
439 440
    p_vout->p->b_done = true;
    vlc_cond_signal( &p_vout->p->change_wait );
441
    vlc_mutex_unlock( &p_vout->p->change_lock );
442

443
    vout_snapshot_End( &p_vout->p->snapshot );
444

445
    vlc_join( p_vout->p->thread, NULL );
446 447 448
}

/* */
449 450
static void vout_Destructor( vlc_object_t * p_this )
{
451
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
452

453
    /* Make sure the vout was stopped first */
454
    //assert( !p_vout->p_module );
455

456 457
    free( p_vout->p->psz_module_name );

Laurent Aimar's avatar
Laurent Aimar committed
458
    /* */
459 460
    if( p_vout->p->p_spu )
        spu_Destroy( p_vout->p->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
461

462 463 464 465 466 467
    vout_chrono_Clean( &p_vout->p->render );

    if( p_vout->p->decoder_fifo )
        picture_fifo_Delete( p_vout->p->decoder_fifo );
    assert( !p_vout->p->decoder_pool );

468
    /* Destroy the locks */
469
    vlc_cond_destroy( &p_vout->p->change_wait );
470
    vlc_cond_destroy( &p_vout->p->picture_wait );
471 472
    vlc_mutex_destroy( &p_vout->p->picture_lock );
    vlc_mutex_destroy( &p_vout->p->change_lock );
473
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
474

475 476 477
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

478
    /* */
479
    vout_snapshot_Clean( &p_vout->p->snapshot );
480 481

    /* */
482
    free( p_vout->p->psz_filter_chain );
483
    free( p_vout->p->title.value );
Gildas Bazin's avatar
 
Gildas Bazin committed
484

485
    config_ChainDestroy( p_vout->p->p_cfg );
486

487 488
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
489 490
}

Laurent Aimar's avatar
Laurent Aimar committed
491 492 493
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
494
    vlc_mutex_lock( &p_vout->p->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
495

496
    assert( !p_vout->p->pause.is_on || !b_paused );
497

498
    vlc_mutex_lock( &p_vout->p->picture_lock );
499

500
    if( p_vout->p->pause.is_on )
Laurent Aimar's avatar
Laurent Aimar committed
501
    {
502
        const mtime_t i_duration = i_date - p_vout->p->pause.date;
Laurent Aimar's avatar
Laurent Aimar committed
503

504 505 506 507 508 509 510
        if (p_vout->p->step.timestamp > VLC_TS_INVALID)
            p_vout->p->step.timestamp += i_duration;
        if (!b_paused)
            p_vout->p->step.last = p_vout->p->step.timestamp;
        picture_fifo_OffsetDate( p_vout->p->decoder_fifo, i_duration );
        if (p_vout->p->displayed.decoded)
            p_vout->p->displayed.decoded->date += i_duration;
Laurent Aimar's avatar
Laurent Aimar committed
511

512
        vlc_cond_signal( &p_vout->p->picture_wait );
513
        vlc_mutex_unlock( &p_vout->p->picture_lock );
514

515
        spu_OffsetSubtitleDate( p_vout->p->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
516
    }
517 518
    else
    {
519 520
        if (b_paused)
            p_vout->p->step.last = p_vout->p->step.timestamp;
521
        vlc_mutex_unlock( &p_vout->p->picture_lock );
522
    }
523 524
    p_vout->p->pause.is_on = b_paused;
    p_vout->p->pause.date  = i_date;
Laurent Aimar's avatar
Laurent Aimar committed
525

526
    vlc_mutex_unlock( &p_vout->p->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
527
}
528

529 530
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
531 532
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
533
}
534

Laurent Aimar's avatar
Laurent Aimar committed
535
static void Flush(vout_thread_t *vout, mtime_t date, bool reset, bool below)
Laurent Aimar's avatar
Laurent Aimar committed
536
{
537 538 539 540 541
    vlc_assert_locked(&vout->p->picture_lock);
    vout->p->step.timestamp = VLC_TS_INVALID;
    vout->p->step.last      = VLC_TS_INVALID;

    picture_t *last = vout->p->displayed.decoded;
Laurent Aimar's avatar
Laurent Aimar committed
542 543 544 545 546 547 548 549
    if (last) {
        if (reset) {
            picture_Release(last);
            vout->p->displayed.decoded = NULL;
        } else if (( below  && last->date <= date) ||
                   (!below && last->date >= date)) {
            vout->p->step.is_requested = true;
        }
Laurent Aimar's avatar
Laurent Aimar committed
550
    }
551
    picture_fifo_Flush( vout->p->decoder_fifo, date, below );
Laurent Aimar's avatar
Laurent Aimar committed
552
}
553

554
void vout_Flush(vout_thread_t *vout, mtime_t date)
555
{
556
    vlc_mutex_lock(&vout->p->picture_lock);
557

Laurent Aimar's avatar
Laurent Aimar committed
558
    Flush(vout, date, false, false);
559

560 561 562
    vlc_cond_signal(&vout->p->picture_wait);
    vlc_mutex_unlock(&vout->p->picture_lock);
}
563

564
void vout_Reset(vout_thread_t *vout)
565 566
{
    vlc_mutex_lock(&vout->p->picture_lock);
567

Laurent Aimar's avatar
Laurent Aimar committed
568
    Flush(vout, INT64_MAX, true, true);
569 570
    if (vout->p->decoder_pool)
        picture_pool_NonEmpty(vout->p->decoder_pool, true);
571 572 573
    vout->p->pause.is_on = false;
    vout->p->pause.date  = mdate();

574 575 576
    vlc_cond_signal( &vout->p->picture_wait );
    vlc_mutex_unlock(&vout->p->picture_lock);
}
577

578
void vout_FixLeaks( vout_thread_t *vout )
579 580 581 582 583 584
{
    vlc_mutex_lock(&vout->p->picture_lock);

    picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
    if (!picture) {
        picture = picture_pool_Get(vout->p->decoder_pool);
585
    }
586 587 588 589 590 591

    if (picture) {
        picture_Release(picture);
        /* Not all pictures has been displayed yet or some are
         * free */
        vlc_mutex_unlock(&vout->p->picture_lock);
592 593 594
        return;
    }

595 596 597
    /* There is no reason that no pictures are available, force one
     * from the pool, becarefull with it though */
    msg_Err(vout, "pictures leaked, trying to workaround");
598

599 600
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
601

602 603
    vlc_cond_signal(&vout->p->picture_wait);
    vlc_mutex_unlock(&vout->p->picture_lock);
604
}
605
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
606
{
607
    vlc_mutex_lock(&vout->p->picture_lock);
608

609 610
    vout->p->b_picture_empty = false;
    vout->p->step.is_requested = true;
611

612 613
    /* FIXME I highly doubt that it can works with only one cond_t FIXME */
    vlc_cond_signal(&vout->p->picture_wait);
614

615 616
    while (vout->p->step.is_requested && !vout->p->b_picture_empty)
        vlc_cond_wait(&vout->p->picture_wait, &vout->p->picture_lock);
617

618 619 620 621 622 623 624
    if (vout->p->step.last > VLC_TS_INVALID &&
        vout->p->step.timestamp > vout->p->step.last) {
        *duration = vout->p->step.timestamp - vout->p->step.last;
        vout->p->step.last = vout->p->step.timestamp;
    } else {
        *duration = 0;
    }
625 626

    /* TODO advance subpicture by the duration ... */
627
    vlc_mutex_unlock(&vout->p->picture_lock);
628
}
629

630 631 632 633
void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
{
    assert( psz_title );

634
    if( !var_InheritBool( p_vout, "osd" ) )
635 636
        return;

637
    vlc_mutex_lock( &p_vout->p->change_lock );
638 639
    free( p_vout->p->title.value );
    p_vout->p->title.value = strdup( psz_title );
640
    vlc_mutex_unlock( &p_vout->p->change_lock );
641
}
642

643 644
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
645
    return p_vout->p->p_spu;
646 647
}

648
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
649
 * InitThread: initialize video output thread
650
 *****************************************************************************
651
 * This function is called from Thread and performs the second step of the
Sam Hocevar's avatar
 
Sam Hocevar committed
652 653
 * initialization. It returns 0 on success. Note that the thread's flag are not
 * modified inside this function.
654
 * XXX You have to enter it with change_lock taken.
655
 *****************************************************************************/
656
static int ThreadInit(vout_thread_t *vout)
Vincent Seguin's avatar
Vincent Seguin committed
657
{
Sam Hocevar's avatar
 
Sam Hocevar committed
658
    /* Initialize output method, it allocates direct buffers for us */
659
    if (vout_InitWrapper(vout))
660
        return VLC_EGENERIC;
661
    assert(vout->p->decoder_pool);
Sam Hocevar's avatar
 
Sam Hocevar committed
662

663
    vout->p->displayed.decoded = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
664

basos g's avatar
basos g committed
665 666
    /* print some usefull debug info about different vout formats
     */
667 668 669
    PrintVideoFormat(vout, "pic render", &vout->fmt_render);
    PrintVideoFormat(vout, "pic in",     &vout->fmt_in);
    PrintVideoFormat(vout, "pic out",    &vout->fmt_out);
Laurent Aimar's avatar
Laurent Aimar committed
670

671 672 673
    assert(vout->fmt_out.i_width  == vout->fmt_render.i_width &&
           vout->fmt_out.i_height == vout->fmt_render.i_height &&
           vout->fmt_out.i_chroma == vout->fmt_render.i_chroma);
674
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
675 676
}

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
/*****************************************************************************
 * CleanThread: clean up after InitThread
 *****************************************************************************
 * This function is called after a sucessful
 * initialization. It frees all resources allocated by InitThread.
 * XXX You have to enter it with change_lock taken.
 *****************************************************************************/
static void ThreadClean(vout_thread_t *vout)
{
    /* Destroy translation tables */
    if (!vout->p->b_error) {
        picture_fifo_Flush(vout->p->decoder_fifo, INT64_MAX, false);
        vout_EndWrapper(vout);
    }
}

693 694
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
695
{
696 697 698 699 700
    int displayed_count = 0;
    int lost_count = 0;

    for (;;) {
        const mtime_t date = mdate();
701
        const bool is_paused = vout->p->pause.is_on;
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
        bool redisplay = is_paused && !now;
        bool is_forced;

        /* FIXME/XXX we must redisplay the last decoded picture (because
         * of potential vout updated, or filters update or SPU update)
         * For now a high update period is needed but it coulmd be removed
         * if and only if:
         * - vout module emits events from theselves.
         * - *and* SPU is modified to emit an event or a deadline when needed.
         *
         * So it will be done latter.
         */
        if (!redisplay) {
            picture_t *peek = picture_fifo_Peek(vout->p->decoder_fifo);
            if (peek) {
                is_forced = peek->b_force || is_paused || now;
                *deadline = (is_forced ? date : peek->date) - vout_chrono_GetHigh(&vout->p->render);
                picture_Release(peek);
            } else {
                redisplay = true;
722 723
            }
        }
724 725
        if (redisplay) {
             /* FIXME a better way for this delay is needed */
726
            const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
727 728 729
            if (date_update > date || !vout->p->displayed.decoded) {
                *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
                break;
730
            }
731 732 733
            /* */
            is_forced = true;
            *deadline = date - vout_chrono_GetHigh(&vout->p->render);
734
        }
735 736
        if (*deadline > VOUT_MWAIT_TOLERANCE)
            *deadline -= VOUT_MWAIT_TOLERANCE;
737

738
        /* If we are too early and can wait, do it */
739 740
        if (date < *deadline && !now)
            break;
741

742 743 744 745 746 747 748 749 750 751 752 753
        picture_t *decoded;
        if (redisplay) {
            decoded = vout->p->displayed.decoded;
            vout->p->displayed.decoded = NULL;
        } else {
            decoded = picture_fifo_Pop(vout->p->decoder_fifo);
            assert(decoded);
            if (!is_forced && !vout->p->is_late_dropped) {
                const mtime_t predicted = date + vout_chrono_GetLow(&vout->p->render);
                const mtime_t late = predicted - decoded->date;
                if (late > 0) {
                    msg_Dbg(vout, "picture might be displayed late (missing %d ms)", (int)(late/1000));
754
                    if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
755 756 757 758 759
                        msg_Warn(vout, "rejected picture because of render time");
                        /* TODO */
                        picture_Release(decoded);
                        lost_count++;
                        break;
760 761 762
                    }
                }
            }
763 764 765

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
766
        }
767
        vout->p->displayed.timestamp = decoded->date;
768 769

        /* */
770 771 772 773
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
774

775 776
        /* */
        vout_chrono_Start(&vout->p->render);
777

778 779 780 781 782 783 784 785
        picture_t *filtered = NULL;
        if (decoded) {
            vlc_mutex_lock(&vout->p->vfilter_lock);
            filtered = filter_chain_VideoFilter(vout->p->p_vf2_chain, decoded);
            //assert(filtered == decoded); // TODO implement
            vlc_mutex_unlock(&vout->p->vfilter_lock);
            if (!filtered)
                continue;
786
        }
787

Sam Hocevar's avatar
 
Sam Hocevar committed
788 789 790
        /*
         * Check for subpictures to display
         */
791 792
        const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
        mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
793 794
        if (vout->p->pause.is_on)
            spu_render_time = vout->p->pause.date;
795
        else
796
            spu_render_time = filtered->date > 1 ? filtered->date : mdate();
797

798 799 800
        subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
                                                   spu_render_time,
                                                   do_snapshot);
Sam Hocevar's avatar
 
Sam Hocevar committed
801 802
        /*
         * Perform rendering
803 804 805 806
         *
         * We have to:
         * - be sure to end up with a direct buffer.
         * - blend subtitles, and in a fast access buffer
Sam Hocevar's avatar
 
Sam Hocevar committed
807
         */
808 809 810 811 812 813 814 815 816 817
        picture_t *direct = NULL;
        if (filtered &&
            (vout->p->decoder_pool != vout->p->display_pool || subpic)) {
            picture_t *render;
            if (vout->p->is_decoder_pool_slow)
                render = picture_NewFromFormat(&vout->fmt_out);
            else if (vout->p->decoder_pool != vout->p->display_pool)
                render = picture_pool_Get(vout->p->display_pool);
            else
                render = picture_pool_Get(vout->p->private_pool);
Sam Hocevar's avatar
 
Sam Hocevar committed
818

819 820
            if (render) {
                picture_Copy(render, filtered);
821

822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
                spu_RenderSubpictures(vout->p->p_spu,
                                      render, &vout->fmt_out,
                                      subpic, &vout->fmt_in, spu_render_time);
            }
            if (vout->p->is_decoder_pool_slow) {
                direct = picture_pool_Get(vout->p->display_pool);
                if (direct)
                    picture_Copy(direct, render);
                picture_Release(render);

            } else {
                direct = render;
            }
            picture_Release(filtered);
            filtered = NULL;
        } else {
            direct = filtered;
Sam Hocevar's avatar
 
Sam Hocevar committed
839 840
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
841
        /*
842
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
843
         */
844 845
        if (direct && do_snapshot)
            vout_snapshot_Set(&vout->p->snapshot, &vout->fmt_out, direct);
846

847 848 849
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
850

851 852
            vout_chrono_Stop(&vout->p->render);
#if 0
Gildas Bazin's avatar
 
Gildas Bazin committed
853
            {
854 855 856 857
            static int i = 0;
            if (((i++)%10) == 0)
                msg_Info(vout, "render: avg %d ms var %d ms",
                         (int)(vout->p->render.avg/1000), (int)(vout->p->render.var/1000));
Gildas Bazin's avatar
 
Gildas Bazin committed
858
            }
859
#endif
860
        }
861

862 863 864
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
865

866
        /* Display the direct buffer returned by vout_RenderPicture */
867
        vout->p->displayed.date = mdate();
868 869
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
870

871 872 873
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
874

875 876 877 878 879
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
880

881
/*****************************************************************************
882
 * Thread: video output thread
883 884 885 886 887
 *****************************************************************************
 * Video output thread. This function does only returns when the thread is
 * terminated. It handles the pictures arriving in the video heap and the
 * display device events.
 *****************************************************************************/
888
static void *Thread(void *object)
889 890 891
{
    vout_thread_t *vout = object;
    bool          has_wrapper;
892

893 894 895 896
    /*
     * Initialize thread
     */
    has_wrapper = !vout_OpenWrapper(vout, vout->p->psz_module_name);
Gildas Bazin's avatar
 
Gildas Bazin committed
897

898
    vlc_mutex_lock(&vout->p->change_lock);
899

900
    if (has_wrapper)
901
        vout->p->b_error = ThreadInit(vout);
902 903
    else
        vout->p->b_error = true;
904

905 906 907 908 909 910
    /* signal the creation of the vout */
    vout->p->b_ready = true;
    vlc_cond_signal(&vout->p->change_wait);

    if (vout->p->b_error)
        goto exit_thread;
911

912
    /* */