video_output.c 54.8 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
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
54
 * Local prototypes
55
 *****************************************************************************/
56
static int      InitThread        ( vout_thread_t * );
57
static void*    RunThread         ( void *  );
Laurent Aimar's avatar
Laurent Aimar committed
58
static void     CleanThread       ( vout_thread_t * );
59
static void     EndThread         ( vout_thread_t * );
Sam Hocevar's avatar
 
Sam Hocevar committed
60

61 62
static void     vout_Destructor   ( vlc_object_t * p_this );

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

/* */
70 71 72 73 74
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 * );
75 76
/* */
static void DeinterlaceEnable( vout_thread_t * );
77
static void DeinterlaceNeeded( vout_thread_t *, bool );
Gildas Bazin's avatar
 
Gildas Bazin committed
78

79 80 81
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

82 83 84
/* Display media title in OSD */
static void DisplayTitleOnOSD( vout_thread_t *p_vout );

85 86
/* Time during which the thread will sleep if it has nothing to
 * display (in micro-seconds) */
87
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
88 89 90 91 92 93 94 95 96 97 98

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

99 100 101 102 103
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
104
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
105
    return picture_pool_Get(p_vout->p->private_pool);
106 107 108 109
}

static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
{
110
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
111
    picture_Release(p_pic);
112 113 114 115
}

static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
{
116 117
    p_filter->pf_video_buffer_new = video_new_buffer_filter;
    p_filter->pf_video_buffer_del = video_del_buffer_filter;
118 119
    p_filter->p_owner = p_data; /* p_vout */
    return VLC_SUCCESS;
120 121
}

122
#undef vout_Request
123
/*****************************************************************************
124 125 126 127 128
 * 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.
 *****************************************************************************/
129 130
vout_thread_t *vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                             video_format_t *p_fmt )
131
{
132
    if( !p_fmt )
133
    {
134 135 136
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
137
        if( p_vout )
138
            vout_CloseAndRelease( p_vout );
139 140 141 142 143 144
        return NULL;
    }

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

148
    /* TODO: find a suitable unused video output */
149 150 151 152

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

155
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
156
         * performance reasons. */
157
        if( p_vout->p->b_filter_change )
Gildas Bazin's avatar
 
Gildas Bazin committed
158
        {
159
            char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
160

161
            if( psz_filter_chain && !*psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
162 163 164 165
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
166
            if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
167
            {
168 169
                free( p_vout->p->psz_filter_chain );
                p_vout->p->psz_filter_chain = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
170 171
            }

172
            if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
173
            {
174
                p_vout->p->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
175 176
            }

177
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
178 179
        }

180 181
#warning "FIXME: Check RGB masks in vout_Request"
        /* FIXME: check RGB masks */
182
        if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
183 184
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
185
            p_vout->p->b_filter_change )
186
        {
187
            vlc_mutex_unlock( &p_vout->p->change_lock );
188

189
            /* We are not interested in this format, close this vout */
190
            vout_CloseAndRelease( p_vout );
191
            vlc_object_release( p_vout );
192 193 194 195 196
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
197 198 199 200 201 202
            /* 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 );
203
#if 0
204 205 206 207 208 209
            /* 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;
            }
210 211
#endif

212 213 214 215 216 217 218 219 220
            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;
221
                p_vout->p->i_changes |= VOUT_ASPECT_CHANGE;
222
            }
223
            vlc_mutex_unlock( &p_vout->p->change_lock );
224 225 226 227 228 229 230 231

            vlc_object_release( p_vout );
        }

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

232
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
233
            vlc_object_detach( p_vout );
234

235
            vlc_object_attach( p_vout, p_this );
236
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
237 238 239 240 241 242 243
        }
    }

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

244
        p_vout = vout_Create( p_this, p_fmt );
245 246 247 248 249
    }

    return p_vout;
}

250
#undef vout_Create
251 252
/*****************************************************************************
 * vout_Create: creates a new video output thread
253
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
254 255
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
256
 *****************************************************************************/
257
vout_thread_t * vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
258
{
259 260
    vout_thread_t  *p_vout;                            /* thread descriptor */
    vlc_value_t     text;
Michel Kaempf's avatar
Michel Kaempf committed
261

262

263 264 265 266
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

267
    if( p_fmt->i_width <= 0 || p_fmt->i_height <= 0 )
268
        return NULL;
269
    const vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
270 271 272 273 274 275

    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;

276
    /* Allocate descriptor */
277 278 279
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
280
    if( p_vout == NULL )
281
        return NULL;
282

283
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
284
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
285 286 287 288 289 290
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

291
    /* */
292 293
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
294

295 296
    p_vout->fmt_render.i_chroma = 
    p_vout->fmt_in.i_chroma     = i_chroma;
297 298 299
    video_format_FixRgb( &p_vout->fmt_render );
    video_format_FixRgb( &p_vout->fmt_in );

Gildas Bazin's avatar
 
Gildas Bazin committed
300
    /* Initialize misc stuff */
301 302
    p_vout->p->i_changes    = 0;
    p_vout->p->b_fullscreen = 0;
303
    vout_chrono_Init( &p_vout->p->render, 5, 10000 ); /* Arbitrary initial time */
304
    vout_statistic_Init( &p_vout->p->statistic );
305
    p_vout->p->b_filter_change = 0;
Laurent Aimar's avatar
Laurent Aimar committed
306 307
    p_vout->p->b_paused = false;
    p_vout->p->i_pause_date = 0;
308 309
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
310
    p_vout->p->is_late_dropped = var_InheritBool( p_vout, "drop-late-frames" );
311
    p_vout->p->b_picture_empty = false;
312 313 314 315 316 317 318 319 320 321 322
    p_vout->p->displayed.clock = VLC_TS_INVALID;
    p_vout->p->displayed.decoded = NULL;
    p_vout->p->displayed.timestampX = VLC_TS_INVALID;
    p_vout->p->displayed.qtype = QTYPE_NONE;
    p_vout->p->displayed.is_interlaced = false;
    p_vout->p->step.is_requested = false;
    p_vout->p->step.last = VLC_TS_INVALID;
    p_vout->p->step.timestamp = VLC_TS_INVALID;

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

324 325
    vlc_mouse_Init( &p_vout->p->mouse );

326
    vout_snapshot_Init( &p_vout->p->snapshot );
327

Gildas Bazin's avatar
 
Gildas Bazin committed
328
    /* Initialize locks */
329
    vlc_mutex_init( &p_vout->p->picture_lock );
330
    vlc_cond_init( &p_vout->p->picture_wait );
331
    vlc_mutex_init( &p_vout->p->change_lock );
332
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
333

334 335
    /* Mouse coordinates */
    var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
336 337
    var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
    var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
338 339
    /* Mouse object (area of interest in a video filter) */
    var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
340

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

344
    /* Initialize subpicture unit */
345
    p_vout->p->p_spu = spu_Create( p_vout );
346

347
    /* */
348
    spu_Init( p_vout->p->p_spu );
349

350
    spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
351

352 353
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
354

Gildas Bazin's avatar
 
Gildas Bazin committed
355 356
    /* If the parent is not a VOUT object, that means we are at the start of
     * the video output pipe */
357
    if( vlc_internals( p_parent )->i_object_type != VLC_OBJECT_VOUT )
Sam Hocevar's avatar
 
Sam Hocevar committed
358
    {
359
        /* Look for the default filter configuration */
360
        p_vout->p->psz_filter_chain =
361
            var_CreateGetStringCommand( p_vout, "vout-filter" );
362 363

        /* Apply video filter2 objects on the first vout */
364
        p_vout->p->psz_vf2 =
365
            var_CreateGetStringCommand( p_vout, "video-filter" );
366 367

        p_vout->p->b_first_vout = true;
Gildas Bazin's avatar
 
Gildas Bazin committed
368 369 370 371
    }
    else
    {
        /* continue the parent's filter chain */
372
        char *psz_tmp;
Gildas Bazin's avatar
 
Gildas Bazin committed
373

374
        /* Ugly hack to jump to our configuration chain */
375 376 377 378
        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 );
379 380
        config_ChainDestroy( p_cfg );
        free( psz_tmp );
381 382

        /* Create a video filter2 var ... but don't inherit values */
383 384
        var_Create( p_vout, "video-filter",
                    VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
385
        p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
386 387 388

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

391
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
392
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
393
        false, video_filter_buffer_allocation_init, NULL, p_vout );
394

Gildas Bazin's avatar
 
Gildas Bazin committed
395
    /* Choose the video output module */
396
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
397
    {
398
        psz_parser = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
399 400 401
    }
    else
    {
402 403
        psz_parser = strdup( p_vout->p->psz_filter_chain );
        p_vout->p->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
404 405
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
406
    /* Create the vout thread */
407
    char *psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
408
    free( psz_parser );
409
    free( psz_tmp );
410
    p_vout->p->p_cfg = p_cfg;
Laurent Aimar's avatar
Laurent Aimar committed
411 412 413 414 415 416 417 418 419 420

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

421
    if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
422 423 424 425 426 427 428
    {
        char *psz_tmp;
        if( asprintf( &psz_tmp, "%s,none", psz_name ) < 0 )
            psz_tmp = strdup( "" );
        free( psz_name );
        psz_name = psz_tmp;
    }
429
    p_vout->p->psz_module_name = psz_name;
Laurent Aimar's avatar
Laurent Aimar committed
430 431

    /* */
432
    vlc_object_set_destructor( p_vout, vout_Destructor );
Gildas Bazin's avatar
 
Gildas Bazin committed
433

434
    /* */
435 436 437
    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
438
    {
439 440 441
        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;
442
        vlc_object_release( p_vout );
443 444 445
        return NULL;
    }

446
    vlc_mutex_lock( &p_vout->p->change_lock );
447 448 449 450
    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 );
451
        vlc_cond_wait( &p_vout->p->change_wait, &p_vout->p->change_lock );
452
    }
453
    vlc_mutex_unlock( &p_vout->p->change_lock );
454

455
    if( p_vout->p->b_error )
456 457
    {
        msg_Err( p_vout, "video output creation failed" );
458
        vout_CloseAndRelease( p_vout );
459
        return NULL;
460
    }
Michel Kaempf's avatar
Michel Kaempf committed
461

462
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
463 464
}

465
/*****************************************************************************
466
 * vout_Close: Close a vout created by vout_Create.
467
 *****************************************************************************
468
 * 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
469
 * You should NEVER call it on vout not obtained through vout_Create
470
 * (like with vout_Request or vlc_object_find.)
471
 * You can use vout_CloseAndRelease() as a convenience method.
472
 *****************************************************************************/
473
void vout_Close( vout_thread_t *p_vout )
474 475 476
{
    assert( p_vout );

477
    vlc_mutex_lock( &p_vout->p->change_lock );
478 479
    p_vout->p->b_done = true;
    vlc_cond_signal( &p_vout->p->change_wait );
480
    vlc_mutex_unlock( &p_vout->p->change_lock );
481

482
    vout_snapshot_End( &p_vout->p->snapshot );
483

484
    vlc_join( p_vout->p->thread, NULL );
485 486 487
}

/* */
488 489
static void vout_Destructor( vlc_object_t * p_this )
{
490
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
491

492
    /* Make sure the vout was stopped first */
493
    //assert( !p_vout->p_module );
494

495 496
    free( p_vout->p->psz_module_name );

Laurent Aimar's avatar
Laurent Aimar committed
497
    /* */
498 499
    if( p_vout->p->p_spu )
        spu_Destroy( p_vout->p->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
500

501 502 503 504 505 506
    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 );

507
    /* Destroy the locks */
508
    vlc_cond_destroy( &p_vout->p->change_wait );
509
    vlc_cond_destroy( &p_vout->p->picture_wait );
510 511
    vlc_mutex_destroy( &p_vout->p->picture_lock );
    vlc_mutex_destroy( &p_vout->p->change_lock );
512
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
513

514 515 516
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

517
    /* */
518
    vout_snapshot_Clean( &p_vout->p->snapshot );
519 520

    /* */
521
    free( p_vout->p->psz_filter_chain );
522
    free( p_vout->p->psz_title );
Gildas Bazin's avatar
 
Gildas Bazin committed
523

524
    config_ChainDestroy( p_vout->p->p_cfg );
525

526 527
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
528 529
}

Laurent Aimar's avatar
Laurent Aimar committed
530 531 532
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
533
    vlc_mutex_lock( &p_vout->p->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
534

535
    assert( !p_vout->p->b_paused || !b_paused );
536

537
    vlc_mutex_lock( &p_vout->p->picture_lock );
538

Laurent Aimar's avatar
Laurent Aimar committed
539 540 541 542
    if( p_vout->p->b_paused )
    {
        const mtime_t i_duration = i_date - p_vout->p->i_pause_date;

543 544 545 546 547 548 549
        if (p_vout->p->step.timestamp > VLC_TS_INVALID)
            p_vout->p->step.timestamp += i_duration;
        if (!b_paused)
            p_vout->p->step.last = p_vout->p->step.timestamp;
        picture_fifo_OffsetDate( p_vout->p->decoder_fifo, i_duration );
        if (p_vout->p->displayed.decoded)
            p_vout->p->displayed.decoded->date += i_duration;
Laurent Aimar's avatar
Laurent Aimar committed
550

551
        vlc_cond_signal( &p_vout->p->picture_wait );
552
        vlc_mutex_unlock( &p_vout->p->picture_lock );
553

554
        spu_OffsetSubtitleDate( p_vout->p->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
555
    }
556 557
    else
    {
558 559
        if (b_paused)
            p_vout->p->step.last = p_vout->p->step.timestamp;
560
        vlc_mutex_unlock( &p_vout->p->picture_lock );
561
    }
Laurent Aimar's avatar
Laurent Aimar committed
562 563 564
    p_vout->p->b_paused = b_paused;
    p_vout->p->i_pause_date = i_date;

565
    vlc_mutex_unlock( &p_vout->p->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
566
}
567

568 569
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
570 571
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
572
}
573

574
static void Flush(vout_thread_t *vout, mtime_t date, bool below)
Laurent Aimar's avatar
Laurent Aimar committed
575
{
576 577 578 579 580 581 582 583 584
    vlc_assert_locked(&vout->p->picture_lock);
    vout->p->step.timestamp = VLC_TS_INVALID;
    vout->p->step.last      = VLC_TS_INVALID;

    picture_t *last = vout->p->displayed.decoded;
    if (last &&
        (( below  && last->date <= date) ||
          (!below && last->date >= date))) {
        vout->p->step.is_requested = true;
Laurent Aimar's avatar
Laurent Aimar committed
585
    }
586
    picture_fifo_Flush( vout->p->decoder_fifo, date, below );
Laurent Aimar's avatar
Laurent Aimar committed
587
}
588

589
void vout_Flush(vout_thread_t *vout, mtime_t date)
590
{
591
    vlc_mutex_lock(&vout->p->picture_lock);
592

593
    Flush(vout, date, false);
594

595 596 597
    vlc_cond_signal(&vout->p->picture_wait);
    vlc_mutex_unlock(&vout->p->picture_lock);
}
598

599 600 601 602 603 604 605 606 607 608
static void vout_Reset(vout_thread_t *vout)
{
#warning "TODO reset pause in vout_Reset"
    vlc_mutex_lock(&vout->p->picture_lock);
    Flush(vout, INT64_MAX, true);
    if (vout->p->decoder_pool)
        picture_pool_NonEmpty(vout->p->decoder_pool, true);
    vlc_cond_signal( &vout->p->picture_wait );
    vlc_mutex_unlock(&vout->p->picture_lock);
}
609

610 611 612 613 614 615 616
void vout_FixLeaks( vout_thread_t *vout, bool b_forced )
{
#warning "TODO split vout_FixLeaks into vout_FixLeaks and vout_Reset"
    if (b_forced) {
        vout_Reset(vout);
        return;
    }
617

618 619 620 621 622
    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);
623
    }
624 625 626 627 628 629

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

633 634 635
    /* 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");
636

637 638
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
639

640 641
    vlc_cond_signal(&vout->p->picture_wait);
    vlc_mutex_unlock(&vout->p->picture_lock);
642
}
643
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
644
{
645
    vlc_mutex_lock(&vout->p->picture_lock);
646

647 648
    vout->p->b_picture_empty = false;
    vout->p->step.is_requested = true;
649

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

653 654
    while (vout->p->step.is_requested && !vout->p->b_picture_empty)
        vlc_cond_wait(&vout->p->picture_wait, &vout->p->picture_lock);
655

656 657 658 659 660 661 662
    if (vout->p->step.last > VLC_TS_INVALID &&
        vout->p->step.timestamp > vout->p->step.last) {
        *duration = vout->p->step.timestamp - vout->p->step.last;
        vout->p->step.last = vout->p->step.timestamp;
    } else {
        *duration = 0;
    }
663 664

    /* TODO advance subpicture by the duration ... */
665
    vlc_mutex_unlock(&vout->p->picture_lock);
666
}
667

668 669 670 671
void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
{
    assert( psz_title );

672
    if( !var_InheritBool( p_vout, "osd" ) )
673 674
        return;

675
    vlc_mutex_lock( &p_vout->p->change_lock );
676 677
    free( p_vout->p->psz_title );
    p_vout->p->psz_title = strdup( psz_title );
678
    vlc_mutex_unlock( &p_vout->p->change_lock );
679
}
680

681 682
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
683
    return p_vout->p->p_spu;
684 685
}

686
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
687
 * InitThread: initialize video output thread
688
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
689 690 691
 * 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.
692
 * XXX You have to enter it with change_lock taken.
693
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
694
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
695
{
696
    int i;
Sam Hocevar's avatar
 
Sam Hocevar committed
697

Sam Hocevar's avatar
 
Sam Hocevar committed
698
    /* Initialize output method, it allocates direct buffers for us */
699
    if( vout_InitWrapper( p_vout ) )
700
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
701

702
    p_vout->p->displayed.decoded = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
703

704
    assert( p_vout->fmt_out.i_width > 0 && p_vout->fmt_out.i_height > 0 );
705 706
    if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
    {
707 708 709
        /* FIXME is it possible to end up here ? */
        p_vout->fmt_out.i_sar_num = 1;
        p_vout->fmt_out.i_sar_den = 1;
710 711
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
712 713
    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 );
714

715
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
716
    /* Calculate shifts from system-updated masks */
717 718
    video_format_FixRgb( &p_vout->fmt_render );
    video_format_FixRgb( &p_vout->fmt_out );
Sam Hocevar's avatar
 
Sam Hocevar committed
719

basos g's avatar
basos g committed
720 721
    /* print some usefull debug info about different vout formats
     */
722
    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
723 724 725 726 727 728 729 730
             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 );

731
    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
732 733 734 735 736 737 738 739
             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 );

740
    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
741 742 743 744 745 746 747 748
             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 );

749 750 751
    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 );
Vincent Seguin's avatar
Vincent Seguin committed
752

753
    assert( p_vout->p->decoder_pool );
Laurent Aimar's avatar
Laurent Aimar committed
754

755
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
756 757
}

758 759
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
760
{
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
    int displayed_count = 0;
    int lost_count = 0;

    for (;;) {
        const mtime_t date = mdate();
        const bool is_paused = vout->p->b_paused;
        bool redisplay = is_paused && !now;
        bool is_forced;

        /* FIXME/XXX we must redisplay the last decoded picture (because
         * of potential vout updated, or filters update or SPU update)
         * For now a high update period is needed but it coulmd be removed
         * if and only if:
         * - vout module emits events from theselves.
         * - *and* SPU is modified to emit an event or a deadline when needed.
         *
         * So it will be done latter.
         */
        if (!redisplay) {
            picture_t *peek = picture_fifo_Peek(vout->p->decoder_fifo);
            if (peek) {
                is_forced = peek->b_force || is_paused || now;
                *deadline = (is_forced ? date : peek->date) - vout_chrono_GetHigh(&vout->p->render);
                picture_Release(peek);
            } else {
                redisplay = true;
787 788
            }
        }
789 790 791 792 793 794 795
        if (redisplay) {
             /* FIXME a better way for this delay is needed */
            const mtime_t paused_display_period = 80000;
            const mtime_t date_update = vout->p->displayed.clock + paused_display_period;
            if (date_update > date || !vout->p->displayed.decoded) {
                *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
                break;
796
            }
797 798 799
            /* */
            is_forced = true;
            *deadline = date - vout_chrono_GetHigh(&vout->p->render);
800 801
        }

802 803 804
       /* If we are too early and can wait, do it */
        if (date < *deadline && !now)
            break;
805

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
        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) {
                    const mtime_t late_threshold = 20000; /* 20ms */
                    msg_Dbg(vout, "picture might be displayed late (missing %d ms)", (int)(late/1000));
                    if (late > late_threshold) {
                        msg_Warn(vout, "rejected picture because of render time");
                        /* TODO */
                        picture_Release(decoded);
                        lost_count++;
                        break;
825 826 827
                    }
                }
            }
828 829 830

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
831
        }
832
        vout->p->displayed.timestampX = decoded->date;
833 834

        /* */
835 836 837 838
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
839

840 841
        /* */
        vout_chrono_Start(&vout->p->render);
842

843 844 845 846 847 848 849 850
        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;
851
        }
852

Sam Hocevar's avatar
 
Sam Hocevar committed
853 854 855
        /*
         * Check for subpictures to display
         */
856 857 858 859
        const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
        mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
        if (vout->p->b_paused)
            spu_render_time = vout->p->i_pause_date;
860
        else
861
            spu_render_time = filtered->date > 1 ? filtered->date : mdate();
862

863 864 865
        subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
                                                   spu_render_time,
                                                   do_snapshot);
Sam Hocevar's avatar
 
Sam Hocevar committed
866 867
        /*
         * Perform rendering
868 869 870 871
         *
         * 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
872
         */
873 874 875 876 877 878 879 880 881 882
        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
883

884 885
            if (render) {
                picture_Copy(render, filtered);
886

887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
                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
904 905
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
906
        /*
907
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
908
         */
909 910
        if (direct && do_snapshot)
            vout_snapshot_Set(&vout->p->snapshot, &vout->fmt_out, direct);
911

912 913 914
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
915

916 917
            vout_chrono_Stop(&vout->p->render);
#if 0
Gildas Bazin's avatar
 
Gildas Bazin committed
918
            {
919 920 921 922
            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
923
            }
924
#endif
925
        }
926

927 928 929
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
930

931 932 933 934
        /* Display the direct buffer returned by vout_RenderPicture */
        vout->p->displayed.clock = mdate();
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
935

936 937 938
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
939

940 941 942 943 944
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
Laurent Aimar's avatar