video_output.c 55.3 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
gbazin's avatar
gbazin 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
dionoea's avatar
dionoea 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

zorglub's avatar
zorglub committed
46
#include <vlc_vout.h>
47

zorglub's avatar
zorglub committed
48 49
#include <vlc_filter.h>
#include <vlc_osd.h>
50

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

zorglub's avatar
zorglub 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 66 67
static int      InitThread        ( vout_thread_t * );
static void     RunThread         ( vout_thread_t * );
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 * );
72 73
static int      BinaryLog         ( uint32_t );
static void     MaskToShift       ( int *, int *, uint32_t );
Michel Kaempf's avatar
Michel Kaempf committed
74

75 76
static void     vout_Destructor   ( vlc_object_t * p_this );

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

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

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

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

    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 )
{
106 107 108 109 110 111 112 113 114
    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;
115 116
}

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

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

145
    /* TODO: find a suitable unused video output */
146 147 148 149

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

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

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

171
            if( !psz_filter_chain && !p_vout->psz_filter_chain )
gbazin's avatar
 
gbazin committed
172
            {
173
                p_vout->b_filter_change = false;
gbazin's avatar
 
gbazin committed
174 175
            }

176
            free( psz_filter_chain );
gbazin's avatar
 
gbazin committed
177 178
        }

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

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

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

    return p_vout;
}

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

223 224
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
225 226 227
    vlc_fourcc_t i_chroma = p_fmt->i_chroma;
    unsigned int i_aspect = p_fmt->i_aspect;

228 229 230 231
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

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

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

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

    /* Initialize the rendering heap */
    I_RENDERPICTURES = 0;
255 256 257

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

gbazin's avatar
 
gbazin committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
    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;

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

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

    /* Initialize locks */
301 302 303
    vlc_mutex_init( &p_vout->picture_lock );
    vlc_mutex_init( &p_vout->change_lock );
    vlc_mutex_init( &p_vout->vfilter_lock );
gbazin's avatar
 
gbazin committed
304

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

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

gbazin's avatar
 
gbazin committed
316 317 318
    /* Attach the new object now so we can use var inheritance below */
    vlc_object_attach( p_vout, p_parent );

319 320
    spu_Init( p_vout->p_spu );

321 322
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
gbazin's avatar
 
gbazin committed
323

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

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

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

        /* Create a video filter2 var ... but don't inherit values */
350 351 352
        var_Create( p_vout, "video-filter",
                    VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
        p_vout->psz_vf2 = var_GetString( p_vout, "video-filter" );
gbazin's avatar
 
gbazin committed
353 354
    }

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

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

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

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

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

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

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

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

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

442 443
    vlc_object_set_destructor( p_vout, vout_Destructor );

444 445 446 447
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );

448
        /* Make sure the thread is destroyed and data released */
449
        vlc_object_release( p_vout );
450
        return NULL;
451
    }
Michel Kaempf's avatar
Michel Kaempf committed
452

453
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
454 455
}

456 457
static void vout_Destructor( vlc_object_t * p_this )
{
458
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
459

460 461 462 463 464 465 466 467 468 469 470
    /* Destroy the locks */
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
    vlc_mutex_destroy( &p_vout->vfilter_lock );

    /* Release the module */
    if( p_vout->p_module )
    {
        module_Unneed( p_vout, p_vout->p_module );
    }

471
    free( p_vout->psz_filter_chain );
gbazin's avatar
 
gbazin committed
472

473 474
    config_ChainDestroy( p_vout->p_cfg );

475
#ifndef __APPLE__
476
    vout_thread_t *p_another_vout;
477

478 479 480 481 482 483 484 485
    /* 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 )
486
        var_SetBool( p_this->p_libvlc, "intf-show", true );
487 488
    else
        vlc_object_release( p_another_vout );
489
#endif
Michel Kaempf's avatar
Michel Kaempf committed
490 491
}

492
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
493
 * InitThread: initialize video output thread
494
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
495 496 497
 * 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.
498
 * XXX You have to enter it with change_lock taken.
499
 *****************************************************************************/
500 501
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
502

Sam Hocevar's avatar
 
Sam Hocevar committed
503
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
504
{
505
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
506

Sam Hocevar's avatar
 
Sam Hocevar committed
507 508
#ifdef STATS
    p_vout->c_loops = 0;
Vincent Seguin's avatar
Vincent Seguin committed
509 510
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
511
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
512
    if( p_vout->pf_init( p_vout ) )
513
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
514

Sam Hocevar's avatar
 
Sam Hocevar committed
515
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
516
    {
517 518
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
519
        p_vout->pf_end( p_vout );
520
        return VLC_EGENERIC;
521
    }
Vincent Seguin's avatar
Vincent Seguin committed
522

gbazin's avatar
 
gbazin committed
523 524 525 526 527 528 529 530
    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;
    }

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

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    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
576 577
    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 );
578 579

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

581 582
    msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
583
             p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
584 585 586 587 588
             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,
589
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
Sam Hocevar's avatar
 
Sam Hocevar committed
590

Sam Hocevar's avatar
 
Sam Hocevar committed
591 592 593 594 595 596 597 598
    /* Calculate shifts from system-updated masks */
    MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
                 p_vout->output.i_rmask );
    MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
                 p_vout->output.i_gmask );
    MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
                 p_vout->output.i_bmask );

Sam Hocevar's avatar
 
Sam Hocevar committed
599
    /* Check whether we managed to create direct buffers similar to
600
     * the render buffers, ie same size and chroma */
Sam Hocevar's avatar
 
Sam Hocevar committed
601 602
    if( ( p_vout->output.i_width == p_vout->render.i_width )
     && ( p_vout->output.i_height == p_vout->render.i_height )
603
     && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
604
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
605 606 607 608
        /* 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
609 610
        p_vout->b_direct = 1;

Sam Hocevar's avatar
 
Sam Hocevar committed
611 612
        for( i = 1; i < VOUT_MAX_PICTURES; i++ )
        {
gbazin's avatar
 
gbazin committed
613 614 615 616 617 618 619 620
            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
621 622 623
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
        }
gbazin's avatar
 
gbazin committed
624 625 626 627

        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
628 629 630
    }
    else
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
631 632 633
        /* 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
634 635
        p_vout->b_direct = 0;

636
        if( ChromaCreate( p_vout ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
637 638
        {
            p_vout->pf_end( p_vout );
639
            return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
640
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
641

gbazin's avatar
 
gbazin committed
642 643 644 645
        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
646 647

        /* Append render buffers after the direct buffers */
Sam Hocevar's avatar
 
Sam Hocevar committed
648
        for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
649 650 651
        {
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
gbazin's avatar
 
gbazin committed
652 653 654 655

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

Sam Hocevar's avatar
 
Sam Hocevar committed
659 660 661 662 663 664 665 666 667 668 669
    /* 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;
    }

670
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
671 672
}

673
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
674
 * RunThread: video output thread
675
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
676 677 678
 * 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.
679
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
680
static void RunThread( vout_thread_t *p_vout)
Vincent Seguin's avatar
Vincent Seguin committed
681
{
Sam Hocevar's avatar
 
Sam Hocevar committed
682
    int             i_index;                                /* index in heap */
683
    int             i_idle_loops = 0;  /* loops without displaying a picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
684 685 686 687
    mtime_t         current_date;                            /* current date */
    mtime_t         display_date;                            /* display date */

    picture_t *     p_picture;                            /* picture pointer */
688
    picture_t *     p_last_picture = NULL;                   /* last picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
689 690
    picture_t *     p_directbuffer;              /* direct buffer to display */

691
    subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
Sam Hocevar's avatar
 
Sam Hocevar committed
692

693
    input_thread_t *p_input = NULL ;           /* Parent input, if it exists */
694

695
    vlc_value_t     val;
696
    bool      b_drop_late;
697

698 699
    int             i_displayed = 0, i_lost = 0, i_loops = 0;

Sam Hocevar's avatar
 
Sam Hocevar committed
700 701 702
    /*
     * Initialize thread
     */
703
    vlc_mutex_lock( &p_vout->change_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
704
    p_vout->b_error = InitThread( p_vout );
gbazin's avatar
 
gbazin committed
705

706 707 708 709
    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;

gbazin's avatar
 
gbazin committed
710 711 712
    /* signal the creation of the vout */
    vlc_thread_ready( p_vout );

Sam Hocevar's avatar
 
Sam Hocevar committed
713
    if( p_vout->b_error )
714
    {
Laurent Aimar's avatar
Laurent Aimar committed
715
        EndThread( p_vout );
716
        vlc_mutex_unlock( &p_vout->change_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
717
        return;
718
    }
719

720 721
    vlc_object_lock( p_vout );

722 723
    if( p_vout->b_title_show )
        DisplayTitleOnOSD( p_vout );
724

725
    /*
Sam Hocevar's avatar
Sam Hocevar committed
726
     * Main loop - it is not executed if an error occurred during
Sam Hocevar's avatar
 
Sam Hocevar committed
727
     * initialization
728
     */
729
    while( (vlc_object_alive( p_vout )) && (!p_vout->b_error) )
730
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
731
        /* Initialize loop variables */
732
        p_picture = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
733 734
        display_date = 0;
        current_date = mdate();
Sam Hocevar's avatar
 
Sam Hocevar committed
735

736
        i_loops++;
737 738 739 740 741
            if( !p_input )
            {
                p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT,
                                           FIND_PARENT );
            }
742 743
            if( p_input )
            {
zorglub's avatar
zorglub committed
744 745
                vlc_mutex_lock( &p_input->p->counters.counters_lock );
                stats_UpdateInteger( p_vout, p_input->p->counters.p_lost_pictures,
746 747
                                     i_lost , NULL);
                stats_UpdateInteger( p_vout,
zorglub's avatar
zorglub committed
748
                                     p_input->p->counters.p_displayed_pictures,
749 750
                                     i_displayed , NULL);
                i_displayed = i_lost = 0;
zorglub's avatar
zorglub committed
751
                vlc_mutex_unlock( &p_input->p->counters.counters_lock );
752 753
                vlc_object_release( p_input );
                p_input = NULL;
754
            }
755
#if 0
Sam Hocevar's avatar
 
Sam Hocevar committed
756 757
        p_vout->c_loops++;
        if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
758
        {
759 760
            msg_Dbg( p_vout, "picture heap: %d/%d",
                     I_RENDERPICTURES, p_vout->i_heap_size );
Sam Hocevar's avatar
 
Sam Hocevar committed
761
        }
762
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
763 764

        /*
765 766 767
         * Find the picture to display (the one with the earliest date).
         * This operation does not need lock, since only READY_PICTUREs
         * are handled. */
768
        for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
769
        {
Sam Hocevar's avatar
 
Sam Hocevar committed
770 771 772
            if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
                && ( (p_picture == NULL) ||
                     (PP_RENDERPICTURE[i_index]->date < display_date) ) )
773
            {
Sam Hocevar's avatar
 
Sam Hocevar committed
774
                p_picture = PP_RENDERPICTURE[i_index];
Sam Hocevar's avatar
 
Sam Hocevar committed
775
                display_date = p_picture->date;
776 777
            }
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
778

779
        if( p_picture )
780
        {
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
            /* 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;
                    }
                }
            }
797

798 799 800 801 802 803 804 805 806 807 808 809 810 811
            /* If we found better than the last picture, destroy it */
            if( p_last_picture && p_picture != p_last_picture )
            {
                vlc_mutex_lock( &p_vout->picture_lock );
                if( p_last_picture->i_refcount )
                {
                    p_last_picture->i_status = DISPLAYED_PICTURE;
                }
                else
                {
                    p_last_picture->i_status = DESTROYED_PICTURE;
                    p_vout->i_heap_size--;
                }
                vlc_mutex_unlock( &p_vout->picture_lock );
812
                p_last_picture = NULL;
813 814
            }

Sam Hocevar's avatar
 
Sam Hocevar committed
815 816 817 818
            /* Compute FPS rate */
            p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
                = display_date;

819
            if( !p_picture->b_force &&
820
                p_picture != p_last_picture &&
821
                display_date < current_date + p_vout->render_time &&
822
                b_drop_late )
Sam Hocevar's avatar
 
Sam Hocevar committed
823 824 825 826 827 828 829 830 831 832 833 834 835 836
            {
                /* Picture is late: it will be destroyed and the thread
                 * will directly choose the next picture */
                vlc_mutex_lock( &p_vout->picture_lock );
                if( p_picture->i_refcount )
                {
                    /* Pretend we displayed the picture, but don't destroy
                     * it since the decoder might still need it. */
                    p_picture->i_status = DISPLAYED_PICTURE;
                }
                else
                {
                    /* Destroy the picture without displaying it */
                    p_picture->i_status = DESTROYED_PICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
837
                    p_vout->i_heap_size--;
Sam Hocevar's avatar
 
Sam Hocevar committed
838
                }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
839
                msg_Warn( p_vout, "late picture skipped (%"PRId64")",