video_output.c 53.9 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>
50

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

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

59
#include "modules/modules.h"
60
#include <assert.h>
61

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

71
static void     AspectRatio       ( int, int *, int * );
Michel Kaempf's avatar
Michel Kaempf committed
72

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

76 77
static void     vout_Destructor   ( vlc_object_t * p_this );

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

86 87 88
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

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

92 93 94 95 96 97
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
    picture_t *p_picture;
98
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
99 100 101 102 103 104 105 106

    p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );

    return p_picture;
}

static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
{
107 108 109 110 111 112 113 114 115
    vout_DestroyPicture( (vout_thread_t*)p_filter->p_owner, p_pic );
}

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;
116 117
}

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

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

143
    /* TODO: find a suitable unused video output */
144 145 146 147

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

151
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
152 153 154
         * performance reasons. */
        if( p_vout->b_filter_change )
        {
155
            var_Get( p_vout, "vout-filter", &val );
156
            psz_filter_chain = val.psz_string;
Gildas Bazin's avatar
 
Gildas Bazin committed
157

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

169
            if( !psz_filter_chain && !p_vout->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
170
            {
171
                p_vout->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
172 173
            }

174
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
175 176
        }

177 178
        if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
            ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
179
            ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect ) ||
Gildas Bazin's avatar
 
Gildas Bazin committed
180
            p_vout->b_filter_change )
181 182
        {
            /* We are not interested in this format, close this vout */
183
            vout_CloseAndRelease( p_vout );
184
            vlc_object_release( p_vout );
185 186 187 188 189
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
190
            spu_Attach( p_vout->p_spu, p_this, true );
191
            vlc_object_attach( p_vout, p_this );
192 193
            if( p_vout->b_title_show )
                DisplayTitleOnOSD( p_vout );
194 195 196 197 198 199 200 201
            vlc_object_release( p_vout );
        }
    }

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

202
        p_vout = vout_Create( p_this, p_fmt );
203 204 205 206 207 208 209
    }

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
210
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
211 212
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
213
 *****************************************************************************/
214
vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
215
{
Gildas Bazin's avatar
 
Gildas Bazin committed
216 217 218
    vout_thread_t  * p_vout;                            /* thread descriptor */
    input_thread_t * p_input_thread;
    int              i_index;                               /* loop variable */
219
    vlc_value_t      val, text;
Michel Kaempf's avatar
Michel Kaempf committed
220

221 222
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
223 224 225
    vlc_fourcc_t i_chroma = p_fmt->i_chroma;
    unsigned int i_aspect = p_fmt->i_aspect;

226 227 228 229
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

230
    /* Allocate descriptor */
231 232 233
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
234
    if( p_vout == NULL )
235
        return NULL;
236

237
    /* Initialize pictures - translation tables and functions
Gildas Bazin's avatar
 
Gildas Bazin committed
238
     * will be initialized later in InitThread */
239
    for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
Gildas Bazin's avatar
 
Gildas Bazin committed
240 241 242 243 244
    {
        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;
245
        p_vout->p_picture[i_index].b_slow   = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
246 247 248 249 250 251 252
    }

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

    /* Initialize the rendering heap */
    I_RENDERPICTURES = 0;
253 254 255

    vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
                 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
256 257
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
258

Gildas Bazin's avatar
 
Gildas Bazin committed
259 260 261 262 263
    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;

264 265 266
    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
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

    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
290
    p_vout->i_alignment  = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
291 292 293
    p_vout->render_time  = 10;
    p_vout->c_fps_samples = 0;
    p_vout->b_filter_change = 0;
294 295
    p_vout->pf_control = NULL;
    p_vout->p_window = NULL;
296
    p_vout->i_par_num = p_vout->i_par_den = 1;
Gildas Bazin's avatar
 
Gildas Bazin committed
297 298

    /* Initialize locks */
299 300 301
    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
302

303 304 305 306 307 308 309
    /* 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 );

310
    /* Initialize subpicture unit */
311
    p_vout->p_spu = spu_Create( p_vout );
312
    spu_Attach( p_vout->p_spu, p_parent, true );
313

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

317 318
    spu_Init( p_vout->p_spu );

319 320
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
321

Gildas Bazin's avatar
 
Gildas Bazin committed
322 323 324
    /* 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
325
    {
326
        /* Look for the default filter configuration */
327 328
        p_vout->psz_filter_chain =
            var_CreateGetStringCommand( p_vout, "vout-filter" );
329 330

        /* Apply video filter2 objects on the first vout */
331 332
        p_vout->psz_vf2 =
            var_CreateGetStringCommand( p_vout, "video-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
333 334 335 336
    }
    else
    {
        /* continue the parent's filter chain */
337
        char *psz_tmp;
Gildas Bazin's avatar
 
Gildas Bazin committed
338

339 340 341 342 343 344 345
        /* 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 );
346 347

        /* Create a video filter2 var ... but don't inherit values */
348 349 350
        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
351 352
    }

353
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
354 355
    p_vout->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
        false, video_filter_buffer_allocation_init, NULL, p_vout );
356

Gildas Bazin's avatar
 
Gildas Bazin committed
357
    /* Choose the video output module */
Gildas Bazin's avatar
 
Gildas Bazin committed
358
    if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
359
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
360 361
        var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "vout", &val );
Antoine Cellerier's avatar
Antoine Cellerier committed
362
        psz_parser = val.psz_string;
Gildas Bazin's avatar
 
Gildas Bazin committed
363 364 365
    }
    else
    {
Antoine Cellerier's avatar
Antoine Cellerier committed
366
        psz_parser = strdup( p_vout->psz_filter_chain );
Sam Hocevar's avatar
 
Sam Hocevar committed
367 368
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
369
    /* Create the vout thread */
370
    char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
371
    free( psz_parser );
372
    free( psz_tmp );
373
    p_vout->p_cfg = p_cfg;
Gildas Bazin's avatar
 
Gildas Bazin committed
374
    p_vout->p_module = module_Need( p_vout,
Gildas Bazin's avatar
 
Gildas Bazin committed
375
        ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
376
        "video filter" : "video output", psz_name, p_vout->psz_filter_chain && *p_vout->psz_filter_chain );
377
    free( psz_name );
Sam Hocevar's avatar
 
Sam Hocevar committed
378 379 380

    if( p_vout->p_module == NULL )
    {
381
        msg_Err( p_vout, "no suitable vout module" );
382 383
        // FIXME it's ugly but that's exactly the function that need to be called.
        EndThread( p_vout );
384
        vlc_object_detach( p_vout );
385
        vlc_object_release( p_vout );
386
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
387
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
388

Gildas Bazin's avatar
 
Gildas Bazin committed
389
    /* Create a few object variables for interface interaction */
Gildas Bazin's avatar
 
Gildas Bazin committed
390 391 392
    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 );
393
    val.psz_string = (char *)""; text.psz_string = _("Disable");
Gildas Bazin's avatar
 
Gildas Bazin committed
394
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
395
    val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
Gildas Bazin's avatar
 
Gildas Bazin committed
396
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
397
    val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
Gildas Bazin's avatar
 
Gildas Bazin committed
398
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
399
    val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
Gildas Bazin's avatar
 
Gildas Bazin committed
400
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
401
    val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
Gildas Bazin's avatar
 
Gildas Bazin committed
402
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
403
    val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
Gildas Bazin's avatar
 
Gildas Bazin committed
404
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
405
    val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
406 407
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );

Gildas Bazin's avatar
 
Gildas Bazin committed
408 409 410
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
411
        free( val.psz_string );
Gildas Bazin's avatar
 
Gildas Bazin committed
412
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
413 414
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

415
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
416
    text.psz_string = _("Filters");
417 418
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
419

Gildas Bazin's avatar
 
Gildas Bazin committed
420 421
    /* Calculate delay created by internal caching */
    p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
Gildas Bazin's avatar
 
Gildas Bazin committed
422
                                           VLC_OBJECT_INPUT, FIND_ANYWHERE );
Gildas Bazin's avatar
 
Gildas Bazin committed
423 424
    if( p_input_thread )
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
425
        p_vout->i_pts_delay = p_input_thread->i_pts_delay;
Gildas Bazin's avatar
 
Gildas Bazin committed
426 427 428 429
        vlc_object_release( p_input_thread );
    }
    else
    {
Gildas Bazin's avatar
 
Gildas Bazin committed
430
        p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
Gildas Bazin's avatar
 
Gildas Bazin committed
431 432
    }

433
    if( vlc_thread_create( p_vout, "video output", RunThread,
434
                           VLC_THREAD_PRIORITY_OUTPUT, true ) )
Michel Kaempf's avatar
Michel Kaempf committed
435
    {
436
        module_Unneed( p_vout, p_vout->p_module );
437
        vlc_object_release( p_vout );
438 439 440
        return NULL;
    }

441 442
    vlc_object_set_destructor( p_vout, vout_Destructor );

443 444 445
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );
446
        vout_CloseAndRelease( p_vout );
447
        return NULL;
448
    }
Michel Kaempf's avatar
Michel Kaempf committed
449

450
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
451 452
}

453
/*****************************************************************************
454
 * vout_Close: Close a vout created by vout_Create.
455
 *****************************************************************************
456 457 458 459
 * You HAVE to call it on vout created by vout_Create before vlc_object_release.
 * You should NEVER call it on vout not obtained though vout_Create
 * (like with vout_Request or vlc_object_find.)
 * You can use vout_CloseAndRelease() as a convenient method.
460
 *****************************************************************************/
461
void vout_Close( vout_thread_t *p_vout )
462 463 464 465 466 467
{
    assert( p_vout );

    vlc_object_kill( p_vout );
    vlc_thread_join( p_vout );
    module_Unneed( p_vout, p_vout->p_module );
468
    p_vout->p_module = NULL;
469 470 471
}

/* */
472 473
static void vout_Destructor( vlc_object_t * p_this )
{
474
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
475

476 477 478
    /* Make sure the vout was stopped first */
    assert( !p_vout->p_module );

479 480 481 482 483
    /* Destroy the locks */
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
    vlc_mutex_destroy( &p_vout->vfilter_lock );

484
    free( p_vout->psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
485

486 487
    config_ChainDestroy( p_vout->p_cfg );

488
#ifndef __APPLE__
489
    vout_thread_t *p_another_vout;
490

491 492 493 494 495 496 497 498
    /* 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 )
499
        var_SetBool( p_this->p_libvlc, "intf-show", true );
500 501
    else
        vlc_object_release( p_another_vout );
502
#endif
Michel Kaempf's avatar
Michel Kaempf committed
503 504
}

505
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
506
 * InitThread: initialize video output thread
507
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
508 509 510
 * 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.
511
 * XXX You have to enter it with change_lock taken.
512
 *****************************************************************************/
513 514
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
Laurent Aimar's avatar
Laurent Aimar committed
515
static void DropPicture( vout_thread_t *p_vout, picture_t *p_picture );
516

Sam Hocevar's avatar
 
Sam Hocevar committed
517
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
518
{
519
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
520

Sam Hocevar's avatar
 
Sam Hocevar committed
521 522
#ifdef STATS
    p_vout->c_loops = 0;
Vincent Seguin's avatar
Vincent Seguin committed
523 524
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
525
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
526
    if( p_vout->pf_init( p_vout ) )
527
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
528

Sam Hocevar's avatar
 
Sam Hocevar committed
529
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
530
    {
531 532
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
533
        p_vout->pf_end( p_vout );
534
        return VLC_EGENERIC;
535
    }
Vincent Seguin's avatar
Vincent Seguin committed
536

Gildas Bazin's avatar
 
Gildas Bazin committed
537 538 539 540 541 542 543 544
    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;
    }

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

547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
    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
590 591
    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 );
592 593

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

595 596
    msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
597
             p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
598 599 600 601 602
             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,
603
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
Sam Hocevar's avatar
 
Sam Hocevar committed
604

605
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
606
    /* Calculate shifts from system-updated masks */
607 608 609 610 611
    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
612

Sam Hocevar's avatar
 
Sam Hocevar committed
613
    /* Check whether we managed to create direct buffers similar to
614
     * the render buffers, ie same size and chroma */
Sam Hocevar's avatar
 
Sam Hocevar committed
615 616
    if( ( p_vout->output.i_width == p_vout->render.i_width )
     && ( p_vout->output.i_height == p_vout->render.i_height )
617
     && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
618
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
619 620 621 622
        /* 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
623 624
        p_vout->b_direct = 1;

Sam Hocevar's avatar
 
Sam Hocevar committed
625 626
        for( i = 1; i < VOUT_MAX_PICTURES; i++ )
        {
Gildas Bazin's avatar
 
Gildas Bazin committed
627 628 629 630 631 632 633 634
            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
635 636 637
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
        }
Gildas Bazin's avatar
 
Gildas Bazin committed
638 639 640 641

        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
642 643 644
    }
    else
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
645 646 647
        /* 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
648 649
        p_vout->b_direct = 0;

650
        if( ChromaCreate( p_vout ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
651 652
        {
            p_vout->pf_end( p_vout );
653
            return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
654
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
655

Gildas Bazin's avatar
 
Gildas Bazin committed
656 657 658 659
        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
660 661

        /* Append render buffers after the direct buffers */
Sam Hocevar's avatar
 
Sam Hocevar committed
662
        for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
663 664 665
        {
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
Gildas Bazin's avatar
 
Gildas Bazin committed
666 667 668 669

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

Sam Hocevar's avatar
 
Sam Hocevar committed
673 674 675 676 677 678 679 680 681 682 683
    /* 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;
    }

684
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
685 686
}

687
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
688
 * RunThread: video output thread
689
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
690 691 692
 * 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.
693
 *****************************************************************************/
694
static void* RunThread( vlc_object_t *p_this )
Vincent Seguin's avatar
Vincent Seguin committed
695
{
696
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
Sam Hocevar's avatar
 
Sam Hocevar committed
697
    int             i_index;                                /* index in heap */
698
    int             i_idle_loops = 0;  /* loops without displaying a picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
699 700 701 702
    mtime_t         current_date;                            /* current date */
    mtime_t         display_date;                            /* display date */

    picture_t *     p_picture;                            /* picture pointer */
703
    picture_t *     p_last_picture = NULL;                   /* last picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
704 705
    picture_t *     p_directbuffer;              /* direct buffer to display */

706
    subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
Sam Hocevar's avatar
 
Sam Hocevar committed
707

708
    input_thread_t *p_input = NULL ;           /* Parent input, if it exists */
709

710
    vlc_value_t     val;
711
    bool      b_drop_late;
712

713 714
    int             i_displayed = 0, i_lost = 0, i_loops = 0;

Sam Hocevar's avatar
 
Sam Hocevar committed
715 716 717
    /*
     * Initialize thread
     */
718
    vlc_mutex_lock( &p_vout->change_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
719
    p_vout->b_error = InitThread( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
720

721 722 723 724
    var_Create( p_vout, "drop-late-frames", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Get( p_vout, "drop-late-frames", &val );
    b_drop_late = val.b_bool;

Gildas Bazin's avatar
 
Gildas Bazin committed
725 726 727
    /* signal the creation of the vout */
    vlc_thread_ready( p_vout );

Sam Hocevar's avatar
 
Sam Hocevar committed
728
    if( p_vout->b_error )
729
    {
Laurent Aimar's avatar
Laurent Aimar committed
730
        EndThread( p_vout );
731
        vlc_mutex_unlock( &p_vout->change_lock );
732
        return NULL;
733
    }
734

735 736
    vlc_object_lock( p_vout );

737 738
    if( p_vout->b_title_show )
        DisplayTitleOnOSD( p_vout );
739

740
    /*
Sam Hocevar's avatar
Sam Hocevar committed
741
     * Main loop - it is not executed if an error occurred during
Sam Hocevar's avatar
 
Sam Hocevar committed
742
     * initialization
743
     */
Laurent Aimar's avatar
Laurent Aimar committed
744
    while( vlc_object_alive( p_vout ) && !p_vout->b_error )
745
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
746
        /* Initialize loop variables */
747
        p_picture = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
748 749
        display_date = 0;
        current_date = mdate();
Sam Hocevar's avatar
 
Sam Hocevar committed
750

751
        i_loops++;
Laurent Aimar's avatar
Laurent Aimar committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
        if( !p_input )
        {
            p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
                                       FIND_PARENT );
        }
        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 );
            p_input = NULL;
        }
770
#if 0
Sam Hocevar's avatar
 
Sam Hocevar committed
771 772
        p_vout->c_loops++;
        if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
773
        {
774 775
            msg_Dbg( p_vout, "picture heap: %d/%d",
                     I_RENDERPICTURES, p_vout->i_heap_size );
Sam Hocevar's avatar
 
Sam Hocevar committed
776
        }
777
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
778 779

        /*
780 781 782
         * Find the picture to display (the one with the earliest date).
         * This operation does not need lock, since only READY_PICTUREs
         * are handled. */
783
        for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
784
        {
Sam Hocevar's avatar
 
Sam Hocevar committed
785 786 787
            if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
                && ( (p_picture == NULL) ||
                     (PP_RENDERPICTURE[i_index]->date < display_date) ) )
788
            {
Sam Hocevar's avatar
 
Sam Hocevar committed
789
                p_picture = PP_RENDERPICTURE[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
790
                display_date = p_picture->date;
791 792
            }
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
793

794
        if( p_picture )
795
        {
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
            /* 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++ )
                {
                    if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
                        && (PP_RENDERPICTURE[i_index] != p_last_picture)
                        && ((p_picture == p_last_picture) ||
                            (PP_RENDERPICTURE[i_index]->date < display_date)) )
                    {
                        p_picture = PP_RENDERPICTURE[i_index];
                        display_date = p_picture->date;
                    }
                }
            }
812

813 814 815
            /* 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
816
                DropPicture( p_vout, p_last_picture );
817
                p_last_picture = NULL;
818 819
            }

Sam Hocevar's avatar
 
Sam Hocevar committed
820 821 822 823
            /* Compute FPS rate */
            p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
                = display_date;

824
            if( !p_picture->b_force &&
825
                p_picture != p_last_picture &&
826
                display_date < current_date + p_vout->render_time &&
827
                b_drop_late )
Sam Hocevar's avatar
 
Sam Hocevar committed
828 829 830
            {
                /* Picture is late: it will be destroyed and the thread
                 * will directly choose the next picture */
Laurent Aimar's avatar
Laurent Aimar committed
831 832
                DropPicture( p_vout, p_picture );
                i_lost++;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
833
                msg_Warn( p_vout, "late picture skipped (%"PRId64")",
834
                                  current_date - display_date );
835 836
                continue;
            }
837

Gildas Bazin's avatar
 
Gildas Bazin committed
838
            if( display_date >
839
                current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
840 841
            {
                /* Picture is waaay too early: it will be destroyed */
Laurent Aimar's avatar
Laurent Aimar committed
842
                DropPicture( p_vout, p_picture );
843
                i_lost++;
844
                msg_Warn( p_vout, "vout warning: early picture skipped "
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
845
                          "(%"PRId64")", display_date - current_date
Gildas Bazin's avatar
 
Gildas Bazin committed
846
                          - p_vout->i_pts_delay );
Sam Hocevar's avatar
 
Sam Hocevar committed
847 848
                continue;
            }
849

850
            if( display_date > current_date + VOUT_DISPLAY_DELAY )
Sam Hocevar's avatar
 
Sam Hocevar committed
851 852 853 854 855 856 857 858
            {
                /* A picture is ready to be rendered, but its rendering date
                 * is far from the current one so the thread will perform an
                 * empty loop as if no picture were found. The picture state
                 * is unchanged */
                p_picture    = NULL;
                display_date = 0;
            }
859 860
            else if( p_picture == p_last_picture )
            {
861 862
                /* We are asked to repeat the previous picture, but we first
                 * wait for a couple of idle loops */
863 864 865 866 867 868 869
                if( i_idle_loops < 4 )
                {
                    p_picture    = NULL;
                    display_date = 0;
                }
                else
                {
870 871 872
                    /* We set the display date to something high, otherwise
                     * we'll have lots of problems with late pictures */
                    display_date = current_date + p_vout->render_time;
873 874 875 876 877 878 879
                }
            }
        }

        if( p_picture == NULL )
        {
            i_idle_loops++;