Fix incorrect day-of-month in LocalTime.
[libdcp.git] / src / rgb_xyz.cc
index 35332fc2baa969d6b728a975ac7ddeeda4103ae8..791d6c7c6e70697aa7830d67d5b01d96399891f6 100644 (file)
 */
 
 #include "rgb_xyz.h"
-#include "argb_frame.h"
-#include "xyz_frame.h"
-#include "image.h"
+#include "xyz_image.h"
 #include "colour_matrix.h"
 #include "colour_conversion.h"
 #include "transfer_function.h"
 #include "dcp_assert.h"
+#include "compose.hpp"
 #include <cmath>
 
 using std::min;
 using std::max;
 using boost::shared_ptr;
+using boost::optional;
 using namespace dcp;
 
 #define DCI_COEFFICIENT (48.0 / 52.37)
 
-/** Convert an openjpeg XYZ image to RGBA.
- *  @param xyz_frame Frame in XYZ.
- *  @return RGB image.
+/** Convert an XYZ image to RGBA.
+ *  @param xyz_image Image in XYZ.
+ *  @param conversion Colour conversion to use.
+ *  @param argb Buffer to fill with RGBA data.  The format of the data is:
+ *
+ *  <pre>
+ *  Byte   /- 0 -------|- 1 --------|- 2 --------|- 3 --------|- 4 --------|- 5 --------| ...
+ *         |(0, 0) Blue|(0, 0)Green |(0, 0) Red  |(0, 0) Alpha|(0, 1) Blue |(0, 1) Green| ...
+ *  </pre>
+ *
+ *  So that the first byte is the blue component of the pixel at x=0, y=0, the second
+ *  is the green component, and so on.
+ *
+ *  Lines are packed so that the second row directly follows the first.
  */
-shared_ptr<ARGBFrame>
+void
 dcp::xyz_to_rgba (
-       boost::shared_ptr<const XYZFrame> xyz_frame,
-       ColourConversion const & conversion
+       boost::shared_ptr<const XYZImage> xyz_image,
+       ColourConversion const & conversion,
+       uint8_t* argb
        )
 {
        int const max_colour = pow (2, 12) - 1;
@@ -54,20 +66,20 @@ dcp::xyz_to_rgba (
                double r, g, b;
        } d;
        
-       int* xyz_x = xyz_frame->data (0);
-       int* xyz_y = xyz_frame->data (1);
-       int* xyz_z = xyz_frame->data (2);
+       int* xyz_x = xyz_image->data (0);
+       int* xyz_y = xyz_image->data (1);
+       int* xyz_z = xyz_image->data (2);
 
-       shared_ptr<ARGBFrame> argb_frame (new ARGBFrame (xyz_frame->size ()));
-       uint8_t* argb = argb_frame->data ();
-       
-       float const * lut_in = conversion.in()->lut (16);
-       float const * lut_out = conversion.out()->lut (12);
-       boost::numeric::ublas::matrix<double> matrix = conversion.matrix ();
+       double const * lut_in = conversion.in()->lut (16, true);
+       double const * lut_out = conversion.out()->lut (12, false);
+       boost::numeric::ublas::matrix<double> const matrix = conversion.xyz_to_rgb ();
 
-       for (int y = 0; y < xyz_frame->size().height; ++y) {
+       int const height = xyz_image->size().height;
+       int const width = xyz_image->size().width;
+       
+       for (int y = 0; y < height; ++y) {
                uint8_t* argb_line = argb;
-               for (int x = 0; x < xyz_frame->size().width; ++x) {
+               for (int x = 0; x < width; ++x) {
 
                        DCP_ASSERT (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_y < 4096 && *xyz_z < 4096);
                        
@@ -96,35 +108,35 @@ dcp::xyz_to_rgba (
                        d.b = max (d.b, 0.0);
                        
                        /* Out gamma LUT */
-                       *argb_line++ = lut_out[(int) (d.b * max_colour)] * 0xff;
-                       *argb_line++ = lut_out[(int) (d.g * max_colour)] * 0xff;
-                       *argb_line++ = lut_out[(int) (d.r * max_colour)] * 0xff;
+                       *argb_line++ = lut_out[int(rint(d.b * max_colour))] * 0xff;
+                       *argb_line++ = lut_out[int(rint(d.g * max_colour))] * 0xff;
+                       *argb_line++ = lut_out[int(rint(d.r * max_colour))] * 0xff;
                        *argb_line++ = 0xff;
                }
-               
-               argb += argb_frame->stride ();
-       }
 
-       return argb_frame;
+               /* 4 bytes per pixel */
+               argb += width * 4;
+       }
 }
 
-/** Convert an openjpeg XYZ image to RGB.
- *  @param xyz_frame Frame in XYZ.
- *  @param lut_in Input Gamma LUT to use.
- *  @param lut_out Output Gamma LUT to use.
- *  @param buffer Buffer to write RGB data to; will be written
- *  as one byte R, one byte G, one byte B, one byte R etc. with
- *  no padding at line ends.
+/** Convert an XYZ image to 48bpp RGB.
+ *  @param xyz_image Frame in XYZ.
+ *  @param conversion Colour conversion to use.
+ *  @param rgb Buffer to fill with RGB data.  Format is packed RGB
+ *  16:16:16, 48bpp, 16R, 16G, 16B, with the 2-byte value for each
+ *  R/G/B component stored as little-endian; i.e. AV_PIX_FMT_RGB48LE.
+ *  @param stride Stride for RGB data in bytes.
+ *  @param note Optional handler for any notes that may be made during the conversion (e.g. when clamping occurs).
  */
 void
 dcp::xyz_to_rgb (
-       boost::shared_ptr<const XYZFrame> xyz_frame,
+       shared_ptr<const XYZImage> xyz_image,
        ColourConversion const & conversion,
-       uint8_t* buffer
+       uint8_t* rgb,
+       int stride,
+       optional<NoteHandler> note
        )
 {
-       int const max_colour = pow (2, 12) - 1;
-
        struct {
                double x, y, z;
        } s;
@@ -132,25 +144,49 @@ dcp::xyz_to_rgb (
        struct {
                double r, g, b;
        } d;
-       
-       int* xyz_x = xyz_frame->data (0);
-       int* xyz_y = xyz_frame->data (1);
-       int* xyz_z = xyz_frame->data (2);
 
-       float const * lut_in = conversion.in()->lut (16);
-       float const * lut_out = conversion.out()->lut (12);
-       boost::numeric::ublas::matrix<double> matrix = conversion.matrix ();
-       
-       for (int y = 0; y < xyz_frame->size().height; ++y) {
-               uint8_t* buffer_line = buffer;
-               for (int x = 0; x < xyz_frame->size().width; ++x) {
+       /* These should be 12-bit values from 0-4095 */
+       int* xyz_x = xyz_image->data (0);
+       int* xyz_y = xyz_image->data (1);
+       int* xyz_z = xyz_image->data (2);
 
-                       DCP_ASSERT (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_y < 4096 && *xyz_z < 4096);
+       double const * lut_in = conversion.in()->lut (12, true);
+       double const * lut_out = conversion.out()->lut (16, false);
+       boost::numeric::ublas::matrix<double> const matrix = conversion.xyz_to_rgb ();
+       
+       for (int y = 0; y < xyz_image->size().height; ++y) {
+               uint16_t* rgb_line = reinterpret_cast<uint16_t*> (rgb + y * stride);
+               for (int x = 0; x < xyz_image->size().width; ++x) {
+
+                       int cx = *xyz_x++;
+                       int cy = *xyz_y++;
+                       int cz = *xyz_z++;
+
+                       if (cx < 0 || cx > 4095) {
+                               if (note) {
+                                       note.get() (DCP_NOTE, String::compose ("XYZ value %1 out of range", cx));
+                               }
+                               cx = max (min (cx, 4095), 0);
+                       }
+
+                       if (cy < 0 || cy > 4095) {
+                               if (note) {
+                                       note.get() (DCP_NOTE, String::compose ("XYZ value %1 out of range", cy));
+                               }
+                               cy = max (min (cy, 4095), 0);
+                       }
+
+                       if (cz < 0 || cz > 4095) {
+                               if (note) {
+                                       note.get() (DCP_NOTE, String::compose ("XYZ value %1 out of range", cz));
+                               }
+                               cz = max (min (cz, 4095), 0);
+                       }
                        
                        /* In gamma LUT */
-                       s.x = lut_in[*xyz_x++];
-                       s.y = lut_in[*xyz_y++];
-                       s.z = lut_in[*xyz_z++];
+                       s.x = lut_in[cx];
+                       s.y = lut_in[cy];
+                       s.z = lut_in[cz];
 
                        /* DCI companding */
                        s.x /= DCI_COEFFICIENT;
@@ -170,27 +206,29 @@ dcp::xyz_to_rgb (
                        
                        d.b = min (d.b, 1.0);
                        d.b = max (d.b, 0.0);
-                       
-                       /* Out gamma LUT */
-                       *buffer_line++ = lut_out[(int) (d.r * max_colour)] * 0xff;
-                       *buffer_line++ = lut_out[(int) (d.g * max_colour)] * 0xff;
-                       *buffer_line++ = lut_out[(int) (d.b * max_colour)] * 0xff;
+
+                       *rgb_line++ = rint(lut_out[int(rint(d.r * 65535))] * 65535);
+                       *rgb_line++ = rint(lut_out[int(rint(d.g * 65535))] * 65535);
+                       *rgb_line++ = rint(lut_out[int(rint(d.b * 65535))] * 65535);
                }
-               
-               buffer += xyz_frame->size().width * 3;
        }
 }
 
-/** rgb must be packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, with the 2-byte value for each R/G/B component stored as little-endian;
- *  i.e. AV_PIX_FMT_RGB48LE.
+/** @param rgb RGB data; packed RGB 16:16:16, 48bpp, 16R, 16G, 16B,
+ *  with the 2-byte value for each R/G/B component stored as
+ *  little-endian; i.e. AV_PIX_FMT_RGB48LE.
+ *  @param size of RGB image in pixels.
+ *  @param stride of RGB data in bytes.
  */
-shared_ptr<dcp::XYZFrame>
+shared_ptr<dcp::XYZImage>
 dcp::rgb_to_xyz (
-       boost::shared_ptr<const Image> rgb,
+       uint8_t const * rgb,
+       dcp::Size size,
+       int stride,
        ColourConversion const & conversion
        )
 {
-       shared_ptr<XYZFrame> xyz (new XYZFrame (rgb->size ()));
+       shared_ptr<XYZImage> xyz (new XYZImage (size));
 
        struct {
                double r, g, b;
@@ -200,38 +238,47 @@ dcp::rgb_to_xyz (
                double x, y, z;
        } d;
 
-       float const * lut_in = conversion.in()->lut (12);
-       float const * lut_out = conversion.out()->lut (16);
-       boost::numeric::ublas::matrix<double> matrix = conversion.matrix ();
+       struct {
+               double x, y, z;
+       } e;
+       
+       double const * lut_in = conversion.in()->lut (12, false);
+       double const * lut_out = conversion.out()->lut (16, true);
+       boost::numeric::ublas::matrix<double> const rgb_to_xyz = conversion.rgb_to_xyz ();
+       boost::numeric::ublas::matrix<double> const bradford = conversion.bradford ();
 
        int jn = 0;
-       for (int y = 0; y < rgb->size().height; ++y) {
-               uint16_t* p = reinterpret_cast<uint16_t *> (rgb->data()[0] + y * rgb->stride()[0]);
-               for (int x = 0; x < rgb->size().width; ++x) {
+       for (int y = 0; y < size.height; ++y) {
+               uint16_t const * p = reinterpret_cast<uint16_t const *> (rgb + y * stride);
+               for (int x = 0; x < size.width; ++x) {
 
                        /* In gamma LUT (converting 16-bit to 12-bit) */
                        s.r = lut_in[*p++ >> 4];
                        s.g = lut_in[*p++ >> 4];
                        s.b = lut_in[*p++ >> 4];
-                       
+
                        /* RGB to XYZ Matrix */
-                       d.x = ((s.r * matrix(0, 0)) + (s.g * matrix(0, 1)) + (s.b * matrix(0, 2)));
-                       d.y = ((s.r * matrix(1, 0)) + (s.g * matrix(1, 1)) + (s.b * matrix(1, 2)));
-                       d.z = ((s.r * matrix(2, 0)) + (s.g * matrix(2, 1)) + (s.b * matrix(2, 2)));
+                       d.x = ((s.r * rgb_to_xyz(0, 0)) + (s.g * rgb_to_xyz(0, 1)) + (s.b * rgb_to_xyz(0, 2)));
+                       d.y = ((s.r * rgb_to_xyz(1, 0)) + (s.g * rgb_to_xyz(1, 1)) + (s.b * rgb_to_xyz(1, 2)));
+                       d.z = ((s.r * rgb_to_xyz(2, 0)) + (s.g * rgb_to_xyz(2, 1)) + (s.b * rgb_to_xyz(2, 2)));
+
+                       e.x = ((d.x * bradford(0, 0)) + (d.y * bradford(0, 1)) + (d.z * bradford(0, 2)));
+                       e.y = ((d.x * bradford(1, 0)) + (d.y * bradford(1, 1)) + (d.z * bradford(1, 2)));
+                       e.z = ((d.x * bradford(2, 0)) + (d.y * bradford(2, 1)) + (d.z * bradford(2, 2)));
                        
                        /* DCI companding */
-                       d.x = d.x * DCI_COEFFICIENT * 65535;
-                       d.y = d.y * DCI_COEFFICIENT * 65535;
-                       d.z = d.z * DCI_COEFFICIENT * 65535;
+                       e.x = e.x * DCI_COEFFICIENT * 65535;
+                       e.y = e.y * DCI_COEFFICIENT * 65535;
+                       e.z = e.z * DCI_COEFFICIENT * 65535;
 
-                       DCP_ASSERT (d.x >= 0 && d.x < 65536);
-                       DCP_ASSERT (d.y >= 0 && d.y < 65536);
-                       DCP_ASSERT (d.z >= 0 && d.z < 65536);
+                       DCP_ASSERT (e.x >= 0 && e.x < 65536);
+                       DCP_ASSERT (e.y >= 0 && e.y < 65536);
+                       DCP_ASSERT (e.z >= 0 && e.z < 65536);
                        
                        /* Out gamma LUT */
-                       xyz->data(0)[jn] = lut_out[(int) d.x] * 4096;
-                       xyz->data(1)[jn] = lut_out[(int) d.y] * 4096;
-                       xyz->data(2)[jn] = lut_out[(int) d.z] * 4096;
+                       xyz->data(0)[jn] = lut_out[int(rint(e.x))] * 4095;
+                       xyz->data(1)[jn] = lut_out[int(rint(e.y))] * 4095;
+                       xyz->data(2)[jn] = lut_out[int(rint(e.z))] * 4095;
 
                        ++jn;
                }
@@ -241,18 +288,19 @@ dcp::rgb_to_xyz (
 }
 
 
-/** Image must be packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, with the 2-byte value for each R/G/B component stored as little-endian;
- *  i.e. AV_PIX_FMT_RGB48LE.
+/** @param xyz_16 XYZ image data in packed 16:16:16, 48bpp, 16X, 16Y,
+ *  16Z, with the 2-byte value for each X/Y/Z component stored as
+ *  little-endian.
  */
-shared_ptr<dcp::XYZFrame>
-dcp::xyz_to_xyz (shared_ptr<const Image> xyz_16)
+shared_ptr<dcp::XYZImage>
+dcp::xyz_to_xyz (uint8_t const * xyz_16, dcp::Size size, int stride)
 {
-       shared_ptr<XYZFrame> xyz_12 (new XYZFrame (xyz_16->size ()));
+       shared_ptr<XYZImage> xyz_12 (new XYZImage (size));
 
        int jn = 0;
-       for (int y = 0; y < xyz_16->size().height; ++y) {
-               uint16_t* p = reinterpret_cast<uint16_t *> (xyz_16->data()[0] + y * xyz_16->stride()[0]);
-               for (int x = 0; x < xyz_16->size().width; ++x) {
+       for (int y = 0; y < size.height; ++y) {
+               uint16_t const * p = reinterpret_cast<uint16_t const *> (xyz_16 + y * stride);
+               for (int x = 0; x < size.width; ++x) {
                        /* Truncate 16-bit to 12-bit */
                        xyz_12->data(0)[jn] = *p++ >> 4;
                        xyz_12->data(1)[jn] = *p++ >> 4;