src/lib/colour_conversion.cc

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "config.h"
  22 #include "colour_conversion.h"
  23 #include "util.h"
  24 #include "digester.h"
  25 #include <dcp/raw_convert.h>
  26 #include <dcp/chromaticity.h>
  27 #include <dcp/colour_matrix.h>
  28 #include <dcp/gamma_transfer_function.h>
  29 #include <dcp/modified_gamma_transfer_function.h>
  30 #include <libcxml/cxml.h>
  31 #include <libxml++/libxml++.h>
  32 #include <boost/foreach.hpp>
  33 #include <iostream>
  34
  35 #include "i18n.h"
  36
  37 using std::list;
  38 using std::string;
  39 using std::cout;
  40 using std::vector;
  41 using boost::shared_ptr;
  42 using boost::optional;
  43 using boost::dynamic_pointer_cast;
  44 using dcp::raw_convert;
  45
  46 vector<PresetColourConversion> PresetColourConversion::_presets;
  47
  48 ColourConversion::ColourConversion ()
  49         : dcp::ColourConversion (dcp::ColourConversion::srgb_to_xyz ())
  50 {
  51
  52 }
  53
  54 ColourConversion::ColourConversion (dcp::ColourConversion conversion_)
  55         : dcp::ColourConversion (conversion_)
  56 {
  57
  58 }
  59
  60 ColourConversion::ColourConversion (cxml::NodePtr node, int version)
  61 {
  62         shared_ptr<dcp::TransferFunction> in;
  63
  64         if (version >= 32) {
  65
  66                 /* Version 2.x */
  67
  68                 cxml::ConstNodePtr in_node = node->node_child ("InputTransferFunction");
  69                 string in_type = in_node->string_child ("Type");
  70                 if (in_type == "Gamma") {
  71                         _in.reset (new dcp::GammaTransferFunction (in_node->number_child<double> ("Gamma")));
  72                 } else if (in_type == "ModifiedGamma") {
  73                         _in.reset (new dcp::ModifiedGammaTransferFunction (
  74                                            in_node->number_child<double> ("Power"),
  75                                            in_node->number_child<double> ("Threshold"),
  76                                            in_node->number_child<double> ("A"),
  77                                            in_node->number_child<double> ("B")
  78                                            ));
  79                 }
  80
  81         } else {
  82
  83                 /* Version 1.x */
  84
  85                 if (node->bool_child ("InputGammaLinearised")) {
  86                         _in.reset (new dcp::ModifiedGammaTransferFunction (node->number_child<double> ("InputGamma"), 0.04045, 0.055, 12.92));
  87                 } else {
  88                         _in.reset (new dcp::GammaTransferFunction (node->number_child<double> ("InputGamma")));
  89                 }
  90         }
  91
  92         _yuv_to_rgb = static_cast<dcp::YUVToRGB> (node->optional_number_child<int>("YUVToRGB").get_value_or (dcp::YUV_TO_RGB_REC601));
  93
  94         list<cxml::NodePtr> m = node->node_children ("Matrix");
  95         if (!m.empty ()) {
  96                 /* Read in old <Matrix> nodes and convert them to chromaticities */
  97                 boost::numeric::ublas::matrix<double> C (3, 3);
  98                 for (list<cxml::NodePtr>::iterator i = m.begin(); i != m.end(); ++i) {
  99                         int const ti = (*i)->number_attribute<int> ("i");
 100                         int const tj = (*i)->number_attribute<int> ("j");
 101                         C(ti, tj) = raw_convert<double> ((*i)->content ());
 102                 }
 103
 104                 double const rd = C(0, 0) + C(1, 0) + C(2, 0);
 105                 _red = dcp::Chromaticity (C(0, 0) / rd, C(1, 0) / rd);
 106                 double const gd = C(0, 1) + C(1, 1) + C(2, 1);
 107                 _green = dcp::Chromaticity (C(0, 1) / gd, C(1, 1) / gd);
 108                 double const bd = C(0, 2) + C(1, 2) + C(2, 2);
 109                 _blue = dcp::Chromaticity (C(0, 2) / bd, C(1, 2) / bd);
 110                 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);
 111                 _white = dcp::Chromaticity ((C(0, 0) + C(0, 1) + C(0, 2)) / wd, (C(1, 0) + C(1, 1) + C(1, 2)) / wd);
 112         } else {
 113                 /* New-style chromaticities */
 114                 _red = dcp::Chromaticity (node->number_child<double> ("RedX"), node->number_child<double> ("RedY"));
 115                 _green = dcp::Chromaticity (node->number_child<double> ("GreenX"), node->number_child<double> ("GreenY"));
 116                 _blue = dcp::Chromaticity (node->number_child<double> ("BlueX"), node->number_child<double> ("BlueY"));
 117                 _white = dcp::Chromaticity (node->number_child<double> ("WhiteX"), node->number_child<double> ("WhiteY"));
 118                 if (node->optional_node_child ("AdjustedWhiteX")) {
 119                         _adjusted_white = dcp::Chromaticity (
 120                                 node->number_child<double> ("AdjustedWhiteX"), node->number_child<double> ("AdjustedWhiteY")
 121                                 );
 122                 }
 123         }
 124
 125         _out.reset (new dcp::GammaTransferFunction (node->number_child<double> ("OutputGamma")));
 126 }
 127
 128 boost::optional<ColourConversion>
 129 ColourConversion::from_xml (cxml::NodePtr node, int version)
 130 {
 131         if (!node->optional_node_child ("InputTransferFunction")) {
 132                 return boost::optional<ColourConversion> ();
 133         }
 134
 135         return ColourConversion (node, version);
 136 }
 137
 138 void
 139 ColourConversion::as_xml (xmlpp::Node* node) const
 140 {
 141         xmlpp::Node* in_node = node->add_child ("InputTransferFunction");
 142         if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in)) {
 143                 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in);
 144                 in_node->add_child("Type")->add_child_text ("Gamma");
 145                 in_node->add_child("Gamma")->add_child_text (raw_convert<string> (tf->gamma ()));
 146         } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in)) {
 147                 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in);
 148                 in_node->add_child("Type")->add_child_text ("ModifiedGamma");
 149                 in_node->add_child("Power")->add_child_text (raw_convert<string> (tf->power ()));
 150                 in_node->add_child("Threshold")->add_child_text (raw_convert<string> (tf->threshold ()));
 151                 in_node->add_child("A")->add_child_text (raw_convert<string> (tf->A ()));
 152                 in_node->add_child("B")->add_child_text (raw_convert<string> (tf->B ()));
 153         }
 154
 155         node->add_child("YUVToRGB")->add_child_text (raw_convert<string> (_yuv_to_rgb));
 156         node->add_child("RedX")->add_child_text (raw_convert<string> (_red.x));
 157         node->add_child("RedY")->add_child_text (raw_convert<string> (_red.y));
 158         node->add_child("GreenX")->add_child_text (raw_convert<string> (_green.x));
 159         node->add_child("GreenY")->add_child_text (raw_convert<string> (_green.y));
 160         node->add_child("BlueX")->add_child_text (raw_convert<string> (_blue.x));
 161         node->add_child("BlueY")->add_child_text (raw_convert<string> (_blue.y));
 162         node->add_child("WhiteX")->add_child_text (raw_convert<string> (_white.x));
 163         node->add_child("WhiteY")->add_child_text (raw_convert<string> (_white.y));
 164         if (_adjusted_white) {
 165                 node->add_child("AdjustedWhiteX")->add_child_text (raw_convert<string> (_adjusted_white.get().x));
 166                 node->add_child("AdjustedWhiteY")->add_child_text (raw_convert<string> (_adjusted_white.get().y));
 167         }
 168
 169         node->add_child("OutputGamma")->add_child_text (raw_convert<string> (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out)->gamma ()));
 170 }
 171
 172 optional<size_t>
 173 ColourConversion::preset () const
 174 {
 175         vector<PresetColourConversion> presets = PresetColourConversion::all ();
 176         size_t i = 0;
 177         while (i < presets.size() && presets[i].conversion != *this) {
 178                 ++i;
 179         }
 180
 181         if (i >= presets.size ()) {
 182                 return optional<size_t> ();
 183         }
 184
 185         return i;
 186 }
 187
 188 string
 189 ColourConversion::identifier () const
 190 {
 191         Digester digester;
 192
 193         if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in)) {
 194                 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (_in);
 195                 digester.add (tf->gamma ());
 196         } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in)) {
 197                 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (_in);
 198                 digester.add (tf->power ());
 199                 digester.add (tf->threshold ());
 200                 digester.add (tf->A ());
 201                 digester.add (tf->B ());
 202         }
 203
 204         digester.add (_red.x);
 205         digester.add (_red.y);
 206         digester.add (_green.x);
 207         digester.add (_green.y);
 208         digester.add (_blue.x);
 209         digester.add (_blue.y);
 210         digester.add (_white.x);
 211         digester.add (_white.y);
 212
 213         if (_adjusted_white) {
 214                 digester.add (_adjusted_white.get().x);
 215                 digester.add (_adjusted_white.get().y);
 216         }
 217
 218         digester.add (dynamic_pointer_cast<const dcp::GammaTransferFunction> (_out)->gamma ());
 219
 220         return digester.get ();
 221 }
 222
 223 PresetColourConversion::PresetColourConversion ()
 224         : name (_("Untitled"))
 225 {
 226
 227 }
 228
 229 PresetColourConversion::PresetColourConversion (string n, string i, dcp::ColourConversion conversion_)
 230         : conversion (conversion_)
 231         , name (n)
 232         , id (i)
 233 {
 234
 235 }
 236
 237 PresetColourConversion::PresetColourConversion (cxml::NodePtr node, int version)
 238         : conversion (node, version)
 239         , name (node->string_child ("Name"))
 240 {
 241
 242 }
 243
 244 bool
 245 operator== (ColourConversion const & a, ColourConversion const & b)
 246 {
 247         return a.about_equal (b, 1e-6);
 248 }
 249
 250 bool
 251 operator!= (ColourConversion const & a, ColourConversion const & b)
 252 {
 253         return !(a == b);
 254 }
 255
 256 bool
 257 operator== (PresetColourConversion const & a, PresetColourConversion const & b)
 258 {
 259         return a.name == b.name && a.conversion == b.conversion;
 260 }
 261
 262 void
 263 PresetColourConversion::setup_colour_conversion_presets ()
 264 {
 265         _presets.push_back (PresetColourConversion (_("sRGB"), "srgb", dcp::ColourConversion::srgb_to_xyz ()));
 266         _presets.push_back (PresetColourConversion (_("Rec. 601"), "rec601", dcp::ColourConversion::rec601_to_xyz ()));
 267         _presets.push_back (PresetColourConversion (_("Rec. 709"), "rec709", dcp::ColourConversion::rec709_to_xyz ()));
 268         _presets.push_back (PresetColourConversion (_("P3"), "p3", dcp::ColourConversion::p3_to_xyz ()));
 269         _presets.push_back (PresetColourConversion (_("Rec. 1886"), "rec1886", dcp::ColourConversion::rec1886_to_xyz ()));
 270         _presets.push_back (PresetColourConversion (_("Rec. 2020"), "rec2020", dcp::ColourConversion::rec2020_to_xyz ()));
 271 }
 272
 273 PresetColourConversion
 274 PresetColourConversion::from_id (string s)
 275 {
 276         BOOST_FOREACH (PresetColourConversion const& i, _presets) {
 277                 if (i.id == s) {
 278                         return i;
 279                 }
 280         }
 281
 282         DCPOMATIC_ASSERT (false);
 283 }