src/lib/analyse_audio_job.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/analyse_audio_job.h
  21  *  @brief AnalyseAudioJob class.
  22  */
  23
  24 #include "job.h"
  25 #include "audio_point.h"
  26 #include "types.h"
  27
  28 class AudioBuffers;
  29 class AudioAnalysis;
  30 class Playlist;
  31 class AudioPoint;
  32
  33 /** @class AnalyseAudioJob
  34  *  @brief A job to analyse the audio of a film and make a note of its
  35  *  broad peak and RMS levels.
  36  *
  37  *  After computing the peak and RMS levels the job will write a file
  38  *  to Film::audio_analysis_path.
  39  */
  40 class AnalyseAudioJob : public Job
  41 {
  42 public:
  43         AnalyseAudioJob (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  44         ~AnalyseAudioJob ();
  45
  46         std::string name () const;
  47         std::string json_name () const;
  48         void run ();
  49
  50         boost::shared_ptr<const Playlist> playlist () const {
  51                 return _playlist;
  52         }
  53
  54 private:
  55         void analyse (boost::shared_ptr<const AudioBuffers>);
  56
  57         boost::shared_ptr<const Playlist> _playlist;
  58
  59         int64_t _done;
  60         int64_t _samples_per_point;
  61         AudioPoint* _current;
  62
  63         float _overall_peak;
  64         Frame _overall_peak_frame;
  65
  66         boost::shared_ptr<AudioAnalysis> _analysis;
  67
  68         static const int _num_points;
  69 };