2 Copyright (C) 2013-2020 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
39 #include <boost/foreach.hpp>
50 using std::shared_ptr;
51 using boost::optional;
52 #if BOOST_VERSION >= 106100
53 using namespace boost::placeholders;
55 using dcp::locale_convert;
57 #define INDICATOR_SIZE 20
58 #define GRID_SPACING 32
59 #define LEFT_WIDTH (GRID_SPACING * 3)
60 #define TOP_HEIGHT (GRID_SPACING * 2)
70 AudioMappingView::AudioMappingView (wxWindow* parent, wxString left_label, wxString from, wxString top_label, wxString to)
71 : wxPanel (parent, wxID_ANY)
74 , _left_label (left_label)
76 , _top_label (top_label)
80 _menu->Append (ID_off, _("Off"));
81 _menu->Append (ID_minus6dB, _("-6dB"));
82 _menu->Append (ID_0dB, _("0dB (unchanged)"));
83 _menu->Append (ID_plus3dB, _("+3dB"));
84 _menu->Append (ID_edit, _("Edit..."));
86 _body = new wxPanel (this, wxID_ANY);
87 _vertical_scroll = new wxScrollBar (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSB_VERTICAL);
88 _horizontal_scroll = new wxScrollBar (this, wxID_ANY);
91 SetDoubleBuffered (true);
94 Bind (wxEVT_SIZE, boost::bind(&AudioMappingView::size, this, _1));
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_MOUSEWHEEL, boost::bind(&AudioMappingView::mouse_wheel, this, _1));
101 _body->Bind (wxEVT_PAINT, boost::bind(&AudioMappingView::paint, this));
102 _body->Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioMappingView::left_down, this, _1));
103 _body->Bind (wxEVT_RIGHT_DOWN, boost::bind(&AudioMappingView::right_down, this, _1));
104 _body->Bind (wxEVT_MOTION, boost::bind(&AudioMappingView::motion, this, _1));
105 _vertical_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
106 _vertical_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
107 _vertical_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
108 _vertical_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
109 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
110 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
111 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
112 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
113 _horizontal_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
114 _horizontal_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
115 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
116 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
117 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
118 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
119 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
120 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
124 AudioMappingView::size (wxSizeEvent& ev)
131 AudioMappingView::setup ()
133 wxSize const s = GetSize();
134 int const w = _vertical_scroll->GetSize().GetWidth();
135 int const h = _horizontal_scroll->GetSize().GetHeight();
137 _vertical_scroll->SetPosition (wxPoint(s.GetWidth() - w, 0));
138 _vertical_scroll->SetSize (wxSize(w, max(0, s.GetHeight() - h)));
140 _body->SetSize (wxSize(max(0, s.GetWidth() - w), max(0, s.GetHeight() - h)));
142 _horizontal_scroll->SetPosition (wxPoint(0, s.GetHeight() - h));
143 _horizontal_scroll->SetSize (wxSize(max(0, s.GetWidth() - w), h));
145 _vertical_scroll->SetScrollbar (
146 _vertical_scroll->GetThumbPosition(),
147 s.GetHeight() - h - 8,
148 GRID_SPACING * (2 + _input_channels.size()),
153 _horizontal_scroll->SetScrollbar (
154 _horizontal_scroll->GetThumbPosition(),
155 s.GetWidth() - w - 8,
156 GRID_SPACING * (3 + _output_channels.size()),
162 AudioMappingView::scroll ()
168 AudioMappingView::paint_static (wxDC& dc)
170 dc.SetFont (wxSWISS_FONT->Bold());
172 wxCoord label_height;
174 dc.GetTextExtent (_top_label, &label_width, &label_height);
175 dc.DrawText (_top_label, LEFT_WIDTH + (_output_channels.size() * GRID_SPACING - label_width) / 2, (GRID_SPACING - label_height) / 2);
177 dc.GetTextExtent (_left_label, &label_width, &label_height);
180 (GRID_SPACING - label_height) / 2,
181 TOP_HEIGHT + (_input_channels.size() * GRID_SPACING + label_width) / 2,
185 dc.SetFont (*wxSWISS_FONT);
189 AudioMappingView::paint_column_labels (wxDC& dc)
192 wxCoord label_height;
194 BOOST_FOREACH (NamedChannel const& i, _output_channels) {
195 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
196 dc.DrawText (std_to_wx(i.name), LEFT_WIDTH + GRID_SPACING * N + (GRID_SPACING - label_width) / 2, GRID_SPACING + (GRID_SPACING - label_height) / 2);
200 dc.DrawLine(wxPoint(LEFT_WIDTH, GRID_SPACING), wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, GRID_SPACING));
201 dc.DrawLine(wxPoint(LEFT_WIDTH, GRID_SPACING * 2), wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, GRID_SPACING * 2));
205 AudioMappingView::paint_column_lines (wxDC& dc)
207 for (size_t i = 0; i < _output_channels.size(); ++i) {
209 wxPoint(LEFT_WIDTH + GRID_SPACING * i, GRID_SPACING),
210 wxPoint(LEFT_WIDTH + GRID_SPACING * i, TOP_HEIGHT + _input_channels.size() * GRID_SPACING)
215 wxPoint(LEFT_WIDTH + GRID_SPACING * _output_channels.size(), GRID_SPACING),
216 wxPoint(LEFT_WIDTH + GRID_SPACING * _output_channels.size(), TOP_HEIGHT + _input_channels.size() * GRID_SPACING)
221 AudioMappingView::paint_row_labels (wxDC& dc)
224 wxCoord label_height;
226 /* Row channel labels */
229 BOOST_FOREACH (NamedChannel const& i, _input_channels) {
230 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
231 dc.DrawText (std_to_wx(i.name), GRID_SPACING * 2 + (GRID_SPACING - label_width) / 2, TOP_HEIGHT + GRID_SPACING * N + (GRID_SPACING - label_height) / 2);
235 /* Vertical lines on the left */
237 for (int i = 1; i < 3; ++i) {
239 wxPoint(GRID_SPACING * i, TOP_HEIGHT),
240 wxPoint(GRID_SPACING * i, TOP_HEIGHT + _input_channels.size() * GRID_SPACING)
244 /* Group labels and lines */
247 BOOST_FOREACH (Group i, _input_groups) {
248 int const height = (i.to - i.from + 1) * GRID_SPACING;
249 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
250 if (label_width > height) {
251 label_width = height - 8;
255 wxDCClipper clip (dc, wxRect(GRID_SPACING, y, GRID_SPACING, height));
257 if ((yp - 2 * GRID_SPACING) < dc.GetLogicalOrigin().y) {
258 yp += dc.GetLogicalOrigin().y;
263 GRID_SPACING + (GRID_SPACING - label_height) / 2,
264 y + (height + label_width) / 2,
269 dc.DrawLine (wxPoint(GRID_SPACING, y), wxPoint(GRID_SPACING * 2, y));
273 dc.DrawLine (wxPoint(GRID_SPACING, y), wxPoint(GRID_SPACING * 2, y));
277 AudioMappingView::paint_row_lines (wxDC& dc)
279 for (size_t i = 0; i < _input_channels.size(); ++i) {
281 wxPoint(GRID_SPACING * 2, TOP_HEIGHT + GRID_SPACING * i),
282 wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, TOP_HEIGHT + GRID_SPACING * i)
286 wxPoint(GRID_SPACING * 2, TOP_HEIGHT + GRID_SPACING * _input_channels.size()),
287 wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, TOP_HEIGHT + GRID_SPACING * _input_channels.size())
292 AudioMappingView::paint_indicators (wxDC& dc)
294 /* _{input,output}_channels and _map may not always be in sync, be careful here */
295 size_t const output = min(_output_channels.size(), size_t(_map.output_channels()));
296 size_t const input = min(_input_channels.size(), size_t(_map.input_channels()));
298 for (size_t x = 0; x < output; ++x) {
299 for (size_t y = 0; y < input; ++y) {
300 dc.SetBrush (*wxWHITE_BRUSH);
303 LEFT_WIDTH + x * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
304 TOP_HEIGHT + y * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
305 INDICATOR_SIZE, INDICATOR_SIZE
309 float const value_dB = linear_to_db(_map.get(_input_channels[y].index, _output_channels[x].index));
310 wxColour const colour = value_dB <= 0 ? wxColour(0, 255, 0) : wxColour(255, 150, 0);
311 int const range = 18;
313 if (value_dB > -range) {
314 height = min(INDICATOR_SIZE, static_cast<int>(INDICATOR_SIZE * (1 + value_dB / range)));
317 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush(colour, wxBRUSHSTYLE_SOLID));
320 LEFT_WIDTH + x * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
321 TOP_HEIGHT + y * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2 + INDICATOR_SIZE - height,
322 INDICATOR_SIZE, height
330 void clip (wxDC& dc, int x, int y, int w, int h)
332 dc.SetClippingRegion (x, y, w, h);
336 void translate (wxDC& dc, int x, int y)
338 dc.SetLogicalOrigin (x, y);
342 void restore (wxDC& dc)
344 dc.SetLogicalOrigin (0, 0);
345 dc.DestroyClippingRegion ();
349 AudioMappingView::paint ()
351 wxPaintDC dc (_body);
353 int const hs = _horizontal_scroll->GetThumbPosition ();
354 int const vs = _vertical_scroll->GetThumbPosition ();
362 GRID_SPACING * _output_channels.size(),
363 GRID_SPACING * (2 + _input_channels.size())
365 translate (dc, hs, 0);
366 paint_column_labels (dc);
374 min(int(GRID_SPACING * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
376 translate (dc, 0, vs);
377 paint_row_labels (dc);
384 GRID_SPACING * (1 + _output_channels.size()),
385 min(int(GRID_SPACING * (2 + _input_channels.size())), GetSize().GetHeight() - TOP_HEIGHT)
387 translate (dc, hs, vs);
388 paint_row_lines (dc);
395 GRID_SPACING * (1 + _output_channels.size()),
396 min(int(GRID_SPACING * (1 + _input_channels.size())), GetSize().GetHeight() - GRID_SPACING)
398 translate (dc, hs, vs);
399 paint_column_lines (dc);
406 GRID_SPACING * _output_channels.size(),
407 min(int(GRID_SPACING * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
409 translate (dc, hs, vs);
410 paint_indicators (dc);
414 optional<pair<NamedChannel, NamedChannel> >
415 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
417 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
418 int const y = ev.GetY() + _vertical_scroll->GetThumbPosition();
420 if (x <= LEFT_WIDTH || y < TOP_HEIGHT) {
421 return optional<pair<NamedChannel, NamedChannel> >();
424 int const input = (y - TOP_HEIGHT) / GRID_SPACING;
425 int const output = (x - LEFT_WIDTH) / GRID_SPACING;
427 if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
428 return optional<pair<NamedChannel, NamedChannel> >();
431 return make_pair (_input_channels[input], _output_channels[output]);
435 AudioMappingView::mouse_event_to_input_group_name (wxMouseEvent& ev) const
437 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
438 if (x < GRID_SPACING || x > (2 * GRID_SPACING)) {
439 return optional<string>();
442 int y = (ev.GetY() + _vertical_scroll->GetThumbPosition() - (GRID_SPACING * 2)) / GRID_SPACING;
443 BOOST_FOREACH (Group i, _input_groups) {
444 if (i.from <= y && y <= i.to) {
449 return optional<string>();
453 AudioMappingView::left_down (wxMouseEvent& ev)
455 optional<pair<NamedChannel, NamedChannel> > channels = mouse_event_to_channels (ev);
460 if (_map.get(channels->first.index, channels->second.index) > 0) {
461 _map.set (channels->first.index, channels->second.index, 0);
463 _map.set (channels->first.index, channels->second.index, 1);
466 map_values_changed ();
470 AudioMappingView::right_down (wxMouseEvent& ev)
472 optional<pair<NamedChannel, NamedChannel> > channels = mouse_event_to_channels (ev);
477 _menu_input = channels->first.index;
478 _menu_output = channels->second.index;
479 PopupMenu (_menu, ev.GetPosition());
483 AudioMappingView::mouse_wheel (wxMouseEvent& ev)
485 if (ev.ShiftDown()) {
486 _horizontal_scroll->SetThumbPosition (
487 _horizontal_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -GRID_SPACING : GRID_SPACING)
491 _vertical_scroll->SetThumbPosition (
492 _vertical_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -GRID_SPACING : GRID_SPACING)
498 /** Called when any gain value has changed */
500 AudioMappingView::map_values_changed ()
503 _last_tooltip_channels = optional<pair<NamedChannel, NamedChannel> >();
508 AudioMappingView::set_gain_from_menu (double linear)
510 _map.set (_menu_input, _menu_output, linear);
511 map_values_changed ();
515 AudioMappingView::edit ()
517 AudioGainDialog* dialog = new AudioGainDialog (this, _menu_input, _menu_output, _map.get(_menu_input, _menu_output));
518 if (dialog->ShowModal() == wxID_OK) {
519 _map.set (_menu_input, _menu_output, dialog->value ());
520 map_values_changed ();
527 AudioMappingView::set (AudioMapping map)
534 AudioMappingView::set_input_channels (vector<NamedChannel> const& channels)
536 _input_channels = channels;
542 AudioMappingView::set_output_channels (vector<NamedChannel> const & channels)
544 _output_channels = channels;
551 AudioMappingView::input_channel_name_with_group (NamedChannel const& n) const
553 optional<wxString> group;
554 BOOST_FOREACH (Group i, _input_groups) {
555 if (i.from <= n.index && n.index <= i.to) {
556 group = std_to_wx (i.name);
560 if (group && !group->IsEmpty()) {
561 return wxString::Format ("%s/%s", group->data(), std_to_wx(n.name).data());
564 return std_to_wx(n.name);
569 AudioMappingView::motion (wxMouseEvent& ev)
571 optional<pair<NamedChannel, NamedChannel> > channels = mouse_event_to_channels (ev);
573 if (channels != _last_tooltip_channels) {
575 float const gain = _map.get(channels->first.index, channels->second.index);
577 s = wxString::Format (
578 _("No audio will be passed from %s channel '%s' to %s channel '%s'."),
580 input_channel_name_with_group(channels->first),
582 std_to_wx(channels->second.name)
584 } else if (gain == 1) {
585 s = wxString::Format (
586 _("Audio will be passed from %s channel %s to %s channel %s unaltered."),
588 input_channel_name_with_group(channels->first),
590 std_to_wx(channels->second.name)
593 float const dB = linear_to_db(gain);
594 s = wxString::Format (
595 _("Audio will be passed from %s channel %s to %s channel %s with gain %.1fdB."),
597 input_channel_name_with_group(channels->first),
599 std_to_wx(channels->second.name),
604 SetToolTip (s + " " + _("Right click to change gain."));
607 optional<string> group = mouse_event_to_input_group_name (ev);
609 SetToolTip (std_to_wx(*group));
615 _last_tooltip_channels = channels;
620 AudioMappingView::set_input_groups (vector<Group> const & groups)
622 _input_groups = groups;