video_output.c 49.3 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2 3 4
 * video_output.c : video output thread
 * This module describes the programming interface for video output threads.
 * It includes functions allowing to open a new thread, send pictures to a
5 6
 * thread, and destroy a previously oppened video output thread.
 *****************************************************************************
zorglub's avatar
zorglub committed
7
 * Copyright (C) 2000-2004 VideoLAN
gbazin's avatar
gbazin committed
8
 * $Id$
9
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
10
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11 12 13 14 15
 *
 * 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
16
 *
17 18
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
21
 *
22 23 24
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
26

27
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
28
 * Preamble
29
 *****************************************************************************/
30
#include <stdlib.h>                                                /* free() */
Vincent Seguin's avatar
Vincent Seguin committed
31

32
#include <vlc/vlc.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
33

34 35
#ifdef HAVE_SYS_TIMES_H
#   include <sys/times.h>
36
#endif
37

38
#include "vlc_video.h"
Michel Kaempf's avatar
Michel Kaempf committed
39
#include "video_output.h"
gbazin's avatar
 
gbazin committed
40
#include <vlc/input.h>                 /* for input_thread_t and i_pts_delay */
41

42 43 44 45
#if defined( SYS_DARWIN )
#include "darwin_specific.h"
#endif

46
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
47
 * Local prototypes
48
 *****************************************************************************/
49 50 51 52 53
static int      InitThread        ( vout_thread_t * );
static void     RunThread         ( vout_thread_t * );
static void     ErrorThread       ( vout_thread_t * );
static void     EndThread         ( vout_thread_t * );
static void     DestroyThread     ( vout_thread_t * );
Sam Hocevar's avatar
 
Sam Hocevar committed
54

Sam Hocevar's avatar
 
Sam Hocevar committed
55
static int      ReduceHeight      ( int );
56 57
static int      BinaryLog         ( uint32_t );
static void     MaskToShift       ( int *, int *, uint32_t );
gbazin's avatar
 
gbazin committed
58
static void     InitWindowSize    ( vout_thread_t *, int *, int * );
Michel Kaempf's avatar
Michel Kaempf committed
59

60 61
void vout_IntfInit( vout_thread_t * );

gbazin's avatar
 
gbazin committed
62
/* Object variables callbacks */
gbazin's avatar
 
gbazin committed
63 64
static int DeinterlaceCallback( vlc_object_t *, char const *,
                                vlc_value_t, vlc_value_t, void * );
65 66
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
gbazin's avatar
 
gbazin committed
67

68 69 70 71 72
/**
 * vout_AspectRatio
 *
 * Set the i_aspect_x and i_aspect_y from i_aspect.
 */
zorglub's avatar
zorglub committed
73 74 75 76
void vout_AspectRatio( unsigned int i_aspect,
                       /*out*/ unsigned int *i_aspect_x,
                       /*out*/ unsigned int *i_aspect_y )
{
77 78 79 80 81
  unsigned int i_pgcd = ReduceHeight( i_aspect );
  *i_aspect_x = i_aspect / i_pgcd;
  *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
}

82
/*****************************************************************************
83 84 85 86 87 88 89 90 91 92 93
 * 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.
 *****************************************************************************/
vout_thread_t * __vout_Request ( vlc_object_t *p_this, vout_thread_t *p_vout,
                                 unsigned int i_width, unsigned int i_height,
                                 vlc_fourcc_t i_chroma, unsigned int i_aspect )
{
    if( !i_width || !i_height || !i_chroma )
    {
gbazin's avatar
 
gbazin committed
94
        /* Reattach video output to input before bailing out */
95 96
        if( p_vout )
        {
97
            vlc_object_t *p_playlist;
98

99
            p_playlist = vlc_object_find( p_this,
100
                                          VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
gbazin's avatar
 
gbazin committed
101

102
            if( p_playlist )
103 104
            {
                vlc_object_detach( p_vout );
105
                vlc_object_attach( p_vout, p_playlist );
106

107
                vlc_object_release( p_playlist );
108 109 110
            }
            else
            {
zorglub's avatar
zorglub committed
111
                msg_Dbg( p_this, "cannot find playlist, destroying vout" );
112 113 114
                vlc_object_detach( p_vout );
                vout_Destroy( p_vout );
            }
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
        }
        return NULL;
    }

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

        if( !p_vout )
        {
130
            vlc_object_t *p_playlist;
gbazin's avatar
 
gbazin committed
131

132 133 134
            p_playlist = vlc_object_find( p_this,
                                          VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
            if( p_playlist )
gbazin's avatar
 
gbazin committed
135
            {
136 137
                p_vout = vlc_object_find( p_playlist,
                                          VLC_OBJECT_VOUT, FIND_CHILD );
138
                /* only first children of p_input for unused vout */
139
                if( p_vout && p_vout->p_parent != p_playlist )
140 141 142 143
                {
                    vlc_object_release( p_vout );
                    p_vout = NULL;
                }
144
                vlc_object_release( p_playlist );
gbazin's avatar
 
gbazin committed
145
            }
146 147 148 149 150 151
        }
    }

    /* If we now have a video output, check it has the right properties */
    if( p_vout )
    {
gbazin's avatar
 
gbazin committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        char *psz_filter_chain;

        /* We don't directly check for the "filter" variable for obvious
         * performance reasons. */
        if( p_vout->b_filter_change )
        {
            psz_filter_chain = config_GetPsz( p_this, "filter" );

            if( psz_filter_chain && !*psz_filter_chain )
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
            if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
            {
                free( p_vout->psz_filter_chain );
                p_vout->psz_filter_chain = NULL;
            }

            if( ( !psz_filter_chain && !p_vout->psz_filter_chain ) ||
                ( psz_filter_chain && p_vout->psz_filter_chain &&
                  !strcmp( psz_filter_chain, p_vout->psz_filter_chain ) ) )
            {
                p_vout->b_filter_change = VLC_FALSE;
            }

gbazin's avatar
 
gbazin committed
178
            if( psz_filter_chain ) free( psz_filter_chain );
gbazin's avatar
 
gbazin committed
179 180
        }

181 182
        if( ( p_vout->render.i_width != i_width ) ||
            ( p_vout->render.i_height != i_height ) ||
gbazin's avatar
 
gbazin committed
183
            ( p_vout->render.i_chroma != i_chroma ) ||
184 185
            ( p_vout->render.i_aspect != i_aspect
                    && !p_vout->b_override_aspect ) ||
gbazin's avatar
 
gbazin committed
186
            p_vout->b_filter_change )
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
        {
            /* We are not interested in this format, close this vout */
            vlc_object_detach( p_vout );
            vlc_object_release( p_vout );
            vout_Destroy( p_vout );
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
            vlc_object_detach( p_vout );
            vlc_object_attach( p_vout, p_this );
            vlc_object_release( p_vout );
        }
    }

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

        p_vout = vout_Create( p_this, i_width, i_height, i_chroma, i_aspect );
    }

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
215
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
216 217
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
218
 *****************************************************************************/
219 220 221
vout_thread_t * __vout_Create( vlc_object_t *p_parent,
                               unsigned int i_width, unsigned int i_height,
                               vlc_fourcc_t i_chroma, unsigned int i_aspect )
Michel Kaempf's avatar
Michel Kaempf committed
222
{
gbazin's avatar
 
gbazin committed
223 224 225 226
    vout_thread_t  * p_vout;                            /* thread descriptor */
    input_thread_t * p_input_thread;
    int              i_index;                               /* loop variable */
    char           * psz_plugin;
gbazin's avatar
 
gbazin committed
227
    vlc_value_t      val, text;
Michel Kaempf's avatar
Michel Kaempf committed
228

229
    /* Allocate descriptor */
230
    p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
231
    if( p_vout == NULL )
Michel Kaempf's avatar
Michel Kaempf committed
232
    {
233
        msg_Err( p_parent, "out of memory" );
234
        return NULL;
Michel Kaempf's avatar
Michel Kaempf committed
235
    }
236

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

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
        p_vout->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
        p_vout->p_subpicture[i_index].i_type   = EMPTY_SUBPICTURE;
    }

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

256 257 258 259
    /* Register the default subpicture channel */
    p_vout->p_default_channel = NULL;
    p_vout->i_channel_count = 1;

gbazin's avatar
 
gbazin committed
260 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 292
    /* Initialize the rendering heap */
    I_RENDERPICTURES = 0;
    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
293
    p_vout->i_alignment  = 0;
gbazin's avatar
 
gbazin committed
294 295 296
    p_vout->render_time  = 10;
    p_vout->c_fps_samples = 0;
    p_vout->b_filter_change = 0;
297
    p_vout->pf_control = 0;
298
    p_vout->p_parent_intf = 0;
gbazin's avatar
 
gbazin committed
299 300 301 302 303 304 305 306

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

307 308 309 310
    var_Create( p_vout, "intf-change", VLC_VAR_BOOL );
    val.b_bool = VLC_TRUE;
    var_Set( p_vout, "intf-change", val );

gbazin's avatar
 
gbazin committed
311 312 313 314 315 316 317 318
    /* Initialize locks */
    vlc_mutex_init( p_vout, &p_vout->picture_lock );
    vlc_mutex_init( p_vout, &p_vout->subpicture_lock );
    vlc_mutex_init( p_vout, &p_vout->change_lock );

    /* Attach the new object now so we can use var inheritance below */
    vlc_object_attach( p_vout, p_parent );

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

322 323
    p_vout->b_override_aspect = VLC_FALSE;

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
    {
gbazin's avatar
 
gbazin committed
328
        var_Get( p_vout, "aspect-ratio", &val );
329 330

        /* Check whether the user tried to override aspect ratio */
gbazin's avatar
 
gbazin committed
331
        if( val.psz_string )
332 333
        {
            unsigned int i_new_aspect = i_aspect;
gbazin's avatar
 
gbazin committed
334
            char *psz_parser = strchr( val.psz_string, ':' );
335 336 337 338

            if( psz_parser )
            {
                *psz_parser++ = '\0';
gbazin's avatar
 
gbazin committed
339 340
                i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
                                                      / atoi( psz_parser );
341 342 343 344
            }
            else
            {
                i_new_aspect = i_width * VOUT_ASPECT_FACTOR
gbazin's avatar
 
gbazin committed
345
                                       * atof( val.psz_string )
346 347 348
                                       / i_height;
            }

gbazin's avatar
 
gbazin committed
349
            free( val.psz_string );
350 351 352

            if( i_new_aspect && i_new_aspect != i_aspect )
            {
zorglub's avatar
zorglub committed
353 354 355
                unsigned int i_aspect_x, i_aspect_y;

                vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
356 357

                msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
358
                         i_aspect_x, i_aspect_y );
359

gbazin's avatar
 
gbazin committed
360
                p_vout->render.i_aspect = i_new_aspect;
361 362

                p_vout->b_override_aspect = VLC_TRUE;
363 364 365 366
            }
        }

        /* Look for the default filter configuration */
gbazin's avatar
 
gbazin committed
367 368 369
        var_Create( p_vout, "filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "filter", &val );
        p_vout->psz_filter_chain = val.psz_string;
gbazin's avatar
 
gbazin committed
370 371 372 373 374 375 376 377 378 379 380 381 382
    }
    else
    {
        /* continue the parent's filter chain */
        char *psz_end;

        psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
        if( psz_end && *(psz_end+1) )
            p_vout->psz_filter_chain = strdup( psz_end+1 );
        else p_vout->psz_filter_chain = NULL;
    }

    /* Choose the video output module */
gbazin's avatar
 
gbazin committed
383
    if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
gbazin's avatar
 
gbazin committed
384
    {
gbazin's avatar
 
gbazin committed
385 386 387
        var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "vout", &val );
        psz_plugin = val.psz_string;
gbazin's avatar
 
gbazin committed
388 389 390 391 392 393 394 395 396 397 398 399
    }
    else
    {
        /* the filter chain is a string list of filters separated by double
         * colons */
        char *psz_end;

        psz_end = strchr( p_vout->psz_filter_chain, ':' );
        if( psz_end )
            psz_plugin = strndup( p_vout->psz_filter_chain,
                                  psz_end - p_vout->psz_filter_chain );
        else psz_plugin = strdup( p_vout->psz_filter_chain );
Sam Hocevar's avatar
 
Sam Hocevar committed
400 401
    }

gbazin's avatar
 
gbazin committed
402 403 404 405
    /* Initialize the dimensions of the video window */
    InitWindowSize( p_vout, &p_vout->i_window_width,
                    &p_vout->i_window_height );

gbazin's avatar
 
gbazin committed
406
    /* Create the vout thread */
gbazin's avatar
 
gbazin committed
407
    p_vout->p_module = module_Need( p_vout,
gbazin's avatar
 
gbazin committed
408 409
        ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
        "video filter" : "video output", psz_plugin, 0 );
Sam Hocevar's avatar
 
Sam Hocevar committed
410

gbazin's avatar
 
gbazin committed
411
    if( psz_plugin ) free( psz_plugin );
Sam Hocevar's avatar
 
Sam Hocevar committed
412 413
    if( p_vout->p_module == NULL )
    {
414 415
        msg_Err( p_vout, "no suitable vout module" );
        vlc_object_destroy( p_vout );
416
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
417
    }
gbazin's avatar
 
gbazin committed
418

gbazin's avatar
 
gbazin committed
419 420
    p_vout->p_text_renderer_module =
        module_Need( p_vout, "text renderer", NULL, 0 );
421 422
    if( p_vout->p_text_renderer_module == NULL )
    {
423 424
        msg_Warn( p_vout, "no suitable text renderer module" );
        p_vout->pf_add_string = NULL;
425
    }
gbazin's avatar
 
gbazin committed
426

gbazin's avatar
 
gbazin committed
427
    /* Create a few object variables for interface interaction */
gbazin's avatar
 
gbazin committed
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    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 );
    val.psz_string = ""; text.psz_string = _("Disable");
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
    val.psz_string = "discard"; text.psz_string = _("Discard");
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
    val.psz_string = "blend"; text.psz_string = _("Blend");
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
    val.psz_string = "mean"; text.psz_string = _("Mean");
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
    val.psz_string = "bob"; text.psz_string = _("Bob");
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
    val.psz_string = "linear"; text.psz_string = _("Linear");
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
gbazin's avatar
 
gbazin committed
443 444 445
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
gbazin's avatar
 
gbazin committed
446
        if( val.psz_string ) free( val.psz_string );
gbazin's avatar
 
gbazin committed
447
    }
gbazin's avatar
 
gbazin committed
448 449
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

450 451 452 453 454

    var_Create( p_vout, "filter", VLC_VAR_STRING );
    text.psz_string = _("Filters");
    var_Change( p_vout, "filter", VLC_VAR_SETTEXT, &text, NULL );
    var_Change( p_vout, "filter", VLC_VAR_INHERITVALUE, &val, NULL );
gbazin's avatar
 
gbazin committed
455
    if( val.psz_string )
456 457
    {
        var_Set( p_vout, "filter", val );
gbazin's avatar
 
gbazin committed
458
        free( val.psz_string );
459 460 461
    }
    var_AddCallback( p_vout, "filter", FilterCallback, NULL );

gbazin's avatar
 
gbazin committed
462 463
    /* Calculate delay created by internal caching */
    p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
gbazin's avatar
 
gbazin committed
464
                                           VLC_OBJECT_INPUT, FIND_ANYWHERE );
gbazin's avatar
 
gbazin committed
465 466
    if( p_input_thread )
    {
gbazin's avatar
 
gbazin committed
467
        p_vout->i_pts_delay = p_input_thread->i_pts_delay;
gbazin's avatar
 
gbazin committed
468 469 470 471
        vlc_object_release( p_input_thread );
    }
    else
    {
gbazin's avatar
 
gbazin committed
472
        p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
gbazin's avatar
 
gbazin committed
473 474
    }

475
    if( vlc_thread_create( p_vout, "video output", RunThread,
gbazin's avatar
 
gbazin committed
476
                           VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
Michel Kaempf's avatar
Michel Kaempf committed
477
    {
478
        msg_Err( p_vout, "out of memory" );
479
        module_Unneed( p_vout, p_vout->p_module );
480 481 482 483 484 485 486 487 488 489 490 491 492 493
        vlc_object_detach( p_vout );
        vlc_object_destroy( p_vout );
        return NULL;
    }

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

        /* Make sure the thread is destroyed */
        p_vout->b_die = VLC_TRUE;
        vlc_thread_join( p_vout );

        vlc_object_detach( p_vout );
494 495
        vlc_object_destroy( p_vout );
        return NULL;
496
    }
Michel Kaempf's avatar
Michel Kaempf committed
497

498
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
499 500
}

501
/*****************************************************************************
502
 * vout_Destroy: destroys a previously created video output
503 504
 *****************************************************************************
 * Destroy a terminated thread.
Michel Kaempf's avatar
Michel Kaempf committed
505
 * The function will request a destruction of the specified thread. If pi_error
506
 * is NULL, it will return once the thread is destroyed. Else, it will be
Michel Kaempf's avatar
Michel Kaempf committed
507
 * update using one of the THREAD_* constants.
508
 *****************************************************************************/
509
void vout_Destroy( vout_thread_t *p_vout )
zorglub's avatar
zorglub committed
510
{
511
    vlc_object_t *p_playlist;
zorglub's avatar
zorglub committed
512

Michel Kaempf's avatar
Michel Kaempf committed
513
    /* Request thread destruction */
514
    p_vout->b_die = VLC_TRUE;
515
    vlc_thread_join( p_vout );
Michel Kaempf's avatar
Michel Kaempf committed
516

517 518
    var_Destroy( p_vout, "intf-change" );

zorglub's avatar
zorglub committed
519
    p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
520 521
                                  FIND_ANYWHERE );

gbazin's avatar
 
gbazin committed
522 523
    if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );

524
    /* Free structure */
525
    vlc_object_destroy( p_vout );
526 527 528 529

    /* If it was the last vout, tell the interface to show up */
    if( p_playlist != NULL )
    {
zorglub's avatar
zorglub committed
530
        vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
531 532 533 534 535 536 537 538 539 540 541 542 543
                                            VLC_OBJECT_VOUT, FIND_ANYWHERE );
        if( p_another_vout == NULL )
        {
            vlc_value_t val;
            val.b_bool = VLC_TRUE;
            var_Set( p_playlist, "intf-show", val );
        }
        else
        {
            vlc_object_release( p_another_vout );
        }
        vlc_object_release( p_playlist );
    }
Michel Kaempf's avatar
Michel Kaempf committed
544 545
}

546
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
547
 * InitThread: initialize video output thread
548
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
549 550 551
 * 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.
552
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
553
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
554
{
555 556
    int i;
    unsigned int i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
557

Sam Hocevar's avatar
 
Sam Hocevar committed
558 559 560 561
    vlc_mutex_lock( &p_vout->change_lock );

#ifdef STATS
    p_vout->c_loops = 0;
Vincent Seguin's avatar
Vincent Seguin committed
562 563
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
564
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
565
    if( p_vout->pf_init( p_vout ) )
Vincent Seguin's avatar
Vincent Seguin committed
566
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
567
        vlc_mutex_unlock( &p_vout->change_lock );
568
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
569 570
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
571
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
572
    {
573 574
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
575
        p_vout->pf_end( p_vout );
Sam Hocevar's avatar
 
Sam Hocevar committed
576
        vlc_mutex_unlock( &p_vout->change_lock );
577
        return VLC_EGENERIC;
578
    }
Vincent Seguin's avatar
Vincent Seguin committed
579

gbazin's avatar
 
gbazin committed
580 581 582 583 584 585 586 587 588
    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 );
        vlc_mutex_unlock( &p_vout->change_lock );
        return VLC_EGENERIC;
    }

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

591
#if 0
592 593 594 595 596 597 598 599 600 601 602 603 604
    if( !p_vout->psz_filter_chain )
    {
        char *psz_aspect = config_GetPsz( p_vout, "pixel-ratio" );

        if( psz_aspect )
        {
            int i_new_aspect = p_vout->output.i_width * VOUT_ASPECT_FACTOR
                                                      * atof( psz_aspect )
                                                      / p_vout->output.i_height;
            free( psz_aspect );

            if( i_new_aspect && i_new_aspect != p_vout->output.i_aspect )
            {
zorglub's avatar
zorglub committed
605
                vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
606

607
                msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
608
                         i_aspect_x, i_aspect_y );
609 610 611 612
                p_vout->output.i_aspect = i_new_aspect;
            }
        }
    }
613
#endif
614

615
    vout_AspectRatio( p_vout->render.i_aspect, &i_aspect_x, &i_aspect_y );
616 617 618 619
    msg_Dbg( p_vout,
             "picture in %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
             p_vout->render.i_width, p_vout->render.i_height,
             p_vout->render.i_chroma, (char*)&p_vout->render.i_chroma,
620
             i_aspect_x, i_aspect_y );
Sam Hocevar's avatar
 
Sam Hocevar committed
621

622
    vout_AspectRatio( p_vout->output.i_aspect, &i_aspect_x, &i_aspect_y );
623 624 625 626
    msg_Dbg( p_vout,
             "picture out %ix%i, chroma 0x%.8x (%4.4s), aspect ratio %i:%i",
             p_vout->output.i_width, p_vout->output.i_height,
             p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma,
627
             i_aspect_x, i_aspect_y );
Sam Hocevar's avatar
 
Sam Hocevar committed
628

Sam Hocevar's avatar
 
Sam Hocevar committed
629 630 631 632 633 634 635 636
    /* 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
637
    /* Check whether we managed to create direct buffers similar to
638
     * the render buffers, ie same size and chroma */
Sam Hocevar's avatar
 
Sam Hocevar committed
639 640
    if( ( p_vout->output.i_width == p_vout->render.i_width )
     && ( p_vout->output.i_height == p_vout->render.i_height )
641
     && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
642
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
643 644 645 646
        /* 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
647 648
        p_vout->b_direct = 1;

Sam Hocevar's avatar
 
Sam Hocevar committed
649 650
        for( i = 1; i < VOUT_MAX_PICTURES; i++ )
        {
gbazin's avatar
 
gbazin committed
651 652 653 654 655 656 657 658
            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
659 660 661
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
        }
gbazin's avatar
 
gbazin committed
662 663 664 665

        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
666 667 668
    }
    else
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
669 670 671
        /* 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
672 673
        p_vout->b_direct = 0;

Sam Hocevar's avatar
 
Sam Hocevar committed
674
        /* Choose the best module */
gbazin's avatar
 
gbazin committed
675
        p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
Sam Hocevar's avatar
 
Sam Hocevar committed
676

Sam Hocevar's avatar
 
Sam Hocevar committed
677 678
        if( p_vout->chroma.p_module == NULL )
        {
679
            msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
680 681
                     (char*)&p_vout->render.i_chroma,
                     (char*)&p_vout->output.i_chroma );
Sam Hocevar's avatar
 
Sam Hocevar committed
682 683
            p_vout->pf_end( p_vout );
            vlc_mutex_unlock( &p_vout->change_lock );
684
            return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
685
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
686

gbazin's avatar
 
gbazin committed
687 688 689 690
        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
691 692

        /* Append render buffers after the direct buffers */
Sam Hocevar's avatar
 
Sam Hocevar committed
693
        for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
694 695 696
        {
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
gbazin's avatar
 
gbazin committed
697 698 699 700

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

Sam Hocevar's avatar
 
Sam Hocevar committed
704 705 706 707 708 709 710 711 712 713 714
    /* 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;
    }

715
/* XXX XXX mark thread ready */
716
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
717 718
}

719
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
720
 * RunThread: video output thread
721
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
722 723 724
 * 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.
725
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
726
static void RunThread( vout_thread_t *p_vout)
Vincent Seguin's avatar
Vincent Seguin committed
727
{
Sam Hocevar's avatar
 
Sam Hocevar committed
728
    int             i_index;                                /* index in heap */
729
    int             i_idle_loops = 0;  /* loops without displaying a picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
730 731 732 733
    mtime_t         current_date;                            /* current date */
    mtime_t         display_date;                            /* display date */

    picture_t *     p_picture;                            /* picture pointer */
734
    picture_t *     p_last_picture = NULL;                   /* last picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
735 736 737 738 739 740 741 742
    picture_t *     p_directbuffer;              /* direct buffer to display */

    subpicture_t *  p_subpic;                          /* subpicture pointer */

    /*
     * Initialize thread
     */
    p_vout->b_error = InitThread( p_vout );
gbazin's avatar
 
gbazin committed
743 744 745 746

    /* signal the creation of the vout */
    vlc_thread_ready( p_vout );

Sam Hocevar's avatar
 
Sam Hocevar committed
747 748 749
    if( p_vout->b_error )
    {
        /* Destroy thread structures allocated by Create and InitThread */
750
        DestroyThread( p_vout );
Sam Hocevar's avatar
 
Sam Hocevar committed
751 752
        return;
    }
753

754
    /*
Sam Hocevar's avatar
 
Sam Hocevar committed
755 756
     * Main loop - it is not executed if an error occured during
     * initialization
757
     */
Sam Hocevar's avatar
 
Sam Hocevar committed
758
    while( (!p_vout->b_die) && (!p_vout->b_error) )
759
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
760
        /* Initialize loop variables */
761
        p_picture = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
762 763
        display_date = 0;
        current_date = mdate();
Sam Hocevar's avatar
 
Sam Hocevar committed
764

765
#if 0
Sam Hocevar's avatar
 
Sam Hocevar committed
766 767
        p_vout->c_loops++;
        if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
768
        {
769 770
            msg_Dbg( p_vout, "picture heap: %d/%d",
                     I_RENDERPICTURES, p_vout->i_heap_size );
Sam Hocevar's avatar
 
Sam Hocevar committed
771
        }
772
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
773 774

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

789
        if( p_picture )
790
        {
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
            /* 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;
                    }
                }
            }
807

808 809 810 811 812 813 814 815 816 817 818 819 820 821
            /* 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 );
822
                p_last_picture = NULL;
823 824
            }

Sam Hocevar's avatar
 
Sam Hocevar committed
825 826 827 828
            /* Compute FPS rate */
            p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
                = display_date;

829
            if( !p_picture->b_force &&
830
                p_picture != p_last_picture &&
831
                display_date < current_date + p_vout->render_time )
Sam Hocevar's avatar
 
Sam Hocevar committed
832 833 834 835 836 837 838 839 840 841 842 843 844 845
            {
                /* 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
846
                    p_vout->i_heap_size--;
Sam Hocevar's avatar
 
Sam Hocevar committed
847
                }
gbazin's avatar
 
gbazin committed
848
                msg_Warn( p_vout, "late picture skipped ("I64Fd")",
849
                                  current_date - display_date );
850 851 852 853
                vlc_mutex_unlock( &p_vout->picture_lock );

                continue;
            }
854

gbazin's avatar
 
gbazin committed
855
            if( display_date >
sigmunau's avatar
sigmunau committed
856
                current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
            {
                /* Picture is waaay too early: it will be destroyed */
                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;
                    p_vout->i_heap_size--;
                }
872
                msg_Warn( p_vout, "vout warning: early picture skipped "
gbazin's avatar
 
gbazin committed
873 874
                          "("I64Fd")", display_date - current_date
                          - p_vout->i_pts_delay );
Sam Hocevar's avatar
 
Sam Hocevar committed
875 876 877 878
                vlc_mutex_unlock( &p_vout->picture_lock );

                continue;
            }
879

880
            if( display_date > current_date + VOUT_DISPLAY_DELAY )
Sam Hocevar's avatar
 
Sam Hocevar committed
881 882 883 884 885 886 887 888
            {
                /* 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;
            }
889 890
            else if( p_picture == p_last_picture )
            {
891 892
                /* We are asked to repeat the previous picture, but we first
                 * wait for a couple of idle loops */
893 894 895 896 897 898 899
                if( i_idle_loops < 4 )
                {
                    p_picture    = NULL;
                    display_date = 0;
                }
                else
                {
900 901 902
                    /* 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;
903 904 905 906 907 908 909
                }
            }
        }

        if( p_picture == NULL )
        {
            i_idle_loops++;
910 911
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
912 913 914 915
        /*
         * Check for subpictures to display
         */
        p_subpic = vout_SortSubPictures( p_vout, display_date );
916

Sam Hocevar's avatar
 
Sam Hocevar committed
917 918 919 920 921
        /*
         * Perform rendering
         */
        p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );

Sam Hocevar's avatar
 
Sam Hocevar committed
922
        /*
923
         * Call the plugin-specific rendering method if there is one
Sam Hocevar's avatar
 
Sam Hocevar committed
924
         */
gbazin's avatar
 
gbazin committed
925
        if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
Sam Hocevar's avatar
 
Sam Hocevar committed
926 927 928 929 930
        {
            /* Render the direct buffer returned by vout_RenderPicture */
            p_vout->pf_render( p_vout, p_directbuffer );
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
931 932 933
        /*
         * Sleep, wake up
         */
gbazin's avatar
 
gbazin committed
934
        if( display_date != 0 && p_directbuffer != NULL )
935
        {
sigmunau's avatar
sigmunau committed
936 937 938 939 940 941 942 943 944 945 946
            mtime_t current_render_time = mdate() - current_date;
            /* if render time is very large we don't include it in the mean */
            if( current_render_time < p_vout->render_time +
                VOUT_DISPLAY_DELAY )
            {
                /* Store render time using a sliding mean weighting to
                 * current value in a 3 to 1 ratio*/
                p_vout->render_time *= 3;
                p_vout->render_time += current_render_time;
                p_vout->render_time >>= 2;
            }
947 948
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
949 950 951 952
        /* Give back change lock */
        vlc_mutex_unlock( &p_vout->change_lock );

        /* Sleep a while or until a given date */
gbazin's avatar
 
gbazin committed
953
        if( display_date != 0 )
Sam Hocevar's avatar
Sam Hocevar committed
954
        {
gbazin's avatar