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 #include <limits.h>
  36
  37 #include <vlc_common.h>
  38 #include "picture.h"
  39 #include <vlc_image.h>
  40 #include <vlc_block.h>
  41
  42 static void PictureDestroyContext( picture_t *p_picture )
  43 {
  44     picture_context_t *ctx = p_picture->context;
  45     if (ctx != NULL)
  46     {
  47         ctx->destroy(ctx);
  48         p_picture->context = NULL;
  49     }
  50 }
  51
  52 /**
  53  * Destroys a picture allocated by picture_NewFromResource() but without
  54  * a custom destruction callback.
  55  */
  56 static void picture_DestroyFromResource( picture_t *p_picture )
  57 {
  58     free( p_picture->p_sys );
  59     free( p_picture );
  60 }
  61
  62 /**
  63  * Destroys a picture allocated with picture_NewFromFormat().
  64  */
  65 static void picture_Destroy( picture_t *p_picture )
  66 {
  67     aligned_free( p_picture->p[0].p_pixels );
  68     free( p_picture );
  69 }
  70
  71 /*****************************************************************************
  72  *
  73  *****************************************************************************/
  74 void picture_Reset( picture_t *p_picture )
  75 {
  76     /* */
  77     p_picture->date = VLC_TICK_INVALID;
  78     p_picture->b_force = false;
  79     p_picture->b_progressive = false;
  80     p_picture->i_nb_fields = 2;
  81     p_picture->b_top_field_first = false;
  82     PictureDestroyContext( p_picture );
  83 }
  84
  85 /*****************************************************************************
  86  *
  87  *****************************************************************************/
  88 static int LCM( int a, int b )
  89 {
  90     return a * b / GCD( a, b );
  91 }
  92
  93 int picture_Setup( picture_t *p_picture, const video_format_t *restrict fmt )
  94 {
  95     /* Store default values */
  96     p_picture->i_planes = 0;
  97     for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
  98     {
  99         plane_t *p = &p_picture->p[i];
 100         p->p_pixels = NULL;
 101         p->i_pixel_pitch = 0;
 102     }
 103
 104     p_picture->i_nb_fields = 2;
 105
 106     video_format_Setup( &p_picture->format, fmt->i_chroma, fmt->i_width, fmt->i_height,
 107                         fmt->i_visible_width, fmt->i_visible_height,
 108                         fmt->i_sar_num, fmt->i_sar_den );
 109
 110     const vlc_chroma_description_t *p_dsc =
 111         vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
 112     if( !p_dsc )
 113         return VLC_EGENERIC;
 114
 115     /* We want V (width/height) to respect:
 116         (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
 117         (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
 118        Which is respected if you have
 119        V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
 120     */
 121     unsigned i_modulo_w = 1;
 122     unsigned i_modulo_h = 1;
 123     unsigned i_ratio_h  = 1;
 124
 125     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 126     {
 127         i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.den );
 128         i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.den );
 129         if( i_ratio_h < p_dsc->p[i].h.den )
 130             i_ratio_h = p_dsc->p[i].h.den;
 131     }
 132     i_modulo_h = LCM( i_modulo_h, 32 );
 133
 134     unsigned width, height;
 135
 136     if (unlikely(add_overflow(fmt->i_width, i_modulo_w - 1, &width))
 137      || unlikely(add_overflow(fmt->i_height, i_modulo_h - 1, &height)))
 138         return VLC_EGENERIC;
 139
 140     width = width / i_modulo_w * i_modulo_w;
 141     height = height / i_modulo_h * i_modulo_h;
 142
 143     /* plane_t uses 'int'. */
 144     if (unlikely(width > INT_MAX) || unlikely(height > INT_MAX))
 145         return VLC_EGENERIC;
 146
 147     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 148     {
 149         plane_t *p = &p_picture->p[i];
 150         const vlc_rational_t *h = &p_dsc->p[i].h;
 151         const vlc_rational_t *w = &p_dsc->p[i].w;
 152
 153         /* A plane cannot be over-sampled. This could lead to overflow. */
 154         assert(h->den >= h->num);
 155         assert(w->den >= w->num);
 156
 157         p->i_lines = height * h->num / h->den;
 158         p->i_visible_lines = (fmt->i_visible_height + (h->den - 1)) / h->den * h->num;
 159
 160         p->i_pitch = width * w->num / w->den * p_dsc->pixel_size;
 161         p->i_visible_pitch = (fmt->i_visible_width + (w->den - 1)) / w->den * w->num
 162                              * p_dsc->pixel_size;
 163         p->i_pixel_pitch = p_dsc->pixel_size;
 164
 165         assert( (p->i_pitch % 16) == 0 );
 166     }
 167     p_picture->i_planes = p_dsc->plane_count;
 168
 169     return VLC_SUCCESS;
 170 }
 171
 172 /*****************************************************************************
 173  *
 174  *****************************************************************************/
 175
 176 static picture_priv_t *picture_NewPrivate(const video_format_t *restrict p_fmt)
 177 {
 178     video_format_t fmt = *p_fmt;
 179
 180     /* It is needed to be sure all information are filled */
 181     video_format_Setup( &fmt, p_fmt->i_chroma,
 182                               p_fmt->i_width, p_fmt->i_height,
 183                               p_fmt->i_visible_width, p_fmt->i_visible_height,
 184                               p_fmt->i_sar_num, p_fmt->i_sar_den );
 185     if( p_fmt->i_x_offset < p_fmt->i_width &&
 186         p_fmt->i_y_offset < p_fmt->i_height &&
 187         p_fmt->i_visible_width  > 0 && p_fmt->i_x_offset + p_fmt->i_visible_width  <= p_fmt->i_width &&
 188         p_fmt->i_visible_height > 0 && p_fmt->i_y_offset + p_fmt->i_visible_height <= p_fmt->i_height )
 189         video_format_CopyCrop( &fmt, p_fmt );
 190
 191     /* */
 192     picture_priv_t *priv = malloc( sizeof (*priv) );
 193     if( unlikely(priv == NULL) )
 194         return NULL;
 195
 196     picture_t *p_picture = &priv->picture;
 197
 198     memset( p_picture, 0, sizeof( *p_picture ) );
 199     p_picture->format = fmt;
 200
 201     /* Make sure the real dimensions are a multiple of 16 */
 202     if( picture_Setup( p_picture, &fmt ) )
 203     {
 204         free( p_picture );
 205         return NULL;
 206     }
 207
 208     atomic_init( &priv->gc.refs, 1 );
 209     priv->gc.opaque = NULL;
 210
 211     return priv;
 212 }
 213
 214 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
 215 {
 216     assert(p_resource != NULL);
 217
 218     picture_priv_t *priv = picture_NewPrivate(p_fmt);
 219     if (unlikely(priv == NULL))
 220         return NULL;
 221
 222     picture_t *p_picture = &priv->picture;
 223
 224     p_picture->p_sys = p_resource->p_sys;
 225
 226     if( p_resource->pf_destroy != NULL )
 227         priv->gc.destroy = p_resource->pf_destroy;
 228     else
 229         priv->gc.destroy = picture_DestroyFromResource;
 230
 231     for( int i = 0; i < p_picture->i_planes; i++ )
 232     {
 233         p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
 234         p_picture->p[i].i_lines  = p_resource->p[i].i_lines;
 235         p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;
 236     }
 237
 238     return p_picture;
 239 }
 240
 241 #define PICTURE_SW_SIZE_MAX (UINT32_C(1) << 28) /* 256MB: 8K * 8K * 4*/
 242
 243 picture_t *picture_NewFromFormat(const video_format_t *restrict fmt)
 244 {
 245     picture_priv_t *priv = picture_NewPrivate(fmt);
 246     if (unlikely(priv == NULL))
 247         return NULL;
 248
 249     priv->gc.destroy = picture_Destroy;
 250
 251     picture_t *pic = &priv->picture;
 252     if (pic->i_planes == 0)
 253         return pic;
 254
 255     /* Calculate how big the new image should be */
 256     size_t plane_sizes[PICTURE_PLANE_MAX];
 257     size_t pic_size = 0;
 258
 259     for (int i = 0; i < pic->i_planes; i++)
 260     {
 261         const plane_t *p = &pic->p[i];
 262
 263         if (unlikely(mul_overflow(p->i_pitch, p->i_lines, &plane_sizes[i]))
 264          || unlikely(add_overflow(pic_size, plane_sizes[i], &pic_size)))
 265             goto error;
 266     }
 267
 268     if (unlikely(pic_size >= PICTURE_SW_SIZE_MAX))
 269         goto error;
 270
 271     uint8_t *buf = aligned_alloc(16, pic_size);
 272     if (unlikely(buf == NULL))
 273         goto error;
 274
 275     /* Fill the p_pixels field for each plane */
 276     for (int i = 0; i < pic->i_planes; i++)
 277     {
 278         pic->p[i].p_pixels = buf;
 279         buf += plane_sizes[i];
 280     }
 281
 282     return pic;
 283 error:
 284     free(pic);
 285     return NULL;
 286 }
 287
 288 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
 289 {
 290     video_format_t fmt;
 291
 292     video_format_Init( &fmt, 0 );
 293     video_format_Setup( &fmt, i_chroma, i_width, i_height,
 294                         i_width, i_height, i_sar_num, i_sar_den );
 295
 296     return picture_NewFromFormat( &fmt );
 297 }
 298
 299 /*****************************************************************************
 300  *
 301  *****************************************************************************/
 302
 303 picture_t *picture_Hold( picture_t *p_picture )
 304 {
 305     assert( p_picture != NULL );
 306
 307     picture_priv_t *priv = (picture_priv_t *)p_picture;
 308     uintptr_t refs = atomic_fetch_add( &priv->gc.refs, 1 );
 309     assert( refs > 0 );
 310     return p_picture;
 311 }
 312
 313 void picture_Release( picture_t *p_picture )
 314 {
 315     assert( p_picture != NULL );
 316
 317     picture_priv_t *priv = (picture_priv_t *)p_picture;
 318     uintptr_t refs = atomic_fetch_sub( &priv->gc.refs, 1 );
 319     assert( refs != 0 );
 320     if( refs > 1 )
 321         return;
 322
 323     PictureDestroyContext( p_picture );
 324     assert( priv->gc.destroy != NULL );
 325     priv->gc.destroy( p_picture );
 326 }
 327
 328 /*****************************************************************************
 329  *
 330  *****************************************************************************/
 331 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
 332 {
 333     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
 334                                      p_src->i_visible_pitch );
 335     const unsigned i_height = __MIN( p_dst->i_lines, p_src->i_lines );
 336
 337     /* The 2x visible pitch check does two things:
 338        1) Makes field plane_t's work correctly (see the deinterlacer module)
 339        2) Moves less data if the pitch and visible pitch differ much.
 340     */
 341     if( p_src->i_pitch == p_dst->i_pitch  &&
 342         p_src->i_pitch < 2*p_src->i_visible_pitch )
 343     {
 344         /* There are margins, but with the same width : perfect ! */
 345         memcpy( p_dst->p_pixels, p_src->p_pixels,
 346                     p_src->i_pitch * i_height );
 347     }
 348     else
 349     {
 350         /* We need to proceed line by line */
 351         uint8_t *p_in = p_src->p_pixels;
 352         uint8_t *p_out = p_dst->p_pixels;
 353
 354         assert( p_in );
 355         assert( p_out );
 356
 357         for( int i_line = i_height; i_line--; )
 358         {
 359             memcpy( p_out, p_in, i_width );
 360             p_in += p_src->i_pitch;
 361             p_out += p_dst->i_pitch;
 362         }
 363     }
 364 }
 365
 366 void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
 367 {
 368     p_dst->date = p_src->date;
 369     p_dst->b_force = p_src->b_force;
 370
 371     p_dst->b_progressive = p_src->b_progressive;
 372     p_dst->i_nb_fields = p_src->i_nb_fields;
 373     p_dst->b_top_field_first = p_src->b_top_field_first;
 374 }
 375
 376 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
 377 {
 378     for( int i = 0; i < p_src->i_planes ; i++ )
 379         plane_CopyPixels( p_dst->p+i, p_src->p+i );
 380
 381     assert( p_dst->context == NULL );
 382
 383     if( p_src->context != NULL )
 384         p_dst->context = p_src->context->copy( p_src->context );
 385 }
 386
 387 void picture_Copy( picture_t *p_dst, const picture_t *p_src )
 388 {
 389     picture_CopyPixels( p_dst, p_src );
 390     picture_CopyProperties( p_dst, p_src );
 391 }
 392
 393 static void picture_DestroyClone(picture_t *clone)
 394 {
 395     picture_t *picture = ((picture_priv_t *)clone)->gc.opaque;
 396
 397     free(clone);
 398     picture_Release(picture);
 399 }
 400
 401 picture_t *picture_Clone(picture_t *picture)
 402 {
 403     /* TODO: merge common code with picture_pool_ClonePicture(). */
 404     picture_resource_t res = {
 405         .p_sys = picture->p_sys,
 406         .pf_destroy = picture_DestroyClone,
 407     };
 408
 409     for (int i = 0; i < picture->i_planes; i++) {
 410         res.p[i].p_pixels = picture->p[i].p_pixels;
 411         res.p[i].i_lines = picture->p[i].i_lines;
 412         res.p[i].i_pitch = picture->p[i].i_pitch;
 413     }
 414
 415     picture_t *clone = picture_NewFromResource(&picture->format, &res);
 416     if (likely(clone != NULL)) {
 417         ((picture_priv_t *)clone)->gc.opaque = picture;
 418         picture_Hold(picture);
 419
 420         if (picture->context != NULL)
 421             clone->context = picture->context->copy(picture->context);
 422     }
 423     return clone;
 424 }
 425
 426 /*****************************************************************************
 427  *
 428  *****************************************************************************/
 429 int picture_Export( vlc_object_t *p_obj,
 430                     block_t **pp_image,
 431                     video_format_t *p_fmt,
 432                     picture_t *p_picture,
 433                     vlc_fourcc_t i_format,
 434                     int i_override_width, int i_override_height )
 435 {
 436     /* */
 437     video_format_t fmt_in = p_picture->format;
 438     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
 439     {
 440         fmt_in.i_sar_num =
 441         fmt_in.i_sar_den = 1;
 442     }
 443
 444     /* */
 445     video_format_t fmt_out;
 446     memset( &fmt_out, 0, sizeof(fmt_out) );
 447     fmt_out.i_sar_num =
 448     fmt_out.i_sar_den = 1;
 449     fmt_out.i_chroma  = i_format;
 450
 451     /* compute original width/height */
 452     unsigned int i_width, i_height, i_original_width, i_original_height;
 453     if( fmt_in.i_visible_width > 0 && fmt_in.i_visible_height > 0 )
 454     {
 455         i_width = fmt_in.i_visible_width;
 456         i_height = fmt_in.i_visible_height;
 457     }
 458     else
 459     {
 460         i_width = fmt_in.i_width;
 461         i_height = fmt_in.i_height;
 462     }
 463     if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
 464     {
 465         i_original_width = (int64_t)i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
 466         i_original_height = i_height;
 467     }
 468     else
 469     {
 470         i_original_width =  i_width;
 471         i_original_height = i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
 472     }
 473
 474     /* */
 475     fmt_out.i_width  = ( i_override_width < 0 ) ?
 476                        i_original_width : (unsigned)i_override_width;
 477     fmt_out.i_height = ( i_override_height < 0 ) ?
 478                        i_original_height : (unsigned)i_override_height;
 479
 480     /* scale if only one direction is provided */
 481     if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
 482     {
 483         fmt_out.i_height = i_height * fmt_out.i_width
 484                          * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
 485     }
 486     else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
 487     {
 488         fmt_out.i_width  = i_width * fmt_out.i_height
 489                          * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
 490     }
 491
 492     image_handler_t *p_image = image_HandlerCreate( p_obj );
 493     if( !p_image )
 494         return VLC_ENOMEM;
 495
 496     block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
 497
 498     image_HandlerDelete( p_image );
 499
 500     if( !p_block )
 501         return VLC_EGENERIC;
 502
 503     p_block->i_pts =
 504     p_block->i_dts = p_picture->date;
 505
 506     if( p_fmt )
 507         *p_fmt = fmt_out;
 508     *pp_image = p_block;
 509
 510     return VLC_SUCCESS;
 511 }