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 #include "audio_plot.h"
23 #include "film_viewer.h"
24 #include "lib/audio_decoder.h"
25 #include "lib/audio_analysis.h"
26 #include "lib/compose.hpp"
27 #include <wx/graphics.h>
28 #include <boost/bind/bind.hpp>
39 using boost::optional;
40 using boost::shared_ptr;
41 using boost::weak_ptr;
42 #if BOOST_VERSION >= 106100
43 using namespace boost::placeholders;
45 using namespace dcpomatic;
47 int const AudioPlot::_minimum = -70;
48 int const AudioPlot::_cursor_size = 8;
49 int const AudioPlot::max_smoothing = 128;
51 AudioPlot::AudioPlot (wxWindow* parent, weak_ptr<FilmViewer> viewer)
52 : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
54 , _smoothing (max_smoothing / 2)
55 , _gain_correction (0)
58 SetDoubleBuffered (true);
61 for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
62 _channel_visible[i] = false;
65 for (int i = 0; i < AudioPoint::COUNT; ++i) {
66 _type_visible[i] = false;
69 _colours.push_back (wxColour ( 0, 0, 0));
70 _colours.push_back (wxColour (255, 0, 0));
71 _colours.push_back (wxColour ( 0, 255, 0));
72 _colours.push_back (wxColour (139, 0, 204));
73 _colours.push_back (wxColour ( 0, 0, 255));
74 _colours.push_back (wxColour ( 0, 139, 0));
75 _colours.push_back (wxColour ( 0, 0, 139));
76 _colours.push_back (wxColour (255, 255, 0));
77 _colours.push_back (wxColour ( 0, 255, 255));
78 _colours.push_back (wxColour (255, 0, 255));
79 _colours.push_back (wxColour (255, 0, 139));
80 _colours.push_back (wxColour (139, 0, 255));
82 _colours.push_back (wxColour (139, 139, 255));
83 _colours.push_back (wxColour ( 0, 139, 255));
84 _colours.push_back (wxColour (255, 139, 139));
85 _colours.push_back (wxColour (255, 139, 0));
87 set_analysis (shared_ptr<AudioAnalysis> ());
89 #if MAX_DCP_AUDIO_CHANNELS != 16
90 #warning AudioPlot::AudioPlot is expecting the wrong MAX_DCP_AUDIO_CHANNELS
93 Bind (wxEVT_PAINT, boost::bind (&AudioPlot::paint, this));
94 Bind (wxEVT_MOTION, boost::bind (&AudioPlot::mouse_moved, this, _1));
95 Bind (wxEVT_LEAVE_WINDOW, boost::bind (&AudioPlot::mouse_leave, this, _1));
96 Bind (wxEVT_LEFT_DOWN, boost::bind(&AudioPlot::left_down, this));
98 SetMinSize (wxSize (640, 512));
102 AudioPlot::set_analysis (shared_ptr<AudioAnalysis> a)
107 _message = _("Please wait; audio is being analysed...");
114 AudioPlot::set_channel_visible (int c, bool v)
116 _channel_visible[c] = v;
121 AudioPlot::set_type_visible (int t, bool v)
123 _type_visible[t] = v;
128 AudioPlot::set_message (wxString s)
136 double db_label_width;
139 float x_scale; ///< pixels per data point
148 wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
153 if (!_analysis || _analysis->channels() == 0) {
154 gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
155 gc->DrawText (_message, 32, 32);
160 wxGraphicsPath h_grid = gc->CreatePath ();
161 gc->SetFont (gc->CreateFont (*wxSMALL_FONT));
162 wxDouble db_label_height;
163 wxDouble db_label_descent;
164 wxDouble db_label_leading;
166 gc->GetTextExtent (wxT ("-80dB"), &metrics.db_label_width, &db_label_height, &db_label_descent, &db_label_leading);
168 metrics.db_label_width += 8;
170 int const data_width = GetSize().GetWidth() - metrics.db_label_width;
171 /* Assume all channels have the same number of points */
172 metrics.x_scale = data_width / float (_analysis->points (0));
173 metrics.height = GetSize().GetHeight ();
174 metrics.y_origin = 32;
175 metrics.y_scale = (metrics.height - metrics.y_origin) / -_minimum;
177 for (int i = _minimum; i <= 0; i += 10) {
178 int const y = (metrics.height - (i - _minimum) * metrics.y_scale) - metrics.y_origin;
179 h_grid.MoveToPoint (metrics.db_label_width - 4, y);
180 h_grid.AddLineToPoint (metrics.db_label_width + data_width, y);
181 gc->DrawText (std_to_wx (String::compose ("%1dB", i)), 0, y - (db_label_height / 2));
184 gc->SetPen (wxPen (wxColour (200, 200, 200)));
185 gc->StrokePath (h_grid);
187 /* Draw an x axis with marks */
189 wxGraphicsPath v_grid = gc->CreatePath ();
191 DCPOMATIC_ASSERT (_analysis->samples_per_point() != 0.0);
192 double const pps = _analysis->sample_rate() * metrics.x_scale / _analysis->samples_per_point();
194 gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (0, 0, 0), 1, wxPENSTYLE_SOLID));
196 double const mark_interval = calculate_mark_interval (rint (128 / pps));
198 DCPTime t = DCPTime::from_seconds (mark_interval);
199 while ((t.seconds() * pps) < data_width) {
200 double tc = t.seconds ();
201 int const h = tc / 3600;
203 int const m = tc / 60;
207 wxString str = wxString::Format (wxT ("%02d:%02d:%02d"), h, m, s);
210 wxDouble str_descent;
211 wxDouble str_leading;
212 gc->GetTextExtent (str, &str_width, &str_height, &str_descent, &str_leading);
214 int const tx = llrintf (metrics.db_label_width + t.seconds() * pps);
215 gc->DrawText (str, tx - str_width / 2, metrics.height - metrics.y_origin + db_label_height);
217 v_grid.MoveToPoint (tx, metrics.height - metrics.y_origin + 4);
218 v_grid.AddLineToPoint (tx, metrics.y_origin);
220 t += DCPTime::from_seconds (mark_interval);
223 gc->SetPen (wxPen (wxColour (200, 200, 200)));
224 gc->StrokePath (v_grid);
226 if (_type_visible[AudioPoint::PEAK]) {
227 for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
228 wxGraphicsPath p = gc->CreatePath ();
229 if (_channel_visible[c] && c < _analysis->channels()) {
230 plot_peak (p, c, metrics);
232 wxColour const col = _colours[c];
233 gc->SetPen (wxPen (wxColour (col.Red(), col.Green(), col.Blue(), col.Alpha() / 2), 1, wxPENSTYLE_SOLID));
238 if (_type_visible[AudioPoint::RMS]) {
239 for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
240 wxGraphicsPath p = gc->CreatePath ();
241 if (_channel_visible[c] && c < _analysis->channels()) {
242 plot_rms (p, c, metrics);
244 wxColour const col = _colours[c];
245 gc->SetPen (wxPen (col, 1, wxPENSTYLE_SOLID));
250 wxGraphicsPath axes = gc->CreatePath ();
251 axes.MoveToPoint (metrics.db_label_width, 0);
252 axes.AddLineToPoint (metrics.db_label_width, metrics.height - metrics.y_origin);
253 axes.AddLineToPoint (metrics.db_label_width + data_width, metrics.height - metrics.y_origin);
254 gc->SetPen (wxPen (wxColour (0, 0, 0)));
255 gc->StrokePath (axes);
258 wxGraphicsPath cursor = gc->CreatePath ();
259 cursor.MoveToPoint (_cursor->draw.x - _cursor_size / 2, _cursor->draw.y - _cursor_size / 2);
260 cursor.AddLineToPoint (_cursor->draw.x + _cursor_size / 2, _cursor->draw.y + _cursor_size / 2);
261 cursor.MoveToPoint (_cursor->draw.x + _cursor_size / 2, _cursor->draw.y - _cursor_size / 2);
262 cursor.AddLineToPoint (_cursor->draw.x - _cursor_size / 2, _cursor->draw.y + _cursor_size / 2);
263 gc->StrokePath (cursor);
272 AudioPlot::y_for_linear (float p, Metrics const & metrics) const
278 return metrics.height - (linear_to_db(p) - _minimum) * metrics.y_scale - metrics.y_origin;
282 AudioPlot::plot_peak (wxGraphicsPath& path, int channel, Metrics const & metrics) const
284 if (_analysis->points (channel) == 0) {
288 _peak[channel] = PointList ();
291 int const N = _analysis->points(channel);
292 for (int i = 0; i < N; ++i) {
293 float const p = get_point(channel, i)[AudioPoint::PEAK];
294 peak -= 0.01f * (1 - log10 (_smoothing) / log10 (max_smoothing));
297 } else if (peak < 0) {
301 _peak[channel].push_back (
303 wxPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (peak, metrics)),
304 DCPTime::from_frames (i * _analysis->samples_per_point(), _analysis->sample_rate()),
310 DCPOMATIC_ASSERT (_peak.find(channel) != _peak.end());
312 path.MoveToPoint (_peak[channel][0].draw);
313 BOOST_FOREACH (Point const & i, _peak[channel]) {
314 path.AddLineToPoint (i.draw);
319 AudioPlot::plot_rms (wxGraphicsPath& path, int channel, Metrics const & metrics) const
321 if (_analysis->points (channel) == 0) {
325 _rms[channel] = PointList();
327 list<float> smoothing;
329 int const N = _analysis->points(channel);
331 float const first = get_point(channel, 0)[AudioPoint::RMS];
332 float const last = get_point(channel, N - 1)[AudioPoint::RMS];
334 int const before = _smoothing / 2;
335 int const after = _smoothing - before;
337 /* Pre-load the smoothing list */
338 for (int i = 0; i < before; ++i) {
339 smoothing.push_back (first);
341 for (int i = 0; i < after; ++i) {
343 smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
345 smoothing.push_back (last);
349 for (int i = 0; i < N; ++i) {
351 int const next_for_window = i + after;
353 if (next_for_window < N) {
354 smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
356 smoothing.push_back (last);
359 smoothing.pop_front ();
362 for (list<float>::const_iterator j = smoothing.begin(); j != smoothing.end(); ++j) {
366 if (!smoothing.empty ()) {
367 p = sqrt (p / smoothing.size ());
370 _rms[channel].push_back (
372 wxPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (p, metrics)),
373 DCPTime::from_frames (i * _analysis->samples_per_point(), _analysis->sample_rate()),
379 DCPOMATIC_ASSERT (_rms.find(channel) != _rms.end());
381 path.MoveToPoint (_rms[channel][0].draw);
382 BOOST_FOREACH (Point const & i, _rms[channel]) {
383 path.AddLineToPoint (i.draw);
388 AudioPlot::set_smoothing (int s)
397 AudioPlot::set_gain_correction (double gain)
399 _gain_correction = gain;
404 AudioPlot::get_point (int channel, int point) const
406 AudioPoint p = _analysis->get_point (channel, point);
407 for (int i = 0; i < AudioPoint::COUNT; ++i) {
408 p[i] *= db_to_linear(_gain_correction);
414 /** @param n Channel index.
415 * @return Colour used by that channel in the plot.
418 AudioPlot::colour (int n) const
420 DCPOMATIC_ASSERT (n < int(_colours.size()));
425 AudioPlot::search (map<int, PointList> const & search, wxMouseEvent const & ev, double& min_dist, Point& min_point) const
427 for (map<int, PointList>::const_iterator i = search.begin(); i != search.end(); ++i) {
428 BOOST_FOREACH (Point const & j, i->second) {
429 double const dist = pow(ev.GetX() - j.draw.x, 2) + pow(ev.GetY() - j.draw.y, 2);
430 if (dist < min_dist) {
440 AudioPlot::left_down ()
443 shared_ptr<FilmViewer> fv = _viewer.lock ();
445 fv->seek (_cursor->time, true);
452 AudioPlot::mouse_moved (wxMouseEvent& ev)
454 double min_dist = DBL_MAX;
457 search (_rms, ev, min_dist, min_point);
458 search (_peak, ev, min_dist, min_point);
460 _cursor = optional<Point> ();
462 if (min_dist < DBL_MAX) {
463 wxRect before (min_point.draw.x - _cursor_size / 2, min_point.draw.y - _cursor_size / 2, _cursor_size, _cursor_size);
464 GetParent()->Refresh (true, &before);
466 wxRect after (min_point.draw.x - _cursor_size / 2, min_point.draw.y - _cursor_size / 2, _cursor_size, _cursor_size);
467 GetParent()->Refresh (true, &after);
468 Cursor (min_point.time, min_point.db);
473 AudioPlot::mouse_leave (wxMouseEvent &)
475 _cursor = optional<Point> ();
477 Cursor (optional<DCPTime>(), optional<float>());