libKeyFinder
A small C++11 library for estimating the musical key of digital audio.
chromagram.h
1 /*************************************************************************
2 
3  Copyright 2011-2015 Ibrahim Sha'ath
4 
5  This file is part of LibKeyFinder.
6 
7  LibKeyFinder is free software: you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation, either version 3 of the License, or
10  (at your option) any later version.
11 
12  LibKeyFinder is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  GNU General Public License for more details.
16 
17  You should have received a copy of the GNU General Public License
18  along with LibKeyFinder. If not, see <http://www.gnu.org/licenses/>.
19 
20 *************************************************************************/
21 
22 #ifndef CHROMAGRAM_H
23 #define CHROMAGRAM_H
24 
25 #include "constants.h"
26 
27 namespace KeyFinder {
28 
29  class Chromagram {
30  public:
31  Chromagram(unsigned int hops = 0);
32  void append(const Chromagram& that);
33  void setMagnitude(unsigned int hop, unsigned int band, double value);
34  double getMagnitude(unsigned int hop, unsigned int band) const;
35  unsigned int getHops() const;
36  std::vector<double> collapseToOneHop() const;
37  private:
38  std::vector< std::vector<double> > chromaData;
39  };
40 
41 }
42 
43 #endif
Definition: chromagram.h:29