src/lib/colour_conversion.cc

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