Don't display all possible channel checkboxes while the analysis
[dcpomatic.git] / src / wx / audio_dialog.cc
index b7f1f613b0723252158d61ea5d8db367a6c589d6..0f6bace2590282c8ad792513e22afd1fcdf03ab0 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -21,6 +21,8 @@
 #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"
 
 using std::cout;
 using std::list;
+using std::vector;
+using std::pair;
 using boost::shared_ptr;
+using boost::weak_ptr;
 using boost::bind;
 using boost::optional;
 using boost::const_pointer_cast;
 using boost::dynamic_pointer_cast;
+using namespace dcpomatic;
 
-/** @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)
+/** @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, weak_ptr<FilmViewer> viewer, 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)
+       , _viewer (viewer)
        , _content (content)
        , _channels (film->audio_channels ())
        , _plot (0)
@@ -62,39 +79,42 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Co
 
        wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
 
-       _plot = new AudioPlot (this);
+       _cursor = new StaticText (this, wxT("Cursor: none"));
+       left->Add (_cursor, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _plot = new AudioPlot (this, viewer);
        left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
-       _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
+       _sample_peak = new StaticText (this, wxT (""));
        left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
-       _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
+       _true_peak = new StaticText (this, wxT (""));
        left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
-       _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
+       _integrated_loudness = new StaticText (this, wxT (""));
        left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
-       _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
+       _loudness_range = new StaticText (this, wxT (""));
        left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _leqm = new StaticText (this, wxT(""));
+       left->Add (_leqm, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
 
-       lr_sizer->Add (left, 1, wxALL, 12);
+       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));
        }
 
-       for (int i = _channels; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
-               _channel_checkbox[i] = 0;
-       }
+       show_or_hide_channel_checkboxes ();
 
        {
-               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);
        }
@@ -105,13 +125,13 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Co
        };
 
        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);
        }
@@ -122,7 +142,7 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Co
 
        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);
@@ -135,17 +155,35 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Co
        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
+AudioDialog::show_or_hide_channel_checkboxes ()
+{
+       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 ();
+       }
+}
+
+
 void
 AudioDialog::try_to_load_analysis ()
 {
@@ -156,25 +194,45 @@ 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_statistics ();
+       show_or_hide_channel_checkboxes ();
 
        /* Set up some defaults if no check boxes are checked */
 
@@ -252,8 +310,28 @@ AudioDialog::channel_clicked (wxCommandEvent& ev)
 }
 
 void
-AudioDialog::content_changed (int p)
+AudioDialog::film_change (ChangeType type, int p)
 {
+       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::GAIN) {
@@ -300,27 +378,26 @@ AudioDialog::setup_statistics ()
                return;
        }
 
-       if (static_cast<bool>(_analysis->sample_peak ())) {
-
-               float const peak_dB = 20 * log10 (_analysis->sample_peak().get()) + _analysis->gain_correction (_playlist);
-
-               _sample_peak->SetLabel (
-                       wxString::Format (
-                               _("Sample peak is %.2fdB at %s"),
-                               peak_dB,
-                               time_to_timecode (_analysis->sample_peak_time().get(), film->video_frame_rate ()).data ()
-                               )
-                       );
-
-               if (peak_dB > -3) {
-                       _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
-               } else {
-                       _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
-               }
+       pair<AudioAnalysis::PeakTime, int> const peak = _analysis->overall_sample_peak ();
+       float const peak_dB = linear_to_db(peak.first.peak) + _analysis->gain_correction(_playlist);
+       _sample_peak->SetLabel (
+               wxString::Format (
+                       _("Sample peak is %.2fdB at %s on %s"),
+                       peak_dB,
+                       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) {
+               _sample_peak->SetForegroundColour (wxColour (255, 0, 0));
+       } else {
+               _sample_peak->SetForegroundColour (wxColour (0, 0, 0));
        }
 
-       if (static_cast<bool>(_analysis->true_peak ())) {
-               float const peak_dB = 20 * log10 (_analysis->true_peak().get()) + _analysis->gain_correction (_playlist);
+       if (_analysis->overall_true_peak()) {
+               float const peak = _analysis->overall_true_peak().get();
+               float const peak_dB = linear_to_db(peak) + _analysis->gain_correction(_playlist);
 
                _true_peak->SetLabel (wxString::Format (_("True peak is %.2fdB"), peak_dB));
 
@@ -350,6 +427,14 @@ AudioDialog::setup_statistics ()
                                )
                        );
        }
+
+       if (static_cast<bool>(_analysis->leqm())) {
+               _leqm->SetLabel(
+                       wxString::Format(
+                               _("LEQ(m) %.2fdB"), _analysis->leqm().get() + _analysis->gain_correction(_playlist)
+                               )
+                       );
+       }
 }
 
 bool
@@ -359,3 +444,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())));
+}