Add some documentation on used scale names

This commit is contained in:
2023-09-23 00:04:49 +03:00
parent 75be1d2519
commit 2843b65122

View File

@ -185,73 +185,18 @@ beat(1)::snd('sine').sustain(0.1).freq([100,100,100,100,200].unique().beat()).ou
true
)}
- <ic>scale(scale: string, mask: number)</ic>: extrapolate a custom-masked scale from each list elements. _[0].scale("major", 3)_ returns _[0,2,4]_
- <ic>scale(scale: string, mask: number)</ic>: extrapolate a custom-masked scale from each list elements. [0].scale("major", 3) returns [0,2,4]. You can use western scale names like (Major, Minor, Minor pentatonic ...) or [zeitler](https://ianring.com/musictheory/scales/traditions/zeitler) scale names. Alternatively you can also use the integers as used by Ian Ring in his [study of scales](https://ianring.com/musictheory/scales/).
${makeExample(
"Extrapolate a 3-elements Persian scale from 2 notes",
"Extrapolate a 3-elements Mixolydian scale from 2 notes",
`
beat(1) :: snd('gtr')
.note([0,5].scale("persian", 3).beat() + 50)
.note([0,5].scale("mixolydian", 3).beat() + 50)
.out()
`,
true
)}
- Currently supported scales :
| Scale name | Values |
|------------|------------------------|
| major | 0, 2, 4, 5, 7, 9, 11
| naturalMinor | 0, 2, 3, 5, 7, 8, 10
| harmonicMinor | 0, 2, 3, 5, 7, 8, 11
| melodicMinor | 0, 2, 3, 5, 7, 9, 11
| dorian | 0, 2, 3, 5, 7, 9, 10
| phrygian | 0, 1, 3, 5, 7, 8, 10
| lydian | 0, 2, 4, 6, 7, 9, 11
| mixolydian | 0, 2, 4, 5, 7, 9, 10
| aeolian | 0, 2, 3, 5, 7, 8, 10
| locrian | 0, 1, 3, 5, 6, 8, 10
| wholeTone | 0, 2, 4, 6, 8, 10
| majorPentatonic | 0, 2, 4, 7, 9
| minorPentatonic | 0, 3, 5, 7, 10
| chromatic | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
| blues | 0, 3, 5, 6, 7, 10
| diminished | 0, 2, 3, 5, 6, 8, 9, 11
| neapolitanMinor | 0, 1, 3, 5, 7, 8, 11
| neapolitanMajor | 0, 1, 3, 5, 7, 9, 11
| enigmatic | 0, 1, 4, 6, 8, 10, 11],
| doubleHarmonic | 0, 1, 4, 5, 7, 8, 11
| octatonic | 0, 2, 3, 5, 6, 8, 9, 11
| bebopDominant | 0, 2, 4, 5, 7, 9, 10, 11
| bebopMajor | 0, 2, 4, 5, 7, 8, 9, 11
| bebopMinor | 0, 2, 3, 5, 7, 8, 9, 11
| bebopDorian | 0, 2, 3, 4, 5, 7, 9, 10
| harmonicMajor | 0, 2, 4, 5, 7, 8, 11
| hungarianMinor | 0, 2, 3, 6, 7, 8, 11
| hungarianMajor | 0, 3, 4, 6, 7, 9, 10
| oriental | 0, 1, 4, 5, 6, 9, 10
| romanianMinor | 0, 2, 3, 6, 7, 9, 10
| spanishGypsy | 0, 1, 4, 5, 7, 8, 10
| jewish | 0, 1, 4, 5, 7, 8, 10
| hindi | 0, 2, 4, 5, 7, 8, 10
| japanese | 0, 1, 5, 7, 8
| hirajoshi | 0, 2, 3, 7, 8
| kumoi | 0, 2, 3, 7, 9
| inSen | 0, 1, 5, 7, 10
| iwato | 0, 1, 5, 6, 10
| yo | 0, 2, 5, 7, 9
| minorBlues | 0, 3, 5, 6, 7, 10
| algerian | 0, 2, 3, 5, 6, 7, 8, 11
| augmented | 0, 3, 4, 7, 8, 11
| balinese | 0, 1, 3, 7, 8
| byzantine | 0, 1, 4, 5, 7, 8, 11
| chinese | 0, 4, 6, 7, 11
| egyptian |0, 2, 5, 7, 10
| eightToneSpanish | 0, 1, 3, 4, 5, 6, 8, 10
| hawaiian | 0, 2, 3, 5, 7, 9, 10
| hindustan | 0, 2, 4, 5, 7, 8, 10
| persian | 0, 1, 4, 5, 6, 8, 11
| eastIndianPurvi | 0, 1, 4, 6, 7, 8, 11
| orientalA | 0, 1, 4, 5, 6, 9, 10
- <ic>add()</ic>: add a given amount to every list element.
- <ic>sub()</ic>: add a given amount to every list element.