2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 #include "lib/colour_conversion.h"
21 #include "lib/safe_stringstream.h"
22 #include "lib/raw_convert.h"
24 #include "colour_conversion_editor.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 <boost/lexical_cast.hpp>
34 using boost::shared_ptr;
35 using boost::dynamic_pointer_cast;
36 using boost::lexical_cast;
38 ColourConversionEditor::ColourConversionEditor (wxWindow* parent)
39 : wxPanel (parent, wxID_ANY)
41 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
42 SetSizer (overall_sizer);
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);
49 subhead (table, this, _("Input gamma correction"), r);
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));
55 add_label_to_grid_bag_sizer (table, this, _("Input gamma"), true, wxGBPosition (r, 0));
56 _input_gamma = new wxSpinCtrlDouble (this);
57 table->Add (_input_gamma, wxGBPosition (r, 1));
60 add_label_to_grid_bag_sizer (table, this, _("Input power"), true, wxGBPosition (r, 0));
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));
78 wxClientDC dc (parent);
79 wxSize size = dc.GetTextExtent (wxT ("-0.12345678901"));
82 wxTextValidator validator (wxFILTER_INCLUDE_CHAR_LIST);
85 wxString n (wxT ("0123456789.-"));
86 for (size_t i = 0; i < n.Length(); ++i) {
90 validator.SetIncludes (list);
93 /* YUV to RGB conversion */
95 subhead (table, this, _("YUV to RGB conversion"), r);
97 add_label_to_grid_bag_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));
104 /* RGB to XYZ conversion */
106 subhead (table, this, _("RGB to XYZ conversion"), r);
108 add_label_to_grid_bag_sizer (table, this, _("x"), false, wxGBPosition (r, 1));
109 add_label_to_grid_bag_sizer (table, this, _("y"), false, wxGBPosition (r, 2));
110 add_label_to_grid_bag_sizer (table, this, _("Matrix"), false, wxGBPosition (r, 3));
113 add_label_to_grid_bag_sizer (table, this, _("Red chromaticity"), true, wxGBPosition (r, 0));
114 _red_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
115 table->Add (_red_x, wxGBPosition (r, 1));
116 _red_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
117 table->Add (_red_y, wxGBPosition (r, 2));
120 add_label_to_grid_bag_sizer (table, this, _("Green chromaticity"), true, wxGBPosition (r, 0));
121 _green_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
122 table->Add (_green_x, wxGBPosition (r, 1));
123 _green_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
124 table->Add (_green_y, wxGBPosition (r, 2));
127 add_label_to_grid_bag_sizer (table, this, _("Blue chromaticity"), true, wxGBPosition (r, 0));
128 _blue_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
129 table->Add (_blue_x, wxGBPosition (r, 1));
130 _blue_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
131 table->Add (_blue_y, wxGBPosition (r, 2));
134 add_label_to_grid_bag_sizer (table, this, _("White point"), true, wxGBPosition (r, 0));
135 _white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
136 table->Add (_white_x, wxGBPosition (r, 1));
137 _white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
138 table->Add (_white_y, wxGBPosition (r, 2));
141 size = dc.GetTextExtent (wxT ("0.12345678"));
144 wxFlexGridSizer* rgb_to_xyz_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
145 for (int i = 0; i < 3; ++i) {
146 for (int j = 0; j < 3; ++j) {
147 _rgb_to_xyz[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
148 rgb_to_xyz_sizer->Add (_rgb_to_xyz[i][j]);
151 table->Add (rgb_to_xyz_sizer, wxGBPosition (r - 4, 3), wxGBSpan (4, 1));
153 /* White point adjustment */
155 size = dc.GetTextExtent (wxT ("-0.12345678901"));
158 subhead (table, this, _("White point adjustment"), r);
160 _adjust_white = new wxCheckBox (this, wxID_ANY, _("Adjust white point to"));
161 table->Add (_adjust_white, wxGBPosition (r, 0));
162 _adjusted_white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
163 table->Add (_adjusted_white_x, wxGBPosition (r, 1));
164 _adjusted_white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
165 table->Add (_adjusted_white_y, wxGBPosition (r, 2));
168 add_label_to_grid_bag_sizer (table, this, wxT (""), false, wxGBPosition (r, 0));
171 size = dc.GetTextExtent (wxT ("0.12345678"));
174 wxFlexGridSizer* bradford_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
175 for (int i = 0; i < 3; ++i) {
176 for (int j = 0; j < 3; ++j) {
177 _bradford[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
178 bradford_sizer->Add (_bradford[i][j]);
181 table->Add (bradford_sizer, wxGBPosition (r - 2, 3), wxGBSpan (2, 1));
183 _input_gamma->SetRange (0.1, 4.0);
184 _input_gamma->SetDigits (2);
185 _input_gamma->SetIncrement (0.1);
186 _input_power->SetRange (0.1, 4.0);
187 _input_power->SetDigits (6);
188 _input_power->SetIncrement (0.1);
190 _input_gamma->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ColourConversionEditor::changed, this, _input_gamma));
191 _input_gamma_linearised->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ColourConversionEditor::changed, this));
192 _input_power->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
193 _input_threshold->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
194 _input_A->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
195 _input_B->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
196 _red_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
197 _red_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
198 _green_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
199 _green_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
200 _blue_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
201 _blue_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
202 _white_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
203 _white_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
204 _adjust_white->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
205 _adjusted_white_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
206 _adjusted_white_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
207 _yuv_to_rgb->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&ColourConversionEditor::changed, this));
211 ColourConversionEditor::subhead (wxGridBagSizer* sizer, wxWindow* parent, wxString text, int& row) const
213 wxStaticText* m = new wxStaticText (parent, wxID_ANY, wxT (""));
214 m->SetLabelMarkup ("<b>" + text + "</b>");
215 sizer->Add (m, wxGBPosition (row, 0), wxGBSpan (1, 3), wxALIGN_CENTER_VERTICAL | wxTOP, 12);
220 ColourConversionEditor::set (ColourConversion conversion)
222 if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ())) {
223 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ());
224 _input_gamma_linearised->SetValue (false);
225 set_spin_ctrl (_input_gamma, tf->gamma ());
226 } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ())) {
227 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ());
228 /* Arbitrary default; not used in this case (greyed out) */
229 _input_gamma->SetValue (2.2);
230 _input_gamma_linearised->SetValue (true);
231 set_spin_ctrl (_input_power, tf->power ());
232 set_text_ctrl (_input_threshold, tf->threshold ());
233 set_text_ctrl (_input_A, tf->A ());
234 set_text_ctrl (_input_B, tf->B ());
237 _yuv_to_rgb->SetSelection (conversion.yuv_to_rgb ());
240 s.setf (std::ios::fixed, std::ios::floatfield);
243 s << conversion.red().x;
244 _red_x->SetValue (std_to_wx (s.str ()));
247 s << conversion.red().y;
248 _red_y->SetValue (std_to_wx (s.str ()));
251 s << conversion.green().x;
252 _green_x->SetValue (std_to_wx (s.str ()));
255 s << conversion.green().y;
256 _green_y->SetValue (std_to_wx (s.str ()));
259 s << conversion.blue().x;
260 _blue_x->SetValue (std_to_wx (s.str ()));
263 s << conversion.blue().y;
264 _blue_y->SetValue (std_to_wx (s.str ()));
267 s << conversion.white().x;
268 _white_x->SetValue (std_to_wx (s.str ()));
271 s << conversion.white().y;
272 _white_y->SetValue (std_to_wx (s.str ()));
274 if (conversion.adjusted_white ()) {
275 _adjust_white->SetValue (true);
277 s << conversion.adjusted_white().get().x;
278 _adjusted_white_x->SetValue (std_to_wx (s.str ()));
280 s << conversion.adjusted_white().get().y;
281 _adjusted_white_y->SetValue (std_to_wx (s.str ()));
283 _adjust_white->SetValue (false);
286 update_rgb_to_xyz ();
291 ColourConversionEditor::get () const
293 ColourConversion conversion;
295 if (_input_gamma_linearised->GetValue ()) {
297 shared_ptr<dcp::ModifiedGammaTransferFunction> (
298 new dcp::ModifiedGammaTransferFunction (
299 _input_power->GetValue (),
300 raw_convert<double> (wx_to_std (_input_threshold->GetValue ())),
301 raw_convert<double> (wx_to_std (_input_A->GetValue ())),
302 raw_convert<double> (wx_to_std (_input_B->GetValue ()))
308 shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (_input_gamma->GetValue ()))
312 conversion.set_yuv_to_rgb (static_cast<dcp::YUVToRGB> (_yuv_to_rgb->GetSelection ()));
315 dcp::Chromaticity (raw_convert<double> (wx_to_std (_red_x->GetValue ())), raw_convert<double> (wx_to_std (_red_y->GetValue ())))
317 conversion.set_green (
318 dcp::Chromaticity (raw_convert<double> (wx_to_std (_green_x->GetValue ())), raw_convert<double> (wx_to_std (_green_y->GetValue ())))
320 conversion.set_blue (
321 dcp::Chromaticity (raw_convert<double> (wx_to_std (_blue_x->GetValue ())), raw_convert<double> (wx_to_std (_blue_y->GetValue ())))
323 conversion.set_white (
324 dcp::Chromaticity (raw_convert<double> (wx_to_std (_white_x->GetValue ())), raw_convert<double> (wx_to_std (_white_y->GetValue ())))
327 if (_adjust_white->GetValue ()) {
328 conversion.set_adjusted_white (
330 raw_convert<double> (wx_to_std (_adjusted_white_x->GetValue ())),
331 raw_convert<double> (wx_to_std (_adjusted_white_y->GetValue ()))
335 conversion.unset_adjusted_white ();
338 conversion.set_out (shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (2.6)));
344 ColourConversionEditor::changed ()
346 bool const lin = _input_gamma_linearised->GetValue ();
347 _input_gamma->Enable (!lin);
348 _input_power->Enable (lin);
349 _input_threshold->Enable (lin);
350 _input_A->Enable (lin);
351 _input_B->Enable (lin);
357 ColourConversionEditor::chromaticity_changed ()
359 update_rgb_to_xyz ();
364 ColourConversionEditor::adjusted_white_changed ()
371 ColourConversionEditor::update_bradford ()
373 _adjusted_white_x->Enable (_adjust_white->GetValue ());
374 _adjusted_white_y->Enable (_adjust_white->GetValue ());
376 boost::numeric::ublas::matrix<double> m = get().bradford ();
377 for (int i = 0; i < 3; ++i) {
378 for (int j = 0; j < 3; ++j) {
380 s.setf (std::ios::fixed, std::ios::floatfield);
383 _bradford[i][j]->SetLabel (std_to_wx (s.str ()));
389 ColourConversionEditor::update_rgb_to_xyz ()
391 boost::numeric::ublas::matrix<double> m = get().rgb_to_xyz ();
392 for (int i = 0; i < 3; ++i) {
393 for (int j = 0; j < 3; ++j) {
395 s.setf (std::ios::fixed, std::ios::floatfield);
398 _rgb_to_xyz[i][j]->SetLabel (std_to_wx (s.str ()));
404 ColourConversionEditor::changed (wxSpinCtrlDouble* sc)
406 /* On OS X, it seems that in some cases when a wxSpinCtrlDouble loses focus
407 it emits an erroneous changed signal, which messes things up.
410 if (fabs (_last_spin_ctrl_value[sc] - sc->GetValue()) < 1e-3) {
418 ColourConversionEditor::set_spin_ctrl (wxSpinCtrlDouble* control, double value)
420 _last_spin_ctrl_value[control] = value;
421 control->SetValue (value);
425 ColourConversionEditor::set_text_ctrl (wxTextCtrl* control, double value)
430 control->SetValue (std_to_wx (s.str ()));