2 Copyright (C) 2013-2016 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 "audio_mapping_view.h"
27 #include "audio_gain_dialog.h"
28 #include "lib/audio_mapping.h"
30 #include <dcp/locale_convert.h>
31 #include <dcp/types.h>
33 #include <wx/renderer.h>
35 #include <wx/graphics.h>
36 #include <boost/foreach.hpp>
47 using boost::shared_ptr;
48 using dcp::locale_convert;
50 #define INDICATOR_SIZE 16
60 class NoSelectionStringRenderer : public wxGridCellStringRenderer
63 void Draw (wxGrid& grid, wxGridCellAttr& attr, wxDC& dc, const wxRect& rect, int row, int col, bool)
65 wxGridCellStringRenderer::Draw (grid, attr, dc, rect, row, col, false);
69 /** @class ValueRenderer
70 * @brief wxGridCellRenderer for a gain value.
72 class ValueRenderer : public wxGridCellRenderer
76 void Draw (wxGrid& grid, wxGridCellAttr &, wxDC& dc, const wxRect& rect, int row, int col, bool)
78 dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (255, 255, 255), 1, wxPENSTYLE_SOLID));
79 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
80 dc.DrawRectangle (rect);
82 int const xo = (rect.GetWidth() - INDICATOR_SIZE) / 2;
83 int const yo = (rect.GetHeight() - INDICATOR_SIZE) / 2;
85 dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
86 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
87 dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo, INDICATOR_SIZE, INDICATOR_SIZE));
89 float const value = locale_convert<float> (wx_to_std (grid.GetCellValue (row, col)));
90 float const value_dB = 20 * log10 (value);
93 if (value_dB > -range) {
94 height = INDICATOR_SIZE * (1 + value_dB / range);
97 height = max (0, height);
100 /* Make sure we get a little bit of the marker if there is any gain */
101 height = max (3, height);
104 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (0, 255, 0), wxBRUSHSTYLE_SOLID));
105 dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo + INDICATOR_SIZE - height, INDICATOR_SIZE, height));
108 wxSize GetBestSize (wxGrid &, wxGridCellAttr &, wxDC &, int, int)
110 return wxSize (INDICATOR_SIZE + 4, INDICATOR_SIZE + 4);
113 wxGridCellRenderer* Clone () const
115 return new ValueRenderer;
120 AudioMappingView::AudioMappingView (wxWindow* parent)
121 : wxPanel (parent, wxID_ANY)
124 , _last_tooltip_row (0)
125 , _last_tooltip_column (0)
127 _left_labels = new wxPanel (this, wxID_ANY);
128 _left_labels->Bind (wxEVT_PAINT, boost::bind (&AudioMappingView::paint_left_labels, this));
129 _top_labels = new wxPanel (this, wxID_ANY);
130 _top_labels->Bind (wxEVT_PAINT, boost::bind (&AudioMappingView::paint_top_labels, this));
132 _grid = new wxGrid (this, wxID_ANY);
134 _grid->CreateGrid (0, MAX_DCP_AUDIO_CHANNELS + 1);
135 _grid->HideRowLabels ();
136 _grid->DisableDragRowSize ();
137 _grid->DisableDragColSize ();
138 _grid->EnableEditing (false);
139 _grid->SetCellHighlightPenWidth (0);
140 _grid->SetDefaultRenderer (new NoSelectionStringRenderer);
141 _grid->EnableScrolling (true, true);
144 wxSizer* vertical_sizer = new wxBoxSizer (wxVERTICAL);
145 vertical_sizer->Add (_top_labels);
146 wxSizer* horizontal_sizer = new wxBoxSizer (wxHORIZONTAL);
147 horizontal_sizer->Add (_left_labels);
148 horizontal_sizer->Add (_grid, 1, wxEXPAND | wxALL);
149 vertical_sizer->Add (horizontal_sizer);
150 SetSizerAndFit (vertical_sizer);
152 Bind (wxEVT_GRID_CELL_LEFT_CLICK, boost::bind (&AudioMappingView::left_click, this, _1));
153 Bind (wxEVT_GRID_CELL_RIGHT_CLICK, boost::bind (&AudioMappingView::right_click, this, _1));
154 _grid->GetGridWindow()->Bind (wxEVT_MOTION, boost::bind (&AudioMappingView::mouse_moved_grid, this, _1));
155 _grid->Bind (wxEVT_SCROLLWIN_TOP, boost::bind (&AudioMappingView::grid_scrolled, this));
156 _grid->Bind (wxEVT_SCROLLWIN_BOTTOM, boost::bind (&AudioMappingView::grid_scrolled, this));
157 _grid->Bind (wxEVT_SCROLLWIN_LINEUP, boost::bind (&AudioMappingView::grid_scrolled, this));
158 _grid->Bind (wxEVT_SCROLLWIN_LINEDOWN, boost::bind (&AudioMappingView::grid_scrolled, this));
159 _grid->Bind (wxEVT_SCROLLWIN_PAGEUP, boost::bind (&AudioMappingView::grid_scrolled, this));
160 _grid->Bind (wxEVT_SCROLLWIN_PAGEDOWN, boost::bind (&AudioMappingView::grid_scrolled, this));
161 _grid->Bind (wxEVT_SCROLLWIN_THUMBTRACK, boost::bind (&AudioMappingView::grid_scrolled, this));
162 _grid->Bind (wxEVT_SCROLLWIN_THUMBRELEASE, boost::bind (&AudioMappingView::grid_scrolled, this));
163 Bind (wxEVT_SIZE, boost::bind (&AudioMappingView::sized, this, _1));
166 _menu->Append (ID_off, _("Off"));
167 _menu->Append (ID_full, _("Full"));
168 _menu->Append (ID_minus6dB, _("-6dB"));
169 _menu->Append (ID_edit, _("Edit..."));
171 Bind (wxEVT_MENU, boost::bind (&AudioMappingView::off, this), ID_off);
172 Bind (wxEVT_MENU, boost::bind (&AudioMappingView::full, this), ID_full);
173 Bind (wxEVT_MENU, boost::bind (&AudioMappingView::minus6dB, this), ID_minus6dB);
174 Bind (wxEVT_MENU, boost::bind (&AudioMappingView::edit, this), ID_edit);
176 _left_labels->Bind (wxEVT_MOTION, bind (&AudioMappingView::mouse_moved_left_labels, this, _1));
179 /** Called when any gain value has changed */
181 AudioMappingView::map_values_changed ()
185 _last_tooltip_column = -1;
189 AudioMappingView::left_click (wxGridEvent& ev)
191 if (ev.GetCol() == 0) {
195 int const d = ev.GetCol() - 1;
197 if (_map.get (ev.GetRow(), d) > 0) {
198 _map.set (ev.GetRow(), d, 0);
200 _map.set (ev.GetRow(), d, 1);
203 map_values_changed ();
207 AudioMappingView::right_click (wxGridEvent& ev)
209 if (ev.GetCol() == 0) {
213 _menu_row = ev.GetRow ();
214 _menu_column = ev.GetCol ();
215 PopupMenu (_menu, ev.GetPosition ());
219 AudioMappingView::off ()
221 _map.set (_menu_row, _menu_column - 1, 0);
222 map_values_changed ();
226 AudioMappingView::full ()
228 _map.set (_menu_row, _menu_column - 1, 1);
229 map_values_changed ();
233 AudioMappingView::minus6dB ()
235 _map.set (_menu_row, _menu_column - 1, pow (10, -6.0 / 20));
236 map_values_changed ();
240 AudioMappingView::edit ()
242 int const d = _menu_column - 1;
244 AudioGainDialog* dialog = new AudioGainDialog (this, _menu_row, _menu_column - 1, _map.get (_menu_row, d));
245 if (dialog->ShowModal () == wxID_OK) {
246 _map.set (_menu_row, d, dialog->value ());
247 map_values_changed ();
254 AudioMappingView::set (AudioMapping map)
261 AudioMappingView::set_input_channels (vector<string> const & names)
263 for (int i = 0; i < _grid->GetNumberRows(); ++i) {
264 _grid->SetCellValue (i, 0, std_to_wx (names[i]));
269 AudioMappingView::set_output_channels (vector<string> const & names)
271 int const o = names.size() + 1;
272 if (o < _grid->GetNumberCols ()) {
273 _grid->DeleteCols (o, _grid->GetNumberCols() - o);
274 } else if (o > _grid->GetNumberCols ()) {
275 _grid->AppendCols (o - _grid->GetNumberCols());
278 _grid->SetColLabelValue (0, wxT (""));
280 for (size_t i = 0; i < names.size(); ++i) {
281 _grid->SetColLabelValue (i + 1, std_to_wx (names[i]));
291 AudioMappingView::update_cells ()
293 vector<string> row_names;
294 for (int i = 0; i < _grid->GetNumberRows (); ++i) {
295 row_names.push_back (wx_to_std (_grid->GetCellValue (i, 0)));
298 if (_grid->GetNumberRows ()) {
299 _grid->DeleteRows (0, _grid->GetNumberRows ());
302 _grid->InsertRows (0, _map.input_channels ());
304 for (int i = 0; i < _map.input_channels(); ++i) {
305 for (int j = 0; j < _map.output_channels(); ++j) {
306 _grid->SetCellRenderer (i, j + 1, new ValueRenderer);
310 for (int i = 0; i < _map.input_channels(); ++i) {
311 if (i < int (row_names.size ())) {
312 _grid->SetCellValue (i, 0, std_to_wx (row_names[i]));
314 for (int j = 1; j < _grid->GetNumberCols(); ++j) {
315 _grid->SetCellValue (i, j, std_to_wx (locale_convert<string> (_map.get (i, j - 1))));
323 AudioMappingView::mouse_moved_grid (wxMouseEvent& ev)
327 _grid->CalcUnscrolledPosition (ev.GetX(), ev.GetY(), &xx, &yy);
329 int const row = _grid->YToRow (yy);
330 int const column = _grid->XToCol (xx);
332 if (row < 0 || column < 1) {
333 _grid->GetGridWindow()->SetToolTip ("");
334 _last_tooltip_row = row;
335 _last_tooltip_column = column;
338 if (row != _last_tooltip_row || column != _last_tooltip_column) {
341 float const gain = _map.get (row, column - 1);
343 s = wxString::Format (_("No audio will be passed from content channel %d to DCP channel %d."), row + 1, column);
344 } else if (gain == 1) {
345 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d unaltered."), row + 1, column);
347 float const dB = 20 * log10 (gain);
348 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d with gain %.1fdB."), row + 1, column, dB);
351 _grid->GetGridWindow()->SetToolTip (s + " " + _("Right click to change gain."));
352 _last_tooltip_row = row;
353 _last_tooltip_column = column;
360 AudioMappingView::sized (wxSizeEvent& ev)
367 AudioMappingView::setup_sizes ()
369 int const top_height = 24;
372 _left_labels->SetMinSize (wxSize (LEFT_WIDTH, _grid->GetSize().GetHeight()));
373 _top_labels->SetMinSize (wxSize (_grid->GetSize().GetWidth() + LEFT_WIDTH, top_height));
374 /* Try to make the _top_labels 'actual' size respect the minimum we just set */
376 _left_labels->Refresh ();
377 _top_labels->Refresh ();
381 AudioMappingView::paint_left_labels ()
383 wxPaintDC dc (_left_labels);
385 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
391 _grid->CalcUnscrolledPosition (0, 0, &sx, &sy);
392 gc->Translate (0, -sy);
394 wxSize const size = dc.GetSize();
395 int const half = size.GetWidth() / 2;
397 gc->SetPen (wxPen (wxColour (0, 0, 0)));
398 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
400 wxGraphicsPath lines = gc->CreatePath();
402 vector<pair<int, int> >::const_iterator i = _input_group_positions.begin();
403 if (i != _input_group_positions.end()) {
404 lines.MoveToPoint (half, i->first);
405 lines.AddLineToPoint (size.GetWidth(), i->first);
408 vector<Group>::const_iterator j = _input_groups.begin();
409 while (i != _input_group_positions.end() && j != _input_groups.end()) {
411 dc.SetClippingRegion (0, i->first + 2, size.GetWidth(), i->second - 4);
413 dc.SetFont (*wxSWISS_FONT);
415 wxCoord label_height;
416 dc.GetTextExtent (std_to_wx (j->name), &label_width, &label_height);
420 half + (half - label_height) / 2,
421 min (i->second, (i->second + i->first + label_width) / 2) - sy,
425 dc.DestroyClippingRegion ();
427 lines.MoveToPoint (half, i->second);
428 lines.AddLineToPoint (size.GetWidth(), i->second);
430 gc->StrokePath (lines);
437 dc.SetFont (wxSWISS_FONT->Bold());
438 wxCoord overall_label_width;
439 wxCoord overall_label_height;
440 dc.GetTextExtent (_("Content"), &overall_label_width, &overall_label_height);
443 (half - overall_label_height) / 2,
444 min (size.GetHeight(), (size.GetHeight() + _grid->GetColLabelSize() + overall_label_width) / 2 - sy),
452 AudioMappingView::paint_top_labels ()
454 wxPaintDC dc (_top_labels);
455 if (_grid->GetNumberCols() == 0) {
459 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
465 _grid->CalcUnscrolledPosition (0, 0, &sx, &sy);
466 gc->Translate (-sx, 0);
468 wxSize const size = dc.GetSize();
470 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
472 dc.SetFont (wxSWISS_FONT->Bold());
474 wxCoord label_height;
475 dc.GetTextExtent (_("DCP"), &label_width, &label_height);
477 dc.DrawText (_("DCP"), (size.GetWidth() + _grid->GetColSize(0) + LEFT_WIDTH - label_width) / 2 - sx, (size.GetHeight() - label_height) / 2);
479 gc->SetPen (wxPen (wxColour (0, 0, 0)));
480 wxGraphicsPath lines = gc->CreatePath();
481 lines.MoveToPoint (LEFT_WIDTH + _grid->GetColSize(0) - 1, 0);
482 lines.AddLineToPoint (LEFT_WIDTH + _grid->GetColSize(0) - 1, size.GetHeight());
483 lines.MoveToPoint (size.GetWidth() - 1, 0);
484 lines.AddLineToPoint (size.GetWidth() - 1, size.GetHeight());
485 gc->StrokePath (lines);
491 AudioMappingView::set_input_groups (vector<Group> const & groups)
493 if (_grid->GetNumberRows() == 0) {
497 _input_groups = groups;
498 _input_group_positions.clear ();
500 int ypos = _grid->GetColLabelSize() - 1;
501 BOOST_FOREACH (Group const & i, _input_groups) {
502 int const old_ypos = ypos;
503 ypos += (i.to - i.from + 1) * _grid->GetRowSize(0);
504 _input_group_positions.push_back (make_pair (old_ypos, ypos));
509 AudioMappingView::mouse_moved_left_labels (wxMouseEvent& event)
512 for (size_t i = 0; i < _input_group_positions.size(); ++i) {
513 if (_input_group_positions[i].first <= event.GetY() && event.GetY() < _input_group_positions[i].second) {
514 _left_labels->SetToolTip (_input_groups[i].name);
520 _left_labels->SetToolTip ("");
525 AudioMappingView::grid_scrolled ()
527 _left_labels->Refresh ();
528 _left_labels->Update ();
529 _top_labels->Refresh ();
530 _top_labels->Update ();