SuperCollider-Android 项目技术文档

1. 安装指南

1.1 环境准备

• 操作系统: 该项目在 OS X 上进行了测试，但在 Linux 上也可以运行，只需进行一些小的调整（如安装 ant 等）。
• Android SDK: 需要安装 Android SDK。
• Eclipse（可选）: 可以选择安装 Eclipse，但本文档将主要介绍从命令行进行构建的方法。
• Apache Ant: 如果使用命令行构建，需要安装 Apache Ant。如果已安装 Homebrew，可以通过以下命令安装：

  brew install ant
  

• Crystax NDK: 该项目使用 Crystax NDK，而不是标准的 Android NDK。需要从 Crystax 官网下载并解压，然后按照 docs/INSTALL.html 中的说明进行安装。

1.2 设置环境变量（可选）

为了方便，可以将 NDK 的路径添加到系统的 PATH 环境变量中。

2. 项目安装方式

2.1 构建原生模块

在项目根目录下执行以下命令来构建原生模块：

ndk-build
# 如果 NDK 不在 PATH 中，可以使用完整路径：/path/to/ndk-build

2.2 生成 ant 构建文件

在项目根目录下执行以下命令生成 ant 构建文件：

android update project -p . --target [target_number]
# target_number 是已安装的 Android 目标之一，可以通过以下命令查看：
android list

2.3 构建项目

在项目根目录下执行以下命令来构建项目：

ant debug

2.4 安装到设备或模拟器

将构建好的 APK 安装到连接的设备或模拟器上：

adb install -r bin/SuperColliderActivity-debug.apk
# -r 参数表示如果 APK 已存在，则强制重新安装

3. 项目的使用说明

3.1 项目概述

SuperCollider-Android 是 SuperCollider 的 Android 移植版本，基于 SuperCollider 3.5。需要注意的是，使用 SuperCollider 3.6 创建的 SynthDefs 通常无法加载。

3.2 项目结构

• native modules: 通过 ndk-build 构建的原生模块。
• ant build.xml: 通过 android update project 生成的构建文件。
• SuperColliderActivity-debug.apk: 构建生成的 APK 文件，可以通过 adb install 安装到设备上。

3.3 使用步骤

1. 按照上述步骤完成项目的构建和安装。
2. 在 Android 设备或模拟器上运行 SuperColliderActivity。
3. 使用 SuperCollider 进行音频合成和处理。

4. 项目API使用文档

4.1 基本API

• SynthDef: 用于定义音频合成器。需要注意的是，SuperCollider 3.6 创建的 SynthDefs 可能无法加载。
• Server: 用于管理音频服务器，控制音频合成器的启动、停止等操作。

4.2 示例代码

以下是一个简单的 SynthDef 示例：

SynthDef("simpleSine", {
    Out.ar(0, SinOsc.ar(440, 0, 0.2))
}).play;

4.3 注意事项

• 由于该项目基于 SuperCollider 3.5，因此在使用时需要注意与 SuperCollider 3.6 的兼容性问题。
• 在 Android 设备上运行时，可能需要根据设备的性能调整音频合成的复杂度。

5. 总结

SuperCollider-Android 是一个功能强大的音频合成工具，适用于 Android 平台。通过本文档的指导，用户可以顺利完成项目的安装和使用，并了解如何通过 API 进行音频合成。