├── .gitignore ├── hallelujah.wav ├── pitcher.tar.gz ├── samples ├── tune.wav ├── lpf-100.wav ├── original.wav ├── hpf-10000.wav ├── scale-0-75.wav └── scale-2-0.wav ├── zip.bash ├── src ├── main.cpp ├── ifft.cpp ├── pitcher.h ├── fundamental.h ├── writer.cpp ├── processstft.h ├── filter.h ├── fft.cpp ├── isftf.cpp ├── processbuffer.h ├── writer.h ├── reader.cpp ├── fundamental.cpp ├── filter.cpp ├── reader.h ├── sftf.cpp ├── fourier.h ├── targetfreq.cpp ├── pitcher.cpp ├── targetfreq.h ├── processbuffer.cpp └── processstft.cpp ├── Makefile ├── README └── Doxyfile /.gitignore: -------------------------------------------------------------------------------- 1 | obj/ 2 | pitcher -------------------------------------------------------------------------------- /hallelujah.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/hallelujah.wav -------------------------------------------------------------------------------- /pitcher.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/pitcher.tar.gz -------------------------------------------------------------------------------- /samples/tune.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/samples/tune.wav -------------------------------------------------------------------------------- /samples/lpf-100.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/samples/lpf-100.wav -------------------------------------------------------------------------------- /samples/original.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/samples/original.wav -------------------------------------------------------------------------------- /samples/hpf-10000.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/samples/hpf-10000.wav -------------------------------------------------------------------------------- /samples/scale-0-75.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/samples/scale-0-75.wav -------------------------------------------------------------------------------- /samples/scale-2-0.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitchadam/pitcher/HEAD/samples/scale-2-0.wav -------------------------------------------------------------------------------- /zip.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # This is what the tar archive will be called 4 | TAR_NAME=pitcher.tar.gz 5 | 6 | # Ignore .txt files in client 7 | FILES="README Makefile hallelujah.wav src/* samples/*" 8 | 9 | tar -czvf $TAR_NAME $FILES 10 | 11 | echo "Thanks for zipping!" 12 | -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include "pitcher.h" 10 | 11 | int main(int argc, char *argv[]) { 12 | // Run Pitcher 13 | pitcher(argc, argv); 14 | } 15 | -------------------------------------------------------------------------------- /src/ifft.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | #include "fourier.h" 9 | 10 | void applyIFFT(CVector& x) 11 | { 12 | // conjugate the complex numbers 13 | x = x.apply(std::conj); 14 | 15 | // forward fft 16 | FFT(x); 17 | 18 | // conjugate the complex numbers again 19 | x = x.apply(std::conj); 20 | 21 | // scale the numbers 22 | x /= x.size(); 23 | } 24 | -------------------------------------------------------------------------------- /src/pitcher.h: -------------------------------------------------------------------------------- 1 | #ifndef _PITCHER_H_ 2 | #define _PITCHER_H_ 3 | 4 | #include "reader.h" 5 | #include "writer.h" 6 | #include "processbuffer.h" 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | // Used for cross fading the buffers to reduce noise 13 | constexpr std::size_t inputBufferLen = 1024; 14 | constexpr std::size_t outputBufferLen = 1536; // 1.5x inputBufferLen 15 | 16 | /* 17 | Run Pitcher 18 | @param: argc number of arguments 19 | @param: *argv[] input arugments 20 | 21 | */ 22 | int pitcher(int argc, char *argv[]); 23 | 24 | #endif -------------------------------------------------------------------------------- /src/fundamental.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #ifndef _FUNDAMENTAL_H_ 10 | #define _FUNDAMENTAL_H_ 11 | 12 | #include 13 | #include 14 | 15 | #include "fourier.h" 16 | 17 | // Used to represent the complex numbers in arary 18 | typedef std::complex CNum; 19 | typedef std::valarray CVector; 20 | 21 | /** 22 | * Estimates the fundamental frequency of a signal using autocorrelation 23 | * @param signal The signal to analyze 24 | * @param sampleRate The sample rate in Hz of the signal 25 | */ 26 | double fundamental(CVector &signal, unsigned long sampleRate); 27 | 28 | #endif 29 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # ------------------------------------------------- 2 | # Name: Mitchell Adam, Ryan Shukla 3 | # ID: 1528592, 1537980 4 | # CMPUT 275, Winter 2018 5 | # 6 | # Final Project 7 | # ------------------------------------------------- 8 | 9 | TARGET := ./pitcher 10 | 11 | CC := g++ 12 | CFLAGS := -std=c++11 -g 13 | # linker flags 14 | LDFLAGS := -lsndfile 15 | 16 | # Directory of cpp source code 17 | SRCDIR := src 18 | # Directory to put .o files 19 | OBJDIR := obj 20 | 21 | # Find all .cpp files to compile 22 | SOURCES := $(shell find $(SRCDIR) -name *.cpp) 23 | OBJECTS := $(patsubst $(SRCDIR)/%, $(OBJDIR)/%, $(SOURCES:.cpp=.o)) 24 | 25 | $(TARGET): $(OBJECTS) 26 | $(CC) -o $(TARGET) $^ $(LDFLAGS) 27 | 28 | $(OBJDIR)/%.o: $(SRCDIR)/%.cpp 29 | mkdir -p $(OBJDIR) 30 | $(CC) $(CFLAGS) -c -o $@ $< 31 | 32 | clean: 33 | -rm -f $(TARGET) 34 | -rm -f $(OBJDIR)/*.o 35 | -------------------------------------------------------------------------------- /src/writer.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include // std::memset() 10 | 11 | #include "writer.h" 12 | 13 | Writer::Writer(std::string filename, double *buffer, std::size_t bufferLen, 14 | SF_INFO &sfinfo) : sfinfo(sfinfo) { 15 | this->filename = filename; 16 | this->buffer = buffer; 17 | this->bufferLen = bufferLen; 18 | } 19 | 20 | bool Writer::open() { 21 | file = sf_open(filename.c_str(), SFM_WRITE, &sfinfo); 22 | 23 | if (!file) { 24 | // sf_open failed (returned nullptr) 25 | return false; 26 | } 27 | 28 | return true; 29 | } 30 | 31 | int Writer::write(std::size_t writeCount) { 32 | return sf_write_double(file, buffer, writeCount); 33 | } 34 | 35 | void Writer::close() { 36 | sf_close(file); 37 | } 38 | -------------------------------------------------------------------------------- /src/processstft.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #ifndef _CALC_FREQ_H_ 10 | #define _CALC_FREQ_H_ 11 | 12 | #include 13 | 14 | #include "fourier.h" // CVector 15 | 16 | /** 17 | * Does desired pitch shifting in the frequency domain 18 | * 19 | * @param stft The short time Fourier Transform representation of the signal 20 | * @param windowSize The size of a window in the stft 21 | * @param overlapFactor Amount of overlap between windows 22 | * e.g. If the next window starts 1/4 of the way into the current window, 23 | * then overlapFactor = 4 24 | * @param pitchScaleFactor The amount to multiply all the frequency components 25 | * of the signal 26 | */ 27 | void processSTFT(std::vector &stft, std::size_t windowSize, 28 | std::size_t overlapFactor, double pitchScaleFactor); 29 | 30 | #endif 31 | -------------------------------------------------------------------------------- /src/filter.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include "fourier.h" // CVector 10 | 11 | #ifndef _FILTER_H_ 12 | #define _FILTER_H_ 13 | 14 | /** 15 | * Generates low pass filter transfer function (H(w)) for a given cutoff 16 | * frequency 17 | * @param cutoff The filter cutoff frequency in Hz 18 | * @param length The length of the signal or buffer 19 | * @param sampleRate The sample rate of the signal 20 | */ 21 | CVector lowPassTransferFunction(double cutoff, std::size_t length, int sampleRate); 22 | 23 | /** 24 | * Generates high pass filter transfer function (H(w)) for a given cutoff 25 | * frequency 26 | * @param cutoff The filter cutoff frequency in Hz 27 | * @param length The length of the signal or buffer 28 | * @param sampleRate The sample rate of the signal 29 | */ 30 | CVector highPassTransferFunction(double cutoff, std::size_t length, int sampleRate); 31 | 32 | #endif 33 | -------------------------------------------------------------------------------- /src/fft.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | #include "fourier.h" 9 | 10 | void FFT(CVector& z){ 11 | const size_t n = z.size(); 12 | // Base Case, ends recursion 13 | if (n <= 1) return; 14 | 15 | // Split up signal into even and odd components 16 | CVector zeven = z[std::slice(0, n/2, 2)]; 17 | CVector zodd = z[std::slice(1, n/2, 2)]; 18 | 19 | // Recursivley call FFT on each component 20 | FFT(zeven); 21 | FFT(zodd); 22 | 23 | // Recombine the FFT of the even and odd components 24 | for (size_t i = 0; i < n/2; ++i) { 25 | // Mutiple odd components by common mutlipler 26 | CNum g = std::polar(1.0, -2 * PI * i/n) * zodd[i]; 27 | 28 | //From periodicity of complex ecponential 29 | //We can more efficiently combine the even and off components as 30 | //follows 31 | z[i] = zeven[i] + g; 32 | z[i+n/2]= zeven[i] - g; 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/isftf.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | #include "fourier.h" 9 | 10 | CVector ISFTF (std::vector windowFFTS, int sampleSize, int overlap){ 11 | 12 | //Create output signal 13 | CVector outputSignal; 14 | size_t n = windowFFTS[0].size(); 15 | outputSignal.resize(n,0); 16 | 17 | for (size_t i = 0; i < windowFFTS.size(); i++) { 18 | //Inverse FT each window first 19 | applyIFFT(windowFFTS[i]); 20 | // Apply window 21 | CVector window = createWindow(n, i * sampleSize / overlap, sampleSize); 22 | windowFFTS[i] *= window; 23 | } 24 | //Add together all the windows to get the ouput window 25 | //Loop through the bins 26 | for (size_t i = 0; i < n; i++) { 27 | //Loop through the windows 28 | for (size_t j = 0; j < windowFFTS.size(); j++) { 29 | // Set weach ouput bin as sum of corresponding window bins 30 | outputSignal[i] += windowFFTS[j][i]; 31 | } 32 | } 33 | return outputSignal; 34 | } 35 | -------------------------------------------------------------------------------- /src/processbuffer.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #ifndef _PROCESS_BUFFER_H_ 10 | #define _PROCESS_BUFFER_H_ 11 | 12 | #include "fourier.h" 13 | #include "fundamental.h" 14 | #include "targetfreq.h" 15 | #include 16 | 17 | /** 18 | * Does all signal processing on buffer. 19 | * Note: this function modifies buffer 20 | * @param inputBuffer Pointer to the start of the input buffer 21 | * @param inputBufferLen Length of the input buffer 22 | * @param outputBuffer Pointer to the start of the output buffer 23 | * @param outputBufferLen Length of the output buffer 24 | * @param channels Number of audio channels in buffer 25 | * @param mode The operating mode ("lpf", "scale", etc.) 26 | * @param option The option within the mode (e.g. the scaling factor if the 27 | * mode is "scale") 28 | */ 29 | void processBuffer(double *inputBuffer, std::size_t inputBufferLen, 30 | double *outputBuffer, std::size_t outputBufferLen, 31 | int channels, std::string mode, std::string option); 32 | 33 | #endif 34 | -------------------------------------------------------------------------------- /src/writer.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #ifndef WRITER_H_ 10 | #define WRITER_H_ 11 | 12 | #include 13 | #include 14 | 15 | /** 16 | * A class which writes to a .wav file from a buffer. 17 | */ 18 | 19 | class Writer { 20 | public: 21 | 22 | /** 23 | * Constructor 24 | * Note: pass the SF_INFO struct from the input file using the getsfinfo() 25 | * method 26 | */ 27 | Writer(std::string filename, double *buffer, std::size_t bufferLen, 28 | SF_INFO &sfinfo); 29 | 30 | /** 31 | * Opens the file for writing 32 | * Returns true on success 33 | */ 34 | bool open(); 35 | 36 | /** 37 | * Writes data from buffer into file. 38 | * @param writeCount The number of samples to write 39 | * Returns number of items written 40 | */ 41 | int write(std::size_t writeCount); 42 | 43 | /** 44 | * Closes the file 45 | */ 46 | void close(); 47 | 48 | private: 49 | double *buffer; 50 | std::size_t bufferLen; 51 | std::string filename; 52 | 53 | SNDFILE *file; 54 | SF_INFO &sfinfo; 55 | }; 56 | 57 | #endif 58 | -------------------------------------------------------------------------------- /src/reader.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include // std::memset() 10 | 11 | #include "reader.h" 12 | 13 | Reader::Reader(std::string filename, double* buffer, std::size_t bufferLen) { 14 | this->filename = filename; 15 | this->buffer = buffer; 16 | this->bufferLen = bufferLen; 17 | 18 | // Initialize sfinfo struct 19 | std::memset(&sfinfo, 0, sizeof(sfinfo)) ; 20 | } 21 | 22 | bool Reader::open() { 23 | file = sf_open(filename.c_str(), SFM_READ, &sfinfo); 24 | 25 | if (!file) { 26 | // sf_open failed (returned nullptr) 27 | return false; 28 | } 29 | 30 | return true; 31 | } 32 | 33 | SF_INFO &Reader::getsfinfo() { 34 | return sfinfo; 35 | } 36 | 37 | int Reader::read() { 38 | return sf_read_double(file, buffer, bufferLen); 39 | } 40 | 41 | int Reader::seek(int offset) { 42 | return sf_seek(file, offset, SEEK_CUR); 43 | } 44 | 45 | bool Reader::atEnd() { 46 | int currentPosition = sf_seek(file, 0, SEEK_CUR); 47 | int endPosition = sf_seek(file, 0, SEEK_END); 48 | // Go back to currentPosition 49 | sf_seek(file, currentPosition, SEEK_SET); 50 | return currentPosition == endPosition; 51 | } 52 | 53 | void Reader::close() { 54 | sf_close(file); 55 | } 56 | -------------------------------------------------------------------------------- /src/fundamental.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include // log() 10 | 11 | #include "fundamental.h" 12 | 13 | 14 | double fundamental(CVector &signal, unsigned long sampleRate) { 15 | // Ignore this many elements from the edges of the autocorrelation signal 16 | // Sometimes the autocorrelation signal has weird behaviour at the edges 17 | std::size_t edgeIgnore = 100; 18 | 19 | // Create a copy of the signal to perform fft on 20 | CVector copy = signal; 21 | 22 | // Compute the autocorrelation of the signal via the frequency domain 23 | FFT(copy); 24 | for (auto &element : copy) { 25 | element = element * std::conj(element); 26 | } 27 | applyIFFT(copy); 28 | 29 | // Find peak in the autocorrelation 30 | // Ignore the edges (lowest and highest frequencies) 31 | double max = 0; 32 | std::size_t maxIndex = 0; 33 | for (std::size_t i = edgeIgnore; i < copy.size() - edgeIgnore; i++) { 34 | // Since we are back in the time domain, the autocorrelation signal should 35 | // be real 36 | if (copy[i].real() > max) { 37 | max = copy[i].real(); 38 | maxIndex = i; 39 | } 40 | } 41 | 42 | // Calculate fundmental from index and sample rate 43 | double samplePeriod = 1/ ((double)sampleRate); 44 | double fundamentalPeriod = maxIndex * samplePeriod; 45 | double fundamental = 1 / fundamentalPeriod; 46 | return fundamental; 47 | } 48 | -------------------------------------------------------------------------------- /src/filter.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include "filter.h" 10 | #include 11 | 12 | CVector lowPassTransferFunction(double cutoff, std::size_t length, 13 | int sampleRate) { 14 | 15 | // Angular frequency of bin 1 16 | double baseBinFreq = 2 * M_PI * ((double)sampleRate) / ((double)length); 17 | 18 | // RC factor of low pass system 19 | double RC = 2 * M_PI * cutoff; 20 | RC = 1 / RC; 21 | 22 | CVector output; 23 | output.resize(length, 0); 24 | 25 | CNum temp; 26 | // Apply transfer function 27 | for (std::size_t i = 0; i < length; i++) { 28 | temp = CNum(1, RC * baseBinFreq * ((double)i)); 29 | output[i] = CNum(1, 0) / temp; 30 | } 31 | 32 | return output; 33 | } 34 | 35 | CVector highPassTransferFunction(double cutoff, std::size_t length, 36 | int sampleRate) { 37 | 38 | // Angular frequency of bin 1 39 | double baseBinFreq = 2 * M_PI * ((double)sampleRate) / ((double)length); 40 | 41 | // RC factor of high pass system 42 | double RC = 2 * M_PI * cutoff; 43 | RC = 1 / RC; 44 | 45 | CVector output; 46 | output.resize(length, 0); 47 | 48 | // Apply transfer function 49 | for (std::size_t i = 0; i < length; i++) { 50 | output[i] = CNum(0, ((double)i) * baseBinFreq) / 51 | CNum(2 * M_PI * cutoff, ((double)i) * baseBinFreq); 52 | 53 | } 54 | 55 | return output; 56 | } 57 | -------------------------------------------------------------------------------- /src/reader.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #ifndef READER_H_ 10 | #define READER_H_ 11 | 12 | #include 13 | #include 14 | 15 | /** 16 | * A class which repeatedly reads a .wav file into a buffer. 17 | */ 18 | 19 | class Reader { 20 | public: 21 | Reader(std::string filename, double* buffer, std::size_t bufferLen); 22 | 23 | /** 24 | * Opens the file. 25 | * Returns true on success. 26 | */ 27 | bool open(); 28 | 29 | /** 30 | * Reads the next chunk of data from the file into the buffer 31 | * Returns number of items read into buffer. If this is zero, you have reached 32 | * the end of the file. 33 | */ 34 | int read(); 35 | 36 | /** 37 | * Moves the file pointer by offset. Offset can be negative. 38 | * Returns offset from the start of the file or -1 on failure. 39 | */ 40 | int seek(int offset); 41 | 42 | /** 43 | * Returns true if the file pointer is at the end of the file. 44 | */ 45 | bool atEnd(); 46 | 47 | /** 48 | * Closes the file 49 | */ 50 | void close(); 51 | 52 | /** 53 | * Get SF_INFO struct that is generated on opening the file. 54 | * libsndfile uses this struct to keep track of number of channels and other 55 | * parameters 56 | */ 57 | SF_INFO& getsfinfo(); 58 | 59 | private: 60 | double *buffer; 61 | std::size_t bufferLen; 62 | std::string filename; 63 | 64 | SNDFILE *file; 65 | SF_INFO sfinfo; 66 | }; 67 | 68 | #endif 69 | -------------------------------------------------------------------------------- /src/sftf.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | #include "fourier.h" 9 | #include // remove 10 | 11 | /* 12 | implementation of Short time fourier transform 13 | */ 14 | std::vector SFTF(CVector& signal, int sampleSize, int overlap){ 15 | // Sample rate is always 44.1 kHz 16 | // Signal Size determines resolution 17 | 18 | int n = signal.size(); 19 | // This will be a vector of the fft of each window 20 | std::vector windowFFTS; 21 | 22 | // Create a window every half window size 23 | for (int i = 0; i <= n; i += sampleSize/overlap) { 24 | // Uses hann window function to create window, zero 25 | //everywhere outside of window 26 | CVector scalingWindow = createWindow(n, i, sampleSize); 27 | CVector signalWindow = signal * scalingWindow; 28 | 29 | //Now that we have the windowed signal, fft signal 30 | FFT(signalWindow); 31 | 32 | windowFFTS.push_back(signalWindow); 33 | } 34 | return windowFFTS; 35 | } 36 | 37 | CVector createWindow(int n, int center, int size){ 38 | CVector scaling; 39 | scaling.resize(n,0); 40 | 41 | // Go backwards from center 42 | for(int i = 1; i <= size/2; i++){ 43 | if ((center - i ) >= 0 && (center-i) < n){ 44 | scaling[center -i]= {0.5 * (1 - cos(2*PI*(size/2-i)/(size-1))),0}; 45 | } 46 | } 47 | // Go forwards from center 48 | for(int i =0; i <= size/2-1;i++){ 49 | if((center + i) < n && (center + i >= 0)){ 50 | scaling[center + i]= {0.5 * (1 - cos(2*PI*(size/2+i)/(size-1))),0}; 51 | } 52 | } 53 | return scaling; 54 | } 55 | 56 | -------------------------------------------------------------------------------- /src/fourier.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | #ifndef _FOURIER_H_ 9 | #define _FOURIER_H_ 10 | 11 | #include 12 | #include 13 | #include 14 | 15 | 16 | // Used to represent the complex numbers in arary 17 | typedef std::complex CNum; 18 | typedef std::valarray CVector; 19 | const double PI = 3.141592653589793238460; 20 | 21 | /* 22 | Implmentation of the Cooley-Tukey FFT algorthim 23 | Algorthim works by splitting signal into odd and even components and 24 | recursivley computing the FFT of each component 25 | Runs in O(nlog(n)) where n is the length of the array representing the s 26 | ignal 27 | Note: n must be a power of 2 28 | Parameters: z - an array representing the signal, using the valarray 29 | library 30 | @param: z is the signal to fft 31 | */ 32 | void FFT(CVector& z); 33 | 34 | /* 35 | Handles the Inverse fourier transform by scaling 1/n 36 | and taking conjugate of signal 37 | @param: z is the signal to do fft on 38 | */ 39 | void applyIFFT(CVector& z); 40 | 41 | /* 42 | Implemntation of the short time fourier transform 43 | Breaks up signal into windows to get more accurate ffts 44 | @param: z is signal to perfrom SFTF on 45 | @param: sampleSize is lenght of window 46 | @param: overlap is the overlap factor (should be multiple of 2) 47 | 48 | */ 49 | std::vector SFTF(CVector& z, int sampleSize, int overlap); 50 | /* 51 | Used by STFT to create the windows of a signal 52 | @param: n is the lenght of entire signal 53 | @param: center is the index of the center of the window 54 | @param: size is the size of each window 55 | */ 56 | CVector createWindow(int n, int center, int size); 57 | /* 58 | Inverse SFTF 59 | First does the IFFT and then adds the windows back up 60 | @param: windowFFTS is the fourier signal 61 | @param: sampleSize is the size of the signal 62 | @param: overlap is the overlap factor should be same as SFTF 63 | */ 64 | CVector ISFTF (std::vector windowFFTS, int sampleSize, int overlap); 65 | #endif 66 | -------------------------------------------------------------------------------- /src/targetfreq.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include 10 | 11 | #include "targetfreq.h" 12 | 13 | double getTargetFreq(double actualFreq, int key) { 14 | // Frequency in Hz of A4 15 | double A4 = 440; 16 | // Frequency in Hz of C0 17 | double C0 = A4 * pow(2, -4.75); 18 | 19 | // Calculate semitones away from C0 using a logarithmic scale 20 | double semitonesFromC0 = 12 * log2(actualFreq / C0); 21 | // Calculate octave for later 22 | int octave = static_cast(semitonesFromC0) / 12; 23 | // Map to one octave 24 | double semitonesModded = std::fmod(semitonesFromC0, 12); 25 | // Round to nearest integer semitone 26 | double semitonesRounded = std::round(semitonesModded); 27 | bool roundedUp = true; 28 | if (semitonesRounded < semitonesModded) { 29 | roundedUp = false; 30 | } 31 | // Cast to int for purposes of querying a map 32 | int semitone = static_cast(semitonesRounded); 33 | 34 | /// Decide whether semitone of signal is in the key 35 | int targetSemitone; 36 | // Set of all semitones that are in the key 37 | std::unordered_set keySet = keyToSemitones.at(key); 38 | // If the semitone is in the key, use it 39 | // If not, move one semitone over, depending on whether we rounded up or down 40 | if (keySet.find(semitone) == keySet.end()) { 41 | // Note is not in key 42 | if (roundedUp) { 43 | targetSemitone = semitone - 1; 44 | } else { 45 | targetSemitone = semitone + 1; 46 | } 47 | } else { 48 | targetSemitone = semitone; 49 | } 50 | 51 | // Ensure targetSemitone is in range [0, 11] 52 | if (targetSemitone < 0) { 53 | targetSemitone += 12; 54 | } 55 | targetSemitone %= 12; 56 | 57 | // The closest semitone might be in the octave below or above 58 | if (targetSemitone - semitone > 2) { 59 | targetSemitone -= 12; 60 | } else if (semitone - targetSemitone > 2) { 61 | targetSemitone += 12; 62 | } 63 | // Convert from semitone to frequency on Hz 64 | double target = static_cast(targetSemitone + octave * 12); 65 | target = C0 * pow(2, target / 12); 66 | return target; 67 | } 68 | -------------------------------------------------------------------------------- /src/pitcher.cpp: -------------------------------------------------------------------------------- 1 | #include "pitcher.h" 2 | 3 | int pitcher(int argc, char *argv[]) { 4 | // Parse command line args 5 | std::string mode; 6 | std::string optionSelect; 7 | std::string inputFileName; 8 | if (argc == 4) { 9 | mode = argv[1]; 10 | optionSelect = argv[2]; 11 | inputFileName = argv[3]; 12 | } 13 | else { 14 | std::cout << "Usage: pitcher [mode] [options] [file]" << std::endl; 15 | return 1; 16 | } 17 | 18 | // Allocate buffer to read sound file into 19 | double *inputBuffer = new double[inputBufferLen]; 20 | std::memset(inputBuffer, 0, inputBufferLen); 21 | 22 | // Allocate buffer to store and crossfade processed sound 23 | double *outputBuffer = new double[outputBufferLen]; 24 | std::memset(outputBuffer, 0, outputBufferLen); 25 | double *outputBufferThird = outputBuffer + inputBufferLen / 2; 26 | double *outputBufferLastThird = outputBuffer + inputBufferLen; 27 | 28 | //Ensure Correct Opening 29 | Reader reader(inputFileName, inputBuffer, inputBufferLen); 30 | if (!reader.open()) { 31 | std::cout << "Error: Failed to open file." << std::endl; 32 | return 1; 33 | } 34 | 35 | // Need to pass the SF_INFO struct from the reader to the writer 36 | // Writer only writes from the first 2/3 of output buffer 37 | Writer writer("output.wav", outputBuffer, inputBufferLen, reader.getsfinfo()); 38 | writer.open(); 39 | 40 | int readCount; 41 | int writeCount; 42 | // Since we are processing overlapping sections, we can only write every other 43 | // iteration of the loop 44 | bool write = false; 45 | while ((readCount = reader.read())) { 46 | processBuffer(inputBuffer, inputBufferLen, outputBuffer, outputBufferLen, 47 | reader.getsfinfo().channels, mode, optionSelect); 48 | if (write) { 49 | //Handle edge case 50 | writeCount = writer.write(inputBufferLen); 51 | write = false; 52 | } else { 53 | write = true; 54 | } 55 | // Shift output buffer 56 | std::memmove(outputBuffer, outputBufferThird, 57 | inputBufferLen * sizeof(double)); 58 | // Set last third of output buffer to zeros 59 | std::memset(outputBufferLastThird, 0, 60 | (inputBufferLen / 2) * sizeof(double)); 61 | int pos = reader.seek(0); 62 | if (!(reader.atEnd())) { 63 | // Move the file pointer backwards so that we can read overlapping 64 | // sections 65 | pos = reader.seek(-1 * (((int)inputBufferLen) / 2)); 66 | } 67 | } 68 | 69 | // Close reader and writer when finished 70 | reader.close(); 71 | writer.close(); 72 | return 0; 73 | } 74 | -------------------------------------------------------------------------------- /src/targetfreq.h: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #ifndef _TARGET_FREQ_H_ 10 | #define _TARGET_FREQ_H_ 11 | 12 | #include 13 | #include 14 | #include 15 | 16 | #include "fourier.h" 17 | 18 | /** 19 | * This file contains utilities to work with musical notes 20 | */ 21 | 22 | /** 23 | * Notes expressed as semitones above C 24 | */ 25 | constexpr int note_c = 0; 26 | constexpr int note_db = 1; 27 | constexpr int note_d = 2; 28 | constexpr int note_eb = 3; 29 | constexpr int note_e = 4; 30 | constexpr int note_f = 5; 31 | constexpr int note_gb = 6; 32 | constexpr int note_g = 7; 33 | constexpr int note_ab = 8; 34 | constexpr int note_a = 9; 35 | constexpr int note_bb = 10; 36 | constexpr int note_b = 11; 37 | 38 | /** 39 | * Mappings from each key to which semitones relative to C are acceptable 40 | * Note: adding the octave (e.g. note_c + 12) makes it easier to calculate the 41 | * target frequency in getTargetFreq 42 | */ 43 | static const std::unordered_map> keyToSemitones{ 44 | {note_c, {note_c, note_d, note_e, note_f, note_g, note_a, note_b, note_c + 12}}, 45 | {note_db, {note_db, note_eb, note_f, note_gb, note_ab, note_bb, note_c, note_db + 12}}, 46 | {note_d, {note_d, note_e, note_gb, note_g, note_a, note_b, note_db, note_d + 12}}, 47 | {note_eb, {note_eb, note_f, note_g, note_ab, note_bb, note_c, note_d, note_eb + 12}}, 48 | {note_e, {note_e, note_gb, note_ab, note_a, note_b, note_db, note_eb, note_e + 12}}, 49 | {note_f, {note_f, note_g, note_a, note_bb, note_c, note_d, note_e, note_f + 12}}, 50 | {note_gb, {note_gb, note_ab, note_bb, note_b, note_db, note_eb, note_f, note_gb + 12}}, 51 | {note_g, {note_g, note_a, note_b, note_c, note_d, note_e, note_gb, note_g + 12}}, 52 | {note_ab, {note_ab, note_bb, note_c, note_db, note_eb, note_f, note_g, note_ab + 12}}, 53 | {note_a, {note_a, note_b, note_db, note_d, note_e, note_gb, note_ab, note_a + 12}}, 54 | {note_bb, {note_bb, note_c, note_d, note_eb, note_f, note_g, note_a, note_bb + 12}}, 55 | {note_b, {note_b, note_db, note_eb, note_e, note_gb, note_ab, note_bb, note_b + 12}}, 56 | }; 57 | 58 | /** 59 | * Maps string to a note as an int (see constants above) 60 | * Used to parse command line args. 61 | */ 62 | static const std::unordered_map stringToNote { 63 | {"c", note_c,}, 64 | {"db", note_db}, 65 | {"d", note_d}, 66 | {"eb", note_eb}, 67 | {"e", note_e}, 68 | {"f", note_f}, 69 | {"gb", note_gb}, 70 | {"g", note_g}, 71 | {"ab", note_ab}, 72 | {"a", note_a}, 73 | {"bb", note_bb}, 74 | {"b", note_b}, 75 | }; 76 | 77 | /** 78 | * Calculates nearest frequency that corresponds to a note in the key 79 | * @param actualFreq The frequency of the signal (can be estimated using 80 | * fundamental()) 81 | * @param key The desired key in which to search for the closest acceptable note 82 | */ 83 | double getTargetFreq(double actualFreq, int key); 84 | 85 | #endif 86 | -------------------------------------------------------------------------------- /src/processbuffer.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include "processbuffer.h" 10 | #include "processstft.h" 11 | #include "filter.h" 12 | #include "targetfreq.h" 13 | 14 | void processBuffer(double *inputBuffer, std::size_t inputBufferLen, 15 | double *outputBuffer, std::size_t outputBufferLen, 16 | int channels, std::string mode, std::string option) { 17 | int k, chan; 18 | 19 | // Construct a valarray of complex numbers from the input buffer 20 | CVector bufferVector; 21 | int sampleRate = 44100; 22 | bufferVector.resize(inputBufferLen); 23 | 24 | for (chan = 0; chan < channels; chan++) { 25 | for (k = chan; k < inputBufferLen; k += channels) { 26 | // Convert each value in the buffer into a complex number 27 | bufferVector[k] = CNum(inputBuffer[k], 0); 28 | } 29 | } 30 | 31 | // SFTF the buffer 32 | std::size_t windowSize = 256; 33 | std::size_t overlapFactor = 16; 34 | std::vector stft = SFTF(bufferVector, windowSize, overlapFactor); 35 | 36 | if (mode == "tune") { 37 | int key = stringToNote.at(option); 38 | 39 | // Calculate the fundamental frequency 40 | double fund = fundamental(bufferVector, sampleRate); 41 | // Calculate the target freqency and scale factor 42 | double target = getTargetFreq(fund, key); 43 | double pitchScaleFactor = target / fund; 44 | 45 | processSTFT(stft, windowSize, overlapFactor, pitchScaleFactor); 46 | 47 | } else if (mode == "scale") { 48 | 49 | double scale = std::stod(option); 50 | processSTFT(stft, windowSize, overlapFactor, scale); 51 | 52 | } else if (mode == "lpf") { 53 | 54 | double cutoff = std::stod(option); 55 | // Apply low pass filter to reduce noise 56 | CVector lpf = lowPassTransferFunction(cutoff, inputBufferLen, sampleRate); 57 | for (auto &freqSignal : stft) { 58 | freqSignal *= lpf; 59 | } 60 | 61 | } else if (mode == "hpf") { 62 | double cutoff = std::stod(option); 63 | // Apply high pass filter to reduce noise 64 | CVector hpf = highPassTransferFunction(cutoff, inputBufferLen, sampleRate); 65 | // Increase "strength" of hpf 66 | for (auto &num : hpf) { 67 | num = std::pow(num, 100); 68 | } 69 | for (auto &freqSignal : stft) { 70 | freqSignal *= hpf; 71 | } 72 | } 73 | 74 | // Inverse STFT 75 | bufferVector = ISFTF(stft, windowSize, overlapFactor); 76 | 77 | // Window the entire processed buffer so that it can be crossfaded 78 | CVector crossfadeWindow = createWindow(inputBufferLen, inputBufferLen / 2, 79 | inputBufferLen); 80 | bufferVector *= crossfadeWindow; 81 | 82 | // Compensates for increase in amplitude do to overlapping windows 83 | double gain = 0.25; 84 | // Covert CVector back into array of doubles 85 | for (chan = 0; chan < channels; chan++) { 86 | for (k = chan; k < inputBufferLen; k += channels) { 87 | // Convert each value in the buffer into a complex number 88 | // Add to the last 2/3 of the output buffer 89 | if (k + inputBufferLen / 2 < outputBufferLen) { 90 | outputBuffer[k + inputBufferLen / 2] += bufferVector[k].real() * gain; 91 | } 92 | } 93 | } 94 | return; 95 | } 96 | -------------------------------------------------------------------------------- /src/processstft.cpp: -------------------------------------------------------------------------------- 1 | // ------------------------------------------------- 2 | // Name: Mitchell Adam, Ryan Shukla 3 | // ID: 1528592, 1537980 4 | // CMPUT 275, Winter 2018 5 | // 6 | // Final Project 7 | // ------------------------------------------------- 8 | 9 | #include // M_PI, fmod() 10 | 11 | #include "processstft.h" 12 | 13 | // Forward declaration 14 | double constrainAngle(double angle); 15 | 16 | void processSTFT(std::vector &stft, std::size_t windowSize, 17 | std::size_t overlapFactor, double pitchScaleFactor) { 18 | 19 | double sampleRate = 44100; 20 | 21 | // Length of the buffer in samples (time domain length is same as freq domain 22 | // length) 23 | std::size_t bufferLen = stft[0].size(); 24 | 25 | // frequency of bin 1 26 | double freqPerBin = sampleRate / ((double)bufferLen); 27 | 28 | // Number of windows in the stft 29 | std::size_t windowCount = stft.size(); 30 | 31 | // Number of samples between start of a window and the next window 32 | std::size_t windowStride = bufferLen / windowCount; 33 | 34 | // Ensure actualFreqs and magnitudes vectors have correct size 35 | // Outer index is window, inner is freqency bin 36 | std::vector< std::vector > actualFreqs; 37 | actualFreqs.resize(windowCount); 38 | for (std::size_t i = 0; i < windowCount; i++) { 39 | actualFreqs[i].resize(bufferLen); 40 | } 41 | std::vector< std::vector > magnitudes; 42 | magnitudes.resize(windowCount); 43 | for (std::size_t i = 0; i < windowCount; i++) { 44 | magnitudes[i].resize(bufferLen); 45 | } 46 | 47 | // Store previous previous of each bin as we loop through windows 48 | std::vector previousPhase; 49 | previousPhase.resize(bufferLen, 0); 50 | 51 | // Loop across frequency bins 52 | for (std::size_t freqIndex = 0; freqIndex < bufferLen; freqIndex++) { 53 | // Loop across stft windows 54 | for (std::size_t windowIndex = 0; windowIndex < windowCount; 55 | windowIndex++) { 56 | 57 | // Calculate magnitude of the bin 58 | magnitudes[windowIndex][freqIndex] = 59 | std::abs(stft[windowIndex][freqIndex]); 60 | 61 | // Calculate phase of bin 62 | double phase = std::arg(stft[windowIndex][freqIndex]); 63 | 64 | // Calculate phase difference between current window and previous window 65 | double phaseDiff = phase - previousPhase[freqIndex]; 66 | previousPhase[freqIndex] = phase; 67 | 68 | // Calculate the expected phase difference based on the overlap between 69 | // windows 70 | double expectedDiff = ((double)freqIndex) * 2 * M_PI * 71 | ((double)windowStride) / ((double)bufferLen); 72 | 73 | // Correct phaseDiff by accounting for expectedDiff 74 | phaseDiff -= expectedDiff; 75 | 76 | // Map phase difference into [-pi, pi] interval 77 | phaseDiff = constrainAngle(phaseDiff); 78 | 79 | // Calculate actual frequency based on phaseDiff 80 | actualFreqs[windowIndex][freqIndex] = 81 | ((double)freqIndex) * freqPerBin + 82 | phaseDiff * ((double)overlapFactor) * freqPerBin / (2 * M_PI); 83 | } 84 | } 85 | 86 | // Now pitch shifting 87 | // Do resampling to shift pitch 88 | // Simply move magnitudes to new indeces 89 | // Move AND scale actual frequencies 90 | 91 | // Create and initialize vectors to store the resampled magnitudes and 92 | // frequencies 93 | std::vector< std::vector > newMags; 94 | newMags.resize(windowCount); 95 | for (std::size_t i = 0; i < windowCount; i++) { 96 | newMags[i].resize(bufferLen); 97 | std::fill(newMags[i].begin(), newMags[i].end(), 0); 98 | } 99 | std::vector< std::vector > newFreqs; 100 | newFreqs.resize(windowCount); 101 | for (std::size_t i = 0; i < windowCount; i++) { 102 | newFreqs[i].resize(bufferLen); 103 | std::fill(newFreqs[i].begin(), newFreqs[i].end(), 0); 104 | } 105 | 106 | // New index used to scale frequency domain 107 | std::size_t newFreqIndex; 108 | // Loop across frequency bins 109 | for (std::size_t freqIndex = 0; freqIndex < bufferLen; freqIndex++) { 110 | // Loop across stft windows 111 | for (std::size_t windowIndex = 0; windowIndex < stft.size(); 112 | windowIndex++) { 113 | // Calculate new index based on scale factor 114 | newFreqIndex = freqIndex * pitchScaleFactor; 115 | // Check if new index is within bounds 116 | if (newFreqIndex < bufferLen) { 117 | // Move magnitude to new index 118 | newMags[windowIndex][newFreqIndex] += 119 | magnitudes[windowIndex][freqIndex]; 120 | // Move and scale frequency 121 | newFreqs[windowIndex][newFreqIndex] += 122 | actualFreqs[windowIndex][freqIndex] * pitchScaleFactor; 123 | } 124 | } 125 | } 126 | // Since we calculate a change in phase between windows, we need to keep track 127 | // of the phase at the previous window 128 | std::vector phaseAccum; 129 | phaseAccum.resize(bufferLen, 0); 130 | 131 | // Loop across frequency bins 132 | for (std::size_t freqIndex = 0; freqIndex < bufferLen; freqIndex++) { 133 | // Loop across stft windows 134 | for (std::size_t windowIndex = 0; windowIndex < stft.size(); 135 | windowIndex++) { 136 | // Subtract ideal bin frequency to get change in frequency 137 | double deltaFreq = newFreqs[windowIndex][freqIndex] - 138 | ((double)freqIndex) * freqPerBin; 139 | 140 | // Convert change in frequency to actual change in phase 141 | double deltaPhase = deltaFreq * 2 * M_PI; 142 | deltaPhase /= overlapFactor; 143 | deltaPhase /= freqPerBin; 144 | 145 | // Convert actual change in phase back to measured change in phase 146 | // by adding the expected change in phase 147 | deltaPhase += ((double)freqIndex) * 2 * M_PI * ((double)windowStride) / 148 | ((double)bufferLen); 149 | 150 | // Add the change in phase to the accumulator 151 | phaseAccum[freqIndex] += deltaPhase; 152 | double phase = phaseAccum[freqIndex]; 153 | 154 | // Calculate real and imaginary parts of stft bin 155 | double mag = newMags[windowIndex][freqIndex]; 156 | stft[windowIndex][freqIndex].real(mag * std::cos(phase)); 157 | stft[windowIndex][freqIndex].imag(mag * std::sin(phase)); 158 | } 159 | } 160 | 161 | // Zero negative frequencies 162 | for (std::size_t windowIndex = 0; windowIndex < windowCount; windowIndex++) { 163 | for (std::size_t i = bufferLen / 2; i < bufferLen; i++) { 164 | stft[windowIndex][i] = CNum(0, 0); 165 | } 166 | } 167 | } 168 | 169 | /** 170 | * Maps an angle in radians to the interval [-pi, pi] 171 | */ 172 | double constrainAngle(double angle) { 173 | angle = fmod(angle, 2 * M_PI); 174 | if (angle > M_PI) { 175 | angle -= 2 * M_PI; 176 | } 177 | if (angle < - M_PI) { 178 | angle += 2 * M_PI; 179 | } 180 | return angle; 181 | } 182 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | ------------------------------------------------- 2 | Name: Mitchell Adam, Ryan Shukla 3 | ID: 1528592, 1537980 4 | CMPUT 275, Winter 2018 5 | 6 | Final Project: Pitcher 7 | ------------------------------------------------- 8 | An audio processor using a phase vocoder. See the samples folder for some examples 9 | of signal manupulation 10 | Overview: 11 | We created a phase vocoder to be used for audio processing. The way this works 12 | is as follows 13 | 14 | 1. We fist read in an auido file in the .wav form 15 | 2. We then use the short-time fourier transform to transform the signals into 16 | the frequencey domain. The short time fourier transform works by using the Hann 17 | window function over a signal to make many windows. We then use the fast fourier 18 | transfrom on each window. 19 | 3. Once we have each window in the frequencey domain we then utilize the fact that 20 | we have the fourier transform of many windows. We do this by comparing the phase 21 | of each bin (a specific frequency band) between multiple windows. This then allows us 22 | the more accurately determine the freqency of each component by using the phase difference 23 | to correct the frequency. This is the benefit of a pahse vocoder. 24 | 4. Once we have accurate frequencey and magnitude of the signal we can do 25 | then audio processing. We have four methods of audio processing 26 | a. High pass filter: This dampens all low freqencey components making the signal sound 27 | "brighter" 28 | b. Low pass filter: This dampens all high freqencey components making the 29 | signal sound more mellow. 30 | c. Pitch shifting: With this option you are able to scale the signal up or down. 31 | Scaling up makes it sound more like a chipmunk while scaling down makes it much 32 | deeper. This is nontrival becuase we are able to shift the pitch without 33 | changing the duration of the signal by resampling the signal.We are able to do this 34 | as a result of using a phase vocoder 35 | d. Autotune: In this method we are able to use more algorithms such as auto correctelation 36 | to detect the fundamental frequcney of the signal. This allows us to calcualte the ratio 37 | between the fundamental freqency and the closest note in the scale. The closest note in 38 | the scale is determined algorithmically using modular arithmetic. Once we have this ratio 39 | we are able to once again scale the signal by resampling similar to a pitch shifting. 40 | 41 | Algorithms and data structres: 42 | 43 | Algorithms 44 | 1. Fast Fourier Transfrom 45 | Runtime O(nlog(n)) 46 | where n is number of samples in original signal 47 | 48 | 2. Short-time Fourier Transfrom 49 | Runtime O(n^2log(n)) 50 | where n is number of samples in original signal 51 | 52 | 53 | 3. Autocorrelation 54 | Runtime O(nlogn) 55 | where n the number of samples in the original signal 56 | This is due to the use of the FFT 57 | Autocorrelation is used in fundamental() 58 | 59 | 4. Musical note detection by modular arithmetic 60 | Runtime O(1) 61 | This is due to the use of modular arithmetic which allows us to work in a single octave 62 | and use a set to decide if a given note is in the key. 63 | This algorithm is used in getTargetFreq() 64 | 65 | Data Structures 66 | Sets and Maps both used extensiveley. Also used STL complex numbers and valarray 67 | 68 | 69 | Included files: 70 | * README 71 | * Makefile 72 | * src/fft.cpp 73 | * src/filter.cpp 74 | * src/fourier.h 75 | * src/fundamental.cpp 76 | * src/fundamental.h 77 | * src/ifft.cpp 78 | * src/istft.cpp 79 | * src/main.cpp 80 | * src/processbuffer.cpp 81 | * src/processbuffer.h 82 | * src/processstft.cpp 83 | * src/processstft.h 84 | * src/reader.cpp 85 | * src/reader.h 86 | * src/sfprocess.cpp 87 | * src/sftf.cpp 88 | * src/targetfreq.cpp 89 | * src/targetfreq.h 90 | * src/writer.cpp 91 | * src/writer.h 92 | * hallelujah.wav 93 | * samples/ 94 | 95 | Running instructions: 96 | 0. First install libsndfile in order to read and write .wav files. Use the 97 | following commands 98 | sudo apt-get install libsndfile1 99 | sudo apt-get install libsndfile1-dev 100 | 1. Then in the main directory run 'make' 101 | 2. The program is then run using the following formate 102 | ./pitcher [mode] [options] [filename] 103 | ex command: ./pitcher scale 2.0 hallelujah.wav 104 | 105 | a. Mode: 106 | Mode determines what audio processing is done on the file it can be 107 | scale , tune, hpf, lpf 108 | scale - pitch shift the audio file 109 | tune - autotune the file with autocorrelation 110 | hpf - use a high pass filter 111 | lpf - use a low pass filter 112 | 113 | b. Options: 114 | Options determines how the mode is used. Each mode has a corresponding option 115 | [scale option]: Is the scale factor as a double 116 | [tune option]: Is the key the original file is in. Valid keys are: c, d, db, eb, e, f 117 | gb, g, ab, a, bb, b 118 | [hpf option]: The cutoff frequency in Hz 119 | [lpf option]: The cutoff frequency in Hz 120 | c. filename: 121 | This is the name of the input file. Must be a .wav file 122 | 3. The program will then run the process. Since there is a lot of processing 123 | to do it may take a while. 124 | 4. The output will then be saved in the same directory as output.wav 125 | 126 | 127 | Recommended Commands: 128 | 1. To test high pass filter use: 129 | ./pitcher hpf 10000 hallelujah.wav 130 | 2. To test low pass filter use: 131 | ./pitcher lpf 100 hallelujah.wav 132 | 3. To test scaling use: 133 | ./pitcher scale 2 hallelujah.wav 134 | 4. To test tune use: 135 | ./pitcher tune c hallelujah.wav 136 | 137 | NOTE: In the samples folder we have already run a wide range of process on 138 | the files. Here you can see how the program changes the audio 139 | 140 | Notes and Assumptions: 141 | * Since we do a manupulation on the signal in the frequency domain there is 142 | some noise created. This is heard most in the tune option. While the can 143 | make the output sound poor, the desired effect is still heard. Audio processing 144 | is a tedious task and fine tuning the output can be very difficult. 145 | The tune option is used as demonstration of the possible applications of a phase 146 | vocoder and is in no way a trivial task. 147 | * Since we have the signal inforamtion in the frequecney domain there are many other 148 | signal processing possibilites that could be done. 149 | 150 | 151 | References: 152 | * Used following websites to learn and implement Cooley-Tukey FFT algorithm: 153 | https://en.wikipedia.org/wiki/Cooley%E2%80%93Tukey_FFT_algorithm 154 | http://www.drdobbs.com/cpp/a-simple-and-efficient-fft-implementatio/199500857 155 | https://rosettacode.org/wiki/Fast_Fourier_transform 156 | * Using the fft to implement stft and a phase vocoder 157 | http://blogs.zynaptiq.com/bernsee/pitch-shifting-using-the-ft/ 158 | * Converting frequency to a musical note 159 | https://www.johndcook.com/blog/2016/02/10/musical-pitch-notation/ 160 | * Phase vocoder 161 | http://sethares.engr.wisc.edu/vocoders/matlabphasevocoder.html 162 | * Pitch detection algorithms 163 | https://sound.eti.pg.gda.pl/student/eim/synteza/leszczyna/index_ang.htm 164 | https://ccrma.stanford.edu/~pdelac/154/m154paper.htm 165 | https://en.wikipedia.org/wiki/Cepstrum 166 | 167 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.15 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the configuration 21 | # file that follow. The default is UTF-8 which is also the encoding used for all 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 | # iconv built into libc) for the transcoding. See 24 | # https://www.gnu.org/software/libiconv/ for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "Pitcher" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = doc 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 | # documentation generated by doxygen is written. Doxygen will use this 98 | # information to generate all generated output in the proper direction. 99 | # Possible values are: None, LTR, RTL and Context. 100 | # The default value is: None. 101 | 102 | OUTPUT_TEXT_DIRECTION = None 103 | 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 105 | # descriptions after the members that are listed in the file and class 106 | # documentation (similar to Javadoc). Set to NO to disable this. 107 | # The default value is: YES. 108 | 109 | BRIEF_MEMBER_DESC = YES 110 | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 112 | # description of a member or function before the detailed description 113 | # 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 115 | # brief descriptions will be completely suppressed. 116 | # The default value is: YES. 117 | 118 | REPEAT_BRIEF = YES 119 | 120 | # This tag implements a quasi-intelligent brief description abbreviator that is 121 | # used to form the text in various listings. Each string in this list, if found 122 | # as the leading text of the brief description, will be stripped from the text 123 | # and the result, after processing the whole list, is used as the annotated 124 | # text. Otherwise, the brief description is used as-is. If left blank, the 125 | # following values are used ($name is automatically replaced with the name of 126 | # the entity):The $name class, The $name widget, The $name file, is, provides, 127 | # specifies, contains, represents, a, an and the. 128 | 129 | ABBREVIATE_BRIEF = "The $name class" \ 130 | "The $name widget" \ 131 | "The $name file" \ 132 | is \ 133 | provides \ 134 | specifies \ 135 | contains \ 136 | represents \ 137 | a \ 138 | an \ 139 | the 140 | 141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 142 | # doxygen will generate a detailed section even if there is only a brief 143 | # description. 144 | # The default value is: NO. 145 | 146 | ALWAYS_DETAILED_SEC = NO 147 | 148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 149 | # inherited members of a class in the documentation of that class as if those 150 | # members were ordinary class members. Constructors, destructors and assignment 151 | # operators of the base classes will not be shown. 152 | # The default value is: NO. 153 | 154 | INLINE_INHERITED_MEMB = NO 155 | 156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 157 | # before files name in the file list and in the header files. If set to NO the 158 | # shortest path that makes the file name unique will be used 159 | # The default value is: YES. 160 | 161 | FULL_PATH_NAMES = YES 162 | 163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 164 | # Stripping is only done if one of the specified strings matches the left-hand 165 | # part of the path. The tag can be used to show relative paths in the file list. 166 | # If left blank the directory from which doxygen is run is used as the path to 167 | # strip. 168 | # 169 | # Note that you can specify absolute paths here, but also relative paths, which 170 | # will be relative from the directory where doxygen is started. 171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 172 | 173 | STRIP_FROM_PATH = 174 | 175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 176 | # path mentioned in the documentation of a class, which tells the reader which 177 | # header file to include in order to use a class. If left blank only the name of 178 | # the header file containing the class definition is used. Otherwise one should 179 | # specify the list of include paths that are normally passed to the compiler 180 | # using the -I flag. 181 | 182 | STRIP_FROM_INC_PATH = 183 | 184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 185 | # less readable) file names. This can be useful is your file systems doesn't 186 | # support long names like on DOS, Mac, or CD-ROM. 187 | # The default value is: NO. 188 | 189 | SHORT_NAMES = NO 190 | 191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 192 | # first line (until the first dot) of a Javadoc-style comment as the brief 193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 194 | # style comments (thus requiring an explicit @brief command for a brief 195 | # description.) 196 | # The default value is: NO. 197 | 198 | JAVADOC_AUTOBRIEF = NO 199 | 200 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 201 | # line (until the first dot) of a Qt-style comment as the brief description. If 202 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 203 | # requiring an explicit \brief command for a brief description.) 204 | # The default value is: NO. 205 | 206 | QT_AUTOBRIEF = NO 207 | 208 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 209 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 210 | # a brief description. This used to be the default behavior. The new default is 211 | # to treat a multi-line C++ comment block as a detailed description. Set this 212 | # tag to YES if you prefer the old behavior instead. 213 | # 214 | # Note that setting this tag to YES also means that rational rose comments are 215 | # not recognized any more. 216 | # The default value is: NO. 217 | 218 | MULTILINE_CPP_IS_BRIEF = NO 219 | 220 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 221 | # documentation from any documented member that it re-implements. 222 | # The default value is: YES. 223 | 224 | INHERIT_DOCS = YES 225 | 226 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 227 | # page for each member. If set to NO, the documentation of a member will be part 228 | # of the file/class/namespace that contains it. 229 | # The default value is: NO. 230 | 231 | SEPARATE_MEMBER_PAGES = NO 232 | 233 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 234 | # uses this value to replace tabs by spaces in code fragments. 235 | # Minimum value: 1, maximum value: 16, default value: 4. 236 | 237 | TAB_SIZE = 4 238 | 239 | # This tag can be used to specify a number of aliases that act as commands in 240 | # the documentation. An alias has the form: 241 | # name=value 242 | # For example adding 243 | # "sideeffect=@par Side Effects:\n" 244 | # will allow you to put the command \sideeffect (or @sideeffect) in the 245 | # documentation, which will result in a user-defined paragraph with heading 246 | # "Side Effects:". You can put \n's in the value part of an alias to insert 247 | # newlines (in the resulting output). You can put ^^ in the value part of an 248 | # alias to insert a newline as if a physical newline was in the original file. 249 | # When you need a literal { or } or , in the value part of an alias you have to 250 | # escape them by means of a backslash (\), this can lead to conflicts with the 251 | # commands \{ and \} for these it is advised to use the version @{ and @} or use 252 | # a double escape (\\{ and \\}) 253 | 254 | ALIASES = 255 | 256 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 257 | # A mapping has the form "name=value". For example adding "class=itcl::class" 258 | # will allow you to use the command class in the itcl::class meaning. 259 | 260 | TCL_SUBST = 261 | 262 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 263 | # only. Doxygen will then generate output that is more tailored for C. For 264 | # instance, some of the names that are used will be different. The list of all 265 | # members will be omitted, etc. 266 | # The default value is: NO. 267 | 268 | OPTIMIZE_OUTPUT_FOR_C = NO 269 | 270 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 271 | # Python sources only. Doxygen will then generate output that is more tailored 272 | # for that language. For instance, namespaces will be presented as packages, 273 | # qualified scopes will look different, etc. 274 | # The default value is: NO. 275 | 276 | OPTIMIZE_OUTPUT_JAVA = NO 277 | 278 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 279 | # sources. Doxygen will then generate output that is tailored for Fortran. 280 | # The default value is: NO. 281 | 282 | OPTIMIZE_FOR_FORTRAN = NO 283 | 284 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 285 | # sources. Doxygen will then generate output that is tailored for VHDL. 286 | # The default value is: NO. 287 | 288 | OPTIMIZE_OUTPUT_VHDL = NO 289 | 290 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 291 | # sources only. Doxygen will then generate output that is more tailored for that 292 | # language. For instance, namespaces will be presented as modules, types will be 293 | # separated into more groups, etc. 294 | # The default value is: NO. 295 | 296 | OPTIMIZE_OUTPUT_SLICE = NO 297 | 298 | # Doxygen selects the parser to use depending on the extension of the files it 299 | # parses. With this tag you can assign which parser to use for a given 300 | # extension. Doxygen has a built-in mapping, but you can override or extend it 301 | # using this tag. The format is ext=language, where ext is a file extension, and 302 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 303 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, 304 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 305 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 306 | # tries to guess whether the code is fixed or free formatted code, this is the 307 | # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat 308 | # .inc files as Fortran files (default is PHP), and .f files as C (default is 309 | # Fortran), use: inc=Fortran f=C. 310 | # 311 | # Note: For files without extension you can use no_extension as a placeholder. 312 | # 313 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 314 | # the files are not read by doxygen. 315 | 316 | EXTENSION_MAPPING = 317 | 318 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 319 | # according to the Markdown format, which allows for more readable 320 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 321 | # The output of markdown processing is further processed by doxygen, so you can 322 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 323 | # case of backward compatibilities issues. 324 | # The default value is: YES. 325 | 326 | MARKDOWN_SUPPORT = YES 327 | 328 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 329 | # to that level are automatically included in the table of contents, even if 330 | # they do not have an id attribute. 331 | # Note: This feature currently applies only to Markdown headings. 332 | # Minimum value: 0, maximum value: 99, default value: 0. 333 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 334 | 335 | TOC_INCLUDE_HEADINGS = 0 336 | 337 | # When enabled doxygen tries to link words that correspond to documented 338 | # classes, or namespaces to their corresponding documentation. Such a link can 339 | # be prevented in individual cases by putting a % sign in front of the word or 340 | # globally by setting AUTOLINK_SUPPORT to NO. 341 | # The default value is: YES. 342 | 343 | AUTOLINK_SUPPORT = YES 344 | 345 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 346 | # to include (a tag file for) the STL sources as input, then you should set this 347 | # tag to YES in order to let doxygen match functions declarations and 348 | # definitions whose arguments contain STL classes (e.g. func(std::string); 349 | # versus func(std::string) {}). This also make the inheritance and collaboration 350 | # diagrams that involve STL classes more complete and accurate. 351 | # The default value is: NO. 352 | 353 | BUILTIN_STL_SUPPORT = NO 354 | 355 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 356 | # enable parsing support. 357 | # The default value is: NO. 358 | 359 | CPP_CLI_SUPPORT = NO 360 | 361 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 362 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 363 | # will parse them like normal C++ but will assume all classes use public instead 364 | # of private inheritance when no explicit protection keyword is present. 365 | # The default value is: NO. 366 | 367 | SIP_SUPPORT = NO 368 | 369 | # For Microsoft's IDL there are propget and propput attributes to indicate 370 | # getter and setter methods for a property. Setting this option to YES will make 371 | # doxygen to replace the get and set methods by a property in the documentation. 372 | # This will only work if the methods are indeed getting or setting a simple 373 | # type. If this is not the case, or you want to show the methods anyway, you 374 | # should set this option to NO. 375 | # The default value is: YES. 376 | 377 | IDL_PROPERTY_SUPPORT = YES 378 | 379 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 380 | # tag is set to YES then doxygen will reuse the documentation of the first 381 | # member in the group (if any) for the other members of the group. By default 382 | # all members of a group must be documented explicitly. 383 | # The default value is: NO. 384 | 385 | DISTRIBUTE_GROUP_DOC = NO 386 | 387 | # If one adds a struct or class to a group and this option is enabled, then also 388 | # any nested class or struct is added to the same group. By default this option 389 | # is disabled and one has to add nested compounds explicitly via \ingroup. 390 | # The default value is: NO. 391 | 392 | GROUP_NESTED_COMPOUNDS = NO 393 | 394 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 395 | # (for instance a group of public functions) to be put as a subgroup of that 396 | # type (e.g. under the Public Functions section). Set it to NO to prevent 397 | # subgrouping. Alternatively, this can be done per class using the 398 | # \nosubgrouping command. 399 | # The default value is: YES. 400 | 401 | SUBGROUPING = YES 402 | 403 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 404 | # are shown inside the group in which they are included (e.g. using \ingroup) 405 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 406 | # and RTF). 407 | # 408 | # Note that this feature does not work in combination with 409 | # SEPARATE_MEMBER_PAGES. 410 | # The default value is: NO. 411 | 412 | INLINE_GROUPED_CLASSES = NO 413 | 414 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 415 | # with only public data fields or simple typedef fields will be shown inline in 416 | # the documentation of the scope in which they are defined (i.e. file, 417 | # namespace, or group documentation), provided this scope is documented. If set 418 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 419 | # Man pages) or section (for LaTeX and RTF). 420 | # The default value is: NO. 421 | 422 | INLINE_SIMPLE_STRUCTS = NO 423 | 424 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 425 | # enum is documented as struct, union, or enum with the name of the typedef. So 426 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 427 | # with name TypeT. When disabled the typedef will appear as a member of a file, 428 | # namespace, or class. And the struct will be named TypeS. This can typically be 429 | # useful for C code in case the coding convention dictates that all compound 430 | # types are typedef'ed and only the typedef is referenced, never the tag name. 431 | # The default value is: NO. 432 | 433 | TYPEDEF_HIDES_STRUCT = NO 434 | 435 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 436 | # cache is used to resolve symbols given their name and scope. Since this can be 437 | # an expensive process and often the same symbol appears multiple times in the 438 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 439 | # doxygen will become slower. If the cache is too large, memory is wasted. The 440 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 441 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 442 | # symbols. At the end of a run doxygen will report the cache usage and suggest 443 | # the optimal cache size from a speed point of view. 444 | # Minimum value: 0, maximum value: 9, default value: 0. 445 | 446 | LOOKUP_CACHE_SIZE = 0 447 | 448 | #--------------------------------------------------------------------------- 449 | # Build related configuration options 450 | #--------------------------------------------------------------------------- 451 | 452 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 453 | # documentation are documented, even if no documentation was available. Private 454 | # class members and static file members will be hidden unless the 455 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 456 | # Note: This will also disable the warnings about undocumented members that are 457 | # normally produced when WARNINGS is set to YES. 458 | # The default value is: NO. 459 | 460 | # MODIFIED this must by set to yes so doxygen will document standalone functions 461 | # and not just classes 462 | EXTRACT_ALL = YES 463 | 464 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 465 | # be included in the documentation. 466 | # The default value is: NO. 467 | 468 | EXTRACT_PRIVATE = NO 469 | 470 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 471 | # scope will be included in the documentation. 472 | # The default value is: NO. 473 | 474 | EXTRACT_PACKAGE = NO 475 | 476 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 477 | # included in the documentation. 478 | # The default value is: NO. 479 | 480 | EXTRACT_STATIC = NO 481 | 482 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 483 | # locally in source files will be included in the documentation. If set to NO, 484 | # only classes defined in header files are included. Does not have any effect 485 | # for Java sources. 486 | # The default value is: YES. 487 | 488 | EXTRACT_LOCAL_CLASSES = YES 489 | 490 | # This flag is only useful for Objective-C code. If set to YES, local methods, 491 | # which are defined in the implementation section but not in the interface are 492 | # included in the documentation. If set to NO, only methods in the interface are 493 | # included. 494 | # The default value is: NO. 495 | 496 | EXTRACT_LOCAL_METHODS = NO 497 | 498 | # If this flag is set to YES, the members of anonymous namespaces will be 499 | # extracted and appear in the documentation as a namespace called 500 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 501 | # the file that contains the anonymous namespace. By default anonymous namespace 502 | # are hidden. 503 | # The default value is: NO. 504 | 505 | EXTRACT_ANON_NSPACES = NO 506 | 507 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 508 | # undocumented members inside documented classes or files. If set to NO these 509 | # members will be included in the various overviews, but no documentation 510 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 511 | # The default value is: NO. 512 | 513 | HIDE_UNDOC_MEMBERS = NO 514 | 515 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 516 | # undocumented classes that are normally visible in the class hierarchy. If set 517 | # to NO, these classes will be included in the various overviews. This option 518 | # has no effect if EXTRACT_ALL is enabled. 519 | # The default value is: NO. 520 | 521 | HIDE_UNDOC_CLASSES = NO 522 | 523 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 524 | # (class|struct|union) declarations. If set to NO, these declarations will be 525 | # included in the documentation. 526 | # The default value is: NO. 527 | 528 | HIDE_FRIEND_COMPOUNDS = NO 529 | 530 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 531 | # documentation blocks found inside the body of a function. If set to NO, these 532 | # blocks will be appended to the function's detailed documentation block. 533 | # The default value is: NO. 534 | 535 | HIDE_IN_BODY_DOCS = NO 536 | 537 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 538 | # \internal command is included. If the tag is set to NO then the documentation 539 | # will be excluded. Set it to YES to include the internal documentation. 540 | # The default value is: NO. 541 | 542 | INTERNAL_DOCS = NO 543 | 544 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 545 | # names in lower-case letters. If set to YES, upper-case letters are also 546 | # allowed. This is useful if you have classes or files whose names only differ 547 | # in case and if your file system supports case sensitive file names. Windows 548 | # and Mac users are advised to set this option to NO. 549 | # The default value is: system dependent. 550 | 551 | CASE_SENSE_NAMES = YES 552 | 553 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 554 | # their full class and namespace scopes in the documentation. If set to YES, the 555 | # scope will be hidden. 556 | # The default value is: NO. 557 | 558 | HIDE_SCOPE_NAMES = NO 559 | 560 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 561 | # append additional text to a page's title, such as Class Reference. If set to 562 | # YES the compound reference will be hidden. 563 | # The default value is: NO. 564 | 565 | HIDE_COMPOUND_REFERENCE= NO 566 | 567 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 568 | # the files that are included by a file in the documentation of that file. 569 | # The default value is: YES. 570 | 571 | SHOW_INCLUDE_FILES = YES 572 | 573 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 574 | # grouped member an include statement to the documentation, telling the reader 575 | # which file to include in order to use the member. 576 | # The default value is: NO. 577 | 578 | SHOW_GROUPED_MEMB_INC = NO 579 | 580 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 581 | # files with double quotes in the documentation rather than with sharp brackets. 582 | # The default value is: NO. 583 | 584 | FORCE_LOCAL_INCLUDES = NO 585 | 586 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 587 | # documentation for inline members. 588 | # The default value is: YES. 589 | 590 | INLINE_INFO = YES 591 | 592 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 593 | # (detailed) documentation of file and class members alphabetically by member 594 | # name. If set to NO, the members will appear in declaration order. 595 | # The default value is: YES. 596 | 597 | SORT_MEMBER_DOCS = YES 598 | 599 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 600 | # descriptions of file, namespace and class members alphabetically by member 601 | # name. If set to NO, the members will appear in declaration order. Note that 602 | # this will also influence the order of the classes in the class list. 603 | # The default value is: NO. 604 | 605 | SORT_BRIEF_DOCS = NO 606 | 607 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 608 | # (brief and detailed) documentation of class members so that constructors and 609 | # destructors are listed first. If set to NO the constructors will appear in the 610 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 611 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 612 | # member documentation. 613 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 614 | # detailed member documentation. 615 | # The default value is: NO. 616 | 617 | SORT_MEMBERS_CTORS_1ST = NO 618 | 619 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 620 | # of group names into alphabetical order. If set to NO the group names will 621 | # appear in their defined order. 622 | # The default value is: NO. 623 | 624 | SORT_GROUP_NAMES = NO 625 | 626 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 627 | # fully-qualified names, including namespaces. If set to NO, the class list will 628 | # be sorted only by class name, not including the namespace part. 629 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 630 | # Note: This option applies only to the class list, not to the alphabetical 631 | # list. 632 | # The default value is: NO. 633 | 634 | SORT_BY_SCOPE_NAME = NO 635 | 636 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 637 | # type resolution of all parameters of a function it will reject a match between 638 | # the prototype and the implementation of a member function even if there is 639 | # only one candidate or it is obvious which candidate to choose by doing a 640 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 641 | # accept a match between prototype and implementation in such cases. 642 | # The default value is: NO. 643 | 644 | STRICT_PROTO_MATCHING = NO 645 | 646 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 647 | # list. This list is created by putting \todo commands in the documentation. 648 | # The default value is: YES. 649 | 650 | GENERATE_TODOLIST = YES 651 | 652 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 653 | # list. This list is created by putting \test commands in the documentation. 654 | # The default value is: YES. 655 | 656 | GENERATE_TESTLIST = YES 657 | 658 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 659 | # list. This list is created by putting \bug commands in the documentation. 660 | # The default value is: YES. 661 | 662 | GENERATE_BUGLIST = YES 663 | 664 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 665 | # the deprecated list. This list is created by putting \deprecated commands in 666 | # the documentation. 667 | # The default value is: YES. 668 | 669 | GENERATE_DEPRECATEDLIST= YES 670 | 671 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 672 | # sections, marked by \if ... \endif and \cond 673 | # ... \endcond blocks. 674 | 675 | ENABLED_SECTIONS = 676 | 677 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 678 | # initial value of a variable or macro / define can have for it to appear in the 679 | # documentation. If the initializer consists of more lines than specified here 680 | # it will be hidden. Use a value of 0 to hide initializers completely. The 681 | # appearance of the value of individual variables and macros / defines can be 682 | # controlled using \showinitializer or \hideinitializer command in the 683 | # documentation regardless of this setting. 684 | # Minimum value: 0, maximum value: 10000, default value: 30. 685 | 686 | MAX_INITIALIZER_LINES = 30 687 | 688 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 689 | # the bottom of the documentation of classes and structs. If set to YES, the 690 | # list will mention the files that were used to generate the documentation. 691 | # The default value is: YES. 692 | 693 | SHOW_USED_FILES = YES 694 | 695 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 696 | # will remove the Files entry from the Quick Index and from the Folder Tree View 697 | # (if specified). 698 | # The default value is: YES. 699 | 700 | SHOW_FILES = YES 701 | 702 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 703 | # page. This will remove the Namespaces entry from the Quick Index and from the 704 | # Folder Tree View (if specified). 705 | # The default value is: YES. 706 | 707 | SHOW_NAMESPACES = YES 708 | 709 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 710 | # doxygen should invoke to get the current version for each file (typically from 711 | # the version control system). Doxygen will invoke the program by executing (via 712 | # popen()) the command command input-file, where command is the value of the 713 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 714 | # by doxygen. Whatever the program writes to standard output is used as the file 715 | # version. For an example see the documentation. 716 | 717 | FILE_VERSION_FILTER = 718 | 719 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 720 | # by doxygen. The layout file controls the global structure of the generated 721 | # output files in an output format independent way. To create the layout file 722 | # that represents doxygen's defaults, run doxygen with the -l option. You can 723 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 724 | # will be used as the name of the layout file. 725 | # 726 | # Note that if you run doxygen from a directory containing a file called 727 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 728 | # tag is left empty. 729 | 730 | LAYOUT_FILE = 731 | 732 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 733 | # the reference definitions. This must be a list of .bib files. The .bib 734 | # extension is automatically appended if omitted. This requires the bibtex tool 735 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 736 | # For LaTeX the style of the bibliography can be controlled using 737 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 738 | # search path. See also \cite for info how to create references. 739 | 740 | CITE_BIB_FILES = 741 | 742 | #--------------------------------------------------------------------------- 743 | # Configuration options related to warning and progress messages 744 | #--------------------------------------------------------------------------- 745 | 746 | # The QUIET tag can be used to turn on/off the messages that are generated to 747 | # standard output by doxygen. If QUIET is set to YES this implies that the 748 | # messages are off. 749 | # The default value is: NO. 750 | 751 | QUIET = NO 752 | 753 | # The WARNINGS tag can be used to turn on/off the warning messages that are 754 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 755 | # this implies that the warnings are on. 756 | # 757 | # Tip: Turn warnings on while writing the documentation. 758 | # The default value is: YES. 759 | 760 | WARNINGS = YES 761 | 762 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 763 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 764 | # will automatically be disabled. 765 | # The default value is: YES. 766 | 767 | WARN_IF_UNDOCUMENTED = YES 768 | 769 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 770 | # potential errors in the documentation, such as not documenting some parameters 771 | # in a documented function, or documenting parameters that don't exist or using 772 | # markup commands wrongly. 773 | # The default value is: YES. 774 | 775 | WARN_IF_DOC_ERROR = YES 776 | 777 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 778 | # are documented, but have no documentation for their parameters or return 779 | # value. If set to NO, doxygen will only warn about wrong or incomplete 780 | # parameter documentation, but not about the absence of documentation. If 781 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 782 | # The default value is: NO. 783 | 784 | WARN_NO_PARAMDOC = NO 785 | 786 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 787 | # a warning is encountered. 788 | # The default value is: NO. 789 | 790 | WARN_AS_ERROR = NO 791 | 792 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 793 | # can produce. The string should contain the $file, $line, and $text tags, which 794 | # will be replaced by the file and line number from which the warning originated 795 | # and the warning text. Optionally the format may contain $version, which will 796 | # be replaced by the version of the file (if it could be obtained via 797 | # FILE_VERSION_FILTER) 798 | # The default value is: $file:$line: $text. 799 | 800 | WARN_FORMAT = "$file:$line: $text" 801 | 802 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 803 | # messages should be written. If left blank the output is written to standard 804 | # error (stderr). 805 | 806 | WARN_LOGFILE = 807 | 808 | #--------------------------------------------------------------------------- 809 | # Configuration options related to the input files 810 | #--------------------------------------------------------------------------- 811 | 812 | # The INPUT tag is used to specify the files and/or directories that contain 813 | # documented source files. You may enter file names like myfile.cpp or 814 | # directories like /usr/src/myproject. Separate the files or directories with 815 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 816 | # Note: If this tag is empty the current directory is searched. 817 | 818 | INPUT = src 819 | 820 | # This tag can be used to specify the character encoding of the source files 821 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 822 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 823 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 824 | # possible encodings. 825 | # The default value is: UTF-8. 826 | 827 | INPUT_ENCODING = UTF-8 828 | 829 | # If the value of the INPUT tag contains directories, you can use the 830 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 831 | # *.h) to filter out the source-files in the directories. 832 | # 833 | # Note that for custom extensions or not directly supported extensions you also 834 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 835 | # read by doxygen. 836 | # 837 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 838 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 839 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 840 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 841 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. 842 | 843 | FILE_PATTERNS = *.c \ 844 | *.cc \ 845 | *.cxx \ 846 | *.cpp \ 847 | *.c++ \ 848 | *.java \ 849 | *.ii \ 850 | *.ixx \ 851 | *.ipp \ 852 | *.i++ \ 853 | *.inl \ 854 | *.idl \ 855 | *.ddl \ 856 | *.odl \ 857 | *.h \ 858 | *.hh \ 859 | *.hxx \ 860 | *.hpp \ 861 | *.h++ \ 862 | *.cs \ 863 | *.d \ 864 | *.php \ 865 | *.php4 \ 866 | *.php5 \ 867 | *.phtml \ 868 | *.inc \ 869 | *.m \ 870 | *.markdown \ 871 | *.md \ 872 | *.mm \ 873 | *.dox \ 874 | *.py \ 875 | *.pyw \ 876 | *.f90 \ 877 | *.f95 \ 878 | *.f03 \ 879 | *.f08 \ 880 | *.f \ 881 | *.for \ 882 | *.tcl \ 883 | *.vhd \ 884 | *.vhdl \ 885 | *.ucf \ 886 | *.qsf \ 887 | *.ice 888 | 889 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 890 | # be searched for input files as well. 891 | # The default value is: NO. 892 | 893 | RECURSIVE = NO 894 | 895 | # The EXCLUDE tag can be used to specify files and/or directories that should be 896 | # excluded from the INPUT source files. This way you can easily exclude a 897 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 898 | # 899 | # Note that relative paths are relative to the directory from which doxygen is 900 | # run. 901 | 902 | EXCLUDE = 903 | 904 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 905 | # directories that are symbolic links (a Unix file system feature) are excluded 906 | # from the input. 907 | # The default value is: NO. 908 | 909 | EXCLUDE_SYMLINKS = NO 910 | 911 | # If the value of the INPUT tag contains directories, you can use the 912 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 913 | # certain files from those directories. 914 | # 915 | # Note that the wildcards are matched against the file with absolute path, so to 916 | # exclude all test directories for example use the pattern */test/* 917 | 918 | EXCLUDE_PATTERNS = 919 | 920 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 921 | # (namespaces, classes, functions, etc.) that should be excluded from the 922 | # output. The symbol name can be a fully qualified name, a word, or if the 923 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 924 | # AClass::ANamespace, ANamespace::*Test 925 | # 926 | # Note that the wildcards are matched against the file with absolute path, so to 927 | # exclude all test directories use the pattern */test/* 928 | 929 | EXCLUDE_SYMBOLS = 930 | 931 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 932 | # that contain example code fragments that are included (see the \include 933 | # command). 934 | 935 | EXAMPLE_PATH = 936 | 937 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 938 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 939 | # *.h) to filter out the source-files in the directories. If left blank all 940 | # files are included. 941 | 942 | EXAMPLE_PATTERNS = * 943 | 944 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 945 | # searched for input files to be used with the \include or \dontinclude commands 946 | # irrespective of the value of the RECURSIVE tag. 947 | # The default value is: NO. 948 | 949 | EXAMPLE_RECURSIVE = NO 950 | 951 | # The IMAGE_PATH tag can be used to specify one or more files or directories 952 | # that contain images that are to be included in the documentation (see the 953 | # \image command). 954 | 955 | IMAGE_PATH = 956 | 957 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 958 | # invoke to filter for each input file. Doxygen will invoke the filter program 959 | # by executing (via popen()) the command: 960 | # 961 | # 962 | # 963 | # where is the value of the INPUT_FILTER tag, and is the 964 | # name of an input file. Doxygen will then use the output that the filter 965 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 966 | # will be ignored. 967 | # 968 | # Note that the filter must not add or remove lines; it is applied before the 969 | # code is scanned, but not when the output code is generated. If lines are added 970 | # or removed, the anchors will not be placed correctly. 971 | # 972 | # Note that for custom extensions or not directly supported extensions you also 973 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 974 | # properly processed by doxygen. 975 | 976 | INPUT_FILTER = 977 | 978 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 979 | # basis. Doxygen will compare the file name with each pattern and apply the 980 | # filter if there is a match. The filters are a list of the form: pattern=filter 981 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 982 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 983 | # patterns match the file name, INPUT_FILTER is applied. 984 | # 985 | # Note that for custom extensions or not directly supported extensions you also 986 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 987 | # properly processed by doxygen. 988 | 989 | FILTER_PATTERNS = 990 | 991 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 992 | # INPUT_FILTER) will also be used to filter the input files that are used for 993 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 994 | # The default value is: NO. 995 | 996 | FILTER_SOURCE_FILES = NO 997 | 998 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 999 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1000 | # it is also possible to disable source filtering for a specific pattern using 1001 | # *.ext= (so without naming a filter). 1002 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1003 | 1004 | FILTER_SOURCE_PATTERNS = 1005 | 1006 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1007 | # is part of the input, its contents will be placed on the main page 1008 | # (index.html). This can be useful if you have a project on for instance GitHub 1009 | # and want to reuse the introduction page also for the doxygen output. 1010 | 1011 | USE_MDFILE_AS_MAINPAGE = 1012 | 1013 | #--------------------------------------------------------------------------- 1014 | # Configuration options related to source browsing 1015 | #--------------------------------------------------------------------------- 1016 | 1017 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1018 | # generated. Documented entities will be cross-referenced with these sources. 1019 | # 1020 | # Note: To get rid of all source code in the generated output, make sure that 1021 | # also VERBATIM_HEADERS is set to NO. 1022 | # The default value is: NO. 1023 | 1024 | SOURCE_BROWSER = NO 1025 | 1026 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1027 | # classes and enums directly into the documentation. 1028 | # The default value is: NO. 1029 | 1030 | INLINE_SOURCES = NO 1031 | 1032 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1033 | # special comment blocks from generated source code fragments. Normal C, C++ and 1034 | # Fortran comments will always remain visible. 1035 | # The default value is: YES. 1036 | 1037 | STRIP_CODE_COMMENTS = YES 1038 | 1039 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1040 | # entity all documented functions referencing it will be listed. 1041 | # The default value is: NO. 1042 | 1043 | REFERENCED_BY_RELATION = NO 1044 | 1045 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1046 | # all documented entities called/used by that function will be listed. 1047 | # The default value is: NO. 1048 | 1049 | REFERENCES_RELATION = NO 1050 | 1051 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1052 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1053 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1054 | # link to the documentation. 1055 | # The default value is: YES. 1056 | 1057 | REFERENCES_LINK_SOURCE = YES 1058 | 1059 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1060 | # source code will show a tooltip with additional information such as prototype, 1061 | # brief description and links to the definition and documentation. Since this 1062 | # will make the HTML file larger and loading of large files a bit slower, you 1063 | # can opt to disable this feature. 1064 | # The default value is: YES. 1065 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1066 | 1067 | SOURCE_TOOLTIPS = YES 1068 | 1069 | # If the USE_HTAGS tag is set to YES then the references to source code will 1070 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1071 | # source browser. The htags tool is part of GNU's global source tagging system 1072 | # (see https://www.gnu.org/software/global/global.html). You will need version 1073 | # 4.8.6 or higher. 1074 | # 1075 | # To use it do the following: 1076 | # - Install the latest version of global 1077 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1078 | # - Make sure the INPUT points to the root of the source tree 1079 | # - Run doxygen as normal 1080 | # 1081 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1082 | # tools must be available from the command line (i.e. in the search path). 1083 | # 1084 | # The result: instead of the source browser generated by doxygen, the links to 1085 | # source code will now point to the output of htags. 1086 | # The default value is: NO. 1087 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1088 | 1089 | USE_HTAGS = NO 1090 | 1091 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1092 | # verbatim copy of the header file for each class for which an include is 1093 | # specified. Set to NO to disable this. 1094 | # See also: Section \class. 1095 | # The default value is: YES. 1096 | 1097 | VERBATIM_HEADERS = YES 1098 | 1099 | #--------------------------------------------------------------------------- 1100 | # Configuration options related to the alphabetical class index 1101 | #--------------------------------------------------------------------------- 1102 | 1103 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1104 | # compounds will be generated. Enable this if the project contains a lot of 1105 | # classes, structs, unions or interfaces. 1106 | # The default value is: YES. 1107 | 1108 | ALPHABETICAL_INDEX = YES 1109 | 1110 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1111 | # which the alphabetical index list will be split. 1112 | # Minimum value: 1, maximum value: 20, default value: 5. 1113 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1114 | 1115 | COLS_IN_ALPHA_INDEX = 5 1116 | 1117 | # In case all classes in a project start with a common prefix, all classes will 1118 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1119 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1120 | # while generating the index headers. 1121 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1122 | 1123 | IGNORE_PREFIX = 1124 | 1125 | #--------------------------------------------------------------------------- 1126 | # Configuration options related to the HTML output 1127 | #--------------------------------------------------------------------------- 1128 | 1129 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1130 | # The default value is: YES. 1131 | 1132 | GENERATE_HTML = YES 1133 | 1134 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1135 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1136 | # it. 1137 | # The default directory is: html. 1138 | # This tag requires that the tag GENERATE_HTML is set to YES. 1139 | 1140 | HTML_OUTPUT = html 1141 | 1142 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1143 | # generated HTML page (for example: .htm, .php, .asp). 1144 | # The default value is: .html. 1145 | # This tag requires that the tag GENERATE_HTML is set to YES. 1146 | 1147 | HTML_FILE_EXTENSION = .html 1148 | 1149 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1150 | # each generated HTML page. If the tag is left blank doxygen will generate a 1151 | # standard header. 1152 | # 1153 | # To get valid HTML the header file that includes any scripts and style sheets 1154 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1155 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1156 | # default header using 1157 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1158 | # YourConfigFile 1159 | # and then modify the file new_header.html. See also section "Doxygen usage" 1160 | # for information on how to generate the default header that doxygen normally 1161 | # uses. 1162 | # Note: The header is subject to change so you typically have to regenerate the 1163 | # default header when upgrading to a newer version of doxygen. For a description 1164 | # of the possible markers and block names see the documentation. 1165 | # This tag requires that the tag GENERATE_HTML is set to YES. 1166 | 1167 | HTML_HEADER = 1168 | 1169 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1170 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1171 | # footer. See HTML_HEADER for more information on how to generate a default 1172 | # footer and what special commands can be used inside the footer. See also 1173 | # section "Doxygen usage" for information on how to generate the default footer 1174 | # that doxygen normally uses. 1175 | # This tag requires that the tag GENERATE_HTML is set to YES. 1176 | 1177 | HTML_FOOTER = 1178 | 1179 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1180 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1181 | # the HTML output. If left blank doxygen will generate a default style sheet. 1182 | # See also section "Doxygen usage" for information on how to generate the style 1183 | # sheet that doxygen normally uses. 1184 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1185 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1186 | # obsolete. 1187 | # This tag requires that the tag GENERATE_HTML is set to YES. 1188 | 1189 | HTML_STYLESHEET = 1190 | 1191 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1192 | # cascading style sheets that are included after the standard style sheets 1193 | # created by doxygen. Using this option one can overrule certain style aspects. 1194 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1195 | # standard style sheet and is therefore more robust against future updates. 1196 | # Doxygen will copy the style sheet files to the output directory. 1197 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1198 | # style sheet in the list overrules the setting of the previous ones in the 1199 | # list). For an example see the documentation. 1200 | # This tag requires that the tag GENERATE_HTML is set to YES. 1201 | 1202 | HTML_EXTRA_STYLESHEET = 1203 | 1204 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1205 | # other source files which should be copied to the HTML output directory. Note 1206 | # that these files will be copied to the base HTML output directory. Use the 1207 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1208 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1209 | # files will be copied as-is; there are no commands or markers available. 1210 | # This tag requires that the tag GENERATE_HTML is set to YES. 1211 | 1212 | HTML_EXTRA_FILES = 1213 | 1214 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1215 | # will adjust the colors in the style sheet and background images according to 1216 | # this color. Hue is specified as an angle on a colorwheel, see 1217 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1218 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1219 | # purple, and 360 is red again. 1220 | # Minimum value: 0, maximum value: 359, default value: 220. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_COLORSTYLE_HUE = 220 1224 | 1225 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1226 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1227 | # value of 255 will produce the most vivid colors. 1228 | # Minimum value: 0, maximum value: 255, default value: 100. 1229 | # This tag requires that the tag GENERATE_HTML is set to YES. 1230 | 1231 | HTML_COLORSTYLE_SAT = 100 1232 | 1233 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1234 | # luminance component of the colors in the HTML output. Values below 100 1235 | # gradually make the output lighter, whereas values above 100 make the output 1236 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1237 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1238 | # change the gamma. 1239 | # Minimum value: 40, maximum value: 240, default value: 80. 1240 | # This tag requires that the tag GENERATE_HTML is set to YES. 1241 | 1242 | HTML_COLORSTYLE_GAMMA = 80 1243 | 1244 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1245 | # page will contain the date and time when the page was generated. Setting this 1246 | # to YES can help to show when doxygen was last run and thus if the 1247 | # documentation is up to date. 1248 | # The default value is: NO. 1249 | # This tag requires that the tag GENERATE_HTML is set to YES. 1250 | 1251 | HTML_TIMESTAMP = NO 1252 | 1253 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1254 | # documentation will contain a main index with vertical navigation menus that 1255 | # are dynamically created via Javascript. If disabled, the navigation index will 1256 | # consists of multiple levels of tabs that are statically embedded in every HTML 1257 | # page. Disable this option to support browsers that do not have Javascript, 1258 | # like the Qt help browser. 1259 | # The default value is: YES. 1260 | # This tag requires that the tag GENERATE_HTML is set to YES. 1261 | 1262 | HTML_DYNAMIC_MENUS = YES 1263 | 1264 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1265 | # documentation will contain sections that can be hidden and shown after the 1266 | # page has loaded. 1267 | # The default value is: NO. 1268 | # This tag requires that the tag GENERATE_HTML is set to YES. 1269 | 1270 | HTML_DYNAMIC_SECTIONS = NO 1271 | 1272 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1273 | # shown in the various tree structured indices initially; the user can expand 1274 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1275 | # such a level that at most the specified number of entries are visible (unless 1276 | # a fully collapsed tree already exceeds this amount). So setting the number of 1277 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1278 | # representing an infinite number of entries and will result in a full expanded 1279 | # tree by default. 1280 | # Minimum value: 0, maximum value: 9999, default value: 100. 1281 | # This tag requires that the tag GENERATE_HTML is set to YES. 1282 | 1283 | HTML_INDEX_NUM_ENTRIES = 100 1284 | 1285 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1286 | # generated that can be used as input for Apple's Xcode 3 integrated development 1287 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX 1288 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a 1289 | # Makefile in the HTML output directory. Running make will produce the docset in 1290 | # that directory and running make install will install the docset in 1291 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1292 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1293 | # genXcode/_index.html for more information. 1294 | # The default value is: NO. 1295 | # This tag requires that the tag GENERATE_HTML is set to YES. 1296 | 1297 | GENERATE_DOCSET = NO 1298 | 1299 | # This tag determines the name of the docset feed. A documentation feed provides 1300 | # an umbrella under which multiple documentation sets from a single provider 1301 | # (such as a company or product suite) can be grouped. 1302 | # The default value is: Doxygen generated docs. 1303 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1304 | 1305 | DOCSET_FEEDNAME = "Doxygen generated docs" 1306 | 1307 | # This tag specifies a string that should uniquely identify the documentation 1308 | # set bundle. This should be a reverse domain-name style string, e.g. 1309 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1310 | # The default value is: org.doxygen.Project. 1311 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1312 | 1313 | DOCSET_BUNDLE_ID = org.doxygen.Project 1314 | 1315 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1316 | # the documentation publisher. This should be a reverse domain-name style 1317 | # string, e.g. com.mycompany.MyDocSet.documentation. 1318 | # The default value is: org.doxygen.Publisher. 1319 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1320 | 1321 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1322 | 1323 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1324 | # The default value is: Publisher. 1325 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1326 | 1327 | DOCSET_PUBLISHER_NAME = Publisher 1328 | 1329 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1330 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1331 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1332 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1333 | # Windows. 1334 | # 1335 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1336 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1337 | # files are now used as the Windows 98 help format, and will replace the old 1338 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1339 | # HTML files also contain an index, a table of contents, and you can search for 1340 | # words in the documentation. The HTML workshop also contains a viewer for 1341 | # compressed HTML files. 1342 | # The default value is: NO. 1343 | # This tag requires that the tag GENERATE_HTML is set to YES. 1344 | 1345 | GENERATE_HTMLHELP = NO 1346 | 1347 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1348 | # file. You can add a path in front of the file if the result should not be 1349 | # written to the html output directory. 1350 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1351 | 1352 | CHM_FILE = 1353 | 1354 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1355 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1356 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1357 | # The file has to be specified with full path. 1358 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1359 | 1360 | HHC_LOCATION = 1361 | 1362 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1363 | # (YES) or that it should be included in the master .chm file (NO). 1364 | # The default value is: NO. 1365 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1366 | 1367 | GENERATE_CHI = NO 1368 | 1369 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1370 | # and project file content. 1371 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1372 | 1373 | CHM_INDEX_ENCODING = 1374 | 1375 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1376 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1377 | # enables the Previous and Next buttons. 1378 | # The default value is: NO. 1379 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1380 | 1381 | BINARY_TOC = NO 1382 | 1383 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1384 | # the table of contents of the HTML help documentation and to the tree view. 1385 | # The default value is: NO. 1386 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1387 | 1388 | TOC_EXPAND = NO 1389 | 1390 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1391 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1392 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1393 | # (.qch) of the generated HTML documentation. 1394 | # The default value is: NO. 1395 | # This tag requires that the tag GENERATE_HTML is set to YES. 1396 | 1397 | GENERATE_QHP = NO 1398 | 1399 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1400 | # the file name of the resulting .qch file. The path specified is relative to 1401 | # the HTML output folder. 1402 | # This tag requires that the tag GENERATE_QHP is set to YES. 1403 | 1404 | QCH_FILE = 1405 | 1406 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1407 | # Project output. For more information please see Qt Help Project / Namespace 1408 | # (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1409 | # The default value is: org.doxygen.Project. 1410 | # This tag requires that the tag GENERATE_QHP is set to YES. 1411 | 1412 | QHP_NAMESPACE = org.doxygen.Project 1413 | 1414 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1415 | # Help Project output. For more information please see Qt Help Project / Virtual 1416 | # Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- 1417 | # folders). 1418 | # The default value is: doc. 1419 | # This tag requires that the tag GENERATE_QHP is set to YES. 1420 | 1421 | QHP_VIRTUAL_FOLDER = doc 1422 | 1423 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1424 | # filter to add. For more information please see Qt Help Project / Custom 1425 | # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1426 | # filters). 1427 | # This tag requires that the tag GENERATE_QHP is set to YES. 1428 | 1429 | QHP_CUST_FILTER_NAME = 1430 | 1431 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1432 | # custom filter to add. For more information please see Qt Help Project / Custom 1433 | # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1434 | # filters). 1435 | # This tag requires that the tag GENERATE_QHP is set to YES. 1436 | 1437 | QHP_CUST_FILTER_ATTRS = 1438 | 1439 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1440 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1441 | # http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1442 | # This tag requires that the tag GENERATE_QHP is set to YES. 1443 | 1444 | QHP_SECT_FILTER_ATTRS = 1445 | 1446 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1447 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1448 | # generated .qhp file. 1449 | # This tag requires that the tag GENERATE_QHP is set to YES. 1450 | 1451 | QHG_LOCATION = 1452 | 1453 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1454 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1455 | # install this plugin and make it available under the help contents menu in 1456 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1457 | # to be copied into the plugins directory of eclipse. The name of the directory 1458 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1459 | # After copying Eclipse needs to be restarted before the help appears. 1460 | # The default value is: NO. 1461 | # This tag requires that the tag GENERATE_HTML is set to YES. 1462 | 1463 | GENERATE_ECLIPSEHELP = NO 1464 | 1465 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1466 | # the directory name containing the HTML and XML files should also have this 1467 | # name. Each documentation set should have its own identifier. 1468 | # The default value is: org.doxygen.Project. 1469 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1470 | 1471 | ECLIPSE_DOC_ID = org.doxygen.Project 1472 | 1473 | # If you want full control over the layout of the generated HTML pages it might 1474 | # be necessary to disable the index and replace it with your own. The 1475 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1476 | # of each HTML page. A value of NO enables the index and the value YES disables 1477 | # it. Since the tabs in the index contain the same information as the navigation 1478 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1479 | # The default value is: NO. 1480 | # This tag requires that the tag GENERATE_HTML is set to YES. 1481 | 1482 | DISABLE_INDEX = NO 1483 | 1484 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1485 | # structure should be generated to display hierarchical information. If the tag 1486 | # value is set to YES, a side panel will be generated containing a tree-like 1487 | # index structure (just like the one that is generated for HTML Help). For this 1488 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1489 | # (i.e. any modern browser). Windows users are probably better off using the 1490 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1491 | # further fine-tune the look of the index. As an example, the default style 1492 | # sheet generated by doxygen has an example that shows how to put an image at 1493 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1494 | # the same information as the tab index, you could consider setting 1495 | # DISABLE_INDEX to YES when enabling this option. 1496 | # The default value is: NO. 1497 | # This tag requires that the tag GENERATE_HTML is set to YES. 1498 | 1499 | GENERATE_TREEVIEW = NO 1500 | 1501 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1502 | # doxygen will group on one line in the generated HTML documentation. 1503 | # 1504 | # Note that a value of 0 will completely suppress the enum values from appearing 1505 | # in the overview section. 1506 | # Minimum value: 0, maximum value: 20, default value: 4. 1507 | # This tag requires that the tag GENERATE_HTML is set to YES. 1508 | 1509 | ENUM_VALUES_PER_LINE = 4 1510 | 1511 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1512 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1513 | # Minimum value: 0, maximum value: 1500, default value: 250. 1514 | # This tag requires that the tag GENERATE_HTML is set to YES. 1515 | 1516 | TREEVIEW_WIDTH = 250 1517 | 1518 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1519 | # external symbols imported via tag files in a separate window. 1520 | # The default value is: NO. 1521 | # This tag requires that the tag GENERATE_HTML is set to YES. 1522 | 1523 | EXT_LINKS_IN_WINDOW = NO 1524 | 1525 | # Use this tag to change the font size of LaTeX formulas included as images in 1526 | # the HTML documentation. When you change the font size after a successful 1527 | # doxygen run you need to manually remove any form_*.png images from the HTML 1528 | # output directory to force them to be regenerated. 1529 | # Minimum value: 8, maximum value: 50, default value: 10. 1530 | # This tag requires that the tag GENERATE_HTML is set to YES. 1531 | 1532 | FORMULA_FONTSIZE = 10 1533 | 1534 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1535 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1536 | # supported properly for IE 6.0, but are supported on all modern browsers. 1537 | # 1538 | # Note that when changing this option you need to delete any form_*.png files in 1539 | # the HTML output directory before the changes have effect. 1540 | # The default value is: YES. 1541 | # This tag requires that the tag GENERATE_HTML is set to YES. 1542 | 1543 | FORMULA_TRANSPARENT = YES 1544 | 1545 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1546 | # https://www.mathjax.org) which uses client side Javascript for the rendering 1547 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1548 | # installed or if you want to formulas look prettier in the HTML output. When 1549 | # enabled you may also need to install MathJax separately and configure the path 1550 | # to it using the MATHJAX_RELPATH option. 1551 | # The default value is: NO. 1552 | # This tag requires that the tag GENERATE_HTML is set to YES. 1553 | 1554 | USE_MATHJAX = NO 1555 | 1556 | # When MathJax is enabled you can set the default output format to be used for 1557 | # the MathJax output. See the MathJax site (see: 1558 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1559 | # Possible values are: HTML-CSS (which is slower, but has the best 1560 | # compatibility), NativeMML (i.e. MathML) and SVG. 1561 | # The default value is: HTML-CSS. 1562 | # This tag requires that the tag USE_MATHJAX is set to YES. 1563 | 1564 | MATHJAX_FORMAT = HTML-CSS 1565 | 1566 | # When MathJax is enabled you need to specify the location relative to the HTML 1567 | # output directory using the MATHJAX_RELPATH option. The destination directory 1568 | # should contain the MathJax.js script. For instance, if the mathjax directory 1569 | # is located at the same level as the HTML output directory, then 1570 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1571 | # Content Delivery Network so you can quickly see the result without installing 1572 | # MathJax. However, it is strongly recommended to install a local copy of 1573 | # MathJax from https://www.mathjax.org before deployment. 1574 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. 1575 | # This tag requires that the tag USE_MATHJAX is set to YES. 1576 | 1577 | MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ 1578 | 1579 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1580 | # extension names that should be enabled during MathJax rendering. For example 1581 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1582 | # This tag requires that the tag USE_MATHJAX is set to YES. 1583 | 1584 | MATHJAX_EXTENSIONS = 1585 | 1586 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1587 | # of code that will be used on startup of the MathJax code. See the MathJax site 1588 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1589 | # example see the documentation. 1590 | # This tag requires that the tag USE_MATHJAX is set to YES. 1591 | 1592 | MATHJAX_CODEFILE = 1593 | 1594 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1595 | # the HTML output. The underlying search engine uses javascript and DHTML and 1596 | # should work on any modern browser. Note that when using HTML help 1597 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1598 | # there is already a search function so this one should typically be disabled. 1599 | # For large projects the javascript based search engine can be slow, then 1600 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1601 | # search using the keyboard; to jump to the search box use + S 1602 | # (what the is depends on the OS and browser, but it is typically 1603 | # , /