From 5df396db1bf4c6968069597ad0f94081bbfea969 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 19 Jun 2025 03:24:02 +0000 Subject: [PATCH] Update README.md --- README.md | 84 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 55 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index bcb227f..edb7c7c 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,65 @@ # shelieyinshi -#### 介绍 -{**以下是 Gitee 平台说明,您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +## 介绍 +这是一个开源音频处理工具集,专注于音频信号分析与可视化展示。项目名称"蛇列音诗"寓意通过算法将音频数据转化为可视化的艺术表达,主要面向音乐制作人、声音工程师及数据可视化爱好者。 -#### 软件架构 -软件架构说明 +## 软件架构 +采用模块化设计,包含三大核心组件: +1. **音频解析引擎**:基于FFmpeg实现多格式音频解码 +2. **频谱分析模块**:使用FFT算法进行实时频谱分析 +3. **可视化渲染层**:基于OpenGL ES 3.0实现动态波形渲染 +系统架构支持跨平台运行(Windows/macOS/Linux),提供CLI和GUI两种交互模式。 +## 安装教程 +### Windows +```bash +# 安装依赖 +choco install ffmpeg opengl +# 构建项目 +mkdir build && cd build +cmake .. +make +``` -#### 安装教程 +### macOS/Linux +```bash +# 安装依赖 +brew install ffmpeg glfw (macOS) +sudo apt install libgl1 (Linux) +# 构建项目 +mkdir build && cd build +cmake .. +make +``` -1. xxxx -2. xxxx -3. xxxx +## 使用说明 +### 基础功能 +```bash +# 音频分析模式 +./shelieyinshi -a input.mp3 --spectrogram +# 实时可视化模式 +./shelieyinshi -d --live-input +``` -#### 使用说明 +### 可视化参数 +- `--waveform`:显示波形图 +- `--spectrogram`:显示频谱图 +- `--3d-mode`:启用三维渲染 +- `--color-scheme <主题>`:选择配色方案(支持 dark/classic/neon) -1. xxxx -2. xxxx -3. xxxx +## 参与贡献 +1. 提交Issue请遵循[模板](.gitee/ISSUE_TEMPLATE.zh-CN.md)要求,提供完整复现步骤 +2. Pull Request需关联对应Issue,描述变更内容时请注明: + - 新增功能说明 + - 修改的配置项 + - 影响的模块范围 +3. 代码提交需通过CI检查(clang-format格式化验证) -#### 参与贡献 +## 特技 +- ✨ 实时音频流处理延迟<50ms +- 📊 支持多通道音频独立分析 +- 🎨 内置8种专业级可视化着色器 +- 📦 支持导出分析结果为CSV/JSON格式 +- 🌐 提供REST API接口供第三方调用 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +> 本项目采用MIT开源协议,欢迎社区贡献! \ No newline at end of file -- Gitee