video_output.c 49 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 256 257 258 259 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
    /* 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;

    /* 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
289
    p_vout->i_alignment  = 0;
gbazin's avatar
 
gbazin committed
290 291 292
    p_vout->render_time  = 10;
    p_vout->c_fps_samples = 0;
    p_vout->b_filter_change = 0;
293
    p_vout->pf_control = 0;
gbazin's avatar
 
gbazin committed
294 295 296 297 298 299 300 301

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

302 303 304 305
    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
306 307 308 309 310 311 312 313
    /* 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 );

314 315
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
gbazin's avatar
 
gbazin committed
316

317 318
    p_vout->b_override_aspect = VLC_FALSE;

gbazin's avatar
 
gbazin committed
319 320 321
    /* 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
322
    {
gbazin's avatar
 
gbazin committed
323
        var_Get( p_vout, "aspect-ratio", &val );
324 325

        /* Check whether the user tried to override aspect ratio */
gbazin's avatar
 
gbazin committed
326
        if( val.psz_string )
327 328
        {
            unsigned int i_new_aspect = i_aspect;
gbazin's avatar
 
gbazin committed
329
            char *psz_parser = strchr( val.psz_string, ':' );
330 331 332 333

            if( psz_parser )
            {
                *psz_parser++ = '\0';
gbazin's avatar
 
gbazin committed
334 335
                i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
                                                      / atoi( psz_parser );
336 337 338 339
            }
            else
            {
                i_new_aspect = i_width * VOUT_ASPECT_FACTOR
gbazin's avatar
 
gbazin committed
340
                                       * atof( val.psz_string )
341 342 343
                                       / i_height;
            }

gbazin's avatar
 
gbazin committed
344
            free( val.psz_string );
345 346 347

            if( i_new_aspect && i_new_aspect != i_aspect )
            {
zorglub's avatar
zorglub committed
348 349 350
                unsigned int i_aspect_x, i_aspect_y;

                vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
351 352

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

gbazin's avatar
 
gbazin committed
355
                p_vout->render.i_aspect = i_new_aspect;
356 357

                p_vout->b_override_aspect = VLC_TRUE;
358 359 360 361
            }
        }

        /* Look for the default filter configuration */
gbazin's avatar
 
gbazin committed
362 363 364
        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
365 366 367 368 369 370 371 372 373 374 375 376 377
    }
    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
378
    if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
gbazin's avatar
 
gbazin committed
379
    {
gbazin's avatar
 
gbazin committed
380 381 382
        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
383 384 385 386 387 388 389 390 391 392 393 394
    }
    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
395 396
    }

gbazin's avatar
 
gbazin committed
397 398 399 400
    /* 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
401
    /* Create the vout thread */
gbazin's avatar
 
gbazin committed
402
    p_vout->p_module = module_Need( p_vout,
gbazin's avatar
 
gbazin committed
403 404
        ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
        "video filter" : "video output", psz_plugin, 0 );
Sam Hocevar's avatar
 
Sam Hocevar committed
405

gbazin's avatar
 
gbazin committed
406
    if( psz_plugin ) free( psz_plugin );
Sam Hocevar's avatar
 
Sam Hocevar committed
407 408
    if( p_vout->p_module == NULL )
    {
409 410
        msg_Err( p_vout, "no suitable vout module" );
        vlc_object_destroy( p_vout );
411
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
412
    }
gbazin's avatar
 
gbazin committed
413

gbazin's avatar
 
gbazin committed
414 415
    p_vout->p_text_renderer_module =
        module_Need( p_vout, "text renderer", NULL, 0 );
416 417
    if( p_vout->p_text_renderer_module == NULL )
    {
418 419
        msg_Warn( p_vout, "no suitable text renderer module" );
        p_vout->pf_add_string = NULL;
420
    }
gbazin's avatar
 
gbazin committed
421

gbazin's avatar
 
gbazin committed
422
    /* Create a few object variables for interface interaction */
gbazin's avatar
 
gbazin committed
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
    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
438 439 440
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
gbazin's avatar
 
gbazin committed
441
        if( val.psz_string ) free( val.psz_string );
gbazin's avatar
 
gbazin committed
442
    }
gbazin's avatar
 
gbazin committed
443 444
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

445 446 447 448 449

    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
450
    if( val.psz_string )
451 452
    {
        var_Set( p_vout, "filter", val );
gbazin's avatar
 
gbazin committed
453
        free( val.psz_string );
454 455 456
    }
    var_AddCallback( p_vout, "filter", FilterCallback, NULL );

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

470
    if( vlc_thread_create( p_vout, "video output", RunThread,
gbazin's avatar
 
gbazin committed
471
                           VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
Michel Kaempf's avatar
Michel Kaempf committed
472
    {
473
        msg_Err( p_vout, "out of memory" );
474
        module_Unneed( p_vout, p_vout->p_module );
475 476 477 478 479 480 481 482 483 484 485 486 487 488
        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 );
489 490
        vlc_object_destroy( p_vout );
        return NULL;
491
    }
Michel Kaempf's avatar
Michel Kaempf committed
492

493
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
494 495
}

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

Michel Kaempf's avatar
Michel Kaempf committed
508
    /* Request thread destruction */
509
    p_vout->b_die = VLC_TRUE;
510
    vlc_thread_join( p_vout );
Michel Kaempf's avatar
Michel Kaempf committed
511

512 513
    var_Destroy( p_vout, "intf-change" );

zorglub's avatar
zorglub committed
514
    p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
515 516
                                  FIND_ANYWHERE );

gbazin's avatar
 
gbazin committed
517 518
    if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );

519
    /* Free structure */
520
    vlc_object_destroy( p_vout );
521 522 523 524

    /* If it was the last vout, tell the interface to show up */
    if( p_playlist != NULL )
    {
zorglub's avatar
zorglub committed
525
        vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
526 527 528 529 530 531 532 533 534 535 536 537 538
                                            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
539 540
}

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

Sam Hocevar's avatar
 
Sam Hocevar committed
553 554 555 556
    vlc_mutex_lock( &p_vout->change_lock );

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

Sam Hocevar's avatar
 
Sam Hocevar committed
559
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
560
    if( p_vout->pf_init( p_vout ) )
Vincent Seguin's avatar
Vincent Seguin committed
561
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
562
        vlc_mutex_unlock( &p_vout->change_lock );
563
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
564 565
    }

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

gbazin's avatar
 
gbazin committed
575 576 577 578 579 580 581 582 583
    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;
    }

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

586
#if 0
587 588 589 590 591 592 593 594 595 596 597 598 599
    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
600
                vout_AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
601

602
                msg_Dbg( p_vout, "output ratio forced to %i:%i\n",
603
                         i_aspect_x, i_aspect_y );
604 605 606 607
                p_vout->output.i_aspect = i_new_aspect;
            }
        }
    }
608
#endif
609

610
    vout_AspectRatio( p_vout->render.i_aspect, &i_aspect_x, &i_aspect_y );
611 612 613 614
    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,
615
             i_aspect_x, i_aspect_y );
Sam Hocevar's avatar
 
Sam Hocevar committed
616

617
    vout_AspectRatio( p_vout->output.i_aspect, &i_aspect_x, &i_aspect_y );
618 619 620 621
    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,
622
             i_aspect_x, i_aspect_y );
Sam Hocevar's avatar
 
Sam Hocevar committed
623

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

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

        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
661 662 663
    }
    else
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
664 665 666
        /* 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
667 668
        p_vout->b_direct = 0;

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

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

gbazin's avatar
 
gbazin committed
682 683 684 685
        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
686 687

        /* Append render buffers after the direct buffers */
Sam Hocevar's avatar
 
Sam Hocevar committed
688
        for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
689 690 691
        {
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
gbazin's avatar
 
gbazin committed
692 693 694 695

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

Sam Hocevar's avatar
 
Sam Hocevar committed
699 700 701 702 703 704 705 706 707 708 709
    /* 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;
    }

710
/* XXX XXX mark thread ready */
711
    return VLC_SUCCESS;
Vincent Seguin's avatar
Vincent Seguin committed
712 713
}

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

    picture_t *     p_picture;                            /* picture pointer */
729
    picture_t *     p_last_picture = NULL;                   /* last picture */
Sam Hocevar's avatar
 
Sam Hocevar committed
730 731 732 733 734 735 736 737
    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
738 739 740 741

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

Sam Hocevar's avatar
 
Sam Hocevar committed
742 743 744
    if( p_vout->b_error )
    {
        /* Destroy thread structures allocated by Create and InitThread */
745
        DestroyThread( p_vout );
Sam Hocevar's avatar
 
Sam Hocevar committed
746 747
        return;
    }
748

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

760
#if 0
Sam Hocevar's avatar
 
Sam Hocevar committed
761 762
        p_vout->c_loops++;
        if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
763
        {
764 765
            msg_Dbg( p_vout, "picture heap: %d/%d",
                     I_RENDERPICTURES, p_vout->i_heap_size );
Sam Hocevar's avatar
 
Sam Hocevar committed
766
        }
767
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
768 769

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

784
        if( p_picture )
785
        {
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
            /* 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;
                    }
                }
            }
802

803 804 805 806 807 808 809 810 811 812 813 814 815 816
            /* 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 );
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 )
Sam Hocevar's avatar
 
Sam Hocevar committed
827 828 829 830 831 832 833 834 835 836 837 838 839 840
            {
                /* 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
841
                    p_vout->i_heap_size--;
Sam Hocevar's avatar
 
Sam Hocevar committed
842
                }
gbazin's avatar
 
gbazin committed
843
                msg_Warn( p_vout, "late picture skipped ("I64Fd")",
844
                                  current_date - display_date );
845 846 847 848
                vlc_mutex_unlock( &p_vout->picture_lock );

                continue;
            }
849

gbazin's avatar
 
gbazin committed
850
            if( display_date >
sigmunau's avatar
sigmunau committed
851
                current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
            {
                /* 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--;
                }
867
                msg_Warn( p_vout, "vout warning: early picture skipped "
gbazin's avatar
 
gbazin committed
868 869
                          "("I64Fd")", display_date - current_date
                          - p_vout->i_pts_delay );
Sam Hocevar's avatar
 
Sam Hocevar committed
870 871 872 873
                vlc_mutex_unlock( &p_vout->picture_lock );

                continue;
            }
874

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

        if( p_picture == NULL )
        {
            i_idle_loops++;
905 906
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
907 908 909 910
        /*
         * Check for subpictures to display
         */
        p_subpic = vout_SortSubPictures( p_vout, display_date );
911

Sam Hocevar's avatar
 
Sam Hocevar committed
912 913 914 915 916
        /*
         * Perform rendering
         */
        p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );

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

Sam Hocevar's avatar
 
Sam Hocevar committed
926 927 928
        /*
         * Sleep, wake up
         */
gbazin's avatar
 
gbazin committed
929
        if( display_date != 0 && p_directbuffer != NULL )
930
        {
sigmunau's avatar
sigmunau committed
931 932 933 934 935 936 937 938 939 940 941
            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;
            }
942 943
        }

Sam Hocevar's avatar
 
Sam Hocevar committed
944 945 946 947
        /* Give back change lock */
        vlc_mutex_unlock( &p_vout->change_lock );

        /* Sleep a while or until a given date */
gbazin's avatar
 
gbazin committed
948
        if( display_date != 0 )
Sam Hocevar's avatar
Sam Hocevar committed
949
        {
gbazin's avatar
 
gbazin committed
950 951 952 953 954 955
            /* If there are filters in the chain, better give them the picture
             * in advance */
            if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
            {
                mwait( display_date - VOUT_MWAIT_TOLERANCE );
            }
956 957 958
        }
        else
        {