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 && p_pic->i_status == DISPLAYED_PICTURE )
 315         DestroyPicture( p_vout, p_pic );
 316
 317     vlc_mutex_unlock( &p_vout->picture_lock );
 318 }
 319
 320 /**
 321  * Render a picture
 322  *
 323  * This function chooses whether the current picture needs to be copied
 324  * before rendering, does the subpicture magic, and tells the video output
 325  * thread which direct buffer needs to be displayed.
 326  */
 327 picture_t *vout_RenderPicture( vout_thread_t *p_vout, picture_t *p_pic,
 328                                subpicture_t *p_subpic, mtime_t render_date )
 329 {
 330     if( p_pic == NULL )
 331         return NULL;
 332
 333     if( p_pic->i_type == DIRECT_PICTURE && !p_subpic )
 334     {
 335         /* No subtitles, picture is in a directbuffer so
 336          * we can display it directly (even if it is still
 337          * in use or not). */
 338         return p_pic;
 339     }
 340
 341     /* It is either because:
 342      *  - the picture is not a direct buffer
 343      *  - we have to render subtitles (we can never do it on the given
 344      *  picture even if not referenced).
 345      */
 346     picture_t *p_render;
 347     if( p_subpic != NULL && PP_OUTPUTPICTURE[0]->b_slow )
 348     {
 349         /* The picture buffer is in slow memory. We'll use
 350          * the "2 * VOUT_MAX_PICTURES + 1" picture as a temporary
 351          * one for subpictures rendering. */
 352         p_render = &p_vout->p_picture[2 * VOUT_MAX_PICTURES];
 353         if( p_render->i_status == FREE_PICTURE )
 354         {
 355             vout_AllocatePicture( VLC_OBJECT(p_vout),
 356                                   p_render, p_vout->fmt_out.i_chroma,
 357                                   p_vout->fmt_out.i_width,
 358                                   p_vout->fmt_out.i_height,
 359                                   p_vout->fmt_out.i_sar_num,
 360                                   p_vout->fmt_out.i_sar_den );
 361             p_render->i_type = MEMORY_PICTURE;
 362             p_render->i_status = RESERVED_PICTURE;
 363         }
 364     }
 365     else
 366     {
 367         /* We can directly render into a direct buffer */
 368         p_render = PP_OUTPUTPICTURE[0];
 369     }
 370     /* Copy or convert */
 371     if( p_vout->p->b_direct )
 372     {
 373         picture_Copy( p_render, p_pic );
 374     }
 375     else
 376     {
 377         p_vout->p->p_chroma->p_owner = (filter_owner_sys_t *)p_render;
 378         p_vout->p->p_chroma->pf_video_filter( p_vout->p->p_chroma, p_pic );
 379     }
 380     /* Render the subtitles if present */
 381     if( p_subpic )
 382         spu_RenderSubpictures( p_vout->p_spu,
 383                                p_render, &p_vout->fmt_out,
 384                                p_subpic, &p_vout->fmt_in, render_date );
 385     /* Copy in case we used a temporary fast buffer */
 386     if( p_render != PP_OUTPUTPICTURE[0] )
 387         picture_Copy( PP_OUTPUTPICTURE[0], p_render );
 388
 389     return PP_OUTPUTPICTURE[0];
 390 }
 391
 392 /**
 393  * Calculate image window coordinates
 394  *
 395  * This function will be accessed by plugins. It calculates the relative
 396  * position of the output window and the image window.
 397  */
 398 void vout_PlacePicture( const vout_thread_t *p_vout,
 399                         unsigned int i_width, unsigned int i_height,
 400                         unsigned int *restrict pi_x,
 401                         unsigned int *restrict pi_y,
 402                         unsigned int *restrict pi_width,
 403                         unsigned int *restrict pi_height )
 404 {
 405     if( i_width <= 0 || i_height <= 0 )
 406     {
 407         *pi_width = *pi_height = *pi_x = *pi_y = 0;
 408         return;
 409     }
 410
 411     if( p_vout->b_autoscale )
 412     {
 413         *pi_width = i_width;
 414         *pi_height = i_height;
 415     }
 416     else
 417     {
 418         int i_zoom = p_vout->i_zoom;
 419         /* be realistic, scaling factor confined between .2 and 10. */
 420         if( i_zoom > 10 * ZOOM_FP_FACTOR )      i_zoom = 10 * ZOOM_FP_FACTOR;
 421         else if( i_zoom <  ZOOM_FP_FACTOR / 5 ) i_zoom = ZOOM_FP_FACTOR / 5;
 422
 423         unsigned int i_original_width, i_original_height;
 424
 425         if( p_vout->fmt_in.i_sar_num >= p_vout->fmt_in.i_sar_den )
 426         {
 427             i_original_width = p_vout->fmt_in.i_visible_width *
 428                                p_vout->fmt_in.i_sar_num / p_vout->fmt_in.i_sar_den;
 429             i_original_height =  p_vout->fmt_in.i_visible_height;
 430         }
 431         else
 432         {
 433             i_original_width =  p_vout->fmt_in.i_visible_width;
 434             i_original_height = p_vout->fmt_in.i_visible_height *
 435                                 p_vout->fmt_in.i_sar_den / p_vout->fmt_in.i_sar_num;
 436         }
 437 #ifdef WIN32
 438         /* On windows, inner video window exceeding container leads to black screen */
 439         *pi_width = __MIN( i_width, i_original_width * i_zoom / ZOOM_FP_FACTOR );
 440         *pi_height = __MIN( i_height, i_original_height * i_zoom / ZOOM_FP_FACTOR );
 441 #else
 442         *pi_width = i_original_width * i_zoom / ZOOM_FP_FACTOR ;
 443         *pi_height = i_original_height * i_zoom / ZOOM_FP_FACTOR ;
 444 #endif
 445     }
 446
 447     int64_t i_scaled_width = p_vout->fmt_in.i_visible_width * (int64_t)p_vout->fmt_in.i_sar_num *
 448                               *pi_height / p_vout->fmt_in.i_visible_height / p_vout->fmt_in.i_sar_den;
 449     int64_t i_scaled_height = p_vout->fmt_in.i_visible_height * (int64_t)p_vout->fmt_in.i_sar_den *
 450                                *pi_width / p_vout->fmt_in.i_visible_width / p_vout->fmt_in.i_sar_num;
 451
 452     if( i_scaled_width <= 0 || i_scaled_height <= 0 )
 453     {
 454         msg_Warn( p_vout, "ignoring broken aspect ratio" );
 455         i_scaled_width = *pi_width;
 456         i_scaled_height = *pi_height;
 457     }
 458
 459     if( i_scaled_width > *pi_width )
 460         *pi_height = i_scaled_height;
 461     else
 462         *pi_width = i_scaled_width;
 463
 464     switch( p_vout->i_alignment & VOUT_ALIGN_HMASK )
 465     {
 466     case VOUT_ALIGN_LEFT:
 467         *pi_x = 0;
 468         break;
 469     case VOUT_ALIGN_RIGHT:
 470         *pi_x = i_width - *pi_width;
 471         break;
 472     default:
 473         *pi_x = ( i_width - *pi_width ) / 2;
 474     }
 475
 476     switch( p_vout->i_alignment & VOUT_ALIGN_VMASK )
 477     {
 478     case VOUT_ALIGN_TOP:
 479         *pi_y = 0;
 480         break;
 481     case VOUT_ALIGN_BOTTOM:
 482         *pi_y = i_height - *pi_height;
 483         break;
 484     default:
 485         *pi_y = ( i_height - *pi_height ) / 2;
 486     }
 487 }
 488
 489 #undef vout_AllocatePicture
 490 /**
 491  * Allocate a new picture in the heap.
 492  *
 493  * This function allocates a fake direct buffer in memory, which can be
 494  * used exactly like a video buffer. The video output thread then manages
 495  * how it gets displayed.
 496  */
 497 int vout_AllocatePicture( vlc_object_t *p_this, picture_t *p_pic,
 498                           vlc_fourcc_t i_chroma,
 499                           int i_width, int i_height,
 500                           int i_sar_num, int i_sar_den )
 501 {
 502     VLC_UNUSED(p_this);
 503
 504     /* Make sure the real dimensions are a multiple of 16 */
 505     if( picture_Setup( p_pic, i_chroma, i_width, i_height,
 506                        i_sar_num, i_sar_den ) != VLC_SUCCESS )
 507         return VLC_EGENERIC;
 508
 509     /* Calculate how big the new image should be */
 510     size_t i_bytes = 0;
 511     for( int i = 0; i < p_pic->i_planes; i++ )
 512     {
 513         const plane_t *p = &p_pic->p[i];
 514
 515         if( p->i_pitch <= 0 || p->i_lines <= 0 ||
 516             p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
 517         {
 518             p_pic->i_planes = 0;
 519             return VLC_ENOMEM;
 520         }
 521         i_bytes += p->i_pitch * p->i_lines;
 522     }
 523
 524     p_pic->p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
 525     if( p_pic->p_data == NULL )
 526     {
 527         p_pic->i_planes = 0;
 528         return VLC_EGENERIC;
 529     }
 530
 531     /* Fill the p_pixels field for each plane */
 532     p_pic->p[0].p_pixels = p_pic->p_data;
 533     for( int i = 1; i < p_pic->i_planes; i++ )
 534     {
 535         p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
 536                                                         p_pic->p[i-1].i_pitch ];
 537     }
 538
 539     return VLC_SUCCESS;
 540 }
 541
 542 /**
 543  * Compare two chroma values
 544  *
 545  * This function returns 1 if the two fourcc values given as argument are
 546  * the same format (eg. UYVY/UYNV) or almost the same format (eg. I420/YV12)
 547  */
 548 int vout_ChromaCmp( vlc_fourcc_t i_chroma, vlc_fourcc_t i_amorhc )
 549 {
 550     static const vlc_fourcc_t p_I420[] = {
 551         VLC_CODEC_I420, VLC_CODEC_YV12, VLC_CODEC_J420, 0
 552     };
 553     static const vlc_fourcc_t p_I422[] = {
 554         VLC_CODEC_I422, VLC_CODEC_J422, 0
 555     };
 556     static const vlc_fourcc_t p_I440[] = {
 557         VLC_CODEC_I440, VLC_CODEC_J440, 0
 558     };
 559     static const vlc_fourcc_t p_I444[] = {
 560         VLC_CODEC_I444, VLC_CODEC_J444, 0
 561     };
 562     static const vlc_fourcc_t *pp_fcc[] = {
 563         p_I420, p_I422, p_I440, p_I444, NULL
 564     };
 565
 566     /* */
 567     i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, i_chroma );
 568     i_amorhc = vlc_fourcc_GetCodec( VIDEO_ES, i_amorhc );
 569
 570     /* If they are the same, they are the same ! */
 571     if( i_chroma == i_amorhc )
 572         return 1;
 573
 574     /* Check for equivalence classes */
 575     for( int i = 0; pp_fcc[i] != NULL; i++ )
 576     {
 577         bool b_fcc1 = false;
 578         bool b_fcc2 = false;
 579         for( int j = 0; pp_fcc[i][j] != 0; j++ )
 580         {
 581             if( i_chroma == pp_fcc[i][j] )
 582                 b_fcc1 = true;
 583             if( i_amorhc == pp_fcc[i][j] )
 584                 b_fcc2 = true;
 585         }
 586         if( b_fcc1 && b_fcc2 )
 587             return 1;
 588     }
 589     return 0;
 590 }
 591
 592 /*****************************************************************************
 593  *
 594  *****************************************************************************/
 595 static void PictureReleaseCallback( picture_t *p_picture )
 596 {
 597     if( --p_picture->i_refcount > 0 )
 598         return;
 599     picture_Delete( p_picture );
 600 }
 601
 602 /*****************************************************************************
 603  *
 604  *****************************************************************************/
 605 void picture_Reset( picture_t *p_picture )
 606 {
 607     /* */
 608     p_picture->date = VLC_TS_INVALID;
 609     p_picture->b_force = false;
 610     p_picture->b_progressive = false;
 611     p_picture->i_nb_fields = 0;
 612     p_picture->b_top_field_first = false;
 613     picture_CleanupQuant( p_picture );
 614 }
 615
 616 /*****************************************************************************
 617  *
 618  *****************************************************************************/
 619 typedef struct
 620 {
 621     unsigned     i_plane_count;
 622     struct
 623     {
 624         struct
 625         {
 626             unsigned i_num;
 627             unsigned i_den;
 628         } w;
 629         struct
 630         {
 631             unsigned i_num;
 632             unsigned i_den;
 633         } h;
 634     } p[VOUT_MAX_PLANES];
 635     unsigned i_pixel_size;
 636
 637 } chroma_description_t;
 638
 639 #define PLANAR(n, w_den, h_den) \
 640     { n, { {{1,1}, {1,1}}, {{1,w_den}, {1,h_den}}, {{1,w_den}, {1,h_den}}, {{1,1}, {1,1}} }, 1 }
 641 #define PACKED(size) \
 642     { 1, { {{1,1}, {1,1}} }, size }
 643
 644 static const struct
 645 {
 646     vlc_fourcc_t            p_fourcc[5];
 647     chroma_description_t    description;
 648 } p_chromas[] = {
 649     { { VLC_CODEC_I411, 0 },                                 PLANAR(3, 4, 1) },
 650     { { VLC_CODEC_I410, VLC_CODEC_YV9, 0 },                  PLANAR(3, 4, 4) },
 651     { { VLC_CODEC_YV12, VLC_CODEC_I420, VLC_CODEC_J420, 0 }, PLANAR(3, 2, 2) },
 652     { { VLC_CODEC_I422, VLC_CODEC_J422, 0 },                 PLANAR(3, 2, 1) },
 653     { { VLC_CODEC_I440, VLC_CODEC_J440, 0 },                 PLANAR(3, 1, 2) },
 654     { { VLC_CODEC_I444, VLC_CODEC_J444, 0 },                 PLANAR(3, 1, 1) },
 655     { { VLC_CODEC_YUVA, 0 },                                 PLANAR(4, 1, 1) },
 656
 657     { { VLC_CODEC_UYVY, VLC_CODEC_VYUY, VLC_CODEC_YUYV, VLC_CODEC_YVYU, 0 }, PACKED(2) },
 658     { { VLC_CODEC_RGB8, VLC_CODEC_GREY, VLC_CODEC_YUVP, VLC_CODEC_RGBP, 0 }, PACKED(1) },
 659     { { VLC_CODEC_RGB16, VLC_CODEC_RGB15, 0 },                               PACKED(2) },
 660     { { VLC_CODEC_RGB24, 0 },                                                PACKED(3) },
 661     { { VLC_CODEC_RGB32, VLC_CODEC_RGBA, 0 },                                PACKED(4) },
 662
 663     { { VLC_CODEC_Y211, 0 }, { 1, { {{1,4}, {1,1}} }, 4 } },
 664
 665     { {0}, { 0, {}, 0 } }
 666 };
 667
 668 #undef PACKED
 669 #undef PLANAR
 670
 671 static const chroma_description_t *vlc_fourcc_GetChromaDescription( vlc_fourcc_t i_fourcc )
 672 {
 673     for( unsigned i = 0; p_chromas[i].p_fourcc[0]; i++ )
 674     {
 675         const vlc_fourcc_t *p_fourcc = p_chromas[i].p_fourcc;
 676         for( unsigned j = 0; p_fourcc[j]; j++ )
 677         {
 678             if( p_fourcc[j] == i_fourcc )
 679                 return &p_chromas[i].description;
 680         }
 681     }
 682     return NULL;
 683 }
 684
 685 static int LCM( int a, int b )
 686 {
 687     return a * b / GCD( a, b );
 688 }
 689
 690 int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
 691                    int i_width, int i_height, int i_sar_num, int i_sar_den )
 692 {
 693     /* Store default values */
 694     p_picture->i_planes = 0;
 695     for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
 696     {
 697         plane_t *p = &p_picture->p[i];
 698         p->p_pixels = NULL;
 699         p->i_pixel_pitch = 0;
 700     }
 701
 702     p_picture->pf_release = NULL;
 703     p_picture->p_release_sys = NULL;
 704     p_picture->i_refcount = 0;
 705
 706     p_picture->i_qtype = QTYPE_NONE;
 707     p_picture->i_qstride = 0;
 708     p_picture->p_q = NULL;
 709
 710     video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
 711                         i_sar_num, i_sar_den );
 712
 713     const chroma_description_t *p_dsc =
 714         vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
 715     if( !p_dsc )
 716         return VLC_EGENERIC;
 717
 718     /* We want V (width/height) to respect:
 719         (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
 720         (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
 721        Which is respected if you have
 722        V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
 723     */
 724     int i_modulo_w = 1;
 725     int i_modulo_h = 1;
 726     int i_ratio_h  = 1;
 727     for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
 728     {
 729         i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.i_den );
 730         i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.i_den );
 731         if( i_ratio_h < p_dsc->p[i].h.i_den )
 732             i_ratio_h = p_dsc->p[i].h.i_den;
 733     }
 734
 735     const int i_width_aligned  = ( i_width  + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
 736     const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
 737     const int i_height_extra   = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
 738     for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
 739     {
 740         plane_t *p = &p_picture->p[i];
 741
 742         p->i_lines         = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
 743         p->i_visible_lines = i_height * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
 744         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;
 745         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;
 746         p->i_pixel_pitch   = p_dsc->i_pixel_size;
 747
 748         assert( (p->i_pitch % 16) == 0 );
 749     }
 750     p_picture->i_planes  = p_dsc->i_plane_count;
 751
 752     return VLC_SUCCESS;
 753 }
 754
 755 /*****************************************************************************
 756  *
 757  *****************************************************************************/
 758 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
 759 {
 760     video_format_t fmt = *p_fmt;
 761
 762     /* It is needed to be sure all informations are filled */
 763     video_format_Setup( &fmt, p_fmt->i_chroma,
 764                               p_fmt->i_width, p_fmt->i_height,
 765                               p_fmt->i_sar_num, p_fmt->i_sar_den );
 766
 767     /* */
 768     picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
 769     if( !p_picture )
 770         return NULL;
 771
 772     if( p_resource )
 773     {
 774         if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
 775                            fmt.i_sar_num, fmt.i_sar_den ) )
 776         {
 777             free( p_picture );
 778             return NULL;
 779         }
 780         p_picture->p_sys = p_resource->p_sys;
 781
 782         for( int i = 0; i < p_picture->i_planes; i++ )
 783         {
 784             p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
 785             p_picture->p[i].i_lines  = p_resource->p[i].i_lines;
 786             p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;
 787         }
 788     }
 789     else
 790     {
 791         if( vout_AllocatePicture( (vlc_object_t *)NULL, p_picture,
 792                                   fmt.i_chroma, fmt.i_width, fmt.i_height,
 793                                   fmt.i_sar_num, fmt.i_sar_den ) )
 794         {
 795             free( p_picture );
 796             return NULL;
 797         }
 798     }
 799     /* */
 800     p_picture->format = fmt;
 801     p_picture->i_refcount = 1;
 802     p_picture->pf_release = PictureReleaseCallback;
 803     p_picture->i_status = RESERVED_PICTURE;
 804
 805     return p_picture;
 806 }
 807 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
 808 {
 809     return picture_NewFromResource( p_fmt, NULL );
 810 }
 811 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
 812 {
 813     video_format_t fmt;
 814
 815     memset( &fmt, 0, sizeof(fmt) );
 816     video_format_Setup( &fmt, i_chroma, i_width, i_height,
 817                         i_sar_num, i_sar_den );
 818
 819     return picture_NewFromFormat( &fmt );
 820 }
 821
 822 /*****************************************************************************
 823  *
 824  *****************************************************************************/
 825 void picture_Delete( picture_t *p_picture )
 826 {
 827     assert( p_picture && p_picture->i_refcount == 0 );
 828     assert( p_picture->p_release_sys == NULL );
 829
 830     free( p_picture->p_q );
 831     free( p_picture->p_data_orig );
 832     free( p_picture->p_sys );
 833     free( p_picture );
 834 }
 835
 836 /*****************************************************************************
 837  *
 838  *****************************************************************************/
 839 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
 840 {
 841     int i;
 842
 843     for( i = 0; i < p_src->i_planes ; i++ )
 844         plane_CopyPixels( p_dst->p+i, p_src->p+i );
 845 }
 846
 847 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
 848 {
 849     const unsigned i_width  = __MIN( p_dst->i_visible_pitch,
 850                                      p_src->i_visible_pitch );
 851     const unsigned i_height = __MIN( p_dst->i_visible_lines,
 852                                      p_src->i_visible_lines );
 853
 854     if( p_src->i_pitch == p_dst->i_pitch )
 855     {
 856         /* There are margins, but with the same width : perfect ! */
 857         vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
 858                     p_src->i_pitch * i_height );
 859     }
 860     else
 861     {
 862         /* We need to proceed line by line */
 863         uint8_t *p_in = p_src->p_pixels;
 864         uint8_t *p_out = p_dst->p_pixels;
 865         int i_line;
 866
 867         assert( p_in );
 868         assert( p_out );
 869
 870         for( i_line = i_height; i_line--; )
 871         {
 872             vlc_memcpy( p_out, p_in, i_width );
 873             p_in += p_src->i_pitch;
 874             p_out += p_dst->i_pitch;
 875         }
 876     }
 877 }
 878
 879 /*****************************************************************************
 880  *
 881  *****************************************************************************/
 882 int picture_Export( vlc_object_t *p_obj,
 883                     block_t **pp_image,
 884                     video_format_t *p_fmt,
 885                     picture_t *p_picture,
 886                     vlc_fourcc_t i_format,
 887                     int i_override_width, int i_override_height )
 888 {
 889     /* */
 890     video_format_t fmt_in = p_picture->format;
 891     if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
 892     {
 893         fmt_in.i_sar_num =
 894         fmt_in.i_sar_den = 1;
 895     }
 896
 897     /* */
 898     video_format_t fmt_out;
 899     memset( &fmt_out, 0, sizeof(fmt_out) );
 900     fmt_out.i_sar_num =
 901     fmt_out.i_sar_den = 1;
 902     fmt_out.i_chroma  = i_format;
 903
 904     /* compute original width/height */
 905     unsigned int i_original_width;
 906     unsigned int i_original_height;
 907     if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
 908     {
 909         i_original_width = fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
 910         i_original_height = fmt_in.i_height;
 911     }
 912     else
 913     {
 914         i_original_width =  fmt_in.i_width;
 915         i_original_height = fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
 916     }
 917
 918     /* */
 919     fmt_out.i_width  = ( i_override_width < 0 ) ?
 920                        i_original_width : i_override_width;
 921     fmt_out.i_height = ( i_override_height < 0 ) ?
 922                        i_original_height : i_override_height;
 923
 924     /* scale if only one direction is provided */
 925     if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
 926     {
 927         fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
 928                      * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
 929     }
 930     else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
 931     {
 932         fmt_out.i_width  = fmt_in.i_width * fmt_out.i_height
 933                      * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
 934     }
 935
 936     image_handler_t *p_image = image_HandlerCreate( p_obj );
 937
 938     block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
 939
 940     image_HandlerDelete( p_image );
 941
 942     if( !p_block )
 943         return VLC_EGENERIC;
 944
 945     p_block->i_pts =
 946     p_block->i_dts = p_picture->date;
 947
 948     if( p_fmt )
 949         *p_fmt = fmt_out;
 950     *pp_image = p_block;
 951
 952     return VLC_SUCCESS;
 953 }
 954