Add DCNC tags file.
[libdcp.git] / test / rgb_xyz_test.cc
1 /*
2     Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
18
19     In addition, as a special exception, the copyright holders give
20     permission to link the code of portions of this program with the
21     OpenSSL library under certain conditions as described in each
22     individual source file, and distribute linked combinations
23     including the two.
24
25     You must obey the GNU General Public License in all respects
26     for all of the code used other than OpenSSL.  If you modify
27     file(s) with this exception, you may extend this exception to your
28     version of the file(s), but you are not obligated to do so.  If you
29     do not wish to do so, delete this exception statement from your
30     version.  If you delete this exception statement from all source
31     files in the program, then also delete it here.
32 */
33
34 #include "rgb_xyz.h"
35 #include "openjpeg_image.h"
36 #include "colour_conversion.h"
37 #include "stream_operators.h"
38 #include <boost/test/unit_test.hpp>
39 #include <boost/bind.hpp>
40 #include <boost/scoped_array.hpp>
41
42 using std::max;
43 using std::list;
44 using std::string;
45 using std::cout;
46 using std::shared_ptr;
47 using std::make_shared;
48 using boost::optional;
49 using boost::scoped_array;
50
51 /** Convert a test image from sRGB to XYZ and check that the transforms are right */
52 BOOST_AUTO_TEST_CASE (rgb_xyz_test)
53 {
54         srand (0);
55         dcp::Size const size (640, 480);
56
57         scoped_array<uint8_t> rgb (new uint8_t[size.width * size.height * 6]);
58         for (int y = 0; y < size.height; ++y) {
59                 uint16_t* p = reinterpret_cast<uint16_t*> (rgb.get() + y * size.width * 6);
60                 for (int x = 0; x < size.width; ++x) {
61                         /* Write a 12-bit random number for each component */
62                         for (int c = 0; c < 3; ++c) {
63                                 *p = (rand () & 0xfff) << 4;
64                                 ++p;
65                         }
66                 }
67         }
68
69         auto xyz = dcp::rgb_to_xyz (rgb.get(), size, size.width * 6, dcp::ColourConversion::srgb_to_xyz());
70
71         for (int y = 0; y < size.height; ++y) {
72                 uint16_t* p = reinterpret_cast<uint16_t*> (rgb.get() + y * size.width * 6);
73                 for (int x = 0; x < size.width; ++x) {
74
75                         double cr = *p++ / 65535.0;
76                         double cg = *p++ / 65535.0;
77                         double cb = *p++ / 65535.0;
78
79                         /* Input gamma */
80
81                         if (cr < 0.04045) {
82                                 cr /= 12.92;
83                         } else {
84                                 cr = pow ((cr + 0.055) / 1.055, 2.4);
85                         }
86
87                         if (cg < 0.04045) {
88                                 cg /= 12.92;
89                         } else {
90                                 cg = pow ((cg + 0.055) / 1.055, 2.4);
91                         }
92
93                         if (cb < 0.04045) {
94                                 cb /= 12.92;
95                         } else {
96                                 cb = pow ((cb + 0.055) / 1.055, 2.4);
97                         }
98
99                         /* Matrix */
100
101                         double cx = cr * 0.4124564 + cg * 0.3575761 + cb * 0.1804375;
102                         double cy = cr * 0.2126729 + cg * 0.7151522 + cb * 0.0721750;
103                         double cz = cr * 0.0193339 + cg * 0.1191920 + cb * 0.9503041;
104
105                         /* Compand */
106
107                         cx *= 48 / 52.37;
108                         cy *= 48 / 52.37;
109                         cz *= 48 / 52.37;
110
111                         /* Output gamma */
112
113                         cx = pow (cx, 1 / 2.6);
114                         cy = pow (cy, 1 / 2.6);
115                         cz = pow (cz, 1 / 2.6);
116
117                         BOOST_REQUIRE_CLOSE (cx * 4095, xyz->data(0)[y * size.width + x], 1);
118                         BOOST_REQUIRE_CLOSE (cy * 4095, xyz->data(1)[y * size.width + x], 1);
119                         BOOST_REQUIRE_CLOSE (cz * 4095, xyz->data(2)[y * size.width + x], 1);
120                 }
121         }
122 }
123
124 static list<string> notes;
125
126 static void
127 note_handler (dcp::NoteType n, string s)
128 {
129         BOOST_REQUIRE_EQUAL (n, dcp::NoteType::NOTE);
130         notes.push_back (s);
131 }
132
133 /** Check that xyz_to_rgb clamps XYZ values correctly */
134 BOOST_AUTO_TEST_CASE (xyz_rgb_range_test)
135 {
136         auto xyz = make_shared<dcp::OpenJPEGImage>(dcp::Size(2, 2));
137
138         xyz->data(0)[0] = -4;
139         xyz->data(0)[1] = 6901;
140         xyz->data(0)[2] = 0;
141         xyz->data(0)[3] = 4095;
142         xyz->data(1)[0] = -4;
143         xyz->data(1)[1] = 6901;
144         xyz->data(1)[2] = 0;
145         xyz->data(1)[3] = 4095;
146         xyz->data(2)[0] = -4;
147         xyz->data(2)[1] = 6901;
148         xyz->data(2)[2] = 0;
149         xyz->data(2)[3] = 4095;
150
151         scoped_array<uint8_t> rgb (new uint8_t[2 * 2 * 6]);
152
153         notes.clear ();
154         dcp::xyz_to_rgb (
155                 xyz, dcp::ColourConversion::srgb_to_xyz (), rgb.get(), 2 * 6, boost::optional<dcp::NoteHandler> (boost::bind (&note_handler, _1, _2))
156                 );
157
158         /* The 6 out-of-range samples should have been noted */
159         BOOST_REQUIRE_EQUAL (notes.size(), 6);
160         auto i = notes.begin ();
161         BOOST_REQUIRE_EQUAL (*i++, "XYZ value -4 out of range");
162         BOOST_REQUIRE_EQUAL (*i++, "XYZ value -4 out of range");
163         BOOST_REQUIRE_EQUAL (*i++, "XYZ value -4 out of range");
164         BOOST_REQUIRE_EQUAL (*i++, "XYZ value 6901 out of range");
165         BOOST_REQUIRE_EQUAL (*i++, "XYZ value 6901 out of range");
166         BOOST_REQUIRE_EQUAL (*i++, "XYZ value 6901 out of range");
167
168         /* And those samples should have been clamped, so check that they give the same result
169            as inputs at the extremes (0 and 4095).
170         */
171
172         auto buffer = reinterpret_cast<uint16_t*> (rgb.get ());
173         BOOST_REQUIRE_EQUAL (buffer[0 * 3 + 0], buffer[2 * 3 + 1]);
174         BOOST_REQUIRE_EQUAL (buffer[0 * 3 + 1], buffer[2 * 3 + 1]);
175         BOOST_REQUIRE_EQUAL (buffer[0 * 3 + 2], buffer[2 * 3 + 2]);
176
177         BOOST_REQUIRE_EQUAL (buffer[1 * 3 + 0], buffer[3 * 3 + 0]);
178         BOOST_REQUIRE_EQUAL (buffer[1 * 3 + 1], buffer[3 * 3 + 1]);
179         BOOST_REQUIRE_EQUAL (buffer[1 * 3 + 2], buffer[3 * 3 + 2]);
180 }
181
182 /** Convert an image from RGB to XYZ and back again */
183 BOOST_AUTO_TEST_CASE (rgb_xyz_round_trip_test)
184 {
185         srand (0);
186         dcp::Size const size (640, 480);
187
188         scoped_array<uint8_t> rgb (new uint8_t[size.width * size.height * 6]);
189         for (int y = 0; y < size.height; ++y) {
190                 uint16_t* p = reinterpret_cast<uint16_t*> (rgb.get() + y * size.width * 6);
191                 for (int x = 0; x < size.width; ++x) {
192                         /* Write a 12-bit random number for each component */
193                         for (int c = 0; c < 3; ++c) {
194                                 *p = (rand () & 0xfff) << 4;
195                                 ++p;
196                         }
197                 }
198         }
199
200         shared_ptr<dcp::OpenJPEGImage> xyz = dcp::rgb_to_xyz (rgb.get(), size, size.width * 6, dcp::ColourConversion::srgb_to_xyz ());
201         scoped_array<uint8_t> back (new uint8_t[size.width * size.height * 6]);
202         dcp::xyz_to_rgb (xyz, dcp::ColourConversion::srgb_to_xyz (), back.get(), size.width * 6);
203
204 #if 0
205         uint16_t* p = reinterpret_cast<uint16_t*> (rgb.get ());
206         uint16_t* q = reinterpret_cast<uint16_t*> (back.get ());
207         for (int i = 0; i < (size.width * size.height); ++i) {
208                 /* XXX: doesn't quite work */
209                 // BOOST_REQUIRE_EQUAL (*p++, *q++);
210         }
211 #endif
212 }