Dynamic Universal Music Bibliotheque (libdumb) 使用教程

1. 项目目录结构及介绍

libdumb 项目目录结构如下：

dumb/
├── cmake-scripts/          # CMake 脚本和相关文件
├── examples/               # 示例程序
├── include/                # 包含的头文件
├── src/                    # 源代码文件
├── vc6/                    # Visual C++ 6 项目文件（旧版本）
├── .clang-format            # LLVM clang-format 配置文件
├── .gitattributes           # Git 属性文件
├── .gitignore              # Git 忽略文件
├── CHANGELOG.md            # 更新日志
├── CMakeLists.txt          # CMake 主配置文件
├── COMPILING.md            # 编译指南
├── DUMBFILE_SYSTEM.md      # 文件系统相关文档
├── LICENSE                 # 许可证文件
├── README.md               # 项目说明文件
├── UPDATING_YOUR_PROJECTS.md # 更新项目指南
└── pkg-config.pc.in        # pkg-config 配置文件模板

• cmake-scripts/: 包含了用于构建项目的 CMake 脚本。
• examples/: 包含了使用 libdumb 的示例代码。
• include/: 包含了 libdumb 的公共头文件。
• src/: 包含了 libdumb 的源代码文件。
• vc6/: 包含了适用于 Visual C++ 6 的项目文件，用于旧版本 Visual Studio。
• .clang-format: 定义了代码格式化的规则。
• .gitattributes: 定义了 Git 的文件属性，如忽略行尾差异等。
• .gitignore: 定义了 Git 应该忽略的文件和目录。
• CHANGELOG.md: 记录了 libdumb 的历史版本和更新内容。
• CMakeLists.txt: 是项目的主 CMake 配置文件，用于构建项目。
• COMPILING.md: 提供了编译 libdumb 的详细指导。
• DUMBFILE_SYSTEM.md: 描述了 libdumb 的文件系统相关操作。
• LICENSE: 包含了 libdumb 使用的许可证信息。
• README.md: 提供了关于 libdumb 的概述和基本使用说明。
• UPDATING_YOUR_PROJECTS.md: 提供了如何更新现有项目以使用 libdumb 的指南。
• pkg-config.pc.in: 包含了 pkg-config 的配置文件模板。

2. 项目的启动文件介绍

libdumb 的启动通常是通过编译示例程序或集成到其他项目中使用。以下是一个简单的示例程序，展示了如何初始化和使用 libdumb：

#include "dumb.h"

int main(int argc, char **argv) {
    dumb_file_t *file = dumb_load_midi("example.mid");
    if (!file) {
        printf("Error loading MIDI file.\n");
        return 1;
    }

    dumbPlayer_t *player = dumb_player_create(file);
    if (!player) {
        printf("Error creating player.\n");
        dumb_file_close(file);
        return 1;
    }

    // 播放音乐
    while (dumb_player_get_state(player) == DUMB_PLAYER_PLAYING) {
        dumb_player_play(player);
    }

    // 清理资源
    dumb_player_delete(player);
    dumb_file_close(file);

    return 0;
}

在这个例子中，程序加载了一个 MIDI 文件，创建了一个播放器，然后进入了一个循环，直到音乐播放完毕。在循环中，dumb_player_play() 函数被调用来更新播放状态。

3. 项目的配置文件介绍

libdumb 的配置主要通过 CMakeLists.txt 文件进行。以下是 CMakeLists.txt 文件的部分内容，展示了如何配置项目：

cmake_minimum_required(VERSION 3.0)
project(dumb)

# 设置编译选项
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O2 -Wall")

# 查找库文件
find_library(ALLEGRO allegro)

# 定义库源文件
set(LIBDUMB_SRC
    src/dumb.c
    src/it.c
    # ... 更多源文件
)

# 创建库目标
add_library(dumb STATIC ${LIBDUMB_SRC})

# 链接库
target_link_libraries(dumb ${ALLEGRO})

在这个配置文件中，首先设置了项目的最小 CMake 版本要求，并定义了项目名称。接着，设置了编译器的警告选项和优化级别。通过 find_library 查找 Allegro 库（如果需要），然后定义了 libdumb 的源文件列表，创建了一个静态库目标，并链接了必要的库。

开发者可以根据自己的需求修改 CMakeLists.txt 文件中的编译选项和链接库。