Fix the build for older macOS.
[dcpomatic.git] / src / lib / image.cc
index c0916df89712cba657723b6a13f29c62574cd862..a4e04bb626d5a146e0cd0405aa94eec850feb5c7 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 /** @file src/image.cc
  *  @brief A class to describe a video image.
  */
 
-#include "image.h"
+
+#include "compose.hpp"
+#include "dcpomatic_socket.h"
 #include "exceptions.h"
-#include "timer.h"
+#include "image.h"
 #include "rect.h"
+#include "timer.h"
 #include "util.h"
-#include "compose.hpp"
-#include "dcpomatic_socket.h"
+#include "warnings.h"
 #include <dcp/rgb_xyz.h>
 #include <dcp/transfer_function.h>
+DCPOMATIC_DISABLE_WARNINGS
 extern "C" {
-#include <libswscale/swscale.h>
-#include <libavutil/pixfmt.h>
-#include <libavutil/pixdesc.h>
 #include <libavutil/frame.h>
+#include <libavutil/pixdesc.h>
+#include <libavutil/pixfmt.h>
+#include <libswscale/swscale.h>
 }
+DCPOMATIC_ENABLE_WARNINGS
 #include <png.h>
 #if HAVE_VALGRIND_MEMCHECK_H
 #include <valgrind/memcheck.h>
 #endif
 #include <iostream>
 
+
 #include "i18n.h"
 
-using std::string;
-using std::min;
-using std::max;
-using std::cout;
+
 using std::cerr;
+using std::cout;
 using std::list;
+using std::make_shared;
+using std::max;
+using std::min;
 using std::runtime_error;
 using std::shared_ptr;
+using std::string;
 using dcp::Size;
 
 
-/** The memory alignment, in bytes, used for each row of an image if aligment is requested */
-#define ALIGNMENT 64
+/** The memory alignment, in bytes, used for each row of an image if Alignment::PADDED is requested */
+int constexpr ALIGNMENT = 64;
+
+/* U/V black value for 8-bit colour */
+static uint8_t const eight_bit_uv =    (1 << 7) - 1;
+/* U/V black value for 9-bit colour */
+static uint16_t const nine_bit_uv =    (1 << 8) - 1;
+/* U/V black value for 10-bit colour */
+static uint16_t const ten_bit_uv =     (1 << 9) - 1;
+/* U/V black value for 16-bit colour */
+static uint16_t const sixteen_bit_uv = (1 << 15) - 1;
 
 
 int
@@ -67,7 +84,7 @@ Image::vertical_factor (int n) const
                return 1;
        }
 
-       AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
+       auto d = av_pix_fmt_desc_get(_pixel_format);
        if (!d) {
                throw PixelFormatError ("line_factor()", _pixel_format);
        }
@@ -82,7 +99,7 @@ Image::horizontal_factor (int n) const
                return 1;
        }
 
-       AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
+       auto d = av_pix_fmt_desc_get(_pixel_format);
        if (!d) {
                throw PixelFormatError ("sample_size()", _pixel_format);
        }
@@ -97,8 +114,8 @@ dcp::Size
 Image::sample_size (int n) const
 {
        return dcp::Size (
-               lrint (ceil (static_cast<double>(size().width) / horizontal_factor (n))),
-               lrint (ceil (static_cast<double>(size().height) / vertical_factor (n)))
+               lrint (ceil(static_cast<double>(size().width) / horizontal_factor(n))),
+               lrint (ceil(static_cast<double>(size().height) / vertical_factor(n)))
                );
 }
 
@@ -106,7 +123,7 @@ Image::sample_size (int n) const
 int
 Image::planes () const
 {
-       AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
+       auto d = av_pix_fmt_desc_get(_pixel_format);
        if (!d) {
                throw PixelFormatError ("planes()", _pixel_format);
        }
@@ -160,22 +177,22 @@ Image::crop_scale_window (
        VideoRange video_range,
        AVPixelFormat out_format,
        VideoRange out_video_range,
-       bool out_aligned,
+       Alignment out_alignment,
        bool fast
        ) const
 {
        /* Empirical testing suggests that sws_scale() will crash if
-          the input image is not aligned.
+          the input image is not padded.
        */
-       DCPOMATIC_ASSERT (aligned ());
+       DCPOMATIC_ASSERT (alignment() == Alignment::PADDED);
 
        DCPOMATIC_ASSERT (out_size.width >= inter_size.width);
        DCPOMATIC_ASSERT (out_size.height >= inter_size.height);
 
-       shared_ptr<Image> out (new Image(out_format, out_size, out_aligned));
+       auto out = make_shared<Image>(out_format, out_size, out_alignment);
        out->make_black ();
 
-       AVPixFmtDescriptor const * in_desc = av_pix_fmt_desc_get (_pixel_format);
+       auto in_desc = av_pix_fmt_desc_get (_pixel_format);
        if (!in_desc) {
                throw PixelFormatError ("crop_scale_window()", _pixel_format);
        }
@@ -202,10 +219,10 @@ Image::crop_scale_window (
        }
 
        /* Size of the image after any crop */
-       dcp::Size const cropped_size = corrected_crop.apply (size());
+       auto const cropped_size = corrected_crop.apply (size());
 
        /* Scale context for a scale from cropped_size to inter_size */
-       struct SwsContext* scale_context = sws_getContext (
+       auto scale_context = sws_getContext (
                        cropped_size.width, cropped_size.height, pixel_format(),
                        inter_size.width, inter_size.height, out_format,
                        fast ? SWS_FAST_BILINEAR : SWS_BICUBIC, 0, 0, 0
@@ -234,8 +251,8 @@ Image::crop_scale_window (
        */
        sws_setColorspaceDetails (
                scale_context,
-               sws_getCoefficients (lut[static_cast<int>(yuv_to_rgb)]), video_range == VIDEO_RANGE_VIDEO ? 0 : 1,
-               sws_getCoefficients (lut[static_cast<int>(yuv_to_rgb)]), out_video_range == VIDEO_RANGE_VIDEO ? 0 : 1,
+               sws_getCoefficients (lut[static_cast<int>(yuv_to_rgb)]), video_range == VideoRange::VIDEO ? 0 : 1,
+               sws_getCoefficients (lut[static_cast<int>(yuv_to_rgb)]), out_video_range == VideoRange::VIDEO ? 0 : 1,
                0, 1 << 16, 1 << 16
                );
 
@@ -246,7 +263,7 @@ Image::crop_scale_window (
                scale_in_data[c] = data()[c] + x + stride()[c] * (corrected_crop.top / vertical_factor(c));
        }
 
-       AVPixFmtDescriptor const * out_desc = av_pix_fmt_desc_get (out_format);
+       auto out_desc = av_pix_fmt_desc_get (out_format);
        if (!out_desc) {
                throw PixelFormatError ("crop_scale_window()", out_format);
        }
@@ -280,33 +297,41 @@ Image::crop_scale_window (
                out->make_part_black (corner.x + cropped_size.width, out_size.width - cropped_size.width);
        }
 
+       if (
+               video_range == VideoRange::VIDEO &&
+               out_video_range == VideoRange::FULL &&
+               av_pix_fmt_desc_get(_pixel_format)->flags & AV_PIX_FMT_FLAG_RGB
+          ) {
+               /* libswscale will not convert video range for RGB sources, so we have to do it ourselves */
+               out->video_range_to_full_range ();
+       }
+
        return out;
 }
 
 shared_ptr<Image>
-Image::convert_pixel_format (dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned, bool fast) const
+Image::convert_pixel_format (dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, Alignment out_alignment, bool fast) const
 {
-       return scale(size(), yuv_to_rgb, out_format, out_aligned, fast);
+       return scale(size(), yuv_to_rgb, out_format, out_alignment, fast);
 }
 
 /** @param out_size Size to scale to.
  *  @param yuv_to_rgb YUVToRGB transform transform to use, if required.
  *  @param out_format Output pixel format.
- *  @param out_aligned true to make an aligned output image.
+ *  @param out_aligment Output alignment.
  *  @param fast Try to be fast at the possible expense of quality; at present this means using
  *  fast bilinear rather than bicubic scaling.
  */
 shared_ptr<Image>
-Image::scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned, bool fast) const
+Image::scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, Alignment out_alignment, bool fast) const
 {
        /* Empirical testing suggests that sws_scale() will crash if
-          the input image is not aligned.
+          the input image alignment is not PADDED.
        */
-       DCPOMATIC_ASSERT (aligned ());
-
-       shared_ptr<Image> scaled (new Image (out_format, out_size, out_aligned));
+       DCPOMATIC_ASSERT (alignment() == Alignment::PADDED);
 
-       struct SwsContext* scale_context = sws_getContext (
+       auto scaled = make_shared<Image>(out_format, out_size, out_alignment);
+       auto scale_context = sws_getContext (
                size().width, size().height, pixel_format(),
                out_size.width, out_size.height, out_format,
                (fast ? SWS_FAST_BILINEAR : SWS_BICUBIC) | SWS_ACCURATE_RND, 0, 0, 0
@@ -354,7 +379,7 @@ Image::yuv_16_black (uint16_t v, bool alpha)
 {
        memset (data()[0], 0, sample_size(0).height * stride()[0]);
        for (int i = 1; i < 3; ++i) {
-               int16_t* p = reinterpret_cast<int16_t*> (data()[i]);
+               auto p = reinterpret_cast<int16_t*> (data()[i]);
                int const lines = sample_size(i).height;
                for (int y = 0; y < lines; ++y) {
                        /* We divide by 2 here because we are writing 2 bytes at a time */
@@ -377,8 +402,19 @@ Image::swap_16 (uint16_t v)
 }
 
 void
-Image::make_part_black (int x, int w)
+Image::make_part_black (int const start, int const width)
 {
+       auto y_part = [&]() {
+               int const bpp = bytes_per_pixel(0);
+               int const h = sample_size(0).height;
+               int const s = stride()[0];
+               auto p = data()[0];
+               for (int y = 0; y < h; ++y) {
+                       memset (p + start * bpp, 0, width * bpp);
+                       p += s;
+               }
+       };
+
        switch (_pixel_format) {
        case AV_PIX_FMT_RGB24:
        case AV_PIX_FMT_ARGB:
@@ -395,12 +431,41 @@ Image::make_part_black (int x, int w)
                int const s = stride()[0];
                uint8_t* p = data()[0];
                for (int y = 0; y < h; y++) {
-                       memset (p + x * bpp, 0, w * bpp);
+                       memset (p + start * bpp, 0, width * bpp);
                        p += s;
                }
                break;
        }
-
+       case AV_PIX_FMT_YUV420P:
+       {
+               y_part ();
+               for (int i = 1; i < 3; ++i) {
+                       auto p = data()[i];
+                       int const h = sample_size(i).height;
+                       for (int y = 0; y < h; ++y) {
+                               for (int x = start / 2; x < (start + width) / 2; ++x) {
+                                       p[x] = eight_bit_uv;
+                               }
+                               p += stride()[i];
+                       }
+               }
+               break;
+       }
+       case AV_PIX_FMT_YUV422P10LE:
+       {
+               y_part ();
+               for (int i = 1; i < 3; ++i) {
+                       auto p = reinterpret_cast<int16_t*>(data()[i]);
+                       int const h = sample_size(i).height;
+                       for (int y = 0; y < h; ++y) {
+                               for (int x = start / 2; x < (start + width) / 2; ++x) {
+                                       p[x] = ten_bit_uv;
+                               }
+                               p += stride()[i] / 2;
+                       }
+               }
+               break;
+       }
        default:
                throw PixelFormatError ("make_part_black()", _pixel_format);
        }
@@ -409,15 +474,6 @@ Image::make_part_black (int x, int w)
 void
 Image::make_black ()
 {
-       /* U/V black value for 8-bit colour */
-       static uint8_t const eight_bit_uv =     (1 << 7) - 1;
-       /* U/V black value for 9-bit colour */
-       static uint16_t const nine_bit_uv =     (1 << 8) - 1;
-       /* U/V black value for 10-bit colour */
-       static uint16_t const ten_bit_uv =      (1 << 9) - 1;
-       /* U/V black value for 16-bit colour */
-       static uint16_t const sixteen_bit_uv =  (1 << 15) - 1;
-
        switch (_pixel_format) {
        case AV_PIX_FMT_YUV420P:
        case AV_PIX_FMT_YUV422P:
@@ -645,7 +701,7 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
        }
        case AV_PIX_FMT_XYZ12LE:
        {
-               dcp::ColourConversion conv = dcp::ColourConversion::srgb_to_xyz();
+               auto conv = dcp::ColourConversion::srgb_to_xyz();
                double fast_matrix[9];
                dcp::combined_rgb_to_xyz (conv, fast_matrix);
                double const * lut_in = conv.in()->lut (8, false);
@@ -680,7 +736,7 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
        }
        case AV_PIX_FMT_YUV420P:
        {
-               shared_ptr<Image> yuv = other->convert_pixel_format (dcp::YUVToRGB::REC709, _pixel_format, false, false);
+               auto yuv = other->convert_pixel_format (dcp::YUVToRGB::REC709, _pixel_format, Alignment::COMPACT, false);
                dcp::Size const ts = size();
                dcp::Size const os = yuv->size();
                for (int ty = start_ty, oy = start_oy; ty < ts.height && oy < os.height; ++ty, ++oy) {
@@ -715,7 +771,7 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
        }
        case AV_PIX_FMT_YUV420P10:
        {
-               shared_ptr<Image> yuv = other->convert_pixel_format (dcp::YUVToRGB::REC709, _pixel_format, false, false);
+               auto yuv = other->convert_pixel_format (dcp::YUVToRGB::REC709, _pixel_format, Alignment::COMPACT, false);
                dcp::Size const ts = size();
                dcp::Size const os = yuv->size();
                for (int ty = start_ty, oy = start_oy; ty < ts.height && oy < os.height; ++ty, ++oy) {
@@ -750,7 +806,7 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
        }
        case AV_PIX_FMT_YUV422P10LE:
        {
-               shared_ptr<Image> yuv = other->convert_pixel_format (dcp::YUVToRGB::REC709, _pixel_format, false, false);
+               auto yuv = other->convert_pixel_format (dcp::YUVToRGB::REC709, _pixel_format, Alignment::COMPACT, false);
                dcp::Size const ts = size();
                dcp::Size const os = yuv->size();
                for (int ty = start_ty, oy = start_oy; ty < ts.height && oy < os.height; ++ty, ++oy) {
@@ -830,7 +886,7 @@ Image::write_to_socket (shared_ptr<Socket> socket) const
 float
 Image::bytes_per_pixel (int c) const
 {
-       AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
+       auto d = av_pix_fmt_desc_get(_pixel_format);
        if (!d) {
                throw PixelFormatError ("bytes_per_pixel()", _pixel_format);
        }
@@ -878,16 +934,17 @@ Image::bytes_per_pixel (int c) const
  *
  *  @param p Pixel format.
  *  @param s Size in pixels.
- *  @param aligned true to make each row of this image aligned to a ALIGNMENT-byte boundary.
+ *  @param alignment PADDED to make each row of this image aligned to a ALIGNMENT-byte boundary, otherwise COMPACT.
  */
-Image::Image (AVPixelFormat p, dcp::Size s, bool aligned)
+Image::Image (AVPixelFormat p, dcp::Size s, Alignment alignment)
        : _size (s)
        , _pixel_format (p)
-       , _aligned (aligned)
+       , _alignment (alignment)
 {
        allocate ();
 }
 
+
 void
 Image::allocate ()
 {
@@ -902,7 +959,7 @@ Image::allocate ()
 
        for (int i = 0; i < planes(); ++i) {
                _line_size[i] = ceil (_size.width * bytes_per_pixel(i));
-               _stride[i] = stride_round_up (i, _line_size, _aligned ? ALIGNMENT : 1);
+               _stride[i] = stride_round_up (i, _line_size, _alignment == Alignment::PADDED ? ALIGNMENT : 1);
 
                /* The assembler function ff_rgb24ToY_avx (in libswscale/x86/input.asm)
                   uses a 16-byte fetch to read three bytes (R/G/B) of image data.
@@ -955,7 +1012,7 @@ Image::Image (Image const & other)
        : std::enable_shared_from_this<Image>(other)
        , _size (other._size)
        , _pixel_format (other._pixel_format)
-       , _aligned (other._aligned)
+       , _alignment (other._alignment)
 {
        allocate ();
 
@@ -971,11 +1028,13 @@ Image::Image (Image const & other)
        }
 }
 
-Image::Image (AVFrame* frame)
+Image::Image (AVFrame const * frame, Alignment alignment)
        : _size (frame->width, frame->height)
-       , _pixel_format (static_cast<AVPixelFormat> (frame->format))
-       , _aligned (true)
+       , _pixel_format (static_cast<AVPixelFormat>(frame->format))
+       , _alignment (alignment)
 {
+       DCPOMATIC_ASSERT (_pixel_format != AV_PIX_FMT_NONE);
+
        allocate ();
 
        for (int i = 0; i < planes(); ++i) {
@@ -991,10 +1050,10 @@ Image::Image (AVFrame* frame)
        }
 }
 
-Image::Image (shared_ptr<const Image> other, bool aligned)
+Image::Image (shared_ptr<const Image> other, Alignment alignment)
        : _size (other->_size)
        , _pixel_format (other->_pixel_format)
-       , _aligned (aligned)
+       , _alignment (alignment)
 {
        allocate ();
 
@@ -1035,7 +1094,7 @@ Image::swap (Image & other)
                std::swap (_stride[i], other._stride[i]);
        }
 
-       std::swap (_aligned, other._aligned);
+       std::swap (_alignment, other._alignment);
 }
 
 Image::~Image ()
@@ -1073,41 +1132,44 @@ Image::size () const
        return _size;
 }
 
-bool
-Image::aligned () const
+Image::Alignment
+Image::alignment () const
 {
-       return _aligned;
+       return _alignment;
 }
 
+
 PositionImage
-merge (list<PositionImage> images)
+merge (list<PositionImage> images, Image::Alignment alignment)
 {
        if (images.empty ()) {
-               return PositionImage ();
+               return {};
        }
 
        if (images.size() == 1) {
-               return images.front ();
+               images.front().image = Image::ensure_alignment(images.front().image, alignment);
+               return images.front();
        }
 
        dcpomatic::Rect<int> all (images.front().position, images.front().image->size().width, images.front().image->size().height);
-       for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
-               all.extend (dcpomatic::Rect<int> (i->position, i->image->size().width, i->image->size().height));
+       for (auto const& i: images) {
+               all.extend (dcpomatic::Rect<int>(i.position, i.image->size().width, i.image->size().height));
        }
 
-       shared_ptr<Image> merged (new Image (images.front().image->pixel_format (), dcp::Size (all.width, all.height), true));
+       auto merged = make_shared<Image>(images.front().image->pixel_format(), dcp::Size(all.width, all.height), alignment);
        merged->make_transparent ();
-       for (list<PositionImage>::const_iterator i = images.begin(); i != images.end(); ++i) {
-               merged->alpha_blend (i->image, i->position - all.position());
+       for (auto const& i: images) {
+               merged->alpha_blend (i.image, i.position - all.position());
        }
 
        return PositionImage (merged, all.position ());
 }
 
+
 bool
 operator== (Image const & a, Image const & b)
 {
-       if (a.planes() != b.planes() || a.pixel_format() != b.pixel_format() || a.aligned() != b.aligned()) {
+       if (a.planes() != b.planes() || a.pixel_format() != b.pixel_format() || a.alignment() != b.alignment()) {
                return false;
        }
 
@@ -1252,16 +1314,18 @@ Image::fade (float f)
        }
 }
 
+
 shared_ptr<const Image>
-Image::ensure_aligned (shared_ptr<const Image> image)
+Image::ensure_alignment (shared_ptr<const Image> image, Image::Alignment alignment)
 {
-       if (image->aligned()) {
+       if (image->alignment() == alignment) {
                return image;
        }
 
-       return shared_ptr<Image> (new Image (image, true));
+       return make_shared<Image>(image, alignment);
 }
 
+
 size_t
 Image::memory_used () const
 {
@@ -1292,7 +1356,7 @@ public:
 static void
 png_write_data (png_structp png_ptr, png_bytep data, png_size_t length)
 {
-       Memory* mem = reinterpret_cast<Memory*>(png_get_io_ptr(png_ptr));
+       auto mem = reinterpret_cast<Memory*>(png_get_io_ptr(png_ptr));
        size_t size = mem->size + length;
 
        if (mem->data) {
@@ -1333,7 +1397,7 @@ Image::as_png () const
        DCPOMATIC_ASSERT (bytes_per_pixel(0) == 4);
        DCPOMATIC_ASSERT (planes() == 1);
        if (pixel_format() != AV_PIX_FMT_RGBA) {
-               return convert_pixel_format(dcp::YUVToRGB::REC709, AV_PIX_FMT_RGBA, true, false)->as_png();
+               return convert_pixel_format(dcp::YUVToRGB::REC709, AV_PIX_FMT_RGBA, Image::Alignment::PADDED, false)->as_png();
        }
 
        /* error handling? */
@@ -1382,13 +1446,29 @@ Image::video_range_to_full_range ()
                for (int y = 0; y < lines; ++y) {
                        uint8_t* q = p;
                        for (int x = 0; x < line_size()[0]; ++x) {
-                               *q = int((*q - 16) * factor);
+                               *q = clamp(lrintf((*q - 16) * factor), 0L, 255L);
                                ++q;
                        }
                        p += stride()[0];
                }
                break;
        }
+       case AV_PIX_FMT_RGB48LE:
+       {
+               float const factor = 65536.0 / 56064.0;
+               uint16_t* p = reinterpret_cast<uint16_t*>(data()[0]);
+               int const lines = sample_size(0).height;
+               for (int y = 0; y < lines; ++y) {
+                       uint16_t* q = p;
+                       int const line_size_pixels = line_size()[0] / 2;
+                       for (int x = 0; x < line_size_pixels; ++x) {
+                               *q = clamp(lrintf((*q - 4096) * factor), 0L, 65535L);
+                               ++q;
+                       }
+                       p += stride()[0] / 2;
+               }
+               break;
+       }
        case AV_PIX_FMT_GBRP12LE:
        {
                float const factor = 4096.0 / 3504.0;
@@ -1399,7 +1479,7 @@ Image::video_range_to_full_range ()
                                uint16_t* q = p;
                                int const line_size_pixels = line_size()[c] / 2;
                                for (int x = 0; x < line_size_pixels; ++x) {
-                                       *q = int((*q - 256) * factor);
+                                       *q = clamp(lrintf((*q - 256) * factor), 0L, 4095L);
                                        ++q;
                                }
                        }