video_output.c 60.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 14 15 16 17
 *
 * 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.
18
 *
19 20
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 22
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
23
 *
24 25
 * 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
26
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
27
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
28

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

36
#include <vlc_common.h>
37

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

Clément Stenac's avatar
Clément Stenac committed
41
#include <vlc_vout.h>
42

Clément Stenac's avatar
Clément Stenac committed
43 44
#include <vlc_filter.h>
#include <vlc_osd.h>
Laurent Aimar's avatar
Laurent Aimar committed
45
#include <assert.h>
46

47
#if defined( __APPLE__ )
Clément Stenac's avatar
Clément Stenac committed
48
/* Include darwin_specific.h here if needed */
49 50
#endif

Clément Stenac's avatar
Clément Stenac committed
51 52
/** FIXME This is quite ugly but needed while we don't have counters
 * helpers */
53
//#include "input/input_internal.h"
Clément Stenac's avatar
Clément Stenac committed
54

55 56
#include <libvlc.h>
#include <vlc_input.h>
57
#include "vout_pictures.h"
Laurent Aimar's avatar
Laurent Aimar committed
58
#include "vout_internal.h"
59

60
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
61
 * Local prototypes
62
 *****************************************************************************/
63
static int      InitThread        ( vout_thread_t * );
64
static void*    RunThread         ( void *  );
65
static void     ErrorThread       ( vout_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
66
static void     CleanThread       ( vout_thread_t * );
67
static void     EndThread         ( vout_thread_t * );
Sam Hocevar's avatar
 
Sam Hocevar committed
68

69 70
static void     vout_Destructor   ( vlc_object_t * p_this );

Gildas Bazin's avatar
 
Gildas Bazin committed
71
/* Object variables callbacks */
72 73
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
74 75
static int VideoFilter2Callback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
76 77

/* */
78 79 80 81 82
static void PostProcessEnable( vout_thread_t * );
static void PostProcessDisable( vout_thread_t * );
static void PostProcessSetFilterQuality( vout_thread_t *p_vout );
static int  PostProcessCallback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
83 84
/* */
static void DeinterlaceEnable( vout_thread_t * );
85
static void DeinterlaceNeeded( vout_thread_t *, bool );
Gildas Bazin's avatar
 
Gildas Bazin committed
86

87 88 89
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

90 91 92
/* Display media title in OSD */
static void DisplayTitleOnOSD( vout_thread_t *p_vout );

93 94
/* Time during which the thread will sleep if it has nothing to
 * display (in micro-seconds) */
95
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
96 97 98 99 100 101 102 103 104 105 106

/* Maximum lap of time allowed between the beginning of rendering and
 * display. If, compared to the current date, the next image is too
 * late, the thread will perform an idle loop. This time should be
 * at least VOUT_IDLE_SLEEP plus the time required to render a few
 * images, to avoid trashing of decoded images */
#define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))

/* Better be in advance when awakening than late... */
#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))

107 108 109 110 111 112 113 114
/* Minimum number of direct pictures the video output will accept without
 * creating additional pictures in system memory */
#ifdef OPTIMIZE_MEMORY
#   define VOUT_MIN_DIRECT_PICTURES        (VOUT_MAX_PICTURES/2)
#else
#   define VOUT_MIN_DIRECT_PICTURES        (3*VOUT_MAX_PICTURES/4)
#endif

115 116 117 118 119
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
120
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
121
    picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
122

123
    p_picture->i_status = READY_PICTURE;
124 125 126 127 128 129

    return p_picture;
}

static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
{
130 131
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;

132 133 134
    vlc_mutex_lock( &p_vout->picture_lock );
    vout_UsePictureLocked( p_vout, p_pic );
    vlc_mutex_unlock( &p_vout->picture_lock );
135 136 137 138
}

static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
{
139 140
    p_filter->pf_video_buffer_new = video_new_buffer_filter;
    p_filter->pf_video_buffer_del = video_del_buffer_filter;
141 142
    p_filter->p_owner = p_data; /* p_vout */
    return VLC_SUCCESS;
143 144
}

145
#undef vout_Request
146
/*****************************************************************************
147 148 149 150 151
 * 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.
 *****************************************************************************/
152 153
vout_thread_t *vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                             video_format_t *p_fmt )
154
{
155
    if( !p_fmt )
156
    {
157 158 159
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
160
        if( p_vout )
161
            vout_CloseAndRelease( p_vout );
162 163 164 165 166 167
        return NULL;
    }

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

171
    /* TODO: find a suitable unused video output */
172 173 174 175

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

178
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
179
         * performance reasons. */
180
        if( p_vout->p->b_filter_change )
Gildas Bazin's avatar
 
Gildas Bazin committed
181
        {
182
            char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
183

184
            if( psz_filter_chain && !*psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
185 186 187 188
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
189
            if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
190
            {
191 192
                free( p_vout->p->psz_filter_chain );
                p_vout->p->psz_filter_chain = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
193 194
            }

195
            if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
196
            {
197
                p_vout->p->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
198 199
            }

200
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
201 202
        }

203 204
#warning "FIXME: Check RGB masks in vout_Request"
        /* FIXME: check RGB masks */
205
        if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
206 207
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
208
            p_vout->p->b_filter_change )
209
        {
210 211
            vlc_mutex_unlock( &p_vout->change_lock );

212
            /* We are not interested in this format, close this vout */
213
            vout_CloseAndRelease( p_vout );
214
            vlc_object_release( p_vout );
215 216 217 218 219
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
220 221 222 223 224 225
            /* 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 );
226
#if 0
227 228 229 230 231 232
            /* 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;
            }
233 234
#endif

235 236 237 238 239 240 241 242 243 244
            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;
                p_vout->i_changes |= VOUT_ASPECT_CHANGE;
245 246 247 248 249 250 251 252 253 254
            }
            vlc_mutex_unlock( &p_vout->change_lock );

            vlc_object_release( p_vout );
        }

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

255
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
256
            vlc_object_detach( p_vout );
257

258
            vlc_object_attach( p_vout, p_this );
259
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
260 261 262 263 264 265 266
        }
    }

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

267
        p_vout = vout_Create( p_this, p_fmt );
268 269 270 271 272
    }

    return p_vout;
}

273
#undef vout_Create
274 275
/*****************************************************************************
 * vout_Create: creates a new video output thread
276
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
277 278
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
279
 *****************************************************************************/
280
vout_thread_t * vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
281
{
Gildas Bazin's avatar
 
Gildas Bazin committed
282 283
    vout_thread_t  * p_vout;                            /* thread descriptor */
    int              i_index;                               /* loop variable */
284
    vlc_value_t      text;
Michel Kaempf's avatar
Michel Kaempf committed
285

286

287 288 289 290
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

291
    if( p_fmt->i_width <= 0 || p_fmt->i_height <= 0 )
292
        return NULL;
293
    const vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
294 295 296 297 298 299

    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;

300
    /* Allocate descriptor */
301 302 303
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
304
    if( p_vout == NULL )
305
        return NULL;
306

307
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
308
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
309 310 311 312 313 314
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

315
    /* Initialize pictures - translation tables and functions
Gildas Bazin's avatar
 
Gildas Bazin committed
316
     * will be initialized later in InitThread */
317
    for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
Gildas Bazin's avatar
 
Gildas Bazin committed
318 319 320
    {
        p_vout->p_picture[i_index].i_status = FREE_PICTURE;
        p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
321
        p_vout->p_picture[i_index].b_slow   = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
322 323 324 325
    }

    /* Initialize the rendering heap */
    I_RENDERPICTURES = 0;
326

327 328
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
329

330 331
    p_vout->fmt_render.i_chroma = 
    p_vout->fmt_in.i_chroma     = i_chroma;
332 333 334
    video_format_FixRgb( &p_vout->fmt_render );
    video_format_FixRgb( &p_vout->fmt_in );

Gildas Bazin's avatar
 
Gildas Bazin committed
335 336 337 338 339 340 341 342
    p_vout->render.i_last_used_pic = -1;

    /* Zero the output heap */
    I_OUTPUTPICTURES = 0;

    /* Initialize misc stuff */
    p_vout->i_changes    = 0;
    p_vout->b_fullscreen = 0;
343 344
    p_vout->p->render_time  = 10;
    p_vout->p->c_fps_samples = 0;
345
    vout_statistic_Init( &p_vout->p->statistic );
346
    p_vout->p->b_filter_change = 0;
Laurent Aimar's avatar
Laurent Aimar committed
347 348
    p_vout->p->b_paused = false;
    p_vout->p->i_pause_date = 0;
349 350
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
351
    p_vout->p->p_picture_displayed = NULL;
352 353 354
    p_vout->p->i_picture_displayed_date = 0;
    p_vout->p->b_picture_displayed = false;
    p_vout->p->b_picture_empty = false;
355
    p_vout->p->i_picture_qtype = QTYPE_NONE;
356
    p_vout->p->b_picture_interlaced = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
357

358 359
    vlc_mouse_Init( &p_vout->p->mouse );

360
    vout_snapshot_Init( &p_vout->p->snapshot );
361

Gildas Bazin's avatar
 
Gildas Bazin committed
362
    /* Initialize locks */
363 364
    vlc_mutex_init( &p_vout->picture_lock );
    vlc_cond_init( &p_vout->p->picture_wait );
365
    vlc_mutex_init( &p_vout->change_lock );
366
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
367

368 369
    /* Mouse coordinates */
    var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
370 371
    var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
    var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
372 373
    /* Mouse object (area of interest in a video filter) */
    var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
374

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

378
    /* Initialize subpicture unit */
379
    p_vout->p->p_spu = spu_Create( p_vout );
380

381
    /* */
382
    spu_Init( p_vout->p->p_spu );
383

384
    spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
385

386 387
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
388

Gildas Bazin's avatar
 
Gildas Bazin committed
389 390
    /* If the parent is not a VOUT object, that means we are at the start of
     * the video output pipe */
391
    if( vlc_internals( p_parent )->i_object_type != VLC_OBJECT_VOUT )
Sam Hocevar's avatar
 
Sam Hocevar committed
392
    {
393
        /* Look for the default filter configuration */
394
        p_vout->p->psz_filter_chain =
395
            var_CreateGetStringCommand( p_vout, "vout-filter" );
396 397

        /* Apply video filter2 objects on the first vout */
398
        p_vout->p->psz_vf2 =
399
            var_CreateGetStringCommand( p_vout, "video-filter" );
400 401

        p_vout->p->b_first_vout = true;
Gildas Bazin's avatar
 
Gildas Bazin committed
402 403 404 405
    }
    else
    {
        /* continue the parent's filter chain */
406
        char *psz_tmp;
Gildas Bazin's avatar
 
Gildas Bazin committed
407

408
        /* Ugly hack to jump to our configuration chain */
409 410 411 412
        p_vout->p->psz_filter_chain
            = ((vout_thread_t *)p_parent)->p->psz_filter_chain;
        p_vout->p->psz_filter_chain
            = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->p->psz_filter_chain );
413 414
        config_ChainDestroy( p_cfg );
        free( psz_tmp );
415 416

        /* Create a video filter2 var ... but don't inherit values */
417 418
        var_Create( p_vout, "video-filter",
                    VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
419
        p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
420 421 422

        /* */
        p_vout->p->b_first_vout = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
423 424
    }

425
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
426
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
427
        false, video_filter_buffer_allocation_init, NULL, p_vout );
428

Gildas Bazin's avatar
 
Gildas Bazin committed
429
    /* Choose the video output module */
430
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
431
    {
432
        psz_parser = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
433 434 435
    }
    else
    {
436 437
        psz_parser = strdup( p_vout->p->psz_filter_chain );
        p_vout->p->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
438 439
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
440
    /* Create the vout thread */
441
    char *psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
442
    free( psz_parser );
443
    free( psz_tmp );
444
    p_vout->p->p_cfg = p_cfg;
Laurent Aimar's avatar
Laurent Aimar committed
445 446 447 448 449 450 451 452 453 454

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

    /* */
    DeinterlaceEnable( p_vout );

455
    if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
456 457 458 459 460 461 462
    {
        char *psz_tmp;
        if( asprintf( &psz_tmp, "%s,none", psz_name ) < 0 )
            psz_tmp = strdup( "" );
        free( psz_name );
        psz_name = psz_tmp;
    }
463
    p_vout->p->psz_module_name = psz_name;
Laurent Aimar's avatar
Laurent Aimar committed
464 465

    /* */
466
    vlc_object_set_destructor( p_vout, vout_Destructor );
Gildas Bazin's avatar
 
Gildas Bazin committed
467

468
    /* */
469 470 471
    vlc_cond_init( &p_vout->p->change_wait );
    if( vlc_clone( &p_vout->p->thread, RunThread, p_vout,
                   VLC_THREAD_PRIORITY_OUTPUT ) )
Michel Kaempf's avatar
Michel Kaempf committed
472
    {
473 474 475
        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;
476
        vlc_object_release( p_vout );
477 478 479
        return NULL;
    }

480 481 482 483 484 485 486 487 488
    vlc_mutex_lock( &p_vout->change_lock );
    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 );
        vlc_cond_wait( &p_vout->p->change_wait, &p_vout->change_lock );
    }
    vlc_mutex_unlock( &p_vout->change_lock );

489
    if( p_vout->p->b_error )
490 491
    {
        msg_Err( p_vout, "video output creation failed" );
492
        vout_CloseAndRelease( p_vout );
493
        return NULL;
494
    }
Michel Kaempf's avatar
Michel Kaempf committed
495

496
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
497 498
}

499
/*****************************************************************************
500
 * vout_Close: Close a vout created by vout_Create.
501
 *****************************************************************************
502
 * 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
503
 * You should NEVER call it on vout not obtained through vout_Create
504
 * (like with vout_Request or vlc_object_find.)
505
 * You can use vout_CloseAndRelease() as a convenience method.
506
 *****************************************************************************/
507
void vout_Close( vout_thread_t *p_vout )
508 509 510
{
    assert( p_vout );

511 512 513 514
    vlc_mutex_lock( &p_vout->change_lock );
    p_vout->p->b_done = true;
    vlc_cond_signal( &p_vout->p->change_wait );
    vlc_mutex_unlock( &p_vout->change_lock );
515

516
    vout_snapshot_End( &p_vout->p->snapshot );
517

518
    vlc_join( p_vout->p->thread, NULL );
519 520 521
}

/* */
522 523
static void vout_Destructor( vlc_object_t * p_this )
{
524
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
525

526
    /* Make sure the vout was stopped first */
527
    //assert( !p_vout->p_module );
528

529 530
    free( p_vout->p->psz_module_name );

Laurent Aimar's avatar
Laurent Aimar committed
531
    /* */
532 533
    if( p_vout->p->p_spu )
        spu_Destroy( p_vout->p->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
534

535
    /* Destroy the locks */
536
    vlc_cond_destroy( &p_vout->p->change_wait );
537
    vlc_cond_destroy( &p_vout->p->picture_wait );
538 539
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
540
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
541

542 543 544
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

545
    /* */
546
    vout_snapshot_Clean( &p_vout->p->snapshot );
547 548

    /* */
549
    free( p_vout->p->psz_filter_chain );
550
    free( p_vout->p->psz_title );
Gildas Bazin's avatar
 
Gildas Bazin committed
551

552
    config_ChainDestroy( p_vout->p->p_cfg );
553

554 555
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
556 557
}

Laurent Aimar's avatar
Laurent Aimar committed
558 559 560
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
561
    vlc_mutex_lock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
562

563
    assert( !p_vout->p->b_paused || !b_paused );
564 565 566 567 568

    vlc_mutex_lock( &p_vout->picture_lock );

    p_vout->p->i_picture_displayed_date = 0;

Laurent Aimar's avatar
Laurent Aimar committed
569 570 571 572 573 574 575 576 577 578 579
    if( p_vout->p->b_paused )
    {
        const mtime_t i_duration = i_date - p_vout->p->i_pause_date;

        for( int i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
        {
            picture_t *p_pic = PP_RENDERPICTURE[i_index];

            if( p_pic->i_status == READY_PICTURE )
                p_pic->date += i_duration;
        }
580 581 582
        vlc_cond_signal( &p_vout->p->picture_wait );
        vlc_mutex_unlock( &p_vout->picture_lock );

583
        spu_OffsetSubtitleDate( p_vout->p->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
584
    }
585 586 587 588
    else
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
    }
Laurent Aimar's avatar
Laurent Aimar committed
589 590 591
    p_vout->p->b_paused = b_paused;
    p_vout->p->i_pause_date = i_date;

592
    vlc_mutex_unlock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
593
}
594

595 596
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
597 598
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
599
}
600

Laurent Aimar's avatar
Laurent Aimar committed
601 602 603
void vout_Flush( vout_thread_t *p_vout, mtime_t i_date )
{
    vlc_mutex_lock( &p_vout->picture_lock );
604
    p_vout->p->i_picture_displayed_date = 0;
Laurent Aimar's avatar
Laurent Aimar committed
605 606 607
    for( int i = 0; i < p_vout->render.i_pictures; i++ )
    {
        picture_t *p_pic = p_vout->render.pp_picture[i];
Laurent Aimar's avatar
Laurent Aimar committed
608

Laurent Aimar's avatar
Laurent Aimar committed
609 610 611 612 613 614 615 616 617
        if( p_pic->i_status == READY_PICTURE ||
            p_pic->i_status == DISPLAYED_PICTURE )
        {
            /* We cannot change picture status if it is in READY_PICTURE state,
             * Just make sure they won't be displayed */
            if( p_pic->date > i_date )
                p_pic->date = i_date;
        }
    }
618
    vlc_cond_signal( &p_vout->p->picture_wait );
Laurent Aimar's avatar
Laurent Aimar committed
619 620
    vlc_mutex_unlock( &p_vout->picture_lock );
}
621

622
void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
623 624 625 626 627
{
    int i_pic, i_ready_pic;

    vlc_mutex_lock( &p_vout->picture_lock );

628
    for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
    {
        const picture_t *p_pic = p_vout->render.pp_picture[i_pic];

        if( p_pic->i_status == READY_PICTURE )
        {
            i_ready_pic++;
            /* If we have at least 2 ready pictures, wait for the vout thread to
             * process one */
            if( i_ready_pic >= 2 )
                break;

            continue;
        }

        if( p_pic->i_status == DISPLAYED_PICTURE )
        {
            /* If at least one displayed picture is not referenced
             * let vout free it */
            if( p_pic->i_refcount == 0 )
                break;
        }
    }
651
    if( i_pic < p_vout->render.i_pictures && !b_forced )
652 653 654 655 656 657 658
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
        return;
    }

    /* Too many pictures are still referenced, there is probably a bug
     * with the decoder */
659 660
    if( !b_forced )
        msg_Err( p_vout, "pictures leaked, resetting the heap" );
661 662 663 664 665

    /* Just free all the pictures */
    for( i_pic = 0; i_pic < p_vout->render.i_pictures; i_pic++ )
    {
        picture_t *p_pic = p_vout->render.pp_picture[i_pic];
666 667

        msg_Dbg( p_vout, "[%d] %d %d", i_pic, p_pic->i_status, p_pic->i_refcount );
668
        p_pic->i_refcount = 0;
Laurent Aimar's avatar
Laurent Aimar committed
669 670 671 672 673 674 675 676 677 678

        switch( p_pic->i_status )
        {
        case READY_PICTURE:
        case DISPLAYED_PICTURE:
        case RESERVED_PICTURE:
            if( p_pic != p_vout->p->p_picture_displayed )
                vout_UsePictureLocked( p_vout, p_pic );
            break;
        }
679
    }
680
    vlc_cond_signal( &p_vout->p->picture_wait );
681 682
    vlc_mutex_unlock( &p_vout->picture_lock );
}
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
void vout_NextPicture( vout_thread_t *p_vout, mtime_t *pi_duration )
{
    vlc_mutex_lock( &p_vout->picture_lock );

    const mtime_t i_displayed_date = p_vout->p->i_picture_displayed_date;

    p_vout->p->b_picture_displayed = false;
    p_vout->p->b_picture_empty = false;
    if( p_vout->p->p_picture_displayed )
    {
        p_vout->p->p_picture_displayed->date = 1;
        vlc_cond_signal( &p_vout->p->picture_wait );
    }

    while( !p_vout->p->b_picture_displayed && !p_vout->p->b_picture_empty )
        vlc_cond_wait( &p_vout->p->picture_wait, &p_vout->picture_lock );

    *pi_duration = __MAX( p_vout->p->i_picture_displayed_date - i_displayed_date, 0 );

    /* TODO advance subpicture by the duration ... */

    vlc_mutex_unlock( &p_vout->picture_lock );
}
706

707 708 709 710
void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
{
    assert( psz_title );

711
    if( !var_InheritBool( p_vout, "osd" ) )
712 713
        return;

714
    vlc_mutex_lock( &p_vout->change_lock );
715 716
    free( p_vout->p->psz_title );
    p_vout->p->psz_title = strdup( psz_title );
717
    vlc_mutex_unlock( &p_vout->change_lock );
718
}
719

720 721
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
722
    return p_vout->p->p_spu;
723 724
}

725
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
726
 * InitThread: initialize video output thread
727
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
728 729 730
 * This function is called from RunThread and performs the second step of the
 * initialization. It returns 0 on success. Note that the thread's flag are not
 * modified inside this function.
731
 * XXX You have to enter it with change_lock taken.
732
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
733
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
734
{
735
    int i;
Sam Hocevar's avatar
 
Sam Hocevar committed
736

Sam Hocevar's avatar
 
Sam Hocevar committed
737
    /* Initialize output method, it allocates direct buffers for us */
738
    if( vout_InitWrapper( p_vout ) )
739
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
740

741 742
    p_vout->p->p_picture_displayed = NULL;

Sam Hocevar's avatar
 
Sam Hocevar committed
743
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
744
    {
745 746
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
747
        vout_EndWrapper( p_vout );
748
        return VLC_EGENERIC;
749
    }
Vincent Seguin's avatar
Vincent Seguin committed
750

Gildas Bazin's avatar
 
Gildas Bazin committed
751 752 753 754
    if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
    {
        msg_Err( p_vout, "plugin allocated too many direct buffers, "
                         "our internal buffers must have overflown." );
755
        vout_EndWrapper( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
756 757 758
        return VLC_EGENERIC;
    }

759
    msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
Sam Hocevar's avatar
 
Sam Hocevar committed
760

761
    assert( p_vout->fmt_out.i_width > 0 && p_vout->fmt_out.i_height > 0 );
762 763
    if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
    {
764 765 766
        /* FIXME is it possible to end up here ? */
        p_vout->fmt_out.i_sar_num = 1;
        p_vout->fmt_out.i_sar_den = 1;
767 768
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
769 770
    vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
                 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
771

772
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
773
    /* Calculate shifts from system-updated masks */
774 775
    video_format_FixRgb( &p_vout->fmt_render );
    video_format_FixRgb( &p_vout->fmt_out );
Sam Hocevar's avatar
 
Sam Hocevar committed
776

basos g's avatar
basos g committed
777 778
    /* print some usefull debug info about different vout formats
     */
779
    msg_Dbg( p_vout, "pic render sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
basos g's avatar
basos g committed
780 781 782 783 784 785 786 787
             p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
             p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
             p_vout->fmt_render.i_visible_width,
             p_vout->fmt_render.i_visible_height,
             (char*)&p_vout->fmt_render.i_chroma,
             p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den,
             p_vout->fmt_render.i_rmask, p_vout->fmt_render.i_gmask, p_vout->fmt_render.i_bmask );

788
    msg_Dbg( p_vout, "pic in sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
basos g's avatar
basos g committed
789 790 791 792 793 794 795 796
             p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
             p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
             p_vout->fmt_in.i_visible_width,
             p_vout->fmt_in.i_visible_height,
             (char*)&p_vout->fmt_in.i_chroma,
             p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den,
             p_vout->fmt_in.i_rmask, p_vout->fmt_in.i_gmask, p_vout->fmt_in.i_bmask );

797
    msg_Dbg( p_vout, "pic out sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
basos g's avatar
basos g committed
798 799 800 801 802 803 804 805
             p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
             p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
             p_vout->fmt_out.i_visible_width,
             p_vout->fmt_out.i_visible_height,
             (char*)&p_vout->fmt_out.i_chroma,
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den,
             p_vout->fmt_out.i_rmask, p_vout->fmt_out.i_gmask, p_vout->fmt_out.i_bmask );

806 807 808
    assert( p_vout->fmt_out.i_width == p_vout->fmt_render.i_width &&
            p_vout->fmt_out.i_height == p_vout->fmt_render.i_height &&
            p_vout->fmt_out.i_chroma == p_vout->fmt_render.i_chroma );
Sam Hocevar's avatar
 
Sam Hocevar committed
809
    /* Check whether we managed to create direct buffers similar to
810
     * the render buffers, ie same size and chroma */
Gildas Bazin's avatar
 
Gildas Bazin committed
811

Laurent Aimar's avatar
Laurent Aimar committed
812 813 814 815 816
    /* Cool ! We have direct buffers, we can ask the decoder to
     * directly decode into them ! Map the first render buffers to
     * the first direct buffers, but keep the first direct buffer
     * for memcpy operations */
    for( i = 1; i < VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
817
    {
Laurent Aimar's avatar
Laurent Aimar committed
818 819 820
        if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
            I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
            p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
821
        {
Laurent Aimar's avatar
Laurent Aimar committed
822 823 824
            /* We have enough direct buffers so there's no need to
             * try to use system memory buffers. */
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
825
        }
Laurent Aimar's avatar
Laurent Aimar committed
826 827
        PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
        I_RENDERPICTURES++;
Sam Hocevar's avatar
 
Sam Hocevar committed
828
    }
Vincent Seguin's avatar
Vincent Seguin committed
829

Laurent Aimar's avatar
Laurent Aimar committed
830 831 832 833
    msg_Dbg( p_vout, "direct render, mapping "
             "render pictures 0-%i to system pictures 1-%i",
             VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );

834
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
835 836
}

837
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
838
 * RunThread: video output thread
839
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
840 841 842
 * 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.
843
 *****************************************************************************/
844
static void* RunThread( void *p_this )
Vincent Seguin's avatar
Vincent Seguin committed
845
{
846
    vout_thread_t *p_vout = p_this;
847
    bool            b_has_wrapper;
848
    int             i_idle_loops = 0;  /* loops without displaying a picture */
849
    int             i_picture_qtype_last = QTYPE_NONE;
850 851
    bool            b_picture_interlaced_last = false;
    mtime_t         i_picture_interlaced_last_date;
Sam Hocevar's avatar
 
Sam Hocevar committed
852 853 854 855

    /*
     * Initialize thread
     */
856
    b_has_wrapper = !vout_OpenWrapper( p_vout, p_vout->p->psz_module_name );
857 858 859

    vlc_mutex_lock( &p_vout->change_lock );

860
    if( b_has_wrapper )
861
        p_vout->p->b_error = InitThread( p_vout );
862
    else
863
        p_vout->p->b_error = true;
864

Gildas Bazin's avatar
 
Gildas Bazin committed
865
    /* signal the creation of the vout */
866 867
    p_vout->p->b_ready = true;
    vlc_cond_signal( &p_vout->p->change_wait );
Gildas Bazin's avatar
 
Gildas Bazin committed
868

869
    if( p_vout->p->b_error )
870 871 872 873
        goto exit_thread;

    /* */
    const bool b_drop_late = var_CreateGetBool( p_vout, "drop-late-frames" );
874
    i_picture_interlaced_last_date = mdate();
875

876
    /*
Sam Hocevar's avatar
Sam Hocevar committed
877
     * Main loop - it is not executed if an error occurred during
Sam Hocevar's avatar
 
Sam Hocevar committed
878
     * initialization
879
     */
880
    while( !p_vout->p->b_done && !p_vout->p->b_error )
881
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
882
        /* Initialize loop variables */
Laurent Aimar's avatar
Laurent Aimar committed
883
        const mtime_t current_date = mdate();
884
        picture_t *p_picture;
885
        picture_t *p_filtered_picture;
886
        mtime_t display_date;
Laurent Aimar's avatar
Laurent Aimar committed
887 888
        picture_t *p_directbuffer;
        int i_index;
Sam Hocevar's avatar
 
Sam Hocevar committed
889

890 891 892
        if( p_vout->p->b_title_show && p_vout->p->psz_title )
            DisplayTitleOnOSD( p_vout );

893 894
        vlc_mutex_lock( &p_vout->picture_lock );

895 896 897 898
        /* Look for the earliest picture but after the last displayed one */
        picture_t *p_last = p_vout->p->p_picture_displayed;;

        p_picture = NULL;
899
        for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
900
        {
Laurent Aimar's avatar
Laurent Aimar committed
901 902
            picture_t *p_pic = PP_RENDERPICTURE[i_index];

903 904 905 906 907 908 909
            if( p_pic->i_status != READY_PICTURE )
                continue;

            if( p_vout->p->b_paused && p_last && p_last->date > 1 )
                continue;

            if( p_last && p_pic != p_last && p_pic->date <= p_last->date )
910
            {
911
                /* Drop old picture */
912 913 914 915 916 917 918 919 920
                vout_UsePictureLocked( p_vout, p_pic );
            }
            else if( !p_vout->p->b_paused && !p_pic->b_force && p_pic != p_last &&
                     p_pic->date < current_date + p_vout->p->render_time &&
                     b_drop_late )
            {
                /* Picture is late: it will be destroyed and the thread
                 * will directly choose the next picture */
                vout_UsePictureLocked( p_vout, p_pic );
921
                vout_statistic_Update( &p_vout->p->statistic, 0, 1 );
922

basos g's avatar
basos g committed
923 924
                msg_Warn( p_vout, "late picture skipped (%"PRId64" > %d)",
                                  current_date - p_pic->date, - p_vout->p->render_time );
925
            }
926 927
            else if( ( !p_last || p_last->date < p_pic->date ) &&
                     ( p_picture == NULL || p_pic->date < p_picture->date ) )
928
            {
929
                p_picture = p_pic;
930 931
            }
        }
932
        if( !p_picture )
933
        {
934
            p_picture = p_last;
Sam Hocevar's avatar
 
Sam Hocevar committed
935

936 937 938 939 940 941 942
            if( !p_vout->p->b_picture_empty )
            {
                p_vout->p->b_picture_empty = true;
                vlc_cond_signal( &p_vout->p->picture_wait );
            }
        }

943
        display_date = 0;
944
        if( p_picture )
945
        {
946
            display_date = p_picture->date;
947

948
            /* If we found better than the last picture, destroy it */
949
            if( p_last && p_picture != p_last )
950
            {