src/lib/image.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/image.cc
  21  *  @brief A class to describe a video image.
  22  */
  23
  24 #include "image.h"
  25 #include "exceptions.h"
  26 #include "timer.h"
  27 #include "rect.h"
  28 #include "util.h"
  29 #include "md5_digester.h"
  30 #include "dcpomatic_socket.h"
  31 extern "C" {
  32 #include <libswscale/swscale.h>
  33 #include <libavutil/pixfmt.h>
  34 #include <libavutil/pixdesc.h>
  35 #include <libavutil/frame.h>
  36 }
  37 #include <iostream>
  38
  39 #include "i18n.h"
  40
  41 using std::string;
  42 using std::min;
  43 using std::cout;
  44 using std::cerr;
  45 using std::list;
  46 using std::runtime_error;
  47 using boost::shared_ptr;
  48 using dcp::Size;
  49
  50 int
  51 Image::line_factor (int n) const
  52 {
  53         if (n == 0) {
  54                 return 1;
  55         }
  56
  57         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
  58         if (!d) {
  59                 throw PixelFormatError ("line_factor()", _pixel_format);
  60         }
  61
  62         return pow (2.0f, d->log2_chroma_h);
  63 }
  64
  65 /** @param n Component index.
  66  *  @return Number of samples (i.e. pixels, unless sub-sampled) in each direction for this component.
  67  */
  68 dcp::Size
  69 Image::sample_size (int n) const
  70 {
  71         int horizontal_factor = 1;
  72         if (n > 0) {
  73                 AVPixFmtDescriptor const * d = av_pix_fmt_desc_get (_pixel_format);
  74                 if (!d) {
  75                         throw PixelFormatError ("sample_size()", _pixel_format);
  76                 }
  77                 horizontal_factor = pow (2.0f, d->log2_chroma_w);
  78         }
  79
  80         return dcp::Size (
  81                 lrint (ceil (static_cast<double>(size().width) / horizontal_factor)),
  82                 lrint (ceil (static_cast<double>(size().height) / line_factor (n)))
  83                 );
  84 }
  85
  86 int
  87 Image::components () const
  88 {
  89         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
  90         if (!d) {
  91                 throw PixelFormatError ("components()", _pixel_format);
  92         }
  93
  94         return d->nb_components;
  95 }
  96
  97 /** @return Number of planes */
  98 int
  99 Image::planes () const
 100 {
 101         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
 102         if (!d) {
 103                 throw PixelFormatError ("planes()", _pixel_format);
 104         }
 105
 106         if ((d->flags & AV_PIX_FMT_FLAG_PLANAR) == 0) {
 107                 return 1;
 108         }
 109
 110         return d->nb_components;
 111 }
 112
 113 /** Crop this image, scale it to `inter_size' and then place it in a black frame of `out_size' */
 114 shared_ptr<Image>
 115 Image::crop_scale_window (
 116         Crop crop, dcp::Size inter_size, dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned
 117         ) const
 118 {
 119         /* Empirical testing suggests that sws_scale() will crash if
 120            the input image is not aligned.
 121         */
 122         DCPOMATIC_ASSERT (aligned ());
 123
 124         DCPOMATIC_ASSERT (out_size.width >= inter_size.width);
 125         DCPOMATIC_ASSERT (out_size.height >= inter_size.height);
 126
 127         /* Here's an image of out_size */
 128         shared_ptr<Image> out (new Image (out_format, out_size, out_aligned));
 129         out->make_black ();
 130
 131         /* Size of the image after any crop */
 132         dcp::Size const cropped_size = crop.apply (size ());
 133
 134         /* Scale context for a scale from cropped_size to inter_size */
 135         struct SwsContext* scale_context = sws_getContext (
 136                         cropped_size.width, cropped_size.height, pixel_format(),
 137                         inter_size.width, inter_size.height, out_format,
 138                         SWS_BICUBIC, 0, 0, 0
 139                 );
 140
 141         if (!scale_context) {
 142                 throw runtime_error (N_("Could not allocate SwsContext"));
 143         }
 144
 145         DCPOMATIC_ASSERT (yuv_to_rgb < dcp::YUV_TO_RGB_COUNT);
 146         int const lut[dcp::YUV_TO_RGB_COUNT] = {
 147                 SWS_CS_ITU601,
 148                 SWS_CS_ITU709
 149         };
 150
 151         sws_setColorspaceDetails (
 152                 scale_context,
 153                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 154                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 155                 0, 1 << 16, 1 << 16
 156                 );
 157
 158         AVPixFmtDescriptor const * desc = av_pix_fmt_desc_get (_pixel_format);
 159         if (!desc) {
 160                 throw PixelFormatError ("crop_scale_window()", _pixel_format);
 161         }
 162
 163         /* Prepare input data pointers with crop */
 164         uint8_t* scale_in_data[planes()];
 165         for (int c = 0; c < planes(); ++c) {
 166                 /* To work out the crop in bytes, start by multiplying
 167                    the crop by the (average) bytes per pixel.  Then
 168                    round down so that we don't crop a subsampled pixel until
 169                    we've cropped all of its Y-channel pixels.
 170                 */
 171                 int const x = lrintf (bytes_per_pixel(c) * crop.left) & ~ ((int) desc->log2_chroma_w);
 172                 scale_in_data[c] = data()[c] + x + stride()[c] * (crop.top / line_factor(c));
 173         }
 174
 175         /* Corner of the image within out_size */
 176         Position<int> const corner ((out_size.width - inter_size.width) / 2, (out_size.height - inter_size.height) / 2);
 177
 178         uint8_t* scale_out_data[out->planes()];
 179         for (int c = 0; c < out->planes(); ++c) {
 180                 scale_out_data[c] = out->data()[c] + lrintf (out->bytes_per_pixel(c) * corner.x) + out->stride()[c] * corner.y;
 181         }
 182
 183         sws_scale (
 184                 scale_context,
 185                 scale_in_data, stride(),
 186                 0, cropped_size.height,
 187                 scale_out_data, out->stride()
 188                 );
 189
 190         sws_freeContext (scale_context);
 191
 192         return out;
 193 }
 194
 195 shared_ptr<Image>
 196 Image::scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned) const
 197 {
 198         /* Empirical testing suggests that sws_scale() will crash if
 199            the input image is not aligned.
 200         */
 201         DCPOMATIC_ASSERT (aligned ());
 202
 203         shared_ptr<Image> scaled (new Image (out_format, out_size, out_aligned));
 204
 205         struct SwsContext* scale_context = sws_getContext (
 206                 size().width, size().height, pixel_format(),
 207                 out_size.width, out_size.height, out_format,
 208                 SWS_BICUBIC, 0, 0, 0
 209                 );
 210
 211         DCPOMATIC_ASSERT (yuv_to_rgb < dcp::YUV_TO_RGB_COUNT);
 212         int const lut[dcp::YUV_TO_RGB_COUNT] = {
 213                 SWS_CS_ITU601,
 214                 SWS_CS_ITU709
 215         };
 216
 217         sws_setColorspaceDetails (
 218                 scale_context,
 219                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 220                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 221                 0, 1 << 16, 1 << 16
 222                 );
 223
 224         sws_scale (
 225                 scale_context,
 226                 data(), stride(),
 227                 0, size().height,
 228                 scaled->data(), scaled->stride()
 229                 );
 230
 231         sws_freeContext (scale_context);
 232
 233         return scaled;
 234 }
 235
 236 /** Blacken a YUV image whose bits per pixel is rounded up to 16 */
 237 void
 238 Image::yuv_16_black (uint16_t v, bool alpha)
 239 {
 240         memset (data()[0], 0, sample_size(0).height * stride()[0]);
 241         for (int i = 1; i < 3; ++i) {
 242                 int16_t* p = reinterpret_cast<int16_t*> (data()[i]);
 243                 int const lines = sample_size(i).height;
 244                 for (int y = 0; y < lines; ++y) {
 245                         /* We divide by 2 here because we are writing 2 bytes at a time */
 246                         for (int x = 0; x < line_size()[i] / 2; ++x) {
 247                                 p[x] = v;
 248                         }
 249                         p += stride()[i] / 2;
 250                 }
 251         }
 252
 253         if (alpha) {
 254                 memset (data()[3], 0, sample_size(3).height * stride()[3]);
 255         }
 256 }
 257
 258 uint16_t
 259 Image::swap_16 (uint16_t v)
 260 {
 261         return ((v >> 8) & 0xff) | ((v & 0xff) << 8);
 262 }
 263
 264 void
 265 Image::make_black ()
 266 {
 267         /* U/V black value for 8-bit colour */
 268         static uint8_t const eight_bit_uv =     (1 << 7) - 1;
 269         /* U/V black value for 9-bit colour */
 270         static uint16_t const nine_bit_uv =     (1 << 8) - 1;
 271         /* U/V black value for 10-bit colour */
 272         static uint16_t const ten_bit_uv =      (1 << 9) - 1;
 273         /* U/V black value for 16-bit colour */
 274         static uint16_t const sixteen_bit_uv =  (1 << 15) - 1;
 275
 276         switch (_pixel_format) {
 277         case AV_PIX_FMT_YUV420P:
 278         case AV_PIX_FMT_YUV422P:
 279         case AV_PIX_FMT_YUV444P:
 280         case AV_PIX_FMT_YUV411P:
 281                 memset (data()[0], 0, sample_size(0).height * stride()[0]);
 282                 memset (data()[1], eight_bit_uv, sample_size(1).height * stride()[1]);
 283                 memset (data()[2], eight_bit_uv, sample_size(2).height * stride()[2]);
 284                 break;
 285
 286         case AV_PIX_FMT_YUVJ420P:
 287         case AV_PIX_FMT_YUVJ422P:
 288         case AV_PIX_FMT_YUVJ444P:
 289                 memset (data()[0], 0, sample_size(0).height * stride()[0]);
 290                 memset (data()[1], eight_bit_uv + 1, sample_size(1).height * stride()[1]);
 291                 memset (data()[2], eight_bit_uv + 1, sample_size(2).height * stride()[2]);
 292                 break;
 293
 294         case AV_PIX_FMT_YUV422P9LE:
 295         case AV_PIX_FMT_YUV444P9LE:
 296                 yuv_16_black (nine_bit_uv, false);
 297                 break;
 298
 299         case AV_PIX_FMT_YUV422P9BE:
 300         case AV_PIX_FMT_YUV444P9BE:
 301                 yuv_16_black (swap_16 (nine_bit_uv), false);
 302                 break;
 303
 304         case AV_PIX_FMT_YUV422P10LE:
 305         case AV_PIX_FMT_YUV444P10LE:
 306                 yuv_16_black (ten_bit_uv, false);
 307                 break;
 308
 309         case AV_PIX_FMT_YUV422P16LE:
 310         case AV_PIX_FMT_YUV444P16LE:
 311                 yuv_16_black (sixteen_bit_uv, false);
 312                 break;
 313
 314         case AV_PIX_FMT_YUV444P10BE:
 315         case AV_PIX_FMT_YUV422P10BE:
 316                 yuv_16_black (swap_16 (ten_bit_uv), false);
 317                 break;
 318
 319         case AV_PIX_FMT_YUVA420P9BE:
 320         case AV_PIX_FMT_YUVA422P9BE:
 321         case AV_PIX_FMT_YUVA444P9BE:
 322                 yuv_16_black (swap_16 (nine_bit_uv), true);
 323                 break;
 324
 325         case AV_PIX_FMT_YUVA420P9LE:
 326         case AV_PIX_FMT_YUVA422P9LE:
 327         case AV_PIX_FMT_YUVA444P9LE:
 328                 yuv_16_black (nine_bit_uv, true);
 329                 break;
 330
 331         case AV_PIX_FMT_YUVA420P10BE:
 332         case AV_PIX_FMT_YUVA422P10BE:
 333         case AV_PIX_FMT_YUVA444P10BE:
 334                 yuv_16_black (swap_16 (ten_bit_uv), true);
 335                 break;
 336
 337         case AV_PIX_FMT_YUVA420P10LE:
 338         case AV_PIX_FMT_YUVA422P10LE:
 339         case AV_PIX_FMT_YUVA444P10LE:
 340                 yuv_16_black (ten_bit_uv, true);
 341                 break;
 342
 343         case AV_PIX_FMT_YUVA420P16BE:
 344         case AV_PIX_FMT_YUVA422P16BE:
 345         case AV_PIX_FMT_YUVA444P16BE:
 346                 yuv_16_black (swap_16 (sixteen_bit_uv), true);
 347                 break;
 348
 349         case AV_PIX_FMT_YUVA420P16LE:
 350         case AV_PIX_FMT_YUVA422P16LE:
 351         case AV_PIX_FMT_YUVA444P16LE:
 352                 yuv_16_black (sixteen_bit_uv, true);
 353                 break;
 354
 355         case AV_PIX_FMT_RGB24:
 356         case AV_PIX_FMT_ARGB:
 357         case AV_PIX_FMT_RGBA:
 358         case AV_PIX_FMT_ABGR:
 359         case AV_PIX_FMT_BGRA:
 360         case AV_PIX_FMT_RGB555LE:
 361         case AV_PIX_FMT_RGB48LE:
 362         case AV_PIX_FMT_RGB48BE:
 363         case AV_PIX_FMT_XYZ12LE:
 364                 memset (data()[0], 0, sample_size(0).height * stride()[0]);
 365                 break;
 366
 367         case AV_PIX_FMT_UYVY422:
 368         {
 369                 int const Y = sample_size(0).height;
 370                 int const X = line_size()[0];
 371                 uint8_t* p = data()[0];
 372                 for (int y = 0; y < Y; ++y) {
 373                         for (int x = 0; x < X / 4; ++x) {
 374                                 *p++ = eight_bit_uv; // Cb
 375                                 *p++ = 0;            // Y0
 376                                 *p++ = eight_bit_uv; // Cr
 377                                 *p++ = 0;            // Y1
 378                         }
 379                 }
 380                 break;
 381         }
 382
 383         default:
 384                 throw PixelFormatError ("make_black()", _pixel_format);
 385         }
 386 }
 387
 388 void
 389 Image::make_transparent ()
 390 {
 391         if (_pixel_format != AV_PIX_FMT_RGBA) {
 392                 throw PixelFormatError ("make_transparent()", _pixel_format);
 393         }
 394
 395         memset (data()[0], 0, sample_size(0).height * stride()[0]);
 396 }
 397
 398 void
 399 Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
 400 {
 401         DCPOMATIC_ASSERT (other->pixel_format() == AV_PIX_FMT_RGBA);
 402         int const other_bpp = 4;
 403
 404         int start_tx = position.x;
 405         int start_ox = 0;
 406
 407         if (start_tx < 0) {
 408                 start_ox = -start_tx;
 409                 start_tx = 0;
 410         }
 411
 412         int start_ty = position.y;
 413         int start_oy = 0;
 414
 415         if (start_ty < 0) {
 416                 start_oy = -start_ty;
 417                 start_ty = 0;
 418         }
 419
 420         switch (_pixel_format) {
 421         case AV_PIX_FMT_RGB24:
 422         {
 423                 int const this_bpp = 3;
 424                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 425                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 426                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 427                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 428                                 float const alpha = float (op[3]) / 255;
 429                                 tp[0] = op[0] * alpha + tp[0] * (1 - alpha);
 430                                 tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
 431                                 tp[2] = op[2] * alpha + tp[2] * (1 - alpha);
 432
 433                                 tp += this_bpp;
 434                                 op += other_bpp;
 435                         }
 436                 }
 437                 break;
 438         }
 439         case AV_PIX_FMT_BGRA:
 440         case AV_PIX_FMT_RGBA:
 441         {
 442                 int const this_bpp = 4;
 443                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 444                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 445                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 446                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 447                                 float const alpha = float (op[3]) / 255;
 448                                 tp[0] = op[0] * alpha + tp[0] * (1 - alpha);
 449                                 tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
 450                                 tp[2] = op[2] * alpha + tp[2] * (1 - alpha);
 451                                 tp[3] = op[3] * alpha + tp[3] * (1 - alpha);
 452
 453                                 tp += this_bpp;
 454                                 op += other_bpp;
 455                         }
 456                 }
 457                 break;
 458         }
 459         case AV_PIX_FMT_RGB48LE:
 460         {
 461                 int const this_bpp = 6;
 462                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 463                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 464                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 465                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 466                                 float const alpha = float (op[3]) / 255;
 467                                 /* Blend high bytes */
 468                                 tp[1] = op[0] * alpha + tp[1] * (1 - alpha);
 469                                 tp[3] = op[1] * alpha + tp[3] * (1 - alpha);
 470                                 tp[5] = op[2] * alpha + tp[5] * (1 - alpha);
 471
 472                                 tp += this_bpp;
 473                                 op += other_bpp;
 474                         }
 475                 }
 476                 break;
 477         }
 478         default:
 479                 DCPOMATIC_ASSERT (false);
 480         }
 481 }
 482
 483 void
 484 Image::copy (shared_ptr<const Image> other, Position<int> position)
 485 {
 486         /* Only implemented for RGB24 onto RGB24 so far */
 487         DCPOMATIC_ASSERT (_pixel_format == AV_PIX_FMT_RGB24 && other->pixel_format() == AV_PIX_FMT_RGB24);
 488         DCPOMATIC_ASSERT (position.x >= 0 && position.y >= 0);
 489
 490         int const N = min (position.x + other->size().width, size().width) - position.x;
 491         for (int ty = position.y, oy = 0; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 492                 uint8_t * const tp = data()[0] + ty * stride()[0] + position.x * 3;
 493                 uint8_t * const op = other->data()[0] + oy * other->stride()[0];
 494                 memcpy (tp, op, N * 3);
 495         }
 496 }
 497
 498 void
 499 Image::read_from_socket (shared_ptr<Socket> socket)
 500 {
 501         for (int i = 0; i < planes(); ++i) {
 502                 uint8_t* p = data()[i];
 503                 int const lines = sample_size(i).height;
 504                 for (int y = 0; y < lines; ++y) {
 505                         socket->read (p, line_size()[i]);
 506                         p += stride()[i];
 507                 }
 508         }
 509 }
 510
 511 void
 512 Image::write_to_socket (shared_ptr<Socket> socket) const
 513 {
 514         for (int i = 0; i < planes(); ++i) {
 515                 uint8_t* p = data()[i];
 516                 int const lines = sample_size(i).height;
 517                 for (int y = 0; y < lines; ++y) {
 518                         socket->write (p, line_size()[i]);
 519                         p += stride()[i];
 520                 }
 521         }
 522 }
 523
 524 float
 525 Image::bytes_per_pixel (int c) const
 526 {
 527         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
 528         if (!d) {
 529                 throw PixelFormatError ("bytes_per_pixel()", _pixel_format);
 530         }
 531
 532         if (c >= planes()) {
 533                 return 0;
 534         }
 535
 536         float bpp[4] = { 0, 0, 0, 0 };
 537
 538         bpp[0] = floor ((d->comp[0].depth_minus1 + 1 + 7) / 8);
 539         if (d->nb_components > 1) {
 540                 bpp[1] = floor ((d->comp[1].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 541         }
 542         if (d->nb_components > 2) {
 543                 bpp[2] = floor ((d->comp[2].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 544         }
 545         if (d->nb_components > 3) {
 546                 bpp[3] = floor ((d->comp[3].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 547         }
 548
 549         if ((d->flags & AV_PIX_FMT_FLAG_PLANAR) == 0) {
 550                 /* Not planar; sum them up */
 551                 return bpp[0] + bpp[1] + bpp[2] + bpp[3];
 552         }
 553
 554         return bpp[c];
 555 }
 556
 557 /** Construct a Image of a given size and format, allocating memory
 558  *  as required.
 559  *
 560  *  @param p Pixel format.
 561  *  @param s Size in pixels.
 562  */
 563 Image::Image (AVPixelFormat p, dcp::Size s, bool aligned)
 564         : _size (s)
 565         , _pixel_format (p)
 566         , _aligned (aligned)
 567 {
 568         allocate ();
 569 }
 570
 571 void
 572 Image::allocate ()
 573 {
 574         _data = (uint8_t **) wrapped_av_malloc (4 * sizeof (uint8_t *));
 575         _data[0] = _data[1] = _data[2] = _data[3] = 0;
 576
 577         _line_size = (int *) wrapped_av_malloc (4 * sizeof (int));
 578         _line_size[0] = _line_size[1] = _line_size[2] = _line_size[3] = 0;
 579
 580         _stride = (int *) wrapped_av_malloc (4 * sizeof (int));
 581         _stride[0] = _stride[1] = _stride[2] = _stride[3] = 0;
 582
 583         for (int i = 0; i < planes(); ++i) {
 584                 _line_size[i] = ceil (_size.width * bytes_per_pixel(i));
 585                 _stride[i] = stride_round_up (i, _line_size, _aligned ? 32 : 1);
 586
 587                 /* The assembler function ff_rgb24ToY_avx (in libswscale/x86/input.asm)
 588                    uses a 16-byte fetch to read three bytes (R/G/B) of image data.
 589                    Hence on the last pixel of the last line it reads over the end of
 590                    the actual data by 1 byte.  If the width of an image is a multiple
 591                    of the stride alignment there will be no padding at the end of image lines.
 592                    OS X crashes on this illegal read, though other operating systems don't
 593                    seem to mind.  The nasty + 1 in this malloc makes sure there is always a byte
 594                    for that instruction to read safely.
 595
 596                    Further to the above, valgrind is now telling me that ff_rgb24ToY_ssse3
 597                    over-reads by more then _avx.  I can't follow the code to work out how much,
 598                    so I'll just over-allocate by 32 bytes and have done with it.  Empirical
 599                    testing suggests that it works.
 600                 */
 601                 _data[i] = (uint8_t *) wrapped_av_malloc (_stride[i] * sample_size(i).height + 32);
 602         }
 603 }
 604
 605 Image::Image (Image const & other)
 606         : _size (other._size)
 607         , _pixel_format (other._pixel_format)
 608         , _aligned (other._aligned)
 609 {
 610         allocate ();
 611
 612         for (int i = 0; i < planes(); ++i) {
 613                 uint8_t* p = _data[i];
 614                 uint8_t* q = other._data[i];
 615                 int const lines = sample_size(i).height;
 616                 for (int j = 0; j < lines; ++j) {
 617                         memcpy (p, q, _line_size[i]);
 618                         p += stride()[i];
 619                         q += other.stride()[i];
 620                 }
 621         }
 622 }
 623
 624 Image::Image (AVFrame* frame)
 625         : _size (frame->width, frame->height)
 626         , _pixel_format (static_cast<AVPixelFormat> (frame->format))
 627         , _aligned (true)
 628 {
 629         allocate ();
 630
 631         for (int i = 0; i < planes(); ++i) {
 632                 uint8_t* p = _data[i];
 633                 uint8_t* q = frame->data[i];
 634                 int const lines = sample_size(i).height;
 635                 for (int j = 0; j < lines; ++j) {
 636                         memcpy (p, q, _line_size[i]);
 637                         p += stride()[i];
 638                         /* AVFrame's linesize is what we call `stride' */
 639                         q += frame->linesize[i];
 640                 }
 641         }
 642 }
 643
 644 Image::Image (shared_ptr<const Image> other, bool aligned)
 645         : _size (other->_size)
 646         , _pixel_format (other->_pixel_format)
 647         , _aligned (aligned)
 648 {
 649         allocate ();
 650
 651         for (int i = 0; i < planes(); ++i) {
 652                 DCPOMATIC_ASSERT (line_size()[i] == other->line_size()[i]);
 653                 uint8_t* p = _data[i];
 654                 uint8_t* q = other->data()[i];
 655                 int const lines = sample_size(i).height;
 656                 for (int j = 0; j < lines; ++j) {
 657                         memcpy (p, q, line_size()[i]);
 658                         p += stride()[i];
 659                         q += other->stride()[i];
 660                 }
 661         }
 662 }
 663
 664 Image&
 665 Image::operator= (Image const & other)
 666 {
 667         if (this == &other) {
 668                 return *this;
 669         }
 670
 671         Image tmp (other);
 672         swap (tmp);
 673         return *this;
 674 }
 675
 676 void
 677 Image::swap (Image & other)
 678 {
 679         std::swap (_size, other._size);
 680         std::swap (_pixel_format, other._pixel_format);
 681
 682         for (int i = 0; i < 4; ++i) {
 683                 std::swap (_data[i], other._data[i]);
 684                 std::swap (_line_size[i], other._line_size[i]);
 685                 std::swap (_stride[i], other._stride[i]);
 686         }
 687
 688         std::swap (_aligned, other._aligned);
 689 }
 690
 691 /** Destroy a Image */
 692 Image::~Image ()
 693 {
 694         for (int i = 0; i < planes(); ++i) {
 695                 av_free (_data[i]);
 696         }
 697
 698         av_free (_data);
 699         av_free (_line_size);
 700         av_free (_stride);
 701 }
 702
 703 uint8_t * const *
 704 Image::data () const
 705 {
 706         return _data;
 707 }
 708
 709 int const *
 710 Image::line_size () const
 711 {
 712         return _line_size;
 713 }
 714
 715 int const *
 716 Image::stride () const
 717 {
 718         return _stride;
 719 }
 720
 721 dcp::Size
 722 Image::size () const
 723 {
 724         return _size;
 725 }
 726
 727 bool
 728 Image::aligned () const
 729 {
 730         return _aligned;
 731 }
 732
 733 PositionImage
 734 merge (list<PositionImage> images)
 735 {
 736         if (images.empty ()) {
 737                 return PositionImage ();
 738         }
 739
 740         if (images.size() == 1) {
 741                 return images.front ();
 742         }
 743
 744         dcpomatic::Rect<int> all (images.front().position, images.front().image->size().width, images.front().image->size().height);
 745         for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
 746                 all.extend (dcpomatic::Rect<int> (i->position, i->image->size().width, i->image->size().height));
 747         }
 748
 749         shared_ptr<Image> merged (new Image (images.front().image->pixel_format (), dcp::Size (all.width, all.height), true));
 750         merged->make_transparent ();
 751         for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
 752                 merged->alpha_blend (i->image, i->position - all.position());
 753         }
 754
 755         return PositionImage (merged, all.position ());
 756 }
 757
 758 bool
 759 operator== (Image const & a, Image const & b)
 760 {
 761         if (a.planes() != b.planes() || a.pixel_format() != b.pixel_format() || a.aligned() != b.aligned()) {
 762                 return false;
 763         }
 764
 765         for (int c = 0; c < a.planes(); ++c) {
 766                 if (a.sample_size(c).height != b.sample_size(c).height || a.line_size()[c] != b.line_size()[c] || a.stride()[c] != b.stride()[c]) {
 767                         return false;
 768                 }
 769
 770                 uint8_t* p = a.data()[c];
 771                 uint8_t* q = b.data()[c];
 772                 int const lines = a.sample_size(c).height;
 773                 for (int y = 0; y < lines; ++y) {
 774                         if (memcmp (p, q, a.line_size()[c]) != 0) {
 775                                 return false;
 776                         }
 777
 778                         p += a.stride()[c];
 779                         q += b.stride()[c];
 780                 }
 781         }
 782
 783         return true;
 784 }
 785
 786 /** Fade the image.
 787  *  @param f Amount to fade by; 0 is black, 1 is no fade.
 788  */
 789 void
 790 Image::fade (float f)
 791 {
 792         switch (_pixel_format) {
 793         case AV_PIX_FMT_YUV420P:
 794         case AV_PIX_FMT_YUV422P:
 795         case AV_PIX_FMT_YUV444P:
 796         case AV_PIX_FMT_YUV411P:
 797         case AV_PIX_FMT_YUVJ420P:
 798         case AV_PIX_FMT_YUVJ422P:
 799         case AV_PIX_FMT_YUVJ444P:
 800         case AV_PIX_FMT_RGB24:
 801         case AV_PIX_FMT_ARGB:
 802         case AV_PIX_FMT_RGBA:
 803         case AV_PIX_FMT_ABGR:
 804         case AV_PIX_FMT_BGRA:
 805         case AV_PIX_FMT_RGB555LE:
 806                 /* 8-bit */
 807                 for (int c = 0; c < 3; ++c) {
 808                         uint8_t* p = data()[c];
 809                         int const lines = sample_size(c).height;
 810                         for (int y = 0; y < lines; ++y) {
 811                                 uint8_t* q = p;
 812                                 for (int x = 0; x < line_size()[c]; ++x) {
 813                                         *q = int (float (*q) * f);
 814                                         ++q;
 815                                 }
 816                                 p += stride()[c];
 817                         }
 818                 }
 819                 break;
 820
 821         case AV_PIX_FMT_YUV422P9LE:
 822         case AV_PIX_FMT_YUV444P9LE:
 823         case AV_PIX_FMT_YUV422P10LE:
 824         case AV_PIX_FMT_YUV444P10LE:
 825         case AV_PIX_FMT_YUV422P16LE:
 826         case AV_PIX_FMT_YUV444P16LE:
 827         case AV_PIX_FMT_YUVA420P9LE:
 828         case AV_PIX_FMT_YUVA422P9LE:
 829         case AV_PIX_FMT_YUVA444P9LE:
 830         case AV_PIX_FMT_YUVA420P10LE:
 831         case AV_PIX_FMT_YUVA422P10LE:
 832         case AV_PIX_FMT_YUVA444P10LE:
 833         case AV_PIX_FMT_RGB48LE:
 834         case AV_PIX_FMT_XYZ12LE:
 835                 /* 16-bit little-endian */
 836                 for (int c = 0; c < 3; ++c) {
 837                         int const stride_pixels = stride()[c] / 2;
 838                         int const line_size_pixels = line_size()[c] / 2;
 839                         uint16_t* p = reinterpret_cast<uint16_t*> (data()[c]);
 840                         int const lines = sample_size(c).height;
 841                         for (int y = 0; y < lines; ++y) {
 842                                 uint16_t* q = p;
 843                                 for (int x = 0; x < line_size_pixels; ++x) {
 844                                         *q = int (float (*q) * f);
 845                                         ++q;
 846                                 }
 847                                 p += stride_pixels;
 848                         }
 849                 }
 850                 break;
 851
 852         case AV_PIX_FMT_YUV422P9BE:
 853         case AV_PIX_FMT_YUV444P9BE:
 854         case AV_PIX_FMT_YUV444P10BE:
 855         case AV_PIX_FMT_YUV422P10BE:
 856         case AV_PIX_FMT_YUVA420P9BE:
 857         case AV_PIX_FMT_YUVA422P9BE:
 858         case AV_PIX_FMT_YUVA444P9BE:
 859         case AV_PIX_FMT_YUVA420P10BE:
 860         case AV_PIX_FMT_YUVA422P10BE:
 861         case AV_PIX_FMT_YUVA444P10BE:
 862         case AV_PIX_FMT_YUVA420P16BE:
 863         case AV_PIX_FMT_YUVA422P16BE:
 864         case AV_PIX_FMT_YUVA444P16BE:
 865         case AV_PIX_FMT_RGB48BE:
 866                 /* 16-bit big-endian */
 867                 for (int c = 0; c < 3; ++c) {
 868                         int const stride_pixels = stride()[c] / 2;
 869                         int const line_size_pixels = line_size()[c] / 2;
 870                         uint16_t* p = reinterpret_cast<uint16_t*> (data()[c]);
 871                         int const lines = sample_size(c).height;
 872                         for (int y = 0; y < lines; ++y) {
 873                                 uint16_t* q = p;
 874                                 for (int x = 0; x < line_size_pixels; ++x) {
 875                                         *q = swap_16 (int (float (swap_16 (*q)) * f));
 876                                         ++q;
 877                                 }
 878                                 p += stride_pixels;
 879                         }
 880                 }
 881                 break;
 882
 883         case AV_PIX_FMT_UYVY422:
 884         {
 885                 int const Y = sample_size(0).height;
 886                 int const X = line_size()[0];
 887                 uint8_t* p = data()[0];
 888                 for (int y = 0; y < Y; ++y) {
 889                         for (int x = 0; x < X; ++x) {
 890                                 *p = int (float (*p) * f);
 891                                 ++p;
 892                         }
 893                 }
 894                 break;
 895         }
 896
 897         default:
 898                 throw PixelFormatError ("fade()", _pixel_format);
 899         }
 900 }