video_output.c 55.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 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 58 59
/** FIXME This is quite ugly but needed while we don't have counters
 * helpers */
#include "input/input_internal.h"

60
#include "modules/modules.h"
61
#include "vout_pictures.h"
Laurent Aimar's avatar
Laurent Aimar committed
62
#include "vout_internal.h"
63

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

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

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

78 79
static void     vout_Destructor   ( vlc_object_t * p_this );

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

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

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

94 95 96
/* */
static void DropPicture( vout_thread_t *p_vout, picture_t *p_picture );

97 98 99 100 101
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
102
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
103
    picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
104

105
    p_picture->i_status = READY_PICTURE;
106 107 108 109 110 111

    return p_picture;
}

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

    DropPicture( p_vout, p_pic );
115 116 117 118 119 120 121 122
}

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;
123 124
}

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

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

151
    /* TODO: find a suitable unused video output */
152 153 154 155

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

159 160
        vlc_mutex_lock( &p_vout->change_lock );

161
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
162 163 164
         * performance reasons. */
        if( p_vout->b_filter_change )
        {
165
            var_Get( p_vout, "vout-filter", &val );
166
            psz_filter_chain = val.psz_string;
Gildas Bazin's avatar
 
Gildas Bazin committed
167

168
            if( psz_filter_chain && !*psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
169 170 171 172
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
173
            if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
174 175 176 177 178
            {
                free( p_vout->psz_filter_chain );
                p_vout->psz_filter_chain = NULL;
            }

179
            if( !psz_filter_chain && !p_vout->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
180
            {
181
                p_vout->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
182 183
            }

184
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
185 186
        }

187 188 189
        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 ||
Gildas Bazin's avatar
 
Gildas Bazin committed
190
            p_vout->b_filter_change )
191
        {
192 193
            vlc_mutex_unlock( &p_vout->change_lock );

194
            /* We are not interested in this format, close this vout */
195
            vout_CloseAndRelease( p_vout );
196
            vlc_object_release( p_vout );
197 198 199 200 201
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
            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" );

250
            spu_Attach( p_vout->p_spu, p_this, true );
251 252

            vlc_object_detach( p_vout );
253
            vlc_object_attach( p_vout, p_this );
254 255 256 257

            /* Display title if we are not using the vout given to vout_Request.
             * XXX for now b_vout_provided is always true at this stage */
            if( p_vout->b_title_show && !b_vout_provided )
258
                DisplayTitleOnOSD( p_vout );
259 260 261 262 263 264 265
        }
    }

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

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

    return p_vout;
}

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

285 286
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
287 288 289
    vlc_fourcc_t i_chroma = p_fmt->i_chroma;
    unsigned int i_aspect = p_fmt->i_aspect;

290 291 292 293
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

294 295 296 297 298 299 300 301
    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;

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

309
    /* Initialize pictures - translation tables and functions
Gildas Bazin's avatar
 
Gildas Bazin committed
310
     * will be initialized later in InitThread */
311
    for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
Gildas Bazin's avatar
 
Gildas Bazin committed
312 313 314 315 316
    {
        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;
317
        p_vout->p_picture[i_index].b_slow   = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
318 319 320 321 322 323 324
    }

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
329 330 331 332 333
    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;

334 335 336
    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
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

    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;
    p_vout->f_gamma      = 0;
    p_vout->b_grayscale  = 0;
    p_vout->b_info       = 0;
    p_vout->b_interface  = 0;
    p_vout->b_scale      = 1;
    p_vout->b_fullscreen = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
360
    p_vout->i_alignment  = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
361 362 363
    p_vout->render_time  = 10;
    p_vout->c_fps_samples = 0;
    p_vout->b_filter_change = 0;
364 365
    p_vout->pf_control = NULL;
    p_vout->p_window = NULL;
366
    p_vout->i_par_num = p_vout->i_par_den = 1;
Gildas Bazin's avatar
 
Gildas Bazin committed
367 368

    /* Initialize locks */
369 370 371
    vlc_mutex_init( &p_vout->picture_lock );
    vlc_mutex_init( &p_vout->change_lock );
    vlc_mutex_init( &p_vout->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
372

373 374 375 376 377 378 379
    /* 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 );
    var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );

380
    /* Initialize subpicture unit */
381
    p_vout->p_spu = spu_Create( p_vout );
382
    spu_Attach( p_vout->p_spu, p_parent, true );
383

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

387 388
    spu_Init( p_vout->p_spu );

389 390
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
391

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

        /* Apply video filter2 objects on the first vout */
401 402
        p_vout->psz_vf2 =
            var_CreateGetStringCommand( p_vout, "video-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
403 404 405 406
    }
    else
    {
        /* continue the parent's filter chain */
407
        char *psz_tmp;
Gildas Bazin's avatar
 
Gildas Bazin committed
408

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

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
427
    /* Choose the video output module */
Gildas Bazin's avatar
 
Gildas Bazin committed
428
    if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
429
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
430 431
        var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "vout", &val );
Antoine Cellerier's avatar
Antoine Cellerier committed
432
        psz_parser = val.psz_string;
Gildas Bazin's avatar
 
Gildas Bazin committed
433 434 435
    }
    else
    {
Antoine Cellerier's avatar
Antoine Cellerier committed
436
        psz_parser = strdup( p_vout->psz_filter_chain );
437
        p_vout->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
438 439
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
440
    /* Create the vout thread */
441
    char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
442
    free( psz_parser );
443
    free( psz_tmp );
444
    p_vout->p_cfg = p_cfg;
445
    p_vout->p_module = module_need( p_vout,
Gildas Bazin's avatar
 
Gildas Bazin committed
446
        ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
447
        "video filter" : "video output", psz_name, p_vout->psz_filter_chain && *p_vout->psz_filter_chain );
448
    free( psz_name );
Sam Hocevar's avatar
 
Sam Hocevar committed
449 450 451

    if( p_vout->p_module == NULL )
    {
452
        msg_Err( p_vout, "no suitable vout module" );
453 454
        // FIXME it's ugly but that's exactly the function that need to be called.
        EndThread( p_vout );
455
        vlc_object_detach( p_vout );
456
        vlc_object_release( p_vout );
457
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
458
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
459

Gildas Bazin's avatar
 
Gildas Bazin committed
460
    /* Create a few object variables for interface interaction */
Gildas Bazin's avatar
 
Gildas Bazin committed
461 462 463
    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 );
464
    val.psz_string = (char *)""; text.psz_string = _("Disable");
Gildas Bazin's avatar
 
Gildas Bazin committed
465
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
466
    val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
Gildas Bazin's avatar
 
Gildas Bazin committed
467
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
468
    val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
Gildas Bazin's avatar
 
Gildas Bazin committed
469
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
470
    val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
Gildas Bazin's avatar
 
Gildas Bazin committed
471
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
472
    val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
Gildas Bazin's avatar
 
Gildas Bazin committed
473
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
474
    val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
Gildas Bazin's avatar
 
Gildas Bazin committed
475
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
476
    val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
477 478
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );

Gildas Bazin's avatar
 
Gildas Bazin committed
479 480 481
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
482
        free( val.psz_string );
Gildas Bazin's avatar
 
Gildas Bazin committed
483
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
484 485
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

486
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
487
    text.psz_string = _("Filters");
488 489
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
490

Gildas Bazin's avatar
 
Gildas Bazin committed
491 492
    /* Calculate delay created by internal caching */
    p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
Gildas Bazin's avatar
 
Gildas Bazin committed
493
                                           VLC_OBJECT_INPUT, FIND_ANYWHERE );
Gildas Bazin's avatar
 
Gildas Bazin committed
494 495
    if( p_input_thread )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
496
        p_vout->i_pts_delay = p_input_thread->i_pts_delay;
Gildas Bazin's avatar
 
Gildas Bazin committed
497 498 499 500
        vlc_object_release( p_input_thread );
    }
    else
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
501
        p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
Gildas Bazin's avatar
 
Gildas Bazin committed
502 503
    }

504
    if( vlc_thread_create( p_vout, "video output", RunThread,
505
                           VLC_THREAD_PRIORITY_OUTPUT, true ) )
Michel Kaempf's avatar
Michel Kaempf committed
506
    {
507
        module_unneed( p_vout, p_vout->p_module );
508
        vlc_object_release( p_vout );
509 510 511
        return NULL;
    }

512 513
    vlc_object_set_destructor( p_vout, vout_Destructor );

514 515 516
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );
517
        vout_CloseAndRelease( p_vout );
518
        return NULL;
519
    }
Michel Kaempf's avatar
Michel Kaempf committed
520

521
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
522 523
}

524
/*****************************************************************************
525
 * vout_Close: Close a vout created by vout_Create.
526
 *****************************************************************************
527
 * 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
528
 * You should NEVER call it on vout not obtained through vout_Create
529 530
 * (like with vout_Request or vlc_object_find.)
 * You can use vout_CloseAndRelease() as a convenient method.
531
 *****************************************************************************/
532
void vout_Close( vout_thread_t *p_vout )
533 534 535 536 537
{
    assert( p_vout );

    vlc_object_kill( p_vout );
    vlc_thread_join( p_vout );
538
    module_unneed( p_vout, p_vout->p_module );
539
    p_vout->p_module = NULL;
540 541 542
}

/* */
543 544
static void vout_Destructor( vlc_object_t * p_this )
{
545
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
546

547 548 549
    /* Make sure the vout was stopped first */
    assert( !p_vout->p_module );

550 551 552 553 554
    /* Destroy the locks */
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
    vlc_mutex_destroy( &p_vout->vfilter_lock );

555
    free( p_vout->psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
556

557 558
    config_ChainDestroy( p_vout->p_cfg );

559
#ifndef __APPLE__
560
    vout_thread_t *p_another_vout;
561

562 563 564 565 566 567 568 569
    /* 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 )
570
        var_SetBool( p_this->p_libvlc, "intf-show", true );
571 572
    else
        vlc_object_release( p_another_vout );
573
#endif
Michel Kaempf's avatar
Michel Kaempf committed
574 575
}

576
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
577
 * InitThread: initialize video output thread
578
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
579 580 581
 * 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.
582
 * XXX You have to enter it with change_lock taken.
583
 *****************************************************************************/
584 585
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
586

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
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
603
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
604
{
605
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
606

Sam Hocevar's avatar
 
Sam Hocevar committed
607 608
#ifdef STATS
    p_vout->c_loops = 0;
Vincent Seguin's avatar
Vincent Seguin committed
609 610
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
611
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
612
    if( p_vout->pf_init( p_vout ) )
613
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
614

Sam Hocevar's avatar
 
Sam Hocevar committed
615
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
616
    {
617 618
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
619
        p_vout->pf_end( p_vout );
620
        return VLC_EGENERIC;
621
    }
Vincent Seguin's avatar
Vincent Seguin committed
622

Gildas Bazin's avatar
 
Gildas Bazin committed
623 624 625 626 627 628 629 630
    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;
    }

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

633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
    AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );

    msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
             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 );

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

    msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
             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 );

    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
676 677
    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 );
678 679

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

681 682
    msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
683
             p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
684 685 686 687 688
             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,
689
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
Sam Hocevar's avatar
 
Sam Hocevar committed
690

691
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
692
    /* Calculate shifts from system-updated masks */
693 694 695 696 697
    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
698

Sam Hocevar's avatar
 
Sam Hocevar committed
699
    /* Check whether we managed to create direct buffers similar to
700
     * the render buffers, ie same size and chroma */
Sam Hocevar's avatar
 
Sam Hocevar committed
701 702
    if( ( p_vout->output.i_width == p_vout->render.i_width )
     && ( p_vout->output.i_height == p_vout->render.i_height )
703
     && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
704
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
705 706 707 708
        /* 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 */
Sam Hocevar's avatar
 
Sam Hocevar committed
709 710
        p_vout->b_direct = 1;

Sam Hocevar's avatar
 
Sam Hocevar committed
711 712
        for( i = 1; i < VOUT_MAX_PICTURES; i++ )
        {
Gildas Bazin's avatar
 
Gildas Bazin committed
713 714 715 716 717 718 719 720
            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
721 722 723
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
        }
Gildas Bazin's avatar
 
Gildas Bazin committed
724 725 726 727

        msg_Dbg( p_vout, "direct render, mapping "
                 "render pictures 0-%i to system pictures 1-%i",
                 VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
Sam Hocevar's avatar
 
Sam Hocevar committed
728 729 730
    }
    else
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
731 732 733
        /* Rats... Something is wrong here, we could not find an output
         * plugin able to directly render what we decode. See if we can
         * find a chroma plugin to do the conversion */
Sam Hocevar's avatar
 
Sam Hocevar committed
734 735
        p_vout->b_direct = 0;

736
        if( ChromaCreate( p_vout ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
737 738
        {
            p_vout->pf_end( p_vout );
739
            return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
740
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
741

Gildas Bazin's avatar
 
Gildas Bazin committed
742 743 744 745
        msg_Dbg( p_vout, "indirect render, mapping "
                 "render pictures 0-%i to system pictures %i-%i",
                 VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
                 I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
Sam Hocevar's avatar
 
Sam Hocevar committed
746 747

        /* Append render buffers after the direct buffers */
Sam Hocevar's avatar
 
Sam Hocevar committed
748
        for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
749 750 751
        {
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
Gildas Bazin's avatar
 
Gildas Bazin committed
752 753 754 755

            /* Check if we have enough render pictures */
            if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
                break;
Sam Hocevar's avatar
 
Sam Hocevar committed
756 757
        }
    }
Vincent Seguin's avatar
Vincent Seguin committed
758

Sam Hocevar's avatar
 
Sam Hocevar committed
759 760 761 762 763 764 765 766 767 768 769
    /* Link pictures back to their heap */
    for( i = 0 ; i < I_RENDERPICTURES ; i++ )
    {
        PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
    }

    for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
    {
        PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
    }

770
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
771 772
}

773
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
774
 * RunThread: video output thread
775
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
776 777 778
 * 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.
779
 *****************************************************************************/
780
static void* RunThread( vlc_object_t *p_this )
Vincent Seguin's avatar
Vincent Seguin committed
781
{
782
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
783
    int             i_idle_loops = 0;  /* loops without displaying a picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
784

785
    picture_t *     p_last_picture = NULL;                   /* last picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
786

787
    subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
Sam Hocevar's avatar
 
Sam Hocevar committed
788

Laurent Aimar's avatar
Laurent Aimar committed
789
    bool            b_drop_late;
790

Laurent Aimar's avatar
Laurent Aimar committed
791
    int             i_displayed = 0, i_lost = 0;
792
    int canc = vlc_savecancel ();
793

Sam Hocevar's avatar
 
Sam Hocevar committed
794 795 796
    /*
     * Initialize thread
     */
797
    vlc_mutex_lock( &p_vout->change_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
798
    p_vout->b_error = InitThread( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
799

Laurent Aimar's avatar
Laurent Aimar committed
800
    b_drop_late = var_CreateGetBool( p_vout, "drop-late-frames" );
801

Gildas Bazin's avatar
 
Gildas Bazin committed
802 803 804
    /* signal the creation of the vout */
    vlc_thread_ready( p_vout );

Sam Hocevar's avatar
 
Sam Hocevar committed
805
    if( p_vout->b_error )
806
    {
Laurent Aimar's avatar
Laurent Aimar committed
807
        EndThread( p_vout );
808
        vlc_mutex_unlock( &p_vout->change_lock );
809
        vlc_restorecancel (canc);
810
        return NULL;
811
    }
812

813 814
    vlc_object_lock( p_vout );

815 816
    if( p_vout->b_title_show )
        DisplayTitleOnOSD( p_vout );
817

818
    /*
Sam Hocevar's avatar
Sam Hocevar committed
819
     * Main loop - it is not executed if an error occurred during
Sam Hocevar's avatar
 
Sam Hocevar committed
820
     * initialization
821
     */
Laurent Aimar's avatar
Laurent Aimar committed
822
    while( vlc_object_alive( p_vout ) && !p_vout->b_error )
823
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
824
        /* Initialize loop variables */
Laurent Aimar's avatar
Laurent Aimar committed
825 826
        const mtime_t current_date = mdate();
        picture_t *p_picture = NULL;
827
        picture_t *p_filtered_picture;
Laurent Aimar's avatar
Laurent Aimar committed
828 829 830 831
        mtime_t display_date = 0;
        picture_t *p_directbuffer;
        input_thread_t *p_input;
        int i_index;
Sam Hocevar's avatar
 
Sam Hocevar committed
832

Laurent Aimar's avatar
Laurent Aimar committed
833 834 835
#if 0
        p_vout->c_loops++;
        if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
Laurent Aimar's avatar
Laurent Aimar committed
836
        {
Laurent Aimar's avatar
Laurent Aimar committed
837 838
            msg_Dbg( p_vout, "picture heap: %d/%d",
                     I_RENDERPICTURES, p_vout->i_heap_size );
Laurent Aimar's avatar
Laurent Aimar committed
839
        }
Laurent Aimar's avatar
Laurent Aimar committed
840 841 842 843
#endif

        /* Update statistics */
        p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT, FIND_PARENT );
Laurent Aimar's avatar
Laurent Aimar committed
844 845 846 847 848 849 850 851 852 853 854
        if( p_input )
        {
            vlc_mutex_lock( &p_input->p->counters.counters_lock );
            stats_UpdateInteger( p_vout, p_input->p->counters.p_lost_pictures,
                                 i_lost , NULL);
            stats_UpdateInteger( p_vout,
                                 p_input->p->counters.p_displayed_pictures,
                                 i_displayed , NULL);
            i_displayed = i_lost = 0;
            vlc_mutex_unlock( &p_input->p->counters.counters_lock );
            vlc_object_release( p_input );
Sam Hocevar's avatar
 
Sam Hocevar committed
855 856 857
        }

        /*
858 859 860
         * Find the picture to display (the one with the earliest date).
         * This operation does not need lock, since only READY_PICTUREs
         * are handled. */
861
        for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
862
        {
Laurent Aimar's avatar
Laurent Aimar committed
863 864 865 866
            picture_t *p_pic = PP_RENDERPICTURE[i_index];

            if( p_pic->i_status == READY_PICTURE &&
                ( p_picture == NULL || p_pic->date < display_date ) )
867
            {
Laurent Aimar's avatar
Laurent Aimar committed
868
                p_picture = p_pic;
Sam Hocevar's avatar
 
Sam Hocevar committed
869
                display_date = p_picture->date;
870 871
            }
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
872

873
        if( p_picture )
874
        {
875 876 877 878 879 880
            /* If we met the last picture, parse again to see whether there is
             * a more appropriate one. */
            if( p_picture == p_last_picture )
            {
                for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
                {
Laurent Aimar's avatar
Laurent Aimar committed
881 882 883 884 885
                    picture_t *p_pic = PP_RENDERPICTURE[i_index];

                    if( p_pic->i_status == READY_PICTURE &&
                        p_pic != p_last_picture &&
                        ( p_picture == p_last_picture || p_pic->date < display_date ) )
886
                    {
Laurent Aimar's avatar
Laurent Aimar committed
887
                        p_picture = p_pic;
888 889 890 891
                        display_date = p_picture->date;
                    }
                }
            }
892

893 894 895
            /* If we found better than the last picture, destroy it */
            if( p_last_picture && p_picture != p_last_picture )
            {
Laurent Aimar's avatar
Laurent Aimar committed
896
                DropPicture( p_vout, p_last_picture );
897
                p_last_picture = NULL;
898 899
            }

Sam Hocevar's avatar