video_output.c 65.6 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 */
Gildas Bazin's avatar
 
Gildas Bazin committed
82 83
static int DeinterlaceCallback( vlc_object_t *, char const *,
                                vlc_value_t, vlc_value_t, void * );
84 85
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
86 87
static int VideoFilter2Callback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
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 * );
Gildas Bazin's avatar
 
Gildas Bazin committed
93

94 95 96
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

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

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

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

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

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

130
    p_picture->i_status = READY_PICTURE;
131 132 133 134 135 136

    return p_picture;
}

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

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

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

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

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

177
    /* TODO: find a suitable unused video output */
178 179 180 181

    /* If we now have a video output, check it has the right properties */
    if( p_vout )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
182
        char *psz_filter_chain;
183
        vlc_value_t val;
Gildas Bazin's avatar
 
Gildas Bazin committed
184

185 186
        vlc_mutex_lock( &p_vout->change_lock );

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

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

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

210
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
211 212
        }

213 214 215
        if( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ||
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
216
            p_vout->p->b_filter_change )
217
        {
218 219
            vlc_mutex_unlock( &p_vout->change_lock );

220
            /* We are not interested in this format, close this vout */
221
            vout_CloseAndRelease( p_vout );
222
            vlc_object_release( p_vout );
223 224 225 226 227
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
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 274 275
            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" );

276
            spu_Attach( p_vout->p_spu, p_this, true );
277 278

            vlc_object_detach( p_vout );
279 280 281 282 283 284 285 286
            vlc_object_attach( p_vout, p_this );
        }
    }

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

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

    return p_vout;
}

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

305 306
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
307 308 309
    vlc_fourcc_t i_chroma = p_fmt->i_chroma;
    unsigned int i_aspect = p_fmt->i_aspect;

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

314 315 316 317 318 319 320 321
    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;

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

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

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

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
357 358 359 360 361
    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;

362 363 364
    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
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381

    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;
382 383
    p_vout->b_autoscale  = 1;
    p_vout->i_zoom      = ZOOM_FP_FACTOR;
Gildas Bazin's avatar
 
Gildas Bazin committed
384
    p_vout->b_fullscreen = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
385
    p_vout->i_alignment  = 0;
386 387
    p_vout->p->render_time  = 10;
    p_vout->p->c_fps_samples = 0;
388 389
    p_vout->p->i_picture_lost = 0;
    p_vout->p->i_picture_displayed = 0;
390
    p_vout->p->b_filter_change = 0;
Laurent Aimar's avatar
Laurent Aimar committed
391 392
    p_vout->p->b_paused = false;
    p_vout->p->i_pause_date = 0;
393
    p_vout->pf_control = NULL;
394 395
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
396
    p_vout->p->p_picture_displayed = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
397 398 399
    p_vout->p->i_picture_displayed_date = 0;
    p_vout->p->b_picture_displayed = false;
    p_vout->p->b_picture_empty = false;
400
    p_vout->p->i_picture_qtype = QTYPE_NONE;
Gildas Bazin's avatar
 
Gildas Bazin committed
401

402 403 404 405 406 407
    p_vout->p->snapshot.b_available = true;
    p_vout->p->snapshot.i_request = 0;
    p_vout->p->snapshot.p_picture = NULL;
    vlc_mutex_init( &p_vout->p->snapshot.lock );
    vlc_cond_init( &p_vout->p->snapshot.wait );

Gildas Bazin's avatar
 
Gildas Bazin committed
408
    /* Initialize locks */
409 410
    vlc_mutex_init( &p_vout->picture_lock );
    vlc_cond_init( &p_vout->p->picture_wait );
411
    vlc_mutex_init( &p_vout->change_lock );
412
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
413

414 415 416 417 418
    /* 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 );
419
    var_Create( p_vout, "mouse-clicked", VLC_VAR_BOOL );
420

421
    /* Initialize subpicture unit */
422
    p_vout->p_spu = spu_Create( p_vout );
423
    spu_Attach( p_vout->p_spu, p_parent, true );
424

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

428 429
    spu_Init( p_vout->p_spu );

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

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

        /* Apply video filter2 objects on the first vout */
442
        p_vout->p->psz_vf2 =
443
            var_CreateGetStringCommand( p_vout, "video-filter" );
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" );
Gildas Bazin's avatar
 
Gildas Bazin committed
462 463
    }

464
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
465
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
466
        false, video_filter_buffer_allocation_init, NULL, p_vout );
467

Gildas Bazin's avatar
 
Gildas Bazin committed
468
    /* Choose the video output module */
469
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
470
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
471 472
        var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "vout", &val );
Antoine Cellerier's avatar
Antoine Cellerier committed
473
        psz_parser = val.psz_string;
Gildas Bazin's avatar
 
Gildas Bazin committed
474 475 476
    }
    else
    {
477 478
        psz_parser = strdup( p_vout->p->psz_filter_chain );
        p_vout->p->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
479 480
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
481
    /* Create the vout thread */
482
    char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
483
    free( psz_parser );
484
    free( psz_tmp );
485
    p_vout->p_cfg = p_cfg;
486
    p_vout->p_module = module_need( p_vout,
487 488
        ( 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 );
489
    free( psz_name );
Sam Hocevar's avatar
 
Sam Hocevar committed
490

491 492
    vlc_object_set_destructor( p_vout, vout_Destructor );

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

Gildas Bazin's avatar
 
Gildas Bazin committed
503
    /* Create a few object variables for interface interaction */
504
    /* Deinterlacing */
Gildas Bazin's avatar
 
Gildas Bazin committed
505 506 507
    var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
    text.psz_string = _("Deinterlace");
    var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
508
    val.psz_string = (char *)""; text.psz_string = _("Disable");
Gildas Bazin's avatar
 
Gildas Bazin committed
509
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
510
    val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
Gildas Bazin's avatar
 
Gildas Bazin committed
511
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
512
    val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
Gildas Bazin's avatar
 
Gildas Bazin committed
513
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
514
    val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
Gildas Bazin's avatar
 
Gildas Bazin committed
515
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
516
    val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
Gildas Bazin's avatar
 
Gildas Bazin committed
517
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
518
    val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
Gildas Bazin's avatar
 
Gildas Bazin committed
519
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
520
    val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
521 522
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );

Gildas Bazin's avatar
 
Gildas Bazin committed
523 524 525
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
526
        free( val.psz_string );
Gildas Bazin's avatar
 
Gildas Bazin committed
527
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
528 529
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

530
    /* */
531
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
532
    text.psz_string = _("Filters");
533 534
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
535

536 537 538
    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
539
    {
540
        module_unneed( p_vout, p_vout->p_module );
Laurent Aimar's avatar
Laurent Aimar committed
541
        p_vout->p_module = NULL;
542
        spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
543 544
        spu_Destroy( p_vout->p_spu );
        p_vout->p_spu = NULL;
545
        vlc_object_release( p_vout );
546 547 548
        return NULL;
    }

549 550 551 552 553 554 555 556 557
    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 );

558 559 560
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );
561
        vout_CloseAndRelease( p_vout );
562
        return NULL;
563
    }
Michel Kaempf's avatar
Michel Kaempf committed
564

565
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
566 567
}

568
/*****************************************************************************
569
 * vout_Close: Close a vout created by vout_Create.
570
 *****************************************************************************
571
 * 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
572
 * You should NEVER call it on vout not obtained through vout_Create
573
 * (like with vout_Request or vlc_object_find.)
574
 * You can use vout_CloseAndRelease() as a convenience method.
575
 *****************************************************************************/
576
void vout_Close( vout_thread_t *p_vout )
577 578 579
{
    assert( p_vout );

580 581 582 583
    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 );
584 585 586 587 588 589

    vlc_mutex_lock( &p_vout->p->snapshot.lock );
    p_vout->p->snapshot.b_available = false;
    vlc_cond_broadcast( &p_vout->p->snapshot.wait );
    vlc_mutex_unlock( &p_vout->p->snapshot.lock );

590
    vlc_join( p_vout->p->thread, NULL );
591
    module_unneed( p_vout, p_vout->p_module );
592
    p_vout->p_module = NULL;
593 594 595
}

/* */
596 597
static void vout_Destructor( vlc_object_t * p_this )
{
598
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
599

600 601 602
    /* Make sure the vout was stopped first */
    assert( !p_vout->p_module );

Laurent Aimar's avatar
Laurent Aimar committed
603
    /* */
604 605
    if( p_vout->p_spu )
        spu_Destroy( p_vout->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
606

607
    /* Destroy the locks */
608
    vlc_cond_destroy( &p_vout->p->change_wait );
609
    vlc_cond_destroy( &p_vout->p->picture_wait );
610 611
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
612
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
613

614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
    /* */
    for( ;; )
    {
        picture_t *p_picture = p_vout->p->snapshot.p_picture;
        if( !p_picture )
            break;

        p_vout->p->snapshot.p_picture = p_picture->p_next;

        picture_Release( p_picture );
    }
    vlc_cond_destroy( &p_vout->p->snapshot.wait );
    vlc_mutex_destroy( &p_vout->p->snapshot.lock );

    /* */
629
    free( p_vout->p->psz_filter_chain );
630
    free( p_vout->p->psz_title );
Gildas Bazin's avatar
 
Gildas Bazin committed
631

632 633
    config_ChainDestroy( p_vout->p_cfg );

634 635
    free( p_vout->p );

636
#ifndef __APPLE__
637
    vout_thread_t *p_another_vout;
638

639 640 641 642 643 644 645 646
    /* 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 )
647
        var_SetBool( p_this->p_libvlc, "intf-show", true );
648 649
    else
        vlc_object_release( p_another_vout );
650
#endif
Michel Kaempf's avatar
Michel Kaempf committed
651 652
}

Laurent Aimar's avatar
Laurent Aimar committed
653 654 655
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
656
    vlc_mutex_lock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
657

658
    assert( !p_vout->p->b_paused || !b_paused );
Laurent Aimar's avatar
Laurent Aimar committed
659 660 661 662 663

    vlc_mutex_lock( &p_vout->picture_lock );

    p_vout->p->i_picture_displayed_date = 0;

Laurent Aimar's avatar
Laurent Aimar committed
664 665 666 667 668 669 670 671 672 673 674
    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;
        }
675 676 677
        vlc_cond_signal( &p_vout->p->picture_wait );
        vlc_mutex_unlock( &p_vout->picture_lock );

Laurent Aimar's avatar
Laurent Aimar committed
678
        spu_OffsetSubtitleDate( p_vout->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
679
    }
Laurent Aimar's avatar
Laurent Aimar committed
680 681 682 683
    else
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
    }
Laurent Aimar's avatar
Laurent Aimar committed
684 685 686
    p_vout->p->b_paused = b_paused;
    p_vout->p->i_pause_date = i_date;

687
    vlc_mutex_unlock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
688
}
689

690 691
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
692
    vlc_mutex_lock( &p_vout->change_lock );
693 694 695 696 697 698 699

    *pi_displayed = p_vout->p->i_picture_displayed;
    *pi_lost = p_vout->p->i_picture_lost;

    p_vout->p->i_picture_displayed = 0;
    p_vout->p->i_picture_lost = 0;

700
    vlc_mutex_unlock( &p_vout->change_lock );
701
}
702

Laurent Aimar's avatar
Laurent Aimar committed
703 704 705
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
706
    p_vout->p->i_picture_displayed_date = 0;
Laurent Aimar's avatar
Laurent Aimar committed
707 708 709
    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
710

Laurent Aimar's avatar
Laurent Aimar committed
711 712 713 714 715 716 717 718 719
        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;
        }
    }
720
    vlc_cond_signal( &p_vout->p->picture_wait );
Laurent Aimar's avatar
Laurent Aimar committed
721 722
    vlc_mutex_unlock( &p_vout->picture_lock );
}
723

724
void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
725 726 727 728 729
{
    int i_pic, i_ready_pic;

    vlc_mutex_lock( &p_vout->picture_lock );

730
    for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
    {
        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;
        }
    }
753
    if( i_pic < p_vout->render.i_pictures && !b_forced )
754 755 756 757 758 759 760
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
        return;
    }

    /* Too many pictures are still referenced, there is probably a bug
     * with the decoder */
761 762
    if( !b_forced )
        msg_Err( p_vout, "pictures leaked, resetting the heap" );
763 764 765 766 767

    /* 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
768 769

        msg_Dbg( p_vout, "[%d] %d %d", i_pic, p_pic->i_status, p_pic->i_refcount );
770
        p_pic->i_refcount = 0;
Laurent Aimar's avatar
Laurent Aimar committed
771 772 773 774 775 776 777 778 779 780

        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;
        }
781
    }
782
    vlc_cond_signal( &p_vout->p->picture_wait );
783 784
    vlc_mutex_unlock( &p_vout->picture_lock );
}
Laurent Aimar's avatar
Laurent Aimar committed
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
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 );
}
808

809 810 811 812 813 814 815
void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
{
    assert( psz_title );

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

816
    vlc_mutex_lock( &p_vout->change_lock );
817 818
    free( p_vout->p->psz_title );
    p_vout->p->psz_title = strdup( psz_title );
819
    vlc_mutex_unlock( &p_vout->change_lock );
820
}
821

822
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
823
 * InitThread: initialize video output thread
824
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
825 826 827
 * 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.
828
 * XXX You have to enter it with change_lock taken.
829
 *****************************************************************************/
830 831
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
832

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
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;

     if( p_output->i_chroma != FOURCC_RV15 &&
         p_output->i_chroma != FOURCC_RV16 &&
         p_output->i_chroma != FOURCC_RV24 &&
         p_output->i_chroma != FOURCC_RV32 )
         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
849
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
850
{
851
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
852

Sam Hocevar's avatar
 
Sam Hocevar committed
853
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
854
    if( p_vout->pf_init( p_vout ) )
855
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
856

857 858
    p_vout->p->p_picture_displayed = NULL;

Sam Hocevar's avatar
 
Sam Hocevar committed
859
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
860
    {
861 862
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
863
        p_vout->pf_end( p_vout );
864
        return VLC_EGENERIC;
865
    }
Vincent Seguin's avatar
Vincent Seguin committed
866

Gildas Bazin's avatar
 
Gildas Bazin committed
867 868 869 870 871 872 873 874
    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;
    }

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

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
    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
900 901
    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 );
902 903

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

905
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
906
    /* Calculate shifts from system-updated masks */
907 908 909 910 911
    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
912

basos g's avatar
basos g committed
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
    /* 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