No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / wx / audio_plot.cc
index 693e11a61f408761bb1edc05170dab4c36a00798..c19ba946a6c362efdf09adfa98b6442303ecac61 100644 (file)
@@ -1,47 +1,53 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include <iostream>
-#include <boost/bind.hpp>
-#include <wx/graphics.h>
 #include "audio_plot.h"
-#include "lib/decoder_factory.h"
 #include "lib/audio_decoder.h"
 #include "lib/audio_analysis.h"
+#include "lib/compose.hpp"
 #include "wx/wx_util.h"
+#include <wx/graphics.h>
+#include <boost/bind.hpp>
+#include <iostream>
 
 using std::cout;
 using std::vector;
+using std::list;
 using std::max;
 using std::min;
 using boost::bind;
 using boost::shared_ptr;
 
-int const AudioPlot::_minimum = -90;
+int const AudioPlot::_minimum = -70;
+int const AudioPlot::max_smoothing = 128;
 
 AudioPlot::AudioPlot (wxWindow* parent)
-       : wxPanel (parent)
-       , _gain (0)
+       : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
+       , _smoothing (max_smoothing / 2)
+       , _gain_correction (0)
 {
+#ifndef __WXOSX__
        SetDoubleBuffered (true);
+#endif
 
-       for (int i = 0; i < MAX_AUDIO_CHANNELS; ++i) {
+       for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
                _channel_visible[i] = false;
        }
 
@@ -49,15 +55,32 @@ AudioPlot::AudioPlot (wxWindow* parent)
                _type_visible[i] = false;
        }
 
-       _colours.push_back (wxColour (  0,   0,   0));
-       _colours.push_back (wxColour (255,   0,   0));
-       _colours.push_back (wxColour (  0, 255,   0));
+       _colours.push_back (wxColour (  0,   0,   0));
+       _colours.push_back (wxColour (255,   0,   0));
+       _colours.push_back (wxColour (  0, 255,   0));
        _colours.push_back (wxColour (139,   0, 204));
-       _colours.push_back (wxColour (  0,   0, 255));
-       _colours.push_back (wxColour (100, 100, 100));
-       
-       Connect (wxID_ANY, wxEVT_PAINT, wxPaintEventHandler (AudioPlot::paint), 0, this);
-       
+       _colours.push_back (wxColour (  0,   0, 255));
+       _colours.push_back (wxColour (  0, 139,   0));
+       _colours.push_back (wxColour (  0,   0, 139));
+       _colours.push_back (wxColour (255, 255,   0));
+       _colours.push_back (wxColour (  0, 255, 255));
+       _colours.push_back (wxColour (255,   0, 255));
+       _colours.push_back (wxColour (255,   0, 139));
+       _colours.push_back (wxColour (139,   0, 255));
+
+       _colours.push_back (wxColour (139, 139, 255));
+       _colours.push_back (wxColour (  0, 139, 255));
+       _colours.push_back (wxColour (255, 139, 139));
+       _colours.push_back (wxColour (255, 139,   0));
+
+       set_analysis (shared_ptr<AudioAnalysis> ());
+
+#if MAX_DCP_AUDIO_CHANNELS != 16
+#warning AudioPlot::AudioPlot is expecting the wrong MAX_DCP_AUDIO_CHANNELS
+#endif
+
+       Bind (wxEVT_PAINT, boost::bind (&AudioPlot::paint, this));
+
        SetMinSize (wxSize (640, 512));
 }
 
@@ -66,14 +89,10 @@ AudioPlot::set_analysis (shared_ptr<AudioAnalysis> a)
 {
        _analysis = a;
 
-       for (int i = 0; i < MAX_AUDIO_CHANNELS; ++i) {
-               _channel_visible[i] = false;
+       if (!a) {
+               _message = _("Please wait; audio is being analysed...");
        }
 
-       for (int i = 0; i < AudioPoint::COUNT; ++i) {
-               _type_visible[i] = false;
-       }
-       
        Refresh ();
 }
 
@@ -92,7 +111,23 @@ AudioPlot::set_type_visible (int t, bool v)
 }
 
 void
-AudioPlot::paint (wxPaintEvent &)
+AudioPlot::set_message (wxString s)
+{
+       _message = s;
+       Refresh ();
+}
+
+struct Metrics
+{
+       double db_label_width;
+       int height;
+       int y_origin;
+       float x_scale;
+       float y_scale;
+};
+
+void
+AudioPlot::paint ()
 {
        wxPaintDC dc (this);
 
@@ -103,94 +138,184 @@ AudioPlot::paint (wxPaintEvent &)
 
        if (!_analysis || _analysis->channels() == 0) {
                gc->SetFont (gc->CreateFont (*wxNORMAL_FONT));
-               gc->DrawText (_("Please wait; audio is being analysed..."), 32, 32);
+               gc->DrawText (_message, 32, 32);
                return;
        }
 
        wxGraphicsPath grid = gc->CreatePath ();
        gc->SetFont (gc->CreateFont (*wxSMALL_FONT));
-       wxDouble db_label_width;
        wxDouble db_label_height;
        wxDouble db_label_descent;
        wxDouble db_label_leading;
-       gc->GetTextExtent (_("-80dB"), &db_label_width, &db_label_height, &db_label_descent, &db_label_leading);
+       Metrics metrics;
+       gc->GetTextExtent (wxT ("-80dB"), &metrics.db_label_width, &db_label_height, &db_label_descent, &db_label_leading);
+
+       metrics.db_label_width += 8;
 
-       db_label_width += 8;
-       
-       int const data_width = GetSize().GetWidth() - db_label_width;
+       int const data_width = GetSize().GetWidth() - metrics.db_label_width;
        /* Assume all channels have the same number of points */
-       float const xs = data_width / float (_analysis->points (0));
-       int const height = GetSize().GetHeight ();
-       int const yo = 32;
-       float const ys = (height - yo) / -_minimum;
+       metrics.x_scale = data_width / float (_analysis->points (0));
+       metrics.height = GetSize().GetHeight ();
+       metrics.y_origin = 32;
+       metrics.y_scale = (metrics.height - metrics.y_origin) / -_minimum;
 
        for (int i = _minimum; i <= 0; i += 10) {
-               int const y = (height - (i - _minimum) * ys) - yo;
-               grid.MoveToPoint (db_label_width - 4, y);
-               grid.AddLineToPoint (db_label_width + data_width, y);
+               int const y = (metrics.height - (i - _minimum) * metrics.y_scale) - metrics.y_origin;
+               grid.MoveToPoint (metrics.db_label_width - 4, y);
+               grid.AddLineToPoint (metrics.db_label_width + data_width, y);
                gc->DrawText (std_to_wx (String::compose ("%1dB", i)), 0, y - (db_label_height / 2));
        }
-       gc->SetPen (*wxLIGHT_GREY_PEN);
+
+       gc->SetPen (wxPen (wxColour (200, 200, 200)));
        gc->StrokePath (grid);
 
-       for (int c = 0; c < MAX_AUDIO_CHANNELS; ++c) {
-               if (!_channel_visible[c] || c >= _analysis->channels()) {
-                       continue;
-               }
+       gc->DrawText (_("Time"), data_width, metrics.height - metrics.y_origin + db_label_height / 2);
 
-               wxGraphicsPath path[AudioPoint::COUNT];
-               
-               for (int i = 0; i < AudioPoint::COUNT; ++i) {
-                       if (!_type_visible[i]) {
-                               continue;
+       if (_type_visible[AudioPoint::PEAK]) {
+               for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
+                       wxGraphicsPath p = gc->CreatePath ();
+                       if (_channel_visible[c] && c < _analysis->channels()) {
+                               plot_peak (p, c, metrics);
                        }
-                       
-                       path[i] = gc->CreatePath ();
-                       path[i].MoveToPoint (
-                               db_label_width,
-                               height - (max (_analysis->get_point(c, 0)[i], float (_minimum)) - _minimum + _gain) * ys - yo
-                               );
+                       wxColour const col = _colours[c];
+                       gc->SetPen (wxPen (wxColour (col.Red(), col.Green(), col.Blue(), col.Alpha() / 2), 1, wxPENSTYLE_SOLID));
+                       gc->StrokePath (p);
                }
+       }
 
-               for (int i = 0; i < _analysis->points(c); ++i) {
-                       for (int j = 0; j < AudioPoint::COUNT; ++j) {
-                               if (!_type_visible[j]) {
-                                       continue;
-                               }
-                               
-                               path[j].AddLineToPoint (
-                                       i * xs + db_label_width,
-                                       height - (max (_analysis->get_point(c, i)[j], float (_minimum)) - _minimum + _gain) * ys - yo
-                                       );
+       if (_type_visible[AudioPoint::RMS]) {
+               for (int c = 0; c < MAX_DCP_AUDIO_CHANNELS; ++c) {
+                       wxGraphicsPath p = gc->CreatePath ();
+                       if (_channel_visible[c] && c < _analysis->channels()) {
+                               plot_rms (p, c, metrics);
                        }
+                       wxColour const col = _colours[c];
+                       gc->SetPen (wxPen (col, 1, wxPENSTYLE_SOLID));
+                       gc->StrokePath (p);
                }
+       }
+
+       wxGraphicsPath axes = gc->CreatePath ();
+       axes.MoveToPoint (metrics.db_label_width, 0);
+       axes.AddLineToPoint (metrics.db_label_width, metrics.height - metrics.y_origin);
+       axes.AddLineToPoint (metrics.db_label_width + data_width, metrics.height - metrics.y_origin);
+       gc->SetPen (wxPen (wxColour (0, 0, 0)));
+       gc->StrokePath (axes);
 
-               wxColour const col = _colours[c];
+       delete gc;
+}
+
+float
+AudioPlot::y_for_linear (float p, Metrics const & metrics) const
+{
+       if (p < 1e-4) {
+               p = 1e-4;
+       }
 
-               if (_type_visible[AudioPoint::RMS]) {
-                       gc->SetPen (*wxThePenList->FindOrCreatePen (col));
-                       gc->StrokePath (path[AudioPoint::RMS]);
+       return metrics.height - (20 * log10(p) - _minimum) * metrics.y_scale - metrics.y_origin;
+}
+
+void
+AudioPlot::plot_peak (wxGraphicsPath& path, int channel, Metrics const & metrics) const
+{
+       if (_analysis->points (channel) == 0) {
+               return;
+       }
+
+       path.MoveToPoint (metrics.db_label_width, y_for_linear (get_point(channel, 0)[AudioPoint::PEAK], metrics));
+
+       float peak = 0;
+       int const N = _analysis->points(channel);
+       for (int i = 0; i < N; ++i) {
+               float const p = get_point(channel, i)[AudioPoint::PEAK];
+               peak -= 0.01f * (1 - log10 (_smoothing) / log10 (max_smoothing));
+               if (p > peak) {
+                       peak = p;
+               } else if (peak < 0) {
+                       peak = 0;
                }
 
-               if (_type_visible[AudioPoint::PEAK]) {
-                       gc->SetPen (*wxThePenList->FindOrCreatePen (wxColour (col.Red(), col.Green(), col.Blue(), col.Alpha() / 2)));
-                       gc->StrokePath (path[AudioPoint::PEAK]);
+               path.AddLineToPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (peak, metrics));
+       }
+}
+
+void
+AudioPlot::plot_rms (wxGraphicsPath& path, int channel, Metrics const & metrics) const
+{
+       if (_analysis->points (channel) == 0) {
+               return;
+       }
+
+       path.MoveToPoint (metrics.db_label_width, y_for_linear (get_point(channel, 0)[AudioPoint::RMS], metrics));
+
+       list<float> smoothing;
+
+       int const N = _analysis->points(channel);
+
+       float const first = get_point(channel, 0)[AudioPoint::RMS];
+       float const last = get_point(channel, N - 1)[AudioPoint::RMS];
+
+       int const before = _smoothing / 2;
+       int const after = _smoothing - before;
+
+       /* Pre-load the smoothing list */
+       for (int i = 0; i < before; ++i) {
+               smoothing.push_back (first);
+       }
+       for (int i = 0; i < after; ++i) {
+               if (i < N) {
+                       smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
+               } else {
+                       smoothing.push_back (last);
                }
        }
 
-       wxGraphicsPath axes = gc->CreatePath ();
-       axes.MoveToPoint (db_label_width, 0);
-       axes.AddLineToPoint (db_label_width, height - yo);
-       axes.AddLineToPoint (db_label_width + data_width, height - yo);
-       gc->SetPen (*wxBLACK_PEN);
-       gc->StrokePath (axes);
+       for (int i = 0; i < N; ++i) {
 
-       delete gc;
+               int const next_for_window = i + after;
+
+               if (next_for_window < N) {
+                       smoothing.push_back (get_point(channel, i)[AudioPoint::RMS]);
+               } else {
+                       smoothing.push_back (last);
+               }
+
+               smoothing.pop_front ();
+
+               float p = 0;
+               for (list<float>::const_iterator j = smoothing.begin(); j != smoothing.end(); ++j) {
+                       p += pow (*j, 2);
+               }
+
+               if (!smoothing.empty ()) {
+                       p = sqrt (p / smoothing.size ());
+               }
+
+               path.AddLineToPoint (metrics.db_label_width + i * metrics.x_scale, y_for_linear (p, metrics));
+       }
+}
+
+void
+AudioPlot::set_smoothing (int s)
+{
+       _smoothing = s;
+       Refresh ();
 }
 
 void
-AudioPlot::set_gain (float g)
+AudioPlot::set_gain_correction (double gain)
 {
-       _gain = g;
+       _gain_correction = gain;
        Refresh ();
 }
+
+AudioPoint
+AudioPlot::get_point (int channel, int point) const
+{
+       AudioPoint p = _analysis->get_point (channel, point);
+       for (int i = 0; i < AudioPoint::COUNT; ++i) {
+               p[i] *= pow (10, _gain_correction / 20);
+       }
+
+       return p;
+}