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