src/video_output/vout_pictures.c

   1 /*****************************************************************************
   2  * vout_pictures.c : picture management functions
   3  *****************************************************************************
   4  * Copyright (C) 2000-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32 #include <assert.h>
  33
  34 #include <vlc_common.h>
  35 #include <libvlc.h>
  36 #include <vlc_vout.h>
  37 #include <vlc_filter.h>
  38 #include <vlc_image.h>
  39 #include <vlc_block.h>
  40 #include <vlc_picture_fifo.h>
  41 #include <vlc_picture_pool.h>
  42
  43 #include "vout_internal.h"
  44
  45 /**
  46  * It retreives a picture from the vout or NULL if no pictures are
  47  * available yet.
  48  *
  49  * You MUST call vout_PutPicture or vout_ReleasePicture on it.
  50  *
  51  * You may use vout_HoldPicture(paired with vout_ReleasePicture) to keep a
  52  * read-only reference.
  53  */
  54 picture_t *vout_GetPicture( vout_thread_t *p_vout )
  55 {
  56     /* Get lock */
  57     vlc_mutex_lock( &p_vout->p->picture_lock );
  58     picture_t *p_pic = picture_pool_Get(p_vout->p->decoder_pool);
  59     if (p_pic) {
  60         picture_Reset(p_pic);
  61         p_pic->p_next = NULL;
  62     }
  63     vlc_mutex_unlock( &p_vout->p->picture_lock );
  64
  65     return p_pic;
  66 }
  67
  68 /**
  69  * It gives to the vout a picture to be displayed.
  70  *
  71  * The given picture MUST comes from vout_GetPicture.
  72  *
  73  * Becareful, after vout_PutPicture is called, picture_t::p_next cannot be
  74  * read/used.
  75  */
  76 void vout_PutPicture( vout_thread_t *p_vout, picture_t *p_pic )
  77 {
  78     vlc_mutex_lock( &p_vout->p->picture_lock );
  79
  80     p_pic->p_next = NULL;
  81     picture_fifo_Push(p_vout->p->decoder_fifo, p_pic);
  82
  83     vlc_mutex_unlock( &p_vout->p->picture_lock );
  84
  85     vout_control_Wake( &p_vout->p->control);
  86 }
  87
  88 /**
  89  * It releases a picture retreived by vout_GetPicture.
  90  */
  91 void vout_ReleasePicture( vout_thread_t *p_vout, picture_t *p_pic  )
  92 {
  93     vlc_mutex_lock( &p_vout->p->picture_lock );
  94
  95     picture_Release( p_pic );
  96
  97     vlc_mutex_unlock( &p_vout->p->picture_lock );
  98
  99     vout_control_Wake( &p_vout->p->control);
 100 }
 101
 102 /**
 103  * It increment the reference counter of a picture retreived by
 104  * vout_GetPicture.
 105  */
 106 void vout_HoldPicture( vout_thread_t *p_vout, picture_t *p_pic )
 107 {
 108     vlc_mutex_lock( &p_vout->p->picture_lock );
 109
 110     picture_Hold( p_pic );
 111
 112     vlc_mutex_unlock( &p_vout->p->picture_lock );
 113 }
 114
 115 /**
 116  * Allocate a new picture in the heap.
 117  *
 118  * This function allocates a fake direct buffer in memory, which can be
 119  * used exactly like a video buffer. The video output thread then manages
 120  * how it gets displayed.
 121  */
 122 static int vout_AllocatePicture( picture_t *p_pic,
 123                                  vlc_fourcc_t i_chroma,
 124                                  int i_width, int i_height,
 125                                  int i_sar_num, int i_sar_den )
 126 {
 127     /* Make sure the real dimensions are a multiple of 16 */
 128     if( picture_Setup( p_pic, i_chroma, i_width, i_height,
 129                        i_sar_num, i_sar_den ) != VLC_SUCCESS )
 130         return VLC_EGENERIC;
 131
 132     /* Calculate how big the new image should be */
 133     size_t i_bytes = 0;
 134     for( int i = 0; i < p_pic->i_planes; i++ )
 135     {
 136         const plane_t *p = &p_pic->p[i];
 137
 138         if( p->i_pitch <= 0 || p->i_lines <= 0 ||
 139             p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
 140         {
 141             p_pic->i_planes = 0;
 142             return VLC_ENOMEM;
 143         }
 144         i_bytes += p->i_pitch * p->i_lines;
 145     }
 146
 147     uint8_t *p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
 148     if( !p_data )
 149     {
 150         p_pic->i_planes = 0;
 151         return VLC_EGENERIC;
 152     }
 153
 154     /* Fill the p_pixels field for each plane */
 155     p_pic->p[0].p_pixels = p_data;
 156     for( int i = 1; i < p_pic->i_planes; i++ )
 157     {
 158         p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
 159                                                         p_pic->p[i-1].i_pitch ];
 160     }
 161
 162     return VLC_SUCCESS;
 163 }
 164
 165 /*****************************************************************************
 166  *
 167  *****************************************************************************/
 168 static void PictureReleaseCallback( picture_t *p_picture )
 169 {
 170     if( --p_picture->i_refcount > 0 )
 171         return;
 172     picture_Delete( p_picture );
 173 }
 174
 175 /*****************************************************************************
 176  *
 177  *****************************************************************************/
 178 void picture_Reset( picture_t *p_picture )
 179 {
 180     /* */
 181     p_picture->date = VLC_TS_INVALID;
 182     p_picture->b_force = false;
 183     p_picture->b_progressive = false;
 184     p_picture->i_nb_fields = 0;
 185     p_picture->b_top_field_first = false;
 186     picture_CleanupQuant( p_picture );
 187 }
 188
 189 /*****************************************************************************
 190  *
 191  *****************************************************************************/
 192 static int LCM( int a, int b )
 193 {
 194     return a * b / GCD( a, b );
 195 }
 196
 197 int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
 198                    int i_width, int i_height, int i_sar_num, int i_sar_den )
 199 {
 200     /* Store default values */
 201     p_picture->i_planes = 0;
 202     for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
 203     {
 204         plane_t *p = &p_picture->p[i];
 205         p->p_pixels = NULL;
 206         p->i_pixel_pitch = 0;
 207     }
 208
 209     p_picture->pf_release = NULL;
 210     p_picture->p_release_sys = NULL;
 211     p_picture->i_refcount = 0;
 212
 213     p_picture->i_qtype = QTYPE_NONE;
 214     p_picture->i_qstride = 0;
 215     p_picture->p_q = NULL;
 216
 217     video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
 218                         i_sar_num, i_sar_den );
 219
 220     const vlc_chroma_description_t *p_dsc =
 221         vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
 222     if( !p_dsc )
 223         return VLC_EGENERIC;
 224
 225     /* We want V (width/height) to respect:
 226         (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
 227         (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
 228        Which is respected if you have
 229        V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
 230     */
 231     int i_modulo_w = 1;
 232     int i_modulo_h = 1;
 233     int i_ratio_h  = 1;
 234     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 235     {
 236         i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.den );
 237         i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.den );
 238         if( i_ratio_h < p_dsc->p[i].h.den )
 239             i_ratio_h = p_dsc->p[i].h.den;
 240     }
 241
 242     const int i_width_aligned  = ( i_width  + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
 243     const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
 244     const int i_height_extra   = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
 245     for( unsigned i = 0; i < p_dsc->plane_count; i++ )
 246     {
 247         plane_t *p = &p_picture->p[i];
 248
 249         p->i_lines         = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.num / p_dsc->p[i].h.den;
 250         p->i_visible_lines = i_height * p_dsc->p[i].h.num / p_dsc->p[i].h.den;
 251         p->i_pitch         = i_width_aligned * p_dsc->p[i].w.num / p_dsc->p[i].w.den * p_dsc->pixel_size;
 252         p->i_visible_pitch = i_width * p_dsc->p[i].w.num / p_dsc->p[i].w.den * p_dsc->pixel_size;
 253         p->i_pixel_pitch   = p_dsc->pixel_size;
 254
 255         assert( (p->i_pitch % 16) == 0 );
 256     }
 257     p_picture->i_planes  = p_dsc->plane_count;
 258
 259     return VLC_SUCCESS;
 260 }
 261
 262 /*****************************************************************************
 263  *
 264  *****************************************************************************/
 265 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
 266 {
 267     video_format_t fmt = *p_fmt;
 268
 269     /* It is needed to be sure all information are filled */
 270     video_format_Setup( &fmt, p_fmt->i_chroma,
 271                               p_fmt->i_width, p_fmt->i_height,
 272                               p_fmt->i_sar_num, p_fmt->i_sar_den );
 273
 274     /* */
 275     picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
 276     if( !p_picture )
 277         return NULL;
 278
 279     if( p_resource )
 280     {
 281         if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
 282                            fmt.i_sar_num, fmt.i_sar_den ) )
 283         {
 284             free( p_picture );
 285             return NULL;
 286         }
 287         p_picture->p_sys = p_resource->p_sys;
 288
 289         for( int i = 0; i < p_picture->i_planes; i++ )
 290         {
 291             p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
 292             p_picture->p[i].i_lines  = p_resource->p[i].i_lines;
 293             p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;
 294         }
 295     }
 296     else
 297     {
 298         if( vout_AllocatePicture( p_picture,
 299                                   fmt.i_chroma, fmt.i_width, fmt.i_height,
 300                                   fmt.i_sar_num, fmt.i_sar_den ) )
 301         {
 302             free( p_picture );
 303             return NULL;
 304         }
 305     }
 306     /* */
 307     p_picture->format = fmt;
 308     p_picture->i_refcount = 1;
 309     p_picture->pf_release = PictureReleaseCallback;
 310
 311     return p_picture;
 312 }
 313 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
 314 {
 315     return picture_NewFromResource( p_fmt, NULL );
 316 }
 317 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
 318 {
 319     video_format_t fmt;
 320
 321     memset( &fmt, 0, sizeof(fmt) );
 322     video_format_Setup( &fmt, i_chroma, i_width, i_height,
 323                         i_sar_num, i_sar_den );
 324
 325     return picture_NewFromFormat( &fmt );
 326 }
 327
 328 /*****************************************************************************
 329  *
 330  *****************************************************************************/
 331 void picture_Delete( picture_t *p_picture )
 332 {
 333     assert( p_picture && p_picture->i_refcount == 0 );
 334     assert( p_picture->p_release_sys == NULL );
 335
 336     free( p_picture->p_q );
 337     free( p_picture->p_data_orig );
 338     free( p_picture->p_sys );
 339     free( p_picture );
 340 }
 341
 342 /*****************************************************************************
 343  *
 344  *****************************************************************************/
 345 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
 346 {
 347     int i;
 348
 349     for( i = 0; i < p_src->i_planes ; i++ )
 350         plane_CopyPixels( p_dst->p+i, p_src->p+i );
 351 }
 352
 353 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
 354 {
 355     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
 356                                      p_src->i_visible_pitch );
 357     const unsigned i_height = __MIN( p_dst->i_visible_lines,
 358                                      p_src->i_visible_lines );
 359
 360     if( p_src->i_pitch == p_dst->i_pitch )
 361     {
 362         /* There are margins, but with the same width : perfect ! */
 363         vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
 364                     p_src->i_pitch * i_height );
 365     }
 366     else
 367     {
 368         /* We need to proceed line by line */
 369         uint8_t *p_in = p_src->p_pixels;
 370         uint8_t *p_out = p_dst->p_pixels;
 371         int i_line;
 372
 373         assert( p_in );
 374         assert( p_out );
 375
 376         for( i_line = i_height; i_line--; )
 377         {
 378             vlc_memcpy( p_out, p_in, i_width );
 379             p_in += p_src->i_pitch;
 380             p_out += p_dst->i_pitch;
 381         }
 382     }
 383 }
 384
 385 /*****************************************************************************
 386  *
 387  *****************************************************************************/
 388 int picture_Export( vlc_object_t *p_obj,
 389                     block_t **pp_image,
 390                     video_format_t *p_fmt,
 391                     picture_t *p_picture,
 392                     vlc_fourcc_t i_format,
 393                     int i_override_width, int i_override_height )
 394 {
 395     /* */
 396     video_format_t fmt_in = p_picture->format;
 397     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
 398     {
 399         fmt_in.i_sar_num =
 400         fmt_in.i_sar_den = 1;
 401     }
 402
 403     /* */
 404     video_format_t fmt_out;
 405     memset( &fmt_out, 0, sizeof(fmt_out) );
 406     fmt_out.i_sar_num =
 407     fmt_out.i_sar_den = 1;
 408     fmt_out.i_chroma  = i_format;
 409
 410     /* compute original width/height */
 411     unsigned int i_original_width;
 412     unsigned int i_original_height;
 413     if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
 414     {
 415         i_original_width = fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
 416         i_original_height = fmt_in.i_height;
 417     }
 418     else
 419     {
 420         i_original_width =  fmt_in.i_width;
 421         i_original_height = fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
 422     }
 423
 424     /* */
 425     fmt_out.i_width  = ( i_override_width < 0 ) ?
 426                        i_original_width : i_override_width;
 427     fmt_out.i_height = ( i_override_height < 0 ) ?
 428                        i_original_height : i_override_height;
 429
 430     /* scale if only one direction is provided */
 431     if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
 432     {
 433         fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
 434                      * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
 435     }
 436     else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
 437     {
 438         fmt_out.i_width  = fmt_in.i_width * fmt_out.i_height
 439                      * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
 440     }
 441
 442     image_handler_t *p_image = image_HandlerCreate( p_obj );
 443
 444     block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
 445
 446     image_HandlerDelete( p_image );
 447
 448     if( !p_block )
 449         return VLC_EGENERIC;
 450
 451     p_block->i_pts =
 452     p_block->i_dts = p_picture->date;
 453
 454     if( p_fmt )
 455         *p_fmt = fmt_out;
 456     *pp_image = p_block;
 457
 458     return VLC_SUCCESS;
 459 }
 460