The Wub Machine 技术文档

本文档将详细介绍如何安装、使用以及配置 The Wub Machine 项目，该项目是一款能够自动将音乐混音为Dubstep和Electro-House风格的应用程序。

1. 安装指南

系统要求

The Wub Machine已在OS X和Ubuntu系统上进行了测试，理论上在任何支持以下依赖项的环境中均可运行。

• 需要一个 Echo Nest API key，并将其设置为环境变量（$ECHO_NEST_API_KEY）。
• 安装脚本会尝试安装以下依赖项：
  • echonest-remix
  • ffmpeg
  • lame
  • soundstretch
  • shntool
  • tornado
  • tornadio
  • libyaml
  • pyyaml
  • numpy
  • mutagen
  • libjpeg
  • PIL
  • python-mysqldb
  • sqlalchemy

安装方式

运行以下命令安装依赖项：

sh install.sh

确保已经设置了Echo Nest API key。

2. 项目使用说明

命令行混音

在命令行中使用以下命令进行混音：

python -m remixers/dubstep <文件名.[mp3|m4a|mp4|wav]>

或者如果你想尝试Electro-House风格，可以使用：

python -m remixers/electrohouse <文件名.[mp3|m4a|mp4|wav]>

混音后的文件将保存在原文件相同的目录下。

集成到大型应用中

如果你的项目需要集成混音功能，可以按照以下方式使用：

from dubstep import Dubstep
class MyProject():
    def wubwub( self ):
        remixer = Dubstep( self, "song.mp3", "output.mp3", ".mp3", "some-kinda-uid", self.log )
        remixer.deleteOriginal = False
        remixer.start()

    def log( self, update ):
        print "混音进度更新："
        print update
m = MyProject()
m.wubwub()

混音器类使用单独的线程来监控进度，并在该线程中启动新的进程以进行大量工作。如果你想要创建新的混音器，可以修改Dubstep类以满足你的需求。

3. 项目API使用文档

项目API的具体使用方式未在文档中提供，但可以通过修改和调用项目中的相关类和方法来实现自定义的混音功能。

4. 项目配置

前端设置

项目的Web前端使用config.yml配置文件来设置运行时变量。以下是config.yml中可以设置的变量：

前端设置

• app_name: 应用程序的公开名称。

混音队列设置

• maximum_concurrent_remixes: 同时运行的最大混音数量。
• maximum_waiting_remixes: 允许在队列中等待的最大混音数量。
• hourly_remix_limit: 在给定小时内允许的最大混音数量。

超时设置

• cleanup_timeout: 定期清理混音、上传和艺术品的时间间隔。
• remix_timeout: 混音可以进行的最大时间，超过该时间将被停止/杀死并删除。
• wait_timeout: 一个人可以等待混音的最大时间，超过该时间将自动删除。
• watch_timeout: 浏览器打开进度Socket（通过Socket.io）的时间，否则将从队列中删除并删除。

监控设置

• monitor_limit: 监控页面上初始加载显示的项目数量。
• monitor_time_limit: 图表上显示的时间（以秒为单位）。

服务器设置

• nginx: 应用程序是否在Nginx代理后面运行。
• database_connect_string: 数据库连接字符串。

日志设置

• log_file: 用于记录所有请求/警告/错误/信息的文件名。
• log_name: 日志文件中服务器文件应被引用的名称。
• log_format: 用于日志记录的格式字符串。

文件扩展名

• allowed_file_extensions: 允许的文件扩展名列表。

Socket.IO设置

• socket_io_port: Socket.IO/Tornadio绑定的端口。
• socket_extra_sep: Socket.IO URL和资源ID之间的分隔符。
• monitor_resource: 监控资源的名称。
• progress_resource: 用户界面歌曲进度的资源名称。

SoundCloud设置

• soundcloud_consumer: SoundCloud消费者API密钥。
• soundcloud_secret: SoundCloud密钥API密钥。
• soundcloud_redirect: SoundCloud OAuth登录后重定向的URL。
• soundcloud_app_id: 注册的SoundCloud应用程序的数字ID。
• soundcloud_timeout: SoundCloud上传超时的时间。
• soundcloud_description: 自动附加到共享到SoundCloud的任何轨道的描述标签。
• soundcloud_tag_list: 要设置为共享轨道的标签列表。
• soundcloud_sharing_note: 通过SoundCloud共享轨道时使用的注释。

注意事项

HTML标记的编辑可以在/templates目录中找到。主页上的SoundCloud小部件大部分是硬编码的，页面JS也包含在其中，这不是很优雅但速度很快。这个项目有很多粗糙的边缘，欢迎贡献你的代码。许多文档内容尚未包含在内。