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 boost::shared_ptr;
51 using boost::optional;
52 using dcp::locale_convert;
54 #define INDICATOR_SIZE 20
55 #define GRID_SPACING 32
56 #define LEFT_WIDTH (GRID_SPACING * 3)
57 #define TOP_HEIGHT (GRID_SPACING * 2)
67 AudioMappingView::AudioMappingView (wxWindow* parent, wxString left_label, wxString from, wxString top_label, wxString to)
68 : wxPanel (parent, wxID_ANY)
71 , _left_label (left_label)
73 , _top_label (top_label)
77 _menu->Append (ID_off, _("Off"));
78 _menu->Append (ID_minus6dB, _("-6dB"));
79 _menu->Append (ID_0dB, _("0dB (unchanged)"));
80 _menu->Append (ID_plus3dB, _("+3dB"));
81 _menu->Append (ID_edit, _("Edit..."));
83 _body = new wxPanel (this, wxID_ANY);
84 _vertical_scroll = new wxScrollBar (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSB_VERTICAL);
85 _horizontal_scroll = new wxScrollBar (this, wxID_ANY);
88 SetDoubleBuffered (true);
91 Bind (wxEVT_SIZE, boost::bind(&AudioMappingView::size, this, _1));
92 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 0), ID_off);
93 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(-6)), ID_minus6dB);
94 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, 1), ID_0dB);
95 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::set_gain_from_menu, this, db_to_linear(3)), ID_plus3dB);
96 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::edit, this), ID_edit);
97 Bind (wxEVT_MOUSEWHEEL, boost::bind(&AudioMappingView::mouse_wheel, this, _1));
98 _body->Bind (wxEVT_PAINT, boost::bind(&AudioMappingView::paint, this));
99 _body->Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioMappingView::left_down, this, _1));
100 _body->Bind (wxEVT_RIGHT_DOWN, boost::bind(&AudioMappingView::right_down, this, _1));
101 _body->Bind (wxEVT_MOTION, boost::bind(&AudioMappingView::motion, this, _1));
102 _vertical_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
103 _vertical_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
104 _vertical_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
105 _vertical_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
106 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
107 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
108 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
109 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
110 _horizontal_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
111 _horizontal_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
112 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
113 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
114 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
115 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
116 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
117 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
121 AudioMappingView::size (wxSizeEvent& ev)
128 AudioMappingView::setup ()
130 wxSize const s = GetSize();
131 int const w = _vertical_scroll->GetSize().GetWidth();
132 int const h = _horizontal_scroll->GetSize().GetHeight();
134 _vertical_scroll->SetPosition (wxPoint(s.GetWidth() - w, 0));
135 _vertical_scroll->SetSize (wxSize(w, max(0, s.GetHeight() - h)));
137 _body->SetSize (wxSize(max(0, s.GetWidth() - w), max(0, s.GetHeight() - h)));
139 _horizontal_scroll->SetPosition (wxPoint(0, s.GetHeight() - h));
140 _horizontal_scroll->SetSize (wxSize(max(0, s.GetWidth() - w), h));
142 _vertical_scroll->SetScrollbar (
143 _vertical_scroll->GetThumbPosition(),
144 s.GetHeight() - h - 8,
145 GRID_SPACING * (2 + _input_channels.size()),
150 _horizontal_scroll->SetScrollbar (
151 _horizontal_scroll->GetThumbPosition(),
152 s.GetWidth() - w - 8,
153 GRID_SPACING * (3 + _output_channels.size()),
159 AudioMappingView::scroll ()
165 AudioMappingView::paint_static (wxDC& dc)
167 dc.SetFont (wxSWISS_FONT->Bold());
169 wxCoord label_height;
171 dc.GetTextExtent (_top_label, &label_width, &label_height);
172 dc.DrawText (_top_label, LEFT_WIDTH + (_output_channels.size() * GRID_SPACING - label_width) / 2, (GRID_SPACING - label_height) / 2);
174 dc.GetTextExtent (_left_label, &label_width, &label_height);
177 (GRID_SPACING - label_height) / 2,
178 TOP_HEIGHT + (_input_channels.size() * GRID_SPACING + label_width) / 2,
182 dc.SetFont (*wxSWISS_FONT);
186 AudioMappingView::paint_column_labels (wxDC& dc)
189 wxCoord label_height;
191 BOOST_FOREACH (string i, _output_channels) {
192 dc.GetTextExtent (std_to_wx(i), &label_width, &label_height);
193 dc.DrawText (std_to_wx(i), LEFT_WIDTH + GRID_SPACING * N + (GRID_SPACING - label_width) / 2, GRID_SPACING + (GRID_SPACING - label_height) / 2);
197 dc.DrawLine(wxPoint(LEFT_WIDTH, GRID_SPACING), wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, GRID_SPACING));
198 dc.DrawLine(wxPoint(LEFT_WIDTH, GRID_SPACING * 2), wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, GRID_SPACING * 2));
202 AudioMappingView::paint_column_lines (wxDC& dc)
204 for (size_t i = 0; i < _output_channels.size(); ++i) {
206 wxPoint(LEFT_WIDTH + GRID_SPACING * i, GRID_SPACING),
207 wxPoint(LEFT_WIDTH + GRID_SPACING * i, TOP_HEIGHT + _input_channels.size() * GRID_SPACING)
212 wxPoint(LEFT_WIDTH + GRID_SPACING * _output_channels.size(), GRID_SPACING),
213 wxPoint(LEFT_WIDTH + GRID_SPACING * _output_channels.size(), TOP_HEIGHT + _input_channels.size() * GRID_SPACING)
218 AudioMappingView::paint_row_labels (wxDC& dc)
221 wxCoord label_height;
223 /* Row channel labels */
226 BOOST_FOREACH (string i, _input_channels) {
227 dc.GetTextExtent (std_to_wx(i), &label_width, &label_height);
228 dc.DrawText (std_to_wx(i), GRID_SPACING * 2 + (GRID_SPACING - label_width) / 2, TOP_HEIGHT + GRID_SPACING * N + (GRID_SPACING - label_height) / 2);
232 /* Vertical lines on the left */
234 for (int i = 1; i < 3; ++i) {
236 wxPoint(GRID_SPACING * i, TOP_HEIGHT),
237 wxPoint(GRID_SPACING * i, TOP_HEIGHT + _input_channels.size() * GRID_SPACING)
241 /* Group labels and lines */
244 BOOST_FOREACH (Group i, _input_groups) {
245 int const height = (i.to - i.from + 1) * GRID_SPACING;
246 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
247 if (label_width > height) {
248 label_width = height - 8;
253 if ((yp - 2 * GRID_SPACING) < dc.GetLogicalOrigin().y) {
254 yp += dc.GetLogicalOrigin().y;
259 GRID_SPACING + (GRID_SPACING - label_height) / 2,
260 y + (height + label_width) / 2,
265 dc.DrawLine (wxPoint(GRID_SPACING, y), wxPoint(GRID_SPACING * 2, y));
269 dc.DrawLine (wxPoint(GRID_SPACING, y), wxPoint(GRID_SPACING * 2, y));
273 AudioMappingView::paint_row_lines (wxDC& dc)
275 for (size_t i = 0; i < _input_channels.size(); ++i) {
277 wxPoint(GRID_SPACING * 2, TOP_HEIGHT + GRID_SPACING * i),
278 wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, TOP_HEIGHT + GRID_SPACING * i)
282 wxPoint(GRID_SPACING * 2, TOP_HEIGHT + GRID_SPACING * _input_channels.size()),
283 wxPoint(LEFT_WIDTH + _output_channels.size() * GRID_SPACING, TOP_HEIGHT + GRID_SPACING * _input_channels.size())
288 AudioMappingView::paint_indicators (wxDC& dc)
290 /* _{input,output}_channels and _map may not always be in sync, be careful here */
291 size_t const output = min(_output_channels.size(), size_t(_map.output_channels()));
292 size_t const input = min(_input_channels.size(), size_t(_map.input_channels()));
294 for (size_t x = 0; x < output; ++x) {
295 for (size_t y = 0; y < input; ++y) {
296 dc.SetBrush (*wxWHITE_BRUSH);
299 LEFT_WIDTH + x * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
300 TOP_HEIGHT + y * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
301 INDICATOR_SIZE, INDICATOR_SIZE
305 float const value_dB = linear_to_db(_map.get(y, x));
306 wxColour const colour = value_dB <= 0 ? wxColour(0, 255, 0) : wxColour(255, 150, 0);
307 int const range = 18;
309 if (value_dB > -range) {
310 height = min(INDICATOR_SIZE, static_cast<int>(INDICATOR_SIZE * (1 + value_dB / range)));
313 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush(colour, wxBRUSHSTYLE_SOLID));
316 LEFT_WIDTH + x * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
317 TOP_HEIGHT + y * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2 + INDICATOR_SIZE - height,
318 INDICATOR_SIZE, height
326 void clip (wxDC& dc, int x, int y, int w, int h)
328 dc.SetClippingRegion (x, y, w, h);
332 void translate (wxDC& dc, int x, int y)
334 dc.SetLogicalOrigin (x, y);
338 void restore (wxDC& dc)
340 dc.SetLogicalOrigin (0, 0);
341 dc.DestroyClippingRegion ();
345 AudioMappingView::paint ()
347 wxPaintDC dc (_body);
349 int const hs = _horizontal_scroll->GetThumbPosition ();
350 int const vs = _vertical_scroll->GetThumbPosition ();
358 GRID_SPACING * _output_channels.size(),
359 GRID_SPACING * (2 + _input_channels.size())
361 translate (dc, hs, 0);
362 paint_column_labels (dc);
370 min(int(GRID_SPACING * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
372 translate (dc, 0, vs);
373 paint_row_labels (dc);
380 GRID_SPACING * (1 + _output_channels.size()),
381 min(int(GRID_SPACING * (2 + _input_channels.size())), GetSize().GetHeight() - TOP_HEIGHT)
383 translate (dc, hs, vs);
384 paint_row_lines (dc);
391 GRID_SPACING * (1 + _output_channels.size()),
392 min(int(GRID_SPACING * (1 + _input_channels.size())), GetSize().GetHeight() - GRID_SPACING)
394 translate (dc, hs, vs);
395 paint_column_lines (dc);
402 GRID_SPACING * _output_channels.size(),
403 min(int(GRID_SPACING * _input_channels.size()), GetSize().GetHeight() - TOP_HEIGHT)
405 translate (dc, hs, vs);
406 paint_indicators (dc);
410 optional<pair<int, int> >
411 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
413 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
414 int const y = ev.GetY() + _vertical_scroll->GetThumbPosition();
416 if (x <= LEFT_WIDTH || y < TOP_HEIGHT) {
417 return optional<pair<int, int> >();
420 int const input = (y - TOP_HEIGHT) / GRID_SPACING;
421 int const output = (x - LEFT_WIDTH) / GRID_SPACING;
423 if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
424 return optional<pair<int, int> >();
427 return make_pair (input, output);
431 AudioMappingView::mouse_event_to_input_group_name (wxMouseEvent& ev) const
433 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
434 if (x < GRID_SPACING || x > (2 * GRID_SPACING)) {
435 return optional<string>();
438 int y = (ev.GetY() + _vertical_scroll->GetThumbPosition() - (GRID_SPACING * 2)) / GRID_SPACING;
439 BOOST_FOREACH (Group i, _input_groups) {
440 if (i.from <= y && y <= i.to) {
445 return optional<string>();
449 AudioMappingView::left_down (wxMouseEvent& ev)
451 optional<pair<int, int> > channels = mouse_event_to_channels (ev);
456 if (_map.get(channels->first, channels->second) > 0) {
457 _map.set (channels->first, channels->second, 0);
459 _map.set (channels->first, channels->second, 1);
462 map_values_changed ();
466 AudioMappingView::right_down (wxMouseEvent& ev)
468 optional<pair<int, int> > channels = mouse_event_to_channels (ev);
473 _menu_input = channels->first;
474 _menu_output = channels->second;
475 PopupMenu (_menu, ev.GetPosition());
479 AudioMappingView::mouse_wheel (wxMouseEvent& ev)
481 if (ev.ShiftDown()) {
482 _horizontal_scroll->SetThumbPosition (
483 _horizontal_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -GRID_SPACING : GRID_SPACING)
487 _vertical_scroll->SetThumbPosition (
488 _vertical_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -GRID_SPACING : GRID_SPACING)
494 /** Called when any gain value has changed */
496 AudioMappingView::map_values_changed ()
499 _last_tooltip_channels = optional<pair<int, int> >();
504 AudioMappingView::set_gain_from_menu (double linear)
506 _map.set (_menu_input, _menu_output, linear);
507 map_values_changed ();
511 AudioMappingView::edit ()
513 AudioGainDialog* dialog = new AudioGainDialog (this, _menu_input, _menu_output, _map.get(_menu_input, _menu_output));
514 if (dialog->ShowModal() == wxID_OK) {
515 _map.set (_menu_input, _menu_output, dialog->value ());
516 map_values_changed ();
523 AudioMappingView::set (AudioMapping map)
530 AudioMappingView::set_input_channels (vector<string> const & names)
532 _input_channels = names;
538 AudioMappingView::set_output_channels (vector<string> const & names)
540 _output_channels = names;
546 AudioMappingView::safe_input_channel_name (int n) const
548 if (n >= int(_input_channels.size())) {
549 return wxString::Format ("%d", n + 1);
552 optional<wxString> group;
553 BOOST_FOREACH (Group i, _input_groups) {
554 if (i.from <= n && n <= i.to) {
555 group = std_to_wx (i.name);
559 if (group && !group->IsEmpty()) {
560 return wxString::Format ("%s/%s", group->data(), std_to_wx(_input_channels[n]).data());
563 return std_to_wx(_input_channels[n]);
567 AudioMappingView::safe_output_channel_name (int n) const
569 if (n >= int(_output_channels.size())) {
570 return wxString::Format ("%d", n + 1);
573 return std_to_wx(_output_channels[n]);
577 AudioMappingView::motion (wxMouseEvent& ev)
579 optional<pair<int, int> > channels = mouse_event_to_channels (ev);
581 if (channels != _last_tooltip_channels) {
583 float const gain = _map.get(channels->first, channels->second);
585 s = wxString::Format (
586 _("No audio will be passed from %s channel '%s' to %s channel '%s'."),
588 safe_input_channel_name(channels->first),
590 safe_output_channel_name(channels->second)
592 } else if (gain == 1) {
593 s = wxString::Format (
594 _("Audio will be passed from %s channel %s to %s channel %s unaltered."),
596 safe_input_channel_name(channels->first),
598 safe_output_channel_name(channels->second)
601 float const dB = linear_to_db(gain);
602 s = wxString::Format (
603 _("Audio will be passed from %s channel %s to %s channel %s with gain %.1fdB."),
605 safe_input_channel_name(channels->first),
607 safe_output_channel_name(channels->second),
612 SetToolTip (s + " " + _("Right click to change gain."));
615 optional<string> group = mouse_event_to_input_group_name (ev);
617 SetToolTip (std_to_wx(*group));
623 _last_tooltip_channels = channels;
628 AudioMappingView::set_input_groups (vector<Group> const & groups)
630 _input_groups = groups;