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>
33 using boost::shared_ptr;
34 using boost::dynamic_pointer_cast;
36 ColourConversionEditor::ColourConversionEditor (wxWindow* parent, bool yuv)
37 : wxPanel (parent, wxID_ANY)
38 , _ignore_chromaticity_changed (false)
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_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_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 wxStaticText* yuv_heading = subhead (table, this, _("YUV to RGB conversion"), r);
96 wxStaticText* yuv_label = add_label_to_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));
104 yuv_heading->Enable (false);
105 yuv_label->Enable (false);
106 _yuv_to_rgb->Enable (false);
109 /* RGB to XYZ conversion */
111 subhead (table, this, _("RGB to XYZ conversion"), r);
113 add_label_to_sizer (table, this, _("x"), false, wxGBPosition (r, 1));
114 add_label_to_sizer (table, this, _("y"), false, wxGBPosition (r, 2));
115 add_label_to_sizer (table, this, _("Matrix"), false, wxGBPosition (r, 3));
118 add_label_to_sizer (table, this, _("Red chromaticity"), true, wxGBPosition (r, 0));
119 _red_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
120 table->Add (_red_x, wxGBPosition (r, 1));
121 _red_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
122 table->Add (_red_y, wxGBPosition (r, 2));
125 add_label_to_sizer (table, this, _("Green chromaticity"), true, wxGBPosition (r, 0));
126 _green_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
127 table->Add (_green_x, wxGBPosition (r, 1));
128 _green_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
129 table->Add (_green_y, wxGBPosition (r, 2));
132 add_label_to_sizer (table, this, _("Blue chromaticity"), true, wxGBPosition (r, 0));
133 _blue_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
134 table->Add (_blue_x, wxGBPosition (r, 1));
135 _blue_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
136 table->Add (_blue_y, wxGBPosition (r, 2));
139 add_label_to_sizer (table, this, _("White point"), true, wxGBPosition (r, 0));
140 _white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
141 table->Add (_white_x, wxGBPosition (r, 1));
142 _white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
143 table->Add (_white_y, wxGBPosition (r, 2));
146 size = dc.GetTextExtent (wxT ("0.12345678"));
149 wxFlexGridSizer* rgb_to_xyz_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
150 for (int i = 0; i < 3; ++i) {
151 for (int j = 0; j < 3; ++j) {
152 _rgb_to_xyz[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
153 rgb_to_xyz_sizer->Add (_rgb_to_xyz[i][j]);
156 table->Add (rgb_to_xyz_sizer, wxGBPosition (r - 4, 3), wxGBSpan (4, 1));
158 /* White point adjustment */
160 size = dc.GetTextExtent (wxT ("-0.12345678901"));
163 subhead (table, this, _("White point adjustment"), r);
165 _adjust_white = new wxCheckBox (this, wxID_ANY, _("Adjust white point to"));
166 table->Add (_adjust_white, wxGBPosition (r, 0));
167 _adjusted_white_x = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
168 table->Add (_adjusted_white_x, wxGBPosition (r, 1));
169 _adjusted_white_y = new wxTextCtrl (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0, validator);
170 table->Add (_adjusted_white_y, wxGBPosition (r, 2));
173 add_label_to_sizer (table, this, wxT (""), false, wxGBPosition (r, 0));
176 size = dc.GetTextExtent (wxT ("0.12345678"));
179 wxFlexGridSizer* bradford_sizer = new wxFlexGridSizer (3, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
180 for (int i = 0; i < 3; ++i) {
181 for (int j = 0; j < 3; ++j) {
182 _bradford[i][j] = new wxStaticText (this, wxID_ANY, wxT (""), wxDefaultPosition, size, 0);
183 bradford_sizer->Add (_bradford[i][j]);
186 table->Add (bradford_sizer, wxGBPosition (r - 2, 3), wxGBSpan (2, 1));
188 _input_gamma->SetRange (0.1, 4.0);
189 _input_gamma->SetDigits (2);
190 _input_gamma->SetIncrement (0.1);
191 _input_power->SetRange (0.1, 4.0);
192 _input_power->SetDigits (6);
193 _input_power->SetIncrement (0.1);
195 _input_gamma->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ColourConversionEditor::changed, this, _input_gamma));
196 _input_gamma_linearised->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ColourConversionEditor::changed, this));
197 _input_power->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
198 _input_threshold->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
199 _input_A->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
200 _input_B->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::changed, this));
201 _red_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
202 _red_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
203 _green_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
204 _green_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
205 _blue_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
206 _blue_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
207 _white_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
208 _white_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::chromaticity_changed, this));
209 _adjust_white->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
210 _adjusted_white_x->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
211 _adjusted_white_y->Bind (wxEVT_COMMAND_TEXT_UPDATED, boost::bind (&ColourConversionEditor::adjusted_white_changed, this));
212 _yuv_to_rgb->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&ColourConversionEditor::changed, this));
216 ColourConversionEditor::subhead (wxGridBagSizer* sizer, wxWindow* parent, wxString text, int& row) const
218 wxStaticText* m = new wxStaticText (parent, wxID_ANY, text);
219 wxFont font (*wxNORMAL_FONT);
220 font.SetWeight (wxFONTWEIGHT_BOLD);
222 sizer->Add (m, wxGBPosition (row, 0), wxGBSpan (1, 3), wxALIGN_CENTER_VERTICAL | wxTOP, 12);
228 ColourConversionEditor::set (ColourConversion conversion)
230 if (dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ())) {
231 shared_ptr<const dcp::GammaTransferFunction> tf = dynamic_pointer_cast<const dcp::GammaTransferFunction> (conversion.in ());
232 _input_gamma_linearised->SetValue (false);
233 set_spin_ctrl (_input_gamma, tf->gamma ());
234 } else if (dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ())) {
235 shared_ptr<const dcp::ModifiedGammaTransferFunction> tf = dynamic_pointer_cast<const dcp::ModifiedGammaTransferFunction> (conversion.in ());
236 /* Arbitrary default; not used in this case (greyed out) */
237 _input_gamma->SetValue (2.2);
238 _input_gamma_linearised->SetValue (true);
239 set_spin_ctrl (_input_power, tf->power ());
240 set_text_ctrl (_input_threshold, tf->threshold ());
241 set_text_ctrl (_input_A, tf->A ());
242 set_text_ctrl (_input_B, tf->B ());
245 _yuv_to_rgb->SetSelection (conversion.yuv_to_rgb ());
247 _ignore_chromaticity_changed = true;
250 s.setf (std::ios::fixed, std::ios::floatfield);
253 s << conversion.red().x;
254 _red_x->SetValue (std_to_wx (s.str ()));
257 s << conversion.red().y;
258 _red_y->SetValue (std_to_wx (s.str ()));
261 s << conversion.green().x;
262 _green_x->SetValue (std_to_wx (s.str ()));
265 s << conversion.green().y;
266 _green_y->SetValue (std_to_wx (s.str ()));
269 s << conversion.blue().x;
270 _blue_x->SetValue (std_to_wx (s.str ()));
273 s << conversion.blue().y;
274 _blue_y->SetValue (std_to_wx (s.str ()));
277 s << conversion.white().x;
278 _white_x->SetValue (std_to_wx (s.str ()));
281 s << conversion.white().y;
282 _white_y->SetValue (std_to_wx (s.str ()));
284 _ignore_chromaticity_changed = false;
286 if (conversion.adjusted_white ()) {
287 _adjust_white->SetValue (true);
289 s << conversion.adjusted_white().get().x;
290 _adjusted_white_x->SetValue (std_to_wx (s.str ()));
292 s << conversion.adjusted_white().get().y;
293 _adjusted_white_y->SetValue (std_to_wx (s.str ()));
295 _adjust_white->SetValue (false);
298 update_rgb_to_xyz ();
304 ColourConversionEditor::get () const
306 ColourConversion conversion;
308 if (_input_gamma_linearised->GetValue ()) {
310 shared_ptr<dcp::ModifiedGammaTransferFunction> (
311 new dcp::ModifiedGammaTransferFunction (
312 _input_power->GetValue (),
313 raw_convert<double> (wx_to_std (_input_threshold->GetValue ())),
314 raw_convert<double> (wx_to_std (_input_A->GetValue ())),
315 raw_convert<double> (wx_to_std (_input_B->GetValue ()))
321 shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (_input_gamma->GetValue ()))
325 conversion.set_yuv_to_rgb (static_cast<dcp::YUVToRGB> (_yuv_to_rgb->GetSelection ()));
328 dcp::Chromaticity (raw_convert<double> (wx_to_std (_red_x->GetValue ())), raw_convert<double> (wx_to_std (_red_y->GetValue ())))
330 conversion.set_green (
331 dcp::Chromaticity (raw_convert<double> (wx_to_std (_green_x->GetValue ())), raw_convert<double> (wx_to_std (_green_y->GetValue ())))
333 conversion.set_blue (
334 dcp::Chromaticity (raw_convert<double> (wx_to_std (_blue_x->GetValue ())), raw_convert<double> (wx_to_std (_blue_y->GetValue ())))
336 conversion.set_white (
337 dcp::Chromaticity (raw_convert<double> (wx_to_std (_white_x->GetValue ())), raw_convert<double> (wx_to_std (_white_y->GetValue ())))
340 if (_adjust_white->GetValue ()) {
341 conversion.set_adjusted_white (
343 raw_convert<double> (wx_to_std (_adjusted_white_x->GetValue ())),
344 raw_convert<double> (wx_to_std (_adjusted_white_y->GetValue ()))
348 conversion.unset_adjusted_white ();
351 conversion.set_out (shared_ptr<dcp::GammaTransferFunction> (new dcp::GammaTransferFunction (2.6)));
357 ColourConversionEditor::changed ()
359 bool const lin = _input_gamma_linearised->GetValue ();
360 _input_gamma->Enable (!lin);
361 _input_power->Enable (lin);
362 _input_threshold->Enable (lin);
363 _input_A->Enable (lin);
364 _input_B->Enable (lin);
370 ColourConversionEditor::chromaticity_changed ()
372 if (_ignore_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 ()));