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