Use dcp::file_to_string().
[dcpomatic.git] / src / lib / audio_analysis.h
index 6c0be69873f2b2b1bcd7d81bca83498e4a54d424..038059502b225f44de78208bd32913cfd722b631 100644 (file)
 /*
-    Copyright (C) 2012-2015 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/>.
 
 */
 
+
 #ifndef DCPOMATIC_AUDIO_ANALYSIS_H
 #define DCPOMATIC_AUDIO_ANALYSIS_H
 
+
 #include "dcpomatic_time.h"
+#include "audio_point.h"
 #include <libcxml/cxml.h>
 #include <boost/optional.hpp>
 #include <boost/filesystem.hpp>
 #include <vector>
 
+
 namespace xmlpp {
        class Element;
 }
 
-class AudioPoint
+
+class Playlist;
+
+
+class AudioAnalysis
 {
 public:
-       enum Type {
-               PEAK,
-               RMS,
-               COUNT
-       };
+       explicit AudioAnalysis (int c);
+       explicit AudioAnalysis (boost::filesystem::path);
+
+       void add_point (int c, AudioPoint const & p);
 
-       AudioPoint ();
-       AudioPoint (cxml::ConstNodePtr node);
-       AudioPoint (AudioPoint const &);
-       AudioPoint& operator= (AudioPoint const &);
+       struct PeakTime {
+               PeakTime (float p, dcpomatic::DCPTime t)
+                       : peak (p)
+                       , time (t)
+               {}
 
-       void as_xml (xmlpp::Element *) const;
+               float peak;
+               dcpomatic::DCPTime time;
+       };
 
-       float& operator[] (int t) {
-               return _data[t];
+       void set_sample_peak (std::vector<PeakTime> peak) {
+               _sample_peak = peak;
        }
 
-private:
-       float _data[COUNT];
-};
+       void set_true_peak (std::vector<float> peak) {
+               _true_peak = peak;
+       }
 
-class AudioAnalysis : public boost::noncopyable
-{
-public:
-       AudioAnalysis (int c);
-       AudioAnalysis (boost::filesystem::path);
+       void set_integrated_loudness (float l) {
+               _integrated_loudness = l;
+       }
 
-       void add_point (int c, AudioPoint const & p);
-       void set_peak (float peak, DCPTime time) {
-               _peak = peak;
-               _peak_time = time;
+       void set_loudness_range (float r) {
+               _loudness_range = r;
        }
 
        AudioPoint get_point (int c, int p) const;
        int points (int c) const;
        int channels () const;
 
-       boost::optional<float> peak () const {
-               return _peak;
+       std::vector<PeakTime> sample_peak () const {
+               return _sample_peak;
        }
 
-       boost::optional<DCPTime> peak_time () const {
-               return _peak_time;
+       std::pair<PeakTime, int> overall_sample_peak () const;
+
+       std::vector<float> true_peak () const {
+               return _true_peak;
+       }
+
+       boost::optional<float> overall_true_peak () const;
+
+       boost::optional<float> integrated_loudness () const {
+               return _integrated_loudness;
+       }
+
+       boost::optional<float> loudness_range () const {
+               return _loudness_range;
        }
 
        boost::optional<double> analysis_gain () const {
@@ -86,17 +105,51 @@ public:
                _analysis_gain = gain;
        }
 
+       int64_t samples_per_point () const {
+               return _samples_per_point;
+       }
+
+       void set_samples_per_point (int64_t spp) {
+               _samples_per_point = spp;
+       }
+
+       int sample_rate () const {
+               return _sample_rate;
+       }
+
+       void set_sample_rate (int sr) {
+               _sample_rate = sr;
+       }
+
+       void set_leqm (double leqm) {
+               _leqm = leqm;
+       }
+
+       boost::optional<double> leqm () const {
+               return _leqm;
+       }
+
        void write (boost::filesystem::path);
 
+       float gain_correction (std::shared_ptr<const Playlist> playlist);
+
 private:
-       std::vector<std::vector<AudioPoint> > _data;
-       boost::optional<float> _peak;
-       boost::optional<DCPTime> _peak_time;
+       std::vector<std::vector<AudioPoint>> _data;
+       std::vector<PeakTime> _sample_peak;
+       std::vector<float> _true_peak;
+       boost::optional<float> _integrated_loudness;
+       boost::optional<float> _loudness_range;
+       boost::optional<double> _leqm;
        /** If this analysis was run on a single piece of
         *  content we store its gain in dB when the analysis
         *  happened.
         */
        boost::optional<double> _analysis_gain;
+       int64_t _samples_per_point = 0;
+       int _sample_rate = 0;
+
+       static int const _current_state_version;
 };
 
+
 #endif