src/lib/audio_analysis.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 #ifndef DCPOMATIC_AUDIO_ANALYSIS_H
  21 #define DCPOMATIC_AUDIO_ANALYSIS_H
  22
  23 #include "dcpomatic_time.h"
  24 #include "audio_point.h"
  25 #include <libcxml/cxml.h>
  26 #include <boost/optional.hpp>
  27 #include <boost/filesystem.hpp>
  28 #include <vector>
  29
  30 namespace xmlpp {
  31         class Element;
  32 }
  33
  34 class Playlist;
  35
  36 class AudioAnalysis : public boost::noncopyable
  37 {
  38 public:
  39         AudioAnalysis (int c);
  40         AudioAnalysis (boost::filesystem::path);
  41
  42         void add_point (int c, AudioPoint const & p);
  43         void set_peak (float peak, DCPTime time) {
  44                 _peak = peak;
  45                 _peak_time = time;
  46         }
  47
  48         AudioPoint get_point (int c, int p) const;
  49         int points (int c) const;
  50         int channels () const;
  51
  52         boost::optional<float> peak () const {
  53                 return _peak;
  54         }
  55
  56         boost::optional<DCPTime> peak_time () const {
  57                 return _peak_time;
  58         }
  59
  60         boost::optional<double> analysis_gain () const {
  61                 return _analysis_gain;
  62         }
  63
  64         void set_analysis_gain (double gain) {
  65                 _analysis_gain = gain;
  66         }
  67
  68         void write (boost::filesystem::path);
  69
  70         float gain_correction (boost::shared_ptr<const Playlist> playlist);
  71
  72 private:
  73         std::vector<std::vector<AudioPoint> > _data;
  74         boost::optional<float> _peak;
  75         boost::optional<DCPTime> _peak_time;
  76         /** If this analysis was run on a single piece of
  77          *  content we store its gain in dB when the analysis
  78          *  happened.
  79          */
  80         boost::optional<double> _analysis_gain;
  81 };
  82
  83 #endif