Logging improvements to allow prettier displays in the server GUI.

[dcpomatic.git] / src / lib / audio_analysis.h

diff --git a/src/lib/audio_analysis.h b/src/lib/audio_analysis.h
index b91a1cf5123d3c43c3a1b40418e279ff273b4630..0d06e5973eca297bcf6d6e4f1240059ab2b68691 100644 (file)
--- a/src/lib/audio_analysis.h
+++ b/src/lib/audio_analysis.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,52 +17,22 @@
 
 */
 
-/** @file  src/lib/audio_analysis.h
- *  @brief AudioAnalysis and AudioPoint classes.
- */
-
 #ifndef DCPOMATIC_AUDIO_ANALYSIS_H
 #define DCPOMATIC_AUDIO_ANALYSIS_H
 
-#include <vector>
-#include <list>
+#include "dcpomatic_time.h"
+#include "audio_point.h"
+#include <libcxml/cxml.h>
+#include <boost/optional.hpp>
 #include <boost/filesystem.hpp>
+#include <vector>
 
-/** @class AudioPoint
- *  @brief A single point of an audio analysis for one portion of one channel.
- */
-class AudioPoint
-{
-public:
-       enum Type {
-               PEAK,
-               RMS,
-               COUNT
-       };
-
-       AudioPoint ();
-       AudioPoint (FILE *);
-       AudioPoint (AudioPoint const &);
-       AudioPoint& operator= (AudioPoint const &);
-
-       void write (FILE *) const;
-       
-       float& operator[] (int t) {
-               return _data[t];
-       }
+namespace xmlpp {
+       class Element;
+}
 
-private:
-       float _data[COUNT];
-};
+class Playlist;
 
-/** @class AudioAnalysis
- *  @brief An analysis of the audio data in a piece of AudioContent.
- *
- *  This is a set of AudioPoints for each channel.  The AudioPoints
- *  each represent some measurement of the audio over a portion of the
- *  content.  For example each AudioPoint may give the RMS level of
- *  a 1-minute portion of the audio.
- */
 class AudioAnalysis : public boost::noncopyable
 {
 public:
@@ -70,15 +40,44 @@ public:
        AudioAnalysis (boost::filesystem::path);
 
        void add_point (int c, AudioPoint const & p);
-       
+       void set_peak (float peak, DCPTime time) {
+               _peak = peak;
+               _peak_time = time;
+       }
+
        AudioPoint get_point (int c, int p) const;
        int points (int c) const;
        int channels () const;
 
+       boost::optional<float> peak () const {
+               return _peak;
+       }
+
+       boost::optional<DCPTime> peak_time () const {
+               return _peak_time;
+       }
+
+       boost::optional<double> analysis_gain () const {
+               return _analysis_gain;
+       }
+
+       void set_analysis_gain (double gain) {
+               _analysis_gain = gain;
+       }
+
        void write (boost::filesystem::path);
 
+       float gain_correction (boost::shared_ptr<const Playlist> playlist);
+
 private:
        std::vector<std::vector<AudioPoint> > _data;
+       boost::optional<float> _peak;
+       boost::optional<DCPTime> _peak_time;
+       /** 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;
 };
 
 #endif