Teoria.js 技术文档

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：表示音符偏差的数值。

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 集成到你的项目中，并利用其强大的音乐理论功能。