Re-analyse audio when DCP channel count changes (#1189).
[dcpomatic.git] / src / wx / audio_dialog.cc
index 8e67215..f4de9cd 100644 (file)
@@ -1,25 +1,28 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 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 "audio_dialog.h"
 #include "audio_plot.h"
 #include "wx_util.h"
+#include "static_text.h"
+#include "check_box.h"
 #include "lib/audio_analysis.h"
 #include "lib/film.h"
 #include "lib/analyse_audio_job.h"
 #include "lib/job_manager.h"
 #include <libxml++/libxml++.h>
 #include <boost/filesystem.hpp>
+#include <boost/foreach.hpp>
 #include <iostream>
 
 using std::cout;
+using std::list;
+using std::vector;
+using std::pair;
 using boost::shared_ptr;
 using boost::bind;
 using boost::optional;
 using boost::const_pointer_cast;
 using boost::dynamic_pointer_cast;
 
-/** @param content Content to analyse, or 0 to analyse all of the film's audio */
-AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<AudioContent> content)
-       : wxDialog (parent, wxID_ANY, _("Audio"), wxDefaultPosition, wxSize (640, 512), wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE)
+/** @param parent Parent window.
+ *  @param film Film we are using.
+ *  @param content Content to analyse, or 0 to analyse all of the film's audio.
+ */
+AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
+       : wxDialog (
+               parent,
+               wxID_ANY,
+               _("Audio"),
+               wxDefaultPosition,
+               wxSize (640, 512),
+#ifdef DCPOMATIC_OSX
+               /* I can't get wxFRAME_FLOAT_ON_PARENT to work on OS X, and although wxSTAY_ON_TOP keeps
+                  the window above all others (and not just our own) it's better than nothing for now.
+               */
+               wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxSTAY_ON_TOP
+#else
+               wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE | wxFRAME_FLOAT_ON_PARENT
+#endif
+               )
        , _film (film)
+       , _content (content)
        , _channels (film->audio_channels ())
        , _plot (0)
 {
@@ -51,29 +76,38 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Au
 
        wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
 
+       _cursor = new StaticText (this, wxT("Cursor: none"));
+       left->Add (_cursor, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
        _plot = new AudioPlot (this);
-       left->Add (_plot, 1, wxALL | wxEXPAND, 12);
-       _peak_time = new wxStaticText (this, wxID_ANY, wxT (""));
-       left->Add (_peak_time, 0, wxALL, 12);
-
-       lr_sizer->Add (left, 1, wxALL, 12);
+       left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
+       _sample_peak = new StaticText (this, wxT (""));
+       left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _true_peak = new StaticText (this, wxT (""));
+       left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _integrated_loudness = new StaticText (this, wxT (""));
+       left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _loudness_range = new StaticText (this, wxT (""));
+       left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+
+       lr_sizer->Add (left, 1, wxALL | wxEXPAND, 12);
 
        wxBoxSizer* right = new wxBoxSizer (wxVERTICAL);
 
        {
-               wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Channels"));
+               wxStaticText* m = new StaticText (this, _("Channels"));
                m->SetFont (subheading_font);
                right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
        }
 
-       for (int i = 0; i < _channels; ++i) {
-               _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (i)));
+       for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
+               _channel_checkbox[i] = new CheckBox (this, std_to_wx(audio_channel_name(i)));
+               _channel_checkbox[i]->SetForegroundColour(wxColour(_plot->colour(i)));
                right->Add (_channel_checkbox[i], 0, wxEXPAND | wxALL, 3);
-               _channel_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::channel_clicked, this, _1));
+               _channel_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::channel_clicked, this, _1));
        }
 
        {
-               wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Type"));
+               wxStaticText* m = new StaticText (this, _("Type"));
                m->SetFont (subheading_font);
                right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
        }
@@ -84,13 +118,13 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Au
        };
 
        for (int i = 0; i < AudioPoint::COUNT; ++i) {
-               _type_checkbox[i] = new wxCheckBox (this, wxID_ANY, types[i]);
+               _type_checkbox[i] = new CheckBox (this, types[i]);
                right->Add (_type_checkbox[i], 0, wxEXPAND | wxALL, 3);
-               _type_checkbox[i]->Bind (wxEVT_COMMAND_CHECKBOX_CLICKED, boost::bind (&AudioDialog::type_clicked, this, _1));
+               _type_checkbox[i]->Bind (wxEVT_CHECKBOX, boost::bind (&AudioDialog::type_clicked, this, _1));
        }
 
        {
-               wxStaticText* m = new wxStaticText (this, wxID_ANY, _("Smoothing"));
+               wxStaticText* m = new StaticText (this, _("Smoothing"));
                m->SetFont (subheading_font);
                right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP, 16);
        }
@@ -101,7 +135,7 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Au
 
        lr_sizer->Add (right, 0, wxALL, 12);
 
-       overall_sizer->Add (lr_sizer);
+       overall_sizer->Add (lr_sizer, 0, wxEXPAND);
 
 #ifdef DCPOMATIC_LINUX
        wxSizer* buttons = CreateSeparatedButtonSizer (wxCLOSE);
@@ -114,15 +148,19 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Au
        overall_sizer->Layout ();
        overall_sizer->SetSizeHints (this);
 
-       _film_connection = film->ContentChanged.connect (boost::bind (&AudioDialog::content_changed, this, _2));
-       SetTitle (_("DCP-o-matic audio"));
+       _film_connection = film->Change.connect (boost::bind(&AudioDialog::film_change, this, _1, _2));
+       _film_content_connection = film->ContentChange.connect (boost::bind (&AudioDialog::content_change, this, _1, _3));
+       DCPOMATIC_ASSERT (film->directory());
+       SetTitle(wxString::Format(_("DCP-o-matic audio - %s"), std_to_wx(film->directory().get().string())));
 
        if (content) {
                _playlist.reset (new Playlist ());
-               const_pointer_cast<Playlist> (_playlist)->add (content);
+               const_pointer_cast<Playlist>(_playlist)->add(film, content);
        } else {
                _playlist = film->playlist ();
        }
+
+       _plot->Cursor.connect (bind (&AudioDialog::set_cursor, this, _1, _2));
 }
 
 void
@@ -135,25 +173,52 @@ AudioDialog::try_to_load_analysis ()
        shared_ptr<const Film> film = _film.lock ();
        DCPOMATIC_ASSERT (film);
 
+       shared_ptr<Content> check = _content.lock();
+
        boost::filesystem::path const path = film->audio_analysis_path (_playlist);
        if (!boost::filesystem::exists (path)) {
                _plot->set_analysis (shared_ptr<AudioAnalysis> ());
                _analysis.reset ();
-               JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
+
+               BOOST_FOREACH (shared_ptr<Job> i, JobManager::instance()->get()) {
+                       if (dynamic_pointer_cast<AnalyseAudioJob>(i)) {
+                               i->cancel ();
+                       }
+               }
+
+               JobManager::instance()->analyse_audio (
+                       film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
+                       );
                return;
        }
 
        try {
                _analysis.reset (new AudioAnalysis (path));
+       } catch (OldFormatError& e) {
+               /* An old analysis file: recreate it */
+               JobManager::instance()->analyse_audio (
+                       film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
+                       );
+               return;
        } catch (xmlpp::exception& e) {
-               /* Probably an old-style analysis file: recreate it */
-               JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
+               /* Probably a (very) old-style analysis file: recreate it */
+               JobManager::instance()->analyse_audio (
+                       film, _playlist, !static_cast<bool>(check), _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this)
+                       );
                return;
         }
 
        _plot->set_analysis (_analysis);
        _plot->set_gain_correction (_analysis->gain_correction (_playlist));
-       setup_peak_time ();
+       setup_statistics ();
+
+       for (int i = 0; i < _channels; ++i) {
+               _channel_checkbox[i]->Show ();
+       }
+
+       for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
+               _channel_checkbox[i]->Hide ();
+       }
 
        /* Set up some defaults if no check boxes are checked */
 
@@ -162,9 +227,24 @@ AudioDialog::try_to_load_analysis ()
                ++i;
        }
 
-       if (i == _channels && _channel_checkbox[0]) {
-               _channel_checkbox[0]->SetValue (true);
-               _plot->set_channel_visible (0, true);
+       if (i == _channels) {
+               /* Nothing checked; check mapped ones */
+
+               list<int> mapped;
+               shared_ptr<Content> content = _content.lock ();
+
+               if (content) {
+                       mapped = content->audio->mapping().mapped_output_channels ();
+               } else {
+                       mapped = film->mapped_audio_channels ();
+               }
+
+               BOOST_FOREACH (int i, mapped) {
+                       if (_channel_checkbox[i]) {
+                               _channel_checkbox[i]->SetValue (true);
+                               _plot->set_channel_visible (i, true);
+                       }
+               }
        }
 
        i = 0;
@@ -186,7 +266,10 @@ void
 AudioDialog::analysis_finished ()
 {
        shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
+       if (!film) {
+               /* This should not happen, but if it does we should just give up quietly */
+               return;
+       }
 
        if (!boost::filesystem::exists (film->audio_analysis_path (_playlist))) {
                /* We analysed and still nothing showed up, so maybe it was cancelled or it failed.
@@ -213,17 +296,37 @@ AudioDialog::channel_clicked (wxCommandEvent& ev)
 }
 
 void
-AudioDialog::content_changed (int p)
+AudioDialog::film_change (ChangeType type, int p)
 {
-       if (p == AudioContentProperty::AUDIO_STREAMS) {
+       if (type != CHANGE_TYPE_DONE) {
+               return;
+       }
+
+       if (p == Film::AUDIO_CHANNELS) {
+               shared_ptr<Film> film = _film.lock ();
+               if (film) {
+                       _channels = film->audio_channels ();
+                       try_to_load_analysis ();
+               }
+       }
+}
+
+void
+AudioDialog::content_change (ChangeType type, int p)
+{
+       if (type != CHANGE_TYPE_DONE) {
+               return;
+       }
+
+       if (p == AudioContentProperty::STREAMS) {
                try_to_load_analysis ();
-       } else if (p == AudioContentProperty::AUDIO_GAIN) {
+       } else if (p == AudioContentProperty::GAIN) {
                if (_playlist->content().size() == 1 && _analysis) {
                        /* We can use a short-cut to render the effect of this
                           change, rather than recalculating everything.
                        */
                        _plot->set_gain_correction (_analysis->gain_correction (_playlist));
-                       setup_peak_time ();
+                       setup_statistics ();
                } else {
                        try_to_load_analysis ();
                }
@@ -250,9 +353,9 @@ AudioDialog::smoothing_changed ()
 }
 
 void
-AudioDialog::setup_peak_time ()
+AudioDialog::setup_statistics ()
 {
-       if (!_analysis || !_analysis->peak ()) {
+       if (!_analysis) {
                return;
        }
 
@@ -261,20 +364,54 @@ AudioDialog::setup_peak_time ()
                return;
        }
 
-       float const peak_dB = 20 * log10 (_analysis->peak().get()) + _analysis->gain_correction (_playlist);
-
-       _peak_time->SetLabel (
+       pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
+       float const peak_dB = 20 * log10 (peak.first.peak) + _analysis->gain_correction (_playlist);
+       _sample_peak->SetLabel (
                wxString::Format (
-                       _("Peak is %.2fdB at %s"),
+                       _("Sample peak is %.2fdB at %s on %s"),
                        peak_dB,
-                       time_to_timecode (_analysis->peak_time().get(), film->video_frame_rate ()).data ()
+                       time_to_timecode (peak.first.time, film->video_frame_rate ()).data (),
+                       std_to_wx (short_audio_channel_name (peak.second)).data ()
                        )
                );
 
        if (peak_dB > -3) {
-               _peak_time->SetForegroundColour (wxColour (255, 0, 0));
+               _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
        } else {
-               _peak_time->SetForegroundColour (wxColour (0, 0, 0));
+               _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
+       }
+
+       if (_analysis->overall_true_peak()) {
+               float const peak = _analysis->overall_true_peak().get();
+               float const peak_dB = 20 * log10 (peak) + _analysis->gain_correction (_playlist);
+
+               _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
+
+               if (peak_dB > -3) {
+                       _true_peak->SetForegroundColour (wxColour (255, 0, 0));
+               } else {
+                       _true_peak->SetForegroundColour (wxColour (0, 0, 0));
+               }
+       }
+
+       /* XXX: check whether it's ok to add dB gain to these quantities */
+
+       if (static_cast<bool>(_analysis->integrated_loudness ())) {
+               _integrated_loudness->SetLabel (
+                       wxString::Format (
+                               _("Integrated loudness %.2f LUFS"),
+                               _analysis->integrated_loudness().get() + _analysis->gain_correction (_playlist)
+                               )
+                       );
+       }
+
+       if (static_cast<bool>(_analysis->loudness_range ())) {
+               _loudness_range->SetLabel (
+                       wxString::Format (
+                               _("Loudness range %.2f LU"),
+                               _analysis->loudness_range().get() + _analysis->gain_correction (_playlist)
+                               )
+                       );
        }
 }
 
@@ -285,3 +422,16 @@ AudioDialog::Show (bool show)
        try_to_load_analysis ();
        return r;
 }
+
+void
+AudioDialog::set_cursor (optional<DCPTime> time, optional<float> db)
+{
+       if (!time || !db) {
+               _cursor->SetLabel (_("Cursor: none"));
+               return;
+       }
+
+       shared_ptr<Film> film = _film.lock();
+       DCPOMATIC_ASSERT (film);
+       _cursor->SetLabel (wxString::Format (_("Cursor: %.1fdB at %s"), *db, time->timecode(film->video_frame_rate())));
+}