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