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/>.
22 #include "audio_plot.h"
23 #include "film_viewer.h"
25 #include "lib/audio_decoder.h"
26 #include "lib/audio_analysis.h"
27 #include "lib/compose.hpp"
28 #include "lib/maths_util.h"
29 #include <dcp/warnings.h>
30 LIBDCP_DISABLE_WARNINGS
31 #include <wx/graphics.h>
32 LIBDCP_ENABLE_WARNINGS
33 #include <boost/bind/bind.hpp>
41 using std::shared_ptr;
45 using boost::optional;
46 #if BOOST_VERSION >= 106100
47 using namespace boost::placeholders;
49 using namespace dcpomatic;
52 int const AudioPlot::_minimum = -70;
53 int const AudioPlot::_cursor_size = 8;
54 int const AudioPlot::max_smoothing = 128;
57 AudioPlot::AudioPlot(wxWindow* parent, FilmViewer& viewer)
58 : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
60 , _smoothing (max_smoothing / 2)
61 , _gain_correction (0)
64 SetDoubleBuffered (true);
67 for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
68 _channel_visible[i] = false;
71 for (int i = 0; i < AudioPoint::COUNT; ++i) {
72 _type_visible[i] = false;
76 _colours.push_back(wxColour(255, 255, 255));
78 _colours.push_back(wxColour(0, 0, 0));
80 _colours.push_back (wxColour (255, 0, 0));
81 _colours.push_back (wxColour ( 0, 255, 0));
82 _colours.push_back (wxColour (139, 0, 204));
83 _colours.push_back (wxColour ( 0, 0, 255));
84 _colours.push_back (wxColour ( 0, 139, 0));
85 _colours.push_back (wxColour ( 0, 0, 139));
86 _colours.push_back (wxColour (255, 255, 0));
87 _colours.push_back (wxColour ( 0, 255, 255));
88 _colours.push_back (wxColour (255, 0, 255));
89 _colours.push_back (wxColour (255, 0, 139));
90 _colours.push_back (wxColour (139, 0, 255));
92 _colours.push_back (wxColour (139, 139, 255));
93 _colours.push_back (wxColour ( 0, 139, 255));
94 _colours.push_back (wxColour (255, 139, 139));
95 _colours.push_back (wxColour (255, 139, 0));
97 set_analysis (shared_ptr<AudioAnalysis> ());
99 #if MAX_DCP_AUDIO_CHANNELS != 16
100 #warning AudioPlot::AudioPlot is expecting the wrong MAX_DCP_AUDIO_CHANNELS
103 Bind (wxEVT_PAINT, boost::bind (&AudioPlot::paint, this));
104 Bind (wxEVT_MOTION, boost::bind (&AudioPlot::mouse_moved, this, _1));
105 Bind (wxEVT_LEAVE_WINDOW, boost::bind (&AudioPlot::mouse_leave, this, _1));
106 Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioPlot::left_down, this));
108 SetMinSize (wxSize (640, 512));
113 AudioPlot::set_analysis (shared_ptr<AudioAnalysis> a)
118 _message = _("Please wait; audio is being analysed...");
126 AudioPlot::set_channel_visible (int c, bool v)
128 _channel_visible[c] = v;
134 AudioPlot::set_type_visible (int t, bool v)
136 _type_visible[t] = v;
142 AudioPlot::set_message (wxString s)
151 double db_label_width;
154 float x_scale; ///< pixels per data point
164 auto gc = wxGraphicsContext::Create (dc);
169 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
171 if (!_analysis || _analysis->channels() == 0) {
172 gc->SetFont(gc->CreateFont(*wxNORMAL_FONT, gui_is_dark() ? *wxWHITE : *wxBLACK));
173 gc->DrawText (_message, 32, 32);
178 auto h_grid = gc->CreatePath ();
179 gc->SetFont(gc->CreateFont(*wxSMALL_FONT, gui_is_dark() ? *wxWHITE : *wxBLACK));
180 wxDouble db_label_height;
181 wxDouble db_label_descent;
182 wxDouble db_label_leading;
184 gc->GetTextExtent (wxT ("-80dB"), &metrics.db_label_width, &db_label_height, &db_label_descent, &db_label_leading);
186 metrics.db_label_width += 8;
188 int const data_width = GetSize().GetWidth() - metrics.db_label_width;
189 /* Assume all channels have the same number of points */
190 metrics.x_scale = data_width / float (_analysis->points (0));
191 metrics.height = GetSize().GetHeight ();
192 metrics.y_origin = 32;
193 metrics.y_scale = (metrics.height - metrics.y_origin) / -_minimum;
195 for (int i = _minimum; i <= 0; i += 10) {
196 int const y = (metrics.height - (i - _minimum) * metrics.y_scale) - metrics.y_origin;
197 h_grid.MoveToPoint (metrics.db_label_width - 4, y);
198 h_grid.AddLineToPoint (metrics.db_label_width + data_width, y);
199 gc->DrawText (std_to_wx (String::compose ("%1dB", i)), 0, y - (db_label_height / 2));
202 wxColour const grid_colour = gui_is_dark() ? wxColour(80, 80, 80) : wxColour(200, 200, 200);
204 gc->SetPen(wxPen(grid_colour));
205 gc->StrokePath (h_grid);
207 /* Draw an x axis with marks */
209 auto v_grid = gc->CreatePath ();
211 DCPOMATIC_ASSERT (_analysis->samples_per_point() != 0.0);
212 double const pps = _analysis->sample_rate() * metrics.x_scale / _analysis->samples_per_point();
214 double const mark_interval = calculate_mark_interval (rint (128 / pps));
216 auto t = DCPTime::from_seconds (mark_interval);
217 while ((t.seconds() * pps) < data_width) {
218 double tc = t.seconds ();
219 int const h = tc / 3600;
221 int const m = tc / 60;
225 auto str = wxString::Format (wxT ("%02d:%02d:%02d"), h, m, s);
228 wxDouble str_descent;
229 wxDouble str_leading;
230 gc->GetTextExtent (str, &str_width, &str_height, &str_descent, &str_leading);
232 int const tx = llrintf (metrics.db_label_width + t.seconds() * pps);
233 gc->DrawText (str, tx - str_width / 2, metrics.height - metrics.y_origin + db_label_height);
235 v_grid.MoveToPoint (tx, metrics.height - metrics.y_origin + 4);
236 v_grid.AddLineToPoint (tx, metrics.y_origin);
238 t += DCPTime::from_seconds (mark_interval);
241 gc->SetPen(wxPen(grid_colour));
242 gc->StrokePath (v_grid);
244 if (_type_visible[AudioPoint::PEAK]) {
245 for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
246 auto p = gc->CreatePath ();
247 if (_channel_visible[c] && c < _analysis->channels()) {
248 plot_peak (p, c, metrics);
250 auto const col = _colours[c];
251 gc->SetPen (wxPen (wxColour (col.Red(), col.Green(), col.Blue(), col.Alpha() / 2), 1, wxPENSTYLE_SOLID));
256 if (_type_visible[AudioPoint::RMS]) {
257 for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
258 auto p = gc->CreatePath ();
259 if (_channel_visible[c] && c < _analysis->channels()) {
260 plot_rms (p, c, metrics);
262 auto const col = _colours[c];
263 gc->SetPen (wxPen (col, 1, wxPENSTYLE_SOLID));
268 auto axes = gc->CreatePath ();
269 axes.MoveToPoint (metrics.db_label_width, 0);
270 axes.AddLineToPoint (metrics.db_label_width, metrics.height - metrics.y_origin);
271 axes.AddLineToPoint (metrics.db_label_width + data_width, metrics.height - metrics.y_origin);
272 gc->SetPen(wxPen(grid_colour));
273 gc->StrokePath (axes);
276 auto cursor = gc->CreatePath ();
277 cursor.MoveToPoint (_cursor->draw.x - _cursor_size / 2, _cursor->draw.y - _cursor_size / 2);
278 cursor.AddLineToPoint (_cursor->draw.x + _cursor_size / 2, _cursor->draw.y + _cursor_size / 2);
279 cursor.MoveToPoint (_cursor->draw.x + _cursor_size / 2, _cursor->draw.y - _cursor_size / 2);
280 cursor.AddLineToPoint (_cursor->draw.x - _cursor_size / 2, _cursor->draw.y + _cursor_size / 2);
281 gc->StrokePath (cursor);
289 AudioPlot::y_for_linear (float p, Metrics const & metrics) const
295 return metrics.height - (linear_to_db(p) - _minimum) * metrics.y_scale - metrics.y_origin;
300 AudioPlot::plot_peak (wxGraphicsPath& path, int channel, Metrics const & metrics) const
302 if (_analysis->points (channel) == 0) {
306 _peak[channel] = PointList ();
309 int const N = _analysis->points(channel);
310 for (int i = 0; i < N; ++i) {
311 float const p = get_point(channel, i)[AudioPoint::PEAK];
312 peak -= 0.01f * (1 - log10 (_smoothing) / log10 (max_smoothing));
315 } else if (peak < 0) {
319 _peak[channel].push_back (
321 wxPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (peak, metrics)),
322 DCPTime::from_frames (i * _analysis->samples_per_point(), _analysis->sample_rate()),
328 DCPOMATIC_ASSERT (_peak.find(channel) != _peak.end());
330 path.MoveToPoint (_peak[channel][0].draw);
331 for (auto const& i: _peak[channel]) {
332 path.AddLineToPoint (i.draw);
338 AudioPlot::plot_rms (wxGraphicsPath& path, int channel, Metrics const & metrics) const
340 if (_analysis->points (channel) == 0) {
344 _rms[channel] = PointList();
346 list<float> smoothing;
348 int const N = _analysis->points(channel);
350 float const first = get_point(channel, 0)[AudioPoint::RMS];
351 float const last = get_point(channel, N - 1)[AudioPoint::RMS];
353 int const before = _smoothing / 2;
354 int const after = _smoothing - before;
356 /* Pre-load the smoothing list */
357 for (int i = 0; i < before; ++i) {
358 smoothing.push_back (first);
360 for (int i = 0; i < after; ++i) {
362 smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
364 smoothing.push_back (last);
368 for (int i = 0; i < N; ++i) {
370 int const next_for_window = i + after;
372 if (next_for_window < N) {
373 smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
375 smoothing.push_back (last);
378 smoothing.pop_front ();
381 for (list<float>::const_iterator j = smoothing.begin(); j != smoothing.end(); ++j) {
385 if (!smoothing.empty ()) {
386 p = sqrt (p / smoothing.size ());
389 _rms[channel].push_back (
391 wxPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (p, metrics)),
392 DCPTime::from_frames (i * _analysis->samples_per_point(), _analysis->sample_rate()),
398 DCPOMATIC_ASSERT (_rms.find(channel) != _rms.end());
400 path.MoveToPoint (_rms[channel][0].draw);
401 for (auto const& i: _rms[channel]) {
402 path.AddLineToPoint (i.draw);
408 AudioPlot::set_smoothing (int s)
418 AudioPlot::set_gain_correction (double gain)
420 _gain_correction = gain;
426 AudioPlot::get_point (int channel, int point) const
428 auto p = _analysis->get_point (channel, point);
429 for (int i = 0; i < AudioPoint::COUNT; ++i) {
430 p[i] *= db_to_linear(_gain_correction);
437 /** @param n Channel index.
438 * @return Colour used by that channel in the plot.
441 AudioPlot::colour (int n) const
443 DCPOMATIC_ASSERT (n < int(_colours.size()));
449 AudioPlot::left_down ()
452 _viewer.seek(_cursor->time, true);
458 AudioPlot::mouse_moved (wxMouseEvent& ev)
460 double min_dist = DBL_MAX;
463 auto search = [this](map<int, PointList> const & search, wxMouseEvent const & ev, double& min_dist, Point& min_point) {
464 for (auto const& i: search) {
465 if (_channel_visible[i.first]) {
466 for (auto const& j: i.second) {
467 double const dist = pow(ev.GetX() - j.draw.x, 2) + pow(ev.GetY() - j.draw.y, 2);
468 if (dist < min_dist) {
477 if (_type_visible[AudioPoint::RMS]) {
478 search (_rms, ev, min_dist, min_point);
480 if (_type_visible[AudioPoint::PEAK]) {
481 search (_peak, ev, min_dist, min_point);
484 _cursor = boost::none;
486 if (min_dist < DBL_MAX) {
487 wxRect before (min_point.draw.x - _cursor_size / 2, min_point.draw.y - _cursor_size / 2, _cursor_size, _cursor_size);
488 GetParent()->Refresh (true, &before);
490 wxRect after (min_point.draw.x - _cursor_size / 2, min_point.draw.y - _cursor_size / 2, _cursor_size, _cursor_size);
491 GetParent()->Refresh (true, &after);
492 Cursor (min_point.time, min_point.db);
498 AudioPlot::mouse_leave (wxMouseEvent &)
500 _cursor = boost::none;
502 Cursor (optional<DCPTime>(), optional<float>());