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, weak_ptr<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;
75 _colours.push_back (wxColour ( 0, 0, 0));
76 _colours.push_back (wxColour (255, 0, 0));
77 _colours.push_back (wxColour ( 0, 255, 0));
78 _colours.push_back (wxColour (139, 0, 204));
79 _colours.push_back (wxColour ( 0, 0, 255));
80 _colours.push_back (wxColour ( 0, 139, 0));
81 _colours.push_back (wxColour ( 0, 0, 139));
82 _colours.push_back (wxColour (255, 255, 0));
83 _colours.push_back (wxColour ( 0, 255, 255));
84 _colours.push_back (wxColour (255, 0, 255));
85 _colours.push_back (wxColour (255, 0, 139));
86 _colours.push_back (wxColour (139, 0, 255));
88 _colours.push_back (wxColour (139, 139, 255));
89 _colours.push_back (wxColour ( 0, 139, 255));
90 _colours.push_back (wxColour (255, 139, 139));
91 _colours.push_back (wxColour (255, 139, 0));
93 set_analysis (shared_ptr<AudioAnalysis> ());
95 #if MAX_DCP_AUDIO_CHANNELS != 16
96 #warning AudioPlot::AudioPlot is expecting the wrong MAX_DCP_AUDIO_CHANNELS
99 Bind (wxEVT_PAINT, boost::bind (&AudioPlot::paint, this));
100 Bind (wxEVT_MOTION, boost::bind (&AudioPlot::mouse_moved, this, _1));
101 Bind (wxEVT_LEAVE_WINDOW, boost::bind (&AudioPlot::mouse_leave, this, _1));
102 Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioPlot::left_down, this));
104 SetMinSize (wxSize (640, 512));
109 AudioPlot::set_analysis (shared_ptr<AudioAnalysis> a)
114 _message = _("Please wait; audio is being analysed...");
122 AudioPlot::set_channel_visible (int c, bool v)
124 _channel_visible[c] = v;
130 AudioPlot::set_type_visible (int t, bool v)
132 _type_visible[t] = v;
138 AudioPlot::set_message (wxString s)
147 double db_label_width;
150 float x_scale; ///< pixels per data point
160 auto gc = wxGraphicsContext::Create (dc);
165 gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
167 if (!_analysis || _analysis->channels() == 0) {
168 gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
169 gc->DrawText (_message, 32, 32);
174 auto h_grid = gc->CreatePath ();
175 gc->SetFont (gc->CreateFont (*wxSMALL_FONT));
176 wxDouble db_label_height;
177 wxDouble db_label_descent;
178 wxDouble db_label_leading;
180 gc->GetTextExtent (wxT ("-80dB"), &metrics.db_label_width, &db_label_height, &db_label_descent, &db_label_leading);
182 metrics.db_label_width += 8;
184 int const data_width = GetSize().GetWidth() - metrics.db_label_width;
185 /* Assume all channels have the same number of points */
186 metrics.x_scale = data_width / float (_analysis->points (0));
187 metrics.height = GetSize().GetHeight ();
188 metrics.y_origin = 32;
189 metrics.y_scale = (metrics.height - metrics.y_origin) / -_minimum;
191 for (int i = _minimum; i <= 0; i += 10) {
192 int const y = (metrics.height - (i - _minimum) * metrics.y_scale) - metrics.y_origin;
193 h_grid.MoveToPoint (metrics.db_label_width - 4, y);
194 h_grid.AddLineToPoint (metrics.db_label_width + data_width, y);
195 gc->DrawText (std_to_wx (String::compose ("%1dB", i)), 0, y - (db_label_height / 2));
198 gc->SetPen (wxPen (wxColour (200, 200, 200)));
199 gc->StrokePath (h_grid);
201 /* Draw an x axis with marks */
203 auto v_grid = gc->CreatePath ();
205 DCPOMATIC_ASSERT (_analysis->samples_per_point() != 0.0);
206 double const pps = _analysis->sample_rate() * metrics.x_scale / _analysis->samples_per_point();
208 gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
210 double const mark_interval = calculate_mark_interval (rint (128 / pps));
212 auto t = DCPTime::from_seconds (mark_interval);
213 while ((t.seconds() * pps) < data_width) {
214 double tc = t.seconds ();
215 int const h = tc / 3600;
217 int const m = tc / 60;
221 auto str = wxString::Format (wxT ("%02d:%02d:%02d"), h, m, s);
224 wxDouble str_descent;
225 wxDouble str_leading;
226 gc->GetTextExtent (str, &str_width, &str_height, &str_descent, &str_leading);
228 int const tx = llrintf (metrics.db_label_width + t.seconds() * pps);
229 gc->DrawText (str, tx - str_width / 2, metrics.height - metrics.y_origin + db_label_height);
231 v_grid.MoveToPoint (tx, metrics.height - metrics.y_origin + 4);
232 v_grid.AddLineToPoint (tx, metrics.y_origin);
234 t += DCPTime::from_seconds (mark_interval);
237 gc->SetPen (wxPen (wxColour (200, 200, 200)));
238 gc->StrokePath (v_grid);
240 if (_type_visible[AudioPoint::PEAK]) {
241 for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
242 auto p = gc->CreatePath ();
243 if (_channel_visible[c] && c < _analysis->channels()) {
244 plot_peak (p, c, metrics);
246 auto const col = _colours[c];
247 gc->SetPen (wxPen (wxColour (col.Red(), col.Green(), col.Blue(), col.Alpha() / 2), 1, wxPENSTYLE_SOLID));
252 if (_type_visible[AudioPoint::RMS]) {
253 for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
254 auto p = gc->CreatePath ();
255 if (_channel_visible[c] && c < _analysis->channels()) {
256 plot_rms (p, c, metrics);
258 auto const col = _colours[c];
259 gc->SetPen (wxPen (col, 1, wxPENSTYLE_SOLID));
264 auto axes = gc->CreatePath ();
265 axes.MoveToPoint (metrics.db_label_width, 0);
266 axes.AddLineToPoint (metrics.db_label_width, metrics.height - metrics.y_origin);
267 axes.AddLineToPoint (metrics.db_label_width + data_width, metrics.height - metrics.y_origin);
268 gc->SetPen (wxPen (wxColour (0, 0, 0)));
269 gc->StrokePath (axes);
272 auto cursor = gc->CreatePath ();
273 cursor.MoveToPoint (_cursor->draw.x - _cursor_size / 2, _cursor->draw.y - _cursor_size / 2);
274 cursor.AddLineToPoint (_cursor->draw.x + _cursor_size / 2, _cursor->draw.y + _cursor_size / 2);
275 cursor.MoveToPoint (_cursor->draw.x + _cursor_size / 2, _cursor->draw.y - _cursor_size / 2);
276 cursor.AddLineToPoint (_cursor->draw.x - _cursor_size / 2, _cursor->draw.y + _cursor_size / 2);
277 gc->StrokePath (cursor);
285 AudioPlot::y_for_linear (float p, Metrics const & metrics) const
291 return metrics.height - (linear_to_db(p) - _minimum) * metrics.y_scale - metrics.y_origin;
296 AudioPlot::plot_peak (wxGraphicsPath& path, int channel, Metrics const & metrics) const
298 if (_analysis->points (channel) == 0) {
302 _peak[channel] = PointList ();
305 int const N = _analysis->points(channel);
306 for (int i = 0; i < N; ++i) {
307 float const p = get_point(channel, i)[AudioPoint::PEAK];
308 peak -= 0.01f * (1 - log10 (_smoothing) / log10 (max_smoothing));
311 } else if (peak < 0) {
315 _peak[channel].push_back (
317 wxPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (peak, metrics)),
318 DCPTime::from_frames (i * _analysis->samples_per_point(), _analysis->sample_rate()),
324 DCPOMATIC_ASSERT (_peak.find(channel) != _peak.end());
326 path.MoveToPoint (_peak[channel][0].draw);
327 for (auto const& i: _peak[channel]) {
328 path.AddLineToPoint (i.draw);
334 AudioPlot::plot_rms (wxGraphicsPath& path, int channel, Metrics const & metrics) const
336 if (_analysis->points (channel) == 0) {
340 _rms[channel] = PointList();
342 list<float> smoothing;
344 int const N = _analysis->points(channel);
346 float const first = get_point(channel, 0)[AudioPoint::RMS];
347 float const last = get_point(channel, N - 1)[AudioPoint::RMS];
349 int const before = _smoothing / 2;
350 int const after = _smoothing - before;
352 /* Pre-load the smoothing list */
353 for (int i = 0; i < before; ++i) {
354 smoothing.push_back (first);
356 for (int i = 0; i < after; ++i) {
358 smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
360 smoothing.push_back (last);
364 for (int i = 0; i < N; ++i) {
366 int const next_for_window = i + after;
368 if (next_for_window < N) {
369 smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
371 smoothing.push_back (last);
374 smoothing.pop_front ();
377 for (list<float>::const_iterator j = smoothing.begin(); j != smoothing.end(); ++j) {
381 if (!smoothing.empty ()) {
382 p = sqrt (p / smoothing.size ());
385 _rms[channel].push_back (
387 wxPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (p, metrics)),
388 DCPTime::from_frames (i * _analysis->samples_per_point(), _analysis->sample_rate()),
394 DCPOMATIC_ASSERT (_rms.find(channel) != _rms.end());
396 path.MoveToPoint (_rms[channel][0].draw);
397 for (auto const& i: _rms[channel]) {
398 path.AddLineToPoint (i.draw);
404 AudioPlot::set_smoothing (int s)
414 AudioPlot::set_gain_correction (double gain)
416 _gain_correction = gain;
422 AudioPlot::get_point (int channel, int point) const
424 auto p = _analysis->get_point (channel, point);
425 for (int i = 0; i < AudioPoint::COUNT; ++i) {
426 p[i] *= db_to_linear(_gain_correction);
433 /** @param n Channel index.
434 * @return Colour used by that channel in the plot.
437 AudioPlot::colour (int n) const
439 DCPOMATIC_ASSERT (n < int(_colours.size()));
445 AudioPlot::left_down ()
448 if (auto fv = _viewer.lock()) {
449 fv->seek (_cursor->time, true);
456 AudioPlot::mouse_moved (wxMouseEvent& ev)
458 double min_dist = DBL_MAX;
461 auto search = [this](map<int, PointList> const & search, wxMouseEvent const & ev, double& min_dist, Point& min_point) {
462 for (auto const& i: search) {
463 if (_channel_visible[i.first]) {
464 for (auto const& j: i.second) {
465 double const dist = pow(ev.GetX() - j.draw.x, 2) + pow(ev.GetY() - j.draw.y, 2);
466 if (dist < min_dist) {
475 if (_type_visible[AudioPoint::RMS]) {
476 search (_rms, ev, min_dist, min_point);
478 if (_type_visible[AudioPoint::PEAK]) {
479 search (_peak, ev, min_dist, min_point);
482 _cursor = boost::none;
484 if (min_dist < DBL_MAX) {
485 wxRect before (min_point.draw.x - _cursor_size / 2, min_point.draw.y - _cursor_size / 2, _cursor_size, _cursor_size);
486 GetParent()->Refresh (true, &before);
488 wxRect after (min_point.draw.x - _cursor_size / 2, min_point.draw.y - _cursor_size / 2, _cursor_size, _cursor_size);
489 GetParent()->Refresh (true, &after);
490 Cursor (min_point.time, min_point.db);
496 AudioPlot::mouse_leave (wxMouseEvent &)
498 _cursor = boost::none;
500 Cursor (optional<DCPTime>(), optional<float>());