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

29
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
30
 * Preamble
31
 *****************************************************************************/
32 33 34 35
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

36
#include <vlc_common.h>
37

38
#include <stdlib.h>                                                /* free() */
39
#include <string.h>
Vincent Seguin's avatar
Vincent Seguin committed
40

Sam Hocevar's avatar
 
Sam Hocevar committed
41

42 43
#ifdef HAVE_SYS_TIMES_H
#   include <sys/times.h>
44
#endif
45

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

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

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

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

60 61
#include <libvlc.h>
#include <vlc_input.h>
62
#include "vout_pictures.h"
Laurent Aimar's avatar
Laurent Aimar committed
63
#include "vout_internal.h"
64

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

74
static void     AspectRatio       ( int, int *, int * );
Michel Kaempf's avatar
Michel Kaempf committed
75

Laurent Aimar's avatar
Laurent Aimar committed
76
static void VideoFormatImportRgb( video_format_t *, const picture_heap_t * );
77 78
static void PictureHeapFixRgb( picture_heap_t * );

79 80
static void     vout_Destructor   ( vlc_object_t * p_this );

gbazin's avatar
 
gbazin committed
81
/* Object variables callbacks */
gbazin's avatar
 
gbazin committed
82 83
static int DeinterlaceCallback( vlc_object_t *, char const *,
                                vlc_value_t, vlc_value_t, void * );
84 85
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
86 87
static int VideoFilter2Callback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
gbazin's avatar
 
gbazin committed
88

89 90 91
/* From vout_intf.c */
int vout_Snapshot( vout_thread_t *, picture_t * );

92 93 94
/* Display media title in OSD */
static void DisplayTitleOnOSD( vout_thread_t *p_vout );

95 96 97
/* */
static void DropPicture( vout_thread_t *p_vout, picture_t *p_picture );

98 99 100 101 102
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
103
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
104
    picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
105

106
    p_picture->i_status = READY_PICTURE;
107 108 109 110 111 112

    return p_picture;
}

static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
{
113 114 115
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;

    DropPicture( p_vout, p_pic );
116 117 118 119 120 121 122 123
}

static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
{
    p_filter->pf_vout_buffer_new = video_new_buffer_filter;
    p_filter->pf_vout_buffer_del = video_del_buffer_filter;
    p_filter->p_owner = p_data; /* p_vout */
    return VLC_SUCCESS;
124 125
}

126
/*****************************************************************************
127 128 129 130 131
 * 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.
 *****************************************************************************/
132 133
vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                               video_format_t *p_fmt )
134
{
135
    const bool b_vout_provided = p_vout != NULL;
136
    if( !p_fmt )
137
    {
138 139 140
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
141
        if( p_vout )
142
            vout_CloseAndRelease( p_vout );
143 144 145 146 147 148
        return NULL;
    }

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

152
    /* TODO: find a suitable unused video output */
153 154 155 156

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

160 161
        vlc_mutex_lock( &p_vout->change_lock );

162
        /* We don't directly check for the "vout-filter" variable for obvious
gbazin's avatar
 
gbazin committed
163
         * performance reasons. */
164
        if( p_vout->p->b_filter_change )
gbazin's avatar
 
gbazin committed
165
        {
166
            var_Get( p_vout, "vout-filter", &val );
167
            psz_filter_chain = val.psz_string;
gbazin's avatar
 
gbazin committed
168

169
            if( psz_filter_chain && !*psz_filter_chain )
gbazin's avatar
 
gbazin committed
170 171 172 173
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
174
            if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
gbazin's avatar
 
gbazin committed
175
            {
176 177
                free( p_vout->p->psz_filter_chain );
                p_vout->p->psz_filter_chain = NULL;
gbazin's avatar
 
gbazin committed
178 179
            }

180
            if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
gbazin's avatar
 
gbazin committed
181
            {
182
                p_vout->p->b_filter_change = false;
gbazin's avatar
 
gbazin committed
183 184
            }

185
            free( psz_filter_chain );
gbazin's avatar
 
gbazin committed
186 187
        }

188 189 190
        if( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ||
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
191
            p_vout->p->b_filter_change )
192
        {
193 194
            vlc_mutex_unlock( &p_vout->change_lock );

195
            /* We are not interested in this format, close this vout */
196
            vout_CloseAndRelease( p_vout );
197
            vlc_object_release( p_vout );
198 199 200 201 202
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
            if( p_vout->fmt_render.i_aspect != p_fmt->i_aspect )
            {
                /* Correct aspect ratio on change
                 * FIXME factorize this code with other aspect ration related code */
                unsigned int i_sar_num;
                unsigned int i_sar_den;
                unsigned int i_aspect;

                i_aspect = p_fmt->i_aspect;
                vlc_ureduce( &i_sar_num, &i_sar_den,
                             p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
#if 0
                /* What's that, it does not seems to be used correcly everywhere
                 * beside the previous p_vout->fmt_render.i_aspect != p_fmt->i_aspect
                 * should be fixed to use it too then */
                if( p_vout->i_par_num > 0 && p_vout->i_par_den > 0 )
                {
                    i_sar_num *= p_vout->i_par_den;
                    i_sar_den *= p_vout->i_par_num;
                    i_aspect = i_aspect * p_vout->i_par_den / p_vout->i_par_num;
                }
#endif

                if( i_sar_num > 0 && i_sar_den > 0 && i_aspect > 0 )
                {
                    p_vout->fmt_in.i_sar_num = i_sar_num;
                    p_vout->fmt_in.i_sar_den = i_sar_den;
                    p_vout->fmt_in.i_aspect  = i_aspect;

                    p_vout->fmt_render.i_sar_num = i_sar_num;
                    p_vout->fmt_render.i_sar_den = i_sar_den;
                    p_vout->fmt_render.i_aspect  = i_aspect;

                    p_vout->render.i_aspect   = i_aspect;

                    p_vout->i_changes |= VOUT_ASPECT_CHANGE;

                }
            }
            vlc_mutex_unlock( &p_vout->change_lock );

            vlc_object_release( p_vout );
        }

        if( p_vout )
        {
            msg_Dbg( p_this, "reusing provided vout" );

251
            spu_Attach( p_vout->p_spu, p_this, true );
252 253

            vlc_object_detach( p_vout );
254
            vlc_object_attach( p_vout, p_this );
255 256 257

            /* Display title if we are not using the vout given to vout_Request.
             * XXX for now b_vout_provided is always true at this stage */
258
            if( p_vout->p->b_title_show && !b_vout_provided )
259
                DisplayTitleOnOSD( p_vout );
260 261 262 263 264 265 266
        }
    }

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

267
        p_vout = vout_Create( p_this, p_fmt );
268 269 270 271 272 273 274
    }

    return p_vout;
}

/*****************************************************************************
 * vout_Create: creates a new video output thread
275
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
276 277
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
278
 *****************************************************************************/
279
vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
280
{
gbazin's avatar
 
gbazin committed
281 282
    vout_thread_t  * p_vout;                            /* thread descriptor */
    int              i_index;                               /* loop variable */
283
    vlc_value_t      val, text;
Michel Kaempf's avatar
Michel Kaempf committed
284

285 286
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
287 288 289
    vlc_fourcc_t i_chroma = p_fmt->i_chroma;
    unsigned int i_aspect = p_fmt->i_aspect;

290 291 292 293
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

294 295 296 297 298 299 300 301
    if( i_width <= 0 || i_height <= 0 || i_aspect <= 0 )
        return NULL;

    vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
                 p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
    if( p_fmt->i_sar_num <= 0 || p_fmt->i_sar_den <= 0 )
        return NULL;

302
    /* Allocate descriptor */
303 304 305
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
306
    if( p_vout == NULL )
307
        return NULL;
308

309
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
310
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
311 312 313 314 315 316
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

317
    /* Initialize pictures - translation tables and functions
gbazin's avatar
 
gbazin committed
318
     * will be initialized later in InitThread */
319
    for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
gbazin's avatar
 
gbazin committed
320 321 322 323 324
    {
        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;
325
        p_vout->p_picture[i_index].b_slow   = 0;
gbazin's avatar
 
gbazin committed
326 327 328 329 330 331 332
    }

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

    /* Initialize the rendering heap */
    I_RENDERPICTURES = 0;
333

334 335
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
336

gbazin's avatar
 
gbazin committed
337 338 339 340 341
    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;

342 343 344
    p_vout->render.i_rmask    = p_fmt->i_rmask;
    p_vout->render.i_gmask    = p_fmt->i_gmask;
    p_vout->render.i_bmask    = p_fmt->i_bmask;
gbazin's avatar
 
gbazin committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

    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->b_scale      = 1;
    p_vout->b_fullscreen = 0;
gbazin's avatar
 
gbazin committed
364
    p_vout->i_alignment  = 0;
365 366
    p_vout->p->render_time  = 10;
    p_vout->p->c_fps_samples = 0;
367 368
    p_vout->p->i_picture_lost = 0;
    p_vout->p->i_picture_displayed = 0;
369
    p_vout->p->b_filter_change = 0;
Laurent Aimar's avatar
Laurent Aimar committed
370 371
    p_vout->p->b_paused = false;
    p_vout->p->i_pause_date = 0;
372 373
    p_vout->pf_control = NULL;
    p_vout->p_window = NULL;
374 375
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
376
    p_vout->p->p_picture_displayed = NULL;
gbazin's avatar
 
gbazin committed
377 378

    /* Initialize locks */
379
    vlc_mutex_init_recursive( &p_vout->picture_lock );
380
    vlc_mutex_init( &p_vout->change_lock );
381
    vlc_mutex_init( &p_vout->p->vfilter_lock );
gbazin's avatar
 
gbazin committed
382

383 384 385 386 387 388 389
    /* 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 );

390
    /* Initialize subpicture unit */
391
    p_vout->p_spu = spu_Create( p_vout );
392
    spu_Attach( p_vout->p_spu, p_parent, true );
393

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

397 398
    spu_Init( p_vout->p_spu );

399 400
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
gbazin's avatar
 
gbazin committed
401

gbazin's avatar
 
gbazin committed
402 403 404
    /* 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
405
    {
406
        /* Look for the default filter configuration */
407
        p_vout->p->psz_filter_chain =
408
            var_CreateGetStringCommand( p_vout, "vout-filter" );
409 410

        /* Apply video filter2 objects on the first vout */
411
        p_vout->p->psz_vf2 =
412
            var_CreateGetStringCommand( p_vout, "video-filter" );
gbazin's avatar
 
gbazin committed
413 414 415 416
    }
    else
    {
        /* continue the parent's filter chain */
417
        char *psz_tmp;
gbazin's avatar
 
gbazin committed
418

419
        /* Ugly hack to jump to our configuration chain */
420 421 422 423
        p_vout->p->psz_filter_chain
            = ((vout_thread_t *)p_parent)->p->psz_filter_chain;
        p_vout->p->psz_filter_chain
            = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->p->psz_filter_chain );
424 425
        config_ChainDestroy( p_cfg );
        free( psz_tmp );
426 427

        /* Create a video filter2 var ... but don't inherit values */
428 429
        var_Create( p_vout, "video-filter",
                    VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
430
        p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
gbazin's avatar
 
gbazin committed
431 432
    }

433
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
434
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
435
        false, video_filter_buffer_allocation_init, NULL, p_vout );
436

gbazin's avatar
 
gbazin committed
437
    /* Choose the video output module */
438
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
gbazin's avatar
 
gbazin committed
439
    {
gbazin's avatar
 
gbazin committed
440 441
        var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
        var_Get( p_vout, "vout", &val );
dionoea's avatar
dionoea committed
442
        psz_parser = val.psz_string;
gbazin's avatar
 
gbazin committed
443 444 445
    }
    else
    {
446 447
        psz_parser = strdup( p_vout->p->psz_filter_chain );
        p_vout->p->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
448 449
    }

gbazin's avatar
 
gbazin committed
450
    /* Create the vout thread */
451
    char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
dionoea's avatar
dionoea committed
452
    free( psz_parser );
453
    free( psz_tmp );
454
    p_vout->p_cfg = p_cfg;
455
    p_vout->p_module = module_need( p_vout,
456 457
        ( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain ) ?
        "video filter" : "video output", psz_name, p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain );
458
    free( psz_name );
Sam Hocevar's avatar
 
Sam Hocevar committed
459 460 461

    if( p_vout->p_module == NULL )
    {
462
        msg_Err( p_vout, "no suitable vout module" );
Laurent Aimar's avatar
Laurent Aimar committed
463
        vlc_object_set_destructor( p_vout, vout_Destructor );
464
        vlc_object_release( p_vout );
465
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
466
    }
gbazin's avatar
 
gbazin committed
467

gbazin's avatar
 
gbazin committed
468
    /* Create a few object variables for interface interaction */
gbazin's avatar
 
gbazin committed
469 470 471
    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 );
472
    val.psz_string = (char *)""; text.psz_string = _("Disable");
gbazin's avatar
 
gbazin committed
473
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
474
    val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
gbazin's avatar
 
gbazin committed
475
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
476
    val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
gbazin's avatar
 
gbazin committed
477
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
478
    val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
gbazin's avatar
 
gbazin committed
479
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
480
    val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
gbazin's avatar
 
gbazin committed
481
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
482
    val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
gbazin's avatar
 
gbazin committed
483
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
484
    val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
485 486
    var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );

gbazin's avatar
 
gbazin committed
487 488 489
    if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
    {
        var_Set( p_vout, "deinterlace", val );
490
        free( val.psz_string );
gbazin's avatar
 
gbazin committed
491
    }
gbazin's avatar
 
gbazin committed
492 493
    var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );

494
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
495
    text.psz_string = _("Filters");
496 497
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
498

499
    if( vlc_thread_create( p_vout, "video output", RunThread,
500
                           VLC_THREAD_PRIORITY_OUTPUT, true ) )
Michel Kaempf's avatar
Michel Kaempf committed
501
    {
502
        module_unneed( p_vout, p_vout->p_module );
Laurent Aimar's avatar
Laurent Aimar committed
503 504
        p_vout->p_module = NULL;
        vlc_object_set_destructor( p_vout, vout_Destructor );
505
        vlc_object_release( p_vout );
506 507 508
        return NULL;
    }

509 510
    vlc_object_set_destructor( p_vout, vout_Destructor );

511 512 513
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );
514
        vout_CloseAndRelease( p_vout );
515
        return NULL;
516
    }
Michel Kaempf's avatar
Michel Kaempf committed
517

518
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
519 520
}

521
/*****************************************************************************
522
 * vout_Close: Close a vout created by vout_Create.
523
 *****************************************************************************
524
 * You HAVE to call it on vout created by vout_Create before vlc_object_release.
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
525
 * You should NEVER call it on vout not obtained through vout_Create
526 527
 * (like with vout_Request or vlc_object_find.)
 * You can use vout_CloseAndRelease() as a convenient method.
528
 *****************************************************************************/
529
void vout_Close( vout_thread_t *p_vout )
530 531 532 533 534
{
    assert( p_vout );

    vlc_object_kill( p_vout );
    vlc_thread_join( p_vout );
535
    module_unneed( p_vout, p_vout->p_module );
536
    p_vout->p_module = NULL;
537 538 539
}

/* */
540 541
static void vout_Destructor( vlc_object_t * p_this )
{
542
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
543

544 545 546
    /* Make sure the vout was stopped first */
    assert( !p_vout->p_module );

Laurent Aimar's avatar
Laurent Aimar committed
547 548 549
    /* */
    spu_Destroy( p_vout->p_spu );

550 551 552
    /* Destroy the locks */
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
553
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
554

555
    free( p_vout->p->psz_filter_chain );
gbazin's avatar
 
gbazin committed
556

557 558
    config_ChainDestroy( p_vout->p_cfg );

559 560
    free( p_vout->p );

561
#ifndef __APPLE__
562
    vout_thread_t *p_another_vout;
563

564 565 566 567 568 569 570 571
    /* This is a dirty hack mostly for Linux, where there is no way to get the
     * GUI back if you closed it while playing video. This is solved in
     * Mac OS X, where we have this novelty called menubar, that will always
     * allow you access to the applications main functionality. They should try
     * that on linux sometime. */
    p_another_vout = vlc_object_find( p_this->p_libvlc,
                                      VLC_OBJECT_VOUT, FIND_ANYWHERE );
    if( p_another_vout == NULL )
572
        var_SetBool( p_this->p_libvlc, "intf-show", true );
573 574
    else
        vlc_object_release( p_another_vout );
575
#endif
Michel Kaempf's avatar
Michel Kaempf committed
576 577
}

Laurent Aimar's avatar
Laurent Aimar committed
578 579 580 581 582
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
    vlc_object_lock( p_vout );

583
    assert( !p_vout->p->b_paused || !b_paused );
Laurent Aimar's avatar
Laurent Aimar committed
584 585 586 587 588 589 590 591 592 593 594
    if( p_vout->p->b_paused )
    {
        const mtime_t i_duration = i_date - p_vout->p->i_pause_date;

        for( int i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
        {
            picture_t *p_pic = PP_RENDERPICTURE[i_index];

            if( p_pic->i_status == READY_PICTURE )
                p_pic->date += i_duration;
        }
Laurent Aimar's avatar
Laurent Aimar committed
595
        spu_OffsetSubtitleDate( p_vout->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
596 597 598 599 600 601
    }
    p_vout->p->b_paused = b_paused;
    p_vout->p->i_pause_date = i_date;

    vlc_object_unlock( p_vout );
}
602 603 604 605 606 607 608 609 610 611 612 613
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
    vlc_object_lock( p_vout );

    *pi_displayed = p_vout->p->i_picture_displayed;
    *pi_lost = p_vout->p->i_picture_lost;

    p_vout->p->i_picture_displayed = 0;
    p_vout->p->i_picture_lost = 0;

    vlc_object_unlock( p_vout );
}
Laurent Aimar's avatar
Laurent Aimar committed
614 615 616 617 618 619
void vout_Flush( vout_thread_t *p_vout, mtime_t i_date )
{
    vlc_mutex_lock( &p_vout->picture_lock );
    for( int i = 0; i < p_vout->render.i_pictures; i++ )
    {
        picture_t *p_pic = p_vout->render.pp_picture[i];
Laurent Aimar's avatar
Laurent Aimar committed
620

Laurent Aimar's avatar
Laurent Aimar committed
621 622 623 624 625 626 627 628 629 630 631
        if( p_pic->i_status == READY_PICTURE ||
            p_pic->i_status == DISPLAYED_PICTURE )
        {
            /* We cannot change picture status if it is in READY_PICTURE state,
             * Just make sure they won't be displayed */
            if( p_pic->date > i_date )
                p_pic->date = i_date;
        }
    }
    vlc_mutex_unlock( &p_vout->picture_lock );
}
632
void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
633 634 635 636 637
{
    int i_pic, i_ready_pic;

    vlc_mutex_lock( &p_vout->picture_lock );

638
    for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
    {
        const picture_t *p_pic = p_vout->render.pp_picture[i_pic];

        if( p_pic->i_status == READY_PICTURE )
        {
            i_ready_pic++;
            /* If we have at least 2 ready pictures, wait for the vout thread to
             * process one */
            if( i_ready_pic >= 2 )
                break;

            continue;
        }

        if( p_pic->i_status == DISPLAYED_PICTURE )
        {
            /* If at least one displayed picture is not referenced
             * let vout free it */
            if( p_pic->i_refcount == 0 )
                break;
        }
    }
661
    if( i_pic < p_vout->render.i_pictures && !b_forced )
662 663 664 665 666 667 668
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
        return;
    }

    /* Too many pictures are still referenced, there is probably a bug
     * with the decoder */
669 670
    if( !b_forced )
        msg_Err( p_vout, "pictures leaked, resetting the heap" );
671 672 673 674 675 676 677 678 679 680 681 682 683 684

    /* Just free all the pictures */
    for( i_pic = 0; i_pic < p_vout->render.i_pictures; i_pic++ )
    {
        picture_t *p_pic = p_vout->render.pp_picture[i_pic];

        if( p_pic->i_status == RESERVED_PICTURE )
            vout_DestroyPicture( p_vout, p_pic );
        if( p_pic->i_refcount > 0 )
            vout_UnlinkPicture( p_vout, p_pic );
    }
    vlc_mutex_unlock( &p_vout->picture_lock );
}

685
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
686
 * InitThread: initialize video output thread
687
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
688 689 690
 * 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.
691
 * XXX You have to enter it with change_lock taken.
692
 *****************************************************************************/
693 694
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
695

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
static bool ChromaIsEqual( const picture_heap_t *p_output, const picture_heap_t *p_render )
{
     if( !vout_ChromaCmp( p_output->i_chroma, p_render->i_chroma ) )
         return false;

     if( p_output->i_chroma != FOURCC_RV15 &&
         p_output->i_chroma != FOURCC_RV16 &&
         p_output->i_chroma != FOURCC_RV24 &&
         p_output->i_chroma != FOURCC_RV32 )
         return true;

     return p_output->i_rmask == p_render->i_rmask &&
            p_output->i_gmask == p_render->i_gmask &&
            p_output->i_bmask == p_render->i_bmask;
}

Sam Hocevar's avatar
 
Sam Hocevar committed
712
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
713
{
714
    int i, i_aspect_x, i_aspect_y;
Sam Hocevar's avatar
 
Sam Hocevar committed
715

Sam Hocevar's avatar
 
Sam Hocevar committed
716
    /* Initialize output method, it allocates direct buffers for us */
Sam Hocevar's avatar
 
Sam Hocevar committed
717
    if( p_vout->pf_init( p_vout ) )
718
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
719

720 721
    p_vout->p->p_picture_displayed = NULL;

Sam Hocevar's avatar
 
Sam Hocevar committed
722
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
723
    {
724 725
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
Sam Hocevar's avatar
 
Sam Hocevar committed
726
        p_vout->pf_end( p_vout );
727
        return VLC_EGENERIC;
728
    }
Vincent Seguin's avatar
Vincent Seguin committed
729

gbazin's avatar
 
gbazin committed
730 731 732 733 734 735 736 737
    if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
    {
        msg_Err( p_vout, "plugin allocated too many direct buffers, "
                         "our internal buffers must have overflown." );
        p_vout->pf_end( p_vout );
        return VLC_EGENERIC;
    }

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

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
    AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );

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

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

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

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

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
783 784
    vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
                 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
785 786

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

788 789
    msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
             "chroma %4.4s, ar %i:%i, sar %i:%i",
790
             p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
791 792 793 794 795
             p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
             p_vout->fmt_out.i_visible_width,
             p_vout->fmt_out.i_visible_height,
             (char*)&p_vout->fmt_out.i_chroma,
             i_aspect_x, i_aspect_y,
796
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
Sam Hocevar's avatar
 
Sam Hocevar committed
797

798
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
799
    /* Calculate shifts from system-updated masks */
800 801 802 803 804
    PictureHeapFixRgb( &p_vout->render );
    VideoFormatImportRgb( &p_vout->fmt_render, &p_vout->render );

    PictureHeapFixRgb( &p_vout->output );
    VideoFormatImportRgb( &p_vout->fmt_out, &p_vout->output );
Sam Hocevar's avatar
 
Sam Hocevar committed
805

Sam Hocevar's avatar
 
Sam Hocevar committed
806
    /* Check whether we managed to create direct buffers similar to
807
     * the render buffers, ie same size and chroma */
Sam Hocevar's avatar
 
Sam Hocevar committed
808 809
    if( ( p_vout->output.i_width == p_vout->render.i_width )
     && ( p_vout->output.i_height == p_vout->render.i_height )
810
     && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
811
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
812 813 814 815
        /* 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 */
816
        p_vout->p->b_direct = true;
Sam Hocevar's avatar
 
Sam Hocevar committed
817

Sam Hocevar's avatar
 
Sam Hocevar committed
818 819
        for( i = 1; i < VOUT_MAX_PICTURES; i++ )
        {
gbazin's avatar
 
gbazin committed
820 821 822 823 824 825 826 827
            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
828 829 830
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
        }
gbazin's avatar
 
gbazin committed
831 832 833 834

        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
835 836 837
    }
    else
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
838 839 840
        /* 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 */
841
        p_vout->p->b_direct = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
842

843
        if( ChromaCreate( p_vout ) )
Sam Hocevar's avatar
 
Sam Hocevar committed
844 845
        {
            p_vout->pf_end( p_vout );
846
            return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
847
        }
Sam Hocevar's avatar
 
Sam Hocevar committed
848

gbazin's avatar
 
gbazin committed
849 850 851 852
        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
853 854

        /* Append render buffers after the direct buffers */
Sam Hocevar's avatar
 
Sam Hocevar committed
855
        for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
856 857 858
        {
            PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
            I_RENDERPICTURES++;
gbazin's avatar
 
gbazin committed
859 860 861 862

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

Sam Hocevar's avatar
 
Sam Hocevar committed
866 867 868 869 870 871 872 873 874 875 876
    /* 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;
    }