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