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>
33 using boost::shared_ptr;
34 using boost::dynamic_pointer_cast;
35 using boost::lexical_cast;
37 ColourConversionEditor::ColourConversionEditor (wxWindow* parent)
38 : wxPanel (parent, wxID_ANY)
40 wxBoxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
41 SetSizer (overall_sizer);
43 wxGridBagSizer* table = new wxGridBagSizer (DCPOMATIC_SIZER_Y_GAP - 3, DCPOMATIC_SIZER_X_GAP);
44 overall_sizer->Add (table, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
48 subhead (table, this, _("Input gamma correction"), r);
50 _input_gamma_linearised = new wxCheckBox (this, wxID_ANY, _("Linearise input gamma curve for small values"));
51 table->Add (_input_gamma_linearised, wxGBPosition (r, 0), wxGBSpan (1, 2));
54 add_label_to_grid_bag_sizer (table, this, _("Input gamma"), true, wxGBPosition (r, 0));
55 _input_gamma = new wxSpinCtrlDouble (this);
56 table->Add (_input_gamma, wxGBPosition (r, 1));
59 add_label_to_grid_bag_sizer (table, this, _("Input power"), true, wxGBPosition (r, 0));
61 wxBoxSizer* s = new wxBoxSizer (wxHORIZONTAL);
62 _input_power = new wxSpinCtrlDouble (this);
63 s->Add (_input_power, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
64 add_label_to_sizer (s, this, _("threshold"), true);
65 _input_threshold = new wxTextCtrl (this, wxID_ANY, wxT (""));
66 s->Add (_input_threshold, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
67 add_label_to_sizer (s, this, _("A"), true);
68 _input_A = new wxTextCtrl (this, wxID_ANY, wxT (""));
69 s->Add (_input_A, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
70 add_label_to_sizer (s, this, _("B"), true);
71 _input_B = new wxTextCtrl (this, wxID_ANY, wxT (""));
72 s->Add (_input_B, 1, wxEXPAND | wxRIGHT, DCPOMATIC_SIZER_GAP);
73 table->Add (s, wxGBPosition (r, 1), wxGBSpan (1, 3));
77 wxClientDC dc (parent);
78 wxSize size = dc.GetTextExtent (wxT ("-0.12345678901"));
81 wxTextValidator validator (wxFILTER_INCLUDE_CHAR_LIST);
84 wxString n (wxT ("0123456789.-"));
85 for (size_t i = 0; i < n.Length(); ++i) {
89 validator.SetIncludes (list);
92 /* YUV to RGB conversion */
94 subhead (table, this, _("YUV to RGB conversion"), r);
96 add_label_to_grid_bag_sizer (table, this, _("YUV to RGB matrix"), true, wxGBPosition (r, 0));
97 _yuv_to_rgb = new wxChoice (this, wxID_ANY);
98 _yuv_to_rgb->Append (_("Rec. 601"));
99 _yuv_to_rgb->Append (_("Rec. 709"));
100 table->Add (_yuv_to_rgb, wxGBPosition (r, 1));
103 /* RGB to XYZ conversion */
105 subhead (table, this, _("RGB to XYZ conversion"), r);
107 add_label_to_grid_bag_sizer (table, this, _("x"), false, wxGBPosition (r, 1));
108 add_label_to_grid_bag_sizer (table, this, _("y"), false, wxGBPosition (r, 2));
109 add_label_to_grid_bag_sizer (table, this, _("Matrix"), false, wxGBPosition (r, 3));
112 add_label_to_grid_bag_sizer (table, this, _("Red chromaticity"), true, wxGBPosition (r, 0));
113 _red_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
114 table->Add (_red_x, wxGBPosition (r, 1));
115 _red_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
116 table->Add (_red_y, wxGBPosition (r, 2));
119 add_label_to_grid_bag_sizer (table, this, _("Green chromaticity"), true, wxGBPosition (r, 0));
120 _green_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
121 table->Add (_green_x, wxGBPosition (r, 1));
122 _green_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
123 table->Add (_green_y, wxGBPosition (r, 2));
126 add_label_to_grid_bag_sizer (table, this, _("Blue chromaticity"), true, wxGBPosition (r, 0));
127 _blue_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
128 table->Add (_blue_x, wxGBPosition (r, 1));
129 _blue_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
130 table->Add (_blue_y, wxGBPosition (r, 2));
133 add_label_to_grid_bag_sizer (table, this, _("White point"), true, wxGBPosition (r, 0));
134 _white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
135 table->Add (_white_x, wxGBPosition (r, 1));
136 _white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
137 table->Add (_white_y, wxGBPosition (r, 2));
140 size = dc.GetTextExtent (wxT ("0.12345678"));
143 wxFlexGridSizer* rgb_to_xyz_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
144 for (int i = 0; i < 3; ++i) {
145 for (int j = 0; j < 3; ++j) {
146 _rgb_to_xyz[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
147 rgb_to_xyz_sizer->Add (_rgb_to_xyz[i][j]);
150 table->Add (rgb_to_xyz_sizer, wxGBPosition (r - 4, 3), wxGBSpan (4, 1));
152 /* White point adjustment */
154 size = dc.GetTextExtent (wxT ("-0.12345678901"));
157 subhead (table, this, _("White point adjustment"), r);
159 _adjust_white = new wxCheckBox (this, wxID_ANY, _("Adjust white point to"));
160 table->Add (_adjust_white, wxGBPosition (r, 0));
161 _adjusted_white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
162 table->Add (_adjusted_white_x, wxGBPosition (r, 1));
163 _adjusted_white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
164 table->Add (_adjusted_white_y, wxGBPosition (r, 2));
167 add_label_to_grid_bag_sizer (table, this, wxT (""), false, wxGBPosition (r, 0));
170 size = dc.GetTextExtent (wxT ("0.12345678"));
173 wxFlexGridSizer* bradford_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
174 for (int i = 0; i < 3; ++i) {
175 for (int j = 0; j < 3; ++j) {
176 _bradford[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
177 bradford_sizer->Add (_bradford[i][j]);
180 table->Add (bradford_sizer, wxGBPosition (r - 2, 3), wxGBSpan (2, 1));
182 subhead (table, this, _("Output gamma correction"), r);
184 add_label_to_grid_bag_sizer (table, this, _("Output gamma"), true, wxGBPosition (r, 0));
185 wxBoxSizer* output_sizer = new wxBoxSizer (wxHORIZONTAL);
186 /// TRANSLATORS: this means the mathematical reciprocal operation, i.e. we are dividing 1 by the control that
188 add_label_to_sizer (output_sizer, this, _("1 / "), false);
189 _output_gamma = new wxSpinCtrlDouble (this);
190 output_sizer->Add (_output_gamma);
191 table->Add (output_sizer, wxGBPosition (r, 1), wxGBSpan (1, 2));
194 _input_gamma->SetRange (0.1, 4.0);
195 _input_gamma->SetDigits (2);
196 _input_gamma->SetIncrement (0.1);
197 _input_power->SetRange (0.1, 4.0);
198 _input_power->SetDigits (6);
199 _input_power->SetIncrement (0.1);
200 _output_gamma->SetRange (0.1, 4.0);
201 _output_gamma->SetDigits (2);
202 _output_gamma->SetIncrement (0.1);
204 _input_gamma->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ColourConversionEditor::changed, this, _input_gamma));
205 _input_gamma_linearised->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ColourConversionEditor::changed, this));
206 _input_power->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
207 _input_threshold->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
208 _input_A->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
209 _input_B->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
210 _red_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
211 _red_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
212 _green_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
213 _green_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
214 _blue_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
215 _blue_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
216 _white_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
217 _white_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
218 _adjust_white->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
219 _adjusted_white_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
220 _adjusted_white_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
221 _yuv_to_rgb->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&ColourConversionEditor::changed, this));
222 _output_gamma->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ColourConversionEditor::changed, this, _output_gamma));
226 ColourConversionEditor::subhead (wxGridBagSizer* sizer, wxWindow* parent, wxString text, int& row) const
228 wxStaticText* m = new wxStaticText (parent, wxID_ANY, wxT (""));
229 m->SetLabelMarkup ("<b>" + text + "</b>");
230 sizer->Add (m, wxGBPosition (row, 0), wxGBSpan (1, 3), wxALIGN_CENTER_VERTICAL | wxTOP, 12);
235 ColourConversionEditor::set (ColourConversion conversion)
237 if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ())) {
238 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ());
239 _input_gamma_linearised->SetValue (false);
240 set_spin_ctrl (_input_gamma, tf->gamma ());
241 } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ())) {
242 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ());
243 /* Arbitrary default; not used in this case (greyed out) */
244 _input_gamma->SetValue (2.2);
245 _input_gamma_linearised->SetValue (true);
246 set_spin_ctrl (_input_power, tf->power ());
247 set_text_ctrl (_input_threshold, tf->threshold ());
248 set_text_ctrl (_input_A, tf->A ());
249 set_text_ctrl (_input_B, tf->B ());
252 _yuv_to_rgb->SetSelection (conversion.yuv_to_rgb ());
255 s.setf (std::ios::fixed, std::ios::floatfield);
258 s << conversion.red().x;
259 _red_x->SetValue (std_to_wx (s.str ()));
262 s << conversion.red().y;
263 _red_y->SetValue (std_to_wx (s.str ()));
266 s << conversion.green().x;
267 _green_x->SetValue (std_to_wx (s.str ()));
270 s << conversion.green().y;
271 _green_y->SetValue (std_to_wx (s.str ()));
274 s << conversion.blue().x;
275 _blue_x->SetValue (std_to_wx (s.str ()));
278 s << conversion.blue().y;
279 _blue_y->SetValue (std_to_wx (s.str ()));
282 s << conversion.white().x;
283 _white_x->SetValue (std_to_wx (s.str ()));
286 s << conversion.white().y;
287 _white_y->SetValue (std_to_wx (s.str ()));
289 if (conversion.adjusted_white ()) {
290 _adjust_white->SetValue (true);
292 s << conversion.adjusted_white().get().x;
293 _adjusted_white_x->SetValue (std_to_wx (s.str ()));
295 s << conversion.adjusted_white().get().y;
296 _adjusted_white_y->SetValue (std_to_wx (s.str ()));
298 _adjust_white->SetValue (false);
301 update_rgb_to_xyz ();
304 set_spin_ctrl (_output_gamma, dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.out ())->gamma ());
308 ColourConversionEditor::get () const
310 ColourConversion conversion;
312 if (_input_gamma_linearised->GetValue ()) {
314 shared_ptr<dcp::ModifiedGammaTransferFunction> (
315 new dcp::ModifiedGammaTransferFunction (
316 _input_power->GetValue (),
317 raw_convert<double> (wx_to_std (_input_threshold->GetValue ())),
318 raw_convert<double> (wx_to_std (_input_A->GetValue ())),
319 raw_convert<double> (wx_to_std (_input_B->GetValue ()))
325 shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (_input_gamma->GetValue ()))
329 conversion.set_yuv_to_rgb (static_cast<dcp::YUVToRGB> (_yuv_to_rgb->GetSelection ()));
332 dcp::Chromaticity (raw_convert<double> (wx_to_std (_red_x->GetValue ())), raw_convert<double> (wx_to_std (_red_y->GetValue ())))
334 conversion.set_green (
335 dcp::Chromaticity (raw_convert<double> (wx_to_std (_green_x->GetValue ())), raw_convert<double> (wx_to_std (_green_y->GetValue ())))
337 conversion.set_blue (
338 dcp::Chromaticity (raw_convert<double> (wx_to_std (_blue_x->GetValue ())), raw_convert<double> (wx_to_std (_blue_y->GetValue ())))
340 conversion.set_white (
341 dcp::Chromaticity (raw_convert<double> (wx_to_std (_white_x->GetValue ())), raw_convert<double> (wx_to_std (_white_y->GetValue ())))
344 if (_adjust_white->GetValue ()) {
345 conversion.set_adjusted_white (
347 raw_convert<double> (wx_to_std (_adjusted_white_x->GetValue ())),
348 raw_convert<double> (wx_to_std (_adjusted_white_y->GetValue ()))
352 conversion.unset_adjusted_white ();
355 conversion.set_out (shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (_output_gamma->GetValue ())));
361 ColourConversionEditor::changed ()
363 bool const lin = _input_gamma_linearised->GetValue ();
364 _input_gamma->Enable (!lin);
365 _input_power->Enable (lin);
366 _input_threshold->Enable (lin);
367 _input_A->Enable (lin);
368 _input_B->Enable (lin);
374 ColourConversionEditor::chromaticity_changed ()
376 update_rgb_to_xyz ();
381 ColourConversionEditor::adjusted_white_changed ()
388 ColourConversionEditor::update_bradford ()
390 _adjusted_white_x->Enable (_adjust_white->GetValue ());
391 _adjusted_white_y->Enable (_adjust_white->GetValue ());
393 boost::numeric::ublas::matrix<double> m = get().bradford ();
394 for (int i = 0; i < 3; ++i) {
395 for (int j = 0; j < 3; ++j) {
397 s.setf (std::ios::fixed, std::ios::floatfield);
400 _bradford[i][j]->SetLabel (std_to_wx (s.str ()));
406 ColourConversionEditor::update_rgb_to_xyz ()
408 boost::numeric::ublas::matrix<double> m = get().rgb_to_xyz ();
409 for (int i = 0; i < 3; ++i) {
410 for (int j = 0; j < 3; ++j) {
412 s.setf (std::ios::fixed, std::ios::floatfield);
415 _rgb_to_xyz[i][j]->SetLabel (std_to_wx (s.str ()));
421 ColourConversionEditor::changed (wxSpinCtrlDouble* sc)
423 /* On OS X, it seems that in some cases when a wxSpinCtrlDouble loses focus
424 it emits an erroneous changed signal, which messes things up.
427 if (fabs (_last_spin_ctrl_value[sc] - sc->GetValue()) < 1e-3) {
435 ColourConversionEditor::set_spin_ctrl (wxSpinCtrlDouble* control, double value)
437 _last_spin_ctrl_value[control] = value;
438 control->SetValue (value);
442 ColourConversionEditor::set_text_ctrl (wxTextCtrl* control, double value)
447 control->SetValue (std_to_wx (s.str ()));