Merge master.

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

diff --git a/src/lib/analyse_audio_job.h b/src/lib/analyse_audio_job.h
index 3d4881983b5234572ce40a47455c5b849a620328..a218cb3400d563354b751101eeb349bf87f81b59 100644 (file)
--- a/src/lib/analyse_audio_job.h
+++ b/src/lib/analyse_audio_job.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,13 +17,25 @@
 
 */
 
+/** @file  src/lib/analyse_audio_job.h
+ *  @brief AnalyseAudioJob class.
+ */
+
 #include "job.h"
 #include "audio_analysis.h"
 #include "types.h"
+#include "dcpomatic_time.h"
 
 class AudioBuffers;
 class AudioContent;
 
+/** @class AnalyseAudioJob
+ *  @brief A job to analyse the audio of a piece of AudioContent and make a note of its
+ *  broad peak and RMS levels.
+ *
+ *  After computing the peak and RMS levels over the length of the content, the job
+ *  will write a file to Content::audio_analysis_path.
+ */
 class AnalyseAudioJob : public Job
 {
 public:
@@ -33,10 +45,10 @@ public:
        void run ();
 
 private:
-       void audio (boost::shared_ptr<const AudioBuffers>, Time);
+       void analyse (boost::shared_ptr<const AudioBuffers>);
 
        boost::weak_ptr<AudioContent> _content;
-       OutputAudioFrame _done;
+       int64_t _done;
        int64_t _samples_per_point;
        std::vector<AudioPoint> _current;