src/lib/image.cc

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