Merge master.

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

diff --git a/src/lib/audio_analysis.h b/src/lib/audio_analysis.h
index cfc170c846ae2af87e12645e3dd84e4ba7e9c13a..b91a1cf5123d3c43c3a1b40418e279ff273b4630 100644 (file)
--- a/src/lib/audio_analysis.h
+++ b/src/lib/audio_analysis.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 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,14 +17,20 @@
 
 */
 
+/** @file  src/lib/audio_analysis.h
+ *  @brief AudioAnalysis and AudioPoint classes.
+ */
+
 #ifndef DCPOMATIC_AUDIO_ANALYSIS_H
 #define DCPOMATIC_AUDIO_ANALYSIS_H
 
-#include <iostream>
 #include <vector>
 #include <list>
 #include <boost/filesystem.hpp>
 
+/** @class AudioPoint
+ *  @brief A single point of an audio analysis for one portion of one channel.
+ */
 class AudioPoint
 {
 public:
@@ -35,11 +41,11 @@ public:
        };
 
        AudioPoint ();
-       AudioPoint (std::istream &);
+       AudioPoint (FILE *);
        AudioPoint (AudioPoint const &);
        AudioPoint& operator= (AudioPoint const &);
 
-       void write (std::ostream &) const;
+       void write (FILE *) const;
        
        float& operator[] (int t) {
                return _data[t];
@@ -49,6 +55,14 @@ 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: