video_output.c 39.5 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
#include "display.h"
55

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

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

68 69 70 71 72 73 74
/* */
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))
75

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

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

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

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

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

107
#undef vout_Request
108
/*****************************************************************************
109 110 111 112 113
 * 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.
 *****************************************************************************/
114 115
vout_thread_t *vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                             video_format_t *p_fmt )
116
{
117
    if( !p_fmt )
118
    {
119 120 121
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
122
        if( p_vout )
123
            vout_CloseAndRelease( p_vout );
124 125 126 127 128 129
        return NULL;
    }

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

133
    /* TODO: find a suitable unused video output */
134 135 136 137

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

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

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

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

162
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
163 164
        }

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

174
            /* We are not interested in this format, close this vout */
175
            vout_CloseAndRelease( p_vout );
176
            vlc_object_release( p_vout );
177 178 179 180 181
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
182 183 184 185 186 187
            /* 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 );
188
#if 0
189 190 191 192 193 194
            /* 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;
            }
195 196
#endif

197 198 199 200 201 202 203 204 205
            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;
206
                p_vout->p->i_changes |= VOUT_ASPECT_CHANGE;
207
            }
208
            vlc_mutex_unlock( &p_vout->p->change_lock );
209 210 211 212 213 214 215 216

            vlc_object_release( p_vout );
        }

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

217
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
218
            vlc_object_detach( p_vout );
219

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

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

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

    return p_vout;
}

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

246

247 248 249 250
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

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

    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;

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

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

275
    /* */
276 277
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
278

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

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

    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;
303 304 305

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

307 308
    vlc_mouse_Init( &p_vout->p->mouse );

309
    vout_snapshot_Init( &p_vout->p->snapshot );
310

311 312 313
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
        false, video_filter_buffer_allocation_init, NULL, p_vout );

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

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

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

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

332
    /* */
333
    spu_Init( p_vout->p->p_spu );
334

335
    spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
336

337 338
    p_vout->p->is_late_dropped = var_InheritBool( p_vout, "drop-late-frames" );

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

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

Laurent Aimar's avatar
Laurent Aimar committed
346
    /* Apply video filter2 objects on the first vout */
347 348
    var_Create( p_vout, "video-filter",
                VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
349
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
350
    var_TriggerCallback( p_vout, "video-filter" );
351

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

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

    /* 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 );

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

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

    /* */
389
    vlc_object_set_destructor( p_vout, vout_Destructor );
Gildas Bazin's avatar
 
Gildas Bazin committed
390

391
    /* */
392
    vlc_cond_init( &p_vout->p->change_wait );
393
    if( vlc_clone( &p_vout->p->thread, Thread, p_vout,
394
                   VLC_THREAD_PRIORITY_OUTPUT ) )
Michel Kaempf's avatar
Michel Kaempf committed
395
    {
396 397 398
        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;
399
        vlc_object_release( p_vout );
400 401 402
        return NULL;
    }

403
    vlc_mutex_lock( &p_vout->p->change_lock );
404 405 406 407
    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 );
408
        vlc_cond_wait( &p_vout->p->change_wait, &p_vout->p->change_lock );
409
    }
410
    vlc_mutex_unlock( &p_vout->p->change_lock );
411

412
    if( p_vout->p->b_error )
413 414
    {
        msg_Err( p_vout, "video output creation failed" );
415
        vout_CloseAndRelease( p_vout );
416
        return NULL;
417
    }
Michel Kaempf's avatar
Michel Kaempf committed
418

419
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
420 421
}

422
/*****************************************************************************
423
 * vout_Close: Close a vout created by vout_Create.
424
 *****************************************************************************
425
 * 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
426
 * You should NEVER call it on vout not obtained through vout_Create
427
 * (like with vout_Request or vlc_object_find.)
428
 * You can use vout_CloseAndRelease() as a convenience method.
429
 *****************************************************************************/
430
void vout_Close( vout_thread_t *p_vout )
431 432 433
{
    assert( p_vout );

434
    vlc_mutex_lock( &p_vout->p->change_lock );
435 436
    p_vout->p->b_done = true;
    vlc_cond_signal( &p_vout->p->change_wait );
437
    vlc_mutex_unlock( &p_vout->p->change_lock );
438

439
    vout_snapshot_End( &p_vout->p->snapshot );
440

441
    vlc_join( p_vout->p->thread, NULL );
442 443 444
}

/* */
445 446
static void vout_Destructor( vlc_object_t * p_this )
{
447
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
448

449
    /* Make sure the vout was stopped first */
450
    //assert( !p_vout->p_module );
451

452 453
    free( p_vout->p->psz_module_name );

Laurent Aimar's avatar
Laurent Aimar committed
454
    /* */
455 456
    if( p_vout->p->p_spu )
        spu_Destroy( p_vout->p->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
457

458 459 460 461 462 463
    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 );

464
    /* Destroy the locks */
465
    vlc_cond_destroy( &p_vout->p->change_wait );
466 467
    vlc_mutex_destroy( &p_vout->p->picture_lock );
    vlc_mutex_destroy( &p_vout->p->change_lock );
468
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
469
    vout_control_Clean( &p_vout->p->control );
470

471 472 473
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

474
    /* */
475
    vout_snapshot_Clean( &p_vout->p->snapshot );
476 477

    /* */
478
    free( p_vout->p->psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
479

480
    config_ChainDestroy( p_vout->p->p_cfg );
481

482 483
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
484 485
}

Laurent Aimar's avatar
Laurent Aimar committed
486
/* */
487
void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
Laurent Aimar's avatar
Laurent Aimar committed
488
{
489 490 491 492 493
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_PAUSE);
    cmd.u.pause.is_on = is_paused;
    cmd.u.pause.date  = date;
    vout_control_Push(&vout->p->control, &cmd);
Laurent Aimar's avatar
Laurent Aimar committed
494

495
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
496
}
497

498 499
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
500 501
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
502
}
503

504
void vout_Flush(vout_thread_t *vout, mtime_t date)
505
{
506 507
    vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
    vout_control_WaitEmpty(&vout->p->control);
508
}
509

510
void vout_Reset(vout_thread_t *vout)
511
{
512 513
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
    vout_control_WaitEmpty(&vout->p->control);
514
}
515

516
void vout_FixLeaks( vout_thread_t *vout )
517 518 519 520 521 522
{
    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);
523
    }
524 525 526 527 528 529

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

533 534 535
    /* 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");
536

537 538
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
539

540
    vlc_mutex_unlock(&vout->p->picture_lock);
541
}
542
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
543
{
544 545 546
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
    cmd.u.time_ptr = duration;
547

548 549
    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);
550
}
551

552
void vout_DisplayTitle(vout_thread_t *vout, const char *title)
553
{
554 555
    assert(title);
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
556
}
557

558 559
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
560
    return p_vout->p->p_spu;
561 562
}

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
/* vout_Control* are usable by anyone at anytime */
void vout_ControlChangeFullscreen(vout_thread_t *vout, bool fullscreen)
{
    vout_control_PushBool(&vout->p->control, VOUT_CONTROL_FULLSCREEN,
                          fullscreen);
}
void vout_ControlChangeOnTop(vout_thread_t *vout, bool is_on_top)
{
    vout_control_PushBool(&vout->p->control, VOUT_CONTROL_ON_TOP,
                          is_on_top);
}
void vout_ControlChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
{
    vout_control_PushBool(&vout->p->control, VOUT_CONTROL_DISPLAY_FILLED,
                          is_filled);
}
void vout_ControlChangeZoom(vout_thread_t *vout, int num, int den)
{
    vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ZOOM,
                          num, den);
}

585
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
586
 * InitThread: initialize video output thread
587
 *****************************************************************************
588
 * This function is called from Thread and performs the second step of the
Sam Hocevar's avatar
 
Sam Hocevar committed
589 590
 * initialization. It returns 0 on success. Note that the thread's flag are not
 * modified inside this function.
591
 * XXX You have to enter it with change_lock taken.
592
 *****************************************************************************/
593
static int ThreadInit(vout_thread_t *vout)
Vincent Seguin's avatar
Vincent Seguin committed
594
{
Sam Hocevar's avatar
 
Sam Hocevar committed
595
    /* Initialize output method, it allocates direct buffers for us */
596
    if (vout_InitWrapper(vout))
597
        return VLC_EGENERIC;
598
    assert(vout->p->decoder_pool);
Sam Hocevar's avatar
 
Sam Hocevar committed
599

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

basos g's avatar
basos g committed
602 603
    /* print some usefull debug info about different vout formats
     */
604 605 606
    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
607

608 609 610
    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);
611
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
612 613
}

614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
/*****************************************************************************
 * 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);
    }
}

630 631
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
632
{
633 634 635 636 637
    int displayed_count = 0;
    int lost_count = 0;

    for (;;) {
        const mtime_t date = mdate();
638
        const bool is_paused = vout->p->pause.is_on;
639
        bool redisplay = is_paused && !now && vout->p->displayed.decoded;
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
        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;
659 660
            }
        }
661 662
        if (redisplay) {
             /* FIXME a better way for this delay is needed */
663
            const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
664 665 666
            if (date_update > date || !vout->p->displayed.decoded) {
                *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
                break;
667
            }
668 669 670
            /* */
            is_forced = true;
            *deadline = date - vout_chrono_GetHigh(&vout->p->render);
671
        }
672 673
        if (*deadline > VOUT_MWAIT_TOLERANCE)
            *deadline -= VOUT_MWAIT_TOLERANCE;
674

675
        /* If we are too early and can wait, do it */
676 677
        if (date < *deadline && !now)
            break;
678

679 680 681 682 683 684 685 686 687 688 689 690
        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));
691
                    if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
692 693 694 695 696
                        msg_Warn(vout, "rejected picture because of render time");
                        /* TODO */
                        picture_Release(decoded);
                        lost_count++;
                        break;
697 698 699
                    }
                }
            }
700 701 702

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
703
        }
704
        vout->p->displayed.timestamp = decoded->date;
705 706

        /* */
707 708 709 710
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
711

712 713
        /* */
        vout_chrono_Start(&vout->p->render);
714

715 716 717 718 719 720 721 722
        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;
723
        }
724

Sam Hocevar's avatar
 
Sam Hocevar committed
725 726 727
        /*
         * Check for subpictures to display
         */
728 729
        const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
        mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
730 731
        if (vout->p->pause.is_on)
            spu_render_time = vout->p->pause.date;
732
        else
733
            spu_render_time = filtered->date > 1 ? filtered->date : mdate();
734

735 736 737
        subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
                                                   spu_render_time,
                                                   do_snapshot);
Sam Hocevar's avatar
 
Sam Hocevar committed
738 739
        /*
         * Perform rendering
740 741 742 743
         *
         * 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
744
         */
745 746 747 748 749 750 751 752 753 754
        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
755

756 757
            if (render) {
                picture_Copy(render, filtered);
758

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
                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
776 777
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
778
        /*
779
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
780
         */
781 782
        if (direct && do_snapshot)
            vout_snapshot_Set(&vout->p->snapshot, &vout->fmt_out, direct);
783

784 785 786
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
787

788 789
            vout_chrono_Stop(&vout->p->render);
#if 0
Gildas Bazin's avatar
 
Gildas Bazin committed
790
            {
791 792 793 794
            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
795
            }
796
#endif
797
        }
798

799 800 801
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
802

803
        /* Display the direct buffer returned by vout_RenderPicture */
804
        vout->p->displayed.date = mdate();
805 806
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
807

808 809 810
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
811

812 813 814 815 816
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
817

818 819 820 821 822 823 824 825
static int ThreadManage(vout_thread_t *vout,
                        mtime_t *deadline,
                        vout_interlacing_support_t *interlacing,
                        vout_postprocessing_support_t *postprocessing)
{
    vlc_mutex_lock(&vout->p->picture_lock);

    *deadline = VLC_TS_INVALID;
826
    ThreadDisplayPicture(vout, false, deadline);
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848

    const int  picture_qtype      = vout->p->displayed.qtype;
    const bool picture_interlaced = vout->p->displayed.is_interlaced;

    vlc_mutex_unlock(&vout->p->picture_lock);

    /* Post processing */
    vout_SetPostProcessingState(vout, postprocessing, picture_qtype);

    /* Deinterlacing */
    vout_SetInterlacingState(vout, interlacing, picture_interlaced);

    if (vout_ManageWrapper(vout)) {
        /* A fatal error occurred, and the thread must terminate
         * immediately, without displaying anything - setting b_error to 1
         * causes the immediate end of the main while() loop. */
        // FIXME pf_end
        return VLC_EGENERIC;
    }
    return VLC_SUCCESS;
}

849
static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
850
{
851 852 853
    if( !var_InheritBool(vout, "osd"))
        return;
    if (!vout->p->title.show)
854 855 856 857 858 859 860 861 862 863
        return;

    vlc_assert_locked(&vout->p->change_lock);

    const mtime_t start = mdate();
    const mtime_t stop = start +
                         INT64_C(1000) * vout->p->title.timeout;

    if (stop > start)
        vout_ShowTextAbsolute(vout, DEFAULT_CHAN,
864
                              string, NULL,
865 866 867 868 869 870 871 872
                              vout->p->title.position,
                              30 + vout->fmt_in.i_width
                                 - vout->fmt_in.i_visible_width
                                 - vout->fmt_in.i_x_offset,
                              20 + vout->fmt_in.i_y_offset,
                              start, stop);
}

873
static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
874
{
875 876 877 878
    es_format_t fmt;
    es_format_Init(&fmt, VIDEO_ES, vout->fmt_render.i_chroma);
    fmt.video = vout->fmt_render;

879 880
    vlc_mutex_lock(&vout->p->vfilter_lock);

881 882 883 884
    filter_chain_Reset(vout->p->p_vf2_chain, &fmt, &fmt);
    if (filter_chain_AppendFromString(vout->p->p_vf2_chain,
                                      filters) < 0)
        msg_Err(vout, "Video filter chain creation failed");
885

886 887
    vlc_mutex_unlock(&vout->p->vfilter_lock);
}
888

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
static void ThreadChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
{
    vlc_assert_locked(&vout->p->change_lock);
    assert(!vout->p->pause.is_on || !is_paused);

    if (vout->p->pause.is_on) {
        const mtime_t duration = date - vout->p->pause.date;

        if (vout->p->step.timestamp > VLC_TS_INVALID)
            vout->p->step.timestamp += duration;
        if (vout->p->step.last > VLC_TS_INVALID)
            vout->p->step.last += duration;
        picture_fifo_OffsetDate(vout->p->decoder_fifo, duration);
        if (vout->p->displayed.decoded)
            vout->p->displayed.decoded->date += duration;

        spu_OffsetSubtitleDate(vout->p->p_spu, duration);
    } else {
        vout->p->step.timestamp = VLC_TS_INVALID;
        vout->p->step.last      = VLC_TS_INVALID;
909
    }
910 911
    vout->p->pause.is_on = is_paused;
    vout->p->pause.date  = date;
912 913
}

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
static void ThreadFlush(vout_thread_t *vout, bool below, mtime_t date)
{
    vout->p->step.timestamp = VLC_TS_INVALID;
    vout->p->step.last      = VLC_TS_INVALID;

    picture_t *last = vout->p->displayed.decoded;
    if (last) {
        if (( below && last->date <= date) ||
            (!below && last->date >= date)) {
            picture_Release(last);

            vout->p->displayed.decoded   = NULL;
            vout->p->displayed.date      = VLC_TS_INVALID;
            vout->p->displayed.timestamp = VLC_TS_INVALID;
        }
    }
    picture_fifo_Flush(vout->p->decoder_fifo, date, below);
}

static void ThreadReset(vout_thread_t *vout)
{
    ThreadFlush(vout, true, INT64_MAX);
    if (vout->p->decoder_pool)
        picture_pool_NonEmpty(vout->p->decoder_pool, true);
    vout->p->pause.is_on = false;
    vout->p->pause.date  = mdate();
}

static void ThreadStep(vout_thread_t *vout, mtime_t *duration)
{
    *duration = 0;

    if (vout->p->step.last <= VLC_TS_INVALID)
        vout->p->step.last = vout->p->displayed.timestamp;

    mtime_t dummy;
    if (ThreadDisplayPicture(vout, true, &dummy))
        return;

    vout->p->step.timestamp = vout->p->displayed.timestamp;

    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;
        /* TODO advance subpicture by the duration ... */
    }
}

963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
static void ThreadChangeFullscreen(vout_thread_t *vout, bool fullscreen)
{
    /* FIXME not sure setting "fullscreen" is good ... */
    var_SetBool(vout, "fullscreen", fullscreen);
    vout_SetDisplayFullscreen(vout->p->display.vd, fullscreen);
}

static void ThreadChangeOnTop(vout_thread_t *vout, bool is_on_top)
{
    vout_SetWindowState(vout->p->display.vd,
                        is_on_top ? VOUT_WINDOW_STATE_ABOVE :
                                    VOUT_WINDOW_STATE_NORMAL);
}

static void ThreadChangeDisplayFilled(vout_thread_t *vout, bool is_filled)
{
    vout_SetDisplayFilled(vout->p->display.vd, is_filled);
}

static void ThreadChangeZoom(vout_thread_t *vout, int num, int den)
{
    if (num * 10 < den) {
        num = den;
        den *= 10;
    } else if (num > den * 10) {
        num = den * 10;
    }

    vout_SetDisplayZoom(vout->p->display.vd, num, den);
}
993

994
/*****************************************************************************
995
 * Thread: video output thread
996 997 998 999 1000
 *****************************************************************************
 * 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.
 *****************************************************************************/
1001
static void *Thread(void *object)
1002 1003 1004
{
    vout_thread_t *vout = object;
    bool          has_wrapper;
1005

1006 1007 1008 1009
    /*
     * Initialize thread
     */
    has_wrapper = !vout_OpenWrapper(vout, vout->p->psz_module_name);
Gildas Bazin's avatar
 
Gildas Bazin committed
1010

1011
    vlc_mutex_lock(&vout->p->change_lock);
1012

1013
    if (has_wrapper)
1014
        vout->p->b_error = ThreadInit(vout);
1015 1016
    else
        vout->p->b_error = true;
1017

1018 1019 1020 1021 1022 1023
    /* signal the creation of the vout */
    vout->p->b_ready = true;
    vlc_cond_signal(&vout->p->change_wait);

    if (vout->p