2 Copyright (C) 2013-2021 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 "lib/warnings.h"
31 #include <dcp/locale_convert.h>
32 #include <dcp/types.h>
33 DCPOMATIC_DISABLE_WARNINGS
35 #include <wx/renderer.h>
37 #include <wx/graphics.h>
38 DCPOMATIC_ENABLE_WARNINGS
49 using std::shared_ptr;
50 using boost::optional;
51 #if BOOST_VERSION >= 106100
52 using namespace boost::placeholders;
54 using dcp::locale_convert;
56 static constexpr auto INDICATOR_SIZE = 20;
57 static constexpr auto ROW_HEIGHT = 32;
58 static constexpr auto MINIMUM_COLUMN_WIDTH = 32;
59 static constexpr auto LEFT_WIDTH = MINIMUM_COLUMN_WIDTH * 3;
60 static constexpr auto TOP_HEIGHT = ROW_HEIGHT * 2;
61 static constexpr auto COLUMN_PADDING = 16;
62 static constexpr auto HORIZONTAL_PAGE_SIZE = 32;
72 AudioMappingView::AudioMappingView (wxWindow* parent, wxString left_label, wxString from, wxString top_label, wxString to)
73 : wxPanel (parent, wxID_ANY)
76 , _left_label (left_label)
78 , _top_label (top_label)
82 _menu->Append (ID_off, _("Off"));
83 _menu->Append (ID_minus6dB, _("-6dB"));
84 _menu->Append (ID_0dB, _("0dB (unchanged)"));
85 _menu->Append (ID_plus3dB, _("+3dB"));
86 _menu->Append (ID_edit, _("Edit..."));
88 _body = new wxPanel (this, wxID_ANY);
89 _vertical_scroll = new wxScrollBar (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSB_VERTICAL);
90 _horizontal_scroll = new wxScrollBar (this, wxID_ANY);
93 SetDoubleBuffered (true);
96 Bind (wxEVT_SIZE, boost::bind(&AudioMappingView::size, this, _1));
97 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 0), ID_off);
98 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(-6)), ID_minus6dB);
99 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 1), ID_0dB);
100 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(3)), ID_plus3dB);
101 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::edit, this), ID_edit);
102 Bind (wxEVT_MOUSEWHEEL, boost::bind(&AudioMappingView::mouse_wheel, this, _1));
103 _body->Bind (wxEVT_PAINT, boost::bind(&AudioMappingView::paint, this));
104 _body->Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioMappingView::left_down, this, _1));
105 _body->Bind (wxEVT_RIGHT_DOWN, boost::bind(&AudioMappingView::right_down, this, _1));
106 _body->Bind (wxEVT_MOTION, boost::bind(&AudioMappingView::motion, this, _1));
107 _vertical_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
108 _vertical_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
109 _vertical_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
110 _vertical_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
111 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
112 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
113 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
114 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
115 _horizontal_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
116 _horizontal_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
117 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
118 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
119 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
120 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
121 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
122 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
126 AudioMappingView::size (wxSizeEvent& ev)
133 AudioMappingView::setup ()
135 auto const s = GetSize();
136 int const w = _vertical_scroll->GetSize().GetWidth();
137 int const h = _horizontal_scroll->GetSize().GetHeight();
139 _vertical_scroll->SetPosition (wxPoint(s.GetWidth() - w, 0));
140 _vertical_scroll->SetSize (wxSize(w, max(0, s.GetHeight() - h)));
142 _body->SetSize (wxSize(max(0, s.GetWidth() - w), max(0, s.GetHeight() - h)));
144 _horizontal_scroll->SetPosition (wxPoint(0, s.GetHeight() - h));
145 _horizontal_scroll->SetSize (wxSize(max(0, s.GetWidth() - w), h));
147 _vertical_scroll->SetScrollbar (
148 _vertical_scroll->GetThumbPosition(),
149 s.GetHeight() - h - 8,
150 ROW_HEIGHT * (2 + _input_channels.size()),
155 wxClientDC dc (GetParent());
156 dc.SetFont (wxSWISS_FONT->Bold());
158 _column_widths.clear ();
159 _column_widths.reserve (_output_channels.size());
160 _column_widths_total = 0;
162 for (auto const& i: _output_channels) {
165 dc.GetTextExtent (std_to_wx(i.name), &width, &height);
166 auto const this_width = max(width + COLUMN_PADDING, MINIMUM_COLUMN_WIDTH);
167 _column_widths.push_back (this_width);
168 _column_widths_total += this_width;
171 _horizontal_scroll->SetScrollbar (
172 _horizontal_scroll->GetThumbPosition(),
173 s.GetWidth() - w - 8,
174 LEFT_WIDTH + _column_widths_total,
175 HORIZONTAL_PAGE_SIZE,
180 AudioMappingView::scroll ()
186 AudioMappingView::paint_static (wxDC& dc)
188 dc.SetFont (wxSWISS_FONT->Bold());
190 wxCoord label_height;
192 dc.GetTextExtent (_top_label, &label_width, &label_height);
193 dc.DrawText (_top_label, LEFT_WIDTH + (_column_widths_total - label_width) / 2, (ROW_HEIGHT - label_height) / 2);
195 dc.GetTextExtent (_left_label, &label_width, &label_height);
198 (ROW_HEIGHT - label_height) / 2,
199 TOP_HEIGHT + (_input_channels.size() * ROW_HEIGHT + label_width) / 2,
203 dc.SetFont (*wxSWISS_FONT);
207 AudioMappingView::paint_column_labels (wxDC& dc)
210 wxCoord label_height;
212 for (auto i = 0U; i < _output_channels.size(); ++i) {
213 auto const name = std_to_wx(_output_channels[i].name);
214 dc.GetTextExtent (name, &label_width, &label_height);
215 dc.DrawText (name, x + (_column_widths[i] - label_width) / 2, ROW_HEIGHT + (ROW_HEIGHT - label_height) / 2);
216 x += _column_widths[i];
219 dc.DrawLine(wxPoint(LEFT_WIDTH, ROW_HEIGHT), wxPoint(LEFT_WIDTH + _column_widths_total, ROW_HEIGHT));
220 dc.DrawLine(wxPoint(LEFT_WIDTH, ROW_HEIGHT * 2), wxPoint(LEFT_WIDTH + _column_widths_total, ROW_HEIGHT * 2));
224 AudioMappingView::paint_column_lines (wxDC& dc)
227 for (size_t i = 0; i < _output_channels.size(); ++i) {
229 wxPoint(x, ROW_HEIGHT),
230 wxPoint(x, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
232 x += _column_widths[i];
236 wxPoint(LEFT_WIDTH + _column_widths_total, ROW_HEIGHT),
237 wxPoint(LEFT_WIDTH + _column_widths_total, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
242 AudioMappingView::paint_row_labels (wxDC& dc)
245 wxCoord label_height;
247 /* Row channel labels */
249 for (auto i = 0U; i < _input_channels.size(); ++i) {
250 auto const name = std_to_wx(_input_channels[i].name);
251 dc.GetTextExtent (name, &label_width, &label_height);
252 dc.DrawText (name, LEFT_WIDTH - MINIMUM_COLUMN_WIDTH + (MINIMUM_COLUMN_WIDTH - label_width) / 2, TOP_HEIGHT + ROW_HEIGHT * i + (ROW_HEIGHT - label_height) / 2);
255 /* Vertical lines on the left */
257 for (int i = 1; i < 3; ++i) {
259 wxPoint(MINIMUM_COLUMN_WIDTH * i, TOP_HEIGHT),
260 wxPoint(MINIMUM_COLUMN_WIDTH * i, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
265 for (auto const& i: _input_groups) {
266 dc.DrawLine (wxPoint(MINIMUM_COLUMN_WIDTH, y), wxPoint(MINIMUM_COLUMN_WIDTH * 2, y));
267 y += (i.to - i.from + 1) * ROW_HEIGHT;
269 dc.DrawLine (wxPoint(MINIMUM_COLUMN_WIDTH, y), wxPoint(MINIMUM_COLUMN_WIDTH * 2, y));
271 /* Group labels and lines; be careful here as wxDCClipper does not restore the old
272 * clipping rectangle after it is destroyed
275 for (auto const& i: _input_groups) {
276 int const height = (i.to - i.from + 1) * ROW_HEIGHT;
277 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
278 if (label_width > height) {
279 label_width = height - 8;
283 wxDCClipper clip (dc, wxRect(MINIMUM_COLUMN_WIDTH, y, ROW_HEIGHT, height));
285 if ((yp - 2 * ROW_HEIGHT) < dc.GetLogicalOrigin().y) {
286 yp += dc.GetLogicalOrigin().y;
291 ROW_HEIGHT + (ROW_HEIGHT - label_height) / 2,
292 y + (height + label_width) / 2,
302 AudioMappingView::paint_row_lines (wxDC& dc)
304 for (size_t i = 0; i < _input_channels.size(); ++i) {
306 wxPoint(MINIMUM_COLUMN_WIDTH * 2, TOP_HEIGHT + ROW_HEIGHT * i),
307 wxPoint(LEFT_WIDTH + _column_widths_total, TOP_HEIGHT + ROW_HEIGHT * i)
311 wxPoint(MINIMUM_COLUMN_WIDTH * 2, TOP_HEIGHT + ROW_HEIGHT * _input_channels.size()),
312 wxPoint(LEFT_WIDTH + _column_widths_total, TOP_HEIGHT + ROW_HEIGHT * _input_channels.size())
317 AudioMappingView::paint_indicators (wxDC& dc)
319 /* _{input,output}_channels and _map may not always be in sync, be careful here */
320 size_t const output = min(_output_channels.size(), size_t(_map.output_channels()));
321 size_t const input = min(_input_channels.size(), size_t(_map.input_channels()));
324 for (size_t x = 0; x < output; ++x) {
325 for (size_t y = 0; y < input; ++y) {
326 dc.SetBrush (*wxWHITE_BRUSH);
329 xp + (_column_widths[x] - INDICATOR_SIZE) / 2,
330 TOP_HEIGHT + y * ROW_HEIGHT + (ROW_HEIGHT - INDICATOR_SIZE) / 2,
331 INDICATOR_SIZE, INDICATOR_SIZE
335 float const value_dB = linear_to_db(_map.get(_input_channels[y].index, _output_channels[x].index));
336 auto const colour = value_dB <= 0 ? wxColour(0, 255, 0) : wxColour(255, 150, 0);
337 int const range = 18;
339 if (value_dB > -range) {
340 height = min(INDICATOR_SIZE, static_cast<int>(INDICATOR_SIZE * (1 + value_dB / range)));
343 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush(colour, wxBRUSHSTYLE_SOLID));
346 xp + (_column_widths[x] - INDICATOR_SIZE) / 2,
347 TOP_HEIGHT + y * ROW_HEIGHT + (ROW_HEIGHT - INDICATOR_SIZE) / 2 + INDICATOR_SIZE - height,
348 INDICATOR_SIZE, height
353 xp += _column_widths[x];
358 void clip (wxDC& dc, int x, int y, int w, int h)
360 dc.SetClippingRegion (x, y, w, h);
364 void translate (wxDC& dc, int x, int y)
366 dc.SetLogicalOrigin (x, y);
370 void restore (wxDC& dc)
372 dc.SetLogicalOrigin (0, 0);
373 dc.DestroyClippingRegion ();
377 AudioMappingView::paint ()
379 wxPaintDC dc (_body);
381 int const hs = _horizontal_scroll->GetThumbPosition ();
382 int const vs = _vertical_scroll->GetThumbPosition ();
390 _column_widths_total,
391 ROW_HEIGHT * (2 + _input_channels.size())
393 translate (dc, hs, 0);
394 paint_column_labels (dc);
402 min(int(ROW_HEIGHT * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT) + 1
404 translate (dc, 0, vs);
405 paint_row_labels (dc);
410 MINIMUM_COLUMN_WIDTH * 2,
412 MINIMUM_COLUMN_WIDTH + _column_widths_total,
413 min(int(ROW_HEIGHT * (2 + _input_channels.size())), GetSize().GetHeight() - TOP_HEIGHT)
415 translate (dc, hs, vs);
416 paint_row_lines (dc);
422 MINIMUM_COLUMN_WIDTH,
423 MINIMUM_COLUMN_WIDTH + _column_widths_total,
424 min(int(ROW_HEIGHT * (1 + _input_channels.size())), GetSize().GetHeight() - ROW_HEIGHT)
426 translate (dc, hs, vs);
427 paint_column_lines (dc);
434 _column_widths_total,
435 min(int(ROW_HEIGHT * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
437 translate (dc, hs, vs);
438 paint_indicators (dc);
442 optional<pair<NamedChannel, NamedChannel>>
443 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
445 int x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
446 int const y = ev.GetY() + _vertical_scroll->GetThumbPosition();
448 if (x <= LEFT_WIDTH || y < TOP_HEIGHT) {
452 int const input = (y - TOP_HEIGHT) / ROW_HEIGHT;
456 for (auto const i: _column_widths) {
464 if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
468 return make_pair(_input_channels[input], _output_channels[output]);
472 AudioMappingView::mouse_event_to_input_group_name (wxMouseEvent& ev) const
474 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
475 if (x < MINIMUM_COLUMN_WIDTH || x > (2 * MINIMUM_COLUMN_WIDTH)) {
479 int const y = (ev.GetY() + _vertical_scroll->GetThumbPosition() - TOP_HEIGHT) / ROW_HEIGHT;
480 for (auto i: _input_groups) {
481 if (i.from <= y && y <= i.to) {
490 AudioMappingView::left_down (wxMouseEvent& ev)
492 auto channels = mouse_event_to_channels (ev);
497 if (_map.get(channels->first.index, channels->second.index) > 0) {
498 _map.set (channels->first.index, channels->second.index, 0);
500 _map.set (channels->first.index, channels->second.index, 1);
503 map_values_changed ();
507 AudioMappingView::right_down (wxMouseEvent& ev)
509 auto channels = mouse_event_to_channels (ev);
514 _menu_input = channels->first.index;
515 _menu_output = channels->second.index;
516 PopupMenu (_menu, ev.GetPosition());
520 AudioMappingView::mouse_wheel (wxMouseEvent& ev)
522 if (ev.ShiftDown()) {
523 _horizontal_scroll->SetThumbPosition (
524 _horizontal_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -HORIZONTAL_PAGE_SIZE : HORIZONTAL_PAGE_SIZE)
528 _vertical_scroll->SetThumbPosition (
529 _vertical_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -ROW_HEIGHT : ROW_HEIGHT)
535 /** Called when any gain value has changed */
537 AudioMappingView::map_values_changed ()
540 _last_tooltip_channels = boost::none;
545 AudioMappingView::set_gain_from_menu (double linear)
547 _map.set (_menu_input, _menu_output, linear);
548 map_values_changed ();
552 AudioMappingView::edit ()
554 auto dialog = new AudioGainDialog (this, _menu_input, _menu_output, _map.get(_menu_input, _menu_output));
555 if (dialog->ShowModal() == wxID_OK) {
556 _map.set (_menu_input, _menu_output, dialog->value ());
557 map_values_changed ();
564 AudioMappingView::set (AudioMapping map)
571 AudioMappingView::set_input_channels (vector<NamedChannel> const& channels)
573 _input_channels = channels;
579 AudioMappingView::set_output_channels (vector<NamedChannel> const & channels)
581 _output_channels = channels;
588 AudioMappingView::input_channel_name_with_group (NamedChannel const& n) const
590 optional<wxString> group;
591 for (auto i: _input_groups) {
592 if (i.from <= n.index && n.index <= i.to) {
593 group = std_to_wx (i.name);
597 if (group && !group->IsEmpty()) {
598 return wxString::Format ("%s/%s", group->data(), std_to_wx(n.name).data());
601 return std_to_wx(n.name);
606 AudioMappingView::motion (wxMouseEvent& ev)
608 auto channels = mouse_event_to_channels (ev);
610 if (channels != _last_tooltip_channels) {
612 auto const gain = _map.get(channels->first.index, channels->second.index);
614 s = wxString::Format (
615 _("No audio will be passed from %s channel '%s' to %s channel '%s'."),
617 input_channel_name_with_group(channels->first),
619 std_to_wx(channels->second.name)
621 } else if (gain == 1) {
622 s = wxString::Format (
623 _("Audio will be passed from %s channel %s to %s channel %s unaltered."),
625 input_channel_name_with_group(channels->first),
627 std_to_wx(channels->second.name)
630 auto const dB = linear_to_db(gain);
631 s = wxString::Format (
632 _("Audio will be passed from %s channel %s to %s channel %s with gain %.1fdB."),
634 input_channel_name_with_group(channels->first),
636 std_to_wx(channels->second.name),
641 SetToolTip (s + " " + _("Right click to change gain."));
644 auto group = mouse_event_to_input_group_name (ev);
646 SetToolTip (std_to_wx(*group));
652 _last_tooltip_channels = channels;
657 AudioMappingView::set_input_groups (vector<Group> const & groups)
659 _input_groups = groups;