video_output.c 67 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.
Sam Hocevar's avatar
Sam Hocevar committed
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

Sam Hocevar's avatar
 
Sam Hocevar committed
41

42 43
#ifdef HAVE_SYS_TIMES_H
#   include <sys/times.h>
44
#endif
45

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

Clément Stenac's avatar
Clément Stenac committed
48 49
#include <vlc_filter.h>
#include <vlc_osd.h>
Laurent Aimar's avatar
Laurent Aimar committed
50
#include <assert.h>
51

52
#if defined( __APPLE__ )
Clément Stenac's avatar
Clément Stenac committed
53
/* Include darwin_specific.h here if needed */
54 55
#endif

Clément Stenac's avatar
Clément Stenac committed
56 57
/** FIXME This is quite ugly but needed while we don't have counters
 * helpers */
58
//#include "input/input_internal.h"
Clément Stenac's avatar
Clément Stenac committed
59

60 61
#include <libvlc.h>
#include <vlc_input.h>
62
#include "vout_pictures.h"
Laurent Aimar's avatar
Laurent Aimar committed
63
#include "vout_internal.h"
64

65
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
66
 * Local prototypes
67
 *****************************************************************************/
68
static int      InitThread        ( vout_thread_t * );
69
static void*    RunThread         ( void *  );
70
static void     ErrorThread       ( vout_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
71
static void     CleanThread       ( vout_thread_t * );
72
static void     EndThread         ( vout_thread_t * );
Sam Hocevar's avatar
 
Sam Hocevar committed
73

74
static void     AspectRatio       ( int, int *, int * );
Michel Kaempf's avatar
Michel Kaempf committed
75

Laurent Aimar's avatar
Laurent Aimar committed
76
static void VideoFormatImportRgb( video_format_t *, const picture_heap_t * );
77 78
static void PictureHeapFixRgb( picture_heap_t * );

79 80
static void     vout_Destructor   ( vlc_object_t * p_this );

Gildas Bazin's avatar
 
Gildas Bazin committed
81
/* Object variables callbacks */
82 83
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
84 85
static int VideoFilter2Callback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
Laurent Aimar's avatar
Laurent Aimar committed
86 87

/* */
88 89 90 91 92
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 * );
Laurent Aimar's avatar
Laurent Aimar committed
93 94
/* */
static void DeinterlaceEnable( vout_thread_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
95

96 97 98
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

99 100 101
/* Display media title in OSD */
static void DisplayTitleOnOSD( vout_thread_t *p_vout );

102 103
/* Time during which the thread will sleep if it has nothing to
 * display (in micro-seconds) */
104
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
105 106 107 108 109 110 111 112 113 114 115

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

116 117 118 119 120 121 122 123
/* 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

124 125 126 127 128
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
129
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
130
    picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
131

132
    p_picture->i_status = READY_PICTURE;
133 134 135 136 137 138

    return p_picture;
}

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

141 142 143
    vlc_mutex_lock( &p_vout->picture_lock );
    vout_UsePictureLocked( p_vout, p_pic );
    vlc_mutex_unlock( &p_vout->picture_lock );
144 145 146 147 148 149 150 151
}

static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
{
    p_filter->pf_vout_buffer_new = video_new_buffer_filter;
    p_filter->pf_vout_buffer_del = video_del_buffer_filter;
    p_filter->p_owner = p_data; /* p_vout */
    return VLC_SUCCESS;
152 153
}

154
/*****************************************************************************
155 156 157 158 159
 * 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.
 *****************************************************************************/
160 161
vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                               video_format_t *p_fmt )
162
{
163
    if( !p_fmt )
164
    {
165 166 167
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
168
        if( p_vout )
169
            vout_CloseAndRelease( p_vout );
170 171 172 173 174 175
        return NULL;
    }

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

179
    /* TODO: find a suitable unused video output */
180 181 182 183

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

186
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
187
         * performance reasons. */
188
        if( p_vout->p->b_filter_change )
Gildas Bazin's avatar
 
Gildas Bazin committed
189
        {
190
            char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
191

192
            if( psz_filter_chain && !*psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
193 194 195 196
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
197
            if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
198
            {
199 200
                free( p_vout->p->psz_filter_chain );
                p_vout->p->psz_filter_chain = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
201 202
            }

203
            if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
204
            {
205
                p_vout->p->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
206 207
            }

208
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
209 210
        }

211
        if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
212 213
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
214
            p_vout->p->b_filter_change )
215
        {
216 217
            vlc_mutex_unlock( &p_vout->change_lock );

218
            /* We are not interested in this format, close this vout */
219
            vout_CloseAndRelease( p_vout );
220
            vlc_object_release( p_vout );
221 222 223 224 225
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
            if( p_vout->fmt_render.i_aspect != p_fmt->i_aspect )
            {
                /* 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;
                unsigned int i_aspect;

                i_aspect = p_fmt->i_aspect;
                vlc_ureduce( &i_sar_num, &i_sar_den,
                             p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
#if 0
                /* What's that, it does not seems to be used correcly everywhere
                 * beside the previous p_vout->fmt_render.i_aspect != p_fmt->i_aspect
                 * should be fixed to use it too then */
                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;
                    i_aspect = i_aspect * p_vout->i_par_den / p_vout->i_par_num;
                }
#endif

                if( i_sar_num > 0 && i_sar_den > 0 && i_aspect > 0 )
                {
                    p_vout->fmt_in.i_sar_num = i_sar_num;
                    p_vout->fmt_in.i_sar_den = i_sar_den;
                    p_vout->fmt_in.i_aspect  = i_aspect;

                    p_vout->fmt_render.i_sar_num = i_sar_num;
                    p_vout->fmt_render.i_sar_den = i_sar_den;
                    p_vout->fmt_render.i_aspect  = i_aspect;

                    p_vout->render.i_aspect   = i_aspect;

                    p_vout->i_changes |= VOUT_ASPECT_CHANGE;

                }
            }
            vlc_mutex_unlock( &p_vout->change_lock );

            vlc_object_release( p_vout );
        }

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

274
            spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
275
            vlc_object_detach( p_vout );
276

277
            vlc_object_attach( p_vout, p_this );
278
            spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );
279 280 281 282 283 284 285
        }
    }

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

286
        p_vout = vout_Create( p_this, p_fmt );
287 288 289 290 291 292 293
    }

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
294
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
295 296
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
297
 *****************************************************************************/
298
vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
299
{
Gildas Bazin's avatar
 
Gildas Bazin committed
300 301
    vout_thread_t  * p_vout;                            /* thread descriptor */
    int              i_index;                               /* loop variable */
302
    vlc_value_t      text;
Michel Kaempf's avatar
Michel Kaempf committed
303

304 305
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
306
    vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
307 308
    unsigned int i_aspect = p_fmt->i_aspect;

309 310 311 312
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

313 314 315 316 317 318 319 320
    if( i_width <= 0 || i_height <= 0 || i_aspect <= 0 )
        return NULL;

    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;

321
    /* Allocate descriptor */
322 323 324
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
325
    if( p_vout == NULL )
326
        return NULL;
327

328
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
329
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
330 331 332 333 334 335
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

336
    /* Initialize pictures - translation tables and functions
Gildas Bazin's avatar
 
Gildas Bazin committed
337
     * will be initialized later in InitThread */
338
    for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
Gildas Bazin's avatar
 
Gildas Bazin committed
339 340 341 342 343
    {
        p_vout->p_picture[i_index].pf_lock = NULL;
        p_vout->p_picture[i_index].pf_unlock = NULL;
        p_vout->p_picture[i_index].i_status = FREE_PICTURE;
        p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
344
        p_vout->p_picture[i_index].b_slow   = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
345 346 347 348 349 350 351
    }

    /* No images in the heap */
    p_vout->i_heap_size = 0;

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

353 354
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
355

Gildas Bazin's avatar
 
Gildas Bazin committed
356 357 358 359 360
    p_vout->render.i_width    = i_width;
    p_vout->render.i_height   = i_height;
    p_vout->render.i_chroma   = i_chroma;
    p_vout->render.i_aspect   = i_aspect;

361 362 363
    p_vout->render.i_rmask    = p_fmt->i_rmask;
    p_vout->render.i_gmask    = p_fmt->i_gmask;
    p_vout->render.i_bmask    = p_fmt->i_bmask;
Gildas Bazin's avatar
 
Gildas Bazin committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

    p_vout->render.i_last_used_pic = -1;
    p_vout->render.b_allow_modify_pics = 1;

    /* Zero the output heap */
    I_OUTPUTPICTURES = 0;
    p_vout->output.i_width    = 0;
    p_vout->output.i_height   = 0;
    p_vout->output.i_chroma   = 0;
    p_vout->output.i_aspect   = 0;

    p_vout->output.i_rmask    = 0;
    p_vout->output.i_gmask    = 0;
    p_vout->output.i_bmask    = 0;

    /* Initialize misc stuff */
    p_vout->i_changes    = 0;
381 382
    p_vout->b_autoscale  = 1;
    p_vout->i_zoom      = ZOOM_FP_FACTOR;
Gildas Bazin's avatar
 
Gildas Bazin committed
383
    p_vout->b_fullscreen = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
384
    p_vout->i_alignment  = 0;
385 386
    p_vout->p->render_time  = 10;
    p_vout->p->c_fps_samples = 0;
387
    vout_statistic_Init( &p_vout->p->statistic );
388
    p_vout->p->b_filter_change = 0;
Laurent Aimar's avatar
Laurent Aimar committed
389 390
    p_vout->p->b_paused = false;
    p_vout->p->i_pause_date = 0;
391
    p_vout->pf_control = NULL;
392 393
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
394
    p_vout->p->p_picture_displayed = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
395 396 397
    p_vout->p->i_picture_displayed_date = 0;
    p_vout->p->b_picture_displayed = false;
    p_vout->p->b_picture_empty = false;
398
    p_vout->p->i_picture_qtype = QTYPE_NONE;
Gildas Bazin's avatar
 
Gildas Bazin committed
399

400 401
    vlc_mouse_Init( &p_vout->p->mouse );

402
    vout_snapshot_Init( &p_vout->p->snapshot );
403

Gildas Bazin's avatar
 
Gildas Bazin committed
404
    /* Initialize locks */
405 406
    vlc_mutex_init( &p_vout->picture_lock );
    vlc_cond_init( &p_vout->p->picture_wait );
407
    vlc_mutex_init( &p_vout->change_lock );
408
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
409

410 411 412 413 414
    /* Mouse coordinates */
    var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
    var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
    var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
    var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
415
    var_Create( p_vout, "mouse-clicked", VLC_VAR_BOOL );
416

417
    /* Initialize subpicture unit */
418
    p_vout->p_spu = spu_Create( p_vout );
419

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

423
    /* */
424 425
    spu_Init( p_vout->p_spu );

426 427
    spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );

428 429
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
430

Gildas Bazin's avatar
 
Gildas Bazin committed
431 432
    /* If the parent is not a VOUT object, that means we are at the start of
     * the video output pipe */
433
    if( vlc_internals( p_parent )->i_object_type != VLC_OBJECT_VOUT )
Sam Hocevar's avatar
 
Sam Hocevar committed
434
    {
435
        /* Look for the default filter configuration */
436
        p_vout->p->psz_filter_chain =
437
            var_CreateGetStringCommand( p_vout, "vout-filter" );
438 439

        /* Apply video filter2 objects on the first vout */
440
        p_vout->p->psz_vf2 =
441
            var_CreateGetStringCommand( p_vout, "video-filter" );
442 443

        p_vout->p->b_first_vout = true;
Gildas Bazin's avatar
 
Gildas Bazin committed
444 445 446 447
    }
    else
    {
        /* continue the parent's filter chain */
448
        char *psz_tmp;
Gildas Bazin's avatar
 
Gildas Bazin committed
449

450
        /* Ugly hack to jump to our configuration chain */
451 452 453 454
        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 );
455 456
        config_ChainDestroy( p_cfg );
        free( psz_tmp );
457 458

        /* Create a video filter2 var ... but don't inherit values */
459 460
        var_Create( p_vout, "video-filter",
                    VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
461
        p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
462 463 464

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

467
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
468
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
469
        false, video_filter_buffer_allocation_init, NULL, p_vout );
470

Gildas Bazin's avatar
 
Gildas Bazin committed
471
    /* Choose the video output module */
472
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
473
    {
474
        psz_parser = var_CreateGetString( p_vout, "vout" );
Gildas Bazin's avatar
 
Gildas Bazin committed
475 476 477
    }
    else
    {
478 479
        psz_parser = strdup( p_vout->p->psz_filter_chain );
        p_vout->p->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
480 481
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
482
    /* Create the vout thread */
483
    char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
484
    free( psz_parser );
485
    free( psz_tmp );
486
    p_vout->p_cfg = p_cfg;
487
    p_vout->p_module = module_need( p_vout,
488 489
        ( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain ) ?
        "video filter" : "video output", psz_name, p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain );
490
    free( psz_name );
Sam Hocevar's avatar
 
Sam Hocevar committed
491

492 493
    vlc_object_set_destructor( p_vout, vout_Destructor );

Sam Hocevar's avatar
 
Sam Hocevar committed
494 495
    if( p_vout->p_module == NULL )
    {
496
        msg_Err( p_vout, "no suitable vout module" );
497
        spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
498 499
        spu_Destroy( p_vout->p_spu );
        p_vout->p_spu = NULL;
500
        vlc_object_release( p_vout );
501
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
502
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
503

Gildas Bazin's avatar
 
Gildas Bazin committed
504
    /* Create a few object variables for interface interaction */
505
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
506
    text.psz_string = _("Filters");
507 508
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
509

Laurent Aimar's avatar
Laurent Aimar committed
510 511 512 513
    /* */
    DeinterlaceEnable( p_vout );

    /* */
514 515 516
    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
517
    {
518
        module_unneed( p_vout, p_vout->p_module );
Laurent Aimar's avatar
Laurent Aimar committed
519
        p_vout->p_module = NULL;
520
        spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
521 522
        spu_Destroy( p_vout->p_spu );
        p_vout->p_spu = NULL;
523
        vlc_object_release( p_vout );
524 525 526
        return NULL;
    }

527 528 529 530 531 532 533 534 535
    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 );

536 537 538
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );
539
        vout_CloseAndRelease( p_vout );
540
        return NULL;
541
    }
Michel Kaempf's avatar
Michel Kaempf committed
542

543
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
544 545
}

546
/*****************************************************************************
547
 * vout_Close: Close a vout created by vout_Create.
548
 *****************************************************************************
549
 * 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
550
 * You should NEVER call it on vout not obtained through vout_Create
551
 * (like with vout_Request or vlc_object_find.)
552
 * You can use vout_CloseAndRelease() as a convenience method.
553
 *****************************************************************************/
554
void vout_Close( vout_thread_t *p_vout )
555 556 557
{
    assert( p_vout );

558 559 560 561
    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 );
562

563
    vout_snapshot_End( &p_vout->p->snapshot );
564

565
    vlc_join( p_vout->p->thread, NULL );
566
    module_unneed( p_vout, p_vout->p_module );
567
    p_vout->p_module = NULL;
568 569 570
}

/* */
571 572
static void vout_Destructor( vlc_object_t * p_this )
{
573
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
574

575 576 577
    /* Make sure the vout was stopped first */
    assert( !p_vout->p_module );

Laurent Aimar's avatar
Laurent Aimar committed
578
    /* */
579 580
    if( p_vout->p_spu )
        spu_Destroy( p_vout->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
581

582
    /* Destroy the locks */
583
    vlc_cond_destroy( &p_vout->p->change_wait );
584
    vlc_cond_destroy( &p_vout->p->picture_wait );
585 586
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
587
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
588

589 590 591
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

592
    /* */
593
    vout_snapshot_Clean( &p_vout->p->snapshot );
594 595

    /* */
596
    free( p_vout->p->psz_filter_chain );
597
    free( p_vout->p->psz_title );
Gildas Bazin's avatar
 
Gildas Bazin committed
598

599 600
    config_ChainDestroy( p_vout->p_cfg );

601 602
    free( p_vout->p );

603
#ifndef __APPLE__
604
    vout_thread_t *p_another_vout;
605

606 607 608 609 610 611 612 613
    /* This is a dirty hack mostly for Linux, where there is no way to get the
     * GUI back if you closed it while playing video. This is solved in
     * Mac OS X, where we have this novelty called menubar, that will always
     * allow you access to the applications main functionality. They should try
     * that on linux sometime. */
    p_another_vout = vlc_object_find( p_this->p_libvlc,
                                      VLC_OBJECT_VOUT, FIND_ANYWHERE );
    if( p_another_vout == NULL )
614
        var_SetBool( p_this->p_libvlc, "intf-show", true );
615 616
    else
        vlc_object_release( p_another_vout );
617
#endif
Michel Kaempf's avatar
Michel Kaempf committed
618 619
}

Laurent Aimar's avatar
Laurent Aimar committed
620 621 622
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
623
    vlc_mutex_lock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
624

625
    assert( !p_vout->p->b_paused || !b_paused );
Laurent Aimar's avatar
Laurent Aimar committed
626 627 628 629 630

    vlc_mutex_lock( &p_vout->picture_lock );

    p_vout->p->i_picture_displayed_date = 0;

Laurent Aimar's avatar
Laurent Aimar committed
631 632 633 634 635 636 637 638 639 640 641
    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;
        }
642 643 644
        vlc_cond_signal( &p_vout->p->picture_wait );
        vlc_mutex_unlock( &p_vout->picture_lock );

Laurent Aimar's avatar
Laurent Aimar committed
645
        spu_OffsetSubtitleDate( p_vout->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
646
    }
Laurent Aimar's avatar
Laurent Aimar committed
647 648 649 650
    else
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
    }
Laurent Aimar's avatar
Laurent Aimar committed
651 652 653
    p_vout->p->b_paused = b_paused;
    p_vout->p->i_pause_date = i_date;

654
    vlc_mutex_unlock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
655
}
656

657 658
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
659 660
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
661
}
662

Laurent Aimar's avatar
Laurent Aimar committed
663 664 665
void vout_Flush( vout_thread_t *p_vout, mtime_t i_date )
{
    vlc_mutex_lock( &p_vout->picture_lock );
Laurent Aimar's avatar
Laurent Aimar committed
666
    p_vout->p->i_picture_displayed_date = 0;
Laurent Aimar's avatar
Laurent Aimar committed
667 668 669
    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
670

Laurent Aimar's avatar
Laurent Aimar committed
671 672 673 674 675 676 677 678 679
        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;
        }
    }
680
    vlc_cond_signal( &p_vout->p->picture_wait );
Laurent Aimar's avatar
Laurent Aimar committed
681 682
    vlc_mutex_unlock( &p_vout->picture_lock );
}
683

684
void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
685 686 687 688 689
{
    int i_pic, i_ready_pic;

    vlc_mutex_lock( &p_vout->picture_lock );

690
    for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
    {
        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;
        }
    }
713
    if( i_pic < p_vout->render.i_pictures && !b_forced )
714 715 716 717 718 719 720
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
        return;
    }

    /* Too many pictures are still referenced, there is probably a bug
     * with the decoder */
721 722
    if( !b_forced )
        msg_Err( p_vout, "pictures leaked, resetting the heap" );
723 724 725 726 727

    /* 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];
Laurent Aimar's avatar
Laurent Aimar committed
728 729

        msg_Dbg( p_vout, "[%d] %d %d", i_pic, p_pic->i_status, p_pic->i_refcount );
730
        p_pic->i_refcount = 0;
Laurent Aimar's avatar
Laurent Aimar committed
731 732 733 734 735 736 737 738 739 740

        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;
        }
741
    }
742
    vlc_cond_signal( &p_vout->p->picture_wait );
743 744
    vlc_mutex_unlock( &p_vout->picture_lock );
}
Laurent Aimar's avatar
Laurent Aimar committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
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 );
}
768

769 770 771 772 773 774 775
void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
{
    assert( psz_title );

    if( !config_GetInt( p_vout, "osd" ) )
        return;

776
    vlc_mutex_lock( &p_vout->change_lock );
777 778
    free( p_vout->p->psz_title );
    p_vout->p->psz_title = strdup( psz_title );
779
    vlc_mutex_unlock( &p_vout->change_lock );
780
}
781

782 783 784 785 786
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
    return p_vout->p_spu;
}

787
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
788
 * InitThread: initialize video output thread
789
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
790 791 792
 * 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.
793
 * XXX You have to enter it with change_lock taken.
794
 *****************************************************************************/
795 796
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
797

798 799 800 801 802
static bool ChromaIsEqual( const picture_heap_t *p_output, const picture_heap_t *p_render )
{
     if( !vout_ChromaCmp( p_output->i_chroma, p_render->i_chroma ) )
         return false;

803 804 805 806
     if( p_output->i_chroma != VLC_CODEC_RGB15 &&
         p_output->i_chroma != VLC_CODEC_RGB16 &&
         p_output->i_chroma != VLC_CODEC_RGB24 &&
         p_output->i_chroma != VLC_CODEC_RGB32 )
807 808 809 810 811 812 813
         return true;

     return p_output->i_rmask == p_render->i_rmask &&
            p_output->i_gmask == p_render->i_gmask &&
            p_output->i_bmask == p_render->i_bmask;
}

Sam Hocevar's avatar
 
Sam Hocevar committed
814
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
815
{
816
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
817

Sam Hocevar's avatar
 
Sam Hocevar committed
818
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
819
    if( p_vout->pf_init( p_vout ) )
820
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
821

822 823
    p_vout->p->p_picture_displayed = NULL;

Sam Hocevar's avatar
 
Sam Hocevar committed
824
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
825
    {
826 827
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
828
        p_vout->pf_end( p_vout );
829
        return VLC_EGENERIC;
830
    }
Vincent Seguin's avatar
Vincent Seguin committed
831

Gildas Bazin's avatar
 
Gildas Bazin committed
832 833 834 835 836 837 838 839
    if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
    {
        msg_Err( p_vout, "plugin allocated too many direct buffers, "
                         "our internal buffers must have overflown." );
        p_vout->pf_end( p_vout );
        return VLC_EGENERIC;
    }

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

842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
    AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );

    AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );

    if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
    {
        p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
            p_vout->output.i_width;
        p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
            p_vout->output.i_height;
        p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;

        p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
        p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
    }
    if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
    {
        p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
            p_vout->fmt_out.i_height;
        p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
            p_vout->fmt_out.i_width;
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
865 866
    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 );
867 868

    AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
Sam Hocevar's avatar
 
Sam Hocevar committed
869

870
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
871
    /* Calculate shifts from system-updated masks */
872 873 874 875 876
    PictureHeapFixRgb( &p_vout->render );
    VideoFormatImportRgb( &p_vout->fmt_render, &p_vout->render );

    PictureHeapFixRgb( &p_vout->output );
    VideoFormatImportRgb( &p_vout->fmt_out, &p_vout->output );
Sam Hocevar's avatar
 
Sam Hocevar committed
877

basos g's avatar
basos g committed
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 908 909
    /* print some usefull debug info about different vout formats
     */
    msg_Dbg( p_vout, "pic render sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, ar %i:%i, sar %i:%i, msk r0x%x g0x%x b0x%x",
             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,
             i_aspect_x, i_aspect_y,
             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 );

    msg_Dbg( p_vout, "pic in sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, ar %i:%i, sar %i:%i, msk r0x%x g0x%x b0x%x",
             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,
             i_aspect_x, i_aspect_y,
             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 );

    msg_Dbg( p_vout, "pic out sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, ar %i:%i, sar %i:%i, msk r0x%x g0x%x b0x%x",
             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,
             i_aspect_x, i_aspect_y,
             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 );

Sam Hocevar's avatar
 
Sam Hocevar committed
910
    /* Check whether we managed to create direct buffers similar to
911
     * the render buffers, ie same size and chroma */
Sam Hocevar's avatar
 
Sam Hocevar committed
912 913
    if( ( p_vout->output.i_width == p_vout->render.i_width )
     && ( p_vout->output.i_height == p_vout->render.i_height )
914
     && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
915
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
916 917 918 919
        /* 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 */
920
        p_vout->p->b_direct = true;
Sam Hocevar's avatar
 
Sam Hocevar committed
921

Sam Hocevar's avatar
 
Sam Hocevar committed
922 923
        for( i = 1; i < VOUT_MAX_PICTURES; i++ )
        {
Gildas Bazin's avatar
 
Gildas Bazin committed
924 925 926 927 928 929 930 931
            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 )
            {
                /* 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
932 933 934
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES