C++11 tidying.
[dcpomatic.git] / src / lib / audio_analysis.cc
index bc59bcccaa56539a6f8a4a1728c2d9e50e9e1a50..b16fa708ad85d74bad44d134b2302745b4d8602c 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 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_analysis.h"
+#include "cross.h"
+#include "util.h"
+#include "playlist.h"
+#include "audio_content.h"
+#include "warnings.h"
+#include <dcp/raw_convert.h>
+DCPOMATIC_DISABLE_WARNINGS
+#include <libxml++/libxml++.h>
+DCPOMATIC_ENABLE_WARNINGS
+#include <boost/filesystem.hpp>
 #include <stdint.h>
 #include <cmath>
-#include <cassert>
-#include <fstream>
-#include <boost/filesystem.hpp>
-#include "audio_analysis.h"
+#include <cstdio>
+#include <iostream>
+#include <inttypes.h>
 
-using std::ostream;
+
+using std::cout;
+using std::dynamic_pointer_cast;
 using std::istream;
+using std::list;
+using std::make_pair;
+using std::make_shared;
+using std::max;
+using std::ostream;
+using std::pair;
+using std::shared_ptr;
 using std::string;
-using std::ofstream;
-using std::ifstream;
 using std::vector;
-using std::cout;
-using std::max;
-using std::list;
-
-AudioPoint::AudioPoint ()
-{
-       for (int i = 0; i < COUNT; ++i) {
-               _data[i] = 0;
-       }
-}
-
-AudioPoint::AudioPoint (istream& s)
-{
-       for (int i = 0; i < COUNT; ++i) {
-               s >> _data[i];
-       }
-}
+using boost::optional;
+using dcp::raw_convert;
+using namespace dcpomatic;
 
-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;
-}
+int const AudioAnalysis::_current_state_version = 3;
 
-void
-AudioPoint::write (ostream& s) const
-{
-       for (int i = 0; i < COUNT; ++i) {
-               s << _data[i] << "\n";
-       }
-}
-       
 
 AudioAnalysis::AudioAnalysis (int channels)
 {
        _data.resize (channels);
 }
 
+
 AudioAnalysis::AudioAnalysis (boost::filesystem::path filename)
 {
-       ifstream f (filename.string().c_str ());
+       cxml::Document f ("AudioAnalysis");
+       f.read_file (filename);
 
-       int channels;
-       f >> channels;
-       _data.resize (channels);
+       if (f.optional_number_child<int>("Version").get_value_or(1) < _current_state_version) {
+               /* Too old.  Throw an exception so that this analysis is re-run. */
+               throw OldFormatError ("Audio analysis file is too old");
+       }
 
-       for (int i = 0; i < channels; ++i) {
-               int points;
-               f >> points;
-               for (int j = 0; j < points; ++j) {
-                       _data[i].push_back (AudioPoint (f));
+       for (auto i: f.node_children("Channel")) {
+               vector<AudioPoint> channel;
+
+               for (auto j: i->node_children("Point")) {
+                       channel.push_back (AudioPoint(j));
                }
+
+               _data.push_back (channel);
        }
+
+       for (auto i: f.node_children ("SamplePeak")) {
+               _sample_peak.push_back (
+                       PeakTime(
+                               dcp::raw_convert<float>(i->content()), DCPTime(i->number_attribute<Frame>("Time"))
+                               )
+                       );
+       }
+
+       for (auto i: f.node_children("TruePeak")) {
+               _true_peak.push_back (dcp::raw_convert<float>(i->content()));
+       }
+
+       _integrated_loudness = f.optional_number_child<float>("IntegratedLoudness");
+       _loudness_range = f.optional_number_child<float>("LoudnessRange");
+
+       _analysis_gain = f.optional_number_child<double>("AnalysisGain");
+       _samples_per_point = f.number_child<int64_t>("SamplesPerPoint");
+       _sample_rate = f.number_child<int64_t>("SampleRate");
+
+       _leqm = f.optional_number_child<double>("Leqm");
 }
 
+
 void
 AudioAnalysis::add_point (int c, AudioPoint const & p)
 {
-       assert (c < channels ());
+       DCPOMATIC_ASSERT (c < channels ());
        _data[c].push_back (p);
 }
 
+
 AudioPoint
 AudioAnalysis::get_point (int c, int p) const
 {
-       assert (p < points (c));
+       DCPOMATIC_ASSERT (p < points(c));
        return _data[c][p];
 }
 
+
 int
 AudioAnalysis::channels () const
 {
        return _data.size ();
 }
 
+
 int
 AudioAnalysis::points (int c) const
 {
-       assert (c < channels ());
+       DCPOMATIC_ASSERT (c < channels());
        return _data[c].size ();
 }
 
+
 void
 AudioAnalysis::write (boost::filesystem::path filename)
 {
-       string tmp = filename.string() + ".tmp";
-
-       ofstream f (tmp.c_str ());
-       f << _data.size() << "\n";
-       for (vector<vector<AudioPoint> >::iterator i = _data.begin(); i != _data.end(); ++i) {
-               f << i->size () << "\n";
-               for (vector<AudioPoint>::iterator j = i->begin(); j != i->end(); ++j) {
-                       j->write (f);
+       auto doc = make_shared<xmlpp::Document>();
+       xmlpp::Element* root = doc->create_root_node ("AudioAnalysis");
+
+       root->add_child("Version")->add_child_text(raw_convert<string>(_current_state_version));
+
+       for (auto& i: _data) {
+               auto channel = root->add_child ("Channel");
+               for (auto& j: i) {
+                       j.as_xml (channel->add_child ("Point"));
                }
        }
 
-       f.close ();
-       boost::filesystem::rename (tmp, filename);
+       for (size_t i = 0; i < _sample_peak.size(); ++i) {
+               auto n = root->add_child("SamplePeak");
+               n->add_child_text (raw_convert<string> (_sample_peak[i].peak));
+               n->set_attribute ("Time", raw_convert<string> (_sample_peak[i].time.get()));
+       }
+
+       for (auto i: _true_peak) {
+               root->add_child("TruePeak")->add_child_text (raw_convert<string> (i));
+       }
+
+       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 ()));
+       }
+
+       root->add_child("SamplesPerPoint")->add_child_text (raw_convert<string> (_samples_per_point));
+       root->add_child("SampleRate")->add_child_text (raw_convert<string> (_sample_rate));
+
+       if (_leqm) {
+               root->add_child("Leqm")->add_child_text(raw_convert<string>(*_leqm));
+       }
+
+       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;
+}
+
+
+/** @return Peak across all channels, and the channel number it is on */
+pair<AudioAnalysis::PeakTime, int>
+AudioAnalysis::overall_sample_peak () const
+{
+       DCPOMATIC_ASSERT (!_sample_peak.empty());
+
+       optional<PeakTime> pt;
+       int c = 0;
+
+       for (size_t i = 0; i < _sample_peak.size(); ++i) {
+               if (!pt || _sample_peak[i].peak > pt->peak) {
+                       pt = _sample_peak[i];
+                       c = i;
+               }
+       }
+
+       return make_pair (pt.get(), c);
+}
+
+
+optional<float>
+AudioAnalysis::overall_true_peak () const
+{
+       optional<float> p;
+
+       for (auto i: _true_peak) {
+               if (!p || i > *p) {
+                       p = i;
+               }
+       }
+
+       return p;
+}
+