X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fanalyse_audio_job.h;h=a218cb3400d563354b751101eeb349bf87f81b59;hb=cc27c2716f755305d67f1e1ba828ecf37f8405dd;hp=0a0be8fa055e48caad18252b4f84b54ff2107de8;hpb=a4c19a34244aeaf183c25878933b570fc5c0ee34;p=dcpomatic.git

diff --git a/src/lib/analyse_audio_job.h b/src/lib/analyse_audio_job.h
index 0a0be8fa0..a218cb340 100644
--- 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,6 +17,10 @@
 
 */
 
+/** @file  src/lib/analyse_audio_job.h
+ *  @brief AnalyseAudioJob class.
+ */
+
 #include "job.h"
 #include "audio_analysis.h"
 #include "types.h"
@@ -25,17 +29,23 @@
 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:
 	AnalyseAudioJob (boost::shared_ptr<const Film>, boost::shared_ptr<AudioContent>);
 
 	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;
 	int64_t _done;