2 Copyright (C) 2013-2019 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 <dcp/locale_convert.h>
31 #include <dcp/types.h>
33 #include <wx/renderer.h>
35 #include <wx/graphics.h>
36 #include <boost/foreach.hpp>
47 using boost::shared_ptr;
48 using boost::optional;
49 using dcp::locale_convert;
51 #define INDICATOR_SIZE 20
52 #define GRID_SPACING 32
53 #define LEFT_WIDTH (GRID_SPACING * 3)
54 #define TOP_HEIGHT (GRID_SPACING * 2)
63 AudioMappingView::AudioMappingView (wxWindow* parent)
64 : wxPanel (parent, wxID_ANY)
69 _menu->Append (ID_off, _("Off"));
70 _menu->Append (ID_full, _("Full"));
71 _menu->Append (ID_minus6dB, _("-6dB"));
72 _menu->Append (ID_edit, _("Edit..."));
74 _body = new wxPanel (this, wxID_ANY);
75 _vertical_scroll = new wxScrollBar (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSB_VERTICAL);
76 _horizontal_scroll = new wxScrollBar (this, wxID_ANY);
78 Bind (wxEVT_SIZE, boost::bind(&AudioMappingView::size, this, _1));
79 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::off, this), ID_off);
80 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::full, this), ID_full);
81 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::minus6dB, this), ID_minus6dB);
82 Bind (wxEVT_MENU, boost::bind(&AudioMappingView::edit, this), ID_edit);
83 Bind (wxEVT_MOUSEWHEEL, boost::bind(&AudioMappingView::mouse_wheel, this, _1));
84 _body->Bind (wxEVT_PAINT, boost::bind(&AudioMappingView::paint, this));
85 _body->Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioMappingView::left_down, this, _1));
86 _body->Bind (wxEVT_RIGHT_DOWN, boost::bind(&AudioMappingView::right_down, this, _1));
87 _body->Bind (wxEVT_MOTION, boost::bind(&AudioMappingView::motion, this, _1));
88 _vertical_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
89 _vertical_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
90 _vertical_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
91 _vertical_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
92 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
93 _vertical_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
94 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
95 _vertical_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
96 _horizontal_scroll->Bind (wxEVT_SCROLL_TOP, boost::bind(&AudioMappingView::scroll, this));
97 _horizontal_scroll->Bind (wxEVT_SCROLL_BOTTOM, boost::bind(&AudioMappingView::scroll, this));
98 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEUP, boost::bind(&AudioMappingView::scroll, this));
99 _horizontal_scroll->Bind (wxEVT_SCROLL_LINEDOWN, boost::bind(&AudioMappingView::scroll, this));
100 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&AudioMappingView::scroll, this));
101 _horizontal_scroll->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&AudioMappingView::scroll, this));
102 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&AudioMappingView::scroll, this));
103 _horizontal_scroll->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&AudioMappingView::scroll, this));
107 AudioMappingView::size (wxSizeEvent& ev)
114 AudioMappingView::setup ()
116 wxSize const s = GetSize();
117 int const w = _vertical_scroll->GetSize().GetWidth();
118 int const h = _horizontal_scroll->GetSize().GetHeight();
120 _vertical_scroll->SetPosition (wxPoint(s.GetWidth() - w, 0));
121 _vertical_scroll->SetSize (wxSize(w, max(0, s.GetHeight() - h)));
123 _body->SetSize (wxSize(max(0, s.GetWidth() - w), max(0, s.GetHeight() - h)));
125 _horizontal_scroll->SetPosition (wxPoint(0, s.GetHeight() - h));
126 _horizontal_scroll->SetSize (wxSize(max(0, s.GetWidth() - w), h));
128 _vertical_scroll->SetScrollbar (
129 _vertical_scroll->GetThumbPosition(),
130 s.GetHeight() - h - 8,
131 GRID_SPACING * (2 + _input_channels.size()),
136 _horizontal_scroll->SetScrollbar (
137 _horizontal_scroll->GetThumbPosition(),
138 s.GetWidth() - w - 8,
139 GRID_SPACING * (3 + _output_channels.size()),
145 AudioMappingView::scroll ()
151 AudioMappingView::paint_static (wxDC& dc, wxGraphicsContext* gc)
153 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
154 dc.SetFont (wxSWISS_FONT->Bold());
156 wxCoord label_height;
158 /* DCP label at the top */
160 dc.GetTextExtent (_("DCP"), &label_width, &label_height);
161 dc.DrawText (_("DCP"), LEFT_WIDTH + (_output_channels.size() * GRID_SPACING - label_width) / 2, (GRID_SPACING - label_height) / 2);
163 /* Content label on the left */
165 dc.GetTextExtent (_("Content"), &label_width, &label_height);
168 (GRID_SPACING - label_height) / 2,
169 TOP_HEIGHT + (_input_channels.size() * GRID_SPACING + label_width) / 2,
173 dc.SetFont (*wxSWISS_FONT);
174 gc->SetPen (*wxBLACK_PEN);
178 AudioMappingView::paint_column_labels (wxDC& dc, wxGraphicsContext* gc)
181 wxCoord label_height;
183 BOOST_FOREACH (string i, _output_channels) {
184 dc.GetTextExtent (std_to_wx(i), &label_width, &label_height);
185 dc.DrawText (std_to_wx(i), LEFT_WIDTH + GRID_SPACING * N + (GRID_SPACING - label_width) / 2, GRID_SPACING + (GRID_SPACING - label_height) / 2);
189 wxGraphicsPath lines = gc->CreatePath ();
190 lines.MoveToPoint (LEFT_WIDTH, GRID_SPACING);
191 lines.AddLineToPoint (LEFT_WIDTH + _output_channels.size() * GRID_SPACING, GRID_SPACING);
192 lines.MoveToPoint (LEFT_WIDTH, GRID_SPACING * 2);
193 lines.AddLineToPoint (LEFT_WIDTH + _output_channels.size() * GRID_SPACING, GRID_SPACING * 2);
194 gc->StrokePath (lines);
198 AudioMappingView::paint_column_lines (wxGraphicsContext* gc)
200 wxGraphicsPath lines = gc->CreatePath ();
201 for (size_t i = 0; i < _output_channels.size(); ++i) {
202 lines.MoveToPoint (LEFT_WIDTH + GRID_SPACING * i, GRID_SPACING);
203 lines.AddLineToPoint (LEFT_WIDTH + GRID_SPACING * i, TOP_HEIGHT + _input_channels.size() * GRID_SPACING);
205 lines.MoveToPoint (LEFT_WIDTH + GRID_SPACING * _output_channels.size(), GRID_SPACING);
206 lines.AddLineToPoint (LEFT_WIDTH + GRID_SPACING * _output_channels.size(), TOP_HEIGHT + _input_channels.size() * GRID_SPACING);
207 gc->StrokePath (lines);
211 void clip (wxDC& dc, wxGraphicsContext* gc, int x, int y, int w, int h)
213 dc.SetClippingRegion (x, y, w, h);
214 gc->Clip (x, y, w, h);
218 void translate (wxDC& dc, wxGraphicsContext* gc, int x, int y)
221 gc->Translate (-x, -y);
222 dc.SetLogicalOrigin (x, y);
226 void restore (wxDC& dc, wxGraphicsContext* gc)
228 dc.SetLogicalOrigin (0, 0);
230 dc.DestroyClippingRegion ();
235 AudioMappingView::paint_row_labels (wxDC& dc, wxGraphicsContext* gc)
238 wxCoord label_height;
239 wxGraphicsPath lines = gc->CreatePath ();
241 /* Row channel labels */
244 BOOST_FOREACH (string i, _input_channels) {
245 dc.GetTextExtent (std_to_wx(i), &label_width, &label_height);
246 dc.DrawText (std_to_wx(i), GRID_SPACING * 2 + (GRID_SPACING - label_width) / 2, TOP_HEIGHT + GRID_SPACING * N + (GRID_SPACING - label_height) / 2);
250 /* Vertical lines on the left */
252 for (int i = 1; i < 3; ++i) {
253 lines.MoveToPoint (GRID_SPACING * i, TOP_HEIGHT);
254 lines.AddLineToPoint (GRID_SPACING * i, TOP_HEIGHT + _input_channels.size() * GRID_SPACING);
257 /* Group labels and lines */
260 BOOST_FOREACH (Group i, _input_groups) {
261 int const height = (i.to - i.from + 1) * GRID_SPACING;
262 dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
263 if (label_width > height) {
264 label_width = height - 8;
266 clip (dc, gc, GRID_SPACING, y + 4, GRID_SPACING, height - 4);
269 GRID_SPACING + (GRID_SPACING - label_height) / 2,
270 y + (height + label_width) / 2,
274 lines.MoveToPoint (GRID_SPACING, y);
275 lines.AddLineToPoint (GRID_SPACING * 2, y);
279 lines.MoveToPoint (GRID_SPACING, y);
280 lines.AddLineToPoint (GRID_SPACING * 2, y);
282 gc->StrokePath (lines);
286 AudioMappingView::paint_row_lines (wxGraphicsContext* gc)
288 wxGraphicsPath lines = gc->CreatePath ();
289 for (size_t i = 0; i < _input_channels.size(); ++i) {
290 lines.MoveToPoint (GRID_SPACING * 2, TOP_HEIGHT + GRID_SPACING * i);
291 lines.AddLineToPoint (LEFT_WIDTH + _output_channels.size() * GRID_SPACING, TOP_HEIGHT + GRID_SPACING * i);
293 lines.MoveToPoint (GRID_SPACING * 2, TOP_HEIGHT + GRID_SPACING * _input_channels.size());
294 lines.AddLineToPoint (LEFT_WIDTH + _output_channels.size() * GRID_SPACING, TOP_HEIGHT + GRID_SPACING * _input_channels.size());
295 gc->StrokePath (lines);
299 AudioMappingView::paint_indicators (wxDC& dc)
301 /* _{input,output}_channels and _map may not always be in sync, be careful here */
302 size_t const output = min(_output_channels.size(), size_t(_map.output_channels()));
303 size_t const input = min(_input_channels.size(), size_t(_map.input_channels()));
305 for (size_t x = 0; x < output; ++x) {
306 for (size_t y = 0; y < input; ++y) {
307 dc.SetBrush (*wxWHITE_BRUSH);
310 LEFT_WIDTH + x * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
311 TOP_HEIGHT + y * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
312 INDICATOR_SIZE, INDICATOR_SIZE
316 float const value_dB = 20 * log10 (_map.get(y, x));
317 int const range = 18;
319 if (value_dB > -range) {
320 height = INDICATOR_SIZE * (1 + value_dB / range);
323 dc.SetBrush (*wxTheBrushList->FindOrCreateBrush(wxColour (0, 255, 0), wxBRUSHSTYLE_SOLID));
326 LEFT_WIDTH + x * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2,
327 TOP_HEIGHT + y * GRID_SPACING + (GRID_SPACING - INDICATOR_SIZE) / 2 + INDICATOR_SIZE - height,
328 INDICATOR_SIZE, height
336 AudioMappingView::paint ()
338 wxPaintDC dc (_body);
340 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
345 int const hs = _horizontal_scroll->GetThumbPosition ();
346 int const vs = _vertical_scroll->GetThumbPosition ();
348 paint_static (dc, gc);
350 clip (dc, gc, LEFT_WIDTH, 0, GRID_SPACING * _output_channels.size(), GRID_SPACING * (2 + _input_channels.size()));
351 translate (dc, gc, hs, 0);
352 paint_column_labels (dc, gc);
355 clip (dc, gc, 0, TOP_HEIGHT, GRID_SPACING * (3 + _output_channels.size()), GRID_SPACING * _input_channels.size() + 1);
356 translate (dc, gc, 0, vs);
357 paint_row_labels (dc, gc);
360 clip (dc, gc, GRID_SPACING * 2, TOP_HEIGHT, GRID_SPACING * (1 + _output_channels.size()), GRID_SPACING * _input_channels.size() + 1);
361 translate (dc, gc, hs, vs);
362 paint_row_lines (gc);
365 clip (dc, gc, LEFT_WIDTH, GRID_SPACING, GRID_SPACING * (1 + _output_channels.size()), GRID_SPACING * (1 + _input_channels.size()));
366 translate (dc, gc, hs, vs);
367 paint_column_lines (gc);
370 clip (dc, gc, LEFT_WIDTH, TOP_HEIGHT, GRID_SPACING * _output_channels.size(), GRID_SPACING * _input_channels.size());
371 translate (dc, gc, hs, vs);
372 paint_indicators (dc);
378 optional<pair<int, int> >
379 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
381 int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
382 int const y = ev.GetY() + _vertical_scroll->GetThumbPosition();
384 if (x <= LEFT_WIDTH || y < TOP_HEIGHT) {
385 return optional<pair<int, int> >();
388 int const input = (y - TOP_HEIGHT) / GRID_SPACING;
389 int const output = (x - LEFT_WIDTH) / GRID_SPACING;
391 if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
392 return optional<pair<int, int> >();
395 return make_pair (input, output);
399 AudioMappingView::left_down (wxMouseEvent& ev)
401 optional<pair<int, int> > channels = mouse_event_to_channels (ev);
406 if (_map.get(channels->first, channels->second) > 0) {
407 _map.set (channels->first, channels->second, 0);
409 _map.set (channels->first, channels->second, 1);
412 map_values_changed ();
416 AudioMappingView::right_down (wxMouseEvent& ev)
418 optional<pair<int, int> > channels = mouse_event_to_channels (ev);
423 _menu_input = channels->first;
424 _menu_output = channels->second;
425 PopupMenu (_menu, ev.GetPosition());
429 AudioMappingView::mouse_wheel (wxMouseEvent& ev)
431 if (ev.ShiftDown()) {
432 _horizontal_scroll->SetThumbPosition (
433 _horizontal_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -GRID_SPACING : GRID_SPACING)
437 _vertical_scroll->SetThumbPosition (
438 _vertical_scroll->GetThumbPosition() + (ev.GetWheelRotation() > 0 ? -GRID_SPACING : GRID_SPACING)
444 /** Called when any gain value has changed */
446 AudioMappingView::map_values_changed ()
449 _last_tooltip_channels = optional<pair<int, int> >();
454 AudioMappingView::off ()
456 _map.set (_menu_input, _menu_output, 0);
457 map_values_changed ();
461 AudioMappingView::full ()
463 _map.set (_menu_input, _menu_output, 1);
464 map_values_changed ();
468 AudioMappingView::minus6dB ()
470 _map.set (_menu_input, _menu_output, pow (10, -6.0 / 20));
471 map_values_changed ();
475 AudioMappingView::edit ()
477 int const d = _menu_output - 1;
479 AudioGainDialog* dialog = new AudioGainDialog (this, _menu_input, _menu_output - 1, _map.get(_menu_input, d));
480 if (dialog->ShowModal() == wxID_OK) {
481 _map.set (_menu_input, d, dialog->value ());
482 map_values_changed ();
489 AudioMappingView::set (AudioMapping map)
496 AudioMappingView::set_input_channels (vector<string> const & names)
498 _input_channels = names;
504 AudioMappingView::set_output_channels (vector<string> const & names)
506 _output_channels = names;
512 AudioMappingView::motion (wxMouseEvent& ev)
514 optional<pair<int, int> > channels = mouse_event_to_channels (ev);
517 _last_tooltip_channels = channels;
521 if (channels != _last_tooltip_channels) {
523 float const gain = _map.get(channels->first, channels->second);
525 s = wxString::Format (_("No audio will be passed from content channel %d to DCP channel %d."), channels->first + 1, channels->second + 1);
526 } else if (gain == 1) {
527 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d unaltered."), channels->first + 1, channels->second + 1);
529 float const dB = 20 * log10 (gain);
530 s = wxString::Format (_("Audio will be passed from content channel %d to DCP channel %d with gain %.1fdB."), channels->first + 1, channels->second + 1, dB);
533 SetToolTip (s + " " + _("Right click to change gain."));
534 _last_tooltip_channels = channels;
541 AudioMappingView::set_input_groups (vector<Group> const & groups)
543 _input_groups = groups;