src/lib/image.cc

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