No-op: remove all trailing whitespace.
[dcpomatic.git] / src / lib / audio_analysis.h
index b91a1cf5123d3c43c3a1b40418e279ff273b4630..2411b4316c7f1474ff363b9e71e1baaee82ddaf6 100644 (file)
@@ -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
 
 */
 
-/** @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 <boost/filesystem.hpp>
+#include <boost/optional.hpp>
+#include <libcxml/cxml.h>
+#include "types.h"
 
-/** @class AudioPoint
- *  @brief A single point of an audio analysis for one portion of one channel.
- */
 class AudioPoint
 {
 public:
@@ -41,12 +37,12 @@ public:
        };
 
        AudioPoint ();
-       AudioPoint (FILE *);
+       AudioPoint (cxml::ConstNodePtr node);
        AudioPoint (AudioPoint const &);
        AudioPoint& operator= (AudioPoint const &);
 
-       void write (FILE *) const;
-       
+       void as_xml (xmlpp::Element *) const;
+
        float& operator[] (int t) {
                return _data[t];
        }
@@ -55,14 +51,6 @@ private:
        float _data[COUNT];
 };
 
-/** @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 +58,29 @@ 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;
+       }
+
        void write (boost::filesystem::path);
 
 private:
        std::vector<std::vector<AudioPoint> > _data;
+       boost::optional<float> _peak;
+       boost::optional<DCPTime> _peak_time;
 };
 
 #endif