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