Rename SafeStringStream -> locked_stringstream. Bump deps for removal of stringstream.
[dcpomatic.git] / src / lib / image.cc
index 134172038fc04892615cd02af5593de2b4b626e8..1735bb38ad81433a9e482e3628b5a4c0175dde46 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -26,7 +27,6 @@
 #include "timer.h"
 #include "rect.h"
 #include "util.h"
-#include "md5_digester.h"
 #include "dcpomatic_socket.h"
 extern "C" {
 #include <libswscale/swscale.h>
@@ -83,17 +83,6 @@ Image::sample_size (int n) const
                );
 }
 
-int
-Image::components () const
-{
-       AVPixFmtDescriptor const * d = av_pix_fmt_desc_get(_pixel_format);
-       if (!d) {
-               throw PixelFormatError ("components()", _pixel_format);
-       }
-
-       return d->nb_components;
-}
-
 /** @return Number of planes */
 int
 Image::planes () const
@@ -110,10 +99,13 @@ Image::planes () const
        return d->nb_components;
 }
 
-/** Crop this image, scale it to `inter_size' and then place it in a black frame of `out_size' */
+/** Crop this image, scale it to `inter_size' and then place it in a black frame of `out_size'.
+ *  @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::crop_scale_window (
-       Crop crop, dcp::Size inter_size, dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned
+       Crop crop, dcp::Size inter_size, dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned, bool fast
        ) const
 {
        /* Empirical testing suggests that sws_scale() will crash if
@@ -124,8 +116,29 @@ Image::crop_scale_window (
        DCPOMATIC_ASSERT (out_size.width >= inter_size.width);
        DCPOMATIC_ASSERT (out_size.height >= inter_size.height);
 
-       /* Here's an image of out_size */
-       shared_ptr<Image> out (new Image (out_format, out_size, out_aligned));
+       /* Here's an image of out_size.  Below we may write to it starting at an offset so we get some padding.
+          Hence we want to write in the following pattern:
+
+          block start   write start                                  line end
+          |..(padding)..|<------line-size------------->|..(padding)..|
+          |..(padding)..|<------line-size------------->|..(padding)..|
+          |..(padding)..|<------line-size------------->|..(padding)..|
+
+          where line-size is of the smaller (inter_size) image and the full padded line length is that of
+          out_size.  To get things to work we have to tell FFmpeg that the stride is that of out_size.
+          However some parts of FFmpeg (notably rgb48Toxyz12 in swscale.c) process data for the full
+          specified *stride*.  This does not matter until we get to the last line:
+
+          block start   write start                                  line end
+          |..(padding)..|<------line-size------------->|XXXwrittenXXX|
+          |XXXwrittenXXX|<------line-size------------->|XXXwrittenXXX|
+          |XXXwrittenXXX|<------line-size------------->|XXXwrittenXXXXXXwrittenXXX
+                                                                      ^^^^ out of bounds
+
+          To get around this, we ask Image to overallocate its buffers by the overrun.
+       */
+
+       shared_ptr<Image> out (new Image (out_format, out_size, out_aligned, (out_size.width - inter_size.width) / 2));
        out->make_black ();
 
        /* Size of the image after any crop */
@@ -135,7 +148,7 @@ Image::crop_scale_window (
        struct SwsContext* scale_context = sws_getContext (
                        cropped_size.width, cropped_size.height, pixel_format(),
                        inter_size.width, inter_size.height, out_format,
-                       SWS_BICUBIC, 0, 0, 0
+                       fast ? SWS_FAST_BILINEAR : SWS_BICUBIC, 0, 0, 0
                );
 
        if (!scale_context) {
@@ -192,8 +205,11 @@ Image::crop_scale_window (
        return out;
 }
 
+/** @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) const
+Image::scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_format, bool out_aligned, bool fast) const
 {
        /* Empirical testing suggests that sws_scale() will crash if
           the input image is not aligned.
@@ -205,7 +221,7 @@ Image::scale (dcp::Size out_size, dcp::YUVToRGB yuv_to_rgb, AVPixelFormat out_fo
        struct SwsContext* scale_context = sws_getContext (
                size().width, size().height, pixel_format(),
                out_size.width, out_size.height, out_format,
-               SWS_BICUBIC, 0, 0, 0
+               fast ? SWS_FAST_BILINEAR : SWS_BICUBIC, 0, 0, 0
                );
 
        DCPOMATIC_ASSERT (yuv_to_rgb < dcp::YUV_TO_RGB_COUNT);
@@ -360,6 +376,7 @@ Image::make_black ()
        case AV_PIX_FMT_RGB555LE:
        case AV_PIX_FMT_RGB48LE:
        case AV_PIX_FMT_RGB48BE:
+       case AV_PIX_FMT_XYZ12LE:
                memset (data()[0], 0, sample_size(0).height * stride()[0]);
                break;
 
@@ -397,6 +414,7 @@ Image::make_transparent ()
 void
 Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
 {
+       /* We're blending RGBA images; first byte is blue, second byte is green, third byte blue, fourth byte alpha */
        DCPOMATIC_ASSERT (other->pixel_format() == AV_PIX_FMT_RGBA);
        int const other_bpp = 4;
 
@@ -419,15 +437,16 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
        switch (_pixel_format) {
        case AV_PIX_FMT_RGB24:
        {
+               /* Going onto RGB24.  First byte is red, second green, third blue */
                int const this_bpp = 3;
                for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
                        uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
                        uint8_t* op = other->data()[0] + oy * other->stride()[0];
                        for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
                                float const alpha = float (op[3]) / 255;
-                               tp[0] = op[0] * alpha + tp[0] * (1 - alpha);
+                               tp[0] = op[2] * alpha + tp[0] * (1 - alpha);
                                tp[1] = op[1] * alpha + tp[1] * (1 - alpha);
-                               tp[2] = op[2] * alpha + tp[2] * (1 - alpha);
+                               tp[2] = op[0] * alpha + tp[2] * (1 - alpha);
 
                                tp += this_bpp;
                                op += other_bpp;
@@ -463,10 +482,36 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
                        uint8_t* op = other->data()[0] + oy * other->stride()[0];
                        for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
                                float const alpha = float (op[3]) / 255;
-                               /* Blend high bytes */
-                               tp[1] = op[0] * alpha + tp[1] * (1 - alpha);
+                               /* Blend high bytes; the RGBA in op appears to be BGRA */
+                               tp[1] = op[2] * alpha + tp[1] * (1 - alpha);
                                tp[3] = op[1] * alpha + tp[3] * (1 - alpha);
-                               tp[5] = op[2] * alpha + tp[5] * (1 - alpha);
+                               tp[5] = op[0] * alpha + tp[5] * (1 - alpha);
+
+                               tp += this_bpp;
+                               op += other_bpp;
+                       }
+               }
+               break;
+       }
+       case AV_PIX_FMT_XYZ12LE:
+       {
+               boost::numeric::ublas::matrix<double> matrix = dcp::ColourConversion::srgb_to_xyz().rgb_to_xyz();
+               int const this_bpp = 6;
+               for (int ty = start_ty, oy = start_oy; ty < size().height && oy < other->size().height; ++ty, ++oy) {
+                       uint8_t* tp = data()[0] + ty * stride()[0] + start_tx * this_bpp;
+                       uint8_t* op = other->data()[0] + oy * other->stride()[0];
+                       for (int tx = start_tx, ox = start_ox; tx < size().width && ox < other->size().width; ++tx, ++ox) {
+                               float const alpha = float (op[3]) / 255;
+
+                               /* Convert sRGB to XYZ; op is BGRA */
+                               int const x = matrix(0, 0) * op[2] + matrix(0, 1) * op[1] + matrix(0, 2) * op[0];
+                               int const y = matrix(1, 0) * op[2] + matrix(1, 1) * op[1] + matrix(1, 2) * op[0];
+                               int const z = matrix(2, 0) * op[2] + matrix(2, 1) * op[1] + matrix(2, 2) * op[0];
+
+                               /* Blend high bytes */
+                               tp[1] = min (x, 255) * alpha + tp[1] * (1 - alpha);
+                               tp[3] = min (y, 255) * alpha + tp[3] * (1 - alpha);
+                               tp[5] = min (z, 255) * alpha + tp[5] * (1 - alpha);
 
                                tp += this_bpp;
                                op += other_bpp;
@@ -534,16 +579,29 @@ Image::bytes_per_pixel (int c) const
 
        float bpp[4] = { 0, 0, 0, 0 };
 
-       bpp[0] = floor ((d->comp[0].depth_minus1 + 1 + 7) / 8);
+#ifdef DCPOMATIC_HAVE_AVCOMPONENTDESCRIPTOR_DEPTH_MINUS1
+       bpp[0] = floor ((d->comp[0].depth_minus1 + 8) / 8);
+       if (d->nb_components > 1) {
+               bpp[1] = floor ((d->comp[1].depth_minus1 + 8) / 8) / pow (2.0f, d->log2_chroma_w);
+       }
+       if (d->nb_components > 2) {
+               bpp[2] = floor ((d->comp[2].depth_minus1 + 8) / 8) / pow (2.0f, d->log2_chroma_w);
+       }
+       if (d->nb_components > 3) {
+               bpp[3] = floor ((d->comp[3].depth_minus1 + 8) / 8) / pow (2.0f, d->log2_chroma_w);
+       }
+#else
+       bpp[0] = floor ((d->comp[0].depth + 7) / 8);
        if (d->nb_components > 1) {
-               bpp[1] = floor ((d->comp[1].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
+               bpp[1] = floor ((d->comp[1].depth + 7) / 8) / pow (2.0f, d->log2_chroma_w);
        }
        if (d->nb_components > 2) {
-               bpp[2] = floor ((d->comp[2].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
+               bpp[2] = floor ((d->comp[2].depth + 7) / 8) / pow (2.0f, d->log2_chroma_w);
        }
        if (d->nb_components > 3) {
-               bpp[3] = floor ((d->comp[3].depth_minus1 + 1 + 7) / 8) / pow (2.0f, d->log2_chroma_w);
+               bpp[3] = floor ((d->comp[3].depth + 7) / 8) / pow (2.0f, d->log2_chroma_w);
        }
+#endif
 
        if ((d->flags & AV_PIX_FMT_FLAG_PLANAR) == 0) {
                /* Not planar; sum them up */
@@ -558,11 +616,13 @@ Image::bytes_per_pixel (int c) const
  *
  *  @param p Pixel format.
  *  @param s Size in pixels.
+ *  @param extra_pixels Amount of extra "run-off" memory to allocate at the end of each plane in pixels.
  */
-Image::Image (AVPixelFormat p, dcp::Size s, bool aligned)
+Image::Image (AVPixelFormat p, dcp::Size s, bool aligned, int extra_pixels)
        : _size (s)
        , _pixel_format (p)
        , _aligned (aligned)
+       , _extra_pixels (extra_pixels)
 {
        allocate ();
 }
@@ -597,7 +657,7 @@ Image::allocate ()
                   so I'll just over-allocate by 32 bytes and have done with it.  Empirical
                   testing suggests that it works.
                */
-               _data[i] = (uint8_t *) wrapped_av_malloc (_stride[i] * sample_size(i).height + 32);
+               _data[i] = (uint8_t *) wrapped_av_malloc (_stride[i] * sample_size(i).height + _extra_pixels * bytes_per_pixel(i) + 32);
        }
 }
 
@@ -605,6 +665,7 @@ Image::Image (Image const & other)
        : _size (other._size)
        , _pixel_format (other._pixel_format)
        , _aligned (other._aligned)
+       , _extra_pixels (other._extra_pixels)
 {
        allocate ();
 
@@ -624,6 +685,7 @@ Image::Image (AVFrame* frame)
        : _size (frame->width, frame->height)
        , _pixel_format (static_cast<AVPixelFormat> (frame->format))
        , _aligned (true)
+       , _extra_pixels (0)
 {
        allocate ();
 
@@ -644,6 +706,7 @@ Image::Image (shared_ptr<const Image> other, bool aligned)
        : _size (other->_size)
        , _pixel_format (other->_pixel_format)
        , _aligned (aligned)
+       , _extra_pixels (other->_extra_pixels)
 {
        allocate ();
 
@@ -685,6 +748,7 @@ Image::swap (Image & other)
        }
 
        std::swap (_aligned, other._aligned);
+       std::swap (_extra_pixels, other._extra_pixels);
 }
 
 /** Destroy a Image */
@@ -830,6 +894,7 @@ Image::fade (float f)
        case AV_PIX_FMT_YUVA422P10LE:
        case AV_PIX_FMT_YUVA444P10LE:
        case AV_PIX_FMT_RGB48LE:
+       case AV_PIX_FMT_XYZ12LE:
                /* 16-bit little-endian */
                for (int c = 0; c < 3; ++c) {
                        int const stride_pixels = stride()[c] / 2;