Teoria.js 技术文档
2024-12-24 17:49:19作者:冯爽妲Honey
1. 安装指南
使用 npm 安装
Teoria.js 可以通过 npm 进行安装,适用于 Node.js 和 Browserify/webpack 等环境。
$ npm install teoria
直接引入文件
如果你不想使用 npm 安装,也可以直接引入打包好的 teoria.js 文件。
<script src="path/to/teoria.js"></script>
2. 项目使用说明
Teoria.js 是一个轻量级且快速的 JavaScript 音乐理论库,支持爵士乐和古典音乐。它提供了直观的编程接口,适用于音乐软件(如乐谱阅读器、乐谱编写器、MIDI 播放器等)。
主要功能
- Note 对象 (
teoria.Note):支持音符的变音记号、八度、键号、频率等,并支持 Helmholtz 记谱法。 - Chord 对象 (
teoria.Chord):支持从简单的三和弦到复杂的爵士和弦(如 Ab#5b9, F(#11) 等)。 - Scale 对象 (
teoria.Scale):支持多种音阶,包括预定义的音阶(如伊奥尼亚、多里安、弗里吉亚等)和自定义音阶。 - Interval 对象 (
teoria.Interval):方便地计算两个音符之间的音程,或根据给定的音程找到音符。
示例代码
// 创建音符
var a4 = teoria.note('a4'); // 科学记谱法
var g5 = teoria.note("g''"); // Helmholtz 记谱法
var c3 = teoria.note.fromKey(28); // 从钢琴键号创建
// 计算音程
teoria.interval(a4, g5); // 返回一个表示小七度的 Interval 对象
teoria.interval(a4, 'M6'); // 返回一个表示 F#5 的 Note 对象
a4.interval('m3'); // 返回一个表示 C#4 的 Note 对象
// 创建音阶
a4.scale('mixolydian').simple(); // 返回: ["a", "b", "c#", "d", "e", "f#", "g"]
a4.scale('aeolian').simple(); // 返回: ["a", "b", "c", "d", "e", "f", "g"]
// 创建和弦
a4.chord('sus2').name; // 返回和弦名称: 'Asus2'
c3.chord('m').name; // 返回 'Cm'
3. 项目 API 使用文档
teoria.note (name | coord[, duration])
- name:音符名称,可以是科学记谱法或 Helmholtz 记谱法。
- coord:如果第一个参数不是字符串,而是一个数组,则实例化一个
Note对象。 - duration:可选参数,表示音符的时值。
teoria.note.fromKey(key)
- 静态方法,返回一个设置为给定钢琴键号的
Note实例。
teoria.note.fromFrequency(fq)
- 静态方法,返回一个包含两个元素的对象:
- note:与给定频率最接近的
Note对象。 - cents:表示音符偏差的数值。
- note:与给定频率最接近的
teoria.note.fromMIDI(note)
- 返回一个设置为对应 MIDI 音符值的
Note实例。
teoria.note.fromString(note)
- 返回一个表示音符名称的
Note实例。
Note 对象方法
- name():返回音符名称(小写字母)。
- octave():返回音符的八度数值。
- duration:返回音符的时值对象。
- accidental():返回音符的变音记号(如
#,b等)。 - accidentalValue():返回变音记号的数值。
- key([whitenotes]):返回钢琴键号。
- midi():返回 MIDI 音符值。
- fq([concertPitch]):计算并返回音符的频率。
- chroma():返回音符的音级(pitch class)。
- scale(scaleName):返回以该音符为根音的音阶实例。
- interval(interval):计算音程。
- transpose(interval):转调。
- chord([name]):返回以该音符为根音的和弦实例。
- helmholtz():返回 Helmholtz 记谱法的音符名称。
- scientific():返回科学记谱法的音符名称。
- enharmonics(oneAccidental):返回所有等音音符。
- durationInSeconds(bpm, beatUnit):返回音符的持续时间。
- solfege(scale, showOctaves):返回给定音阶上下文中的唱名。
- durationName():返回音符的时值名称。
- scaleDegree(scale):返回该音符在给定音阶中的度数。
- toString([dontShow]):返回音符的字符串表示。
Chord 对象
- Chord(root, chord):创建一个和弦对象。
- teoria.chord(name || note[, octave || symbol]):返回和弦的音符。
4. 项目安装方式
通过 npm 安装
$ npm install teoria
直接引入文件
<script src="path/to/teoria.js"></script>
通过以上方式,你可以轻松地将 Teoria.js 集成到你的项目中,并利用其强大的音乐理论功能。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp Cafe Menu项目中link元素的void特性解析2 freeCodeCamp课程中屏幕放大器知识点优化分析3 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析4 freeCodeCamp课程视频测验中的Tab键导航问题解析5 freeCodeCamp论坛排行榜项目中的错误日志规范要求6 freeCodeCamp博客页面工作坊中的断言方法优化建议7 freeCodeCamp英语课程填空题提示缺失问题分析8 freeCodeCamp全栈开发课程中React实验项目的分类修正9 freeCodeCamp音乐播放器项目中的函数调用问题解析10 freeCodeCamp课程页面空白问题的技术分析与解决方案
最新内容推荐
TJSONObject完整解析教程:Delphi开发者必备的JSON处理指南 TextAnimator for Unity:打造专业级文字动画效果的终极解决方案 开源电子设计自动化利器:KiCad EDA全方位使用指南 Photoshop作业资源文件下载指南:全面提升设计学习效率的必备素材库 RadiAnt DICOM Viewer 2021.2:专业医学影像阅片软件的全面指南 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 STDF-View解析查看软件:半导体测试数据分析的终极工具指南 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案 WebVideoDownloader:高效网页视频抓取工具全面使用指南 移动端HTML医疗影像DICOM在线浏览解决方案:零足迹医疗图像查看器
项目优选
收起
deepin linux kernel
C
24
6
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
243
2.4 K
React Native鸿蒙化仓库
JavaScript
216
291
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
353
1.61 K
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
405
暂无简介
Dart
540
118
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.01 K
591
仓颉编程语言运行时与标准库。
Cangjie
123
99
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
117