2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file src/wx/audio_mapping_view.cc
22 * @brief AudioMappingView class and helpers.
25 #include "lib/audio_mapping.h"
27 #include "lib/raw_convert.h"
28 #include "audio_mapping_view.h"
30 #include "audio_gain_dialog.h"
31 #include <dcp/types.h>
33 #include <wx/renderer.h>
42 using boost::shared_ptr;
44 #define INDICATOR_SIZE 16
53 class NoSelectionStringRenderer : public wxGridCellStringRenderer
56 void Draw (wxGrid& grid, wxGridCellAttr& attr, wxDC& dc, const wxRect& rect, int row, int col, bool)
58 wxGridCellStringRenderer::Draw (grid, attr, dc, rect, row, col, false);
62 /** @class ValueRenderer
63 * @brief wxGridCellRenderer for a gain value.
65 class ValueRenderer : public wxGridCellRenderer
69 void Draw (wxGrid& grid, wxGridCellAttr &, wxDC& dc, const wxRect& rect, int row, int col, bool)
71 dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (255, 255, 255), 1, wxPENSTYLE_SOLID));
72 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
73 dc.DrawRectangle (rect);
75 int const xo = (rect.GetWidth() - INDICATOR_SIZE) / 2;
76 int const yo = (rect.GetHeight() - INDICATOR_SIZE) / 2;
78 dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
79 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
80 dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo, INDICATOR_SIZE, INDICATOR_SIZE));
82 float const value = raw_convert<float> (wx_to_std (grid.GetCellValue (row, col)));
83 float const value_dB = 20 * log10 (value);
86 if (value_dB > -range) {
87 height = INDICATOR_SIZE * (1 + value_dB / range);
90 height = max (0, height);
93 /* Make sure we get a little bit of the marker if there is any gain */
94 height = max (3, height);
97 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (0, 255, 0), wxBRUSHSTYLE_SOLID));
98 dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo + INDICATOR_SIZE - height, INDICATOR_SIZE, height));
101 wxSize GetBestSize (wxGrid &, wxGridCellAttr &, wxDC &, int, int)
103 return wxSize (INDICATOR_SIZE + 4, INDICATOR_SIZE + 4);
106 wxGridCellRenderer* Clone () const
108 return new ValueRenderer;
113 AudioMappingView::AudioMappingView (wxWindow* parent)
114 : wxPanel (parent, wxID_ANY)
117 , _last_tooltip_row (0)
118 , _last_tooltip_column (0)
120 _grid = new wxGrid (this, wxID_ANY);
122 _grid->CreateGrid (0, MAX_DCP_AUDIO_CHANNELS + 1);
123 _grid->HideRowLabels ();
124 _grid->DisableDragRowSize ();
125 _grid->DisableDragColSize ();
126 _grid->EnableEditing (false);
127 _grid->SetCellHighlightPenWidth (0);
128 _grid->SetDefaultRenderer (new NoSelectionStringRenderer);
131 _sizer = new wxBoxSizer (wxVERTICAL);
132 _sizer->Add (_grid, 1, wxEXPAND | wxALL);
133 SetSizerAndFit (_sizer);
135 Bind (wxEVT_GRID_CELL_LEFT_CLICK, boost::bind (&AudioMappingView::left_click, this, _1));
136 Bind (wxEVT_GRID_CELL_RIGHT_CLICK, boost::bind (&AudioMappingView::right_click, this, _1));
137 _grid->GetGridWindow()->Bind (wxEVT_MOTION, boost::bind (&AudioMappingView::mouse_moved, this, _1));
138 Bind (wxEVT_SIZE, boost::bind (&AudioMappingView::sized, this, _1));
141 _menu->Append (ID_off, _("Off"));
142 _menu->Append (ID_full, _("Full"));
143 _menu->Append (ID_minus6dB, _("-6dB"));
144 _menu->Append (ID_edit, _("Edit..."));
146 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::off, this), ID_off);
147 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::full, this), ID_full);
148 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::minus6dB, this), ID_minus6dB);
149 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::edit, this), ID_edit);
152 /** Called when any gain value has changed */
154 AudioMappingView::map_values_changed ()
158 _last_tooltip_column = -1;
162 AudioMappingView::left_click (wxGridEvent& ev)
164 if (ev.GetCol() == 0) {
168 int const d = ev.GetCol() - 1;
170 if (_map.get (ev.GetRow(), d) > 0) {
171 _map.set (ev.GetRow(), d, 0);
173 _map.set (ev.GetRow(), d, 1);
176 map_values_changed ();
180 AudioMappingView::right_click (wxGridEvent& ev)
182 if (ev.GetCol() == 0) {
186 _menu_row = ev.GetRow ();
187 _menu_column = ev.GetCol ();
188 PopupMenu (_menu, ev.GetPosition ());
192 AudioMappingView::off ()
194 _map.set (_menu_row, _menu_column - 1, 0);
195 map_values_changed ();
199 AudioMappingView::full ()
201 _map.set (_menu_row, _menu_column - 1, 1);
202 map_values_changed ();
206 AudioMappingView::minus6dB ()
208 _map.set (_menu_row, _menu_column - 1, pow (10, -6.0 / 20));
209 map_values_changed ();
213 AudioMappingView::edit ()
215 int const d = _menu_column - 1;
217 AudioGainDialog* dialog = new AudioGainDialog (this, _menu_row, _menu_column - 1, _map.get (_menu_row, d));
218 if (dialog->ShowModal () == wxID_OK) {
219 _map.set (_menu_row, d, dialog->value ());
220 map_values_changed ();
227 AudioMappingView::set (AudioMapping map)
234 AudioMappingView::set_input_channels (vector<string> const & names)
236 for (int i = 0; i < _grid->GetNumberRows(); ++i) {
237 _grid->SetCellValue (i, 0, std_to_wx (names[i]));
242 AudioMappingView::set_output_channels (vector<string> const & names)
244 int const o = names.size() + 1;
245 if (o < _grid->GetNumberCols ()) {
246 _grid->DeleteCols (o, _grid->GetNumberCols() - o);
247 } else if (o > _grid->GetNumberCols ()) {
248 _grid->InsertCols (_grid->GetNumberCols(), o - _grid->GetNumberCols());
251 _grid->SetColLabelValue (0, wxT (""));
253 for (size_t i = 0; i < names.size(); ++i) {
254 _grid->SetColLabelValue (i + 1, std_to_wx (names[i]));
261 AudioMappingView::update_cells ()
263 vector<string> row_names;
264 for (int i = 0; i < _grid->GetNumberRows (); ++i) {
265 row_names.push_back (wx_to_std (_grid->GetCellValue (i, 0)));
268 if (_grid->GetNumberRows ()) {
269 _grid->DeleteRows (0, _grid->GetNumberRows ());
272 _grid->InsertRows (0, _map.input_channels ());
274 for (int i = 0; i < _map.input_channels(); ++i) {
275 for (int j = 0; j < _map.output_channels(); ++j) {
276 _grid->SetCellRenderer (i, j + 1, new ValueRenderer);
280 for (int i = 0; i < _map.input_channels(); ++i) {
281 if (i < int (row_names.size ())) {
282 _grid->SetCellValue (i, 0, std_to_wx (row_names[i]));
284 for (int j = 1; j < _grid->GetNumberCols(); ++j) {
285 _grid->SetCellValue (i, j, std_to_wx (raw_convert<string> (_map.get (i, j - 1))));
293 AudioMappingView::mouse_moved (wxMouseEvent& ev)
297 _grid->CalcUnscrolledPosition (ev.GetX(), ev.GetY(), &xx, &yy);
299 int const row = _grid->YToRow (yy);
300 int const column = _grid->XToCol (xx);
302 if (row < 0 || column < 1) {
303 _grid->GetGridWindow()->SetToolTip ("");
304 _last_tooltip_row = row;
305 _last_tooltip_column = column;
308 if (row != _last_tooltip_row || column != _last_tooltip_column) {
311 float const gain = _map.get (row, column - 1);
313 s = wxString::Format (_("No audio will be passed from content channel %d to DCP channel %d."), row + 1, column);
314 } else if (gain == 1) {
315 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d unaltered."), row + 1, column);
317 float const dB = 20 * log10 (gain);
318 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d with gain %.1fdB."), row + 1, column, dB);
321 _grid->GetGridWindow()->SetToolTip (s + " " + _("Right click to change gain."));
322 _last_tooltip_row = row;
323 _last_tooltip_column = column;
330 AudioMappingView::sized (wxSizeEvent& ev)