video_output.c 39.3 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>
Laurent Aimar's avatar
Laurent Aimar committed
50
#include "vout_internal.h"
51 52
#include "interlacing.h"
#include "postprocessing.h"
53
#include "display.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 70 71 72 73
/* */
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))
74

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

196
            if( i_sar_num > 0 && i_sar_den > 0 &&
197 198
                ( i_sar_num != p_vout->p->fmt_render.i_sar_num ||
                  i_sar_den != p_vout->p->fmt_render.i_sar_den ) )
199
            {
200 201
                p_vout->p->fmt_in.i_sar_num = i_sar_num;
                p_vout->p->fmt_in.i_sar_den = i_sar_den;
202

203 204
                p_vout->p->fmt_render.i_sar_num = i_sar_num;
                p_vout->p->fmt_render.i_sar_den = i_sar_den;
205
                p_vout->p->i_changes |= VOUT_ASPECT_CHANGE;
206
            }
207
            vlc_mutex_unlock( &p_vout->p->change_lock );
208 209 210 211 212 213 214 215

            vlc_object_release( p_vout );
        }

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

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

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

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

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

    return p_vout;
}

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

245

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

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

    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;

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

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

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

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

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

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

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

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

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

310 311 312
    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
313
    /* Initialize locks */
314 315
    vlc_mutex_init( &p_vout->p->picture_lock );
    vlc_mutex_init( &p_vout->p->change_lock );
316
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
317

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

481 482
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
483 484
}

Laurent Aimar's avatar
Laurent Aimar committed
485
/* */
486
void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
Laurent Aimar's avatar
Laurent Aimar committed
487
{
488 489 490 491 492
    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
493

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

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

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

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

515 516 517 518 519 520 521 522 523 524 525 526 527
bool vout_IsEmpty(vout_thread_t *vout)
{
    vlc_mutex_lock(&vout->p->picture_lock);

    picture_t *picture = picture_fifo_Peek(vout->p->decoder_fifo);
    if (picture)
        picture_Release(picture);

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

    return !picture;
}

528
void vout_FixLeaks( vout_thread_t *vout )
529 530 531 532 533 534
{
    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);
535
    }
536 537 538 539 540 541

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

545 546 547
    /* 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");
548

549 550
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
551

552
    vlc_mutex_unlock(&vout->p->picture_lock);
553
}
554
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
555
{
556 557 558
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
    cmd.u.time_ptr = duration;
559

560 561
    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);
562
}
563

564
void vout_DisplayTitle(vout_thread_t *vout, const char *title)
565
{
566 567
    assert(title);
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
568
}
569

570 571
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
572
    return p_vout->p->p_spu;
573 574
}

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
/* 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);
}

597
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
598
 * InitThread: initialize video output thread
599
 *****************************************************************************
600
 * This function is called from Thread and performs the second step of the
Sam Hocevar's avatar
 
Sam Hocevar committed
601 602
 * initialization. It returns 0 on success. Note that the thread's flag are not
 * modified inside this function.
603
 * XXX You have to enter it with change_lock taken.
604
 *****************************************************************************/
605
static int ThreadInit(vout_thread_t *vout)
Vincent Seguin's avatar
Vincent Seguin committed
606
{
Sam Hocevar's avatar
 
Sam Hocevar committed
607
    /* Initialize output method, it allocates direct buffers for us */
608
    if (vout_InitWrapper(vout))
609
        return VLC_EGENERIC;
610
    assert(vout->p->decoder_pool);
Sam Hocevar's avatar
 
Sam Hocevar committed
611

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

basos g's avatar
basos g committed
614 615
    /* print some usefull debug info about different vout formats
     */
616 617 618
    PrintVideoFormat(vout, "pic render", &vout->p->fmt_render);
    PrintVideoFormat(vout, "pic in",     &vout->p->fmt_in);
    PrintVideoFormat(vout, "pic out",    &vout->p->fmt_out);
Laurent Aimar's avatar
Laurent Aimar committed
619

620 621 622
    assert(vout->p->fmt_out.i_width  == vout->p->fmt_render.i_width &&
           vout->p->fmt_out.i_height == vout->p->fmt_render.i_height &&
           vout->p->fmt_out.i_chroma == vout->p->fmt_render.i_chroma);
623
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
624 625
}

626 627
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
628
{
629 630 631 632 633
    int displayed_count = 0;
    int lost_count = 0;

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

671
        /* If we are too early and can wait, do it */
672 673
        if (date < *deadline && !now)
            break;
674

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

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
699
        }
700
        vout->p->displayed.timestamp = decoded->date;
701 702

        /* */
703 704 705 706
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
707

708 709
        /* */
        vout_chrono_Start(&vout->p->render);
710

711 712 713 714 715 716 717 718
        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;
719
        }
720

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

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

752 753
            if (render) {
                picture_Copy(render, filtered);
754

755
                spu_RenderSubpictures(vout->p->p_spu,
756 757
                                      render, &vout->p->fmt_out,
                                      subpic, &vout->p->fmt_in, spu_render_time);
758 759 760 761 762 763 764 765 766 767 768 769 770 771
            }
            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
772 773
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
774
        /*
775
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
776
         */
777
        if (direct && do_snapshot)
778
            vout_snapshot_Set(&vout->p->snapshot, &vout->p->fmt_out, direct);
779

780 781 782
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
783

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

795 796 797
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
798

799
        /* Display the direct buffer returned by vout_RenderPicture */
800
        vout->p->displayed.date = mdate();
801 802
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
803

804 805 806
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
807

808 809 810 811 812
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
813

814 815 816 817 818 819 820 821
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;
822
    ThreadDisplayPicture(vout, false, deadline);
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844

    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;
}

845
static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
846
{
847 848 849
    if( !var_InheritBool(vout, "osd"))
        return;
    if (!vout->p->title.show)
850 851 852 853
        return;

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

854 855
    if (vout->p->title.timeout > 0)
        vout_ShowTextRelative(vout, SPU_DEFAULT_CHANNEL,
856
                              string, NULL,
857
                              vout->p->title.position,
858 859 860 861
                              30 + vout->p->fmt_in.i_width
                                 - vout->p->fmt_in.i_visible_width
                                 - vout->p->fmt_in.i_x_offset,
                              20 + vout->p->fmt_in.i_y_offset,
862
                              INT64_C(1000) * vout->p->title.timeout);
863 864
}

865
static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
866
{
867
    es_format_t fmt;
868 869
    es_format_Init(&fmt, VIDEO_ES, vout->p->fmt_render.i_chroma);
    fmt.video = vout->p->fmt_render;
870

871 872
    vlc_mutex_lock(&vout->p->vfilter_lock);

873 874 875 876
    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");
877

878 879
    vlc_mutex_unlock(&vout->p->vfilter_lock);
}
880

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
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;
901
    }
902 903
    vout->p->pause.is_on = is_paused;
    vout->p->pause.date  = date;
904 905
}

906 907 908 909 910 911 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
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 ... */
    }
}

955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
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);
}
985

986 987 988 989 990 991 992 993 994
static void ThreadClean(vout_thread_t *vout)
{
    /* Destroy translation tables */
    if (!vout->p->b_error) {
        ThreadFlush(vout, true, INT64_MAX);
        vout_EndWrapper(vout);
    }
}

995
/*****************************************************************************
996
 * Thread: video output thread
997 998 999 1000 1001
 *****************************************************************************
 * 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.
 *****************************************************************************/