No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / wx / audio_dialog.cc
index a14498359078bc901fcfd5b8228bdb51137f1769..bce3c8628e34618313e90c534b99fe95b32ba97f 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 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 "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 boost::shared_ptr;
 using boost::bind;
 using boost::optional;
@@ -36,9 +40,11 @@ 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)
+AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
        : wxDialog (parent, wxID_ANY, _("Audio"), wxDefaultPosition, wxSize (640, 512), wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxFULL_REPAINT_ON_RESIZE)
        , _film (film)
+       , _content (content)
+       , _channels (film->audio_channels ())
        , _plot (0)
 {
        wxFont subheading_font (*wxNORMAL_FONT);
@@ -50,9 +56,15 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Au
        wxBoxSizer* left = new wxBoxSizer (wxVERTICAL);
 
        _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);
+       left->Add (_plot, 1, wxTOP | wxEXPAND, 12);
+       _sample_peak = new wxStaticText (this, wxID_ANY, wxT (""));
+       left->Add (_sample_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _true_peak = new wxStaticText (this, wxID_ANY, wxT (""));
+       left->Add (_true_peak, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _integrated_loudness = new wxStaticText (this, wxID_ANY, wxT (""));
+       left->Add (_integrated_loudness, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
+       _loudness_range = new wxStaticText (this, wxID_ANY, wxT (""));
+       left->Add (_loudness_range, 0, wxTOP, DCPOMATIC_SIZER_Y_GAP);
 
        lr_sizer->Add (left, 1, wxALL, 12);
 
@@ -64,7 +76,7 @@ AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Au
                right->Add (m, 1, wxALIGN_CENTER_VERTICAL | wxTOP | wxBOTTOM, 16);
        }
 
-       for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
+       for (int i = 0; i < _channels; ++i) {
                _channel_checkbox[i] = new wxCheckBox (this, wxID_ANY, std_to_wx (audio_channel_name (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));
@@ -133,14 +145,11 @@ AudioDialog::try_to_load_analysis ()
        shared_ptr<const Film> film = _film.lock ();
        DCPOMATIC_ASSERT (film);
 
-       boost::filesystem::path path = film->audio_analysis_path (_playlist);
-
+       boost::filesystem::path const path = film->audio_analysis_path (_playlist);
        if (!boost::filesystem::exists (path)) {
                _plot->set_analysis (shared_ptr<AudioAnalysis> ());
                _analysis.reset ();
-               shared_ptr<AnalyseAudioJob> job (new AnalyseAudioJob (film, _playlist));
-               _analysis_finished_connection = job->Finished.connect (bind (&AudioDialog::analysis_finished, this));
-               JobManager::instance()->add (job);
+               JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
                return;
        }
 
@@ -148,26 +157,39 @@ AudioDialog::try_to_load_analysis ()
                _analysis.reset (new AudioAnalysis (path));
        } catch (xmlpp::exception& e) {
                /* Probably an old-style analysis file: recreate it */
-               shared_ptr<AnalyseAudioJob> job (new AnalyseAudioJob (film, _playlist));
-               _analysis_finished_connection = job->Finished.connect (bind (&AudioDialog::analysis_finished, this));
-               JobManager::instance()->add (job);
+               JobManager::instance()->analyse_audio (film, _playlist, _analysis_finished_connection, bind (&AudioDialog::analysis_finished, this));
                return;
         }
 
        _plot->set_analysis (_analysis);
-       _plot->set_gain_correction (gain_correction ());
-       setup_peak_time ();
+       _plot->set_gain_correction (_analysis->gain_correction (_playlist));
+       setup_statistics ();
 
        /* Set up some defaults if no check boxes are checked */
 
        int i = 0;
-       while (i < MAX_DCP_AUDIO_CHANNELS && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
+       while (i < _channels && (!_channel_checkbox[i] || !_channel_checkbox[i]->GetValue ())) {
                ++i;
        }
 
-       if (i == MAX_DCP_AUDIO_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;
@@ -206,11 +228,11 @@ void
 AudioDialog::channel_clicked (wxCommandEvent& ev)
 {
        int c = 0;
-       while (c < MAX_DCP_AUDIO_CHANNELS && ev.GetEventObject() != _channel_checkbox[c]) {
+       while (c < _channels && ev.GetEventObject() != _channel_checkbox[c]) {
                ++c;
        }
 
-       DCPOMATIC_ASSERT (c < MAX_DCP_AUDIO_CHANNELS);
+       DCPOMATIC_ASSERT (c < _channels);
 
        _plot->set_channel_visible (c, _channel_checkbox[c]->GetValue ());
 }
@@ -218,15 +240,15 @@ AudioDialog::channel_clicked (wxCommandEvent& ev)
 void
 AudioDialog::content_changed (int p)
 {
-       if (p == AudioContentProperty::AUDIO_STREAMS) {
+       if (p == AudioContentProperty::STREAMS) {
                try_to_load_analysis ();
-       } else if (p == AudioContentProperty::AUDIO_GAIN) {
-               if (_playlist->content().size() == 1) {
+       } 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 (gain_correction ());
-                       setup_peak_time ();
+                       _plot->set_gain_correction (_analysis->gain_correction (_playlist));
+                       setup_statistics ();
                } else {
                        try_to_load_analysis ();
                }
@@ -253,9 +275,9 @@ AudioDialog::smoothing_changed ()
 }
 
 void
-AudioDialog::setup_peak_time ()
+AudioDialog::setup_statistics ()
 {
-       if (!_analysis || !_analysis->peak ()) {
+       if (!_analysis) {
                return;
        }
 
@@ -264,20 +286,55 @@ AudioDialog::setup_peak_time ()
                return;
        }
 
-       float const peak_dB = 20 * log10 (_analysis->peak().get()) + gain_correction ();
+       if (static_cast<bool>(_analysis->sample_peak ())) {
 
-       _peak_time->SetLabel (
-               wxString::Format (
-                       _("Peak is %.2fdB at %s"),
-                       peak_dB,
-                       time_to_timecode (_analysis->peak_time().get(), film->video_frame_rate ()).data ()
-                       )
-               );
+               float const peak_dB = 20 * log10 (_analysis->sample_peak().get()) + _analysis->gain_correction (_playlist);
 
-       if (peak_dB > -3) {
-               _peak_time->SetForegroundColour (wxColour (255, 0, 0));
-       } else {
-               _peak_time->SetForegroundColour (wxColour (0, 0, 0));
+               _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));
+               }
+       }
+
+       if (static_cast<bool>(_analysis->true_peak ())) {
+               float const peak_dB = 20 * log10 (_analysis->true_peak().get()) + _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)
+                               )
+                       );
        }
 }
 
@@ -288,22 +345,3 @@ AudioDialog::Show (bool show)
        try_to_load_analysis ();
        return r;
 }
-
-/** @return gain correction in dB required to be added to raw gain values to render
- *  the dialog correctly.
- */
-float
-AudioDialog::gain_correction ()
-{
-       if (_playlist->content().size() == 1 && _analysis->analysis_gain ()) {
-               /* In this case we know that the analysis was of a single piece of content and
-                  we know that content's gain when the analysis was run.  Hence we can work out
-                  what correction is now needed to make it look `right'.
-               */
-               shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (_playlist->content().front ());
-               DCPOMATIC_ASSERT (ac);
-               return ac->audio_gain() - _analysis->analysis_gain().get ();
-       }
-
-       return 0.0f;
-}