Accessor for ClosedCaptionsDialog.
[dcpomatic.git] / src / lib / audio_analysis.cc
index 1e5d089257d86c4f4aed253f2616c67af2d6b00b..13917cb5f6d693f3987b0c8adb85526a6426747c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -39,10 +39,16 @@ using std::string;
 using std::vector;
 using std::cout;
 using std::max;
+using std::pair;
+using std::make_pair;
 using std::list;
 using boost::shared_ptr;
+using boost::optional;
 using boost::dynamic_pointer_cast;
 using dcp::raw_convert;
+using namespace dcpomatic;
+
+int const AudioAnalysis::_current_state_version = 3;
 
 AudioAnalysis::AudioAnalysis (int channels)
 {
@@ -54,6 +60,11 @@ AudioAnalysis::AudioAnalysis (boost::filesystem::path filename)
        cxml::Document f ("AudioAnalysis");
        f.read_file (filename);
 
+       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");
+       }
+
        BOOST_FOREACH (cxml::NodePtr i, f.node_children ("Channel")) {
                vector<AudioPoint> channel;
 
@@ -64,23 +75,24 @@ AudioAnalysis::AudioAnalysis (boost::filesystem::path filename)
                _data.push_back (channel);
        }
 
-       _sample_peak = f.optional_number_child<float> ("Peak");
-       if (!_sample_peak) {
-               /* New key */
-               _sample_peak = f.optional_number_child<float> ("SamplePeak");
+       BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children ("SamplePeak")) {
+               _sample_peak.push_back (
+                       PeakTime (
+                               dcp::raw_convert<float>(i->content()), DCPTime(i->number_attribute<Frame>("Time"))
+                               )
+                       );
        }
 
-       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"));
+       BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children ("TruePeak")) {
+               _true_peak.push_back (dcp::raw_convert<float> (i->content ()));
        }
 
-       _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");
+       _samples_per_point = f.number_child<int64_t> ("SamplesPerPoint");
+       _sample_rate = f.number_child<int64_t> ("SampleRate");
 }
 
 void
@@ -116,6 +128,8 @@ AudioAnalysis::write (boost::filesystem::path filename)
        shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
        xmlpp::Element* root = doc->create_root_node ("AudioAnalysis");
 
+       root->add_child("Version")->add_child_text (raw_convert<string> (_current_state_version));
+
        BOOST_FOREACH (vector<AudioPoint>& i, _data) {
                xmlpp::Element* channel = root->add_child ("Channel");
                BOOST_FOREACH (AudioPoint& j, i) {
@@ -123,13 +137,14 @@ AudioAnalysis::write (boost::filesystem::path filename)
                }
        }
 
-       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 ()));
+       for (size_t i = 0; i < _sample_peak.size(); ++i) {
+               xmlpp::Element* 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()));
        }
 
-       if (_true_peak) {
-               root->add_child("TruePeak")->add_child_text (raw_convert<string> (_true_peak.get ()));
+       BOOST_FOREACH (float i, _true_peak) {
+               root->add_child("TruePeak")->add_child_text (raw_convert<string> (i));
        }
 
        if (_integrated_loudness) {
@@ -144,6 +159,9 @@ AudioAnalysis::write (boost::filesystem::path filename)
                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));
+
        doc->write_to_file_formatted (filename.string ());
 }
 
@@ -161,3 +179,36 @@ AudioAnalysis::gain_correction (shared_ptr<const Playlist> playlist)
 
        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;
+
+       BOOST_FOREACH (float i, _true_peak) {
+               if (!p || i > *p) {
+                       p = i;
+               }
+       }
+
+       return p;
+}