src/wx/colour_conversion_editor.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 "wx_util.h"
  22 #include "colour_conversion_editor.h"
  23 #include "lib/colour_conversion.h"
  24 #include <dcp/locale_convert.h>
  25 #include <dcp/gamma_transfer_function.h>
  26 #include <dcp/identity_transfer_function.h>
  27 #include <dcp/s_gamut3_transfer_function.h>
  28 #include <dcp/modified_gamma_transfer_function.h>
  29 #include <wx/spinctrl.h>
  30 #include <wx/gbsizer.h>
  31 #include <iostream>
  32
  33 using std::string;
  34 using std::cout;
  35 using boost::shared_ptr;
  36 using boost::dynamic_pointer_cast;
  37 using boost::bind;
  38 using dcp::locale_convert;
  39
  40 int const ColourConversionEditor::INPUT_GAMMA = 0;
  41 int const ColourConversionEditor::INPUT_GAMMA_LINEARISED = 1;
  42 int const ColourConversionEditor::INPUT_SGAMUT3 = 2;
  43
  44 ColourConversionEditor::ColourConversionEditor (wxWindow* parent, bool yuv)
  45         : wxPanel (parent, wxID_ANY)
  46         , _ignore_chromaticity_changed (false)
  47 {
  48         wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
  49         SetSizer (overall_sizer);
  50
  51         wxGridBagSizer* table = new wxGridBagSizer (DCPOMATIC_SIZER_Y_GAP - 3, DCPOMATIC_SIZER_X_GAP);
  52         overall_sizer->Add (table, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  53
  54         int r = 0;
  55
  56         subhead (table, this, _("Input gamma correction"), r);
  57
  58         add_label_to_sizer (table, this, _("Input transfer function"), true, wxGBPosition (r, 0));
  59         _input = new wxChoice (this, wxID_ANY);
  60         _input->Append (_("Gamma"));
  61         _input->Append (_("Gamma, linearised for small values"));
  62         _input->Append (_("S-Gamut3"));
  63         table->Add (_input, wxGBPosition (r, 1), wxGBSpan (1, 2));
  64         ++r;
  65
  66         add_label_to_sizer (table, this, _("Input gamma"), true, wxGBPosition (r, 0));
  67         _input_gamma = new wxSpinCtrlDouble (this);
  68         table->Add (_input_gamma, wxGBPosition (r, 1));
  69         ++r;
  70
  71         add_label_to_sizer (table, this, _("Input power"), true, wxGBPosition (r, 0));
  72         {
  73                 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
  74                 _input_power = new wxSpinCtrlDouble (this);
  75                 s->Add (_input_power, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
  76                 add_label_to_sizer (s, this, _("threshold"), true);
  77                 _input_threshold = new wxTextCtrl (this, wxID_ANY, wxT (""));
  78                 s->Add (_input_threshold, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
  79                 add_label_to_sizer (s, this, _("A"), true);
  80                 _input_A = new wxTextCtrl (this, wxID_ANY, wxT (""));
  81                 s->Add (_input_A, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
  82                 add_label_to_sizer (s, this, _("B"), true);
  83                 _input_B = new wxTextCtrl (this, wxID_ANY, wxT (""));
  84                 s->Add (_input_B, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
  85                 table->Add (s, wxGBPosition (r, 1), wxGBSpan (1, 3));
  86         }
  87         ++r;
  88
  89         wxClientDC dc (parent);
  90         wxSize size = dc.GetTextExtent (wxT ("-0.12345678901"));
  91         size.SetHeight (-1);
  92
  93         wxTextValidator validator (wxFILTER_INCLUDE_CHAR_LIST);
  94         wxArrayString list;
  95
  96         wxString n (wxT ("0123456789.-"));
  97         for (size_t i = 0; i < n.Length(); ++i) {
  98                 list.Add (n[i]);
  99         }
 100
 101         validator.SetIncludes (list);
 102
 103
 104         /* YUV to RGB conversion */
 105
 106         wxStaticText* yuv_heading = subhead (table, this, _("YUV to RGB conversion"), r);
 107
 108         wxStaticText* yuv_label = add_label_to_sizer (table, this, _("YUV to RGB matrix"), true, wxGBPosition (r, 0));
 109         _yuv_to_rgb = new wxChoice (this, wxID_ANY);
 110         _yuv_to_rgb->Append (_("Rec. 601"));
 111         _yuv_to_rgb->Append (_("Rec. 709"));
 112         table->Add (_yuv_to_rgb, wxGBPosition (r, 1));
 113         ++r;
 114
 115         if (!yuv) {
 116                 yuv_heading->Enable (false);
 117                 yuv_label->Enable (false);
 118                 _yuv_to_rgb->Enable (false);
 119         }
 120
 121         /* RGB to XYZ conversion */
 122
 123         subhead (table, this, _("RGB to XYZ conversion"), r);
 124
 125         add_label_to_sizer (table, this, _("x"), false, wxGBPosition (r, 1));
 126         add_label_to_sizer (table, this, _("y"), false, wxGBPosition (r, 2));
 127         add_label_to_sizer (table, this, _("Matrix"), false, wxGBPosition (r, 3));
 128         ++r;
 129
 130         add_label_to_sizer (table, this, _("Red chromaticity"), true, wxGBPosition (r, 0));
 131         _red_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 132         table->Add (_red_x, wxGBPosition (r, 1));
 133         _red_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 134         table->Add (_red_y, wxGBPosition (r, 2));
 135         ++r;
 136
 137         add_label_to_sizer (table, this, _("Green chromaticity"), true, wxGBPosition (r, 0));
 138         _green_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 139         table->Add (_green_x, wxGBPosition (r, 1));
 140         _green_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 141         table->Add (_green_y, wxGBPosition (r, 2));
 142         ++r;
 143
 144         add_label_to_sizer (table, this, _("Blue chromaticity"), true, wxGBPosition (r, 0));
 145         _blue_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 146         table->Add (_blue_x, wxGBPosition (r, 1));
 147         _blue_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 148         table->Add (_blue_y, wxGBPosition (r, 2));
 149         ++r;
 150
 151         add_label_to_sizer (table, this, _("White point"), true, wxGBPosition (r, 0));
 152         _white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 153         table->Add (_white_x, wxGBPosition (r, 1));
 154         _white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 155         table->Add (_white_y, wxGBPosition (r, 2));
 156         ++r;
 157
 158         size = dc.GetTextExtent (wxT ("0.12345678"));
 159         size.SetHeight (-1);
 160
 161         wxFlexGridSizer* rgb_to_xyz_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
 162         for (int i = 0; i < 3; ++i) {
 163                 for (int j = 0; j < 3; ++j) {
 164                         _rgb_to_xyz[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
 165                         rgb_to_xyz_sizer->Add (_rgb_to_xyz[i][j]);
 166                 }
 167         }
 168         table->Add (rgb_to_xyz_sizer, wxGBPosition (r - 4, 3), wxGBSpan (4, 1));
 169
 170         /* White point adjustment */
 171
 172         size = dc.GetTextExtent (wxT ("-0.12345678901"));
 173         size.SetHeight (-1);
 174
 175         subhead (table, this, _("White point adjustment"), r);
 176
 177         _adjust_white = new wxCheckBox (this, wxID_ANY, _("Adjust white point to"));
 178         table->Add (_adjust_white, wxGBPosition (r, 0));
 179         _adjusted_white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 180         table->Add (_adjusted_white_x, wxGBPosition (r, 1));
 181         _adjusted_white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
 182         table->Add (_adjusted_white_y, wxGBPosition (r, 2));
 183         ++r;
 184
 185         add_label_to_sizer (table, this, wxT (""), false, wxGBPosition (r, 0));
 186         ++r;
 187
 188         size = dc.GetTextExtent (wxT ("0.12345678"));
 189         size.SetHeight (-1);
 190
 191         wxFlexGridSizer* bradford_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
 192         for (int i = 0; i < 3; ++i) {
 193                 for (int j = 0; j < 3; ++j) {
 194                         _bradford[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
 195                         bradford_sizer->Add (_bradford[i][j]);
 196                 }
 197         }
 198         table->Add (bradford_sizer, wxGBPosition (r - 2, 3), wxGBSpan (2, 1));
 199         ++r;
 200
 201         /* Output transfer function */
 202
 203         _output = new wxCheckBox (this, wxID_ANY, _("Inverse 2.6 gamma correction on output"));
 204         table->Add (_output, wxGBPosition (r, 0), wxGBSpan (1, 2));
 205
 206         _input_gamma->SetRange (0.1, 4.0);
 207         _input_gamma->SetDigits (2);
 208         _input_gamma->SetIncrement (0.1);
 209         _input_power->SetRange (0.1, 4.0);
 210         _input_power->SetDigits (6);
 211         _input_power->SetIncrement (0.1);
 212
 213         _input->Bind (wxEVT_CHOICE, bind (&ColourConversionEditor::changed, this));
 214         _input_gamma->Bind (wxEVT_SPINCTRLDOUBLE, bind (&ColourConversionEditor::changed, this, _input_gamma));
 215         _input_power->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::changed, this));
 216         _input_threshold->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::changed, this));
 217         _input_A->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::changed, this));
 218         _input_B->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::changed, this));
 219         _red_x->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 220         _red_y->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 221         _green_x->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 222         _green_y->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 223         _blue_x->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 224         _blue_y->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 225         _white_x->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 226         _white_y->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::chromaticity_changed, this));
 227         _adjust_white->Bind (wxEVT_CHECKBOX, bind (&ColourConversionEditor::adjusted_white_changed, this));
 228         _adjusted_white_x->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::adjusted_white_changed, this));
 229         _adjusted_white_y->Bind (wxEVT_TEXT, bind (&ColourConversionEditor::adjusted_white_changed, this));
 230         _yuv_to_rgb->Bind (wxEVT_CHOICE, bind (&ColourConversionEditor::changed, this));
 231         _output->Bind (wxEVT_CHECKBOX, bind (&ColourConversionEditor::changed, this));
 232 }
 233
 234 wxStaticText *
 235 ColourConversionEditor::subhead (wxGridBagSizer* sizer, wxWindow* parent, wxString text, int& row) const
 236 {
 237         wxStaticText* m = new wxStaticText (parent, wxID_ANY, text);
 238         wxFont font (*wxNORMAL_FONT);
 239         font.SetWeight (wxFONTWEIGHT_BOLD);
 240         m->SetFont (font);
 241         sizer->Add (m, wxGBPosition (row, 0), wxGBSpan (1, 3), wxALIGN_CENTER_VERTICAL | wxTOP, 12);
 242         ++row;
 243         return m;
 244 }
 245
 246 void
 247 ColourConversionEditor::set (ColourConversion conversion)
 248 {
 249         if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ())) {
 250                 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ());
 251                 checked_set (_input, 0);
 252                 set_spin_ctrl (_input_gamma, tf->gamma ());
 253         } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ())) {
 254                 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ());
 255                 checked_set (_input, 1);
 256                 /* Arbitrary default; not used in this case (greyed out) */
 257                 _input_gamma->SetValue (2.2);
 258                 set_spin_ctrl (_input_power, tf->power ());
 259                 set_text_ctrl (_input_threshold, tf->threshold ());
 260                 set_text_ctrl (_input_A, tf->A ());
 261                 set_text_ctrl (_input_B, tf->B ());
 262         } else if (dynamic_pointer_cast<const dcp::SGamut3TransferFunction> (conversion.in ())) {
 263                 checked_set (_input, 2);
 264         }
 265
 266         _yuv_to_rgb->SetSelection (conversion.yuv_to_rgb ());
 267
 268         _ignore_chromaticity_changed = true;
 269
 270         char buffer[256];
 271         snprintf (buffer, sizeof (buffer), "%.6f", conversion.red().x);
 272         _red_x->SetValue (std_to_wx (buffer));
 273         snprintf (buffer, sizeof (buffer), "%.6f", conversion.red().y);
 274         _red_y->SetValue (std_to_wx (buffer));
 275         snprintf (buffer, sizeof (buffer), "%.6f", conversion.green().x);
 276         _green_x->SetValue (std_to_wx (buffer));
 277         snprintf (buffer, sizeof (buffer), "%.6f", conversion.green().y);
 278         _green_y->SetValue (std_to_wx (buffer));
 279         snprintf (buffer, sizeof (buffer), "%.6f", conversion.blue().x);
 280         _blue_x->SetValue (std_to_wx (buffer));
 281         snprintf (buffer, sizeof (buffer), "%.6f", conversion.blue().y);
 282         _blue_y->SetValue (std_to_wx (buffer));
 283         snprintf (buffer, sizeof (buffer), "%.6f", conversion.white().x);
 284         _white_x->SetValue (std_to_wx (buffer));
 285         snprintf (buffer, sizeof (buffer), "%.6f", conversion.white().y);
 286         _white_y->SetValue (std_to_wx (buffer));
 287
 288         _ignore_chromaticity_changed = false;
 289
 290         if (conversion.adjusted_white ()) {
 291                 _adjust_white->SetValue (true);
 292                 snprintf (buffer, sizeof (buffer), "%.6f", conversion.adjusted_white().get().x);
 293                 _adjusted_white_x->SetValue (std_to_wx (buffer));
 294                 snprintf (buffer, sizeof (buffer), "%.6f", conversion.adjusted_white().get().y);
 295                 _adjusted_white_y->SetValue (std_to_wx (buffer));
 296         } else {
 297                 _adjust_white->SetValue (false);
 298         }
 299
 300         _output->SetValue (static_cast<bool> (dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.out ())));
 301
 302         update_rgb_to_xyz ();
 303         update_bradford ();
 304         changed ();
 305 }
 306
 307 ColourConversion
 308 ColourConversionEditor::get () const
 309 {
 310         ColourConversion conversion;
 311
 312         switch (_input->GetSelection ()) {
 313         case INPUT_GAMMA:
 314                 conversion.set_in (
 315                         shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (_input_gamma->GetValue ()))
 316                         );
 317                 break;
 318         case INPUT_GAMMA_LINEARISED:
 319                 /* Linearised gamma */
 320                 conversion.set_in (
 321                         shared_ptr<dcp::ModifiedGammaTransferFunction> (
 322                                 new dcp::ModifiedGammaTransferFunction (
 323                                         _input_power->GetValue (),
 324                                         locale_convert<double> (wx_to_std (_input_threshold->GetValue ())),
 325                                         locale_convert<double> (wx_to_std (_input_A->GetValue ())),
 326                                         locale_convert<double> (wx_to_std (_input_B->GetValue ()))
 327                                         )
 328                                 )
 329                         );
 330                 break;
 331         case INPUT_SGAMUT3:
 332                 /* SGamut3 */
 333                 conversion.set_in (shared_ptr<dcp::SGamut3TransferFunction> (new dcp::SGamut3TransferFunction ()));
 334                 break;
 335         }
 336
 337         conversion.set_yuv_to_rgb (static_cast<dcp::YUVToRGB> (_yuv_to_rgb->GetSelection ()));
 338
 339         conversion.set_red (
 340                 dcp::Chromaticity (locale_convert<double> (wx_to_std (_red_x->GetValue ())), locale_convert<double> (wx_to_std (_red_y->GetValue ())))
 341                 );
 342         conversion.set_green (
 343                 dcp::Chromaticity (locale_convert<double> (wx_to_std (_green_x->GetValue ())), locale_convert<double> (wx_to_std (_green_y->GetValue ())))
 344                 );
 345         conversion.set_blue (
 346                 dcp::Chromaticity (locale_convert<double> (wx_to_std (_blue_x->GetValue ())), locale_convert<double> (wx_to_std (_blue_y->GetValue ())))
 347                 );
 348         conversion.set_white (
 349                 dcp::Chromaticity (locale_convert<double> (wx_to_std (_white_x->GetValue ())), locale_convert<double> (wx_to_std (_white_y->GetValue ())))
 350                 );
 351
 352         if (_adjust_white->GetValue ()) {
 353                 conversion.set_adjusted_white (
 354                         dcp::Chromaticity (
 355                                 locale_convert<double> (wx_to_std (_adjusted_white_x->GetValue ())),
 356                                 locale_convert<double> (wx_to_std (_adjusted_white_y->GetValue ()))
 357                                 )
 358                         );
 359         } else {
 360                 conversion.unset_adjusted_white ();
 361         }
 362
 363         if (_output->GetValue ()) {
 364                 conversion.set_out (shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (2.6)));
 365         } else {
 366                 conversion.set_out (shared_ptr<dcp::IdentityTransferFunction> (new dcp::IdentityTransferFunction ()));
 367         }
 368
 369         return conversion;
 370 }
 371
 372 void
 373 ColourConversionEditor::changed ()
 374 {
 375         int const in = _input->GetSelection();
 376         _input_gamma->Enable (in == INPUT_GAMMA);
 377         _input_power->Enable (in == INPUT_GAMMA_LINEARISED);
 378         _input_threshold->Enable (in == INPUT_GAMMA_LINEARISED);
 379         _input_A->Enable (in == INPUT_GAMMA_LINEARISED);
 380         _input_B->Enable (in == INPUT_GAMMA_LINEARISED);
 381
 382         Changed ();
 383 }
 384
 385 void
 386 ColourConversionEditor::chromaticity_changed ()
 387 {
 388         if (_ignore_chromaticity_changed) {
 389                 return;
 390         }
 391
 392         update_rgb_to_xyz ();
 393         changed ();
 394 }
 395
 396 void
 397 ColourConversionEditor::adjusted_white_changed ()
 398 {
 399         update_bradford ();
 400         changed ();
 401 }
 402
 403 void
 404 ColourConversionEditor::update_bradford ()
 405 {
 406         _adjusted_white_x->Enable (_adjust_white->GetValue ());
 407         _adjusted_white_y->Enable (_adjust_white->GetValue ());
 408
 409         boost::numeric::ublas::matrix<double> m = get().bradford ();
 410         for (int i = 0; i < 3; ++i) {
 411                 for (int j = 0; j < 3; ++j) {
 412                         char buffer[256];
 413                         snprintf (buffer, sizeof (buffer), "%.7f", m (i, j));
 414                         _bradford[i][j]->SetLabel (std_to_wx (buffer));
 415                 }
 416         }
 417 }
 418
 419 void
 420 ColourConversionEditor::update_rgb_to_xyz ()
 421 {
 422         boost::numeric::ublas::matrix<double> m = get().rgb_to_xyz ();
 423         for (int i = 0; i < 3; ++i) {
 424                 for (int j = 0; j < 3; ++j) {
 425                         char buffer[256];
 426                         snprintf (buffer, sizeof (buffer), "%.7f", m (i, j));
 427                         _rgb_to_xyz[i][j]->SetLabel (std_to_wx (buffer));
 428                 }
 429         }
 430 }
 431
 432 void
 433 ColourConversionEditor::changed (wxSpinCtrlDouble* sc)
 434 {
 435         /* On OS X, it seems that in some cases when a wxSpinCtrlDouble loses focus
 436            it emits an erroneous changed signal, which messes things up.
 437            Check for that here.
 438         */
 439         if (fabs (_last_spin_ctrl_value[sc] - sc->GetValue()) < 1e-3) {
 440                 return;
 441         }
 442
 443         Changed ();
 444 }
 445
 446 void
 447 ColourConversionEditor::set_spin_ctrl (wxSpinCtrlDouble* control, double value)
 448 {
 449         _last_spin_ctrl_value[control] = value;
 450         control->SetValue (value);
 451 }
 452
 453 void
 454 ColourConversionEditor::set_text_ctrl (wxTextCtrl* control, double value)
 455 {
 456         char buffer[256];
 457         snprintf (buffer, sizeof (buffer), "%.7f", value);
 458         control->SetValue (std_to_wx (buffer));
 459 }