Buzztrax 技术文档

本文档将为您详细介绍如何安装、使用以及API调用的方法。

1. 安装指南

环境要求

Buzztrax 项目需要以下依赖：

• gstreamer >= 1.2 及其插件（gstreamer, gst-plugins-base 和 gst-plugins-good）。
• glib, gsf 和 libxml2 作为核心库。
• clutter-gtk 和 gtk+ 用于用户界面。

可选的依赖包包括：

• gst-plugins-ugly：用于 mp3 录音。
• gst-plugins-bad：额外的音频效果。
• gudev 和 libasound：用于交互控制器支持。
• orc：用于插件加速。
• fluidsynth：构建相关的 gstreamer 包装器。
• check：用于单元测试。

从 Git 仓库构建

使用 autogen.sh 脚本代替 configure。这个脚本接受与 configure 相同的选项。之后可以使用 autoregen.sh 来重新运行引导程序。

从 Git 仓库构建需要安装以下软件：

• gtk-doc
• yelp-tools
• cvs（用于 gettext 的 autopoint）

2. 项目使用说明

安装本地

使用以下选项运行 ./autogen.sh 或 ./configure：

--prefix=$HOME/buzztrax
--with-gconf-source=xml::/home/ensonic/.gconf/
--with-desktop-dir=/home/ensonic/.gnome2/vfolders/

将软件包安装到例如 $HOME/buzztrax 后，需要设置以下环境变量：

# 库：
export LD_LIBRARY_PATH=$HOME/buzztrax/lib:$LD_LIBRARY_PATH
# gstreamer
export GST_PLUGIN_PATH="$HOME/buzztrax/lib/gstreamer-1.0"
# MIME 数据库和图标主题：
export XDG_DATA_DIRS="$XDG_DATA_DIRS:$HOME/buzztrax/share"
update-mime-database $HOME/buzztrax/share/mime/

对于开发者：

# 在 devhelp 中查看 buzztrax 帮助文件：
export DEVHELP_SEARCH_PATH="$DEVHELP_SEARCH_PATH:$HOME/buzztrax/share/gtk-doc/html"
# 使用 pkg-config 编译 buzztrax 库：
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$HOME/buzztrax/lib/pkgconfig"
# ...
export GI_TYPELIB_PATH="\$GI_TYPELIB_PATH:$prefix/lib/girepository"

安装到 /usr/local

--prefix 配置选项的默认值是 /usr/local。在这种情况下，也需要导出上文提到的环境变量。

运行应用程序

cd $HOME/buzztrax/bin
./buzztrax-cmd --command=info --input-file=../share/buzztrax/songs/melo1.xml
./buzztrax-cmd --command=play --input-file=../share/buzztrax/songs/melo1.xml
./buzztrax-cmd --command=encode --input-file=../share/buzztrax/songs/melo1.xml --output-file=./melo1.ogg
./buzztrax-edit --command=load --input-file=../share/buzztrax/songs/melo1.xml

3. 项目 API 使用文档

项目的 API 文档位于 docs 目录中，包含了设计思路和 API 参考信息。开发者可以参考此目录中的内容来了解和使用 Buzztrax 的 API。

4. 项目安装方式

项目的安装方式已在上述“安装指南”中详细说明，主要包括从 Git 仓库构建、安装到本地和安装到 /usr/local 等步骤。请按照相应步骤进行安装。

---

以上就是 Buzztrax 项目的技术文档，希望对您的使用有所帮助。