No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / audio_analysis.cc
index 73422a9be9ad8a2f3a6039d7487c284ddfe4f8bf..1863e38eeae85bf633c79151dc335fd4e3d9be09 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2012-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/>.
 
 */
 
@@ -21,6 +22,8 @@
 #include "cross.h"
 #include "util.h"
 #include "raw_convert.h"
+#include "playlist.h"
+#include "audio_content.h"
 #include <libxml++/libxml++.h>
 #include <boost/filesystem.hpp>
 #include <boost/foreach.hpp>
@@ -38,48 +41,8 @@ using std::cout;
 using std::max;
 using std::list;
 using boost::shared_ptr;
+using boost::dynamic_pointer_cast;
 
-AudioPoint::AudioPoint ()
-{
-       for (int i = 0; i < COUNT; ++i) {
-               _data[i] = 0;
-       }
-}
-
-AudioPoint::AudioPoint (cxml::ConstNodePtr node)
-{
-       _data[PEAK] = node->number_child<float> ("Peak");
-       _data[RMS] = node->number_child<float> ("RMS");
-}
-
-AudioPoint::AudioPoint (AudioPoint const & other)
-{
-       for (int i = 0; i < COUNT; ++i) {
-               _data[i] = other._data[i];
-       }
-}
-
-AudioPoint &
-AudioPoint::operator= (AudioPoint const & other)
-{
-       if (this == &other) {
-               return *this;
-       }
-       
-       for (int i = 0; i < COUNT; ++i) {
-               _data[i] = other._data[i];
-       }
-
-       return *this;
-}
-
-void
-AudioPoint::as_xml (xmlpp::Element* parent) const
-{
-       parent->add_child ("Peak")->add_child_text (raw_convert<string> (_data[PEAK]));
-       parent->add_child ("RMS")->add_child_text (raw_convert<string> (_data[RMS]));
-}
-       
 AudioAnalysis::AudioAnalysis (int channels)
 {
        _data.resize (channels);
@@ -100,8 +63,23 @@ AudioAnalysis::AudioAnalysis (boost::filesystem::path filename)
                _data.push_back (channel);
        }
 
-       _peak = f.number_child<float> ("Peak");
-       _peak_time = DCPTime (f.number_child<DCPTime::Type> ("PeakTime"));
+       _sample_peak = f.optional_number_child<float> ("Peak");
+       if (!_sample_peak) {
+               /* New key */
+               _sample_peak = f.optional_number_child<float> ("SamplePeak");
+       }
+
+       if (f.optional_number_child<DCPTime::Type> ("PeakTime")) {
+               _sample_peak_time = DCPTime (f.number_child<DCPTime::Type> ("PeakTime"));
+       } else if (f.optional_number_child<DCPTime::Type> ("SamplePeakTime")) {
+               _sample_peak_time = DCPTime (f.number_child<DCPTime::Type> ("SamplePeakTime"));
+       }
+
+       _true_peak = f.optional_number_child<float> ("TruePeak");
+       _integrated_loudness = f.optional_number_child<float> ("IntegratedLoudness");
+       _loudness_range = f.optional_number_child<float> ("LoudnessRange");
+
+       _analysis_gain = f.optional_number_child<double> ("AnalysisGain");
 }
 
 void
@@ -144,10 +122,41 @@ AudioAnalysis::write (boost::filesystem::path filename)
                }
        }
 
-       if (_peak) {
-               root->add_child("Peak")->add_child_text (raw_convert<string> (_peak.get ()));
-               root->add_child("PeakTime")->add_child_text (raw_convert<string> (_peak_time.get().get ()));
+       if (_sample_peak) {
+               root->add_child("SamplePeak")->add_child_text (raw_convert<string> (_sample_peak.get ()));
+               root->add_child("SamplePeakTime")->add_child_text (raw_convert<string> (_sample_peak_time.get().get ()));
+       }
+
+       if (_true_peak) {
+               root->add_child("TruePeak")->add_child_text (raw_convert<string> (_true_peak.get ()));
+       }
+
+       if (_integrated_loudness) {
+               root->add_child("IntegratedLoudness")->add_child_text (raw_convert<string> (_integrated_loudness.get ()));
+       }
+
+       if (_loudness_range) {
+               root->add_child("LoudnessRange")->add_child_text (raw_convert<string> (_loudness_range.get ()));
+       }
+
+       if (_analysis_gain) {
+               root->add_child("AnalysisGain")->add_child_text (raw_convert<string> (_analysis_gain.get ()));
        }
 
        doc->write_to_file_formatted (filename.string ());
 }
+
+float
+AudioAnalysis::gain_correction (shared_ptr<const Playlist> playlist)
+{
+       if (playlist->content().size() == 1 && 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'.
+               */
+               DCPOMATIC_ASSERT (playlist->content().front()->audio);
+               return playlist->content().front()->audio->gain() - analysis_gain().get ();
+       }
+
+       return 0.0f;
+}