git.sesse.net Git - vlc/blob - 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
  33 #include <vlc_common.h>
  34 #include <vlc_vout.h>
  35 #include <vlc_osd.h>
  36 #include <vlc_filter.h>
  37 #include "vout_pictures.h"
  38
  39 #include <assert.h>
  40
  41 /**
  42  * Display a picture
  43  *
  44  * Remove the reservation flag of a picture, which will cause it to be ready
  45  * for display. The picture won't be displayed until vout_DatePicture has been
  46  * called.
  47  */
  48 void vout_DisplayPicture( vout_thread_t *p_vout, picture_t *p_pic )
  49 {
  50     vlc_mutex_lock( &p_vout->picture_lock );
  51     switch( p_pic->i_status )
  52     {
  53     case RESERVED_PICTURE:
  54         p_pic->i_status = RESERVED_DISP_PICTURE;
  55         break;
  56     case RESERVED_DATED_PICTURE:
  57         p_pic->i_status = READY_PICTURE;
  58         break;
  59     default:
  60         msg_Err( p_vout, "picture to display %p has invalid status %d",
  61                          p_pic, p_pic->i_status );
  62         break;
  63     }
  64
  65     vlc_mutex_unlock( &p_vout->picture_lock );
  66 }
  67
  68 /**
  69  * Date a picture
  70  *
  71  * Remove the reservation flag of a picture, which will cause it to be ready
  72  * for display. The picture won't be displayed until vout_DisplayPicture has
  73  * been called.
  74  * \param p_vout The vout in question
  75  * \param p_pic The picture to date
  76  * \param date The date to display the picture
  77  */
  78 void vout_DatePicture( vout_thread_t *p_vout,
  79                        picture_t *p_pic, mtime_t date )
  80 {
  81     vlc_mutex_lock( &p_vout->picture_lock );
  82     p_pic->date = date;
  83     switch( p_pic->i_status )
  84     {
  85     case RESERVED_PICTURE:
  86         p_pic->i_status = RESERVED_DATED_PICTURE;
  87         break;
  88     case RESERVED_DISP_PICTURE:
  89         p_pic->i_status = READY_PICTURE;
  90         break;
  91     default:
  92         msg_Err( p_vout, "picture to date %p has invalid status %d",
  93                          p_pic, p_pic->i_status );
  94         break;
  95     }
  96
  97     vlc_mutex_unlock( &p_vout->picture_lock );
  98 }
  99
 100 /**
 101  * Allocate a picture in the video output heap.
 102  *
 103  * This function creates a reserved image in the video output heap.
 104  * A null pointer is returned if the function fails. This method provides an
 105  * already allocated zone of memory in the picture data fields.
 106  * It needs locking since several pictures can be created by several producers
 107  * threads.
 108  */
 109 int vout_CountPictureAvailable( vout_thread_t *p_vout )
 110 {
 111     int i_free = 0;
 112     int i_pic;
 113
 114     vlc_mutex_lock( &p_vout->picture_lock );
 115     for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
 116     {
 117         picture_t *p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1) % I_RENDERPICTURES];
 118
 119         switch( p_pic->i_status )
 120         {
 121             case DESTROYED_PICTURE:
 122                 i_free++;
 123                 break;
 124
 125             case FREE_PICTURE:
 126                 i_free++;
 127                 break;
 128
 129             default:
 130                 break;
 131         }
 132     }
 133     vlc_mutex_unlock( &p_vout->picture_lock );
 134
 135     return i_free;
 136 }
 137
 138 picture_t *vout_CreatePicture( vout_thread_t *p_vout,
 139                                bool b_progressive,
 140                                bool b_top_field_first,
 141                                unsigned int i_nb_fields )
 142 {
 143     int         i_pic;                                      /* picture index */
 144     picture_t * p_pic;
 145     picture_t * p_freepic = NULL;                      /* first free picture */
 146
 147     /* Get lock */
 148     vlc_mutex_lock( &p_vout->picture_lock );
 149
 150     /*
 151      * Look for an empty place in the picture heap.
 152      */
 153     for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
 154     {
 155         p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1)
 156                                  % I_RENDERPICTURES];
 157
 158         switch( p_pic->i_status )
 159         {
 160             case DESTROYED_PICTURE:
 161                 /* Memory will not be reallocated, and function can end
 162                  * immediately - this is the best possible case, since no
 163                  * memory allocation needs to be done */
 164                 p_pic->i_status   = RESERVED_PICTURE;
 165                 p_pic->i_refcount = 0;
 166                 p_pic->b_force    = 0;
 167
 168                 p_pic->b_progressive        = b_progressive;
 169                 p_pic->i_nb_fields          = i_nb_fields;
 170                 p_pic->b_top_field_first    = b_top_field_first;
 171
 172                 p_vout->i_heap_size++;
 173                 p_vout->render.i_last_used_pic =
 174                     ( p_vout->render.i_last_used_pic + i_pic + 1 )
 175                     % I_RENDERPICTURES;
 176                 vlc_mutex_unlock( &p_vout->picture_lock );
 177                 return( p_pic );
 178
 179             case FREE_PICTURE:
 180                 /* Picture is empty and ready for allocation */
 181                 p_vout->render.i_last_used_pic =
 182                     ( p_vout->render.i_last_used_pic + i_pic + 1 )
 183                     % I_RENDERPICTURES;
 184                 p_freepic = p_pic;
 185                 break;
 186
 187             default:
 188                 break;
 189         }
 190     }
 191
 192     /*
 193      * Prepare picture
 194      */
 195     if( p_freepic != NULL )
 196     {
 197         vout_AllocatePicture( VLC_OBJECT(p_vout),
 198                               p_freepic, p_vout->render.i_chroma,
 199                               p_vout->render.i_width, p_vout->render.i_height,
 200                               p_vout->render.i_aspect );
 201
 202         if( p_freepic->i_planes )
 203         {
 204             /* Copy picture information, set some default values */
 205             p_freepic->i_status   = RESERVED_PICTURE;
 206             p_freepic->i_type     = MEMORY_PICTURE;
 207             p_freepic->b_slow     = 0;
 208
 209             p_freepic->i_refcount = 0;
 210             p_freepic->b_force = 0;
 211
 212             p_freepic->b_progressive        = b_progressive;
 213             p_freepic->i_nb_fields          = i_nb_fields;
 214             p_freepic->b_top_field_first    = b_top_field_first;
 215
 216             p_freepic->i_matrix_coefficients = 1;
 217
 218             p_vout->i_heap_size++;
 219         }
 220         else
 221         {
 222             /* Memory allocation failed : set picture as empty */
 223             p_freepic->i_status = FREE_PICTURE;
 224             p_freepic = NULL;
 225
 226             msg_Err( p_vout, "picture allocation failed" );
 227         }
 228
 229         vlc_mutex_unlock( &p_vout->picture_lock );
 230
 231         return( p_freepic );
 232     }
 233
 234     /* No free or destroyed picture could be found, but the decoder
 235      * will try again in a while. */
 236     vlc_mutex_unlock( &p_vout->picture_lock );
 237
 238     return( NULL );
 239 }
 240
 241 /**
 242  * Remove a permanent or reserved picture from the heap
 243  *
 244  * This function frees a previously reserved picture or a permanent
 245  * picture. It is meant to be used when the construction of a picture aborted.
 246  * Note that the picture will be destroyed even if it is linked !
 247  */
 248 void vout_DestroyPicture( vout_thread_t *p_vout, picture_t *p_pic )
 249 {
 250     vlc_mutex_lock( &p_vout->picture_lock );
 251
 252 #ifndef NDEBUG
 253     /* Check if picture status is valid */
 254     if( (p_pic->i_status != RESERVED_PICTURE) &&
 255         (p_pic->i_status != RESERVED_DATED_PICTURE) &&
 256         (p_pic->i_status != RESERVED_DISP_PICTURE) )
 257     {
 258         msg_Err( p_vout, "picture to destroy %p has invalid status %d",
 259                          p_pic, p_pic->i_status );
 260     }
 261 #endif
 262
 263     p_pic->i_status = DESTROYED_PICTURE;
 264     p_vout->i_heap_size--;
 265     picture_CleanupQuant( p_pic );
 266
 267     vlc_mutex_unlock( &p_vout->picture_lock );
 268 }
 269
 270 /**
 271  * Increment reference counter of a picture
 272  *
 273  * This function increments the reference counter of a picture in the video
 274  * heap. It needs a lock since several producer threads can access the picture.
 275  */
 276 void vout_LinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
 277 {
 278     vlc_mutex_lock( &p_vout->picture_lock );
 279     p_pic->i_refcount++;
 280     vlc_mutex_unlock( &p_vout->picture_lock );
 281 }
 282
 283 /**
 284  * Decrement reference counter of a picture
 285  *
 286  * This function decrement the reference counter of a picture in the video heap
 287  */
 288 void vout_UnlinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
 289 {
 290     vlc_mutex_lock( &p_vout->picture_lock );
 291     p_pic->i_refcount--;
 292
 293     if( ( p_pic->i_refcount == 0 ) &&
 294         ( p_pic->i_status == DISPLAYED_PICTURE ) )
 295     {
 296         p_pic->i_status = DESTROYED_PICTURE;
 297         p_vout->i_heap_size--;
 298         picture_CleanupQuant( p_pic );
 299     }
 300
 301     vlc_mutex_unlock( &p_vout->picture_lock );
 302 }
 303
 304 static int vout_LockPicture( vout_thread_t *p_vout, picture_t *p_picture )
 305 {
 306     if( p_picture->pf_lock )
 307         return p_picture->pf_lock( p_vout, p_picture );
 308     return VLC_SUCCESS;
 309 }
 310 static void vout_UnlockPicture( vout_thread_t *p_vout, picture_t *p_picture )
 311 {
 312     if( p_picture->pf_unlock )
 313         p_picture->pf_unlock( p_vout, p_picture );
 314 }
 315
 316 /**
 317  * Render a picture
 318  *
 319  * This function chooses whether the current picture needs to be copied
 320  * before rendering, does the subpicture magic, and tells the video output
 321  * thread which direct buffer needs to be displayed.
 322  */
 323 picture_t *vout_RenderPicture( vout_thread_t *p_vout, picture_t *p_pic,
 324                                subpicture_t *p_subpic )
 325 {
 326     if( p_pic == NULL )
 327         return NULL;
 328
 329     if( p_pic->i_type == DIRECT_PICTURE )
 330     {
 331         /* Picture is in a direct buffer. */
 332
 333         if( p_subpic != NULL )
 334         {
 335             /* We have subtitles. First copy the picture to
 336              * the spare direct buffer, then render the
 337              * subtitles. */
 338             if( vout_LockPicture( p_vout, PP_OUTPUTPICTURE[0] ) )
 339                 return NULL;
 340
 341             vout_CopyPicture( p_vout, PP_OUTPUTPICTURE[0], p_pic );
 342
 343             spu_RenderSubpictures( p_vout->p_spu,
 344                                    PP_OUTPUTPICTURE[0], &p_vout->fmt_out,
 345                                    p_subpic, &p_vout->fmt_in );
 346
 347             vout_UnlockPicture( p_vout, PP_OUTPUTPICTURE[0] );
 348
 349             return PP_OUTPUTPICTURE[0];
 350         }
 351
 352         /* No subtitles, picture is in a directbuffer so
 353          * we can display it directly (even if it is still
 354          * in use or not). */
 355         return p_pic;
 356     }
 357
 358     /* Not a direct buffer. We either need to copy it to a direct buffer,
 359      * or render it if the chroma isn't the same. */
 360     if( p_vout->b_direct )
 361     {
 362         /* Picture is not in a direct buffer, but is exactly the
 363          * same size as the direct buffers. A memcpy() is enough,
 364          * then render the subtitles. */
 365
 366         if( vout_LockPicture( p_vout, PP_OUTPUTPICTURE[0] ) )
 367             return NULL;
 368
 369         vout_CopyPicture( p_vout, PP_OUTPUTPICTURE[0], p_pic );
 370         spu_RenderSubpictures( p_vout->p_spu,
 371                                PP_OUTPUTPICTURE[0], &p_vout->fmt_out,
 372                                p_subpic, &p_vout->fmt_in );
 373
 374         vout_UnlockPicture( p_vout, PP_OUTPUTPICTURE[0] );
 375
 376         return PP_OUTPUTPICTURE[0];
 377     }
 378
 379     /* Picture is not in a direct buffer, and needs to be converted to
 380      * another size/chroma. Then the subtitles need to be rendered as
 381      * well. This usually means software YUV, or hardware YUV with a
 382      * different chroma. */
 383
 384     if( p_subpic != NULL && p_vout->p_picture[0].b_slow )
 385     {
 386         /* The picture buffer is in slow memory. We'll use
 387          * the "2 * VOUT_MAX_PICTURES + 1" picture as a temporary
 388          * one for subpictures rendering. */
 389         picture_t *p_tmp_pic = &p_vout->p_picture[2 * VOUT_MAX_PICTURES];
 390         if( p_tmp_pic->i_status == FREE_PICTURE )
 391         {
 392             vout_AllocatePicture( VLC_OBJECT(p_vout),
 393                                   p_tmp_pic, p_vout->fmt_out.i_chroma,
 394                                   p_vout->fmt_out.i_width,
 395                                   p_vout->fmt_out.i_height,
 396                                   p_vout->fmt_out.i_aspect );
 397             p_tmp_pic->i_type = MEMORY_PICTURE;
 398             p_tmp_pic->i_status = RESERVED_PICTURE;
 399             /* some modules (such as blend)  needs to know the extra information in picture heap */
 400             p_tmp_pic->p_heap = &p_vout->output;
 401         }
 402
 403         /* Convert image to the first direct buffer */
 404         p_vout->p_chroma->p_owner = (filter_owner_sys_t *)p_tmp_pic;
 405         p_vout->p_chroma->pf_video_filter( p_vout->p_chroma, p_pic );
 406
 407         /* Render subpictures on the first direct buffer */
 408         spu_RenderSubpictures( p_vout->p_spu,
 409                                p_tmp_pic, &p_vout->fmt_out,
 410                                p_subpic, &p_vout->fmt_in );
 411
 412         if( vout_LockPicture( p_vout, &p_vout->p_picture[0] ) )
 413             return NULL;
 414
 415         vout_CopyPicture( p_vout, &p_vout->p_picture[0], p_tmp_pic );
 416     }
 417     else
 418     {
 419         if( vout_LockPicture( p_vout, &p_vout->p_picture[0] ) )
 420             return NULL;
 421
 422         /* Convert image to the first direct buffer */
 423         p_vout->p_chroma->p_owner = (filter_owner_sys_t *)&p_vout->p_picture[0];
 424         p_vout->p_chroma->pf_video_filter( p_vout->p_chroma, p_pic );
 425
 426         /* Render subpictures on the first direct buffer */
 427         spu_RenderSubpictures( p_vout->p_spu,
 428                                &p_vout->p_picture[0], &p_vout->fmt_out,
 429                                p_subpic, &p_vout->fmt_in );
 430     }
 431
 432     vout_UnlockPicture( p_vout, &p_vout->p_picture[0] );
 433
 434     return &p_vout->p_picture[0];
 435 }
 436
 437 /**
 438  * Calculate image window coordinates
 439  *
 440  * This function will be accessed by plugins. It calculates the relative
 441  * position of the output window and the image window.
 442  */
 443 void vout_PlacePicture( vout_thread_t *p_vout,
 444                         unsigned int i_width, unsigned int i_height,
 445                         unsigned int *pi_x, unsigned int *pi_y,
 446                         unsigned int *pi_width, unsigned int *pi_height )
 447 {
 448     if( (i_width <= 0) || (i_height <=0) )
 449     {
 450         *pi_width = *pi_height = *pi_x = *pi_y = 0;
 451         return;
 452     }
 453
 454     if( p_vout->b_scale )
 455     {
 456         *pi_width = i_width;
 457         *pi_height = i_height;
 458     }
 459     else
 460     {
 461         *pi_width = __MIN( i_width, p_vout->fmt_in.i_visible_width );
 462         *pi_height = __MIN( i_height, p_vout->fmt_in.i_visible_height );
 463     }
 464
 465      int64_t i_scaled_width = p_vout->fmt_in.i_visible_width * (int64_t)p_vout->fmt_in.i_sar_num *
 466                               *pi_height / p_vout->fmt_in.i_visible_height / p_vout->fmt_in.i_sar_den;
 467      int64_t i_scaled_height = p_vout->fmt_in.i_visible_height * (int64_t)p_vout->fmt_in.i_sar_den *
 468                                *pi_width / p_vout->fmt_in.i_visible_width / p_vout->fmt_in.i_sar_num;
 469
 470     if( i_scaled_width <= 0 || i_scaled_height <= 0 )
 471     {
 472         msg_Warn( p_vout, "ignoring broken aspect ratio" );
 473         i_scaled_width = *pi_width;
 474         i_scaled_height = *pi_height;
 475     }
 476
 477     if( i_scaled_width > *pi_width )
 478         *pi_height = i_scaled_height;
 479     else
 480         *pi_width = i_scaled_width;
 481
 482     switch( p_vout->i_alignment & VOUT_ALIGN_HMASK )
 483     {
 484     case VOUT_ALIGN_LEFT:
 485         *pi_x = 0;
 486         break;
 487     case VOUT_ALIGN_RIGHT:
 488         *pi_x = i_width - *pi_width;
 489         break;
 490     default:
 491         *pi_x = ( i_width - *pi_width ) / 2;
 492     }
 493
 494     switch( p_vout->i_alignment & VOUT_ALIGN_VMASK )
 495     {
 496     case VOUT_ALIGN_TOP:
 497         *pi_y = 0;
 498         break;
 499     case VOUT_ALIGN_BOTTOM:
 500         *pi_y = i_height - *pi_height;
 501         break;
 502     default:
 503         *pi_y = ( i_height - *pi_height ) / 2;
 504     }
 505 }
 506
 507 /**
 508  * Allocate a new picture in the heap.
 509  *
 510  * This function allocates a fake direct buffer in memory, which can be
 511  * used exactly like a video buffer. The video output thread then manages
 512  * how it gets displayed.
 513  */
 514 int __vout_AllocatePicture( vlc_object_t *p_this, picture_t *p_pic,
 515                             vlc_fourcc_t i_chroma,
 516                             int i_width, int i_height, int i_aspect )
 517 {
 518     int i_bytes, i_index, i_width_aligned, i_height_aligned;
 519
 520     /* Make sure the real dimensions are a multiple of 16 */
 521     i_width_aligned = (i_width + 15) >> 4 << 4;
 522     i_height_aligned = (i_height + 15) >> 4 << 4;
 523
 524     if( vout_InitPicture( p_this, p_pic, i_chroma,
 525                           i_width, i_height, i_aspect ) != VLC_SUCCESS )
 526     {
 527         p_pic->i_planes = 0;
 528         return VLC_EGENERIC;
 529     }
 530
 531     /* Calculate how big the new image should be */
 532     i_bytes = p_pic->format.i_bits_per_pixel *
 533         i_width_aligned * i_height_aligned / 8;
 534
 535     p_pic->p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
 536
 537     if( p_pic->p_data == NULL )
 538     {
 539         p_pic->i_planes = 0;
 540         return VLC_EGENERIC;
 541     }
 542
 543     /* Fill the p_pixels field for each plane */
 544     p_pic->p[ 0 ].p_pixels = p_pic->p_data;
 545
 546     for( i_index = 1; i_index < p_pic->i_planes; i_index++ )
 547     {
 548         p_pic->p[i_index].p_pixels = p_pic->p[i_index-1].p_pixels +
 549             p_pic->p[i_index-1].i_lines * p_pic->p[i_index-1].i_pitch;
 550     }
 551
 552     return VLC_SUCCESS;
 553 }
 554
 555 /**
 556  * Initialise the video format fields given chroma/size.
 557  *
 558  * This function initializes all the video_frame_format_t fields given the
 559  * static properties of a picture (chroma and size).
 560  * \param p_format Pointer to the format structure to initialize
 561  * \param i_chroma Chroma to set
 562  * \param i_width Width to set
 563  * \param i_height Height to set
 564  * \param i_aspect Aspect ratio
 565  */
 566 void vout_InitFormat( video_frame_format_t *p_format, vlc_fourcc_t i_chroma,
 567                       int i_width, int i_height, int i_aspect )
 568 {
 569     p_format->i_chroma   = i_chroma;
 570     p_format->i_width    = p_format->i_visible_width  = i_width;
 571     p_format->i_height   = p_format->i_visible_height = i_height;
 572     p_format->i_x_offset = p_format->i_y_offset = 0;
 573     p_format->i_aspect   = i_aspect;
 574
 575 #if 0
 576     /* Assume we have square pixels */
 577     if( i_width && i_height )
 578         p_format->i_aspect = i_width * VOUT_ASPECT_FACTOR / i_height;
 579     else
 580         p_format->i_aspect = 0;
 581 #endif
 582
 583     switch( i_chroma )
 584     {
 585         case FOURCC_YUVA:
 586             p_format->i_bits_per_pixel = 32;
 587             break;
 588         case FOURCC_I444:
 589         case FOURCC_J444:
 590             p_format->i_bits_per_pixel = 24;
 591             break;
 592         case FOURCC_I422:
 593         case FOURCC_YUY2:
 594         case FOURCC_UYVY:
 595         case FOURCC_J422:
 596             p_format->i_bits_per_pixel = 16;
 597             break;
 598         case FOURCC_I440:
 599         case FOURCC_J440:
 600             p_format->i_bits_per_pixel = 16;
 601             break;
 602         case FOURCC_I411:
 603         case FOURCC_YV12:
 604         case FOURCC_I420:
 605         case FOURCC_J420:
 606         case FOURCC_IYUV:
 607             p_format->i_bits_per_pixel = 12;
 608             break;
 609         case FOURCC_I410:
 610         case FOURCC_YVU9:
 611             p_format->i_bits_per_pixel = 9;
 612             break;
 613         case FOURCC_Y211:
 614             p_format->i_bits_per_pixel = 8;
 615             break;
 616         case FOURCC_YUVP:
 617             p_format->i_bits_per_pixel = 8;
 618             break;
 619
 620         case FOURCC_RV32:
 621         case FOURCC_RGBA:
 622             p_format->i_bits_per_pixel = 32;
 623             break;
 624         case FOURCC_RV24:
 625             p_format->i_bits_per_pixel = 24;
 626             break;
 627         case FOURCC_RV15:
 628         case FOURCC_RV16:
 629             p_format->i_bits_per_pixel = 16;
 630             break;
 631         case FOURCC_RGB2:
 632             p_format->i_bits_per_pixel = 8;
 633             break;
 634
 635         case FOURCC_GREY:
 636         case FOURCC_Y800:
 637         case FOURCC_Y8:
 638         case FOURCC_RGBP:
 639             p_format->i_bits_per_pixel = 8;
 640             break;
 641
 642         default:
 643             p_format->i_bits_per_pixel = 0;
 644             break;
 645     }
 646 }
 647
 648 /**
 649  * Initialise the picture_t fields given chroma/size.
 650  *
 651  * This function initializes most of the picture_t fields given a chroma and
 652  * size. It makes the assumption that stride == width.
 653  * \param p_this The calling object
 654  * \param p_pic Pointer to the picture to initialize
 655  * \param i_chroma The chroma fourcc to set
 656  * \param i_width The width of the picture
 657  * \param i_height The height of the picture
 658  * \param i_aspect The aspect ratio of the picture
 659  */
 660 int __vout_InitPicture( vlc_object_t *p_this, picture_t *p_pic,
 661                         vlc_fourcc_t i_chroma,
 662                         int i_width, int i_height, int i_aspect )
 663 {
 664     int i_index, i_width_aligned, i_height_aligned;
 665
 666     /* Store default values */
 667     for( i_index = 0; i_index < VOUT_MAX_PLANES; i_index++ )
 668     {
 669         p_pic->p[i_index].p_pixels = NULL;
 670         p_pic->p[i_index].i_pixel_pitch = 1;
 671     }
 672
 673     p_pic->pf_release = NULL;
 674     p_pic->pf_lock = NULL;
 675     p_pic->pf_unlock = NULL;
 676     p_pic->i_refcount = 0;
 677
 678     p_pic->p_q = NULL;
 679     p_pic->i_qstride = 0;
 680     p_pic->i_qtype = 0;
 681
 682     vout_InitFormat( &p_pic->format, i_chroma, i_width, i_height, i_aspect );
 683
 684     /* Make sure the real dimensions are a multiple of 16 */
 685     i_width_aligned = (i_width + 15) >> 4 << 4;
 686     i_height_aligned = (i_height + 15) >> 4 << 4;
 687
 688     /* Calculate coordinates */
 689     switch( i_chroma )
 690     {
 691         case FOURCC_I411:
 692             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 693             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 694             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 695             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 696             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
 697             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
 698             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 4;
 699             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 4;
 700             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
 701             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
 702             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 4;
 703             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 4;
 704             p_pic->i_planes = 3;
 705             break;
 706
 707         case FOURCC_I410:
 708         case FOURCC_YVU9:
 709             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 710             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 711             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 712             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 713             p_pic->p[ U_PLANE ].i_lines = i_height_aligned / 4;
 714             p_pic->p[ U_PLANE ].i_visible_lines = i_height / 4;
 715             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 4;
 716             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 4;
 717             p_pic->p[ V_PLANE ].i_lines = i_height_aligned / 4;
 718             p_pic->p[ V_PLANE ].i_visible_lines = i_height / 4;
 719             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 4;
 720             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 4;
 721             p_pic->i_planes = 3;
 722             break;
 723
 724         case FOURCC_YV12:
 725         case FOURCC_I420:
 726         case FOURCC_IYUV:
 727         case FOURCC_J420:
 728             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 729             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 730             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 731             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 732             p_pic->p[ U_PLANE ].i_lines = i_height_aligned / 2;
 733             p_pic->p[ U_PLANE ].i_visible_lines = i_height / 2;
 734             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 2;
 735             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 2;
 736             p_pic->p[ V_PLANE ].i_lines = i_height_aligned / 2;
 737             p_pic->p[ V_PLANE ].i_visible_lines = i_height / 2;
 738             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 2;
 739             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 2;
 740             p_pic->i_planes = 3;
 741             break;
 742
 743         case FOURCC_I422:
 744         case FOURCC_J422:
 745             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 746             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 747             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 748             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 749             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
 750             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
 751             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned / 2;
 752             p_pic->p[ U_PLANE ].i_visible_pitch = i_width / 2;
 753             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
 754             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
 755             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned / 2;
 756             p_pic->p[ V_PLANE ].i_visible_pitch = i_width / 2;
 757             p_pic->i_planes = 3;
 758             break;
 759
 760         case FOURCC_I440:
 761         case FOURCC_J440:
 762             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 763             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 764             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 765             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 766             p_pic->p[ U_PLANE ].i_lines = i_height_aligned / 2;
 767             p_pic->p[ U_PLANE ].i_visible_lines = i_height / 2;
 768             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned;
 769             p_pic->p[ U_PLANE ].i_visible_pitch = i_width;
 770             p_pic->p[ V_PLANE ].i_lines = i_height_aligned / 2;
 771             p_pic->p[ V_PLANE ].i_visible_lines = i_height / 2;
 772             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned;
 773             p_pic->p[ V_PLANE ].i_visible_pitch = i_width;
 774             p_pic->i_planes = 3;
 775             break;
 776
 777         case FOURCC_I444:
 778         case FOURCC_J444:
 779             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 780             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 781             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 782             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 783             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
 784             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
 785             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned;
 786             p_pic->p[ U_PLANE ].i_visible_pitch = i_width;
 787             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
 788             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
 789             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned;
 790             p_pic->p[ V_PLANE ].i_visible_pitch = i_width;
 791             p_pic->i_planes = 3;
 792             break;
 793
 794         case FOURCC_YUVA:
 795             p_pic->p[ Y_PLANE ].i_lines = i_height_aligned;
 796             p_pic->p[ Y_PLANE ].i_visible_lines = i_height;
 797             p_pic->p[ Y_PLANE ].i_pitch = i_width_aligned;
 798             p_pic->p[ Y_PLANE ].i_visible_pitch = i_width;
 799             p_pic->p[ U_PLANE ].i_lines = i_height_aligned;
 800             p_pic->p[ U_PLANE ].i_visible_lines = i_height;
 801             p_pic->p[ U_PLANE ].i_pitch = i_width_aligned;
 802             p_pic->p[ U_PLANE ].i_visible_pitch = i_width;
 803             p_pic->p[ V_PLANE ].i_lines = i_height_aligned;
 804             p_pic->p[ V_PLANE ].i_visible_lines = i_height;
 805             p_pic->p[ V_PLANE ].i_pitch = i_width_aligned;
 806             p_pic->p[ V_PLANE ].i_visible_pitch = i_width;
 807             p_pic->p[ A_PLANE ].i_lines = i_height_aligned;
 808             p_pic->p[ A_PLANE ].i_visible_lines = i_height;
 809             p_pic->p[ A_PLANE ].i_pitch = i_width_aligned;
 810             p_pic->p[ A_PLANE ].i_visible_pitch = i_width;
 811             p_pic->i_planes = 4;
 812             break;
 813
 814         case FOURCC_YUVP:
 815             p_pic->p->i_lines = i_height_aligned;
 816             p_pic->p->i_visible_lines = i_height;
 817             p_pic->p->i_pitch = i_width_aligned;
 818             p_pic->p->i_visible_pitch = i_width;
 819             p_pic->p->i_pixel_pitch = 8;
 820             p_pic->i_planes = 1;
 821             break;
 822
 823         case FOURCC_Y211:
 824             p_pic->p->i_lines = i_height_aligned;
 825             p_pic->p->i_visible_lines = i_height;
 826             p_pic->p->i_pitch = i_width_aligned;
 827             p_pic->p->i_visible_pitch = i_width;
 828             p_pic->p->i_pixel_pitch = 4;
 829             p_pic->i_planes = 1;
 830             break;
 831
 832         case FOURCC_UYVY:
 833         case FOURCC_YUY2:
 834             p_pic->p->i_lines = i_height_aligned;
 835             p_pic->p->i_visible_lines = i_height;
 836             p_pic->p->i_pitch = i_width_aligned * 2;
 837             p_pic->p->i_visible_pitch = i_width * 2;
 838             p_pic->p->i_pixel_pitch = 4;
 839             p_pic->i_planes = 1;
 840             break;
 841
 842         case FOURCC_RGB2:
 843             p_pic->p->i_lines = i_height_aligned;
 844             p_pic->p->i_visible_lines = i_height;
 845             p_pic->p->i_pitch = i_width_aligned;
 846             p_pic->p->i_visible_pitch = i_width;
 847             p_pic->p->i_pixel_pitch = 1;
 848             p_pic->i_planes = 1;
 849             break;
 850
 851         case FOURCC_RV15:
 852             p_pic->p->i_lines = i_height_aligned;
 853             p_pic->p->i_visible_lines = i_height;
 854             p_pic->p->i_pitch = i_width_aligned * 2;
 855             p_pic->p->i_visible_pitch = i_width * 2;
 856             p_pic->p->i_pixel_pitch = 2;
 857             p_pic->i_planes = 1;
 858             break;
 859
 860         case FOURCC_RV16:
 861             p_pic->p->i_lines = i_height_aligned;
 862             p_pic->p->i_visible_lines = i_height;
 863             p_pic->p->i_pitch = i_width_aligned * 2;
 864             p_pic->p->i_visible_pitch = i_width * 2;
 865             p_pic->p->i_pixel_pitch = 2;
 866             p_pic->i_planes = 1;
 867             break;
 868
 869         case FOURCC_RV24:
 870             p_pic->p->i_lines = i_height_aligned;
 871             p_pic->p->i_visible_lines = i_height;
 872             p_pic->p->i_pitch = i_width_aligned * 3;
 873             p_pic->p->i_visible_pitch = i_width * 3;
 874             p_pic->p->i_pixel_pitch = 3;
 875             p_pic->i_planes = 1;
 876             break;
 877
 878         case FOURCC_RV32:
 879         case FOURCC_RGBA:
 880             p_pic->p->i_lines = i_height_aligned;
 881             p_pic->p->i_visible_lines = i_height;
 882             p_pic->p->i_pitch = i_width_aligned * 4;
 883             p_pic->p->i_visible_pitch = i_width * 4;
 884             p_pic->p->i_pixel_pitch = 4;
 885             p_pic->i_planes = 1;
 886             break;
 887
 888         case FOURCC_GREY:
 889         case FOURCC_Y800:
 890         case FOURCC_Y8:
 891         case FOURCC_RGBP:
 892             p_pic->p->i_lines = i_height_aligned;
 893             p_pic->p->i_visible_lines = i_height;
 894             p_pic->p->i_pitch = i_width_aligned;
 895             p_pic->p->i_visible_pitch = i_width;
 896             p_pic->p->i_pixel_pitch = 1;
 897             p_pic->i_planes = 1;
 898             break;
 899
 900         default:
 901             if( p_this )
 902                 msg_Err( p_this, "unknown chroma type 0x%.8x (%4.4s)",
 903                                  i_chroma, (char*)&i_chroma );
 904             p_pic->i_planes = 0;
 905             return VLC_EGENERIC;
 906     }
 907
 908     return VLC_SUCCESS;
 909 }
 910
 911 /**
 912  * Compare two chroma values
 913  *
 914  * This function returns 1 if the two fourcc values given as argument are
 915  * the same format (eg. UYVY/UYNV) or almost the same format (eg. I420/YV12)
 916  */
 917 int vout_ChromaCmp( vlc_fourcc_t i_chroma, vlc_fourcc_t i_amorhc )
 918 {
 919     /* If they are the same, they are the same ! */
 920     if( i_chroma == i_amorhc )
 921     {
 922         return 1;
 923     }
 924
 925     /* Check for equivalence classes */
 926     switch( i_chroma )
 927     {
 928         case FOURCC_I420:
 929         case FOURCC_IYUV:
 930         case FOURCC_YV12:
 931             switch( i_amorhc )
 932             {
 933                 case FOURCC_I420:
 934                 case FOURCC_IYUV:
 935                 case FOURCC_YV12:
 936                     return 1;
 937
 938                 default:
 939                     return 0;
 940             }
 941
 942         case FOURCC_UYVY:
 943         case FOURCC_UYNV:
 944         case FOURCC_Y422:
 945             switch( i_amorhc )
 946             {
 947                 case FOURCC_UYVY:
 948                 case FOURCC_UYNV:
 949                 case FOURCC_Y422:
 950                     return 1;
 951
 952                 default:
 953                     return 0;
 954             }
 955
 956         case FOURCC_YUY2:
 957         case FOURCC_YUNV:
 958             switch( i_amorhc )
 959             {
 960                 case FOURCC_YUY2:
 961                 case FOURCC_YUNV:
 962                     return 1;
 963
 964                 default:
 965                     return 0;
 966             }
 967
 968         case FOURCC_GREY:
 969         case FOURCC_Y800:
 970         case FOURCC_Y8:
 971             switch( i_amorhc )
 972             {
 973                 case FOURCC_GREY:
 974                 case FOURCC_Y800:
 975                 case FOURCC_Y8:
 976                     return 1;
 977
 978                 default:
 979                     return 0;
 980             }
 981
 982         default:
 983             return 0;
 984     }
 985 }
 986
 987 /*****************************************************************************
 988  * vout_CopyPicture: copy a picture to another one
 989  *****************************************************************************
 990  * This function takes advantage of the image format, and reduces the
 991  * number of calls to memcpy() to the minimum. Source and destination
 992  * images must have same width (hence i_visible_pitch), height, and chroma.
 993  *****************************************************************************/
 994 void __vout_CopyPicture( vlc_object_t *p_this,
 995                          picture_t *p_dest, picture_t *p_src )
 996 {
 997     VLC_UNUSED(p_this);
 998     picture_Copy( p_dest, p_src );
 999 }
1000
1001 /*****************************************************************************
1002  *
1003  *****************************************************************************/
1004 static void PictureReleaseCallback( picture_t *p_picture )
1005 {
1006     if( --p_picture->i_refcount > 0 )
1007         return;
1008     picture_Delete( p_picture );
1009 }
1010 /*****************************************************************************
1011  *
1012  *****************************************************************************/
1013 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect )
1014 {
1015     picture_t *p_picture = malloc( sizeof(*p_picture) );
1016
1017     if( !p_picture )
1018         return NULL;
1019
1020     memset( p_picture, 0, sizeof(*p_picture) );
1021     if( __vout_AllocatePicture( NULL, p_picture,
1022                                 i_chroma, i_width, i_height, i_aspect ) )
1023     {
1024         free( p_picture );
1025         return NULL;
1026     }
1027
1028     p_picture->i_refcount = 1;
1029     p_picture->pf_release = PictureReleaseCallback;
1030     p_picture->i_status = RESERVED_PICTURE;
1031
1032     return p_picture;
1033 }
1034
1035 /*****************************************************************************
1036  *
1037  *****************************************************************************/
1038 void picture_Delete( picture_t *p_picture )
1039 {
1040     assert( p_picture && p_picture->i_refcount == 0 );
1041
1042     free( p_picture->p_q );
1043     free( p_picture->p_data_orig );
1044     free( p_picture->p_sys );
1045     free( p_picture );
1046 }
1047
1048 /*****************************************************************************
1049  *
1050  *****************************************************************************/
1051 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
1052 {
1053     int i;
1054
1055     for( i = 0; i < p_src->i_planes ; i++ )
1056         plane_CopyPixels( p_dst->p+i, p_src->p+i );
1057 }
1058
1059 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
1060 {
1061     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
1062                                      p_src->i_visible_pitch );
1063     const unsigned i_height = __MIN( p_dst->i_visible_lines,
1064                                      p_src->i_visible_lines );
1065
1066     if( p_src->i_pitch == p_dst->i_pitch )
1067     {
1068         /* There are margins, but with the same width : perfect ! */
1069         vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
1070                     p_src->i_pitch * i_height );
1071     }
1072     else
1073     {
1074         /* We need to proceed line by line */
1075         uint8_t *p_in = p_src->p_pixels;
1076         uint8_t *p_out = p_dst->p_pixels;
1077         int i_line;
1078
1079         assert( p_in );
1080         assert( p_out );
1081
1082         for( i_line = i_height; i_line--; )
1083         {
1084             vlc_memcpy( p_out, p_in, i_width );
1085             p_in += p_src->i_pitch;
1086             p_out += p_dst->i_pitch;
1087         }
1088     }
1089 }
1090
1091 /*****************************************************************************
1092  *
1093  *****************************************************************************/
1094