video_output.c 50.3 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * video_output.c : video output thread
3
 *
Michel Kaempf's avatar
Michel Kaempf committed
4 5
 * This module describes the programming interface for video output threads.
 * It includes functions allowing to open a new thread, send pictures to a
6 7
 * thread, and destroy a previously oppened video output thread.
 *****************************************************************************
8
 * Copyright (C) 2000-2004 the VideoLAN team
gbazin's avatar
gbazin committed
9
 * $Id$
10
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
11
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
12
 *          Gildas Bazin <gbazin@videolan.org>
13 14 15 16 17
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
Sam Hocevar's avatar
Sam Hocevar committed
18
 *
19 20
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 22
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
23
 *
24 25 26
 * 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.
27
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
28

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

34
#include <vlc/vlc.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
35

36 37
#ifdef HAVE_SYS_TIMES_H
#   include <sys/times.h>
38
#endif
39

40
#include "vlc_video.h"
Michel Kaempf's avatar
Michel Kaempf committed
41
#include "video_output.h"
42
#include "vlc_spu.h"
gbazin's avatar
 
gbazin committed
43
#include <vlc/input.h>                 /* for input_thread_t and i_pts_delay */
44
#include "vlc_playlist.h"
45

46 47 48 49
#if defined( SYS_DARWIN )
#include "darwin_specific.h"
#endif

50
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
51
 * Local prototypes
52
 *****************************************************************************/
53 54 55 56 57
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
58

59
static void     AspectRatio       ( int, int *, int * );
60 61
static int      BinaryLog         ( uint32_t );
static void     MaskToShift       ( int *, int *, uint32_t );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
62
static void     InitWindowSize    ( vout_thread_t *, unsigned *, unsigned * );
Michel Kaempf's avatar
Michel Kaempf committed
63

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

70 71 72
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

73
/*****************************************************************************
74 75 76 77 78
 * 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.
 *****************************************************************************/
79 80
vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                               video_format_t *p_fmt )
81
{
82
    if( !p_fmt )
83
    {
gbazin's avatar
 
gbazin committed
84
        /* Reattach video output to input before bailing out */
85 86
        if( p_vout )
        {
87
            vlc_object_t *p_playlist;
88

89 90
            p_playlist = vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
                                          FIND_ANYWHERE );
gbazin's avatar
 
gbazin committed
91

92
            if( p_playlist )
93
            {
94
                spu_Attach( p_vout->p_spu, p_this, VLC_FALSE );
95
                vlc_object_detach( p_vout );
96
                vlc_object_attach( p_vout, p_playlist );
97

98
                vlc_object_release( p_playlist );
99 100 101
            }
            else
            {
zorglub's avatar
zorglub committed
102
                msg_Dbg( p_this, "cannot find playlist, destroying vout" );
103 104 105
                vlc_object_detach( p_vout );
                vout_Destroy( p_vout );
            }
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
        }
        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 )
        {
121
            playlist_t *p_playlist;
gbazin's avatar
 
gbazin committed
122

123 124 125
            p_playlist = vlc_object_find( p_this,
                                          VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
            if( p_playlist )
gbazin's avatar
 
gbazin committed
126
            {
127
                vlc_mutex_lock( &p_playlist->gc_lock );
128 129
                p_vout = vlc_object_find( p_playlist,
                                          VLC_OBJECT_VOUT, FIND_CHILD );
130
                /* only first children of p_input for unused vout */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
131
                if( p_vout && p_vout->p_parent != (vlc_object_t *)p_playlist )
132 133 134 135
                {
                    vlc_object_release( p_vout );
                    p_vout = NULL;
                }
136
                vlc_mutex_unlock( &p_playlist->gc_lock );
137
                vlc_object_release( p_playlist );
gbazin's avatar
 
gbazin committed
138
            }
139 140 141 142 143 144
        }
    }

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

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

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

166
            if( !psz_filter_chain && !p_vout->psz_filter_chain )
gbazin's avatar
 
gbazin committed
167 168 169 170
            {
                p_vout->b_filter_change = VLC_FALSE;
            }

gbazin's avatar
 
gbazin committed
171
            if( psz_filter_chain ) free( psz_filter_chain );
gbazin's avatar
 
gbazin committed
172 173
        }

174 175 176 177
        if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
            ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
            ( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ) ||
            ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect
178
                    && !p_vout->b_override_aspect ) ||
gbazin's avatar
 
gbazin committed
179
            p_vout->b_filter_change )
180 181 182 183 184 185 186 187 188 189 190
        {
            /* 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 );
191
            spu_Attach( p_vout->p_spu, p_this, VLC_TRUE );
192 193 194 195 196 197 198 199 200
            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" );

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

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
209
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
210 211
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
212
 *****************************************************************************/
213
vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
214
{
gbazin's avatar
 
gbazin committed
215 216 217 218
    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
219
    vlc_value_t      val, text;
Michel Kaempf's avatar
Michel Kaempf committed
220

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

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

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

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

    /* Initialize the rendering heap */
    I_RENDERPICTURES = 0;
250 251
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
gbazin's avatar
 
gbazin committed
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
    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
283
    p_vout->i_alignment  = 0;
gbazin's avatar
 
gbazin committed
284 285 286
    p_vout->render_time  = 10;
    p_vout->c_fps_samples = 0;
    p_vout->b_filter_change = 0;
287
    p_vout->pf_control = 0;
288
    p_vout->p_parent_intf = 0;
gbazin's avatar
 
gbazin committed
289 290 291 292 293

    /* Initialize locks */
    vlc_mutex_init( p_vout, &p_vout->picture_lock );
    vlc_mutex_init( p_vout, &p_vout->change_lock );

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

301
    /* Initialize subpicture unit */
302
    p_vout->p_spu = spu_Create( p_vout );
303
    spu_Attach( p_vout->p_spu, p_parent, VLC_TRUE );
304

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

308 309
    spu_Init( p_vout->p_spu );

310 311
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
gbazin's avatar
 
gbazin committed
312

313 314
    p_vout->b_override_aspect = VLC_FALSE;

gbazin's avatar
 
gbazin committed
315 316 317
    /* 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
318
    {
gbazin's avatar
 
gbazin committed
319
        var_Get( p_vout, "aspect-ratio", &val );
320 321

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

            if( psz_parser )
            {
                *psz_parser++ = '\0';
gbazin's avatar
 
gbazin committed
330 331
                i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
                                                      / atoi( psz_parser );
332 333 334
            }
            else
            {
335 336
                i_new_aspect = VOUT_ASPECT_FACTOR
                                       * atof( val.psz_string );
337 338
            }

gbazin's avatar
 
gbazin committed
339
            free( val.psz_string );
340 341 342

            if( i_new_aspect && i_new_aspect != i_aspect )
            {
343
                int i_aspect_x, i_aspect_y;
zorglub's avatar
zorglub committed
344

345
                AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
346 347

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

gbazin's avatar
 
gbazin committed
350
                p_vout->render.i_aspect = i_new_aspect;
351 352

                p_vout->b_override_aspect = VLC_TRUE;
353 354 355 356
            }
        }

        /* Look for the default filter configuration */
357 358
        var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "vout-filter", &val );
gbazin's avatar
 
gbazin committed
359
        p_vout->psz_filter_chain = val.psz_string;
gbazin's avatar
 
gbazin committed
360 361 362 363 364 365
    }
    else
    {
        /* continue the parent's filter chain */
        char *psz_end;

366
        psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
gbazin's avatar
 
gbazin committed
367 368 369 370 371 372
        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
373
    if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
gbazin's avatar
 
gbazin committed
374
    {
gbazin's avatar
 
gbazin committed
375 376 377
        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
378 379 380 381 382 383 384
    }
    else
    {
        /* the filter chain is a string list of filters separated by double
         * colons */
        char *psz_end;

385
        psz_end = strchr( p_vout->psz_filter_chain, ':' );
gbazin's avatar
 
gbazin committed
386 387 388 389
        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
390 391
    }

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

gbazin's avatar
 
gbazin committed
401
    if( psz_plugin ) free( psz_plugin );
Sam Hocevar's avatar
 
Sam Hocevar committed
402 403
    if( p_vout->p_module == NULL )
    {
404
        msg_Err( p_vout, "no suitable vout module" );
405
        vlc_object_detach( p_vout );
406
        vlc_object_destroy( p_vout );
407
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
408
    }
gbazin's avatar
 
gbazin committed
409

gbazin's avatar
 
gbazin committed
410
    /* Create a few object variables for interface interaction */
gbazin's avatar
 
gbazin committed
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
    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
426 427 428
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
gbazin's avatar
 
gbazin committed
429
        if( val.psz_string ) free( val.psz_string );
gbazin's avatar
 
gbazin committed
430
    }
gbazin's avatar
 
gbazin committed
431 432
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

433

434
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
435
    text.psz_string = _("Filters");
436 437
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
438

gbazin's avatar
 
gbazin committed
439 440
    /* Calculate delay created by internal caching */
    p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
gbazin's avatar
 
gbazin committed
441
                                           VLC_OBJECT_INPUT, FIND_ANYWHERE );
gbazin's avatar
 
gbazin committed
442 443
    if( p_input_thread )
    {
gbazin's avatar
 
gbazin committed
444
        p_vout->i_pts_delay = p_input_thread->i_pts_delay;
gbazin's avatar
 
gbazin committed
445 446 447 448
        vlc_object_release( p_input_thread );
    }
    else
    {
gbazin's avatar
 
gbazin committed
449
        p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
gbazin's avatar
 
gbazin committed
450 451
    }

452
    if( vlc_thread_create( p_vout, "video output", RunThread,
gbazin's avatar
 
gbazin committed
453
                           VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
Michel Kaempf's avatar
Michel Kaempf committed
454
    {
455
        msg_Err( p_vout, "out of memory" );
456
        module_Unneed( p_vout, p_vout->p_module );
457 458 459 460 461 462 463 464 465 466 467
        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;
468

469 470 471
        vlc_thread_join( p_vout );

        vlc_object_detach( p_vout );
472 473
        vlc_object_destroy( p_vout );
        return NULL;
474
    }
Michel Kaempf's avatar
Michel Kaempf committed
475

476
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
477 478
}

479
/*****************************************************************************
480
 * vout_Destroy: destroys a previously created video output
481 482
 *****************************************************************************
 * Destroy a terminated thread.
Michel Kaempf's avatar
Michel Kaempf committed
483
 * The function will request a destruction of the specified thread. If pi_error
484
 * is NULL, it will return once the thread is destroyed. Else, it will be
Michel Kaempf's avatar
Michel Kaempf committed
485
 * update using one of the THREAD_* constants.
486
 *****************************************************************************/
487
void vout_Destroy( vout_thread_t *p_vout )
zorglub's avatar
zorglub committed
488
{
489
    vlc_object_t *p_playlist;
zorglub's avatar
zorglub committed
490

Michel Kaempf's avatar
Michel Kaempf committed
491
    /* Request thread destruction */
492
    p_vout->b_die = VLC_TRUE;
493
    vlc_thread_join( p_vout );
Michel Kaempf's avatar
Michel Kaempf committed
494

495 496
    var_Destroy( p_vout, "intf-change" );

zorglub's avatar
zorglub committed
497
    p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
498 499
                                  FIND_ANYWHERE );

gbazin's avatar
 
gbazin committed
500 501
    if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );

502
    /* Free structure */
503
    vlc_object_destroy( p_vout );
504 505 506 507

    /* If it was the last vout, tell the interface to show up */
    if( p_playlist != NULL )
    {
zorglub's avatar
zorglub committed
508
        vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
509 510 511 512 513 514 515 516 517 518 519 520 521
                                            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
522 523
}

524
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
525
 * InitThread: initialize video output thread
526
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
527 528 529
 * 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.
530
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
531
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
532
{
533
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
534

Sam Hocevar's avatar
 
Sam Hocevar committed
535 536 537 538
    vlc_mutex_lock( &p_vout->change_lock );

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

Sam Hocevar's avatar
 
Sam Hocevar committed
541
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
542
    if( p_vout->pf_init( p_vout ) )
Vincent Seguin's avatar
Vincent Seguin committed
543
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
544
        vlc_mutex_unlock( &p_vout->change_lock );
545
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
546 547
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
548
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
549
    {
550 551
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
552
        p_vout->pf_end( p_vout );
Sam Hocevar's avatar
 
Sam Hocevar committed
553
        vlc_mutex_unlock( &p_vout->change_lock );
554
        return VLC_EGENERIC;
555
    }
Vincent Seguin's avatar
Vincent Seguin committed
556

gbazin's avatar
 
gbazin committed
557 558 559 560 561 562 563 564 565
    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;
    }

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

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
    AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );

    msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
             p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
             p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
             p_vout->fmt_render.i_visible_width,
             p_vout->fmt_render.i_visible_height,
             (char*)&p_vout->fmt_render.i_chroma,
             i_aspect_x, i_aspect_y,
             p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );

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

    msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
             p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
             p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
             p_vout->fmt_in.i_visible_width,
             p_vout->fmt_in.i_visible_height,
             (char*)&p_vout->fmt_in.i_chroma,
             i_aspect_x, i_aspect_y,
             p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );

    if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
    {
        p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
            p_vout->output.i_width;
        p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
            p_vout->output.i_height;
        p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;

        p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
        p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
    }
    if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
    {
        p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
            p_vout->fmt_out.i_height;
        p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
            p_vout->fmt_out.i_width;
    }

    vlc_reduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
                p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );

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

616
    msg_Dbg( p_vout, "picture out %ix%i, chroma %4.4s, ar %i:%i, sar %i:%i",
617
             p_vout->output.i_width, p_vout->output.i_height,
618 619 620
             (char*)&p_vout->output.i_chroma,
             i_aspect_x, i_aspect_y,
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
Sam Hocevar's avatar
 
Sam Hocevar committed
621

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

801 802 803 804 805 806 807 808 809 810 811 812 813 814
            /* 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 );
815
                p_last_picture = NULL;
816 817
            }

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

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

                continue;
            }
847

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

                continue;
            }
872

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