Gamma项目技术文档

1. 安装指南

Gamma 是一个跨平台的 C++ 库，用于进行通用信号合成和过滤。以下是 Gamma 库的安装步骤：

使用 Make（Linux、OS X、mingw）

在大多数情况下，只需要执行以下命令即可自动检测平台设置并构建库：

make

Makefile.config 文件中包含了其他构建选项。以下是 Makefile 中的一些规则：

• make：构建静态库
• make install：将库安装到 DESTDIR
• make clean：从构建文件夹中删除二进制文件
• make test：执行单元测试

可以使用 run.sh 脚本来编译和运行示例以及其他源文件。例如：

./run.sh examples/oscillator/sine.cpp

如果不运行文件，仅编译源文件，可以在源文件后添加 AUTORUN=0。二进制文件位于自动生成的 build/ 目录中。在 OS X 上，Gamma 库将链接到 external/lib_osx 中预编译的依赖库。在 Linux 上，使用 apt-get 来安装必要的依赖库。

使用 Xcode（OS X）

你也可以使用提供的 Xcode 项目来构建库：

1. 打开 project/xcode/gamma.xcodeproj
2. 构建目标 libgamma{.a, .dylib}。库将位于项目构建文件夹中。

直接从源代码编译

Gamma 可以轻松地直接从源代码编译到现有的项目中。

确保在编译器中传递以下标志：

-D__STDC_CONSTANT_MACROS
-finline-functions (或 -O3)
-fpeel-loops

依赖关系

只有在使用 Gamma 的 AudioIO 类（在 Gamma/AudioIO.h 中定义）时才需要 PortAudio。如果不希望使用音频输入/输出，可以将标志 NO_AUDIO_IO=1 传递给 make 或者在项目中排除 src/AudioIO.cpp。

如果希望使用 libsndfile 作为 SoundFile 类的后端，可以传递标志 USE_LIBSNDFILE=1 给 make。

2. 项目的使用说明

Gamma 库包含了有用的数学函数、类型（如向量和复数）、序列生成器以及其他用于信号处理任务的对象。它主要用于实时声音和图形合成，但同样适用于非实时任务。

编译和运行示例

可以使用 run.sh 脚本来编译和运行示例代码。例如，要运行 sine 示例：

./run.sh examples/oscillator/sine.cpp

3. 项目API使用文档

Gamma 库的 API 包括数学函数、类型定义、序列生成器等。以下是简要的 API 使用说明：

• 数学函数：提供常用的数学运算和功能。
• 类型定义：如 Vector 和 Complex 类型，用于信号处理。
• 序列生成器：生成各种信号序列，用于合成和过滤。

具体 API 文档请参考项目中的头文件和源文件。

4. 项目安装方式

安装 Gamma 库的方式已在“安装指南”部分详细说明。以下是简要总结：

• 使用 Make 或 Xcode 构建库。
• 确保安装所有依赖库。
• 根据需要编译示例或直接集成到现有项目中。

确保遵循安装指南，以便正确安装和使用 Gamma 库。