src/lib/image.cc

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