跳转到内容

开发者文档

jpFun 是将简谱 DSL 编译为谱面布局与播放计划的 JavaScript 库。核心库负责语法、音乐时间和几何计算;宿主应用负责界面、文件访问、音频设备和实时调度。

开发者文档先介绍公共 API 的使用,再说明支撑这些 API 的概念模型、阶段边界和扩展契约。它面向应用集成者与核心库贡献者,不重复教程中的记谱语法。

  1. 在项目中使用:安装、编译、诊断、渲染、播放计划与外部格式导入。
  2. 架构总览:源码、音乐时间与几何三种表示,以及函数和引擎的分工。
  3. 阶段专题:先建立各阶段的数据模型,再查阅处理流程与扩展接口。
关注的问题对应文档
语法结构、参数作用域与源码位置源码解析
音乐时间、并行声部与轨道Lowering
尺寸、对齐、间距约束与分页简谱布局
最终几何、绘制协议与后端渲染后端
演奏顺序、状态与时间映射播放
将核心能力组合成完整应用编辑器集成

架构文档解释数据的含义、所有权和处理顺序;具体类型与方法签名以链接的源码定义为准。应用集成从公共 API 入手,扩展或修改实现时再阅读相关专题。

修改实现时,先区分符号规则与共享机制:前者通常归属对应函数,后者归属编译阶段。再根据该阶段的契约,用相邻测试验证行为。