2 Copyright (C) 2013-2020 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic 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.
11 DCP-o-matic 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.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "colour_conversion.h"
25 #include <dcp/raw_convert.h>
26 #include <dcp/chromaticity.h>
27 #include <dcp/gamma_transfer_function.h>
28 #include <dcp/modified_gamma_transfer_function.h>
29 #include <dcp/identity_transfer_function.h>
30 #include <dcp/s_gamut3_transfer_function.h>
31 #include <libcxml/cxml.h>
32 #include <libxml++/libxml++.h>
33 #include <boost/foreach.hpp>
42 using boost::shared_ptr;
43 using boost::optional;
44 using boost::dynamic_pointer_cast;
45 using dcp::raw_convert;
47 vector<PresetColourConversion> PresetColourConversion::_presets;
49 ColourConversion::ColourConversion ()
50 : dcp::ColourConversion (dcp::ColourConversion::srgb_to_xyz ())
55 ColourConversion::ColourConversion (dcp::ColourConversion conversion_)
56 : dcp::ColourConversion (conversion_)
61 ColourConversion::ColourConversion (cxml::NodePtr node, int version)
63 shared_ptr<dcp::TransferFunction> in;
69 cxml::ConstNodePtr in_node = node->node_child ("InputTransferFunction");
70 string in_type = in_node->string_child ("Type");
71 if (in_type == "Gamma") {
72 _in.reset (new dcp::GammaTransferFunction (in_node->number_child<double> ("Gamma")));
73 } else if (in_type == "ModifiedGamma") {
74 _in.reset (new dcp::ModifiedGammaTransferFunction (
75 in_node->number_child<double> ("Power"),
76 in_node->number_child<double> ("Threshold"),
77 in_node->number_child<double> ("A"),
78 in_node->number_child<double> ("B")
80 } else if (in_type == "SGamut3") {
81 _in.reset (new dcp::SGamut3TransferFunction ());
88 if (node->bool_child ("InputGammaLinearised")) {
89 _in.reset (new dcp::ModifiedGammaTransferFunction (node->number_child<double> ("InputGamma"), 0.04045, 0.055, 12.92));
91 _in.reset (new dcp::GammaTransferFunction (node->number_child<double> ("InputGamma")));
95 _yuv_to_rgb = static_cast<dcp::YUVToRGB> (node->optional_number_child<int>("YUVToRGB").get_value_or (dcp::YUV_TO_RGB_REC601));
97 list<cxml::NodePtr> m = node->node_children ("Matrix");
99 /* Read in old <Matrix> nodes and convert them to chromaticities */
100 boost::numeric::ublas::matrix<double> C (3, 3);
101 for (list<cxml::NodePtr>::iterator i = m.begin(); i != m.end(); ++i) {
102 int const ti = (*i)->number_attribute<int> ("i");
103 int const tj = (*i)->number_attribute<int> ("j");
104 C(ti, tj) = raw_convert<double> ((*i)->content ());
107 double const rd = C(0, 0) + C(1, 0) + C(2, 0);
108 _red = dcp::Chromaticity (C(0, 0) / rd, C(1, 0) / rd);
109 double const gd = C(0, 1) + C(1, 1) + C(2, 1);
110 _green = dcp::Chromaticity (C(0, 1) / gd, C(1, 1) / gd);
111 double const bd = C(0, 2) + C(1, 2) + C(2, 2);
112 _blue = dcp::Chromaticity (C(0, 2) / bd, C(1, 2) / bd);
113 double const wd = C(0, 0) + C(0, 1) + C(0, 2) + C(1, 0) + C(1, 1) + C(1, 2) + C(2, 0) + C(2, 1) + C(2, 2);
114 _white = dcp::Chromaticity ((C(0, 0) + C(0, 1) + C(0, 2)) / wd, (C(1, 0) + C(1, 1) + C(1, 2)) / wd);
116 /* New-style chromaticities */
117 _red = dcp::Chromaticity (node->number_child<double> ("RedX"), node->number_child<double> ("RedY"));
118 _green = dcp::Chromaticity (node->number_child<double> ("GreenX"), node->number_child<double> ("GreenY"));
119 _blue = dcp::Chromaticity (node->number_child<double> ("BlueX"), node->number_child<double> ("BlueY"));
120 _white = dcp::Chromaticity (node->number_child<double> ("WhiteX"), node->number_child<double> ("WhiteY"));
121 if (node->optional_node_child ("AdjustedWhiteX")) {
122 _adjusted_white = dcp::Chromaticity (
123 node->number_child<double> ("AdjustedWhiteX"), node->number_child<double> ("AdjustedWhiteY")
128 optional<double> gamma = node->optional_number_child<double> ("OutputGamma");
130 _out.reset (new dcp::GammaTransferFunction (node->number_child<double> ("OutputGamma")));
132 _out.reset (new dcp::IdentityTransferFunction ());
136 boost::optional<ColourConversion>
137 ColourConversion::from_xml (cxml::NodePtr node, int version)
139 if (!node->optional_node_child ("InputTransferFunction")) {
140 return boost::optional<ColourConversion> ();
143 return ColourConversion (node, version);
147 ColourConversion::as_xml (xmlpp::Node* node) const
149 xmlpp::Node* in_node = node->add_child ("InputTransferFunction");
150 if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in)) {
151 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in);
152 in_node->add_child("Type")->add_child_text ("Gamma");
153 in_node->add_child("Gamma")->add_child_text (raw_convert<string> (tf->gamma ()));
154 } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in)) {
155 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in);
156 in_node->add_child("Type")->add_child_text ("ModifiedGamma");
157 in_node->add_child("Power")->add_child_text (raw_convert<string> (tf->power ()));
158 in_node->add_child("Threshold")->add_child_text (raw_convert<string> (tf->threshold ()));
159 in_node->add_child("A")->add_child_text (raw_convert<string> (tf->A ()));
160 in_node->add_child("B")->add_child_text (raw_convert<string> (tf->B ()));
161 } else if (dynamic_pointer_cast<const dcp::SGamut3TransferFunction> (_in)) {
162 in_node->add_child("Type")->add_child_text ("SGamut3");
165 node->add_child("YUVToRGB")->add_child_text (raw_convert<string> (static_cast<int> (_yuv_to_rgb)));
166 node->add_child("RedX")->add_child_text (raw_convert<string> (_red.x));
167 node->add_child("RedY")->add_child_text (raw_convert<string> (_red.y));
168 node->add_child("GreenX")->add_child_text (raw_convert<string> (_green.x));
169 node->add_child("GreenY")->add_child_text (raw_convert<string> (_green.y));
170 node->add_child("BlueX")->add_child_text (raw_convert<string> (_blue.x));
171 node->add_child("BlueY")->add_child_text (raw_convert<string> (_blue.y));
172 node->add_child("WhiteX")->add_child_text (raw_convert<string> (_white.x));
173 node->add_child("WhiteY")->add_child_text (raw_convert<string> (_white.y));
174 if (_adjusted_white) {
175 node->add_child("AdjustedWhiteX")->add_child_text (raw_convert<string> (_adjusted_white.get().x));
176 node->add_child("AdjustedWhiteY")->add_child_text (raw_convert<string> (_adjusted_white.get().y));
179 if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out)) {
180 shared_ptr<const dcp::GammaTransferFunction> gf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out);
181 node->add_child("OutputGamma")->add_child_text (raw_convert<string> (gf->gamma ()));
186 ColourConversion::preset () const
188 vector<PresetColourConversion> presets = PresetColourConversion::all ();
190 while (i < presets.size() && presets[i].conversion != *this) {
194 if (i >= presets.size ()) {
195 return optional<size_t> ();
202 ColourConversion::identifier () const
206 if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in)) {
207 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in);
208 digester.add (tf->gamma ());
209 } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in)) {
210 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in);
211 digester.add (tf->power ());
212 digester.add (tf->threshold ());
213 digester.add (tf->A ());
214 digester.add (tf->B ());
217 digester.add (_red.x);
218 digester.add (_red.y);
219 digester.add (_green.x);
220 digester.add (_green.y);
221 digester.add (_blue.x);
222 digester.add (_blue.y);
223 digester.add (_white.x);
224 digester.add (_white.y);
226 if (_adjusted_white) {
227 digester.add (_adjusted_white.get().x);
228 digester.add (_adjusted_white.get().y);
231 shared_ptr<const dcp::GammaTransferFunction> gf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out);
233 digester.add (gf->gamma ());
236 return digester.get ();
239 PresetColourConversion::PresetColourConversion ()
240 : name (_("Untitled"))
245 PresetColourConversion::PresetColourConversion (string n, string i, dcp::ColourConversion conversion_)
246 : conversion (conversion_)
253 PresetColourConversion::PresetColourConversion (cxml::NodePtr node, int version)
254 : conversion (node, version)
255 , name (node->string_child ("Name"))
261 operator== (ColourConversion const & a, ColourConversion const & b)
263 return a.about_equal (b, 1e-6);
267 operator!= (ColourConversion const & a, ColourConversion const & b)
273 operator== (PresetColourConversion const & a, PresetColourConversion const & b)
275 return a.name == b.name && a.conversion == b.conversion;
279 PresetColourConversion::setup_colour_conversion_presets ()
281 _presets.push_back (PresetColourConversion (_("sRGB"), "srgb", dcp::ColourConversion::srgb_to_xyz ()));
282 _presets.push_back (PresetColourConversion (_("Rec. 601"), "rec601", dcp::ColourConversion::rec601_to_xyz ()));
283 _presets.push_back (PresetColourConversion (_("Rec. 709"), "rec709", dcp::ColourConversion::rec709_to_xyz ()));
284 _presets.push_back (PresetColourConversion (_("P3"), "p3", dcp::ColourConversion::p3_to_xyz ()));
285 _presets.push_back (PresetColourConversion (_("Rec. 1886"), "rec1886", dcp::ColourConversion::rec1886_to_xyz ()));
286 _presets.push_back (PresetColourConversion (_("Rec. 2020"), "rec2020", dcp::ColourConversion::rec2020_to_xyz ()));
287 _presets.push_back (PresetColourConversion (_("S-Gamut3/S-Log3"), "sgamut3", dcp::ColourConversion::s_gamut3_to_xyz ()));
290 PresetColourConversion
291 PresetColourConversion::from_id (string s)
293 BOOST_FOREACH (PresetColourConversion const& i, _presets) {
299 DCPOMATIC_ASSERT (false);