Updated cs_CZ translation from Tomáš Begeni.

[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 0a0be8fa055e48caad18252b4f84b54ff2107de8..afd52c3040688c00f48ce215f0e2d48fe8acef35 100644 (file)
--- a/src/lib/analyse_audio_job.h
+++ b/src/lib/analyse_audio_job.h
@@ -1,49 +1,76 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include "job.h"
-#include "audio_analysis.h"
-#include "types.h"
+
+/** @file  src/lib/analyse_audio_job.h
+ *  @brief AnalyseAudioJob class.
+ */
+
+
+#include "audio_analyser.h"
+#include "audio_point.h"
 #include "dcpomatic_time.h"
+#include "job.h"
+#include <leqm_nrt.h>
+#include <boost/scoped_ptr.hpp>
+
 
 class AudioBuffers;
-class AudioContent;
+class AudioAnalysis;
+class Playlist;
+class AudioPoint;
+class AudioFilterGraph;
+class Filter;
+
 
+/** @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(std::shared_ptr<const Film>, std::shared_ptr<const Playlist>, bool whole_film);
+       ~AnalyseAudioJob ();
 
-       std::string name () const;
-       std::string json_name () const;
-       void run ();
+       std::string name () const override;
+       std::string json_name () const override;
+       void run () override;
+       bool enable_notify () const override {
+               return true;
+       }
 
-private:
-       void audio (boost::shared_ptr<const AudioBuffers>, DCPTime);
+       boost::filesystem::path path () const {
+               return _path;
+       }
 
-       boost::weak_ptr<AudioContent> _content;
-       int64_t _done;
-       int64_t _samples_per_point;
-       std::vector<AudioPoint> _current;
+private:
+       AudioAnalyser _analyser;
 
-       boost::shared_ptr<AudioAnalysis> _analysis;
+       std::shared_ptr<const Playlist> _playlist;
+       /** playlist's audio analysis path when the job was created */
+       boost::filesystem::path _path;
+       bool _whole_film;
 
        static const int _num_points;
 };
-