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 #include <dcp/rgb_xyz.h>
  32 #include <dcp/transfer_function.h>
  33 extern "C" {
  34 #include <libswscale/swscale.h>
  35 #include <libavutil/pixfmt.h>
  36 #include <libavutil/pixdesc.h>
  37 #include <libavutil/frame.h>
  38 }
  39 #include <iostream>
  40
  41 #include "i18n.h"
  42
  43 using std::string;
  44 using std::min;
  45 using std::max;
  46 using std::cout;
  47 using std::cerr;
  48 using std::list;
  49 using std::runtime_error;
  50 using boost::shared_ptr;
  51 using dcp::Size;
  52
  53 int
  54 Image::line_factor (int n) const
  55 {
  56         if (n == 0) {
  57                 return 1;
  58         }
  59
  60         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
  61         if (!d) {
  62                 throw PixelFormatError ("line_factor()", _pixel_format);
  63         }
  64
  65         return pow (2.0f, d->log2_chroma_h);
  66 }
  67
  68 /** @param n Component index.
  69  *  @return Number of samples (i.e. pixels, unless sub-sampled) in each direction for this component.
  70  */
  71 dcp::Size
  72 Image::sample_size (int n) const
  73 {
  74         int horizontal_factor = 1;
  75         if (n > 0) {
  76                 AVPixFmtDescriptor const * d = av_pix_fmt_desc_get (_pixel_format);
  77                 if (!d) {
  78                         throw PixelFormatError ("sample_size()", _pixel_format);
  79                 }
  80                 horizontal_factor = pow (2.0f, d->log2_chroma_w);
  81         }
  82
  83         return dcp::Size (
  84                 lrint (ceil (static_cast<double>(size().width) / horizontal_factor)),
  85                 lrint (ceil (static_cast<double>(size().height) / line_factor (n)))
  86                 );
  87 }
  88
  89 /** @return Number of planes */
  90 int
  91 Image::planes () const
  92 {
  93         AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
  94         if (!d) {
  95                 throw PixelFormatError ("planes()", _pixel_format);
  96         }
  97
  98         if ((d->flags & AV_PIX_FMT_FLAG_PLANAR) == 0) {
  99                 return 1;
 100         }
 101
 102         return d->nb_components;
 103 }
 104
 105 /** Crop this image, scale it to `inter_size' and then place it in a black frame of `out_size'.
 106  *  @param fast Try to be fast at the possible expense of quality; at present this means using
 107  *  fast bilinear rather than bicubic scaling.
 108  */
 109 shared_ptr<Image>
 110 Image::crop_scale_window (
 111         Crop crop, dcp::Size inter_size, dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned, bool fast
 112         ) const
 113 {
 114         /* Empirical testing suggests that sws_scale() will crash if
 115            the input image is not aligned.
 116         */
 117         DCPOMATIC_ASSERT (aligned ());
 118
 119         DCPOMATIC_ASSERT (out_size.width >= inter_size.width);
 120         DCPOMATIC_ASSERT (out_size.height >= inter_size.height);
 121
 122         /* Here's an image of out_size.  Below we may write to it starting at an offset so we get some padding.
 123            Hence we want to write in the following pattern:
 124
 125            block start   write start                                  line end
 126            |..(padding)..|<------line-size------------->|..(padding)..|
 127            |..(padding)..|<------line-size------------->|..(padding)..|
 128            |..(padding)..|<------line-size------------->|..(padding)..|
 129
 130            where line-size is of the smaller (inter_size) image and the full padded line length is that of
 131            out_size.  To get things to work we have to tell FFmpeg that the stride is that of out_size.
 132            However some parts of FFmpeg (notably rgb48Toxyz12 in swscale.c) process data for the full
 133            specified *stride*.  This does not matter until we get to the last line:
 134
 135            block start   write start                                  line end
 136            |..(padding)..|<------line-size------------->|XXXwrittenXXX|
 137            |XXXwrittenXXX|<------line-size------------->|XXXwrittenXXX|
 138            |XXXwrittenXXX|<------line-size------------->|XXXwrittenXXXXXXwrittenXXX
 139                                                                        ^^^^ out of bounds
 140
 141            To get around this, we ask Image to overallocate its buffers by the overrun.
 142         */
 143
 144         shared_ptr<Image> out (new Image (out_format, out_size, out_aligned, (out_size.width - inter_size.width) / 2));
 145         out->make_black ();
 146
 147         /* Size of the image after any crop */
 148         dcp::Size const cropped_size = crop.apply (size ());
 149
 150         /* Scale context for a scale from cropped_size to inter_size */
 151         struct SwsContext* scale_context = sws_getContext (
 152                         cropped_size.width, cropped_size.height, pixel_format(),
 153                         inter_size.width, inter_size.height, out_format,
 154                         fast ? SWS_FAST_BILINEAR : SWS_BICUBIC, 0, 0, 0
 155                 );
 156
 157         if (!scale_context) {
 158                 throw runtime_error (N_("Could not allocate SwsContext"));
 159         }
 160
 161         DCPOMATIC_ASSERT (yuv_to_rgb < dcp::YUV_TO_RGB_COUNT);
 162         int const lut[dcp::YUV_TO_RGB_COUNT] = {
 163                 SWS_CS_ITU601,
 164                 SWS_CS_ITU709
 165         };
 166
 167         sws_setColorspaceDetails (
 168                 scale_context,
 169                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 170                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 171                 0, 1 << 16, 1 << 16
 172                 );
 173
 174         AVPixFmtDescriptor const * desc = av_pix_fmt_desc_get (_pixel_format);
 175         if (!desc) {
 176                 throw PixelFormatError ("crop_scale_window()", _pixel_format);
 177         }
 178
 179         /* Prepare input data pointers with crop */
 180         uint8_t* scale_in_data[planes()];
 181         for (int c = 0; c < planes(); ++c) {
 182                 /* To work out the crop in bytes, start by multiplying
 183                    the crop by the (average) bytes per pixel.  Then
 184                    round down so that we don't crop a subsampled pixel until
 185                    we've cropped all of its Y-channel pixels.
 186                 */
 187                 int const x = lrintf (bytes_per_pixel(c) * crop.left) & ~ ((int) desc->log2_chroma_w);
 188                 scale_in_data[c] = data()[c] + x + stride()[c] * (crop.top / line_factor(c));
 189         }
 190
 191         /* Corner of the image within out_size */
 192         Position<int> const corner ((out_size.width - inter_size.width) / 2, (out_size.height - inter_size.height) / 2);
 193
 194         uint8_t* scale_out_data[out->planes()];
 195         for (int c = 0; c < out->planes(); ++c) {
 196                 scale_out_data[c] = out->data()[c] + lrintf (out->bytes_per_pixel(c) * corner.x) + out->stride()[c] * corner.y;
 197         }
 198
 199         sws_scale (
 200                 scale_context,
 201                 scale_in_data, stride(),
 202                 0, cropped_size.height,
 203                 scale_out_data, out->stride()
 204                 );
 205
 206         sws_freeContext (scale_context);
 207
 208         return out;
 209 }
 210
 211 /** @param fast Try to be fast at the possible expense of quality; at present this means using
 212  *  fast bilinear rather than bicubic scaling.
 213  */
 214 shared_ptr<Image>
 215 Image::scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned, bool fast) const
 216 {
 217         /* Empirical testing suggests that sws_scale() will crash if
 218            the input image is not aligned.
 219         */
 220         DCPOMATIC_ASSERT (aligned ());
 221
 222         shared_ptr<Image> scaled (new Image (out_format, out_size, out_aligned));
 223
 224         struct SwsContext* scale_context = sws_getContext (
 225                 size().width, size().height, pixel_format(),
 226                 out_size.width, out_size.height, out_format,
 227                 fast ? SWS_FAST_BILINEAR : SWS_BICUBIC, 0, 0, 0
 228                 );
 229
 230         DCPOMATIC_ASSERT (yuv_to_rgb < dcp::YUV_TO_RGB_COUNT);
 231         int const lut[dcp::YUV_TO_RGB_COUNT] = {
 232                 SWS_CS_ITU601,
 233                 SWS_CS_ITU709
 234         };
 235
 236         sws_setColorspaceDetails (
 237                 scale_context,
 238                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 239                 sws_getCoefficients (lut[yuv_to_rgb]), 0,
 240                 0, 1 << 16, 1 << 16
 241                 );
 242
 243         sws_scale (
 244                 scale_context,
 245                 data(), stride(),
 246                 0, size().height,
 247                 scaled->data(), scaled->stride()
 248                 );
 249
 250         sws_freeContext (scale_context);
 251
 252         return scaled;
 253 }
 254
 255 /** Blacken a YUV image whose bits per pixel is rounded up to 16 */
 256 void
 257 Image::yuv_16_black (uint16_t v, bool alpha)
 258 {
 259         memset (data()[0], 0, sample_size(0).height * stride()[0]);
 260         for (int i = 1; i < 3; ++i) {
 261                 int16_t* p = reinterpret_cast<int16_t*> (data()[i]);
 262                 int const lines = sample_size(i).height;
 263                 for (int y = 0; y < lines; ++y) {
 264                         /* We divide by 2 here because we are writing 2 bytes at a time */
 265                         for (int x = 0; x < line_size()[i] / 2; ++x) {
 266                                 p[x] = v;
 267                         }
 268                         p += stride()[i] / 2;
 269                 }
 270         }
 271
 272         if (alpha) {
 273                 memset (data()[3], 0, sample_size(3).height * stride()[3]);
 274         }
 275 }
 276
 277 uint16_t
 278 Image::swap_16 (uint16_t v)
 279 {
 280         return ((v >> 8) & 0xff) | ((v & 0xff) << 8);
 281 }
 282
 283 void
 284 Image::make_black ()
 285 {
 286         /* U/V black value for 8-bit colour */
 287         static uint8_t const eight_bit_uv =     (1 << 7) - 1;
 288         /* U/V black value for 9-bit colour */
 289         static uint16_t const nine_bit_uv =     (1 << 8) - 1;
 290         /* U/V black value for 10-bit colour */
 291         static uint16_t const ten_bit_uv =      (1 << 9) - 1;
 292         /* U/V black value for 16-bit colour */
 293         static uint16_t const sixteen_bit_uv =  (1 << 15) - 1;
 294
 295         switch (_pixel_format) {
 296         case AV_PIX_FMT_YUV420P:
 297         case AV_PIX_FMT_YUV422P:
 298         case AV_PIX_FMT_YUV444P:
 299         case AV_PIX_FMT_YUV411P:
 300                 memset (data()[0], 0, sample_size(0).height * stride()[0]);
 301                 memset (data()[1], eight_bit_uv, sample_size(1).height * stride()[1]);
 302                 memset (data()[2], eight_bit_uv, sample_size(2).height * stride()[2]);
 303                 break;
 304
 305         case AV_PIX_FMT_YUVJ420P:
 306         case AV_PIX_FMT_YUVJ422P:
 307         case AV_PIX_FMT_YUVJ444P:
 308                 memset (data()[0], 0, sample_size(0).height * stride()[0]);
 309                 memset (data()[1], eight_bit_uv + 1, sample_size(1).height * stride()[1]);
 310                 memset (data()[2], eight_bit_uv + 1, sample_size(2).height * stride()[2]);
 311                 break;
 312
 313         case AV_PIX_FMT_YUV422P9LE:
 314         case AV_PIX_FMT_YUV444P9LE:
 315                 yuv_16_black (nine_bit_uv, false);
 316                 break;
 317
 318         case AV_PIX_FMT_YUV422P9BE:
 319         case AV_PIX_FMT_YUV444P9BE:
 320                 yuv_16_black (swap_16 (nine_bit_uv), false);
 321                 break;
 322
 323         case AV_PIX_FMT_YUV422P10LE:
 324         case AV_PIX_FMT_YUV444P10LE:
 325                 yuv_16_black (ten_bit_uv, false);
 326                 break;
 327
 328         case AV_PIX_FMT_YUV422P16LE:
 329         case AV_PIX_FMT_YUV444P16LE:
 330                 yuv_16_black (sixteen_bit_uv, false);
 331                 break;
 332
 333         case AV_PIX_FMT_YUV444P10BE:
 334         case AV_PIX_FMT_YUV422P10BE:
 335                 yuv_16_black (swap_16 (ten_bit_uv), false);
 336                 break;
 337
 338         case AV_PIX_FMT_YUVA420P9BE:
 339         case AV_PIX_FMT_YUVA422P9BE:
 340         case AV_PIX_FMT_YUVA444P9BE:
 341                 yuv_16_black (swap_16 (nine_bit_uv), true);
 342                 break;
 343
 344         case AV_PIX_FMT_YUVA420P9LE:
 345         case AV_PIX_FMT_YUVA422P9LE:
 346         case AV_PIX_FMT_YUVA444P9LE:
 347                 yuv_16_black (nine_bit_uv, true);
 348                 break;
 349
 350         case AV_PIX_FMT_YUVA420P10BE:
 351         case AV_PIX_FMT_YUVA422P10BE:
 352         case AV_PIX_FMT_YUVA444P10BE:
 353                 yuv_16_black (swap_16 (ten_bit_uv), true);
 354                 break;
 355
 356         case AV_PIX_FMT_YUVA420P10LE:
 357         case AV_PIX_FMT_YUVA422P10LE:
 358         case AV_PIX_FMT_YUVA444P10LE:
 359                 yuv_16_black (ten_bit_uv, true);
 360                 break;
 361
 362         case AV_PIX_FMT_YUVA420P16BE:
 363         case AV_PIX_FMT_YUVA422P16BE:
 364         case AV_PIX_FMT_YUVA444P16BE:
 365                 yuv_16_black (swap_16 (sixteen_bit_uv), true);
 366                 break;
 367
 368         case AV_PIX_FMT_YUVA420P16LE:
 369         case AV_PIX_FMT_YUVA422P16LE:
 370         case AV_PIX_FMT_YUVA444P16LE:
 371                 yuv_16_black (sixteen_bit_uv, true);
 372                 break;
 373
 374         case AV_PIX_FMT_RGB24:
 375         case AV_PIX_FMT_ARGB:
 376         case AV_PIX_FMT_RGBA:
 377         case AV_PIX_FMT_ABGR:
 378         case AV_PIX_FMT_BGRA:
 379         case AV_PIX_FMT_RGB555LE:
 380         case AV_PIX_FMT_RGB48LE:
 381         case AV_PIX_FMT_RGB48BE:
 382         case AV_PIX_FMT_XYZ12LE:
 383                 memset (data()[0], 0, sample_size(0).height * stride()[0]);
 384                 break;
 385
 386         case AV_PIX_FMT_UYVY422:
 387         {
 388                 int const Y = sample_size(0).height;
 389                 int const X = line_size()[0];
 390                 uint8_t* p = data()[0];
 391                 for (int y = 0; y < Y; ++y) {
 392                         for (int x = 0; x < X / 4; ++x) {
 393                                 *p++ = eight_bit_uv; // Cb
 394                                 *p++ = 0;            // Y0
 395                                 *p++ = eight_bit_uv; // Cr
 396                                 *p++ = 0;            // Y1
 397                         }
 398                 }
 399                 break;
 400         }
 401
 402         default:
 403                 throw PixelFormatError ("make_black()", _pixel_format);
 404         }
 405 }
 406
 407 void
 408 Image::make_transparent ()
 409 {
 410         if (_pixel_format != AV_PIX_FMT_RGBA) {
 411                 throw PixelFormatError ("make_transparent()", _pixel_format);
 412         }
 413
 414         memset (data()[0], 0, sample_size(0).height * stride()[0]);
 415 }
 416
 417 void
 418 Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
 419 {
 420         /* We're blending RGBA images; first byte is blue, second byte is green, third byte blue, fourth byte alpha */
 421         DCPOMATIC_ASSERT (other->pixel_format() == AV_PIX_FMT_RGBA);
 422         int const other_bpp = 4;
 423
 424         int start_tx = position.x;
 425         int start_ox = 0;
 426
 427         if (start_tx < 0) {
 428                 start_ox = -start_tx;
 429                 start_tx = 0;
 430         }
 431
 432         int start_ty = position.y;
 433         int start_oy = 0;
 434
 435         if (start_ty < 0) {
 436                 start_oy = -start_ty;
 437                 start_ty = 0;
 438         }
 439
 440         switch (_pixel_format) {
 441         case AV_PIX_FMT_RGB24:
 442         {
 443                 /* Going onto RGB24.  First byte is red, second green, third blue */
 444                 int const this_bpp = 3;
 445                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 446                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 447                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 448                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 449                                 float const alpha = float (op[3]) / 255;
 450                                 tp[0] = op[2] * alpha + tp[0] * (1 - alpha);
 451                                 tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
 452                                 tp[2] = op[0] * alpha + tp[2] * (1 - alpha);
 453
 454                                 tp += this_bpp;
 455                                 op += other_bpp;
 456                         }
 457                 }
 458                 break;
 459         }
 460         case AV_PIX_FMT_BGRA:
 461         case AV_PIX_FMT_RGBA:
 462         {
 463                 int const this_bpp = 4;
 464                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 465                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 466                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 467                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 468                                 float const alpha = float (op[3]) / 255;
 469                                 tp[0] = op[0] * alpha + tp[0] * (1 - alpha);
 470                                 tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
 471                                 tp[2] = op[2] * alpha + tp[2] * (1 - alpha);
 472                                 tp[3] = op[3] * alpha + tp[3] * (1 - alpha);
 473
 474                                 tp += this_bpp;
 475                                 op += other_bpp;
 476                         }
 477                 }
 478                 break;
 479         }
 480         case AV_PIX_FMT_RGB48LE:
 481         {
 482                 int const this_bpp = 6;
 483                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 484                         uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
 485                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 486                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 487                                 float const alpha = float (op[3]) / 255;
 488                                 /* Blend high bytes; the RGBA in op appears to be BGRA */
 489                                 tp[1] = op[2] * alpha + tp[1] * (1 - alpha);
 490                                 tp[3] = op[1] * alpha + tp[3] * (1 - alpha);
 491                                 tp[5] = op[0] * alpha + tp[5] * (1 - alpha);
 492
 493                                 tp += this_bpp;
 494                                 op += other_bpp;
 495                         }
 496                 }
 497                 break;
 498         }
 499         case AV_PIX_FMT_XYZ12LE:
 500         {
 501                 dcp::ColourConversion conv = dcp::ColourConversion::srgb_to_xyz();
 502                 double fast_matrix[9];
 503                 dcp::combined_rgb_to_xyz (conv, fast_matrix);
 504                 double const * lut_in = conv.in()->lut (8, false);
 505                 double const * lut_out = conv.out()->lut (16, true);
 506                 int const this_bpp = 6;
 507                 for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
 508                         uint16_t* tp = reinterpret_cast<uint16_t*> (data()[0] + ty * stride()[0] + start_tx * this_bpp);
 509                         uint8_t* op = other->data()[0] + oy * other->stride()[0];
 510                         for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
 511                                 float const alpha = float (op[3]) / 255;
 512
 513                                 /* Convert sRGB to XYZ; op is BGRA.  First, input gamma LUT */
 514                                 double const r = lut_in[op[2]];
 515                                 double const g = lut_in[op[1]];
 516                                 double const b = lut_in[op[0]];
 517
 518                                 /* RGB to XYZ, including Bradford transform and DCI companding */
 519                                 double const x = max (0.0, min (65535.0, r * fast_matrix[0] + g * fast_matrix[1] + b * fast_matrix[2]));
 520                                 double const y = max (0.0, min (65535.0, r * fast_matrix[3] + g * fast_matrix[4] + b * fast_matrix[5]));
 521                                 double const z = max (0.0, min (65535.0, r * fast_matrix[6] + g * fast_matrix[7] + b * fast_matrix[8]));
 522
 523                                 /* Out gamma LUT and blend */
 524                                 tp[0] = lrint(lut_out[lrint(x)] * 65535) * alpha + tp[0] * (1 - alpha);
 525                                 tp[1] = lrint(lut_out[lrint(y)] * 65535) * alpha + tp[1] * (1 - alpha);
 526                                 tp[2] = lrint(lut_out[lrint(z)] * 65535) * alpha + tp[2] * (1 - alpha);
 527
 528                                 tp += this_bpp / 2;
 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         std::swap (_extra_pixels, other._extra_pixels);
 764 }
 765
 766 /** Destroy a Image */
 767 Image::~Image ()
 768 {
 769         for (int i = 0; i < planes(); ++i) {
 770                 av_free (_data[i]);
 771         }
 772
 773         av_free (_data);
 774         av_free (_line_size);
 775         av_free (_stride);
 776 }
 777
 778 uint8_t * const *
 779 Image::data () const
 780 {
 781         return _data;
 782 }
 783
 784 int const *
 785 Image::line_size () const
 786 {
 787         return _line_size;
 788 }
 789
 790 int const *
 791 Image::stride () const
 792 {
 793         return _stride;
 794 }
 795
 796 dcp::Size
 797 Image::size () const
 798 {
 799         return _size;
 800 }
 801
 802 bool
 803 Image::aligned () const
 804 {
 805         return _aligned;
 806 }
 807
 808 PositionImage
 809 merge (list<PositionImage> images)
 810 {
 811         if (images.empty ()) {
 812                 return PositionImage ();
 813         }
 814
 815         if (images.size() == 1) {
 816                 return images.front ();
 817         }
 818
 819         dcpomatic::Rect<int> all (images.front().position, images.front().image->size().width, images.front().image->size().height);
 820         for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
 821                 all.extend (dcpomatic::Rect<int> (i->position, i->image->size().width, i->image->size().height));
 822         }
 823
 824         shared_ptr<Image> merged (new Image (images.front().image->pixel_format (), dcp::Size (all.width, all.height), true));
 825         merged->make_transparent ();
 826         for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
 827                 merged->alpha_blend (i->image, i->position - all.position());
 828         }
 829
 830         return PositionImage (merged, all.position ());
 831 }
 832
 833 bool
 834 operator== (Image const & a, Image const & b)
 835 {
 836         if (a.planes() != b.planes() || a.pixel_format() != b.pixel_format() || a.aligned() != b.aligned()) {
 837                 return false;
 838         }
 839
 840         for (int c = 0; c < a.planes(); ++c) {
 841                 if (a.sample_size(c).height != b.sample_size(c).height || a.line_size()[c] != b.line_size()[c] || a.stride()[c] != b.stride()[c]) {
 842                         return false;
 843                 }
 844
 845                 uint8_t* p = a.data()[c];
 846                 uint8_t* q = b.data()[c];
 847                 int const lines = a.sample_size(c).height;
 848                 for (int y = 0; y < lines; ++y) {
 849                         if (memcmp (p, q, a.line_size()[c]) != 0) {
 850                                 return false;
 851                         }
 852
 853                         p += a.stride()[c];
 854                         q += b.stride()[c];
 855                 }
 856         }
 857
 858         return true;
 859 }
 860
 861 /** Fade the image.
 862  *  @param f Amount to fade by; 0 is black, 1 is no fade.
 863  */
 864 void
 865 Image::fade (float f)
 866 {
 867         switch (_pixel_format) {
 868         case AV_PIX_FMT_YUV420P:
 869         case AV_PIX_FMT_YUV422P:
 870         case AV_PIX_FMT_YUV444P:
 871         case AV_PIX_FMT_YUV411P:
 872         case AV_PIX_FMT_YUVJ420P:
 873         case AV_PIX_FMT_YUVJ422P:
 874         case AV_PIX_FMT_YUVJ444P:
 875         case AV_PIX_FMT_RGB24:
 876         case AV_PIX_FMT_ARGB:
 877         case AV_PIX_FMT_RGBA:
 878         case AV_PIX_FMT_ABGR:
 879         case AV_PIX_FMT_BGRA:
 880         case AV_PIX_FMT_RGB555LE:
 881                 /* 8-bit */
 882                 for (int c = 0; c < 3; ++c) {
 883                         uint8_t* p = data()[c];
 884                         int const lines = sample_size(c).height;
 885                         for (int y = 0; y < lines; ++y) {
 886                                 uint8_t* q = p;
 887                                 for (int x = 0; x < line_size()[c]; ++x) {
 888                                         *q = int (float (*q) * f);
 889                                         ++q;
 890                                 }
 891                                 p += stride()[c];
 892                         }
 893                 }
 894                 break;
 895
 896         case AV_PIX_FMT_YUV422P9LE:
 897         case AV_PIX_FMT_YUV444P9LE:
 898         case AV_PIX_FMT_YUV422P10LE:
 899         case AV_PIX_FMT_YUV444P10LE:
 900         case AV_PIX_FMT_YUV422P16LE:
 901         case AV_PIX_FMT_YUV444P16LE:
 902         case AV_PIX_FMT_YUVA420P9LE:
 903         case AV_PIX_FMT_YUVA422P9LE:
 904         case AV_PIX_FMT_YUVA444P9LE:
 905         case AV_PIX_FMT_YUVA420P10LE:
 906         case AV_PIX_FMT_YUVA422P10LE:
 907         case AV_PIX_FMT_YUVA444P10LE:
 908         case AV_PIX_FMT_RGB48LE:
 909         case AV_PIX_FMT_XYZ12LE:
 910                 /* 16-bit little-endian */
 911                 for (int c = 0; c < 3; ++c) {
 912                         int const stride_pixels = stride()[c] / 2;
 913                         int const line_size_pixels = line_size()[c] / 2;
 914                         uint16_t* p = reinterpret_cast<uint16_t*> (data()[c]);
 915                         int const lines = sample_size(c).height;
 916                         for (int y = 0; y < lines; ++y) {
 917                                 uint16_t* q = p;
 918                                 for (int x = 0; x < line_size_pixels; ++x) {
 919                                         *q = int (float (*q) * f);
 920                                         ++q;
 921                                 }
 922                                 p += stride_pixels;
 923                         }
 924                 }
 925                 break;
 926
 927         case AV_PIX_FMT_YUV422P9BE:
 928         case AV_PIX_FMT_YUV444P9BE:
 929         case AV_PIX_FMT_YUV444P10BE:
 930         case AV_PIX_FMT_YUV422P10BE:
 931         case AV_PIX_FMT_YUVA420P9BE:
 932         case AV_PIX_FMT_YUVA422P9BE:
 933         case AV_PIX_FMT_YUVA444P9BE:
 934         case AV_PIX_FMT_YUVA420P10BE:
 935         case AV_PIX_FMT_YUVA422P10BE:
 936         case AV_PIX_FMT_YUVA444P10BE:
 937         case AV_PIX_FMT_YUVA420P16BE:
 938         case AV_PIX_FMT_YUVA422P16BE:
 939         case AV_PIX_FMT_YUVA444P16BE:
 940         case AV_PIX_FMT_RGB48BE:
 941                 /* 16-bit big-endian */
 942                 for (int c = 0; c < 3; ++c) {
 943                         int const stride_pixels = stride()[c] / 2;
 944                         int const line_size_pixels = line_size()[c] / 2;
 945                         uint16_t* p = reinterpret_cast<uint16_t*> (data()[c]);
 946                         int const lines = sample_size(c).height;
 947                         for (int y = 0; y < lines; ++y) {
 948                                 uint16_t* q = p;
 949                                 for (int x = 0; x < line_size_pixels; ++x) {
 950                                         *q = swap_16 (int (float (swap_16 (*q)) * f));
 951                                         ++q;
 952                                 }
 953                                 p += stride_pixels;
 954                         }
 955                 }
 956                 break;
 957
 958         case AV_PIX_FMT_UYVY422:
 959         {
 960                 int const Y = sample_size(0).height;
 961                 int const X = line_size()[0];
 962                 uint8_t* p = data()[0];
 963                 for (int y = 0; y < Y; ++y) {
 964                         for (int x = 0; x < X; ++x) {
 965                                 *p = int (float (*p) * f);
 966                                 ++p;
 967                         }
 968                 }
 969                 break;
 970         }
 971
 972         default:
 973                 throw PixelFormatError ("fade()", _pixel_format);
 974         }
 975 }