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