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 /** @file  src/lib/audio_analysis.h
  21  *  @brief AudioAnalysis and AudioPoint classes.
  22  */
  23
  24 #ifndef DCPOMATIC_AUDIO_ANALYSIS_H
  25 #define DCPOMATIC_AUDIO_ANALYSIS_H
  26
  27 #include "types.h"
  28 #include <boost/filesystem.hpp>
  29 #include <boost/optional.hpp>
  30 #include <vector>
  31
  32 /** @class AudioPoint
  33  *  @brief A single point of an audio analysis for one portion of one channel.
  34  */
  35 class AudioPoint
  36 {
  37 public:
  38         enum Type {
  39                 PEAK,
  40                 RMS,
  41                 COUNT
  42         };
  43
  44         AudioPoint ();
  45         AudioPoint (FILE *);
  46         AudioPoint (AudioPoint const &);
  47         AudioPoint& operator= (AudioPoint const &);
  48
  49         void write (FILE *) const;
  50
  51         float& operator[] (int t) {
  52                 return _data[t];
  53         }
  54
  55 private:
  56         float _data[COUNT];
  57 };
  58
  59 /** @class AudioAnalysis
  60  *  @brief An analysis of the audio data in a piece of AudioContent.
  61  *
  62  *  This is a set of AudioPoints for each channel.  The AudioPoints
  63  *  each represent some measurement of the audio over a portion of the
  64  *  content.  For example each AudioPoint may give the RMS level of
  65  *  a 1-minute portion of the audio.
  66  */
  67 class AudioAnalysis : public boost::noncopyable
  68 {
  69 public:
  70         AudioAnalysis (int c);
  71         AudioAnalysis (boost::filesystem::path);
  72
  73         void add_point (int c, AudioPoint const & p);
  74         void set_peak (float peak, DCPTime time) {
  75                 _peak = peak;
  76                 _peak_time = time;
  77         }
  78
  79         AudioPoint get_point (int c, int p) const;
  80         int points (int c) const;
  81         int channels () const;
  82
  83         boost::optional<float> peak () const {
  84                 return _peak;
  85         }
  86
  87         boost::optional<DCPTime> peak_time () const {
  88                 return _peak_time;
  89         }
  90
  91         void write (boost::filesystem::path);
  92
  93 private:
  94         std::vector<std::vector<AudioPoint> > _data;
  95         boost::optional<float> _peak;
  96         boost::optional<DCPTime> _peak_time;
  97 };
  98
  99 #endif