AudioFFT 技术文档

1. 安装指南

AudioFFT 的安装非常简单。首先，你需要将项目中的 .h 和 .cpp 文件添加到你的项目中。根据你的开发平台和需求，你可能还需要进行以下操作：

• 若要使用 FFTW3 以获得额外速度，你需要将 FFTW3 链接到你的项目，并定义 AUDIOFFT_FFTW3 宏（但请确保你的项目符合 FFTW3 的许可协议）。
• 若要在苹果平台上获得最佳速度，你需要将 Apple Accelerate 框架链接到你的项目，并定义 AUDIOFFT_APPLE_ACCELERATE。
• 在任何支持的平台上，你都可以通过链接到 Intel IPP 并定义 AUDIOFFT_INTEL_IPP 来使用 Intel IPP 的 FFT。

2. 项目的使用说明

AudioFFT 提供了实数到复数和复数到实数的 FFT 例程。以下是一个使用 AudioFFT 的简单示例：

#include "AudioFFT.h"

void Example()
{
  const size_t fftSize = 1024; // 需要是 2 的幂！

  std::vector<float> input(fftSize, 0.0f);
  std::vector<float> re(fftaudio::AudioFFT::ComplexSize(fftSize)); 
  std::vector<float> im(fftaudio::AudioFFT::ComplexSize(fftSize)); 
  std::vector<float> output(fftSize);
  
  audiofft::AudioFFT fft;
  fft.init(1024);
  fft.fft(input.data(), re.data(), im.data());
  fft.ifft(output.data(), re.data(), im.data());
}

在这个示例中，我们首先创建了一个大小为 fftSize 的输入向量和一个输出向量。然后，我们初始化了一个 AudioFFT 对象，使用 fft 方法对输入进行快速傅里叶变换（FFT），然后使用 ifft 方法进行逆变换。

3. 项目 API 使用文档

以下是 AudioFFT 项目的主要 API：

• AudioFFT()：构造函数，用于创建一个 AudioFFT 对象。
• ~AudioFFT()：析构函数，用于销毁 AudioFFT 对象。
• void init(size_t size)：初始化 FFT，size 需要是一个 2 的幂。
• void fft(const float* input, float* re, float* im)：对实数输入进行 FFT，结果存储在 re 和 im 中。
• void ifft(float* output, const float* re, const float* im)：对复数输入进行逆 FFT，结果存储在 output 中。

4. 项目安装方式

如前所述，安装 AudioFFT 的方式是将 .h 和 .cpp 文件添加到你的项目中。根据你的平台和需求，你可能需要链接相应的库（FFTW3、Apple Accelerate 或 Intel IPP）并定义相应的宏。

确保你的项目符合所有使用的库的许可协议。AudioFFT 使用的是 MIT 许可，这是一种非常自由的许可，允许你在大多数情况下自由使用和修改代码。