JC303 开源项目使用教程

JC303 开源项目使用教程

jc303 A Free Roland TB-303 Plugin for Windows, MacOS and Linux: VST2, VST3, LV2, CLAP and AU. A Juce port of Open303 engine. 项目地址: https://gitcode.com/gh_mirrors/jc/jc303

1. 项目的目录结构及介绍

JC303 项目的目录结构如下：

jc303/
├── README.md
├── src/
│   ├── main.cpp
│   ├── config.h
│   ├── utils/
│   │   ├── helper.cpp
│   │   └── helper.h
│   └── modules/
│       ├── module1.cpp
│       └── module1.h
├── include/
│   └── jc303.h
├── tests/
│   └── test_main.cpp
└── docs/
    └── tutorial.md

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• src/: 项目的源代码目录，包含主要的源文件和模块。
  • main.cpp: 项目的启动文件。
  • config.h: 项目的配置文件。
  • utils/: 包含项目中使用的工具函数和类。
  • modules/: 包含项目的各个模块，每个模块包含源文件和头文件。
• include/: 包含项目的公共头文件。
• tests/: 包含项目的测试代码。
• docs/: 包含项目的文档，如本教程。

2. 项目的启动文件介绍

项目的启动文件是 src/main.cpp。该文件负责初始化项目并启动主程序。以下是 main.cpp 的基本结构：

#include "config.h"
#include "modules/module1.h"

int main() {
    // 初始化配置
    Config config;
    config.load("config.json");

    // 初始化模块
    Module1 module1(config);

    // 启动主程序
    module1.run();

    return 0;
}

启动文件介绍

• 包含头文件: main.cpp 包含了项目的配置文件 config.h 和模块 module1.h。
• 初始化配置: 在 main 函数中，首先初始化配置对象 Config，并从 config.json 文件中加载配置。
• 初始化模块: 接着，初始化模块 Module1，并将配置对象传递给模块。
• 启动主程序: 最后，调用模块的 run 方法启动主程序。

3. 项目的配置文件介绍

项目的配置文件是 src/config.h。该文件定义了项目的配置结构和加载配置的方法。以下是 config.h 的基本结构：

#ifndef CONFIG_H
#define CONFIG_H

#include <string>
#include <json/json.h>

class Config {
public:
    Config();
    ~Config();

    void load(const std::string& filename);

    std::string getParam(const std::string& key) const;

private:
    Json::Value root;
};

#endif // CONFIG_H

配置文件介绍

• 配置类定义: Config 类定义了配置的结构和方法。
• 加载配置: load 方法从指定的 JSON 文件中加载配置。
• 获取参数: getParam 方法用于根据键名获取配置参数。
• 私有成员: root 是一个 Json::Value 对象，用于存储加载的配置数据。

通过以上介绍，您可以更好地理解和使用 JC303 开源项目。

jc303 A Free Roland TB-303 Plugin for Windows, MacOS and Linux: VST2, VST3, LV2, CLAP and AU. A Juce port of Open303 engine. 项目地址: https://gitcode.com/gh_mirrors/jc/jc303