video_output.c 63.7 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
Gildas Bazin's avatar
Gildas Bazin 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
Antoine Cellerier's avatar
Antoine Cellerier 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

Clément Stenac's avatar
Clément Stenac committed
41
#include <vlc_vout.h>
42

Clément Stenac's avatar
Clément Stenac committed
43 44
#include <vlc_filter.h>
#include <vlc_osd.h>
Laurent Aimar's avatar
Laurent Aimar committed
45
#include <assert.h>
46

47
#if defined( __APPLE__ )
Clément Stenac's avatar
Clément Stenac committed
48
/* Include darwin_specific.h here if needed */
49 50
#endif

Clément Stenac's avatar
Clément Stenac committed
51 52
/** FIXME This is quite ugly but needed while we don't have counters
 * helpers */
53
//#include "input/input_internal.h"
Clément Stenac's avatar
Clément Stenac committed
54

55 56
#include <libvlc.h>
#include <vlc_input.h>
57
#include "vout_pictures.h"
Laurent Aimar's avatar
Laurent Aimar committed
58
#include "vout_internal.h"
59

60
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
61
 * Local prototypes
62
 *****************************************************************************/
63
static int      InitThread        ( vout_thread_t * );
64
static void*    RunThread         ( void *  );
65
static void     ErrorThread       ( vout_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
66
static void     CleanThread       ( vout_thread_t * );
67
static void     EndThread         ( vout_thread_t * );
Sam Hocevar's avatar
 
Sam Hocevar committed
68

Laurent Aimar's avatar
Laurent Aimar committed
69
static void VideoFormatImportRgb( video_format_t *, const picture_heap_t * );
70 71
static void PictureHeapFixRgb( picture_heap_t * );

72 73
static void     vout_Destructor   ( vlc_object_t * p_this );

Gildas Bazin's avatar
 
Gildas Bazin committed
74
/* Object variables callbacks */
75 76
static int FilterCallback( vlc_object_t *, char const *,
                           vlc_value_t, vlc_value_t, void * );
77 78
static int VideoFilter2Callback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
Laurent Aimar's avatar
Laurent Aimar committed
79 80

/* */
81 82 83 84 85
static void PostProcessEnable( vout_thread_t * );
static void PostProcessDisable( vout_thread_t * );
static void PostProcessSetFilterQuality( vout_thread_t *p_vout );
static int  PostProcessCallback( vlc_object_t *, char const *,
                                 vlc_value_t, vlc_value_t, void * );
Laurent Aimar's avatar
Laurent Aimar committed
86 87
/* */
static void DeinterlaceEnable( vout_thread_t * );
88
static void DeinterlaceNeeded( vout_thread_t *, bool );
Gildas Bazin's avatar
 
Gildas Bazin committed
89

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

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

96 97
/* Time during which the thread will sleep if it has nothing to
 * display (in micro-seconds) */
98
#define VOUT_IDLE_SLEEP                 ((int)(0.020*CLOCK_FREQ))
99 100 101 102 103 104 105 106 107 108 109

/* Maximum lap of time allowed between the beginning of rendering and
 * display. If, compared to the current date, the next image is too
 * late, the thread will perform an idle loop. This time should be
 * at least VOUT_IDLE_SLEEP plus the time required to render a few
 * images, to avoid trashing of decoded images */
#define VOUT_DISPLAY_DELAY              ((int)(0.200*CLOCK_FREQ))

/* Better be in advance when awakening than late... */
#define VOUT_MWAIT_TOLERANCE            ((mtime_t)(0.020*CLOCK_FREQ))

110 111 112 113 114 115 116 117
/* Minimum number of direct pictures the video output will accept without
 * creating additional pictures in system memory */
#ifdef OPTIMIZE_MEMORY
#   define VOUT_MIN_DIRECT_PICTURES        (VOUT_MAX_PICTURES/2)
#else
#   define VOUT_MIN_DIRECT_PICTURES        (3*VOUT_MAX_PICTURES/4)
#endif

118 119 120 121 122
/*****************************************************************************
 * Video Filter2 functions
 *****************************************************************************/
static picture_t *video_new_buffer_filter( filter_t *p_filter )
{
123
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
124
    picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
125

126
    p_picture->i_status = READY_PICTURE;
127 128 129 130 131 132

    return p_picture;
}

static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
{
133 134
    vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;

135 136 137
    vlc_mutex_lock( &p_vout->picture_lock );
    vout_UsePictureLocked( p_vout, p_pic );
    vlc_mutex_unlock( &p_vout->picture_lock );
138 139 140 141
}

static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
{
142 143
    p_filter->pf_video_buffer_new = video_new_buffer_filter;
    p_filter->pf_video_buffer_del = video_del_buffer_filter;
144 145
    p_filter->p_owner = p_data; /* p_vout */
    return VLC_SUCCESS;
146 147
}

148
#undef vout_Request
149
/*****************************************************************************
150 151 152 153 154
 * 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.
 *****************************************************************************/
155 156
vout_thread_t *vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
                             video_format_t *p_fmt )
157
{
158
    if( !p_fmt )
159
    {
160 161 162
        /* Video output is no longer used.
         * TODO: support for reusing video outputs with proper _thread-safe_
         * reference handling. */
163
        if( p_vout )
164
            vout_CloseAndRelease( p_vout );
165 166 167 168 169 170
        return NULL;
    }

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

174
    /* TODO: find a suitable unused video output */
175 176 177 178

    /* If we now have a video output, check it has the right properties */
    if( p_vout )
    {
179 180
        vlc_mutex_lock( &p_vout->change_lock );

181
        /* We don't directly check for the "vout-filter" variable for obvious
Gildas Bazin's avatar
 
Gildas Bazin committed
182
         * performance reasons. */
183
        if( p_vout->p->b_filter_change )
Gildas Bazin's avatar
 
Gildas Bazin committed
184
        {
185
            char *psz_filter_chain = var_GetString( p_vout, "vout-filter" );
Gildas Bazin's avatar
 
Gildas Bazin committed
186

187
            if( psz_filter_chain && !*psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
188 189 190 191
            {
                free( psz_filter_chain );
                psz_filter_chain = NULL;
            }
192
            if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
193
            {
194 195
                free( p_vout->p->psz_filter_chain );
                p_vout->p->psz_filter_chain = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
196 197
            }

198
            if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
199
            {
200
                p_vout->p->b_filter_change = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
201 202
            }

203
            free( psz_filter_chain );
Gildas Bazin's avatar
 
Gildas Bazin committed
204 205
        }

206
        if( p_vout->fmt_render.i_chroma != vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma ) ||
207 208
            p_vout->fmt_render.i_width != p_fmt->i_width ||
            p_vout->fmt_render.i_height != p_fmt->i_height ||
209
            p_vout->p->b_filter_change )
210
        {
211 212
            vlc_mutex_unlock( &p_vout->change_lock );

213
            /* We are not interested in this format, close this vout */
214
            vout_CloseAndRelease( p_vout );
215
            vlc_object_release( p_vout );
216 217 218 219 220
            p_vout = NULL;
        }
        else
        {
            /* This video output is cool! Hijack it. */
Laurent Aimar's avatar
Laurent Aimar committed
221 222 223 224 225 226
            /* 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;
            vlc_ureduce( &i_sar_num, &i_sar_den,
                         p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
227
#if 0
Laurent Aimar's avatar
Laurent Aimar committed
228 229 230 231 232 233
            /* What's that, it does not seems to be used correcly everywhere */
            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;
            }
234 235
#endif

Laurent Aimar's avatar
Laurent Aimar committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
            if( i_sar_num > 0 && i_sar_den > 0 &&
                ( i_sar_num != p_vout->fmt_render.i_sar_num ||
                  i_sar_den != p_vout->fmt_render.i_sar_den ) )
            {
                p_vout->fmt_in.i_sar_num = i_sar_num;
                p_vout->fmt_in.i_sar_den = i_sar_den;

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

                p_vout->render.i_aspect = (int64_t)i_sar_num *
                                                   p_vout->fmt_render.i_width *
                                                   VOUT_ASPECT_FACTOR /
                                                   i_sar_den /
                                                   p_vout->fmt_render.i_height;
                p_vout->i_changes |= VOUT_ASPECT_CHANGE;
252 253 254 255 256 257 258 259 260 261
            }
            vlc_mutex_unlock( &p_vout->change_lock );

            vlc_object_release( p_vout );
        }

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

262
            spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
263
            vlc_object_detach( p_vout );
264

265
            vlc_object_attach( p_vout, p_this );
266
            spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );
267 268 269 270 271 272 273
        }
    }

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

274
        p_vout = vout_Create( p_this, p_fmt );
275 276 277 278 279
    }

    return p_vout;
}

280
#undef vout_Create
281 282
/*****************************************************************************
 * vout_Create: creates a new video output thread
283
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
284 285
 * This function creates a new video output thread, and returns a pointer
 * to its description. On error, it returns NULL.
286
 *****************************************************************************/
287
vout_thread_t * vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
Michel Kaempf's avatar
Michel Kaempf committed
288
{
Gildas Bazin's avatar
 
Gildas Bazin committed
289 290
    vout_thread_t  * p_vout;                            /* thread descriptor */
    int              i_index;                               /* loop variable */
291
    vlc_value_t      text;
Michel Kaempf's avatar
Michel Kaempf committed
292

293 294
    unsigned int i_width = p_fmt->i_width;
    unsigned int i_height = p_fmt->i_height;
295
    vlc_fourcc_t i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, p_fmt->i_chroma );
296

297 298 299 300
    config_chain_t *p_cfg;
    char *psz_parser;
    char *psz_name;

Laurent Aimar's avatar
Laurent Aimar committed
301
    if( i_width <= 0 || i_height <= 0 )
302 303 304 305 306 307
        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;
Laurent Aimar's avatar
Laurent Aimar committed
308 309 310 311 312
    unsigned int i_aspect = (int64_t)p_fmt->i_sar_num *
                                     i_width *
                                     VOUT_ASPECT_FACTOR /
                                     p_fmt->i_sar_den /
                                     i_height;
313

314
    /* Allocate descriptor */
315 316 317
    static const char typename[] = "video output";
    p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
                                typename );
318
    if( p_vout == NULL )
319
        return NULL;
320

321
    /* */
Laurent Aimar's avatar
Laurent Aimar committed
322
    p_vout->p = calloc( 1, sizeof(*p_vout->p) );
323 324 325 326 327 328
    if( !p_vout->p )
    {
        vlc_object_release( p_vout );
        return NULL;
    }

329
    /* Initialize pictures - translation tables and functions
Gildas Bazin's avatar
 
Gildas Bazin committed
330
     * will be initialized later in InitThread */
331
    for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
Gildas Bazin's avatar
 
Gildas Bazin committed
332 333 334
    {
        p_vout->p_picture[i_index].i_status = FREE_PICTURE;
        p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
335
        p_vout->p_picture[i_index].b_slow   = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
336 337 338 339 340 341 342
    }

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

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

344 345
    p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
    p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
346

Gildas Bazin's avatar
 
Gildas Bazin committed
347 348 349 350 351
    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;

352 353 354
    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;
Gildas Bazin's avatar
 
Gildas Bazin committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371

    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;
372 373
    p_vout->b_autoscale  = 1;
    p_vout->i_zoom      = ZOOM_FP_FACTOR;
Gildas Bazin's avatar
 
Gildas Bazin committed
374
    p_vout->b_fullscreen = 0;
Gildas Bazin's avatar
 
Gildas Bazin committed
375
    p_vout->i_alignment  = 0;
376 377
    p_vout->p->render_time  = 10;
    p_vout->p->c_fps_samples = 0;
378
    vout_statistic_Init( &p_vout->p->statistic );
379
    p_vout->p->b_filter_change = 0;
Laurent Aimar's avatar
Laurent Aimar committed
380 381
    p_vout->p->b_paused = false;
    p_vout->p->i_pause_date = 0;
382 383
    p_vout->p->i_par_num =
    p_vout->p->i_par_den = 1;
384
    p_vout->p->p_picture_displayed = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
385 386 387
    p_vout->p->i_picture_displayed_date = 0;
    p_vout->p->b_picture_displayed = false;
    p_vout->p->b_picture_empty = false;
388
    p_vout->p->i_picture_qtype = QTYPE_NONE;
389
    p_vout->p->b_picture_interlaced = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
390

391 392
    vlc_mouse_Init( &p_vout->p->mouse );

393
    vout_snapshot_Init( &p_vout->p->snapshot );
394

Gildas Bazin's avatar
 
Gildas Bazin committed
395
    /* Initialize locks */
396 397
    vlc_mutex_init( &p_vout->picture_lock );
    vlc_cond_init( &p_vout->p->picture_wait );
398
    vlc_mutex_init( &p_vout->change_lock );
399
    vlc_mutex_init( &p_vout->p->vfilter_lock );
Gildas Bazin's avatar
 
Gildas Bazin committed
400

401 402
    /* Mouse coordinates */
    var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
403 404
    var_Create( p_vout, "mouse-moved", VLC_VAR_COORDS );
    var_Create( p_vout, "mouse-clicked", VLC_VAR_COORDS );
405 406
    /* Mouse object (area of interest in a video filter) */
    var_Create( p_vout, "mouse-object", VLC_VAR_BOOL );
407

Gildas Bazin's avatar
 
Gildas Bazin committed
408 409 410
    /* Attach the new object now so we can use var inheritance below */
    vlc_object_attach( p_vout, p_parent );

411 412 413
    /* Initialize subpicture unit */
    p_vout->p_spu = spu_Create( p_vout );

414
    /* */
415 416
    spu_Init( p_vout->p_spu );

417 418
    spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), true );

419 420
    /* Take care of some "interface/control" related initialisations */
    vout_IntfInit( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
421

Gildas Bazin's avatar
 
Gildas Bazin committed
422 423
    /* If the parent is not a VOUT object, that means we are at the start of
     * the video output pipe */
424
    if( vlc_internals( p_parent )->i_object_type != VLC_OBJECT_VOUT )
Sam Hocevar's avatar
 
Sam Hocevar committed
425
    {
426
        /* Look for the default filter configuration */
427
        p_vout->p->psz_filter_chain =
428
            var_CreateGetStringCommand( p_vout, "vout-filter" );
429 430

        /* Apply video filter2 objects on the first vout */
431
        p_vout->p->psz_vf2 =
432
            var_CreateGetStringCommand( p_vout, "video-filter" );
433 434

        p_vout->p->b_first_vout = true;
Gildas Bazin's avatar
 
Gildas Bazin committed
435 436 437 438
    }
    else
    {
        /* continue the parent's filter chain */
439
        char *psz_tmp;
Gildas Bazin's avatar
 
Gildas Bazin committed
440

441
        /* Ugly hack to jump to our configuration chain */
442 443 444 445
        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 );
446 447
        config_ChainDestroy( p_cfg );
        free( psz_tmp );
448 449

        /* Create a video filter2 var ... but don't inherit values */
450 451
        var_Create( p_vout, "video-filter",
                    VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
452
        p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
453 454 455

        /* */
        p_vout->p->b_first_vout = false;
Gildas Bazin's avatar
 
Gildas Bazin committed
456 457
    }

458
    var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
459
    p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
460
        false, video_filter_buffer_allocation_init, NULL, p_vout );
461

Gildas Bazin's avatar
 
Gildas Bazin committed
462
    /* Choose the video output module */
463
    if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
Gildas Bazin's avatar
 
Gildas Bazin committed
464
    {
465
        psz_parser = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
466 467 468
    }
    else
    {
469 470
        psz_parser = strdup( p_vout->p->psz_filter_chain );
        p_vout->p->b_title_show = false;
Sam Hocevar's avatar
 
Sam Hocevar committed
471 472
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
473
    /* Create the vout thread */
474
    char *psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
Antoine Cellerier's avatar
Antoine Cellerier committed
475
    free( psz_parser );
476
    free( psz_tmp );
477
    p_vout->p_cfg = p_cfg;
Laurent Aimar's avatar
Laurent Aimar committed
478 479 480 481 482 483 484 485 486 487

    /* Create a few object variables for interface interaction */
    var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    text.psz_string = _("Filters");
    var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
    var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );

    /* */
    DeinterlaceEnable( p_vout );

488
    if( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain )
489 490 491 492 493 494 495
    {
        char *psz_tmp;
        if( asprintf( &psz_tmp, "%s,none", psz_name ) < 0 )
            psz_tmp = strdup( "" );
        free( psz_name );
        psz_name = psz_tmp;
    }
496
    p_vout->p->psz_module_name = psz_name;
Laurent Aimar's avatar
Laurent Aimar committed
497 498

    /* */
499
    vlc_object_set_destructor( p_vout, vout_Destructor );
Gildas Bazin's avatar
 
Gildas Bazin committed
500

Laurent Aimar's avatar
Laurent Aimar committed
501
    /* */
502 503 504
    vlc_cond_init( &p_vout->p->change_wait );
    if( vlc_clone( &p_vout->p->thread, RunThread, p_vout,
                   VLC_THREAD_PRIORITY_OUTPUT ) )
Michel Kaempf's avatar
Michel Kaempf committed
505
    {
506
        spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
507 508
        spu_Destroy( p_vout->p_spu );
        p_vout->p_spu = NULL;
509
        vlc_object_release( p_vout );
510 511 512
        return NULL;
    }

513 514 515 516 517 518 519 520 521
    vlc_mutex_lock( &p_vout->change_lock );
    while( !p_vout->p->b_ready )
    {   /* We are (ab)using the same condition in opposite directions for
         * b_ready and b_done. This works because of the strict ordering. */
        assert( !p_vout->p->b_done );
        vlc_cond_wait( &p_vout->p->change_wait, &p_vout->change_lock );
    }
    vlc_mutex_unlock( &p_vout->change_lock );

522 523 524
    if( p_vout->b_error )
    {
        msg_Err( p_vout, "video output creation failed" );
525
        vout_CloseAndRelease( p_vout );
526
        return NULL;
527
    }
Michel Kaempf's avatar
Michel Kaempf committed
528

529
    return p_vout;
Michel Kaempf's avatar
Michel Kaempf committed
530 531
}

532
/*****************************************************************************
533
 * vout_Close: Close a vout created by vout_Create.
534
 *****************************************************************************
535
 * 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
536
 * You should NEVER call it on vout not obtained through vout_Create
537
 * (like with vout_Request or vlc_object_find.)
538
 * You can use vout_CloseAndRelease() as a convenience method.
539
 *****************************************************************************/
540
void vout_Close( vout_thread_t *p_vout )
541 542 543
{
    assert( p_vout );

544 545 546 547
    vlc_mutex_lock( &p_vout->change_lock );
    p_vout->p->b_done = true;
    vlc_cond_signal( &p_vout->p->change_wait );
    vlc_mutex_unlock( &p_vout->change_lock );
548

549
    vout_snapshot_End( &p_vout->p->snapshot );
550

551
    vlc_join( p_vout->p->thread, NULL );
552 553 554
}

/* */
555 556
static void vout_Destructor( vlc_object_t * p_this )
{
557
    vout_thread_t *p_vout = (vout_thread_t *)p_this;
558

559
    /* Make sure the vout was stopped first */
560
    //assert( !p_vout->p_module );
561

562 563
    free( p_vout->p->psz_module_name );

Laurent Aimar's avatar
Laurent Aimar committed
564
    /* */
565 566
    if( p_vout->p_spu )
        spu_Destroy( p_vout->p_spu );
Laurent Aimar's avatar
Laurent Aimar committed
567

568
    /* Destroy the locks */
569
    vlc_cond_destroy( &p_vout->p->change_wait );
570
    vlc_cond_destroy( &p_vout->p->picture_wait );
571 572
    vlc_mutex_destroy( &p_vout->picture_lock );
    vlc_mutex_destroy( &p_vout->change_lock );
573
    vlc_mutex_destroy( &p_vout->p->vfilter_lock );
574

575 576 577
    /* */
    vout_statistic_Clean( &p_vout->p->statistic );

578
    /* */
579
    vout_snapshot_Clean( &p_vout->p->snapshot );
580 581

    /* */
582
    free( p_vout->p->psz_filter_chain );
583
    free( p_vout->p->psz_title );
Gildas Bazin's avatar
 
Gildas Bazin committed
584

585 586
    config_ChainDestroy( p_vout->p_cfg );

587 588
    free( p_vout->p );

Michel Kaempf's avatar
Michel Kaempf committed
589 590
}

Laurent Aimar's avatar
Laurent Aimar committed
591 592 593
/* */
void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
{
594
    vlc_mutex_lock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
595

596
    assert( !p_vout->p->b_paused || !b_paused );
Laurent Aimar's avatar
Laurent Aimar committed
597 598 599 600 601

    vlc_mutex_lock( &p_vout->picture_lock );

    p_vout->p->i_picture_displayed_date = 0;

Laurent Aimar's avatar
Laurent Aimar committed
602 603 604 605 606 607 608 609 610 611 612
    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;
        }
613 614 615
        vlc_cond_signal( &p_vout->p->picture_wait );
        vlc_mutex_unlock( &p_vout->picture_lock );

Laurent Aimar's avatar
Laurent Aimar committed
616
        spu_OffsetSubtitleDate( p_vout->p_spu, i_duration );
Laurent Aimar's avatar
Laurent Aimar committed
617
    }
Laurent Aimar's avatar
Laurent Aimar committed
618 619 620 621
    else
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
    }
Laurent Aimar's avatar
Laurent Aimar committed
622 623 624
    p_vout->p->b_paused = b_paused;
    p_vout->p->i_pause_date = i_date;

625
    vlc_mutex_unlock( &p_vout->change_lock );
Laurent Aimar's avatar
Laurent Aimar committed
626
}
627

628 629
void vout_GetResetStatistic( vout_thread_t *p_vout, int *pi_displayed, int *pi_lost )
{
630 631
    vout_statistic_GetReset( &p_vout->p->statistic,
                             pi_displayed, pi_lost );
632
}
633

Laurent Aimar's avatar
Laurent Aimar committed
634 635 636
void vout_Flush( vout_thread_t *p_vout, mtime_t i_date )
{
    vlc_mutex_lock( &p_vout->picture_lock );
Laurent Aimar's avatar
Laurent Aimar committed
637
    p_vout->p->i_picture_displayed_date = 0;
Laurent Aimar's avatar
Laurent Aimar committed
638 639 640
    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
641

Laurent Aimar's avatar
Laurent Aimar committed
642 643 644 645 646 647 648 649 650
        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;
        }
    }
651
    vlc_cond_signal( &p_vout->p->picture_wait );
Laurent Aimar's avatar
Laurent Aimar committed
652 653
    vlc_mutex_unlock( &p_vout->picture_lock );
}
654

655
void vout_FixLeaks( vout_thread_t *p_vout, bool b_forced )
656 657 658 659 660
{
    int i_pic, i_ready_pic;

    vlc_mutex_lock( &p_vout->picture_lock );

661
    for( i_pic = 0, i_ready_pic = 0; i_pic < p_vout->render.i_pictures && !b_forced; i_pic++ )
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
    {
        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;
        }
    }
684
    if( i_pic < p_vout->render.i_pictures && !b_forced )
685 686 687 688 689 690 691
    {
        vlc_mutex_unlock( &p_vout->picture_lock );
        return;
    }

    /* Too many pictures are still referenced, there is probably a bug
     * with the decoder */
692 693
    if( !b_forced )
        msg_Err( p_vout, "pictures leaked, resetting the heap" );
694 695 696 697 698

    /* 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];
Laurent Aimar's avatar
Laurent Aimar committed
699 700

        msg_Dbg( p_vout, "[%d] %d %d", i_pic, p_pic->i_status, p_pic->i_refcount );
701
        p_pic->i_refcount = 0;
Laurent Aimar's avatar
Laurent Aimar committed
702 703 704 705 706 707 708 709 710 711

        switch( p_pic->i_status )
        {
        case READY_PICTURE:
        case DISPLAYED_PICTURE:
        case RESERVED_PICTURE:
            if( p_pic != p_vout->p->p_picture_displayed )
                vout_UsePictureLocked( p_vout, p_pic );
            break;
        }
712
    }
713
    vlc_cond_signal( &p_vout->p->picture_wait );
714 715
    vlc_mutex_unlock( &p_vout->picture_lock );
}
Laurent Aimar's avatar
Laurent Aimar committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
void vout_NextPicture( vout_thread_t *p_vout, mtime_t *pi_duration )
{
    vlc_mutex_lock( &p_vout->picture_lock );

    const mtime_t i_displayed_date = p_vout->p->i_picture_displayed_date;

    p_vout->p->b_picture_displayed = false;
    p_vout->p->b_picture_empty = false;
    if( p_vout->p->p_picture_displayed )
    {
        p_vout->p->p_picture_displayed->date = 1;
        vlc_cond_signal( &p_vout->p->picture_wait );
    }

    while( !p_vout->p->b_picture_displayed && !p_vout->p->b_picture_empty )
        vlc_cond_wait( &p_vout->p->picture_wait, &p_vout->picture_lock );

    *pi_duration = __MAX( p_vout->p->i_picture_displayed_date - i_displayed_date, 0 );

    /* TODO advance subpicture by the duration ... */

    vlc_mutex_unlock( &p_vout->picture_lock );
}
739

740 741 742 743
void vout_DisplayTitle( vout_thread_t *p_vout, const char *psz_title )
{
    assert( psz_title );

744
    if( !var_InheritBool( p_vout, "osd" ) )
745 746
        return;

747
    vlc_mutex_lock( &p_vout->change_lock );
748 749
    free( p_vout->p->psz_title );
    p_vout->p->psz_title = strdup( psz_title );
750
    vlc_mutex_unlock( &p_vout->change_lock );
751
}
752

753 754 755 756 757
spu_t *vout_GetSpu( vout_thread_t *p_vout )
{
    return p_vout->p_spu;
}

758
/*****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
759
 * InitThread: initialize video output thread
760
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
761 762 763
 * 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.
764
 * XXX You have to enter it with change_lock taken.
765
 *****************************************************************************/
766 767
static int ChromaCreate( vout_thread_t *p_vout );
static void ChromaDestroy( vout_thread_t *p_vout );
768

Sam Hocevar's avatar
 
Sam Hocevar committed
769
static int InitThread( vout_thread_t *p_vout )
Vincent Seguin's avatar
Vincent Seguin committed
770
{
Laurent Aimar's avatar
Laurent Aimar committed
771
    int i;
Sam Hocevar's avatar
 
Sam Hocevar committed
772

Sam Hocevar's avatar
 
Sam Hocevar committed
773
    /* Initialize output method, it allocates direct buffers for us */
774
    if( vout_InitWrapper( p_vout ) )
775
        return VLC_EGENERIC;
Sam Hocevar's avatar
 
Sam Hocevar committed
776

777 778
    p_vout->p->p_picture_displayed = NULL;

Sam Hocevar's avatar
 
Sam Hocevar committed
779
    if( !I_OUTPUTPICTURES )
Sam Hocevar's avatar
 
Sam Hocevar committed
780
    {
781 782
        msg_Err( p_vout, "plugin was unable to allocate at least "
                         "one direct buffer" );
783
        vout_EndWrapper( p_vout );
784
        return VLC_EGENERIC;
785
    }
Vincent Seguin's avatar
Vincent Seguin committed
786

Gildas Bazin's avatar
 
Gildas Bazin committed
787 788 789 790
    if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
    {
        msg_Err( p_vout, "plugin allocated too many direct buffers, "
                         "our internal buffers must have overflown." );
791
        vout_EndWrapper( p_vout );
Gildas Bazin's avatar
 
Gildas Bazin committed
792 793 794
        return VLC_EGENERIC;
    }

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

797 798 799 800 801 802 803 804 805 806 807 808
    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_chroma = p_vout->output.i_chroma;
    }
    if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
    {
Laurent Aimar's avatar
Laurent Aimar committed
809
        p_vout->fmt_out.i_sar_num = p_vout->output.i_aspect *
810 811 812 813 814
            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
815 816
    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 );
817

818
    /* FIXME removed the need of both fmt_* and heap infos */
Sam Hocevar's avatar
 
Sam Hocevar committed
819
    /* Calculate shifts from system-updated masks */
820 821 822 823 824
    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
825

basos g's avatar
basos g committed
826 827
    /* print some usefull debug info about different vout formats
     */
Laurent Aimar's avatar
Laurent Aimar committed
828
    msg_Dbg( p_vout, "pic render sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
basos g's avatar
basos g committed
829 830 831 832 833 834 835 836
             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,
             p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den,
             p_vout->fmt_render.i_rmask, p_vout->fmt_render.i_gmask, p_vout->fmt_render.i_bmask );

Laurent Aimar's avatar
Laurent Aimar committed
837
    msg_Dbg( p_vout, "pic in sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
basos g's avatar
basos g committed
838 839 840 841 842 843 844 845
             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,
             p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den,
             p_vout->fmt_in.i_rmask, p_vout->fmt_in.i_gmask, p_vout->fmt_in.i_bmask );

Laurent Aimar's avatar
Laurent Aimar committed
846
    msg_Dbg( p_vout, "pic out sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
basos g's avatar
basos g committed
847 848 849 850 851 852 853 854
             p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
             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,
             p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den,
             p_vout->fmt_out.i_rmask, p_vout->fmt_out.i_gmask, p_vout->fmt_out.i_bmask );

Laurent Aimar's avatar
Laurent Aimar committed
855 856 857
    assert( p_vout->output.i_width == p_vout->render.i_width &&
            p_vout->output.i_height == p_vout->render.i_height &&
            p_vout->output.i_chroma == p_vout->render.i_chroma );
Sam Hocevar's avatar
 
Sam Hocevar committed
858
    /* Check whether we managed to create direct buffers similar to
859
     * the render buffers, ie same size and chroma */
Gildas Bazin's avatar
 
Gildas Bazin committed
860

Laurent Aimar's avatar
Laurent Aimar committed
861 862 863 864 865
    /* 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 */
    for( i = 1; i < VOUT_MAX_PICTURES; i++ )
Sam Hocevar's avatar
 
Sam Hocevar committed
866
    {
Laurent Aimar's avatar
Laurent Aimar committed
867 868 869
        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 )
Sam Hocevar's avatar
 
Sam Hocevar committed
870
        {
Laurent Aimar's avatar
Laurent Aimar committed
871 872 873
            /* We have enough direct buffers so there's no need to
             * try to use system memory buffers. */
            break;
Sam Hocevar's avatar