git.sesse.net Git - vlc/blob - 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 <vlc_picture.h>
  38 #include <vlc_image.h>
  39 #include <vlc_block.h>
  40 #include <vlc_atomic.h>
  41
  42 /**
  43  * Allocate a new picture in the heap.
  44  *
  45  * This function allocates a fake direct buffer in memory, which can be
  46  * used exactly like a video buffer. The video output thread then manages
  47  * how it gets displayed.
  48  */
  49 static int AllocatePicture( picture_t *p_pic )
  50 {
  51     /* Calculate how big the new image should be */
  52     size_t i_bytes = 0;
  53     for( int i = 0; i < p_pic->i_planes; i++ )
  54     {
  55         const plane_t *p = &p_pic->p[i];
  56
  57         if( p->i_pitch < 0 || p->i_lines <= 0 ||
  58             (size_t)p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
  59         {
  60             p_pic->i_planes = 0;
  61             return VLC_ENOMEM;
  62         }
  63         i_bytes += p->i_pitch * p->i_lines;
  64     }
  65
  66     uint8_t *p_data = vlc_memalign( 16, i_bytes );
  67     if( i_bytes > 0 && p_data == NULL )
  68     {
  69         p_pic->i_planes = 0;
  70         return VLC_EGENERIC;
  71     }
  72     p_pic->gc.p_sys = (void *)p_data;
  73
  74     /* Fill the p_pixels field for each plane */
  75     p_pic->p[0].p_pixels = p_data;
  76     for( int i = 1; i < p_pic->i_planes; i++ )
  77     {
  78         p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
  79                                                         p_pic->p[i-1].i_pitch ];
  80     }
  81
  82     return VLC_SUCCESS;
  83 }
  84
  85 /*****************************************************************************
  86  *
  87  *****************************************************************************/
  88
  89 static void PictureDestroyContext( picture_t *p_picture )
  90 {
  91     void (**context)( void * ) = p_picture->context;
  92     if( context != NULL )
  93     {
  94         void (*context_destroy)( void * ) = *context;
  95         context_destroy( context );
  96         p_picture->context = NULL;
  97     }
  98 }
  99
 100 static void PictureDestroy( picture_t *p_picture )
 101 {
 102     assert( p_picture &&
 103             vlc_atomic_get( &p_picture->gc.refcount ) == 0 );
 104
 105     vlc_free( p_picture->gc.p_sys );
 106     free( p_picture->p_sys );
 107     free( p_picture );
 108 }
 109
 110 /*****************************************************************************
 111  *
 112  *****************************************************************************/
 113 void picture_Reset( picture_t *p_picture )
 114 {
 115     /* */
 116     p_picture->date = VLC_TS_INVALID;
 117     p_picture->b_force = false;
 118     p_picture->b_progressive = false;
 119     p_picture->i_nb_fields = 2;
 120     p_picture->b_top_field_first = false;
 121     PictureDestroyContext( p_picture );
 122 }
 123
 124 /*****************************************************************************
 125  *
 126  *****************************************************************************/
 127 static int LCM( int a, int b )
 128 {
 129     return a * b / GCD( a, b );
 130 }
 131
 132 int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
 133                    int i_width, int i_height, int i_sar_num, int i_sar_den )
 134 {
 135     /* Store default values */
 136     p_picture->i_planes = 0;
 137     for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
 138     {
 139         plane_t *p = &p_picture->p[i];
 140         p->p_pixels = NULL;
 141         p->i_pixel_pitch = 0;
 142     }
 143
 144     vlc_atomic_set( &p_picture->gc.refcount, 0 );
 145     p_picture->gc.pf_destroy = NULL;
 146     p_picture->gc.p_sys = NULL;
 147
 148     p_picture->i_nb_fields = 2;
 149
 150     video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
 151                         i_sar_num, i_sar_den );
 152
 153     const vlc_chroma_description_t *p_dsc =
 154         vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
 155     if( !p_dsc )
 156         return VLC_EGENERIC;
 157
 158     /* We want V (width/height) to respect:
 159         (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
 160         (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
 161        Which is respected if you have
 162        V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
 163     */
 164     int i_modulo_w = 1;
 165     int i_modulo_h = 1;
 166     unsigned int i_ratio_h  = 1;
 167     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 168     {
 169         i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.den );
 170         i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.den );
 171         if( i_ratio_h < p_dsc->p[i].h.den )
 172             i_ratio_h = p_dsc->p[i].h.den;
 173     }
 174     i_modulo_h = LCM( i_modulo_h, 32 );
 175
 176     const int i_width_aligned  = ( i_width  + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
 177     const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
 178     const int i_height_extra   = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
 179     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 180     {
 181         plane_t *p = &p_picture->p[i];
 182
 183         p->i_lines         = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.num / p_dsc->p[i].h.den;
 184         p->i_visible_lines = i_height * p_dsc->p[i].h.num / p_dsc->p[i].h.den;
 185         p->i_pitch         = i_width_aligned * p_dsc->p[i].w.num / p_dsc->p[i].w.den * p_dsc->pixel_size;
 186         p->i_visible_pitch = i_width * p_dsc->p[i].w.num / p_dsc->p[i].w.den * p_dsc->pixel_size;
 187         p->i_pixel_pitch   = p_dsc->pixel_size;
 188
 189         assert( (p->i_pitch % 16) == 0 );
 190     }
 191     p_picture->i_planes  = p_dsc->plane_count;
 192
 193     return VLC_SUCCESS;
 194 }
 195
 196 /*****************************************************************************
 197  *
 198  *****************************************************************************/
 199 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
 200 {
 201     video_format_t fmt = *p_fmt;
 202
 203     /* It is needed to be sure all information are filled */
 204     video_format_Setup( &fmt, p_fmt->i_chroma,
 205                               p_fmt->i_width, p_fmt->i_height,
 206                               p_fmt->i_sar_num, p_fmt->i_sar_den );
 207     if( p_fmt->i_x_offset < p_fmt->i_width &&
 208         p_fmt->i_y_offset < p_fmt->i_height &&
 209         p_fmt->i_visible_width  > 0 && p_fmt->i_x_offset + p_fmt->i_visible_width  <= p_fmt->i_width &&
 210         p_fmt->i_visible_height > 0 && p_fmt->i_y_offset + p_fmt->i_visible_height <= p_fmt->i_height )
 211         video_format_CopyCrop( &fmt, p_fmt );
 212
 213     /* */
 214     picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
 215     if( !p_picture )
 216         return NULL;
 217
 218     /* Make sure the real dimensions are a multiple of 16 */
 219     if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
 220                        fmt.i_sar_num, fmt.i_sar_den ) )
 221     {
 222         free( p_picture );
 223         return NULL;
 224     }
 225
 226     if( p_resource )
 227     {
 228         p_picture->p_sys = p_resource->p_sys;
 229         assert( p_picture->gc.p_sys == NULL );
 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     else
 239     {
 240         if( AllocatePicture( p_picture ) )
 241         {
 242             free( p_picture );
 243             return NULL;
 244         }
 245         assert( p_picture->gc.p_sys != NULL );
 246     }
 247     /* */
 248     p_picture->format = fmt;
 249
 250     vlc_atomic_set( &p_picture->gc.refcount, 1 );
 251     p_picture->gc.pf_destroy = PictureDestroy;
 252
 253     return p_picture;
 254 }
 255 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
 256 {
 257     return picture_NewFromResource( p_fmt, NULL );
 258 }
 259 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
 260 {
 261     video_format_t fmt;
 262
 263     memset( &fmt, 0, sizeof(fmt) );
 264     video_format_Setup( &fmt, i_chroma, i_width, i_height,
 265                         i_sar_num, i_sar_den );
 266
 267     return picture_NewFromFormat( &fmt );
 268 }
 269
 270 /*****************************************************************************
 271  *
 272  *****************************************************************************/
 273
 274 picture_t *picture_Hold( picture_t *p_picture )
 275 {
 276     vlc_atomic_inc( &p_picture->gc.refcount );
 277     return p_picture;
 278 }
 279
 280 void picture_Release( picture_t *p_picture )
 281 {
 282     uintptr_t refs = vlc_atomic_dec( &p_picture->gc.refcount );
 283     assert( refs != (uintptr_t)-1 );
 284     if( refs > 0 )
 285         return;
 286
 287     PictureDestroyContext( p_picture );
 288     if( p_picture->gc.pf_destroy != NULL )
 289         p_picture->gc.pf_destroy( p_picture );
 290 }
 291
 292 bool picture_IsReferenced( picture_t *p_picture )
 293 {
 294     return vlc_atomic_get( &p_picture->gc.refcount ) > 1;
 295 }
 296
 297 /*****************************************************************************
 298  *
 299  *****************************************************************************/
 300 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
 301 {
 302     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
 303                                      p_src->i_visible_pitch );
 304     const unsigned i_height = __MIN( p_dst->i_visible_lines,
 305                                      p_src->i_visible_lines );
 306
 307     /* The 2x visible pitch check does two things:
 308        1) Makes field plane_t's work correctly (see the deinterlacer module)
 309        2) Moves less data if the pitch and visible pitch differ much.
 310     */
 311     if( p_src->i_pitch == p_dst->i_pitch  &&
 312         p_src->i_pitch < 2*p_src->i_visible_pitch )
 313     {
 314         /* There are margins, but with the same width : perfect ! */
 315         memcpy( p_dst->p_pixels, p_src->p_pixels,
 316                     p_src->i_pitch * i_height );
 317     }
 318     else
 319     {
 320         /* We need to proceed line by line */
 321         uint8_t *p_in = p_src->p_pixels;
 322         uint8_t *p_out = p_dst->p_pixels;
 323         int i_line;
 324
 325         assert( p_in );
 326         assert( p_out );
 327
 328         for( i_line = i_height; i_line--; )
 329         {
 330             memcpy( p_out, p_in, i_width );
 331             p_in += p_src->i_pitch;
 332             p_out += p_dst->i_pitch;
 333         }
 334     }
 335 }
 336
 337 void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
 338 {
 339     p_dst->date = p_src->date;
 340     p_dst->b_force = p_src->b_force;
 341
 342     p_dst->b_progressive = p_src->b_progressive;
 343     p_dst->i_nb_fields = p_src->i_nb_fields;
 344     p_dst->b_top_field_first = p_src->b_top_field_first;
 345 }
 346
 347 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
 348 {
 349     int i;
 350
 351     for( i = 0; i < p_src->i_planes ; i++ )
 352         plane_CopyPixels( p_dst->p+i, p_src->p+i );
 353 }
 354
 355 void picture_Copy( picture_t *p_dst, const picture_t *p_src )
 356 {
 357     picture_CopyPixels( p_dst, p_src );
 358     picture_CopyProperties( p_dst, p_src );
 359 }
 360
 361
 362 /*****************************************************************************
 363  *
 364  *****************************************************************************/
 365 int picture_Export( vlc_object_t *p_obj,
 366                     block_t **pp_image,
 367                     video_format_t *p_fmt,
 368                     picture_t *p_picture,
 369                     vlc_fourcc_t i_format,
 370                     int i_override_width, int i_override_height )
 371 {
 372     /* */
 373     video_format_t fmt_in = p_picture->format;
 374     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
 375     {
 376         fmt_in.i_sar_num =
 377         fmt_in.i_sar_den = 1;
 378     }
 379
 380     /* */
 381     video_format_t fmt_out;
 382     memset( &fmt_out, 0, sizeof(fmt_out) );
 383     fmt_out.i_sar_num =
 384     fmt_out.i_sar_den = 1;
 385     fmt_out.i_chroma  = i_format;
 386
 387     /* compute original width/height */
 388     unsigned int i_original_width;
 389     unsigned int i_original_height;
 390     if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
 391     {
 392         i_original_width = (int64_t)fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
 393         i_original_height = fmt_in.i_height;
 394     }
 395     else
 396     {
 397         i_original_width =  fmt_in.i_width;
 398         i_original_height = (int64_t)fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
 399     }
 400
 401     /* */
 402     fmt_out.i_width  = ( i_override_width < 0 ) ?
 403                        i_original_width : (unsigned)i_override_width;
 404     fmt_out.i_height = ( i_override_height < 0 ) ?
 405                        i_original_height : (unsigned)i_override_height;
 406
 407     /* scale if only one direction is provided */
 408     if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
 409     {
 410         fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
 411                      * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
 412     }
 413     else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
 414     {
 415         fmt_out.i_width  = fmt_in.i_width * fmt_out.i_height
 416                      * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
 417     }
 418
 419     image_handler_t *p_image = image_HandlerCreate( p_obj );
 420
 421     block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
 422
 423     image_HandlerDelete( p_image );
 424
 425     if( !p_block )
 426         return VLC_EGENERIC;
 427
 428     p_block->i_pts =
 429     p_block->i_dts = p_picture->date;
 430
 431     if( p_fmt )
 432         *p_fmt = fmt_out;
 433     *pp_image = p_block;
 434
 435     return VLC_SUCCESS;
 436 }
 437
 438 void picture_BlendSubpicture(picture_t *dst,
 439                              filter_t *blend, subpicture_t *src)
 440 {
 441     assert(src && !src->b_fade && src->b_absolute);
 442
 443     for (subpicture_region_t *r = src->p_region; r != NULL; r = r->p_next) {
 444         assert(r->p_picture && r->i_align == 0);
 445         if (filter_ConfigureBlend(blend, dst->format.i_width, dst->format.i_height,
 446                                   &r->fmt) ||
 447             filter_Blend(blend, dst,
 448                          r->i_x, r->i_y, r->p_picture,
 449                          src->i_alpha * r->i_alpha / 255)) {
 450             msg_Err(blend, "blending %4.4s to %4.4s failed",
 451                     (char *)&blend->fmt_in.video.i_chroma,
 452                     (char *)&blend->fmt_out.video.i_chroma );
 453         }
 454     }
 455 }