video_output.c 38.5 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * video_output.c : video output thread
3
 *
Michel Kaempf's avatar
Michel Kaempf committed
4 5
 * This module describes the programming interface for video output threads.
 * It includes functions allowing to open a new thread, send pictures to a
6 7
 * thread, and destroy a previously oppened video output thread.
 *****************************************************************************
8
 * Copyright (C) 2000-2007 the VideoLAN team
Gildas Bazin's avatar
Gildas Bazin committed
9
 * $Id$
10
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
11
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
12
 *          Gildas Bazin <gbazin@videolan.org>
13
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
14 15 16 17 18
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
19
 *
20 21
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 23
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
24
 *
25 26
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
27
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
28
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
29

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

37
#include <vlc_common.h>
38

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

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

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

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 )
    {
Laurent Aimar's avatar
Laurent Aimar committed
137
        if( !video_format_IsSimilar( &p_vout->p->original, p_fmt ) )
138 139
        {
            /* We are not interested in this format, close this vout */
140
            vout_CloseAndRelease( p_vout );
141
            vlc_object_release( p_vout );
142 143 144 145 146
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
147 148 149 150 151 152 153
            vlc_object_release( p_vout );
        }

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

154
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), false );
155
            vlc_object_detach( p_vout );
156

157
            vlc_object_attach( p_vout, p_this );
158
            spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
159 160 161 162 163 164 165
        }
    }

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

166
        p_vout = vout_Create( p_this, p_fmt );
167 168 169 170 171 172 173
    }

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
174
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
175 176
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
177
 *****************************************************************************/
178
vout_thread_t * (vout_Create)( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
179
{
180 181
    vout_thread_t  *p_vout;                            /* thread descriptor */
    vlc_value_t     text;
Michel Kaempf's avatar
Michel Kaempf committed
182

183

184 185 186 187
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

188
    if( p_fmt->i_width <= 0 || p_fmt->i_height <= 0 )
189
        return NULL;
190
    const vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
191 192 193 194 195 196

    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;

197
    /* Allocate descriptor */
198 199 200
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
201
    if( p_vout == NULL )
202
        return NULL;
203

204
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
205
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
206 207 208 209 210 211
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

212
    /* */
213 214 215
    p_vout->p->original = *p_fmt;   /* FIXME palette */
    p_vout->p->original.i_chroma = i_chroma;
    video_format_FixRgb( &p_vout->p->original );
216

Gildas Bazin's avatar
 
Gildas Bazin committed
217
    /* Initialize misc stuff */
218
    vout_control_Init( &p_vout->p->control );
219
    vout_control_PushVoid( &p_vout->p->control, VOUT_CONTROL_INIT );
220
    vout_chrono_Init( &p_vout->p->render, 5, 10000 ); /* Arbitrary initial time */
221
    vout_statistic_Init( &p_vout->p->statistic );
222 223
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
224
    p_vout->p->displayed.date = VLC_TS_INVALID;
225
    p_vout->p->displayed.decoded = NULL;
226
    p_vout->p->displayed.timestamp = VLC_TS_INVALID;
227 228
    p_vout->p->displayed.qtype = QTYPE_NONE;
    p_vout->p->displayed.is_interlaced = false;
229 230 231 232 233 234

    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;
235 236 237

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

239 240
    vlc_mouse_Init( &p_vout->p->mouse );

241
    vout_snapshot_Init( &p_vout->p->snapshot );
242

Laurent Aimar's avatar
Laurent Aimar committed
243 244 245
    p_vout->p->vfilter_chain =
        filter_chain_New( p_vout, "video filter2", false,
                          video_filter_buffer_allocation_init, NULL, p_vout );
246

Gildas Bazin's avatar
 
Gildas Bazin committed
247
    /* Initialize locks */
248
    vlc_mutex_init( &p_vout->p->picture_lock );
249
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
250

251 252
    /* Mouse coordinates */
    var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
253 254
    var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
    var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
255 256
    /* Mouse object (area of interest in a video filter) */
    var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
257

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

261
    /* Initialize subpicture unit */
262
    p_vout->p->p_spu = spu_Create( p_vout );
263

264
    /* */
265
    spu_Init( p_vout->p->p_spu );
266

267
    spu_Attach( p_vout->p->p_spu, VLC_OBJECT(p_vout), true );
268

269 270
    p_vout->p->is_late_dropped = var_InheritBool( p_vout, "drop-late-frames" );

271 272
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
273

Laurent Aimar's avatar
Laurent Aimar committed
274 275 276
    /* Look for the default filter configuration */
    p_vout->p->psz_filter_chain =
        var_CreateGetStringCommand( p_vout, "vout-filter" );
277

Laurent Aimar's avatar
Laurent Aimar committed
278
    /* Apply video filter2 objects on the first vout */
279 280
    var_Create( p_vout, "video-filter",
                VLC_VAR_STRING | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
281
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
282
    var_TriggerCallback( p_vout, "video-filter" );
283

Gildas Bazin's avatar
 
Gildas Bazin committed
284
    /* Choose the video output module */
285
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
286
    {
287
        psz_parser = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
288 289 290
    }
    else
    {
291
        psz_parser = strdup( p_vout->p->psz_filter_chain );
292
        p_vout->p->title.show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
293 294
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
295
    /* Create the vout thread */
296
    char *psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
297
    free( psz_parser );
298
    free( psz_tmp );
299
    p_vout->p->p_cfg = p_cfg;
Laurent Aimar's avatar
Laurent Aimar committed
300 301 302 303 304 305 306 307

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

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

310
    if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
311 312 313 314 315 316 317
    {
        char *psz_tmp;
        if( asprintf( &psz_tmp, "%s,none", psz_name ) < 0 )
            psz_tmp = strdup( "" );
        free( psz_name );
        psz_name = psz_tmp;
    }
318
    p_vout->p->psz_module_name = psz_name;
Laurent Aimar's avatar
Laurent Aimar committed
319 320

    /* */
321
    vlc_object_set_destructor( p_vout, vout_Destructor );
Gildas Bazin's avatar
 
Gildas Bazin committed
322

323
    /* */
324
    if( vlc_clone( &p_vout->p->thread, Thread, p_vout,
325
                   VLC_THREAD_PRIORITY_OUTPUT ) )
Michel Kaempf's avatar
Michel Kaempf committed
326
    {
327 328 329
        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;
330
        vlc_object_release( p_vout );
331 332 333
        return NULL;
    }

334
    vout_control_WaitEmpty( &p_vout->p->control );
335

336
    if (p_vout->p->dead )
337 338
    {
        msg_Err( p_vout, "video output creation failed" );
339
        vout_CloseAndRelease( p_vout );
340
        return NULL;
341
    }
Michel Kaempf's avatar
Michel Kaempf committed
342

343
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
344 345
}

346
/*****************************************************************************
347
 * vout_Close: Close a vout created by vout_Create.
348
 *****************************************************************************
349
 * 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
350
 * You should NEVER call it on vout not obtained through vout_Create
351
 * (like with vout_Request or vlc_object_find.)
352
 * You can use vout_CloseAndRelease() as a convenience method.
353
 *****************************************************************************/
354
void vout_Close( vout_thread_t *p_vout )
355 356 357
{
    assert( p_vout );

358
    vout_snapshot_End( &p_vout->p->snapshot );
359

360
    vout_control_PushVoid( &p_vout->p->control, VOUT_CONTROL_CLEAN );
361
    vlc_join( p_vout->p->thread, NULL );
362 363 364
}

/* */
365 366
static void vout_Destructor( vlc_object_t * p_this )
{
367
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
368

369
    /* Make sure the vout was stopped first */
370
    //assert( !p_vout->p_module );
371

372 373
    free( p_vout->p->psz_module_name );

Laurent Aimar's avatar
Laurent Aimar committed
374
    /* */
375 376
    if( p_vout->p->p_spu )
        spu_Destroy( p_vout->p->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
377

378 379 380 381 382 383
    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 );

384
    /* Destroy the locks */
385
    vlc_mutex_destroy( &p_vout->p->picture_lock );
386
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
387
    vout_control_Clean( &p_vout->p->control );
388

389 390 391
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

392
    /* */
393
    vout_snapshot_Clean( &p_vout->p->snapshot );
394 395

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

398
    config_ChainDestroy( p_vout->p->p_cfg );
399

400 401
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
402 403
}

Laurent Aimar's avatar
Laurent Aimar committed
404
/* */
405
void vout_ChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
Laurent Aimar's avatar
Laurent Aimar committed
406
{
407 408 409 410 411
    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
412

413
    vout_control_WaitEmpty(&vout->p->control);
Laurent Aimar's avatar
Laurent Aimar committed
414
}
415

416 417
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
418 419
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
420
}
421

422
void vout_Flush(vout_thread_t *vout, mtime_t date)
423
{
424 425
    vout_control_PushTime(&vout->p->control, VOUT_CONTROL_FLUSH, date);
    vout_control_WaitEmpty(&vout->p->control);
426
}
427

428
void vout_Reset(vout_thread_t *vout)
429
{
430 431
    vout_control_PushVoid(&vout->p->control, VOUT_CONTROL_RESET);
    vout_control_WaitEmpty(&vout->p->control);
432
}
433

434 435 436 437 438 439 440 441 442 443 444 445 446
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;
}

447
void vout_FixLeaks( vout_thread_t *vout )
448 449 450 451 452 453
{
    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);
454
    }
455 456 457 458 459 460

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

464 465 466
    /* 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");
467

468 469
    /* */
    picture_pool_NonEmpty(vout->p->decoder_pool, false);
Laurent Aimar's avatar
Laurent Aimar committed
470

471
    vlc_mutex_unlock(&vout->p->picture_lock);
472
}
473
void vout_NextPicture(vout_thread_t *vout, mtime_t *duration)
474
{
475 476 477
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_STEP);
    cmd.u.time_ptr = duration;
478

479 480
    vout_control_Push(&vout->p->control, &cmd);
    vout_control_WaitEmpty(&vout->p->control);
481
}
482

483
void vout_DisplayTitle(vout_thread_t *vout, const char *title)
484
{
485 486
    assert(title);
    vout_control_PushString(&vout->p->control, VOUT_CONTROL_OSD_TITLE, title);
487
}
488

489 490 491 492 493 494 495 496 497 498 499 500 501
void vout_PutSubpicture( vout_thread_t *vout, subpicture_t *subpic )
{
    spu_DisplaySubpicture(vout->p->p_spu, subpic);
}
int vout_RegisterSubpictureChannel( vout_thread_t *vout )
{
    return spu_RegisterChannel(vout->p->p_spu);
}
void vout_FlushSubpictureChannel( vout_thread_t *vout, int channel )
{
    spu_ClearChannel(vout->p->p_spu, channel);
}

502 503
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
504
    return p_vout->p->p_spu;
505 506
}

507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
/* 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);
}
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
void vout_ControlChangeSampleAspectRatio(vout_thread_t *vout,
                                         unsigned num, unsigned den)
{
    vout_control_PushPair(&vout->p->control, VOUT_CONTROL_ASPECT_RATIO,
                          num, den);
}
void vout_ControlChangeCropRatio(vout_thread_t *vout,
                                 unsigned num, unsigned den)
{
    vout_control_PushPair(&vout->p->control, VOUT_CONTROL_CROP_RATIO,
                          num, den);
}
void vout_ControlChangeCropWindow(vout_thread_t *vout,
                                  int x, int y, int width, int height)
{
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_WINDOW);
    cmd.u.window.x      = x;
    cmd.u.window.y      = y;
    cmd.u.window.width  = width;
    cmd.u.window.height = height;

    vout_control_Push(&vout->p->control, &cmd);
}
void vout_ControlChangeCropBorder(vout_thread_t *vout,
                                  int left, int top, int right, int bottom)
{
    vout_control_cmd_t cmd;
    vout_control_cmd_Init(&cmd, VOUT_CONTROL_CROP_BORDER);
    cmd.u.border.left   = left;
    cmd.u.border.top    = top;
    cmd.u.border.right  = right;
    cmd.u.border.bottom = bottom;

    vout_control_Push(&vout->p->control, &cmd);
}
564

565
/* */
566 567
static int ThreadDisplayPicture(vout_thread_t *vout,
                                bool now, mtime_t *deadline)
Vincent Seguin's avatar
Vincent Seguin committed
568
{
569
    vout_display_t *vd = vout->p->display.vd;
570 571 572 573 574
    int displayed_count = 0;
    int lost_count = 0;

    for (;;) {
        const mtime_t date = mdate();
575
        const bool is_paused = vout->p->pause.is_on;
576
        bool redisplay = is_paused && !now && vout->p->displayed.decoded;
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
        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;
596 597
            }
        }
598 599
        if (redisplay) {
             /* FIXME a better way for this delay is needed */
600
            const mtime_t date_update = vout->p->displayed.date + VOUT_REDISPLAY_DELAY;
601 602 603
            if (date_update > date || !vout->p->displayed.decoded) {
                *deadline = vout->p->displayed.decoded ? date_update : VLC_TS_INVALID;
                break;
604
            }
605 606 607
            /* */
            is_forced = true;
            *deadline = date - vout_chrono_GetHigh(&vout->p->render);
608
        }
609 610
        if (*deadline > VOUT_MWAIT_TOLERANCE)
            *deadline -= VOUT_MWAIT_TOLERANCE;
611

612
        /* If we are too early and can wait, do it */
613 614
        if (date < *deadline && !now)
            break;
615

616 617 618 619 620 621 622 623 624 625 626 627
        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));
628
                    if (late > VOUT_DISPLAY_LATE_THRESHOLD) {
629 630 631 632 633
                        msg_Warn(vout, "rejected picture because of render time");
                        /* TODO */
                        picture_Release(decoded);
                        lost_count++;
                        break;
634 635 636
                    }
                }
            }
637 638 639

            vout->p->displayed.is_interlaced = !decoded->b_progressive;
            vout->p->displayed.qtype         = decoded->i_qtype;
640
        }
641
        vout->p->displayed.timestamp = decoded->date;
642 643

        /* */
644 645 646 647
        if (vout->p->displayed.decoded)
            picture_Release(vout->p->displayed.decoded);
        picture_Hold(decoded);
        vout->p->displayed.decoded = decoded;
648

649 650
        /* */
        vout_chrono_Start(&vout->p->render);
651

652 653 654
        picture_t *filtered = NULL;
        if (decoded) {
            vlc_mutex_lock(&vout->p->vfilter_lock);
Laurent Aimar's avatar
Laurent Aimar committed
655
            filtered = filter_chain_VideoFilter(vout->p->vfilter_chain, decoded);
656 657 658 659
            //assert(filtered == decoded); // TODO implement
            vlc_mutex_unlock(&vout->p->vfilter_lock);
            if (!filtered)
                continue;
660
        }
661

Sam Hocevar's avatar
 
Sam Hocevar committed
662 663 664
        /*
         * Check for subpictures to display
         */
665 666
        const bool do_snapshot = vout_snapshot_IsRequested(&vout->p->snapshot);
        mtime_t spu_render_time = is_forced ? mdate() : filtered->date;
667 668
        if (vout->p->pause.is_on)
            spu_render_time = vout->p->pause.date;
669
        else
670
            spu_render_time = filtered->date > 1 ? filtered->date : mdate();
671

672 673 674
        subpicture_t *subpic = spu_SortSubpictures(vout->p->p_spu,
                                                   spu_render_time,
                                                   do_snapshot);
Sam Hocevar's avatar
 
Sam Hocevar committed
675 676
        /*
         * Perform rendering
677 678 679 680
         *
         * 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
681
         */
682 683 684 685 686
        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)
687
                render = picture_NewFromFormat(&vd->source);
688 689 690 691
            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
692

693 694
            if (render) {
                picture_Copy(render, filtered);
695

696
                spu_RenderSubpictures(vout->p->p_spu,
697 698
                                      render, &vd->source,
                                      subpic, &vd->source, spu_render_time);
699 700 701 702 703 704 705 706 707 708 709 710 711 712
            }
            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
713 714
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
715
        /*
716
         * Take a snapshot if requested
Sam Hocevar's avatar
 
Sam Hocevar committed
717
         */
718
        if (direct && do_snapshot)
719
            vout_snapshot_Set(&vout->p->snapshot, &vd->source, direct);
720

721 722 723
        /* Render the direct buffer returned by vout_RenderPicture */
        if (direct) {
            vout_RenderWrapper(vout, direct);
Sam Hocevar's avatar
 
Sam Hocevar committed
724

725 726
            vout_chrono_Stop(&vout->p->render);
#if 0
Gildas Bazin's avatar
 
Gildas Bazin committed
727
            {
728 729 730 731
            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
732
            }
733
#endif
734
        }
735

736 737 738
        /* Wait the real date (for rendering jitter) */
        if (!is_forced)
            mwait(decoded->date);
Sam Hocevar's avatar
 
Sam Hocevar committed
739

740
        /* Display the direct buffer returned by vout_RenderPicture */
741
        vout->p->displayed.date = mdate();
742 743
        if (direct)
            vout_DisplayWrapper(vout, direct);
Vincent Seguin's avatar
Vincent Seguin committed
744

745 746 747
        displayed_count++;
        break;
    }
Vincent Seguin's avatar
Vincent Seguin committed
748

749 750 751 752 753
    vout_statistic_Update(&vout->p->statistic, displayed_count, lost_count);
    if (displayed_count <= 0)
        return VLC_EGENERIC;
    return VLC_SUCCESS;
}
754

755 756 757 758
static void ThreadManage(vout_thread_t *vout,
                         mtime_t *deadline,
                         vout_interlacing_support_t *interlacing,
                         vout_postprocessing_support_t *postprocessing)
759 760 761 762
{
    vlc_mutex_lock(&vout->p->picture_lock);

    *deadline = VLC_TS_INVALID;
763
    ThreadDisplayPicture(vout, false, deadline);
764 765 766 767 768 769 770 771 772 773 774 775

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

776
    vout_ManageWrapper(vout);
777 778
}

779
static void ThreadDisplayOsdTitle(vout_thread_t *vout, const char *string)
780
{
781
    if (!vout->p->title.show)
782 783
        return;

784 785 786
    vout_OSDText(vout, SPU_DEFAULT_CHANNEL,
                 vout->p->title.position, INT64_C(1000) * vout->p->title.timeout,
                 string);
787 788
}

789
static void ThreadChangeFilters(vout_thread_t *vout, const char *filters)
790
{
791
    es_format_t fmt;
792 793
    es_format_Init(&fmt, VIDEO_ES, vout->p->original.i_chroma);
    fmt.video = vout->p->original;
794

795 796
    vlc_mutex_lock(&vout->p->vfilter_lock);

Laurent Aimar's avatar
Laurent Aimar committed
797 798
    filter_chain_Reset(vout->p->vfilter_chain, &fmt, &fmt);
    if (filter_chain_AppendFromString(vout->p->vfilter_chain,
799 800
                                      filters) < 0)
        msg_Err(vout, "Video filter chain creation failed");
801

802 803
    vlc_mutex_unlock(&vout->p->vfilter_lock);
}
804

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
static void ThreadChangePause(vout_thread_t *vout, bool is_paused, mtime_t date)
{
    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;
824
    }
825 826
    vout->p->pause.is_on = is_paused;
    vout->p->pause.date  = date;
827 828
}

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
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 ... */
    }
}

878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
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);
}
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 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
static void ThreadChangeAspectRatio(vout_thread_t *vout,
                                    unsigned num, unsigned den)
{
    const video_format_t *source = &vout->p->original;

    if (num > 0 && den > 0) {
        num *= source->i_visible_height;
        den *= source->i_visible_width;
        vlc_ureduce(&num, &den, num, den, 0);
    }
    vout_SetDisplayAspect(vout->p->display.vd, num, den);
}


static void ThreadExecuteCropWindow(vout_thread_t *vout,
                                    unsigned crop_num, unsigned crop_den,
                                    unsigned x, unsigned y,
                                    unsigned width, unsigned height)
{
    const video_format_t *source = &vout->p->original;

    vout_SetDisplayCrop(vout->p->display.vd,
                        crop_num, crop_den,
                        source->i_x_offset + x,
                        source->i_y_offset + y,
                        width, height);
}
static void ThreadExecuteCropBorder(vout_thread_t *vout,
                                    unsigned left, unsigned top,
                                    unsigned right, unsigned bottom)
{
    const video_format_t *source = &vout->p->original;
    ThreadExecuteCropWindow(vout, 0, 0,
                            left,
                            top,
                            /* At worst, it becomes < 0 (but unsigned) and will be rejected */
                            source->i_visible_width  - (left + right),
                            source->i_visible_height - (top  + bottom));
}

static void ThreadExecuteCropRatio(vout_thread_t *vout,
                                   unsigned num, unsigned den)
{
    const video_format_t *source = &vout->p->original;

    int x, y;
    int width, height;
    if (num <= 0 || den <= 0) {
        num = 0;
        den = 0;
        x   = 0;
        y   = 0;
        width  = source->i_visible_width;
        height = source->i_visible_height;
    } else {
        unsigned scaled_width  = (uint64_t)source->i_visible_height * num * source->i_sar_den / den / source->i_sar_num;
        unsigned scaled_height = (uint64_t)source->i_visible_width  * den * source->i_sar_num / num / source->i_sar_den;

        if (scaled_width < source->i_visible_width) {
            x      = (source->i_visible_width - scaled_width) / 2;
            y      = 0;
            width  = scaled_width;
            height = source->i_visible_height;
        } else {
            x      = 0;
            y      = (source->i_visible_height - scaled_height) / 2;
            width  = source->i_visible_width;
            height = scaled_height;
        }
    }
    ThreadExecuteCropWindow(vout, num, den, x, y, width, height);
}

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
static int ThreadInit(vout_thread_t *vout)
{
    vout->p->dead = false;

    if (vout_OpenWrapper(vout, vout->p->psz_module_name))
        return VLC_EGENERIC;
    if (vout_InitWrapper(vout))
        return VLC_EGENERIC;
    assert(vout->p->decoder_pool);

    vout->p->displayed.decoded = NULL;

    PrintVideoFormat(vout, "original format", &vout->p->original);
    return VLC_SUCCESS;
}

998 999
static void ThreadClean(vout_thread_t *vout)
{
1000 1001 1002
    /* Destroy the video filters2 */
    filter_chain_Delete(vout->p->vfilter_chain);

1003
    /* Destroy translation tables */
1004 1005 1006 1007 1008 1009
    if (vout->p->display.vd) {
        if (vout->p->decoder_pool) {
            ThreadFlush(vout, true, INT64_MAX);
            vout_EndWrapper(vout);
        }
        vout_CloseWrapper(vout);
1010
    }
1011 1012 1013 1014 1015 1016 1017

    /* Detach subpicture unit from both input and vout */
    spu_Attach(vout->p->p_spu, VLC_OBJECT(vout), false);
    vlc_object_detach(vout->p->p_spu);

    vout->p->dead = true;
    vout_control_Dead(&vout->p->control);
1018 1019
}

1020
/*****************************************************************************
1021
 * Thread: video output thread
1022 1023 1024 1025 1026
 *****************************************************************************
 * 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.
 *****************************************************************************/
1027
static void *Thread(void *object)
1028 1029
{
    vout_thread_t *vout = object;
1030

1031 1032 1033 1034 1035 1036 1037
    vout_interlacing_support_t interlacing = {
        .is_interlaced = false,
        .date = mdate(),
    };
    vout_postprocessing_support_t postprocessing = {
        .qtype = QTYPE_NONE,
    };
1038

1039
    mtime_t deadline = VLC_TS_INVALID;
1040
    for (;;) {
1041 1042 1043 1044 1045 1046
        vout_control_cmd_t cmd;

        /* FIXME remove thoses ugly timeouts
         */
        while (!vout_control_Pop(&vout->p->control, &cmd, deadline, 100000)) {
            switch(cmd.type) {
1047 1048 1049 1050 1051 1052 1053 1054 1055
            case VOUT_CONTROL_INIT:
                if (ThreadInit(vout)) {
                    ThreadClean(vout);
                    return NULL;
                }
                break;
            case VOUT_CONTROL_CLEAN:
                ThreadClean(vout);
                return NULL;
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
            case VOUT_CONTROL_OSD_TITLE:
                ThreadDisplayOsdTitle(vout, cmd.u.string);
                break;
            case VOUT_CONTROL_CHANGE_FILTERS:
                ThreadChangeFilters(vout, cmd.u.string);
                break;
            case VOUT_CONTROL_PAUSE:
                ThreadChangePause(vout, cmd.u.pause.is_on, cmd.u.pause.date);
                break;
            case VOUT_CONTROL_FLUSH:
                ThreadFlush(vout, false, cmd.u.time);
                break;
            case VOUT_CONTROL_RESET:
                ThreadReset(vout);
                break;
            case VOUT_CONTROL_STEP:
                ThreadStep(vout, cmd.u.time_ptr);
                break;
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
            case VOUT_CONTROL_FULLSCREEN:
                ThreadChangeFullscreen(vout, cmd.u.boolean);
                break;
            case VOUT_CONTROL_ON_TOP:
                ThreadChangeOnTop(vout, cmd.u.boolean);
                break;
            case VOUT_CONTROL_DISPLAY_FILLED:
                ThreadChangeDisplayFilled(vout, cmd.u.boolean);
                break;
            case VOUT_CONTROL_ZOOM:
                ThreadChangeZoom(vout, cmd.u.pair.a, cmd.u.pair.b);
                break;
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
            case VOUT_CONTROL_ASPECT_RATIO:
                ThreadChangeAspectRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
                break;
           case VOUT_CONTROL_CROP_RATIO:
                ThreadExecuteCropRatio(vout, cmd.u.pair.a, cmd.u.pair.b);
                break;
            case VOUT_CONTROL_CROP_WINDOW:
                ThreadExecuteCropWindow(vout, 0, 0,
                                        cmd.u.window.x, cmd.u.window.y,
                                        cmd.u.window.width, cmd.u.window.height);
                break;
            case VOUT_CONTROL_CROP_BORDER:
                ThreadExecuteCropBorder(vout,
                                        cmd.u.border.left,  cmd.u.border.top,
                                        cmd.u.border.right, cmd.u.border.bottom);
                break;
1102 1103 1104 1105 1106 1107
            default:
                break;
            }
            vout_control_cmd_Clean(&cmd);
        }

1108
        ThreadManage(vout, &deadline, &interlacing, &postprocessing);
Sam Hocevar's avatar
 
Sam Hocevar committed
1109
    }
Michel Kaempf's avatar
Michel Kaempf committed
1110 1111
}

Gildas Bazin's avatar
 
Gildas Bazin committed
1112 1113 1114 1115
/*****************************************************************************
 * object variables callbacks: a bunch of object variables are used by the
 * interfaces to interact with the vout.
 *****************************************************************************/
1116 1117 1118 1119 1120
static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
                       vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
    input_thread_t *p_input;
1121
    (void)psz_cmd; (void)oldval; (void)p_data;
1122 1123 1124 1125 1126 1127

    p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
                                                 FIND_PARENT );
    if (!p_input)
    {
        msg_Err( p_vout, "Input not found" );
1128
        return VLC_EGENERIC;
1129
    }
<