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>
35 #include <wx/graphics.h>
36 #include <boost/foreach.hpp>
45 using boost::shared_ptr;
47 #define INDICATOR_SIZE 16
57 class NoSelectionStringRenderer : public wxGridCellStringRenderer
60 void Draw (wxGrid& grid, wxGridCellAttr& attr, wxDC& dc, const wxRect& rect, int row, int col, bool)
62 wxGridCellStringRenderer::Draw (grid, attr, dc, rect, row, col, false);
66 /** @class ValueRenderer
67 * @brief wxGridCellRenderer for a gain value.
69 class ValueRenderer : public wxGridCellRenderer
73 void Draw (wxGrid& grid, wxGridCellAttr &, wxDC& dc, const wxRect& rect, int row, int col, bool)
75 dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (255, 255, 255), 1, wxPENSTYLE_SOLID));
76 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
77 dc.DrawRectangle (rect);
79 int const xo = (rect.GetWidth() - INDICATOR_SIZE) / 2;
80 int const yo = (rect.GetHeight() - INDICATOR_SIZE) / 2;
82 dc.SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
83 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (255, 255, 255), wxBRUSHSTYLE_SOLID));
84 dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo, INDICATOR_SIZE, INDICATOR_SIZE));
86 float const value = raw_convert<float> (wx_to_std (grid.GetCellValue (row, col)));
87 float const value_dB = 20 * log10 (value);
90 if (value_dB > -range) {
91 height = INDICATOR_SIZE * (1 + value_dB / range);
94 height = max (0, height);
97 /* Make sure we get a little bit of the marker if there is any gain */
98 height = max (3, height);
101 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush (wxColour (0, 255, 0), wxBRUSHSTYLE_SOLID));
102 dc.DrawRectangle (wxRect (rect.GetLeft() + xo, rect.GetTop() + yo + INDICATOR_SIZE - height, INDICATOR_SIZE, height));
105 wxSize GetBestSize (wxGrid &, wxGridCellAttr &, wxDC &, int, int)
107 return wxSize (INDICATOR_SIZE + 4, INDICATOR_SIZE + 4);
110 wxGridCellRenderer* Clone () const
112 return new ValueRenderer;
117 AudioMappingView::AudioMappingView (wxWindow* parent)
118 : wxPanel (parent, wxID_ANY)
121 , _last_tooltip_row (0)
122 , _last_tooltip_column (0)
124 _left_labels = new wxPanel (this, wxID_ANY);
125 _left_labels->Bind (wxEVT_PAINT, boost::bind (&AudioMappingView::paint_left_labels, this));
126 _top_labels = new wxPanel (this, wxID_ANY);
127 _top_labels->Bind (wxEVT_PAINT, boost::bind (&AudioMappingView::paint_top_labels, this));
129 _grid = new wxGrid (this, wxID_ANY);
131 _grid->CreateGrid (0, MAX_DCP_AUDIO_CHANNELS + 1);
132 _grid->HideRowLabels ();
133 _grid->DisableDragRowSize ();
134 _grid->DisableDragColSize ();
135 _grid->EnableEditing (false);
136 _grid->SetCellHighlightPenWidth (0);
137 _grid->SetDefaultRenderer (new NoSelectionStringRenderer);
140 wxSizer* vertical_sizer = new wxBoxSizer (wxVERTICAL);
141 vertical_sizer->Add (_top_labels);
142 wxSizer* horizontal_sizer = new wxBoxSizer (wxHORIZONTAL);
143 horizontal_sizer->Add (_left_labels);
144 horizontal_sizer->Add (_grid, 1, wxEXPAND | wxALL);
145 vertical_sizer->Add (horizontal_sizer);
146 SetSizerAndFit (vertical_sizer);
148 Bind (wxEVT_GRID_CELL_LEFT_CLICK, boost::bind (&AudioMappingView::left_click, this, _1));
149 Bind (wxEVT_GRID_CELL_RIGHT_CLICK, boost::bind (&AudioMappingView::right_click, this, _1));
150 _grid->GetGridWindow()->Bind (wxEVT_MOTION, boost::bind (&AudioMappingView::mouse_moved, this, _1));
151 Bind (wxEVT_SIZE, boost::bind (&AudioMappingView::sized, this, _1));
154 _menu->Append (ID_off, _("Off"));
155 _menu->Append (ID_full, _("Full"));
156 _menu->Append (ID_minus6dB, _("-6dB"));
157 _menu->Append (ID_edit, _("Edit..."));
159 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::off, this), ID_off);
160 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::full, this), ID_full);
161 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::minus6dB, this), ID_minus6dB);
162 Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&AudioMappingView::edit, this), ID_edit);
165 /** Called when any gain value has changed */
167 AudioMappingView::map_values_changed ()
171 _last_tooltip_column = -1;
175 AudioMappingView::left_click (wxGridEvent& ev)
177 if (ev.GetCol() == 0) {
181 int const d = ev.GetCol() - 1;
183 if (_map.get (ev.GetRow(), d) > 0) {
184 _map.set (ev.GetRow(), d, 0);
186 _map.set (ev.GetRow(), d, 1);
189 map_values_changed ();
193 AudioMappingView::right_click (wxGridEvent& ev)
195 if (ev.GetCol() == 0) {
199 _menu_row = ev.GetRow ();
200 _menu_column = ev.GetCol ();
201 PopupMenu (_menu, ev.GetPosition ());
205 AudioMappingView::off ()
207 _map.set (_menu_row, _menu_column - 1, 0);
208 map_values_changed ();
212 AudioMappingView::full ()
214 _map.set (_menu_row, _menu_column - 1, 1);
215 map_values_changed ();
219 AudioMappingView::minus6dB ()
221 _map.set (_menu_row, _menu_column - 1, pow (10, -6.0 / 20));
222 map_values_changed ();
226 AudioMappingView::edit ()
228 int const d = _menu_column - 1;
230 AudioGainDialog* dialog = new AudioGainDialog (this, _menu_row, _menu_column - 1, _map.get (_menu_row, d));
231 if (dialog->ShowModal () == wxID_OK) {
232 _map.set (_menu_row, d, dialog->value ());
233 map_values_changed ();
240 AudioMappingView::set (AudioMapping map)
247 AudioMappingView::set_input_channels (vector<string> const & names)
249 for (int i = 0; i < _grid->GetNumberRows(); ++i) {
250 _grid->SetCellValue (i, 0, std_to_wx (names[i]));
255 AudioMappingView::set_output_channels (vector<string> const & names)
257 int const o = names.size() + 1;
258 if (o < _grid->GetNumberCols ()) {
259 _grid->DeleteCols (o, _grid->GetNumberCols() - o);
260 } else if (o > _grid->GetNumberCols ()) {
261 _grid->InsertCols (_grid->GetNumberCols(), o - _grid->GetNumberCols());
264 _grid->SetColLabelValue (0, wxT (""));
266 for (size_t i = 0; i < names.size(); ++i) {
267 _grid->SetColLabelValue (i + 1, std_to_wx (names[i]));
274 AudioMappingView::update_cells ()
276 vector<string> row_names;
277 for (int i = 0; i < _grid->GetNumberRows (); ++i) {
278 row_names.push_back (wx_to_std (_grid->GetCellValue (i, 0)));
281 if (_grid->GetNumberRows ()) {
282 _grid->DeleteRows (0, _grid->GetNumberRows ());
285 _grid->InsertRows (0, _map.input_channels ());
287 for (int i = 0; i < _map.input_channels(); ++i) {
288 for (int j = 0; j < _map.output_channels(); ++j) {
289 _grid->SetCellRenderer (i, j + 1, new ValueRenderer);
293 for (int i = 0; i < _map.input_channels(); ++i) {
294 if (i < int (row_names.size ())) {
295 _grid->SetCellValue (i, 0, std_to_wx (row_names[i]));
297 for (int j = 1; j < _grid->GetNumberCols(); ++j) {
298 _grid->SetCellValue (i, j, std_to_wx (raw_convert<string> (_map.get (i, j - 1))));
306 AudioMappingView::mouse_moved (wxMouseEvent& ev)
310 _grid->CalcUnscrolledPosition (ev.GetX(), ev.GetY(), &xx, &yy);
312 int const row = _grid->YToRow (yy);
313 int const column = _grid->XToCol (xx);
315 if (row < 0 || column < 1) {
316 _grid->GetGridWindow()->SetToolTip ("");
317 _last_tooltip_row = row;
318 _last_tooltip_column = column;
321 if (row != _last_tooltip_row || column != _last_tooltip_column) {
324 float const gain = _map.get (row, column - 1);
326 s = wxString::Format (_("No audio will be passed from content channel %d to DCP channel %d."), row + 1, column);
327 } else if (gain == 1) {
328 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d unaltered."), row + 1, column);
330 float const dB = 20 * log10 (gain);
331 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d with gain %.1fdB."), row + 1, column, dB);
334 _grid->GetGridWindow()->SetToolTip (s + " " + _("Right click to change gain."));
335 _last_tooltip_row = row;
336 _last_tooltip_column = column;
343 AudioMappingView::sized (wxSizeEvent& ev)
345 int const top_height = 24;
348 _left_labels->SetMinSize (wxSize (LEFT_WIDTH, _grid->GetSize().GetHeight()));
349 _top_labels->SetMinSize (wxSize (_grid->GetSize().GetWidth() + LEFT_WIDTH, top_height));
354 AudioMappingView::paint_left_labels ()
356 wxPaintDC dc (_left_labels);
358 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
363 wxSize const size = dc.GetSize();
364 int const half = size.GetWidth() / 2;
366 gc->SetPen (wxPen (wxColour (0, 0, 0)));
367 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
369 if (_grid->GetNumberRows() > 0) {
371 /* Draw a line at the top of the first group */
372 int ypos = _grid->GetColLabelSize() - 1;
373 wxGraphicsPath lines = gc->CreatePath();
374 lines.MoveToPoint (half, ypos);
375 lines.AddLineToPoint (size.GetWidth(), ypos);
377 /* And the names of the groups and a line under each */
378 BOOST_FOREACH (Group const & i, _input_groups) {
379 int const old_ypos = ypos;
380 ypos += (i.to - i.from + 1) * _grid->GetRowSize(0);
382 dc.SetClippingRegion (0, old_ypos + 2, size.GetWidth(), ypos - 4);
384 dc.SetFont (*wxSWISS_FONT);
386 wxCoord label_height;
387 dc.GetTextExtent (std_to_wx (i.name), &label_width, &label_height);
389 dc.DrawRotatedText (i.name, half + (half - label_height) / 2, (ypos + old_ypos + label_width) / 2, 90);
390 dc.DestroyClippingRegion ();
392 lines.MoveToPoint (half, ypos);
393 lines.AddLineToPoint (size.GetWidth(), ypos);
396 gc->StrokePath (lines);
400 dc.SetFont (wxSWISS_FONT->Bold());
401 wxCoord overall_label_width;
402 wxCoord overall_label_height;
403 dc.GetTextExtent (_("Content"), &overall_label_width, &overall_label_height);
406 (half - overall_label_height) / 2,
407 min (size.GetHeight(), (size.GetHeight() + _grid->GetColLabelSize() + overall_label_width) / 2),
415 AudioMappingView::paint_top_labels ()
417 wxPaintDC dc (_top_labels);
418 if (_grid->GetNumberCols() == 0) {
422 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
427 wxSize const size = dc.GetSize();
429 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
431 dc.SetFont (wxSWISS_FONT->Bold());
433 wxCoord label_height;
434 dc.GetTextExtent (_("DCP"), &label_width, &label_height);
436 dc.DrawText (_("DCP"), (size.GetWidth() + _grid->GetColSize(0) + LEFT_WIDTH - label_width) / 2, (size.GetHeight() - label_height) / 2);
438 gc->SetPen (wxPen (wxColour (0, 0, 0)));
439 wxGraphicsPath lines = gc->CreatePath();
440 lines.MoveToPoint (LEFT_WIDTH + _grid->GetColSize(0) - 1, 0);
441 lines.AddLineToPoint (LEFT_WIDTH + _grid->GetColSize(0) - 1, size.GetHeight());
442 lines.MoveToPoint (size.GetWidth() - 1, 0);
443 lines.AddLineToPoint (size.GetWidth() - 1, size.GetHeight());
444 gc->StrokePath (lines);
450 AudioMappingView::set_input_groups (vector<Group> const & groups)
452 _input_groups = groups;