src/wx/colour_conversion_editor.cc

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