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 void
 433 Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
 434 {
 435         /* We're blending RGBA images; first byte is blue, second byte is green, third byte blue, fourth byte alpha */
 436         DCPOMATIC_ASSERT (other->pixel_format() == AV_PIX_FMT_RGBA);
 437         int const other_bpp = 4;
 438
 439         int start_tx = position.x;
 440         int start_ox = 0;
 441
 442         if (start_tx < 0) {
 443                 start_ox = -start_tx;
 444                 start_tx = 0;
 445         }
 446
 447         int start_ty = position.y;
 448         int start_oy = 0;
 449
 450         if (start_ty < 0) {
 451                 start_oy = -start_ty;
 452                 start_ty = 0;
 453         }
 454
 455         switch (_pixel_format) {
 456         case AV_PIX_FMT_RGB24:
 457         {
 458                 /* Going onto RGB24.  First byte is red, second green, third blue */
 459                 int const this_bpp = 3;
 460                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 461                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 462                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 463                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 464                                 float const alpha = float (op[3]) / 255;
 465                                 tp[0] = op[2] * alpha + tp[0] * (1 - alpha);
 466                                 tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
 467                                 tp[2] = op[0] * alpha + tp[2] * (1 - alpha);
 468
 469                                 tp += this_bpp;
 470                                 op += other_bpp;
 471                         }
 472                 }
 473                 break;
 474         }
 475         case AV_PIX_FMT_BGRA:
 476         case AV_PIX_FMT_RGBA:
 477         {
 478                 int const this_bpp = 4;
 479                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 480                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 481                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 482                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 483                                 float const alpha = float (op[3]) / 255;
 484                                 tp[0] = op[0] * alpha + tp[0] * (1 - alpha);
 485                                 tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
 486                                 tp[2] = op[2] * alpha + tp[2] * (1 - alpha);
 487                                 tp[3] = op[3] * alpha + tp[3] * (1 - alpha);
 488
 489                                 tp += this_bpp;
 490                                 op += other_bpp;
 491                         }
 492                 }
 493                 break;
 494         }
 495         case AV_PIX_FMT_RGB48LE:
 496         {
 497                 int const this_bpp = 6;
 498                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 499                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 500                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 501                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 502                                 float const alpha = float (op[3]) / 255;
 503                                 /* Blend high bytes; the RGBA in op appears to be BGRA */
 504                                 tp[1] = op[2] * alpha + tp[1] * (1 - alpha);
 505                                 tp[3] = op[1] * alpha + tp[3] * (1 - alpha);
 506                                 tp[5] = op[0] * alpha + tp[5] * (1 - alpha);
 507
 508                                 tp += this_bpp;
 509                                 op += other_bpp;
 510                         }
 511                 }
 512                 break;
 513         }
 514         case AV_PIX_FMT_XYZ12LE:
 515         {
 516                 dcp::ColourConversion conv = dcp::ColourConversion::srgb_to_xyz();
 517                 double fast_matrix[9];
 518                 dcp::combined_rgb_to_xyz (conv, fast_matrix);
 519                 double const * lut_in = conv.in()->lut (8, false);
 520                 double const * lut_out = conv.out()->lut (16, true);
 521                 int const this_bpp = 6;
 522                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 523                         uint16_t* tp = reinterpret_cast<uint16_t*> (data()[0] + ty * stride()[0] + start_tx * this_bpp);
 524                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 525                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 526                                 float const alpha = float (op[3]) / 255;
 527
 528                                 /* Convert sRGB to XYZ; op is BGRA.  First, input gamma LUT */
 529                                 double const r = lut_in[op[2]];
 530                                 double const g = lut_in[op[1]];
 531                                 double const b = lut_in[op[0]];
 532
 533                                 /* RGB to XYZ, including Bradford transform and DCI companding */
 534                                 double const x = max (0.0, min (65535.0, r * fast_matrix[0] + g * fast_matrix[1] + b * fast_matrix[2]));
 535                                 double const y = max (0.0, min (65535.0, r * fast_matrix[3] + g * fast_matrix[4] + b * fast_matrix[5]));
 536                                 double const z = max (0.0, min (65535.0, r * fast_matrix[6] + g * fast_matrix[7] + b * fast_matrix[8]));
 537
 538                                 /* Out gamma LUT and blend */
 539                                 tp[0] = lrint(lut_out[lrint(x)] * 65535) * alpha + tp[0] * (1 - alpha);
 540                                 tp[1] = lrint(lut_out[lrint(y)] * 65535) * alpha + tp[1] * (1 - alpha);
 541                                 tp[2] = lrint(lut_out[lrint(z)] * 65535) * alpha + tp[2] * (1 - alpha);
 542
 543                                 tp += this_bpp / 2;
 544                                 op += other_bpp;
 545                         }
 546                 }
 547                 break;
 548         }
 549         case AV_PIX_FMT_YUV420P:
 550         case AV_PIX_FMT_YUV420P10:
 551         {
 552                 shared_ptr<Image> yuv = other->scale (other->size(), dcp::YUV_TO_RGB_REC709, _pixel_format, false, false);
 553
 554                 for (int i = 0; i < 3; ++i) {
 555                         dcp::Size const tsize = sample_size(i);
 556                         dcp::Size const osize = yuv->sample_size(i);
 557                         int const tbpp = ceil (bytes_per_pixel(i) / horizontal_factor(i));
 558                         int const obpp = ceil (yuv->bytes_per_pixel(i) / yuv->horizontal_factor(i));
 559                         int const abpp = other->bytes_per_pixel(0);
 560                         start_tx /= horizontal_factor (i);
 561                         start_ty /= vertical_factor (i);
 562                         start_ox /= yuv->horizontal_factor (i);
 563                         start_oy /= yuv->vertical_factor (i);
 564                         for (int ty = start_ty, oy = start_oy; ty < tsize.height && oy < osize.height; ++ty, ++oy) {
 565                                 /* this image */
 566                                 uint8_t* tp = data()[i] + ty * stride()[i] + start_tx * tbpp;
 567                                 /* overlay image */
 568                                 uint8_t* op = yuv->data()[i] + oy * yuv->stride()[i];
 569                                 /* original RGBA for alpha channel */
 570                                 uint8_t* ap = other->data()[0] + oy * other->stride()[0];
 571                                 for (int tx = start_tx, ox = start_ox; tx < tsize.width && ox < osize.width; ++tx, ++ox) {
 572                                         float const alpha = float (ap[3]) / 255;
 573                                         *tp = *op * alpha + *tp * (1 - alpha);
 574                                         tp += tbpp;
 575                                         op += obpp;
 576                                         ap += abpp;
 577                                 }
 578                         }
 579                 }
 580                 break;
 581         }
 582         default:
 583                 throw PixelFormatError ("alpha_blend()", _pixel_format);
 584         }
 585 }
 586
 587 void
 588 Image::copy (shared_ptr<const Image> other, Position<int> position)
 589 {
 590         /* Only implemented for RGB24 onto RGB24 so far */
 591         DCPOMATIC_ASSERT (_pixel_format == AV_PIX_FMT_RGB24 && other->pixel_format() == AV_PIX_FMT_RGB24);
 592         DCPOMATIC_ASSERT (position.x >= 0 && position.y >= 0);
 593
 594         int const N = min (position.x + other->size().width, size().width) - position.x;
 595         for (int ty = position.y, oy = 0; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 596                 uint8_t * const tp = data()[0] + ty * stride()[0] + position.x * 3;
 597                 uint8_t * const op = other->data()[0] + oy * other->stride()[0];
 598                 memcpy (tp, op, N * 3);
 599         }
 600 }
 601
 602 void
 603 Image::read_from_socket (shared_ptr<Socket> socket)
 604 {
 605         for (int i = 0; i < planes(); ++i) {
 606                 uint8_t* p = data()[i];
 607                 int const lines = sample_size(i).height;
 608                 for (int y = 0; y < lines; ++y) {
 609                         socket->read (p, line_size()[i]);
 610                         p += stride()[i];
 611                 }
 612         }
 613 }
 614
 615 void
 616 Image::write_to_socket (shared_ptr<Socket> socket) const
 617 {
 618         for (int i = 0; i < planes(); ++i) {
 619                 uint8_t* p = data()[i];
 620                 int const lines = sample_size(i).height;
 621                 for (int y = 0; y < lines; ++y) {
 622                         socket->write (p, line_size()[i]);
 623                         p += stride()[i];
 624                 }
 625         }
 626 }
 627
 628 float
 629 Image::bytes_per_pixel (int c) const
 630 {
 631         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
 632         if (!d) {
 633                 throw PixelFormatError ("bytes_per_pixel()", _pixel_format);
 634         }
 635
 636         if (c >= planes()) {
 637                 return 0;
 638         }
 639
 640         float bpp[4] = { 0, 0, 0, 0 };
 641
 642 #ifdef DCPOMATIC_HAVE_AVCOMPONENTDESCRIPTOR_DEPTH_MINUS1
 643         bpp[0] = floor ((d->comp[0].depth_minus1 + 8) / 8);
 644         if (d->nb_components > 1) {
 645                 bpp[1] = floor ((d->comp[1].depth_minus1 + 8) / 8) / pow (2.0f, d->log2_chroma_w);
 646         }
 647         if (d->nb_components > 2) {
 648                 bpp[2] = floor ((d->comp[2].depth_minus1 + 8) / 8) / pow (2.0f, d->log2_chroma_w);
 649         }
 650         if (d->nb_components > 3) {
 651                 bpp[3] = floor ((d->comp[3].depth_minus1 + 8) / 8) / pow (2.0f, d->log2_chroma_w);
 652         }
 653 #else
 654         bpp[0] = floor ((d->comp[0].depth + 7) / 8);
 655         if (d->nb_components > 1) {
 656                 bpp[1] = floor ((d->comp[1].depth + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 657         }
 658         if (d->nb_components > 2) {
 659                 bpp[2] = floor ((d->comp[2].depth + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 660         }
 661         if (d->nb_components > 3) {
 662                 bpp[3] = floor ((d->comp[3].depth + 7) / 8) / pow (2.0f, d->log2_chroma_w);
 663         }
 664 #endif
 665
 666         if ((d->flags & AV_PIX_FMT_FLAG_PLANAR) == 0) {
 667                 /* Not planar; sum them up */
 668                 return bpp[0] + bpp[1] + bpp[2] + bpp[3];
 669         }
 670
 671         return bpp[c];
 672 }
 673
 674 /** Construct a Image of a given size and format, allocating memory
 675  *  as required.
 676  *
 677  *  @param p Pixel format.
 678  *  @param s Size in pixels.
 679  *  @param aligned true to make each row of this image aligned to a 32-byte boundary.
 680  *  @param extra_pixels Amount of extra "run-off" memory to allocate at the end of each plane in pixels.
 681  */
 682 Image::Image (AVPixelFormat p, dcp::Size s, bool aligned, int extra_pixels)
 683         : _size (s)
 684         , _pixel_format (p)
 685         , _aligned (aligned)
 686         , _extra_pixels (extra_pixels)
 687 {
 688         allocate ();
 689 }
 690
 691 void
 692 Image::allocate ()
 693 {
 694         _data = (uint8_t **) wrapped_av_malloc (4 * sizeof (uint8_t *));
 695         _data[0] = _data[1] = _data[2] = _data[3] = 0;
 696
 697         _line_size = (int *) wrapped_av_malloc (4 * sizeof (int));
 698         _line_size[0] = _line_size[1] = _line_size[2] = _line_size[3] = 0;
 699
 700         _stride = (int *) wrapped_av_malloc (4 * sizeof (int));
 701         _stride[0] = _stride[1] = _stride[2] = _stride[3] = 0;
 702
 703         for (int i = 0; i < planes(); ++i) {
 704                 _line_size[i] = ceil (_size.width * bytes_per_pixel(i));
 705                 _stride[i] = stride_round_up (i, _line_size, _aligned ? 32 : 1);
 706
 707                 /* The assembler function ff_rgb24ToY_avx (in libswscale/x86/input.asm)
 708                    uses a 16-byte fetch to read three bytes (R/G/B) of image data.
 709                    Hence on the last pixel of the last line it reads over the end of
 710                    the actual data by 1 byte.  If the width of an image is a multiple
 711                    of the stride alignment there will be no padding at the end of image lines.
 712                    OS X crashes on this illegal read, though other operating systems don't
 713                    seem to mind.  The nasty + 1 in this malloc makes sure there is always a byte
 714                    for that instruction to read safely.
 715
 716                    Further to the above, valgrind is now telling me that ff_rgb24ToY_ssse3
 717                    over-reads by more then _avx.  I can't follow the code to work out how much,
 718                    so I'll just over-allocate by 32 bytes and have done with it.  Empirical
 719                    testing suggests that it works.
 720                 */
 721                 _data[i] = (uint8_t *) wrapped_av_malloc (_stride[i] * sample_size(i).height + _extra_pixels * bytes_per_pixel(i) + 32);
 722         }
 723 }
 724
 725 Image::Image (Image const & other)
 726         : _size (other._size)
 727         , _pixel_format (other._pixel_format)
 728         , _aligned (other._aligned)
 729         , _extra_pixels (other._extra_pixels)
 730 {
 731         allocate ();
 732
 733         for (int i = 0; i < planes(); ++i) {
 734                 uint8_t* p = _data[i];
 735                 uint8_t* q = other._data[i];
 736                 int const lines = sample_size(i).height;
 737                 for (int j = 0; j < lines; ++j) {
 738                         memcpy (p, q, _line_size[i]);
 739                         p += stride()[i];
 740                         q += other.stride()[i];
 741                 }
 742         }
 743 }
 744
 745 Image::Image (AVFrame* frame)
 746         : _size (frame->width, frame->height)
 747         , _pixel_format (static_cast<AVPixelFormat> (frame->format))
 748         , _aligned (true)
 749         , _extra_pixels (0)
 750 {
 751         allocate ();
 752
 753         for (int i = 0; i < planes(); ++i) {
 754                 uint8_t* p = _data[i];
 755                 uint8_t* q = frame->data[i];
 756                 int const lines = sample_size(i).height;
 757                 for (int j = 0; j < lines; ++j) {
 758                         memcpy (p, q, _line_size[i]);
 759                         p += stride()[i];
 760                         /* AVFrame's linesize is what we call `stride' */
 761                         q += frame->linesize[i];
 762                 }
 763         }
 764 }
 765
 766 Image::Image (shared_ptr<const Image> other, bool aligned)
 767         : _size (other->_size)
 768         , _pixel_format (other->_pixel_format)
 769         , _aligned (aligned)
 770         , _extra_pixels (other->_extra_pixels)
 771 {
 772         allocate ();
 773
 774         for (int i = 0; i < planes(); ++i) {
 775                 DCPOMATIC_ASSERT (line_size()[i] == other->line_size()[i]);
 776                 uint8_t* p = _data[i];
 777                 uint8_t* q = other->data()[i];
 778                 int const lines = sample_size(i).height;
 779                 for (int j = 0; j < lines; ++j) {
 780                         memcpy (p, q, line_size()[i]);
 781                         p += stride()[i];
 782                         q += other->stride()[i];
 783                 }
 784         }
 785 }
 786
 787 Image&
 788 Image::operator= (Image const & other)
 789 {
 790         if (this == &other) {
 791                 return *this;
 792         }
 793
 794         Image tmp (other);
 795         swap (tmp);
 796         return *this;
 797 }
 798
 799 void
 800 Image::swap (Image & other)
 801 {
 802         std::swap (_size, other._size);
 803         std::swap (_pixel_format, other._pixel_format);
 804
 805         for (int i = 0; i < 4; ++i) {
 806                 std::swap (_data[i], other._data[i]);
 807                 std::swap (_line_size[i], other._line_size[i]);
 808                 std::swap (_stride[i], other._stride[i]);
 809         }
 810
 811         std::swap (_aligned, other._aligned);
 812         std::swap (_extra_pixels, other._extra_pixels);
 813 }
 814
 815 /** Destroy a Image */
 816 Image::~Image ()
 817 {
 818         for (int i = 0; i < planes(); ++i) {
 819                 av_free (_data[i]);
 820         }
 821
 822         av_free (_data);
 823         av_free (_line_size);
 824         av_free (_stride);
 825 }
 826
 827 uint8_t * const *
 828 Image::data () const
 829 {
 830         return _data;
 831 }
 832
 833 int const *
 834 Image::line_size () const
 835 {
 836         return _line_size;
 837 }
 838
 839 int const *
 840 Image::stride () const
 841 {
 842         return _stride;
 843 }
 844
 845 dcp::Size
 846 Image::size () const
 847 {
 848         return _size;
 849 }
 850
 851 bool
 852 Image::aligned () const
 853 {
 854         return _aligned;
 855 }
 856
 857 PositionImage
 858 merge (list<PositionImage> images)
 859 {
 860         if (images.empty ()) {
 861                 return PositionImage ();
 862         }
 863
 864         if (images.size() == 1) {
 865                 return images.front ();
 866         }
 867
 868         dcpomatic::Rect<int> all (images.front().position, images.front().image->size().width, images.front().image->size().height);
 869         for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
 870                 all.extend (dcpomatic::Rect<int> (i->position, i->image->size().width, i->image->size().height));
 871         }
 872
 873         shared_ptr<Image> merged (new Image (images.front().image->pixel_format (), dcp::Size (all.width, all.height), true));
 874         merged->make_transparent ();
 875         for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
 876                 merged->alpha_blend (i->image, i->position - all.position());
 877         }
 878
 879         return PositionImage (merged, all.position ());
 880 }
 881
 882 bool
 883 operator== (Image const & a, Image const & b)
 884 {
 885         if (a.planes() != b.planes() || a.pixel_format() != b.pixel_format() || a.aligned() != b.aligned()) {
 886                 return false;
 887         }
 888
 889         for (int c = 0; c < a.planes(); ++c) {
 890                 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]) {
 891                         return false;
 892                 }
 893
 894                 uint8_t* p = a.data()[c];
 895                 uint8_t* q = b.data()[c];
 896                 int const lines = a.sample_size(c).height;
 897                 for (int y = 0; y < lines; ++y) {
 898                         if (memcmp (p, q, a.line_size()[c]) != 0) {
 899                                 return false;
 900                         }
 901
 902                         p += a.stride()[c];
 903                         q += b.stride()[c];
 904                 }
 905         }
 906
 907         return true;
 908 }
 909
 910 /** Fade the image.
 911  *  @param f Amount to fade by; 0 is black, 1 is no fade.
 912  */
 913 void
 914 Image::fade (float f)
 915 {
 916         switch (_pixel_format) {
 917         case AV_PIX_FMT_YUV420P:
 918         case AV_PIX_FMT_YUV422P:
 919         case AV_PIX_FMT_YUV444P:
 920         case AV_PIX_FMT_YUV411P:
 921         case AV_PIX_FMT_YUVJ420P:
 922         case AV_PIX_FMT_YUVJ422P:
 923         case AV_PIX_FMT_YUVJ444P:
 924         case AV_PIX_FMT_RGB24:
 925         case AV_PIX_FMT_ARGB:
 926         case AV_PIX_FMT_RGBA:
 927         case AV_PIX_FMT_ABGR:
 928         case AV_PIX_FMT_BGRA:
 929         case AV_PIX_FMT_RGB555LE:
 930                 /* 8-bit */
 931                 for (int c = 0; c < 3; ++c) {
 932                         uint8_t* p = data()[c];
 933                         int const lines = sample_size(c).height;
 934                         for (int y = 0; y < lines; ++y) {
 935                                 uint8_t* q = p;
 936                                 for (int x = 0; x < line_size()[c]; ++x) {
 937                                         *q = int (float (*q) * f);
 938                                         ++q;
 939                                 }
 940                                 p += stride()[c];
 941                         }
 942                 }
 943                 break;
 944
 945         case AV_PIX_FMT_YUV422P9LE:
 946         case AV_PIX_FMT_YUV444P9LE:
 947         case AV_PIX_FMT_YUV422P10LE:
 948         case AV_PIX_FMT_YUV444P10LE:
 949         case AV_PIX_FMT_YUV422P16LE:
 950         case AV_PIX_FMT_YUV444P16LE:
 951         case AV_PIX_FMT_YUVA420P9LE:
 952         case AV_PIX_FMT_YUVA422P9LE:
 953         case AV_PIX_FMT_YUVA444P9LE:
 954         case AV_PIX_FMT_YUVA420P10LE:
 955         case AV_PIX_FMT_YUVA422P10LE:
 956         case AV_PIX_FMT_YUVA444P10LE:
 957         case AV_PIX_FMT_RGB48LE:
 958         case AV_PIX_FMT_XYZ12LE:
 959                 /* 16-bit little-endian */
 960                 for (int c = 0; c < 3; ++c) {
 961                         int const stride_pixels = stride()[c] / 2;
 962                         int const line_size_pixels = line_size()[c] / 2;
 963                         uint16_t* p = reinterpret_cast<uint16_t*> (data()[c]);
 964                         int const lines = sample_size(c).height;
 965                         for (int y = 0; y < lines; ++y) {
 966                                 uint16_t* q = p;
 967                                 for (int x = 0; x < line_size_pixels; ++x) {
 968                                         *q = int (float (*q) * f);
 969                                         ++q;
 970                                 }
 971                                 p += stride_pixels;
 972                         }
 973                 }
 974                 break;
 975
 976         case AV_PIX_FMT_YUV422P9BE:
 977         case AV_PIX_FMT_YUV444P9BE:
 978         case AV_PIX_FMT_YUV444P10BE:
 979         case AV_PIX_FMT_YUV422P10BE:
 980         case AV_PIX_FMT_YUVA420P9BE:
 981         case AV_PIX_FMT_YUVA422P9BE:
 982         case AV_PIX_FMT_YUVA444P9BE:
 983         case AV_PIX_FMT_YUVA420P10BE:
 984         case AV_PIX_FMT_YUVA422P10BE:
 985         case AV_PIX_FMT_YUVA444P10BE:
 986         case AV_PIX_FMT_YUVA420P16BE:
 987         case AV_PIX_FMT_YUVA422P16BE:
 988         case AV_PIX_FMT_YUVA444P16BE:
 989         case AV_PIX_FMT_RGB48BE:
 990                 /* 16-bit big-endian */
 991                 for (int c = 0; c < 3; ++c) {
 992                         int const stride_pixels = stride()[c] / 2;
 993                         int const line_size_pixels = line_size()[c] / 2;
 994                         uint16_t* p = reinterpret_cast<uint16_t*> (data()[c]);
 995                         int const lines = sample_size(c).height;
 996                         for (int y = 0; y < lines; ++y) {
 997                                 uint16_t* q = p;
 998                                 for (int x = 0; x < line_size_pixels; ++x) {
 999                                         *q = swap_16 (int (float (swap_16 (*q)) * f));
1000                                         ++q;
1001                                 }
1002                                 p += stride_pixels;
1003                         }
1004                 }
1005                 break;
1006
1007         case AV_PIX_FMT_UYVY422:
1008         {
1009                 int const Y = sample_size(0).height;
1010                 int const X = line_size()[0];
1011                 uint8_t* p = data()[0];
1012                 for (int y = 0; y < Y; ++y) {
1013                         for (int x = 0; x < X; ++x) {
1014                                 *p = int (float (*p) * f);
1015                                 ++p;
1016                         }
1017                 }
1018                 break;
1019         }
1020
1021         default:
1022                 throw PixelFormatError ("fade()", _pixel_format);
1023         }
1024 }