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
  44         void set_sample_peak (float peak, DCPTime time) {
  45                 _sample_peak = peak;
  46                 _sample_peak_time = time;
  47         }
  48
  49         void set_true_peak (float peak) {
  50                 _true_peak = peak;
  51         }
  52
  53         void set_integrated_loudness (float l) {
  54                 _integrated_loudness = l;
  55         }
  56
  57         void set_loudness_range (float r) {
  58                 _loudness_range = r;
  59         }
  60
  61         AudioPoint get_point (int c, int p) const;
  62         int points (int c) const;
  63         int channels () const;
  64
  65         boost::optional<float> sample_peak () const {
  66                 return _sample_peak;
  67         }
  68
  69         boost::optional<DCPTime> sample_peak_time () const {
  70                 return _sample_peak_time;
  71         }
  72
  73         boost::optional<float> true_peak () const {
  74                 return _true_peak;
  75         }
  76
  77         boost::optional<float> integrated_loudness () const {
  78                 return _integrated_loudness;
  79         }
  80
  81         boost::optional<float> loudness_range () const {
  82                 return _loudness_range;
  83         }
  84
  85         boost::optional<double> analysis_gain () const {
  86                 return _analysis_gain;
  87         }
  88
  89         void set_analysis_gain (double gain) {
  90                 _analysis_gain = gain;
  91         }
  92
  93         void write (boost::filesystem::path);
  94
  95         float gain_correction (boost::shared_ptr<const Playlist> playlist);
  96
  97 private:
  98         std::vector<std::vector<AudioPoint> > _data;
  99         boost::optional<float> _sample_peak;
 100         boost::optional<DCPTime> _sample_peak_time;
 101         boost::optional<float> _true_peak;
 102         boost::optional<float> _integrated_loudness;
 103         boost::optional<float> _loudness_range;
 104         /** If this analysis was run on a single piece of
 105          *  content we store its gain in dB when the analysis
 106          *  happened.
 107          */
 108         boost::optional<double> _analysis_gain;
 109 };
 110
 111 #endif