Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / lib / colour_conversion.cc
index aacefaa05502c9202178b2637dfa7dd5dbd50df6..2e052060e2b247ad9f26dbd51c54399b952f9c91 100644 (file)
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2020 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/>.
 
 */
 
-#include <libxml++/libxml++.h>
-#include <dcp/colour_matrix.h>
-#include <dcp/raw_convert.h>
-#include <libcxml/cxml.h>
 #include "config.h"
 #include "colour_conversion.h"
 #include "util.h"
-#include "md5_digester.h"
+#include "digester.h"
+#include <dcp/raw_convert.h>
+#include <dcp/chromaticity.h>
+#include <dcp/gamma_transfer_function.h>
+#include <dcp/modified_gamma_transfer_function.h>
+#include <dcp/identity_transfer_function.h>
+#include <dcp/s_gamut3_transfer_function.h>
+#include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
 using std::list;
 using std::string;
-using std::stringstream;
 using std::cout;
 using std::vector;
 using boost::shared_ptr;
 using boost::optional;
+using boost::dynamic_pointer_cast;
 using dcp::raw_convert;
 
+vector<PresetColourConversion> PresetColourConversion::_presets;
+
 ColourConversion::ColourConversion ()
-       : input_gamma (2.4)
-       , input_gamma_linearised (true)
-       , matrix (3, 3)
-       , output_gamma (2.6)
+       : dcp::ColourConversion (dcp::ColourConversion::srgb_to_xyz ())
 {
-       for (int i = 0; i < 3; ++i) {
-               for (int j = 0; j < 3; ++j) {
-                       matrix (i, j) = dcp::colour_matrix::srgb_to_xyz[i][j];
-               }
-       }
+
 }
 
-ColourConversion::ColourConversion (double i, bool il, double const m[3][3], double o)
-       : input_gamma (i)
-       , input_gamma_linearised (il)
-       , matrix (3, 3)
-       , output_gamma (o)
+ColourConversion::ColourConversion (dcp::ColourConversion conversion_)
+       : dcp::ColourConversion (conversion_)
 {
-       for (int i = 0; i < 3; ++i) {
-               for (int j = 0; j < 3; ++j) {
-                       matrix (i, j) = m[i][j];
-               }
-       }
+
 }
 
-ColourConversion::ColourConversion (cxml::NodePtr node)
-       : matrix (3, 3)
+ColourConversion::ColourConversion (cxml::NodePtr node, int version)
 {
-       input_gamma = node->number_child<double> ("InputGamma");
-       input_gamma_linearised = node->bool_child ("InputGammaLinearised");
+       shared_ptr<dcp::TransferFunction> in;
+
+       if (version >= 32) {
+
+               /* Version 2.x */
 
-       for (int i = 0; i < 3; ++i) {
-               for (int j = 0; j < 3; ++j) {
-                       matrix (i, j) = 0;
+               cxml::ConstNodePtr in_node = node->node_child ("InputTransferFunction");
+               string in_type = in_node->string_child ("Type");
+               if (in_type == "Gamma") {
+                       _in.reset (new dcp::GammaTransferFunction (in_node->number_child<double> ("Gamma")));
+               } else if (in_type == "ModifiedGamma") {
+                       _in.reset (new dcp::ModifiedGammaTransferFunction (
+                                          in_node->number_child<double> ("Power"),
+                                          in_node->number_child<double> ("Threshold"),
+                                          in_node->number_child<double> ("A"),
+                                          in_node->number_child<double> ("B")
+                                          ));
+               } else if (in_type == "SGamut3") {
+                       _in.reset (new dcp::SGamut3TransferFunction ());
+               }
+
+       } else {
+
+               /* Version 1.x */
+
+               if (node->bool_child ("InputGammaLinearised")) {
+                       _in.reset (new dcp::ModifiedGammaTransferFunction (node->number_child<double> ("InputGamma"), 0.04045, 0.055, 12.92));
+               } else {
+                       _in.reset (new dcp::GammaTransferFunction (node->number_child<double> ("InputGamma")));
                }
        }
 
+       _yuv_to_rgb = static_cast<dcp::YUVToRGB> (node->optional_number_child<int>("YUVToRGB").get_value_or (dcp::YUV_TO_RGB_REC601));
+
        list<cxml::NodePtr> m = node->node_children ("Matrix");
-       for (list<cxml::NodePtr>::iterator i = m.begin(); i != m.end(); ++i) {
-               int const ti = (*i)->number_attribute<int> ("i");
-               int const tj = (*i)->number_attribute<int> ("j");
-               matrix(ti, tj) = raw_convert<double> ((*i)->content ());
+       if (!m.empty ()) {
+               /* Read in old <Matrix> nodes and convert them to chromaticities */
+               boost::numeric::ublas::matrix<double> C (3, 3);
+               for (list<cxml::NodePtr>::iterator i = m.begin(); i != m.end(); ++i) {
+                       int const ti = (*i)->number_attribute<int> ("i");
+                       int const tj = (*i)->number_attribute<int> ("j");
+                       C(ti, tj) = raw_convert<double> ((*i)->content ());
+               }
+
+               double const rd = C(0, 0) + C(1, 0) + C(2, 0);
+               _red = dcp::Chromaticity (C(0, 0) / rd, C(1, 0) / rd);
+               double const gd = C(0, 1) + C(1, 1) + C(2, 1);
+               _green = dcp::Chromaticity (C(0, 1) / gd, C(1, 1) / gd);
+               double const bd = C(0, 2) + C(1, 2) + C(2, 2);
+               _blue = dcp::Chromaticity (C(0, 2) / bd, C(1, 2) / bd);
+               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);
+               _white = dcp::Chromaticity ((C(0, 0) + C(0, 1) + C(0, 2)) / wd, (C(1, 0) + C(1, 1) + C(1, 2)) / wd);
+       } else {
+               /* New-style chromaticities */
+               _red = dcp::Chromaticity (node->number_child<double> ("RedX"), node->number_child<double> ("RedY"));
+               _green = dcp::Chromaticity (node->number_child<double> ("GreenX"), node->number_child<double> ("GreenY"));
+               _blue = dcp::Chromaticity (node->number_child<double> ("BlueX"), node->number_child<double> ("BlueY"));
+               _white = dcp::Chromaticity (node->number_child<double> ("WhiteX"), node->number_child<double> ("WhiteY"));
+               if (node->optional_node_child ("AdjustedWhiteX")) {
+                       _adjusted_white = dcp::Chromaticity (
+                               node->number_child<double> ("AdjustedWhiteX"), node->number_child<double> ("AdjustedWhiteY")
+                               );
+               }
        }
 
-       output_gamma = node->number_child<double> ("OutputGamma");
+       optional<double> gamma = node->optional_number_child<double> ("OutputGamma");
+       if (gamma) {
+               _out.reset (new dcp::GammaTransferFunction (node->number_child<double> ("OutputGamma")));
+       } else {
+               _out.reset (new dcp::IdentityTransferFunction ());
+       }
+}
+
+boost::optional<ColourConversion>
+ColourConversion::from_xml (cxml::NodePtr node, int version)
+{
+       if (!node->optional_node_child ("InputTransferFunction")) {
+               return boost::optional<ColourConversion> ();
+       }
+
+       return ColourConversion (node, version);
 }
 
 void
 ColourConversion::as_xml (xmlpp::Node* node) const
 {
-       node->add_child("InputGamma")->add_child_text (raw_convert<string> (input_gamma));
-       node->add_child("InputGammaLinearised")->add_child_text (input_gamma_linearised ? "1" : "0");
-
-       for (int i = 0; i < 3; ++i) {
-               for (int j = 0; j < 3; ++j) {
-                       xmlpp::Element* m = node->add_child("Matrix");
-                       m->set_attribute ("i", raw_convert<string> (i));
-                       m->set_attribute ("j", raw_convert<string> (j));
-                       m->add_child_text (raw_convert<string> (matrix (i, j)));
-               }
+       xmlpp::Node* in_node = node->add_child ("InputTransferFunction");
+       if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in)) {
+               shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in);
+               in_node->add_child("Type")->add_child_text ("Gamma");
+               in_node->add_child("Gamma")->add_child_text (raw_convert<string> (tf->gamma ()));
+       } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in)) {
+               shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in);
+               in_node->add_child("Type")->add_child_text ("ModifiedGamma");
+               in_node->add_child("Power")->add_child_text (raw_convert<string> (tf->power ()));
+               in_node->add_child("Threshold")->add_child_text (raw_convert<string> (tf->threshold ()));
+               in_node->add_child("A")->add_child_text (raw_convert<string> (tf->A ()));
+               in_node->add_child("B")->add_child_text (raw_convert<string> (tf->B ()));
+       } else if (dynamic_pointer_cast<const dcp::SGamut3TransferFunction> (_in)) {
+               in_node->add_child("Type")->add_child_text ("SGamut3");
        }
 
-       node->add_child("OutputGamma")->add_child_text (raw_convert<string> (output_gamma));
+       node->add_child("YUVToRGB")->add_child_text (raw_convert<string> (static_cast<int> (_yuv_to_rgb)));
+       node->add_child("RedX")->add_child_text (raw_convert<string> (_red.x));
+       node->add_child("RedY")->add_child_text (raw_convert<string> (_red.y));
+       node->add_child("GreenX")->add_child_text (raw_convert<string> (_green.x));
+       node->add_child("GreenY")->add_child_text (raw_convert<string> (_green.y));
+       node->add_child("BlueX")->add_child_text (raw_convert<string> (_blue.x));
+       node->add_child("BlueY")->add_child_text (raw_convert<string> (_blue.y));
+       node->add_child("WhiteX")->add_child_text (raw_convert<string> (_white.x));
+       node->add_child("WhiteY")->add_child_text (raw_convert<string> (_white.y));
+       if (_adjusted_white) {
+               node->add_child("AdjustedWhiteX")->add_child_text (raw_convert<string> (_adjusted_white.get().x));
+               node->add_child("AdjustedWhiteY")->add_child_text (raw_convert<string> (_adjusted_white.get().y));
+       }
+
+       if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out)) {
+               shared_ptr<const dcp::GammaTransferFunction> gf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out);
+               node->add_child("OutputGamma")->add_child_text (raw_convert<string> (gf->gamma ()));
+       }
 }
 
 optional<size_t>
 ColourConversion::preset () const
 {
-       vector<PresetColourConversion> presets = Config::instance()->colour_conversions ();
+       vector<PresetColourConversion> presets = PresetColourConversion::all ();
        size_t i = 0;
-       while (i < presets.size() && (presets[i].conversion != *this)) {
+       while (i < presets.size() && presets[i].conversion != *this) {
                ++i;
        }
 
@@ -122,17 +201,38 @@ ColourConversion::preset () const
 string
 ColourConversion::identifier () const
 {
-       MD5Digester digester;
-       
-       digester.add (input_gamma);
-       digester.add (input_gamma_linearised);
-       for (int i = 0; i < 3; ++i) {
-               for (int j = 0; j < 3; ++j) {
-                       digester.add (matrix (i, j));
-               }
+       Digester digester;
+
+       if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in)) {
+               shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in);
+               digester.add (tf->gamma ());
+       } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in)) {
+               shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in);
+               digester.add (tf->power ());
+               digester.add (tf->threshold ());
+               digester.add (tf->A ());
+               digester.add (tf->B ());
+       }
+
+       digester.add (_red.x);
+       digester.add (_red.y);
+       digester.add (_green.x);
+       digester.add (_green.y);
+       digester.add (_blue.x);
+       digester.add (_blue.y);
+       digester.add (_white.x);
+       digester.add (_white.y);
+
+       if (_adjusted_white) {
+               digester.add (_adjusted_white.get().x);
+               digester.add (_adjusted_white.get().y);
+       }
+
+       shared_ptr<const dcp::GammaTransferFunction> gf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out);
+       if (gf) {
+               digester.add (gf->gamma ());
        }
-       digester.add (output_gamma);
-       
+
        return digester.get ();
 }
 
@@ -142,56 +242,59 @@ PresetColourConversion::PresetColourConversion ()
 
 }
 
-PresetColourConversion::PresetColourConversion (string n, double i, bool il, double const m[3][3], double o)
-       : name (n)
-       , conversion (i, il, m, o)
+PresetColourConversion::PresetColourConversion (string n, string i, dcp::ColourConversion conversion_)
+       : conversion (conversion_)
+       , name (n)
+       , id (i)
 {
 
 }
 
-PresetColourConversion::PresetColourConversion (cxml::NodePtr node)
-       : conversion (node)
+PresetColourConversion::PresetColourConversion (cxml::NodePtr node, int version)
+       : conversion (node, version)
+       , name (node->string_child ("Name"))
 {
-       name = node->string_child ("Name");
+
 }
 
-void
-PresetColourConversion::as_xml (xmlpp::Node* node) const
+bool
+operator== (ColourConversion const & a, ColourConversion const & b)
 {
-       conversion.as_xml (node);
-       node->add_child("Name")->add_child_text (name);
+       return a.about_equal (b, 1e-6);
 }
 
-static bool
-about_equal (double a, double b)
+bool
+operator!= (ColourConversion const & a, ColourConversion const & b)
 {
-       static const double eps = 1e-6;
-       return fabs (a - b) < eps;
+       return !(a == b);
 }
 
 bool
-operator== (ColourConversion const & a, ColourConversion const & b)
+operator== (PresetColourConversion const & a, PresetColourConversion const & b)
 {
-       if (
-               !about_equal (a.input_gamma, b.input_gamma) ||
-               a.input_gamma_linearised != b.input_gamma_linearised ||
-               !about_equal (a.output_gamma, b.output_gamma)) {
-               return false;
-       }
-
-       for (int i = 0; i < 3; ++i) {
-               for (int j = 0; j < 3; ++j) {
-                       if (!about_equal (a.matrix (i, j), b.matrix (i, j))) {
-                               return false;
-                       }
-               }
-       }
+       return a.name == b.name && a.conversion == b.conversion;
+}
 
-       return true;
+void
+PresetColourConversion::setup_colour_conversion_presets ()
+{
+       _presets.push_back (PresetColourConversion (_("sRGB"), "srgb", dcp::ColourConversion::srgb_to_xyz ()));
+       _presets.push_back (PresetColourConversion (_("Rec. 601"), "rec601", dcp::ColourConversion::rec601_to_xyz ()));
+       _presets.push_back (PresetColourConversion (_("Rec. 709"), "rec709", dcp::ColourConversion::rec709_to_xyz ()));
+       _presets.push_back (PresetColourConversion (_("P3"), "p3", dcp::ColourConversion::p3_to_xyz ()));
+       _presets.push_back (PresetColourConversion (_("Rec. 1886"), "rec1886", dcp::ColourConversion::rec1886_to_xyz ()));
+       _presets.push_back (PresetColourConversion (_("Rec. 2020"), "rec2020", dcp::ColourConversion::rec2020_to_xyz ()));
+       _presets.push_back (PresetColourConversion (_("S-Gamut3/S-Log3"), "sgamut3", dcp::ColourConversion::s_gamut3_to_xyz ()));
 }
 
-bool
-operator!= (ColourConversion const & a, ColourConversion const & b)
+PresetColourConversion
+PresetColourConversion::from_id (string s)
 {
-       return !(a == b);
+       BOOST_FOREACH (PresetColourConversion const& i, _presets) {
+               if (i.id == s) {
+                       return i;
+               }
+       }
+
+       DCPOMATIC_ASSERT (false);
 }