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 TOP_HEIGHT = ROW_HEIGHT * 2;
63 static constexpr auto COLUMN_PADDING = 16;
67 ID_off = DCPOMATIC_AUDIO_GAIN_MENU,
75 AudioMappingView::AudioMappingView (wxWindow* parent, wxString left_label, wxString from, wxString top_label, wxString to)
76 : wxPanel (parent, wxID_ANY)
79 , _left_label (left_label)
81 , _top_label (top_label)
85 _menu->Append (ID_off, _("Off"));
86 _menu->Append (ID_minus6dB, _("-6dB"));
87 _menu->Append (ID_0dB, _("0dB (unchanged)"));
88 _menu->Append (ID_plus3dB, _("+3dB"));
89 _menu->Append (ID_edit, _("Edit..."));
92 SetDoubleBuffered (true);
95 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 0), ID_off);
96 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(-6)), ID_minus6dB);
97 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 1), ID_0dB);
98 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(3)), ID_plus3dB);
99 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::edit, this), ID_edit);
100 Bind (wxEVT_PAINT, boost::bind(&AudioMappingView::paint, this));
101 Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioMappingView::left_down, this, _1));
102 Bind (wxEVT_RIGHT_DOWN, boost::bind(&AudioMappingView::right_down, this, _1));
103 Bind (wxEVT_MOTION, boost::bind(&AudioMappingView::motion, this, _1));
108 AudioMappingView::setup ()
110 wxClientDC dc (GetParent());
111 dc.SetFont (wxSWISS_FONT->Bold());
113 _column_widths.clear ();
114 _column_widths.reserve (_output_channels.size());
115 _column_widths_total = 0;
117 for (auto const& i: _output_channels) {
120 dc.GetTextExtent (std_to_wx(i.name), &width, &height);
121 auto const this_width = max(width + COLUMN_PADDING, MINIMUM_COLUMN_WIDTH);
122 _column_widths.push_back (this_width);
123 _column_widths_total += this_width;
126 SetMinSize({8 + left_width() + _column_widths_total, static_cast<int>(8 + TOP_HEIGHT + ROW_HEIGHT * _input_channels.size())});
131 AudioMappingView::paint_static (wxDC& dc)
133 dc.SetFont (wxSWISS_FONT->Bold());
135 wxCoord label_height;
137 dc.GetTextExtent (_top_label, &label_width, &label_height);
138 dc.DrawText (_top_label, left_width() + (_column_widths_total - label_width) / 2, (ROW_HEIGHT - label_height) / 2);
140 dc.GetTextExtent (_left_label, &label_width, &label_height);
143 (ROW_HEIGHT - label_height) / 2,
144 TOP_HEIGHT + (_input_channels.size() * ROW_HEIGHT + label_width) / 2,
148 dc.SetFont (*wxSWISS_FONT);
153 AudioMappingView::paint_column_labels (wxDC& dc)
156 wxCoord label_height;
157 int x = left_width();
158 for (auto i = 0U; i < _output_channels.size(); ++i) {
159 auto const name = std_to_wx(_output_channels[i].name);
160 dc.GetTextExtent (name, &label_width, &label_height);
161 dc.DrawText (name, x + (_column_widths[i] - label_width) / 2, ROW_HEIGHT + (ROW_HEIGHT - label_height) / 2);
162 x += _column_widths[i];
165 dc.DrawLine(wxPoint(left_width(), ROW_HEIGHT), wxPoint(left_width() + _column_widths_total, ROW_HEIGHT));
166 dc.DrawLine(wxPoint(left_width(), ROW_HEIGHT * 2), wxPoint(left_width() + _column_widths_total, ROW_HEIGHT * 2));
171 AudioMappingView::paint_column_lines (wxDC& dc)
173 int x = left_width();
174 for (size_t i = 0; i < _output_channels.size(); ++i) {
176 wxPoint(x, ROW_HEIGHT),
177 wxPoint(x, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
179 x += _column_widths[i];
183 wxPoint(left_width() + _column_widths_total, ROW_HEIGHT),
184 wxPoint(left_width() + _column_widths_total, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
190 AudioMappingView::paint_row_labels (wxDC& dc)
193 wxCoord label_height;
195 /* Row channel labels */
197 for (auto i = 0U; i < _input_channels.size(); ++i) {
198 auto const name = std_to_wx(_input_channels[i].name);
199 dc.GetTextExtent (name, &label_width, &label_height);
200 dc.DrawText (name, left_width() - MINIMUM_COLUMN_WIDTH + (MINIMUM_COLUMN_WIDTH - label_width) / 2, TOP_HEIGHT + ROW_HEIGHT * i + (ROW_HEIGHT - label_height) / 2);
203 /* Vertical lines on the left */
205 for (int i = 1; i < 3; ++i) {
207 wxPoint(MINIMUM_COLUMN_WIDTH * i, TOP_HEIGHT),
208 wxPoint(MINIMUM_COLUMN_WIDTH * i, TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT)
213 for (auto const& i: _input_groups) {
214 dc.DrawLine (wxPoint(MINIMUM_COLUMN_WIDTH, y), wxPoint(MINIMUM_COLUMN_WIDTH * 2, y));
215 y += (i.to - i.from + 1) * ROW_HEIGHT;
217 dc.DrawLine (wxPoint(MINIMUM_COLUMN_WIDTH, y), wxPoint(MINIMUM_COLUMN_WIDTH * 2, y));
219 if (_input_groups.empty()) {
220 auto const bottom = TOP_HEIGHT + _input_channels.size() * ROW_HEIGHT;
221 dc.DrawLine(wxPoint(MINIMUM_COLUMN_WIDTH, bottom), wxPoint(MINIMUM_COLUMN_WIDTH * 2, bottom));
224 /* Group labels and lines; be careful here as wxDCClipper does not restore the old
225 * clipping rectangle after it is destroyed
228 for (auto const& i: _input_groups) {
229 int const height = (i.to - i.from + 1) * ROW_HEIGHT;
230 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
231 if (label_width > height) {
232 label_width = height - 8;
236 wxDCClipper clip (dc, wxRect(MINIMUM_COLUMN_WIDTH, y, ROW_HEIGHT, height));
238 if ((yp - 2 * ROW_HEIGHT) < dc.GetLogicalOrigin().y) {
239 yp += dc.GetLogicalOrigin().y;
244 ROW_HEIGHT + (ROW_HEIGHT - label_height) / 2,
245 y + (height + label_width) / 2,
256 AudioMappingView::paint_row_lines (wxDC& dc)
258 for (size_t i = 0; i < _input_channels.size() + 1; ++i) {
260 wxPoint(MINIMUM_COLUMN_WIDTH * 2, TOP_HEIGHT + ROW_HEIGHT * i),
261 wxPoint(left_width() + _column_widths_total, TOP_HEIGHT + ROW_HEIGHT * i)
268 AudioMappingView::paint_indicators (wxDC& dc)
270 /* _{input,output}_channels and _map may not always be in sync, be careful here */
271 size_t const output = min(_output_channels.size(), size_t(_map.output_channels()));
272 size_t const input = min(_input_channels.size(), size_t(_map.input_channels()));
274 int xp = left_width();
275 for (size_t x = 0; x < output; ++x) {
276 for (size_t y = 0; y < input; ++y) {
277 dc.SetBrush (*wxWHITE_BRUSH);
280 xp + (_column_widths[x] - INDICATOR_SIZE) / 2,
281 TOP_HEIGHT + y * ROW_HEIGHT + (ROW_HEIGHT - INDICATOR_SIZE) / 2,
282 INDICATOR_SIZE, INDICATOR_SIZE
286 float const value_dB = linear_to_db(_map.get(_input_channels[y].index, _output_channels[x].index));
287 auto const colour = value_dB <= 0 ? wxColour(0, 255, 0) : wxColour(255, 150, 0);
288 int const range = 18;
290 if (value_dB > -range) {
291 height = min(INDICATOR_SIZE, static_cast<int>(INDICATOR_SIZE * (1 + value_dB / range)));
294 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush(colour, wxBRUSHSTYLE_SOLID));
297 xp + (_column_widths[x] - INDICATOR_SIZE) / 2,
298 TOP_HEIGHT + y * ROW_HEIGHT + (ROW_HEIGHT - INDICATOR_SIZE) / 2 + INDICATOR_SIZE - height,
299 INDICATOR_SIZE, height
304 xp += _column_widths[x];
310 void restore (wxDC& dc)
312 dc.SetLogicalOrigin (0, 0);
313 dc.DestroyClippingRegion ();
318 AudioMappingView::paint ()
324 dc.SetClippingRegion (
327 _column_widths_total,
328 ROW_HEIGHT * (2 + _input_channels.size())
330 paint_column_labels (dc);
333 dc.SetClippingRegion(
337 min(int(ROW_HEIGHT * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT) + 1
339 paint_row_labels (dc);
342 dc.SetClippingRegion(
343 MINIMUM_COLUMN_WIDTH * 2,
345 MINIMUM_COLUMN_WIDTH + _column_widths_total,
346 min(int(ROW_HEIGHT * (2 + _input_channels.size())), GetSize().GetHeight() - TOP_HEIGHT)
348 paint_row_lines (dc);
351 dc.SetClippingRegion(
353 MINIMUM_COLUMN_WIDTH,
354 MINIMUM_COLUMN_WIDTH + _column_widths_total,
355 min(int(ROW_HEIGHT * (1 + _input_channels.size())), GetSize().GetHeight() - ROW_HEIGHT)
357 paint_column_lines (dc);
360 dc.SetClippingRegion (
363 _column_widths_total,
364 min(int(ROW_HEIGHT * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
366 paint_indicators (dc);
371 optional<pair<NamedChannel, NamedChannel>>
372 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
375 int const y = ev.GetY();
377 if (x <= left_width() || y < TOP_HEIGHT) {
381 int const input = (y - TOP_HEIGHT) / ROW_HEIGHT;
385 for (auto const i: _column_widths) {
393 if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
397 return make_pair(_input_channels[input], _output_channels[output]);
401 AudioMappingView::mouse_event_to_input_group_name (wxMouseEvent& ev) const
403 int const x = ev.GetX();
404 if (x < MINIMUM_COLUMN_WIDTH || x > (2 * MINIMUM_COLUMN_WIDTH)) {
408 int const y = (ev.GetY() - TOP_HEIGHT) / ROW_HEIGHT;
409 for (auto i: _input_groups) {
410 if (i.from <= y && y <= i.to) {
419 AudioMappingView::left_down (wxMouseEvent& ev)
421 auto channels = mouse_event_to_channels (ev);
426 if (_map.get(channels->first.index, channels->second.index) > 0) {
427 _map.set (channels->first.index, channels->second.index, 0);
429 _map.set (channels->first.index, channels->second.index, 1);
432 map_values_changed ();
436 AudioMappingView::right_down (wxMouseEvent& ev)
438 auto channels = mouse_event_to_channels (ev);
443 _menu_input = channels->first.index;
444 _menu_output = channels->second.index;
445 PopupMenu (_menu, ev.GetPosition());
449 /** Called when any gain value has changed */
451 AudioMappingView::map_values_changed ()
454 _last_tooltip_channels = boost::none;
459 AudioMappingView::set_gain_from_menu (double linear)
461 _map.set (_menu_input, _menu_output, linear);
462 map_values_changed ();
466 AudioMappingView::edit ()
468 auto dialog = make_wx<AudioGainDialog>(this, _menu_input, _menu_output, _map.get(_menu_input, _menu_output));
469 if (dialog->ShowModal() == wxID_OK) {
470 _map.set (_menu_input, _menu_output, dialog->value ());
471 map_values_changed ();
476 AudioMappingView::set (AudioMapping map)
483 AudioMappingView::set_input_channels (vector<NamedChannel> const& channels)
485 _input_channels = channels;
491 AudioMappingView::set_output_channels (vector<NamedChannel> const & channels)
493 _output_channels = channels;
500 AudioMappingView::input_channel_name_with_group (NamedChannel const& n) const
502 optional<wxString> group;
503 for (auto i: _input_groups) {
504 if (i.from <= n.index && n.index <= i.to) {
505 group = std_to_wx (i.name);
509 if (group && !group->IsEmpty()) {
510 return wxString::Format ("%s/%s", group->data(), std_to_wx(n.name).data());
513 return std_to_wx(n.name);
518 AudioMappingView::motion (wxMouseEvent& ev)
520 auto channels = mouse_event_to_channels (ev);
522 if (channels != _last_tooltip_channels) {
524 auto const gain = _map.get(channels->first.index, channels->second.index);
526 s = wxString::Format (
527 _("No audio will be passed from %s channel '%s' to %s channel '%s'."),
529 input_channel_name_with_group(channels->first),
531 std_to_wx(channels->second.name)
533 } else if (gain == 1) {
534 s = wxString::Format (
535 _("Audio will be passed from %s channel %s to %s channel %s unaltered."),
537 input_channel_name_with_group(channels->first),
539 std_to_wx(channels->second.name)
542 auto const dB = linear_to_db(gain);
543 s = wxString::Format (
544 _("Audio will be passed from %s channel %s to %s channel %s with gain %.1fdB."),
546 input_channel_name_with_group(channels->first),
548 std_to_wx(channels->second.name),
553 SetToolTip (s + " " + _("Right click to change gain."));
556 auto group = mouse_event_to_input_group_name (ev);
558 SetToolTip (std_to_wx(*group));
564 _last_tooltip_channels = channels;
569 AudioMappingView::set_input_groups (vector<Group> const & groups)
571 _input_groups = groups;
576 AudioMappingView::left_width() const
578 return _input_groups.empty() ? (MINIMUM_COLUMN_WIDTH * 2) : (MINIMUM_COLUMN_WIDTH * 3);