src/lib/audio_analysis.h

   1 /*
   2     Copyright (C) 2012-2014 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 <boost/filesystem.hpp>
  28 #include <vector>
  29
  30 /** @class AudioPoint
  31  *  @brief A single point of an audio analysis for one portion of one channel.
  32  */
  33 class AudioPoint
  34 {
  35 public:
  36         enum Type {
  37                 PEAK,
  38                 RMS,
  39                 COUNT
  40         };
  41
  42         AudioPoint ();
  43         AudioPoint (FILE *);
  44         AudioPoint (AudioPoint const &);
  45         AudioPoint& operator= (AudioPoint const &);
  46
  47         void write (FILE *) const;
  48
  49         float& operator[] (int t) {
  50                 return _data[t];
  51         }
  52
  53 private:
  54         float _data[COUNT];
  55 };
  56
  57 /** @class AudioAnalysis
  58  *  @brief An analysis of the audio data in a piece of AudioContent.
  59  *
  60  *  This is a set of AudioPoints for each channel.  The AudioPoints
  61  *  each represent some measurement of the audio over a portion of the
  62  *  content.  For example each AudioPoint may give the RMS level of
  63  *  a 1-minute portion of the audio.
  64  */
  65 class AudioAnalysis : public boost::noncopyable
  66 {
  67 public:
  68         AudioAnalysis (int c);
  69         AudioAnalysis (boost::filesystem::path);
  70
  71         void add_point (int c, AudioPoint const & p);
  72
  73         AudioPoint get_point (int c, int p) const;
  74         int points (int c) const;
  75         int channels () const;
  76
  77         void write (boost::filesystem::path);
  78
  79 private:
  80         std::vector<std::vector<AudioPoint> > _data;
  81 };
  82
  83 #endif