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