Various Doxygen fixes.
[dcpomatic.git] / src / lib / image.cc
index 9ddccb75f462b79bd0cf4940ae36389c15277432..8718223ae83cf96eeb144695472319ee7d3057c1 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,8 +27,9 @@
 #include "timer.h"
 #include "rect.h"
 #include "util.h"
-#include "md5_digester.h"
 #include "dcpomatic_socket.h"
+#include <dcp/rgb_xyz.h>
+#include <dcp/transfer_function.h>
 extern "C" {
 #include <libswscale/swscale.h>
 #include <libavutil/pixfmt.h>
@@ -40,6 +42,7 @@ extern "C" {
 
 using std::string;
 using std::min;
+using std::max;
 using std::cout;
 using std::cerr;
 using std::list;
@@ -83,17 +86,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 +102,19 @@ 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 crop Amount to crop by.
+ *  @param inter_size Size to scale the cropped image to.
+ *  @param out_size Size of output frame; if this is larger than inter_size there will be black padding.
+ *  @param yuv_to_rgb YUV to RGB transformation to use, if required.
+ *  @param out_format Output pixel format.
+ *  @param out_aligned true to make the output image aligned.
+ *  @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
@@ -156,7 +157,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) {
@@ -213,8 +214,15 @@ Image::crop_scale_window (
        return out;
 }
 
+/** @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 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.
@@ -226,7 +234,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);
@@ -419,6 +427,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;
 
@@ -441,15 +450,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;
@@ -498,25 +508,34 @@ Image::alpha_blend (shared_ptr<const Image> other, Position<int> position)
        }
        case AV_PIX_FMT_XYZ12LE:
        {
-               boost::numeric::ublas::matrix<double> matrix = dcp::ColourConversion::srgb_to_xyz().rgb_to_xyz();
+               dcp::ColourConversion 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);
+               double const * lut_out = conv.out()->lut (16, true);
                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;
+                       uint16_t* tp = reinterpret_cast<uint16_t*> (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];
+                               /* Convert sRGB to XYZ; op is BGRA.  First, input gamma LUT */
+                               double const r = lut_in[op[2]];
+                               double const g = lut_in[op[1]];
+                               double const b = lut_in[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);
+                               /* RGB to XYZ, including Bradford transform and DCI companding */
+                               double const x = max (0.0, min (65535.0, r * fast_matrix[0] + g * fast_matrix[1] + b * fast_matrix[2]));
+                               double const y = max (0.0, min (65535.0, r * fast_matrix[3] + g * fast_matrix[4] + b * fast_matrix[5]));
+                               double const z = max (0.0, min (65535.0, r * fast_matrix[6] + g * fast_matrix[7] + b * fast_matrix[8]));
 
-                               tp += this_bpp;
+                               /* Out gamma LUT and blend */
+                               tp[0] = lrint(lut_out[lrint(x)] * 65535) * alpha + tp[0] * (1 - alpha);
+                               tp[1] = lrint(lut_out[lrint(y)] * 65535) * alpha + tp[1] * (1 - alpha);
+                               tp[2] = lrint(lut_out[lrint(z)] * 65535) * alpha + tp[2] * (1 - alpha);
+
+                               tp += this_bpp / 2;
                                op += other_bpp;
                        }
                }
@@ -619,6 +638,7 @@ 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 32-byte boundary.
  *  @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, int extra_pixels)
@@ -751,6 +771,7 @@ Image::swap (Image & other)
        }
 
        std::swap (_aligned, other._aligned);
+       std::swap (_extra_pixels, other._extra_pixels);
 }
 
 /** Destroy a Image */