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 #include <assert.h>
  33
  34 #include <vlc_common.h>
  35 #include <libvlc.h>
  36 #include <vlc_vout.h>
  37 #include <vlc_osd.h>
  38 #include <vlc_filter.h>
  39 #include <vlc_image.h>
  40 #include <vlc_block.h>
  41 #include <vlc_picture_fifo.h>
  42 #include <vlc_picture_pool.h>
  43
  44 #include "vout_pictures.h"
  45 #include "vout_internal.h"
  46
  47 /**
  48  * Display a picture
  49  *
  50  * Remove the reservation flag of a picture, which will cause it to be ready
  51  * for display.
  52  */
  53 void vout_DisplayPicture( vout_thread_t *p_vout, picture_t *p_pic )
  54 {
  55     vlc_mutex_lock( &p_vout->picture_lock );
  56
  57     if( p_pic->i_status == RESERVED_PICTURE )
  58     {
  59         p_pic->i_status = READY_PICTURE;
  60         vlc_cond_signal( &p_vout->p->picture_wait );
  61     }
  62     else
  63     {
  64         msg_Err( p_vout, "picture to display %p has invalid status %d",
  65                          p_pic, p_pic->i_status );
  66     }
  67     p_vout->p->i_picture_qtype = p_pic->i_qtype;
  68     p_vout->p->b_picture_interlaced = !p_pic->b_progressive;
  69
  70     vlc_mutex_unlock( &p_vout->picture_lock );
  71 }
  72
  73 /**
  74  * Allocate a picture in the video output heap.
  75  *
  76  * This function creates a reserved image in the video output heap.
  77  * A null pointer is returned if the function fails. This method provides an
  78  * already allocated zone of memory in the picture data fields.
  79  * It needs locking since several pictures can be created by several producers
  80  * threads.
  81  */
  82 int vout_CountPictureAvailable( vout_thread_t *p_vout )
  83 {
  84     int i_free = 0;
  85     int i_pic;
  86
  87     vlc_mutex_lock( &p_vout->picture_lock );
  88     for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
  89     {
  90         picture_t *p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1) % I_RENDERPICTURES];
  91
  92         switch( p_pic->i_status )
  93         {
  94             case DESTROYED_PICTURE:
  95                 i_free++;
  96                 break;
  97
  98             case FREE_PICTURE:
  99                 i_free++;
 100                 break;
 101
 102             default:
 103                 break;
 104         }
 105     }
 106     vlc_mutex_unlock( &p_vout->picture_lock );
 107
 108     return i_free;
 109 }
 110
 111 picture_t *vout_CreatePicture( vout_thread_t *p_vout,
 112                                bool b_progressive,
 113                                bool b_top_field_first,
 114                                unsigned int i_nb_fields )
 115 {
 116     int         i_pic;                                      /* picture index */
 117     picture_t * p_pic;
 118     picture_t * p_freepic = NULL;                      /* first free picture */
 119
 120     /* Get lock */
 121     vlc_mutex_lock( &p_vout->picture_lock );
 122
 123     /*
 124      * Look for an empty place in the picture heap.
 125      */
 126     for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
 127     {
 128         p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1)
 129                                  % I_RENDERPICTURES];
 130
 131         switch( p_pic->i_status )
 132         {
 133             case DESTROYED_PICTURE:
 134                 /* Memory will not be reallocated, and function can end
 135                  * immediately - this is the best possible case, since no
 136                  * memory allocation needs to be done */
 137                 p_pic->i_status   = RESERVED_PICTURE;
 138                 p_pic->i_refcount = 0;
 139                 p_pic->b_force    = 0;
 140
 141                 p_pic->b_progressive        = b_progressive;
 142                 p_pic->i_nb_fields          = i_nb_fields;
 143                 p_pic->b_top_field_first    = b_top_field_first;
 144
 145                 p_vout->i_heap_size++;
 146                 p_vout->render.i_last_used_pic =
 147                     ( p_vout->render.i_last_used_pic + i_pic + 1 )
 148                     % I_RENDERPICTURES;
 149                 vlc_mutex_unlock( &p_vout->picture_lock );
 150                 return( p_pic );
 151
 152             case FREE_PICTURE:
 153                 /* Picture is empty and ready for allocation */
 154                 p_vout->render.i_last_used_pic =
 155                     ( p_vout->render.i_last_used_pic + i_pic + 1 )
 156                     % I_RENDERPICTURES;
 157                 p_freepic = p_pic;
 158                 break;
 159
 160             default:
 161                 break;
 162         }
 163     }
 164
 165     /*
 166      * Prepare picture
 167      */
 168     if( p_freepic != NULL )
 169     {
 170         vout_AllocatePicture( VLC_OBJECT(p_vout),
 171                               p_freepic, p_vout->render.i_chroma,
 172                               p_vout->render.i_width, p_vout->render.i_height,
 173                               p_vout->render.i_aspect * p_vout->render.i_height,
 174                               VOUT_ASPECT_FACTOR      * p_vout->render.i_width);
 175
 176         if( p_freepic->i_planes )
 177         {
 178             /* Copy picture information, set some default values */
 179             p_freepic->i_status   = RESERVED_PICTURE;
 180             p_freepic->i_type     = MEMORY_PICTURE;
 181             p_freepic->b_slow     = 0;
 182
 183             p_freepic->i_refcount = 0;
 184             p_freepic->b_force = 0;
 185
 186             p_freepic->b_progressive        = b_progressive;
 187             p_freepic->i_nb_fields          = i_nb_fields;
 188             p_freepic->b_top_field_first    = b_top_field_first;
 189
 190             p_vout->i_heap_size++;
 191         }
 192         else
 193         {
 194             /* Memory allocation failed : set picture as empty */
 195             p_freepic->i_status = FREE_PICTURE;
 196             p_freepic = NULL;
 197
 198             msg_Err( p_vout, "picture allocation failed" );
 199         }
 200
 201         vlc_mutex_unlock( &p_vout->picture_lock );
 202
 203         return( p_freepic );
 204     }
 205
 206     /* No free or destroyed picture could be found, but the decoder
 207      * will try again in a while. */
 208     vlc_mutex_unlock( &p_vout->picture_lock );
 209
 210     return( NULL );
 211 }
 212
 213 /* */
 214 static void DestroyPicture( vout_thread_t *p_vout, picture_t *p_picture )
 215 {
 216     vlc_assert_locked( &p_vout->picture_lock );
 217
 218     p_picture->i_status = DESTROYED_PICTURE;
 219     p_vout->i_heap_size--;
 220     picture_CleanupQuant( p_picture );
 221
 222     vlc_cond_signal( &p_vout->p->picture_wait );
 223 }
 224
 225 /**
 226  * Remove a permanent or reserved picture from the heap
 227  *
 228  * This function frees a previously reserved picture or a permanent
 229  * picture. It is meant to be used when the construction of a picture aborted.
 230  * Note that the picture will be destroyed even if it is linked !
 231  *
 232  * TODO remove it, vout_DropPicture should be used instead
 233  */
 234 void vout_DestroyPicture( vout_thread_t *p_vout, picture_t *p_pic )
 235 {
 236 #ifndef NDEBUG
 237     /* Check if picture status is valid */
 238     vlc_mutex_lock( &p_vout->picture_lock );
 239     if( p_pic->i_status != RESERVED_PICTURE )
 240     {
 241         msg_Err( p_vout, "picture to destroy %p has invalid status %d",
 242                          p_pic, p_pic->i_status );
 243     }
 244     vlc_mutex_unlock( &p_vout->picture_lock );
 245 #endif
 246
 247     vout_DropPicture( p_vout, p_pic );
 248 }
 249
 250 /* */
 251 void vout_UsePictureLocked( vout_thread_t *p_vout, picture_t *p_picture )
 252 {
 253     vlc_assert_locked( &p_vout->picture_lock );
 254     if( p_picture->i_refcount > 0 )
 255     {
 256         /* Pretend we displayed the picture, but don't destroy
 257          * it since the decoder might still need it. */
 258         p_picture->i_status = DISPLAYED_PICTURE;
 259     }
 260     else
 261     {
 262         /* Destroy the picture without displaying it */
 263         DestroyPicture( p_vout, p_picture );
 264     }
 265 }
 266
 267 /* */
 268 void vout_DropPicture( vout_thread_t *p_vout, picture_t *p_pic  )
 269 {
 270     vlc_mutex_lock( &p_vout->picture_lock );
 271
 272     if( p_pic->i_status == READY_PICTURE )
 273     {
 274         /* Grr cannot destroy ready picture by myself so be sure vout won't like it */
 275         p_pic->date = 1;
 276         vlc_cond_signal( &p_vout->p->picture_wait );
 277     }
 278     else
 279     {
 280         vout_UsePictureLocked( p_vout, p_pic );
 281     }
 282
 283     vlc_mutex_unlock( &p_vout->picture_lock );
 284 }
 285
 286 /**
 287  * Increment reference counter of a picture
 288  *
 289  * This function increments the reference counter of a picture in the video
 290  * heap. It needs a lock since several producer threads can access the picture.
 291  */
 292 void vout_LinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
 293 {
 294     vlc_mutex_lock( &p_vout->picture_lock );
 295     p_pic->i_refcount++;
 296     vlc_mutex_unlock( &p_vout->picture_lock );
 297 }
 298
 299 /**
 300  * Decrement reference counter of a picture
 301  *
 302  * This function decrement the reference counter of a picture in the video heap
 303  */
 304 void vout_UnlinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
 305 {
 306     vlc_mutex_lock( &p_vout->picture_lock );
 307
 308     if( p_pic->i_refcount > 0 )
 309         p_pic->i_refcount--;
 310     else
 311         msg_Err( p_vout, "Invalid picture reference count (%p, %d)",
 312                  p_pic, p_pic->i_refcount );
 313
 314     if( p_pic->i_refcount == 0 &&
 315         ( p_pic->i_status == DISPLAYED_PICTURE || p_pic->i_status == RESERVED_PICTURE ) )
 316         DestroyPicture( p_vout, p_pic );
 317
 318     vlc_mutex_unlock( &p_vout->picture_lock );
 319 }
 320
 321 /**
 322  * Render a picture
 323  *
 324  * This function chooses whether the current picture needs to be copied
 325  * before rendering, does the subpicture magic, and tells the video output
 326  * thread which direct buffer needs to be displayed.
 327  */
 328 picture_t *vout_RenderPicture( vout_thread_t *p_vout, picture_t *p_pic,
 329                                subpicture_t *p_subpic, mtime_t render_date )
 330 {
 331     if( p_pic == NULL )
 332         return NULL;
 333
 334     if( p_pic->i_type == DIRECT_PICTURE && !p_subpic )
 335     {
 336         /* No subtitles, picture is in a directbuffer so
 337          * we can display it directly (even if it is still
 338          * in use or not). */
 339         return p_pic;
 340     }
 341
 342     /* It is either because:
 343      *  - the picture is not a direct buffer
 344      *  - we have to render subtitles (we can never do it on the given
 345      *  picture even if not referenced).
 346      */
 347     picture_t *p_render;
 348     if( p_subpic != NULL && PP_OUTPUTPICTURE[0]->b_slow )
 349     {
 350         /* The picture buffer is in slow memory. We'll use
 351          * the "2 * VOUT_MAX_PICTURES + 1" picture as a temporary
 352          * one for subpictures rendering. */
 353         p_render = &p_vout->p_picture[2 * VOUT_MAX_PICTURES];
 354         if( p_render->i_status == FREE_PICTURE )
 355         {
 356             vout_AllocatePicture( VLC_OBJECT(p_vout),
 357                                   p_render, p_vout->fmt_out.i_chroma,
 358                                   p_vout->fmt_out.i_width,
 359                                   p_vout->fmt_out.i_height,
 360                                   p_vout->fmt_out.i_sar_num,
 361                                   p_vout->fmt_out.i_sar_den );
 362             p_render->i_type = MEMORY_PICTURE;
 363             p_render->i_status = RESERVED_PICTURE;
 364         }
 365     }
 366     else
 367     {
 368         /* We can directly render into a direct buffer */
 369         p_render = PP_OUTPUTPICTURE[0];
 370     }
 371     /* Copy or convert */
 372     if( p_vout->p->b_direct )
 373     {
 374         picture_Copy( p_render, p_pic );
 375     }
 376     else
 377     {
 378         p_vout->p->p_chroma->p_owner = (filter_owner_sys_t *)p_render;
 379         p_vout->p->p_chroma->pf_video_filter( p_vout->p->p_chroma, p_pic );
 380     }
 381     /* Render the subtitles if present */
 382     if( p_subpic )
 383         spu_RenderSubpictures( p_vout->p_spu,
 384                                p_render, &p_vout->fmt_out,
 385                                p_subpic, &p_vout->fmt_in, render_date );
 386     /* Copy in case we used a temporary fast buffer */
 387     if( p_render != PP_OUTPUTPICTURE[0] )
 388         picture_Copy( PP_OUTPUTPICTURE[0], p_render );
 389
 390     return PP_OUTPUTPICTURE[0];
 391 }
 392
 393 /**
 394  * Calculate image window coordinates
 395  *
 396  * This function will be accessed by plugins. It calculates the relative
 397  * position of the output window and the image window.
 398  */
 399 void vout_PlacePicture( const vout_thread_t *p_vout,
 400                         unsigned int i_width, unsigned int i_height,
 401                         unsigned int *restrict pi_x,
 402                         unsigned int *restrict pi_y,
 403                         unsigned int *restrict pi_width,
 404                         unsigned int *restrict pi_height )
 405 {
 406     if( i_width <= 0 || i_height <= 0 )
 407     {
 408         *pi_width = *pi_height = *pi_x = *pi_y = 0;
 409         return;
 410     }
 411
 412     if( p_vout->b_autoscale )
 413     {
 414         *pi_width = i_width;
 415         *pi_height = i_height;
 416     }
 417     else
 418     {
 419         int i_zoom = p_vout->i_zoom;
 420         /* be realistic, scaling factor confined between .2 and 10. */
 421         if( i_zoom > 10 * ZOOM_FP_FACTOR )      i_zoom = 10 * ZOOM_FP_FACTOR;
 422         else if( i_zoom <  ZOOM_FP_FACTOR / 5 ) i_zoom = ZOOM_FP_FACTOR / 5;
 423
 424         unsigned int i_original_width, i_original_height;
 425
 426         if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
 427         {
 428             i_original_width = p_vout->fmt_in.i_visible_width *
 429                                p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den;
 430             i_original_height =  p_vout->fmt_in.i_visible_height;
 431         }
 432         else
 433         {
 434             i_original_width =  p_vout->fmt_in.i_visible_width;
 435             i_original_height = p_vout->fmt_in.i_visible_height *
 436                                 p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num;
 437         }
 438 #ifdef WIN32
 439         /* On windows, inner video window exceeding container leads to black screen */
 440         *pi_width = __MIN( i_width, i_original_width * i_zoom / ZOOM_FP_FACTOR );
 441         *pi_height = __MIN( i_height, i_original_height * i_zoom / ZOOM_FP_FACTOR );
 442 #else
 443         *pi_width = i_original_width * i_zoom / ZOOM_FP_FACTOR ;
 444         *pi_height = i_original_height * i_zoom / ZOOM_FP_FACTOR ;
 445 #endif
 446     }
 447
 448     int64_t i_scaled_width = p_vout->fmt_in.i_visible_width * (int64_t)p_vout->fmt_in.i_sar_num *
 449                               *pi_height / p_vout->fmt_in.i_visible_height / p_vout->fmt_in.i_sar_den;
 450     int64_t i_scaled_height = p_vout->fmt_in.i_visible_height * (int64_t)p_vout->fmt_in.i_sar_den *
 451                                *pi_width / p_vout->fmt_in.i_visible_width / p_vout->fmt_in.i_sar_num;
 452
 453     if( i_scaled_width <= 0 || i_scaled_height <= 0 )
 454     {
 455         msg_Warn( p_vout, "ignoring broken aspect ratio" );
 456         i_scaled_width = *pi_width;
 457         i_scaled_height = *pi_height;
 458     }
 459
 460     if( i_scaled_width > *pi_width )
 461         *pi_height = i_scaled_height;
 462     else
 463         *pi_width = i_scaled_width;
 464
 465     switch( p_vout->i_alignment & VOUT_ALIGN_HMASK )
 466     {
 467     case VOUT_ALIGN_LEFT:
 468         *pi_x = 0;
 469         break;
 470     case VOUT_ALIGN_RIGHT:
 471         *pi_x = i_width - *pi_width;
 472         break;
 473     default:
 474         *pi_x = ( i_width - *pi_width ) / 2;
 475     }
 476
 477     switch( p_vout->i_alignment & VOUT_ALIGN_VMASK )
 478     {
 479     case VOUT_ALIGN_TOP:
 480         *pi_y = 0;
 481         break;
 482     case VOUT_ALIGN_BOTTOM:
 483         *pi_y = i_height - *pi_height;
 484         break;
 485     default:
 486         *pi_y = ( i_height - *pi_height ) / 2;
 487     }
 488 }
 489
 490 #undef vout_AllocatePicture
 491 /**
 492  * Allocate a new picture in the heap.
 493  *
 494  * This function allocates a fake direct buffer in memory, which can be
 495  * used exactly like a video buffer. The video output thread then manages
 496  * how it gets displayed.
 497  */
 498 int vout_AllocatePicture( vlc_object_t *p_this, picture_t *p_pic,
 499                           vlc_fourcc_t i_chroma,
 500                           int i_width, int i_height,
 501                           int i_sar_num, int i_sar_den )
 502 {
 503     VLC_UNUSED(p_this);
 504
 505     /* Make sure the real dimensions are a multiple of 16 */
 506     if( picture_Setup( p_pic, i_chroma, i_width, i_height,
 507                        i_sar_num, i_sar_den ) != VLC_SUCCESS )
 508         return VLC_EGENERIC;
 509
 510     /* Calculate how big the new image should be */
 511     size_t i_bytes = 0;
 512     for( int i = 0; i < p_pic->i_planes; i++ )
 513     {
 514         const plane_t *p = &p_pic->p[i];
 515
 516         if( p->i_pitch <= 0 || p->i_lines <= 0 ||
 517             p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
 518         {
 519             p_pic->i_planes = 0;
 520             return VLC_ENOMEM;
 521         }
 522         i_bytes += p->i_pitch * p->i_lines;
 523     }
 524
 525     p_pic->p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
 526     if( p_pic->p_data == NULL )
 527     {
 528         p_pic->i_planes = 0;
 529         return VLC_EGENERIC;
 530     }
 531
 532     /* Fill the p_pixels field for each plane */
 533     p_pic->p[0].p_pixels = p_pic->p_data;
 534     for( int i = 1; i < p_pic->i_planes; i++ )
 535     {
 536         p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
 537                                                         p_pic->p[i-1].i_pitch ];
 538     }
 539
 540     return VLC_SUCCESS;
 541 }
 542
 543 /**
 544  * Compare two chroma values
 545  *
 546  * This function returns 1 if the two fourcc values given as argument are
 547  * the same format (eg. UYVY/UYNV) or almost the same format (eg. I420/YV12)
 548  */
 549 int vout_ChromaCmp( vlc_fourcc_t i_chroma, vlc_fourcc_t i_amorhc )
 550 {
 551     static const vlc_fourcc_t p_I420[] = {
 552         VLC_CODEC_I420, VLC_CODEC_YV12, VLC_CODEC_J420, 0
 553     };
 554     static const vlc_fourcc_t p_I422[] = {
 555         VLC_CODEC_I422, VLC_CODEC_J422, 0
 556     };
 557     static const vlc_fourcc_t p_I440[] = {
 558         VLC_CODEC_I440, VLC_CODEC_J440, 0
 559     };
 560     static const vlc_fourcc_t p_I444[] = {
 561         VLC_CODEC_I444, VLC_CODEC_J444, 0
 562     };
 563     static const vlc_fourcc_t *pp_fcc[] = {
 564         p_I420, p_I422, p_I440, p_I444, NULL
 565     };
 566
 567     /* */
 568     i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, i_chroma );
 569     i_amorhc = vlc_fourcc_GetCodec( VIDEO_ES, i_amorhc );
 570
 571     /* If they are the same, they are the same ! */
 572     if( i_chroma == i_amorhc )
 573         return 1;
 574
 575     /* Check for equivalence classes */
 576     for( int i = 0; pp_fcc[i] != NULL; i++ )
 577     {
 578         bool b_fcc1 = false;
 579         bool b_fcc2 = false;
 580         for( int j = 0; pp_fcc[i][j] != 0; j++ )
 581         {
 582             if( i_chroma == pp_fcc[i][j] )
 583                 b_fcc1 = true;
 584             if( i_amorhc == pp_fcc[i][j] )
 585                 b_fcc2 = true;
 586         }
 587         if( b_fcc1 && b_fcc2 )
 588             return 1;
 589     }
 590     return 0;
 591 }
 592
 593 /*****************************************************************************
 594  *
 595  *****************************************************************************/
 596 static void PictureReleaseCallback( picture_t *p_picture )
 597 {
 598     if( --p_picture->i_refcount > 0 )
 599         return;
 600     picture_Delete( p_picture );
 601 }
 602
 603 /*****************************************************************************
 604  *
 605  *****************************************************************************/
 606 void picture_Reset( picture_t *p_picture )
 607 {
 608     /* */
 609     p_picture->date = VLC_TS_INVALID;
 610     p_picture->b_force = false;
 611     p_picture->b_progressive = false;
 612     p_picture->i_nb_fields = 0;
 613     p_picture->b_top_field_first = false;
 614     picture_CleanupQuant( p_picture );
 615 }
 616
 617 /*****************************************************************************
 618  *
 619  *****************************************************************************/
 620 typedef struct
 621 {
 622     unsigned     i_plane_count;
 623     struct
 624     {
 625         struct
 626         {
 627             unsigned i_num;
 628             unsigned i_den;
 629         } w;
 630         struct
 631         {
 632             unsigned i_num;
 633             unsigned i_den;
 634         } h;
 635     } p[VOUT_MAX_PLANES];
 636     unsigned i_pixel_size;
 637
 638 } chroma_description_t;
 639
 640 #define PLANAR(n, w_den, h_den) \
 641     { n, { {{1,1}, {1,1}}, {{1,w_den}, {1,h_den}}, {{1,w_den}, {1,h_den}}, {{1,1}, {1,1}} }, 1 }
 642 #define PACKED(size) \
 643     { 1, { {{1,1}, {1,1}} }, size }
 644
 645 static const struct
 646 {
 647     vlc_fourcc_t            p_fourcc[5];
 648     chroma_description_t    description;
 649 } p_chromas[] = {
 650     { { VLC_CODEC_I411, 0 },                                 PLANAR(3, 4, 1) },
 651     { { VLC_CODEC_I410, VLC_CODEC_YV9, 0 },                  PLANAR(3, 4, 4) },
 652     { { VLC_CODEC_YV12, VLC_CODEC_I420, VLC_CODEC_J420, 0 }, PLANAR(3, 2, 2) },
 653     { { VLC_CODEC_I422, VLC_CODEC_J422, 0 },                 PLANAR(3, 2, 1) },
 654     { { VLC_CODEC_I440, VLC_CODEC_J440, 0 },                 PLANAR(3, 1, 2) },
 655     { { VLC_CODEC_I444, VLC_CODEC_J444, 0 },                 PLANAR(3, 1, 1) },
 656     { { VLC_CODEC_YUVA, 0 },                                 PLANAR(4, 1, 1) },
 657
 658     { { VLC_CODEC_UYVY, VLC_CODEC_VYUY, VLC_CODEC_YUYV, VLC_CODEC_YVYU, 0 }, PACKED(2) },
 659     { { VLC_CODEC_RGB8, VLC_CODEC_GREY, VLC_CODEC_YUVP, VLC_CODEC_RGBP, 0 }, PACKED(1) },
 660     { { VLC_CODEC_RGB16, VLC_CODEC_RGB15, 0 },                               PACKED(2) },
 661     { { VLC_CODEC_RGB24, 0 },                                                PACKED(3) },
 662     { { VLC_CODEC_RGB32, VLC_CODEC_RGBA, 0 },                                PACKED(4) },
 663
 664     { { VLC_CODEC_Y211, 0 }, { 1, { {{1,4}, {1,1}} }, 4 } },
 665
 666     { {0}, { 0, {}, 0 } }
 667 };
 668
 669 #undef PACKED
 670 #undef PLANAR
 671
 672 static const chroma_description_t *vlc_fourcc_GetChromaDescription( vlc_fourcc_t i_fourcc )
 673 {
 674     for( unsigned i = 0; p_chromas[i].p_fourcc[0]; i++ )
 675     {
 676         const vlc_fourcc_t *p_fourcc = p_chromas[i].p_fourcc;
 677         for( unsigned j = 0; p_fourcc[j]; j++ )
 678         {
 679             if( p_fourcc[j] == i_fourcc )
 680                 return &p_chromas[i].description;
 681         }
 682     }
 683     return NULL;
 684 }
 685
 686 static int LCM( int a, int b )
 687 {
 688     return a * b / GCD( a, b );
 689 }
 690
 691 int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
 692                    int i_width, int i_height, int i_sar_num, int i_sar_den )
 693 {
 694     /* Store default values */
 695     p_picture->i_planes = 0;
 696     for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
 697     {
 698         plane_t *p = &p_picture->p[i];
 699         p->p_pixels = NULL;
 700         p->i_pixel_pitch = 0;
 701     }
 702
 703     p_picture->pf_release = NULL;
 704     p_picture->p_release_sys = NULL;
 705     p_picture->i_refcount = 0;
 706
 707     p_picture->i_qtype = QTYPE_NONE;
 708     p_picture->i_qstride = 0;
 709     p_picture->p_q = NULL;
 710
 711     video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
 712                         i_sar_num, i_sar_den );
 713
 714     const chroma_description_t *p_dsc =
 715         vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
 716     if( !p_dsc )
 717         return VLC_EGENERIC;
 718
 719     /* We want V (width/height) to respect:
 720         (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
 721         (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
 722        Which is respected if you have
 723        V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
 724     */
 725     int i_modulo_w = 1;
 726     int i_modulo_h = 1;
 727     int i_ratio_h  = 1;
 728     for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
 729     {
 730         i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.i_den );
 731         i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.i_den );
 732         if( i_ratio_h < p_dsc->p[i].h.i_den )
 733             i_ratio_h = p_dsc->p[i].h.i_den;
 734     }
 735
 736     const int i_width_aligned  = ( i_width  + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
 737     const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
 738     const int i_height_extra   = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
 739     for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
 740     {
 741         plane_t *p = &p_picture->p[i];
 742
 743         p->i_lines         = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
 744         p->i_visible_lines = i_height * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
 745         p->i_pitch         = i_width_aligned * p_dsc->p[i].w.i_num / p_dsc->p[i].w.i_den * p_dsc->i_pixel_size;
 746         p->i_visible_pitch = i_width * p_dsc->p[i].w.i_num / p_dsc->p[i].w.i_den * p_dsc->i_pixel_size;
 747         p->i_pixel_pitch   = p_dsc->i_pixel_size;
 748
 749         assert( (p->i_pitch % 16) == 0 );
 750     }
 751     p_picture->i_planes  = p_dsc->i_plane_count;
 752
 753     return VLC_SUCCESS;
 754 }
 755
 756 /*****************************************************************************
 757  *
 758  *****************************************************************************/
 759 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
 760 {
 761     video_format_t fmt = *p_fmt;
 762
 763     /* It is needed to be sure all informations are filled */
 764     video_format_Setup( &fmt, p_fmt->i_chroma,
 765                               p_fmt->i_width, p_fmt->i_height,
 766                               p_fmt->i_sar_num, p_fmt->i_sar_den );
 767
 768     /* */
 769     picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
 770     if( !p_picture )
 771         return NULL;
 772
 773     if( p_resource )
 774     {
 775         if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
 776                            fmt.i_sar_num, fmt.i_sar_den ) )
 777         {
 778             free( p_picture );
 779             return NULL;
 780         }
 781         p_picture->p_sys = p_resource->p_sys;
 782
 783         for( int i = 0; i < p_picture->i_planes; i++ )
 784         {
 785             p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
 786             p_picture->p[i].i_lines  = p_resource->p[i].i_lines;
 787             p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;
 788         }
 789     }
 790     else
 791     {
 792         if( vout_AllocatePicture( (vlc_object_t *)NULL, p_picture,
 793                                   fmt.i_chroma, fmt.i_width, fmt.i_height,
 794                                   fmt.i_sar_num, fmt.i_sar_den ) )
 795         {
 796             free( p_picture );
 797             return NULL;
 798         }
 799     }
 800     /* */
 801     p_picture->format = fmt;
 802     p_picture->i_refcount = 1;
 803     p_picture->pf_release = PictureReleaseCallback;
 804     p_picture->i_status = RESERVED_PICTURE;
 805
 806     return p_picture;
 807 }
 808 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
 809 {
 810     return picture_NewFromResource( p_fmt, NULL );
 811 }
 812 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
 813 {
 814     video_format_t fmt;
 815
 816     memset( &fmt, 0, sizeof(fmt) );
 817     video_format_Setup( &fmt, i_chroma, i_width, i_height,
 818                         i_sar_num, i_sar_den );
 819
 820     return picture_NewFromFormat( &fmt );
 821 }
 822
 823 /*****************************************************************************
 824  *
 825  *****************************************************************************/
 826 void picture_Delete( picture_t *p_picture )
 827 {
 828     assert( p_picture && p_picture->i_refcount == 0 );
 829     assert( p_picture->p_release_sys == NULL );
 830
 831     free( p_picture->p_q );
 832     free( p_picture->p_data_orig );
 833     free( p_picture->p_sys );
 834     free( p_picture );
 835 }
 836
 837 /*****************************************************************************
 838  *
 839  *****************************************************************************/
 840 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
 841 {
 842     int i;
 843
 844     for( i = 0; i < p_src->i_planes ; i++ )
 845         plane_CopyPixels( p_dst->p+i, p_src->p+i );
 846 }
 847
 848 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
 849 {
 850     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
 851                                      p_src->i_visible_pitch );
 852     const unsigned i_height = __MIN( p_dst->i_visible_lines,
 853                                      p_src->i_visible_lines );
 854
 855     if( p_src->i_pitch == p_dst->i_pitch )
 856     {
 857         /* There are margins, but with the same width : perfect ! */
 858         vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
 859                     p_src->i_pitch * i_height );
 860     }
 861     else
 862     {
 863         /* We need to proceed line by line */
 864         uint8_t *p_in = p_src->p_pixels;
 865         uint8_t *p_out = p_dst->p_pixels;
 866         int i_line;
 867
 868         assert( p_in );
 869         assert( p_out );
 870
 871         for( i_line = i_height; i_line--; )
 872         {
 873             vlc_memcpy( p_out, p_in, i_width );
 874             p_in += p_src->i_pitch;
 875             p_out += p_dst->i_pitch;
 876         }
 877     }
 878 }
 879
 880 /*****************************************************************************
 881  *
 882  *****************************************************************************/
 883 int picture_Export( vlc_object_t *p_obj,
 884                     block_t **pp_image,
 885                     video_format_t *p_fmt,
 886                     picture_t *p_picture,
 887                     vlc_fourcc_t i_format,
 888                     int i_override_width, int i_override_height )
 889 {
 890     /* */
 891     video_format_t fmt_in = p_picture->format;
 892     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
 893     {
 894         fmt_in.i_sar_num =
 895         fmt_in.i_sar_den = 1;
 896     }
 897
 898     /* */
 899     video_format_t fmt_out;
 900     memset( &fmt_out, 0, sizeof(fmt_out) );
 901     fmt_out.i_sar_num =
 902     fmt_out.i_sar_den = 1;
 903     fmt_out.i_chroma  = i_format;
 904
 905     /* compute original width/height */
 906     unsigned int i_original_width;
 907     unsigned int i_original_height;
 908     if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
 909     {
 910         i_original_width = fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
 911         i_original_height = fmt_in.i_height;
 912     }
 913     else
 914     {
 915         i_original_width =  fmt_in.i_width;
 916         i_original_height = fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
 917     }
 918
 919     /* */
 920     fmt_out.i_width  = ( i_override_width < 0 ) ?
 921                        i_original_width : i_override_width;
 922     fmt_out.i_height = ( i_override_height < 0 ) ?
 923                        i_original_height : i_override_height;
 924
 925     /* scale if only one direction is provided */
 926     if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
 927     {
 928         fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
 929                      * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
 930     }
 931     else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
 932     {
 933         fmt_out.i_width  = fmt_in.i_width * fmt_out.i_height
 934                      * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
 935     }
 936
 937     image_handler_t *p_image = image_HandlerCreate( p_obj );
 938
 939     block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
 940
 941     image_HandlerDelete( p_image );
 942
 943     if( !p_block )
 944         return VLC_EGENERIC;
 945
 946     p_block->i_pts =
 947     p_block->i_dts = p_picture->date;
 948
 949     if( p_fmt )
 950         *p_fmt = fmt_out;
 951     *pp_image = p_block;
 952
 953     return VLC_SUCCESS;
 954 }
 955