AnalyseAudioJob does not need an explicit playlist.

[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 6ed236d85ca57854a7a4f4691f4082bf4c1c059e..1794ab3dcae1b4f6f8755de341f761d237ead5bf 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-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,29 +17,42 @@
 
 */
 
+/** @file  src/lib/analyse_audio_job.h
+ *  @brief AnalyseAudioJob class.
+ */
+
 #include "job.h"
 #include "audio_analysis.h"
 #include "types.h"
 
 class AudioBuffers;
-class AudioContent;
 
+/** @class AnalyseAudioJob
+ *  @brief A job to analyse the audio of a film and make a note of its
+ *  broad peak and RMS levels.
+ *
+ *  After computing the peak and RMS levels the job will write a file
+ *  to Film::audio_analysis_path.
+ */
 class AnalyseAudioJob : public Job
 {
 public:
-       AnalyseAudioJob (boost::shared_ptr<const Film>, boost::shared_ptr<AudioContent>);
+       AnalyseAudioJob (boost::shared_ptr<const Film>);
 
        std::string name () const;
+       std::string json_name () const;
        void run ();
 
 private:
-       void audio (boost::shared_ptr<const AudioBuffers>, DCPTime);
+       void analyse (boost::shared_ptr<const AudioBuffers>);
 
-       boost::weak_ptr<AudioContent> _content;
-       AudioFrame _done;
+       int64_t _done;
        int64_t _samples_per_point;
        std::vector<AudioPoint> _current;
 
+       float _overall_peak;
+       Frame _overall_peak_frame;
+
        boost::shared_ptr<AudioAnalysis> _analysis;
 
        static const int _num_points;