vout_pictures.c 17.2 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_pictures.c : picture management functions
 *****************************************************************************
4
 * Copyright (C) 2000-2004 the VideoLAN team
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * 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
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
23 24 25 26 27 28
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/

29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
32
#include <assert.h>
33

34
#include <vlc_common.h>
35
#include <libvlc.h>
zorglub's avatar
zorglub committed
36 37
#include <vlc_vout.h>
#include <vlc_osd.h>
38
#include <vlc_filter.h>
39 40
#include <vlc_image.h>
#include <vlc_block.h>
Laurent Aimar's avatar
Laurent Aimar committed
41
#include <vlc_picture_fifo.h>
42
#include <vlc_picture_pool.h>
43

44
#include "vout_pictures.h"
45
#include "vout_internal.h"
46

47 48 49
/**
 * Display a picture
 *
gbazin's avatar
 
gbazin committed
50
 * Remove the reservation flag of a picture, which will cause it to be ready
51
 * for display.
52
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
53
void vout_DisplayPicture( vout_thread_t *p_vout, picture_t *p_pic )
Sam Hocevar's avatar
 
Sam Hocevar committed
54
{
55
    vlc_mutex_lock( &p_vout->p->picture_lock );
56

57 58
    p_pic->p_next = NULL;
    picture_fifo_Push(p_vout->p->decoder_fifo, p_pic);
Sam Hocevar's avatar
 
Sam Hocevar committed
59

60
    vlc_cond_signal( &p_vout->p->picture_wait );
61
    vlc_mutex_unlock( &p_vout->p->picture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
62 63
}

64 65 66
/**
 * Allocate a picture in the video output heap.
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
67 68
 * This function creates a reserved image in the video output heap.
 * A null pointer is returned if the function fails. This method provides an
gbazin's avatar
 
gbazin committed
69 70 71
 * already allocated zone of memory in the picture data fields.
 * It needs locking since several pictures can be created by several producers
 * threads.
72
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
73
picture_t *vout_CreatePicture( vout_thread_t *p_vout,
74 75
                               bool b_progressive,
                               bool b_top_field_first,
76
                               unsigned int i_nb_fields )
Sam Hocevar's avatar
 
Sam Hocevar committed
77
{
78
#warning "TODO remove unused vout_CreatePicture parameters"
Sam Hocevar's avatar
 
Sam Hocevar committed
79
    /* Get lock */
80
    vlc_mutex_lock( &p_vout->p->picture_lock );
81 82 83 84
    picture_t *p_pic = picture_pool_Get(p_vout->p->decoder_pool);
    if (p_pic) {
        picture_Reset(p_pic);
        p_pic->p_next = NULL; // FIXME put it in picture_Reset ?
Sam Hocevar's avatar
 
Sam Hocevar committed
85
    }
86
    vlc_mutex_unlock( &p_vout->p->picture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
87

88
    return p_pic;
Sam Hocevar's avatar
 
Sam Hocevar committed
89 90
}

91
/* */
92
void vout_DropPicture( vout_thread_t *p_vout, picture_t *p_pic  )
93
{
94
    vlc_mutex_lock( &p_vout->p->picture_lock );
95

96
    picture_Release( p_pic );
97 98

    vlc_cond_signal( &p_vout->p->picture_wait );
99
    vlc_mutex_unlock( &p_vout->p->picture_lock );
100 101
}

Sam Hocevar's avatar
 
Sam Hocevar committed
102
void vout_DestroyPicture( vout_thread_t *p_vout, picture_t *p_pic )
Sam Hocevar's avatar
 
Sam Hocevar committed
103
{
104 105
    vout_DropPicture( p_vout, p_pic );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
106

107

108 109 110
/**
 * Increment reference counter of a picture
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
111 112
 * This function increments the reference counter of a picture in the video
 * heap. It needs a lock since several producer threads can access the picture.
113
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
114
void vout_LinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
Sam Hocevar's avatar
 
Sam Hocevar committed
115
{
116
    vlc_mutex_lock( &p_vout->p->picture_lock );
117
    picture_Hold( p_pic );
118
    vlc_mutex_unlock( &p_vout->p->picture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
119 120
}

121 122 123
/**
 * Decrement reference counter of a picture
 *
gbazin's avatar
 
gbazin committed
124
 * This function decrement the reference counter of a picture in the video heap
125
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
126
void vout_UnlinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
Sam Hocevar's avatar
 
Sam Hocevar committed
127
{
128
    vlc_mutex_lock( &p_vout->p->picture_lock );
129
    picture_Release( p_pic );
Sam Hocevar's avatar
 
Sam Hocevar committed
130

131
    vlc_cond_signal( &p_vout->p->picture_wait );
132
    vlc_mutex_unlock( &p_vout->p->picture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
133 134
}

135 136 137
/**
 * Allocate a new picture in the heap.
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
138 139 140
 * This function allocates a fake direct buffer in memory, which can be
 * used exactly like a video buffer. The video output thread then manages
 * how it gets displayed.
141
 */
142 143 144 145
static int vout_AllocatePicture( picture_t *p_pic,
                                 vlc_fourcc_t i_chroma,
                                 int i_width, int i_height,
                                 int i_sar_num, int i_sar_den )
Sam Hocevar's avatar
 
Sam Hocevar committed
146
{
147
    /* Make sure the real dimensions are a multiple of 16 */
148 149
    if( picture_Setup( p_pic, i_chroma, i_width, i_height,
                       i_sar_num, i_sar_den ) != VLC_SUCCESS )
150
        return VLC_EGENERIC;
gbazin's avatar
 
gbazin committed
151 152

    /* Calculate how big the new image should be */
153
    size_t i_bytes = 0;
154
    for( int i = 0; i < p_pic->i_planes; i++ )
155
    {
156 157 158 159
        const plane_t *p = &p_pic->p[i];

        if( p->i_pitch <= 0 || p->i_lines <= 0 ||
            p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
160
        {
161 162
            p_pic->i_planes = 0;
            return VLC_ENOMEM;
163
        }
164
        i_bytes += p->i_pitch * p->i_lines;
165
    }
gbazin's avatar
 
gbazin committed
166 167 168 169 170

    p_pic->p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
    if( p_pic->p_data == NULL )
    {
        p_pic->i_planes = 0;
171
        return VLC_EGENERIC;
gbazin's avatar
 
gbazin committed
172 173 174
    }

    /* Fill the p_pixels field for each plane */
175 176
    p_pic->p[0].p_pixels = p_pic->p_data;
    for( int i = 1; i < p_pic->i_planes; i++ )
gbazin's avatar
 
gbazin committed
177
    {
178 179
        p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
                                                        p_pic->p[i-1].i_pitch ];
gbazin's avatar
 
gbazin committed
180
    }
181 182

    return VLC_SUCCESS;
gbazin's avatar
 
gbazin committed
183 184
}

185 186 187 188 189 190 191 192 193
/*****************************************************************************
 *
 *****************************************************************************/
static void PictureReleaseCallback( picture_t *p_picture )
{
    if( --p_picture->i_refcount > 0 )
        return;
    picture_Delete( p_picture );
}
194

Laurent Aimar's avatar
Laurent Aimar committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208
/*****************************************************************************
 *
 *****************************************************************************/
void picture_Reset( picture_t *p_picture )
{
    /* */
    p_picture->date = VLC_TS_INVALID;
    p_picture->b_force = false;
    p_picture->b_progressive = false;
    p_picture->i_nb_fields = 0;
    p_picture->b_top_field_first = false;
    picture_CleanupQuant( p_picture );
}

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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
typedef struct
{
    unsigned     i_plane_count;
    struct
    {
        struct
        {
            unsigned i_num;
            unsigned i_den;
        } w;
        struct
        {
            unsigned i_num;
            unsigned i_den;
        } h;
    } p[VOUT_MAX_PLANES];
    unsigned i_pixel_size;

} chroma_description_t;

#define PLANAR(n, w_den, h_den) \
    { n, { {{1,1}, {1,1}}, {{1,w_den}, {1,h_den}}, {{1,w_den}, {1,h_den}}, {{1,1}, {1,1}} }, 1 }
#define PACKED(size) \
    { 1, { {{1,1}, {1,1}} }, size }

static const struct
{
    vlc_fourcc_t            p_fourcc[5];
    chroma_description_t    description;
} p_chromas[] = {
    { { VLC_CODEC_I411, 0 },                                 PLANAR(3, 4, 1) },
    { { VLC_CODEC_I410, VLC_CODEC_YV9, 0 },                  PLANAR(3, 4, 4) },
    { { VLC_CODEC_YV12, VLC_CODEC_I420, VLC_CODEC_J420, 0 }, PLANAR(3, 2, 2) },
    { { VLC_CODEC_I422, VLC_CODEC_J422, 0 },                 PLANAR(3, 2, 1) },
    { { VLC_CODEC_I440, VLC_CODEC_J440, 0 },                 PLANAR(3, 1, 2) },
    { { VLC_CODEC_I444, VLC_CODEC_J444, 0 },                 PLANAR(3, 1, 1) },
    { { VLC_CODEC_YUVA, 0 },                                 PLANAR(4, 1, 1) },

    { { VLC_CODEC_UYVY, VLC_CODEC_VYUY, VLC_CODEC_YUYV, VLC_CODEC_YVYU, 0 }, PACKED(2) },
    { { VLC_CODEC_RGB8, VLC_CODEC_GREY, VLC_CODEC_YUVP, VLC_CODEC_RGBP, 0 }, PACKED(1) },
    { { VLC_CODEC_RGB16, VLC_CODEC_RGB15, 0 },                               PACKED(2) },
    { { VLC_CODEC_RGB24, 0 },                                                PACKED(3) },
    { { VLC_CODEC_RGB32, VLC_CODEC_RGBA, 0 },                                PACKED(4) },

    { { VLC_CODEC_Y211, 0 }, { 1, { {{1,4}, {1,1}} }, 4 } },

    { {0}, { 0, {}, 0 } }
};

#undef PACKED
#undef PLANAR

static const chroma_description_t *vlc_fourcc_GetChromaDescription( vlc_fourcc_t i_fourcc )
{
    for( unsigned i = 0; p_chromas[i].p_fourcc[0]; i++ )
    {
        const vlc_fourcc_t *p_fourcc = p_chromas[i].p_fourcc;
        for( unsigned j = 0; p_fourcc[j]; j++ )
        {
            if( p_fourcc[j] == i_fourcc )
                return &p_chromas[i].description;
        }
    }
    return NULL;
}

static int LCM( int a, int b )
{
    return a * b / GCD( a, b );
}

283 284
int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
                   int i_width, int i_height, int i_sar_num, int i_sar_den )
285 286
{
    /* Store default values */
287 288
    p_picture->i_planes = 0;
    for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
289
    {
290 291 292
        plane_t *p = &p_picture->p[i];
        p->p_pixels = NULL;
        p->i_pixel_pitch = 0;
293 294 295
    }

    p_picture->pf_release = NULL;
Laurent Aimar's avatar
Laurent Aimar committed
296
    p_picture->p_release_sys = NULL;
297 298 299 300 301 302
    p_picture->i_refcount = 0;

    p_picture->i_qtype = QTYPE_NONE;
    p_picture->i_qstride = 0;
    p_picture->p_q = NULL;

303
    video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
304
                        i_sar_num, i_sar_den );
305

306 307 308 309
    const chroma_description_t *p_dsc =
        vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
    if( !p_dsc )
        return VLC_EGENERIC;
310

311 312 313 314 315 316 317 318 319 320
    /* We want V (width/height) to respect:
        (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
        (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
       Which is respected if you have
       V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
    */
    int i_modulo_w = 1;
    int i_modulo_h = 1;
    int i_ratio_h  = 1;
    for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
321
    {
322 323 324 325 326
        i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.i_den );
        i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.i_den );
        if( i_ratio_h < p_dsc->p[i].h.i_den )
            i_ratio_h = p_dsc->p[i].h.i_den;
    }
327

328 329 330 331 332 333
    const int i_width_aligned  = ( i_width  + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
    const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
    const int i_height_extra   = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
    for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
    {
        plane_t *p = &p_picture->p[i];
334

335 336 337 338 339
        p->i_lines         = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
        p->i_visible_lines = i_height * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
        p->i_pitch         = i_width_aligned * p_dsc->p[i].w.i_num / p_dsc->p[i].w.i_den * p_dsc->i_pixel_size;
        p->i_visible_pitch = i_width * p_dsc->p[i].w.i_num / p_dsc->p[i].w.i_den * p_dsc->i_pixel_size;
        p->i_pixel_pitch   = p_dsc->i_pixel_size;
340

341
        assert( (p->i_pitch % 16) == 0 );
342
    }
343
    p_picture->i_planes  = p_dsc->i_plane_count;
344 345 346 347

    return VLC_SUCCESS;
}

348 349 350
/*****************************************************************************
 *
 *****************************************************************************/
351
picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
352
{
353 354 355 356
    video_format_t fmt = *p_fmt;

    /* It is needed to be sure all informations are filled */
    video_format_Setup( &fmt, p_fmt->i_chroma,
357
                              p_fmt->i_width, p_fmt->i_height,
Laurent Aimar's avatar
Laurent Aimar committed
358
                              p_fmt->i_sar_num, p_fmt->i_sar_den );
359 360

    /* */
ivoire's avatar
ivoire committed
361
    picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
362 363 364
    if( !p_picture )
        return NULL;

365
    if( p_resource )
366
    {
367 368
        if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
                           fmt.i_sar_num, fmt.i_sar_den ) )
369 370 371 372 373
        {
            free( p_picture );
            return NULL;
        }
        p_picture->p_sys = p_resource->p_sys;
374

375 376 377 378 379 380 381 382 383
        for( int i = 0; i < p_picture->i_planes; i++ )
        {
            p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
            p_picture->p[i].i_lines  = p_resource->p[i].i_lines;
            p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;
        }
    }
    else
    {
384
        if( vout_AllocatePicture( p_picture,
385 386
                                  fmt.i_chroma, fmt.i_width, fmt.i_height,
                                  fmt.i_sar_num, fmt.i_sar_den ) )
387 388 389 390 391 392 393
        {
            free( p_picture );
            return NULL;
        }
    }
    /* */
    p_picture->format = fmt;
394 395 396 397 398 399
    p_picture->i_refcount = 1;
    p_picture->pf_release = PictureReleaseCallback;
    p_picture->i_status = RESERVED_PICTURE;

    return p_picture;
}
400 401 402 403
picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
{
    return picture_NewFromResource( p_fmt, NULL );
}
404
picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
405 406 407 408
{
    video_format_t fmt;

    memset( &fmt, 0, sizeof(fmt) );
409
    video_format_Setup( &fmt, i_chroma, i_width, i_height,
410
                        i_sar_num, i_sar_den );
411 412 413

    return picture_NewFromFormat( &fmt );
}
414 415 416 417 418 419 420

/*****************************************************************************
 *
 *****************************************************************************/
void picture_Delete( picture_t *p_picture )
{
    assert( p_picture && p_picture->i_refcount == 0 );
Laurent Aimar's avatar
Laurent Aimar committed
421
    assert( p_picture->p_release_sys == NULL );
422

423
    free( p_picture->p_q );
424 425 426 427 428 429 430 431 432 433
    free( p_picture->p_data_orig );
    free( p_picture->p_sys );
    free( p_picture );
}

/*****************************************************************************
 *
 *****************************************************************************/
void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
{
434 435 436
    int i;

    for( i = 0; i < p_src->i_planes ; i++ )
437 438
        plane_CopyPixels( p_dst->p+i, p_src->p+i );
}
439

440 441 442 443 444 445
void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
{
    const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
                                     p_src->i_visible_pitch );
    const unsigned i_height = __MIN( p_dst->i_visible_lines,
                                     p_src->i_visible_lines );
446

447 448 449 450 451 452 453 454 455 456 457 458
    if( p_src->i_pitch == p_dst->i_pitch )
    {
        /* There are margins, but with the same width : perfect ! */
        vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
                    p_src->i_pitch * i_height );
    }
    else
    {
        /* We need to proceed line by line */
        uint8_t *p_in = p_src->p_pixels;
        uint8_t *p_out = p_dst->p_pixels;
        int i_line;
459

460 461 462 463 464 465 466 467
        assert( p_in );
        assert( p_out );

        for( i_line = i_height; i_line--; )
        {
            vlc_memcpy( p_out, p_in, i_width );
            p_in += p_src->i_pitch;
            p_out += p_dst->i_pitch;
468 469 470
        }
    }
}
Laurent Aimar's avatar
Laurent Aimar committed
471

472 473 474
/*****************************************************************************
 *
 *****************************************************************************/
475 476 477 478 479
int picture_Export( vlc_object_t *p_obj,
                    block_t **pp_image,
                    video_format_t *p_fmt,
                    picture_t *p_picture,
                    vlc_fourcc_t i_format,
480
                    int i_override_width, int i_override_height )
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
{
    /* */
    video_format_t fmt_in = p_picture->format;
    if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
    {
        fmt_in.i_sar_num =
        fmt_in.i_sar_den = 1;
    }

    /* */
    video_format_t fmt_out;
    memset( &fmt_out, 0, sizeof(fmt_out) );
    fmt_out.i_sar_num =
    fmt_out.i_sar_den = 1;
    fmt_out.i_chroma  = i_format;

497 498 499 500
    /* compute original width/height */
    unsigned int i_original_width;
    unsigned int i_original_height;
    if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
501
    {
502 503
        i_original_width = fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
        i_original_height = fmt_in.i_height;
504 505 506
    }
    else
    {
507 508 509 510 511
        i_original_width =  fmt_in.i_width;
        i_original_height = fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
    }

    /* */
512 513 514 515
    fmt_out.i_width  = ( i_override_width < 0 ) ?
                       i_original_width : i_override_width;
    fmt_out.i_height = ( i_override_height < 0 ) ?
                       i_original_height : i_override_height;
516 517 518 519 520 521 522 523 524 525 526

    /* scale if only one direction is provided */
    if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
    {
        fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
                     * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
    }
    else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
    {
        fmt_out.i_width  = fmt_in.i_width * fmt_out.i_height
                     * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
    }

    image_handler_t *p_image = image_HandlerCreate( p_obj );

    block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );

    image_HandlerDelete( p_image );

    if( !p_block )
        return VLC_EGENERIC;

    p_block->i_pts =
    p_block->i_dts = p_picture->date;

    if( p_fmt )
        *p_fmt = fmt_out;
    *pp_image = p_block;

    return VLC_SUCCESS;
}