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