src/misc/picture.c

   1 /*****************************************************************************
   2  * picture.c : picture management functions
   3  *****************************************************************************
   4  * Copyright (C) 2000-2010 VLC authors and VideoLAN
   5  * Copyright (C) 2009-2010 Laurent Aimar
   6  * $Id$
   7  *
   8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   9  *          Samuel Hocevar <sam@zoy.org>
  10  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU Lesser General Public License as published by
  14  * the Free Software Foundation; either version 2.1 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34 #include <assert.h>
  35
  36 #include <vlc_common.h>
  37 #include "picture.h"
  38 #include <vlc_image.h>
  39 #include <vlc_block.h>
  40
  41 #define PICTURE_SW_SIZE_MAX (1<<28) /* 256MB: 8K * 8K * 4*/
  42
  43 /**
  44  * Allocate a new picture in the heap.
  45  *
  46  * This function allocates a fake direct buffer in memory, which can be
  47  * used exactly like a video buffer. The video output thread then manages
  48  * how it gets displayed.
  49  */
  50 static int AllocatePicture( picture_t *p_pic )
  51 {
  52     /* Calculate how big the new image should be */
  53     size_t i_bytes = 0;
  54     for( int i = 0; i < p_pic->i_planes; i++ )
  55     {
  56         const plane_t *p = &p_pic->p[i];
  57
  58         if( p->i_pitch < 0 || p->i_lines <= 0 ||
  59             (size_t)p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
  60         {
  61             p_pic->i_planes = 0;
  62             return VLC_ENOMEM;
  63         }
  64         i_bytes += p->i_pitch * p->i_lines;
  65     }
  66
  67     if( i_bytes >= PICTURE_SW_SIZE_MAX )
  68     {
  69         p_pic->i_planes = 0;
  70         return VLC_ENOMEM;
  71     }
  72
  73     uint8_t *p_data = aligned_alloc( 16, i_bytes );
  74     if( i_bytes > 0 && p_data == NULL )
  75     {
  76         p_pic->i_planes = 0;
  77         return VLC_EGENERIC;
  78     }
  79
  80     /* Fill the p_pixels field for each plane */
  81     p_pic->p[0].p_pixels = p_data;
  82     for( int i = 1; i < p_pic->i_planes; i++ )
  83     {
  84         p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
  85                                                         p_pic->p[i-1].i_pitch ];
  86     }
  87
  88     return VLC_SUCCESS;
  89 }
  90
  91 /*****************************************************************************
  92  *
  93  *****************************************************************************/
  94
  95 static void PictureDestroyContext( picture_t *p_picture )
  96 {
  97     picture_context_t *ctx = p_picture->context;
  98     if (ctx != NULL)
  99     {
 100         ctx->destroy(ctx);
 101         p_picture->context = NULL;
 102     }
 103 }
 104
 105 /**
 106  * Destroys a picture allocated by picture_NewFromResource() but without
 107  * a custom destruction callback.
 108  */
 109 static void picture_DestroyFromResource( picture_t *p_picture )
 110 {
 111     free( p_picture->p_sys );
 112     free( p_picture );
 113 }
 114
 115 /**
 116  * Destroys a picture allocated with picture_NewFromFormat()
 117  * (and thus AllocatePicture()).
 118  */
 119 static void picture_Destroy( picture_t *p_picture )
 120 {
 121     aligned_free( p_picture->p[0].p_pixels );
 122     free( p_picture );
 123 }
 124
 125 /*****************************************************************************
 126  *
 127  *****************************************************************************/
 128 void picture_Reset( picture_t *p_picture )
 129 {
 130     /* */
 131     p_picture->date = VLC_TS_INVALID;
 132     p_picture->b_force = false;
 133     p_picture->b_progressive = false;
 134     p_picture->i_nb_fields = 2;
 135     p_picture->b_top_field_first = false;
 136     PictureDestroyContext( p_picture );
 137 }
 138
 139 /*****************************************************************************
 140  *
 141  *****************************************************************************/
 142 static int LCM( int a, int b )
 143 {
 144     return a * b / GCD( a, b );
 145 }
 146
 147 int picture_Setup( picture_t *p_picture, const video_format_t *restrict fmt )
 148 {
 149     /* Store default values */
 150     p_picture->i_planes = 0;
 151     for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
 152     {
 153         plane_t *p = &p_picture->p[i];
 154         p->p_pixels = NULL;
 155         p->i_pixel_pitch = 0;
 156     }
 157
 158     p_picture->i_nb_fields = 2;
 159
 160     video_format_Setup( &p_picture->format, fmt->i_chroma, fmt->i_width, fmt->i_height,
 161                         fmt->i_visible_width, fmt->i_visible_height,
 162                         fmt->i_sar_num, fmt->i_sar_den );
 163
 164     const vlc_chroma_description_t *p_dsc =
 165         vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
 166     if( !p_dsc )
 167         return VLC_EGENERIC;
 168
 169     /* We want V (width/height) to respect:
 170         (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
 171         (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
 172        Which is respected if you have
 173        V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
 174     */
 175     int i_modulo_w = 1;
 176     int i_modulo_h = 1;
 177     unsigned int i_ratio_h  = 1;
 178     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 179     {
 180         i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.den );
 181         i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.den );
 182         if( i_ratio_h < p_dsc->p[i].h.den )
 183             i_ratio_h = p_dsc->p[i].h.den;
 184     }
 185     i_modulo_h = LCM( i_modulo_h, 32 );
 186
 187     const int i_width_aligned  = ( fmt->i_width  + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
 188     const int i_height_aligned = ( fmt->i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
 189     const int i_height_extra   = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
 190     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 191     {
 192         plane_t *p = &p_picture->p[i];
 193
 194         p->i_lines         = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.num / p_dsc->p[i].h.den;
 195         p->i_visible_lines = fmt->i_visible_height * p_dsc->p[i].h.num / p_dsc->p[i].h.den;
 196         p->i_pitch         = i_width_aligned * p_dsc->p[i].w.num / p_dsc->p[i].w.den * p_dsc->pixel_size;
 197         p->i_visible_pitch = fmt->i_visible_width * p_dsc->p[i].w.num / p_dsc->p[i].w.den * p_dsc->pixel_size;
 198         p->i_pixel_pitch   = p_dsc->pixel_size;
 199
 200         assert( (p->i_pitch % 16) == 0 );
 201     }
 202     p_picture->i_planes  = p_dsc->plane_count;
 203
 204     return VLC_SUCCESS;
 205 }
 206
 207 /*****************************************************************************
 208  *
 209  *****************************************************************************/
 210 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
 211 {
 212     video_format_t fmt = *p_fmt;
 213
 214     /* It is needed to be sure all information are filled */
 215     video_format_Setup( &fmt, p_fmt->i_chroma,
 216                               p_fmt->i_width, p_fmt->i_height,
 217                               p_fmt->i_visible_width, p_fmt->i_visible_height,
 218                               p_fmt->i_sar_num, p_fmt->i_sar_den );
 219     if( p_fmt->i_x_offset < p_fmt->i_width &&
 220         p_fmt->i_y_offset < p_fmt->i_height &&
 221         p_fmt->i_visible_width  > 0 && p_fmt->i_x_offset + p_fmt->i_visible_width  <= p_fmt->i_width &&
 222         p_fmt->i_visible_height > 0 && p_fmt->i_y_offset + p_fmt->i_visible_height <= p_fmt->i_height )
 223         video_format_CopyCrop( &fmt, p_fmt );
 224
 225     /* */
 226     picture_priv_t *priv = malloc( sizeof (*priv) );
 227     if( unlikely(priv == NULL) )
 228         return NULL;
 229
 230     picture_t *p_picture = &priv->picture;
 231
 232     memset( p_picture, 0, sizeof( *p_picture ) );
 233     p_picture->format = fmt;
 234
 235     /* Make sure the real dimensions are a multiple of 16 */
 236     if( picture_Setup( p_picture, &fmt ) )
 237     {
 238         free( p_picture );
 239         return NULL;
 240     }
 241
 242     atomic_init( &priv->gc.refs, 1 );
 243     priv->gc.opaque = NULL;
 244
 245     if( p_resource )
 246     {
 247         p_picture->p_sys = p_resource->p_sys;
 248
 249         if( p_resource->pf_destroy != NULL )
 250             priv->gc.destroy = p_resource->pf_destroy;
 251         else
 252             priv->gc.destroy = picture_DestroyFromResource;
 253
 254         for( int i = 0; i < p_picture->i_planes; i++ )
 255         {
 256             p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
 257             p_picture->p[i].i_lines  = p_resource->p[i].i_lines;
 258             p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;
 259         }
 260     }
 261     else
 262     {
 263         if( AllocatePicture( p_picture ) )
 264         {
 265             free( p_picture );
 266             return NULL;
 267         }
 268         priv->gc.destroy = picture_Destroy;
 269     }
 270
 271     return p_picture;
 272 }
 273
 274 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
 275 {
 276     return picture_NewFromResource( p_fmt, NULL );
 277 }
 278
 279 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
 280 {
 281     video_format_t fmt;
 282
 283     video_format_Init( &fmt, 0 );
 284     video_format_Setup( &fmt, i_chroma, i_width, i_height,
 285                         i_width, i_height, i_sar_num, i_sar_den );
 286
 287     return picture_NewFromFormat( &fmt );
 288 }
 289
 290 /*****************************************************************************
 291  *
 292  *****************************************************************************/
 293
 294 picture_t *picture_Hold( picture_t *p_picture )
 295 {
 296     assert( p_picture != NULL );
 297
 298     picture_priv_t *priv = (picture_priv_t *)p_picture;
 299     uintptr_t refs = atomic_fetch_add( &priv->gc.refs, 1 );
 300     assert( refs > 0 );
 301     return p_picture;
 302 }
 303
 304 void picture_Release( picture_t *p_picture )
 305 {
 306     assert( p_picture != NULL );
 307
 308     picture_priv_t *priv = (picture_priv_t *)p_picture;
 309     uintptr_t refs = atomic_fetch_sub( &priv->gc.refs, 1 );
 310     assert( refs != 0 );
 311     if( refs > 1 )
 312         return;
 313
 314     PictureDestroyContext( p_picture );
 315     assert( priv->gc.destroy != NULL );
 316     priv->gc.destroy( p_picture );
 317 }
 318
 319 /*****************************************************************************
 320  *
 321  *****************************************************************************/
 322 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
 323 {
 324     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
 325                                      p_src->i_visible_pitch );
 326     const unsigned i_height = __MIN( p_dst->i_visible_lines,
 327                                      p_src->i_visible_lines );
 328
 329     /* The 2x visible pitch check does two things:
 330        1) Makes field plane_t's work correctly (see the deinterlacer module)
 331        2) Moves less data if the pitch and visible pitch differ much.
 332     */
 333     if( p_src->i_pitch == p_dst->i_pitch  &&
 334         p_src->i_pitch < 2*p_src->i_visible_pitch )
 335     {
 336         /* There are margins, but with the same width : perfect ! */
 337         memcpy( p_dst->p_pixels, p_src->p_pixels,
 338                     p_src->i_pitch * i_height );
 339     }
 340     else
 341     {
 342         /* We need to proceed line by line */
 343         uint8_t *p_in = p_src->p_pixels;
 344         uint8_t *p_out = p_dst->p_pixels;
 345
 346         assert( p_in );
 347         assert( p_out );
 348
 349         for( int i_line = i_height; i_line--; )
 350         {
 351             memcpy( p_out, p_in, i_width );
 352             p_in += p_src->i_pitch;
 353             p_out += p_dst->i_pitch;
 354         }
 355     }
 356 }
 357
 358 void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
 359 {
 360     p_dst->date = p_src->date;
 361     p_dst->b_force = p_src->b_force;
 362
 363     p_dst->b_progressive = p_src->b_progressive;
 364     p_dst->i_nb_fields = p_src->i_nb_fields;
 365     p_dst->b_top_field_first = p_src->b_top_field_first;
 366 }
 367
 368 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
 369 {
 370     for( int i = 0; i < p_src->i_planes ; i++ )
 371         plane_CopyPixels( p_dst->p+i, p_src->p+i );
 372
 373     assert( p_dst->context == NULL );
 374
 375     if( p_src->context != NULL )
 376         p_dst->context = p_src->context->copy( p_src->context );
 377 }
 378
 379 void picture_Copy( picture_t *p_dst, const picture_t *p_src )
 380 {
 381     picture_CopyPixels( p_dst, p_src );
 382     picture_CopyProperties( p_dst, p_src );
 383 }
 384
 385 static void picture_DestroyClone(picture_t *clone)
 386 {
 387     picture_t *picture = ((picture_priv_t *)clone)->gc.opaque;
 388
 389     free(clone);
 390     picture_Release(picture);
 391 }
 392
 393 picture_t *picture_Clone(picture_t *picture)
 394 {
 395     /* TODO: merge common code with picture_pool_ClonePicture(). */
 396     picture_resource_t res = {
 397         .p_sys = picture->p_sys,
 398         .pf_destroy = picture_DestroyClone,
 399     };
 400
 401     for (int i = 0; i < picture->i_planes; i++) {
 402         res.p[i].p_pixels = picture->p[i].p_pixels;
 403         res.p[i].i_lines = picture->p[i].i_lines;
 404         res.p[i].i_pitch = picture->p[i].i_pitch;
 405     }
 406
 407     picture_t *clone = picture_NewFromResource(&picture->format, &res);
 408     if (likely(clone != NULL)) {
 409         ((picture_priv_t *)clone)->gc.opaque = picture;
 410         picture_Hold(picture);
 411
 412         if (picture->context != NULL)
 413             clone->context = picture->context->copy(picture->context);
 414     }
 415     return clone;
 416 }
 417
 418 /*****************************************************************************
 419  *
 420  *****************************************************************************/
 421 int picture_Export( vlc_object_t *p_obj,
 422                     block_t **pp_image,
 423                     video_format_t *p_fmt,
 424                     picture_t *p_picture,
 425                     vlc_fourcc_t i_format,
 426                     int i_override_width, int i_override_height )
 427 {
 428     /* */
 429     video_format_t fmt_in = p_picture->format;
 430     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
 431     {
 432         fmt_in.i_sar_num =
 433         fmt_in.i_sar_den = 1;
 434     }
 435
 436     /* */
 437     video_format_t fmt_out;
 438     memset( &fmt_out, 0, sizeof(fmt_out) );
 439     fmt_out.i_sar_num =
 440     fmt_out.i_sar_den = 1;
 441     fmt_out.i_chroma  = i_format;
 442
 443     /* compute original width/height */
 444     unsigned int i_width, i_height, i_original_width, i_original_height;
 445     if( fmt_in.i_visible_width > 0 && fmt_in.i_visible_height > 0 )
 446     {
 447         i_width = fmt_in.i_visible_width;
 448         i_height = fmt_in.i_visible_height;
 449     }
 450     else
 451     {
 452         i_width = fmt_in.i_width;
 453         i_height = fmt_in.i_height;
 454     }
 455     if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
 456     {
 457         i_original_width = (int64_t)i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
 458         i_original_height = i_height;
 459     }
 460     else
 461     {
 462         i_original_width =  i_width;
 463         i_original_height = i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
 464     }
 465
 466     /* */
 467     fmt_out.i_width  = ( i_override_width < 0 ) ?
 468                        i_original_width : (unsigned)i_override_width;
 469     fmt_out.i_height = ( i_override_height < 0 ) ?
 470                        i_original_height : (unsigned)i_override_height;
 471
 472     /* scale if only one direction is provided */
 473     if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
 474     {
 475         fmt_out.i_height = i_height * fmt_out.i_width
 476                          * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
 477     }
 478     else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
 479     {
 480         fmt_out.i_width  = i_width * fmt_out.i_height
 481                          * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
 482     }
 483
 484     image_handler_t *p_image = image_HandlerCreate( p_obj );
 485     if( !p_image )
 486         return VLC_ENOMEM;
 487
 488     block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
 489
 490     image_HandlerDelete( p_image );
 491
 492     if( !p_block )
 493         return VLC_EGENERIC;
 494
 495     p_block->i_pts =
 496     p_block->i_dts = p_picture->date;
 497
 498     if( p_fmt )
 499         *p_fmt = fmt_out;
 500     *pp_image = p_block;
 501
 502     return VLC_SUCCESS;
 503 }