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/>.
22 /** @file src/wx/audio_mapping_view.cc
23 * @brief AudioMappingView class and helpers.
27 #include "audio_gain_dialog.h"
28 #include "audio_mapping_view.h"
31 #include "lib/audio_mapping.h"
32 #include "lib/maths_util.h"
33 #include <dcp/locale_convert.h>
34 #include <dcp/types.h>
35 #include <dcp/warnings.h>
36 LIBDCP_DISABLE_WARNINGS
37 #include <wx/graphics.h>
39 #include <wx/renderer.h>
41 LIBDCP_ENABLE_WARNINGS
49 using std::shared_ptr;
52 using boost::optional;
53 #if BOOST_VERSION >= 106100
54 using namespace boost::placeholders;
56 using dcp::locale_convert;
59 static constexpr auto INDICATOR_SIZE = 20;
60 static constexpr auto ROW_HEIGHT = 32;
61 static constexpr auto MINIMUM_COLUMN_WIDTH = 32;
62 static constexpr auto LEFT_WIDTH = MINIMUM_COLUMN_WIDTH * 3;
63 static constexpr auto TOP_HEIGHT = ROW_HEIGHT * 2;
64 static constexpr auto COLUMN_PADDING = 16;
65 static constexpr auto HORIZONTAL_PAGE_SIZE = 32;
77 AudioMappingView::AudioMappingView (wxWindow* parent, wxString left_label, wxString from, wxString top_label, wxString to)
78 : wxPanel (parent, wxID_ANY)
81 , _left_label (left_label)
83 , _top_label (top_label)
87 _menu->Append (ID_off, _("Off"));
88 _menu->Append (ID_minus6dB, _("-6dB"));
89 _menu->Append (ID_0dB, _("0dB (unchanged)"));
90 _menu->Append (ID_plus3dB, _("+3dB"));
91 _menu->Append (ID_edit, _("Edit..."));
93 _body = new wxPanel (this, wxID_ANY);
94 _vertical_scroll = new wxScrollBar (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSB_VERTICAL);
95 _horizontal_scroll = new wxScrollBar (this, wxID_ANY);
98 SetDoubleBuffered (true);
101 Bind (wxEVT_SIZE, boost::bind(&AudioMappingView::size, this, _1));
102 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 0), ID_off);
103 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(-6)), ID_minus6dB);
104 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 1), ID_0dB);
105 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(3)), ID_plus3dB);
106 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::edit, this), ID_edit);
107 Bind (wxEVT_MOUSEWHEEL, boost::bind(&AudioMappingView::mouse_wheel, this, _1));
108 _body->Bind (wxEVT_PAINT, boost::bind(&AudioMappingView::paint, this));
109 _body->Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioMappingView::left_down, this, _1));
110 _body->Bind (wxEVT_RIGHT_DOWN, boost::bind(&AudioMappingView::right_down, this, _1));
111 _body->Bind (wxEVT_MOTION, boost::bind(&AudioMappingView::motion, this, _1));
112 _vertical_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
113 _vertical_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
114 _vertical_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
115 _vertical_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
116 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
117 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
118 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
119 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
120 _horizontal_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
121 _horizontal_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
122 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
123 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
124 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
125 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
126 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
127 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
132 AudioMappingView::size (wxSizeEvent& ev)
140 AudioMappingView::setup ()
142 auto const s = GetSize();
143 int const w = _vertical_scroll->GetSize().GetWidth();
144 int const h = _horizontal_scroll->GetSize().GetHeight();
146 _vertical_scroll->SetPosition (wxPoint(s.GetWidth() - w, 0));
147 _vertical_scroll->SetSize (wxSize(w, max(0, s.GetHeight() - h)));
149 _body->SetSize (wxSize(max(0, s.GetWidth() - w), max(0, s.GetHeight() - h)));
151 _horizontal_scroll->SetPosition (wxPoint(0, s.GetHeight() - h));
152 _horizontal_scroll->SetSize (wxSize(max(0, s.GetWidth() - w), h));
154 _vertical_scroll->SetScrollbar (
155 _vertical_scroll->GetThumbPosition(),
156 s.GetHeight() - h - 8,
157 ROW_HEIGHT * (2 + _input_channels.size()),
162 wxClientDC dc (GetParent());
163 dc.SetFont (wxSWISS_FONT->Bold());
165 _column_widths.clear ();
166 _column_widths.reserve (_output_channels.size());
167 _column_widths_total = 0;
169 for (auto const& i: _output_channels) {
172 dc.GetTextExtent (std_to_wx(i.name), &width, &height);
173 auto const this_width = max(width + COLUMN_PADDING, MINIMUM_COLUMN_WIDTH);
174 _column_widths.push_back (this_width);
175 _column_widths_total += this_width;
178 _horizontal_scroll->SetScrollbar (
179 _horizontal_scroll->GetThumbPosition(),
180 s.GetWidth() - w - 8,
181 LEFT_WIDTH + _column_widths_total,
182 HORIZONTAL_PAGE_SIZE,
188 AudioMappingView::scroll ()
195 AudioMappingView::paint_static (wxDC& dc)
197 dc.SetFont (wxSWISS_FONT->Bold());
199 wxCoord label_height;
201 dc.GetTextExtent (_top_label, &label_width, &label_height);
202 dc.DrawText (_top_label, LEFT_WIDTH + (_column_widths_total - label_width) / 2, (ROW_HEIGHT - label_height) / 2);
204 dc.GetTextExtent (_left_label, &label_width, &label_height);
207 (ROW_HEIGHT - label_height) / 2,
208 TOP_HEIGHT + (_input_channels.size() * ROW_HEIGHT + label_width) / 2,
212 dc.SetFont (*wxSWISS_FONT);
217 AudioMappingView::paint_column_labels (wxDC& dc)
220 wxCoord label_height;
222 for (auto i = 0U; i < _output_channels.size(); ++i) {
223 auto const name = std_to_wx(_output_channels[i].name);
224 dc.GetTextExtent (name, &label_width, &label_height);
225 dc.DrawText (name, x + (_column_widths[i] - label_width) / 2, ROW_HEIGHT + (ROW_HEIGHT - label_height) / 2);
226 x += _column_widths[i];
229 dc.DrawLine(wxPoint(LEFT_WIDTH, ROW_HEIGHT), wxPoint(LEFT_WIDTH + _column_widths_total, ROW_HEIGHT));
230 dc.DrawLine(wxPoint(LEFT_WIDTH, ROW_HEIGHT * 2), wxPoint(LEFT_WIDTH + _column_widths_total, ROW_HEIGHT * 2));
235 AudioMappingView::paint_column_lines (wxDC& dc)
238 for (size_t i = 0; i < _output_channels.size(); ++i) {
240 wxPoint(x, ROW_HEIGHT),
241 wxPoint(x, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
243 x += _column_widths[i];
247 wxPoint(LEFT_WIDTH + _column_widths_total, ROW_HEIGHT),
248 wxPoint(LEFT_WIDTH + _column_widths_total, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
254 AudioMappingView::paint_row_labels (wxDC& dc)
257 wxCoord label_height;
259 /* Row channel labels */
261 for (auto i = 0U; i < _input_channels.size(); ++i) {
262 auto const name = std_to_wx(_input_channels[i].name);
263 dc.GetTextExtent (name, &label_width, &label_height);
264 dc.DrawText (name, LEFT_WIDTH - MINIMUM_COLUMN_WIDTH + (MINIMUM_COLUMN_WIDTH - label_width) / 2, TOP_HEIGHT + ROW_HEIGHT * i + (ROW_HEIGHT - label_height) / 2);
267 /* Vertical lines on the left */
269 for (int i = 1; i < 3; ++i) {
271 wxPoint(MINIMUM_COLUMN_WIDTH * i, TOP_HEIGHT),
272 wxPoint(MINIMUM_COLUMN_WIDTH * i, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
277 for (auto const& i: _input_groups) {
278 dc.DrawLine (wxPoint(MINIMUM_COLUMN_WIDTH, y), wxPoint(MINIMUM_COLUMN_WIDTH * 2, y));
279 y += (i.to - i.from + 1) * ROW_HEIGHT;
281 dc.DrawLine (wxPoint(MINIMUM_COLUMN_WIDTH, y), wxPoint(MINIMUM_COLUMN_WIDTH * 2, y));
283 if (_input_groups.empty()) {
284 auto const bottom = TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT;
285 dc.DrawLine(wxPoint(MINIMUM_COLUMN_WIDTH, bottom), wxPoint(MINIMUM_COLUMN_WIDTH * 2, bottom));
288 /* Group labels and lines; be careful here as wxDCClipper does not restore the old
289 * clipping rectangle after it is destroyed
292 for (auto const& i: _input_groups) {
293 int const height = (i.to - i.from + 1) * ROW_HEIGHT;
294 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
295 if (label_width > height) {
296 label_width = height - 8;
300 wxDCClipper clip (dc, wxRect(MINIMUM_COLUMN_WIDTH, y, ROW_HEIGHT, height));
302 if ((yp - 2 * ROW_HEIGHT) < dc.GetLogicalOrigin().y) {
303 yp += dc.GetLogicalOrigin().y;
308 ROW_HEIGHT + (ROW_HEIGHT - label_height) / 2,
309 y + (height + label_width) / 2,
320 AudioMappingView::paint_row_lines (wxDC& dc)
322 for (size_t i = 0; i < _input_channels.size(); ++i) {
324 wxPoint(MINIMUM_COLUMN_WIDTH * 2, TOP_HEIGHT + ROW_HEIGHT * i),
325 wxPoint(LEFT_WIDTH + _column_widths_total, TOP_HEIGHT + ROW_HEIGHT * i)
329 wxPoint(MINIMUM_COLUMN_WIDTH * 2, TOP_HEIGHT + ROW_HEIGHT * _input_channels.size()),
330 wxPoint(LEFT_WIDTH + _column_widths_total, TOP_HEIGHT + ROW_HEIGHT * _input_channels.size())
336 AudioMappingView::paint_indicators (wxDC& dc)
338 /* _{input,output}_channels and _map may not always be in sync, be careful here */
339 size_t const output = min(_output_channels.size(), size_t(_map.output_channels()));
340 size_t const input = min(_input_channels.size(), size_t(_map.input_channels()));
343 for (size_t x = 0; x < output; ++x) {
344 for (size_t y = 0; y < input; ++y) {
345 dc.SetBrush (*wxWHITE_BRUSH);
348 xp + (_column_widths[x] - INDICATOR_SIZE) / 2,
349 TOP_HEIGHT + y * ROW_HEIGHT + (ROW_HEIGHT - INDICATOR_SIZE) / 2,
350 INDICATOR_SIZE, INDICATOR_SIZE
354 float const value_dB = linear_to_db(_map.get(_input_channels[y].index, _output_channels[x].index));
355 auto const colour = value_dB <= 0 ? wxColour(0, 255, 0) : wxColour(255, 150, 0);
356 int const range = 18;
358 if (value_dB > -range) {
359 height = min(INDICATOR_SIZE, static_cast<int>(INDICATOR_SIZE * (1 + value_dB / range)));
362 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush(colour, wxBRUSHSTYLE_SOLID));
365 xp + (_column_widths[x] - INDICATOR_SIZE) / 2,
366 TOP_HEIGHT + y * ROW_HEIGHT + (ROW_HEIGHT - INDICATOR_SIZE) / 2 + INDICATOR_SIZE - height,
367 INDICATOR_SIZE, height
372 xp += _column_widths[x];
378 void restore (wxDC& dc)
380 dc.SetLogicalOrigin (0, 0);
381 dc.DestroyClippingRegion ();
386 AudioMappingView::paint ()
388 wxPaintDC dc (_body);
390 int const hs = _horizontal_scroll->GetThumbPosition ();
391 int const vs = _vertical_scroll->GetThumbPosition ();
395 dc.SetClippingRegion (
398 _column_widths_total,
399 ROW_HEIGHT * (2 + _input_channels.size())
401 dc.SetLogicalOrigin (hs, 0);
402 paint_column_labels (dc);
405 dc.SetClippingRegion(
409 min(int(ROW_HEIGHT * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT) + 1
411 dc.SetLogicalOrigin (0, vs);
412 paint_row_labels (dc);
415 dc.SetClippingRegion(
416 MINIMUM_COLUMN_WIDTH * 2,
418 MINIMUM_COLUMN_WIDTH + _column_widths_total,
419 min(int(ROW_HEIGHT * (2 + _input_channels.size())), GetSize().GetHeight() - TOP_HEIGHT)
421 dc.SetLogicalOrigin (hs, vs);
422 paint_row_lines (dc);
425 dc.SetClippingRegion(
427 MINIMUM_COLUMN_WIDTH,
428 MINIMUM_COLUMN_WIDTH + _column_widths_total,
429 min(int(ROW_HEIGHT * (1 + _input_channels.size())), GetSize().GetHeight() - ROW_HEIGHT)
431 dc.SetLogicalOrigin(hs, vs);
432 paint_column_lines (dc);
435 dc.SetClippingRegion (
438 _column_widths_total,
439 min(int(ROW_HEIGHT * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
441 dc.SetLogicalOrigin(hs, vs);
442 paint_indicators (dc);
447 optional<pair<NamedChannel, NamedChannel>>
448 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
450 int x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
451 int const y = ev.GetY() + _vertical_scroll->GetThumbPosition();
453 if (x <= LEFT_WIDTH || y < TOP_HEIGHT) {
457 int const input = (y - TOP_HEIGHT) / ROW_HEIGHT;
461 for (auto const i: _column_widths) {
469 if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
473 return make_pair(_input_channels[input], _output_channels[output]);
477 AudioMappingView::mouse_event_to_input_group_name (wxMouseEvent& ev) const
479 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
480 if (x < MINIMUM_COLUMN_WIDTH || x > (2 * MINIMUM_COLUMN_WIDTH)) {
484 int const y = (ev.GetY() + _vertical_scroll->GetThumbPosition() - TOP_HEIGHT) / ROW_HEIGHT;
485 for (auto i: _input_groups) {
486 if (i.from <= y && y <= i.to) {
495 AudioMappingView::left_down (wxMouseEvent& ev)
497 auto channels = mouse_event_to_channels (ev);
502 if (_map.get(channels->first.index, channels->second.index) > 0) {
503 _map.set (channels->first.index, channels->second.index, 0);
505 _map.set (channels->first.index, channels->second.index, 1);
508 map_values_changed ();
512 AudioMappingView::right_down (wxMouseEvent& ev)
514 auto channels = mouse_event_to_channels (ev);
519 _menu_input = channels->first.index;
520 _menu_output = channels->second.index;
521 PopupMenu (_menu, ev.GetPosition());
525 AudioMappingView::mouse_wheel (wxMouseEvent& ev)
527 if (ev.ShiftDown()) {
528 _horizontal_scroll->SetThumbPosition (
529 _horizontal_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -HORIZONTAL_PAGE_SIZE : HORIZONTAL_PAGE_SIZE)
533 _vertical_scroll->SetThumbPosition (
534 _vertical_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -ROW_HEIGHT : ROW_HEIGHT)
540 /** Called when any gain value has changed */
542 AudioMappingView::map_values_changed ()
545 _last_tooltip_channels = boost::none;
550 AudioMappingView::set_gain_from_menu (double linear)
552 _map.set (_menu_input, _menu_output, linear);
553 map_values_changed ();
557 AudioMappingView::edit ()
559 auto dialog = make_wx<AudioGainDialog>(this, _menu_input, _menu_output, _map.get(_menu_input, _menu_output));
560 if (dialog->ShowModal() == wxID_OK) {
561 _map.set (_menu_input, _menu_output, dialog->value ());
562 map_values_changed ();
567 AudioMappingView::set (AudioMapping map)
574 AudioMappingView::set_input_channels (vector<NamedChannel> const& channels)
576 _input_channels = channels;
582 AudioMappingView::set_output_channels (vector<NamedChannel> const & channels)
584 _output_channels = channels;
591 AudioMappingView::input_channel_name_with_group (NamedChannel const& n) const
593 optional<wxString> group;
594 for (auto i: _input_groups) {
595 if (i.from <= n.index && n.index <= i.to) {
596 group = std_to_wx (i.name);
600 if (group && !group->IsEmpty()) {
601 return wxString::Format ("%s/%s", group->data(), std_to_wx(n.name).data());
604 return std_to_wx(n.name);
609 AudioMappingView::motion (wxMouseEvent& ev)
611 auto channels = mouse_event_to_channels (ev);
613 if (channels != _last_tooltip_channels) {
615 auto const gain = _map.get(channels->first.index, channels->second.index);
617 s = wxString::Format (
618 _("No audio will be passed from %s channel '%s' to %s channel '%s'."),
620 input_channel_name_with_group(channels->first),
622 std_to_wx(channels->second.name)
624 } else if (gain == 1) {
625 s = wxString::Format (
626 _("Audio will be passed from %s channel %s to %s channel %s unaltered."),
628 input_channel_name_with_group(channels->first),
630 std_to_wx(channels->second.name)
633 auto const dB = linear_to_db(gain);
634 s = wxString::Format (
635 _("Audio will be passed from %s channel %s to %s channel %s with gain %.1fdB."),
637 input_channel_name_with_group(channels->first),
639 std_to_wx(channels->second.name),
644 SetToolTip (s + " " + _("Right click to change gain."));
647 auto group = mouse_event_to_input_group_name (ev);
649 SetToolTip (std_to_wx(*group));
655 _last_tooltip_channels = channels;
660 AudioMappingView::set_input_groups (vector<Group> const & groups)
662 _input_groups = groups;