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