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