Safe Haskell	Safe-Inferred

Derive.Scale.JustScales

Contents

input_to_note
transpose
note_to_call
key
format
named intervals

Synopsis

type Ratios = Vector.Vector (Ratio.Ratio Int)
just_base_control :: ScoreT.Control
data ScaleMap = ScaleMap {
- smap_fmt :: TheoryFormat.Format
- smap_keys :: Keys
- smap_default_key :: Key
- smap_default_tuning :: Maybe Tuning
- smap_default_base_hz :: Pitch.Hz
- smap_named_intervals :: ScaleDegree.NamedIntervals
- smap_accidental_interval :: Double
}
type Tuning = Text
type Keys = Map Pitch.Key Key
scale_map :: Keys -> Key -> Maybe Tuning -> TheoryFormat.Format -> ScaleMap
layout :: Theory.Layout
make_scale :: Pitch.ScaleId -> ScaleMap -> Doc.Doc -> [(Doc.Doc, Doc.Doc)] -> Scale
default_call_doc :: DocumentedCall
group_relative_keys :: [(Pitch.Key, Key)] -> [(Doc.Doc, Doc.Doc)]
show_ratios :: Map Tuning Ratios -> Text
just_doc :: Doc.Doc
enharmonics :: Theory.Layout -> TheoryFormat.Format -> Enharmonics
input_to_note :: ScaleMap -> Scales.InputToNote
transpose :: TheoryFormat.Format -> Transpose
note_to_call :: DeriveT.Scale -> ScaleMap -> Pitch.Note -> Maybe ValCall
pitch_nn :: ScaleMap -> TheoryFormat.RelativePitch -> Scale.PitchNn
pitch_note :: TheoryFormat.Format -> TheoryFormat.RelativePitch -> Scale.PitchNote
transpose_to_hz :: Pitch.PitchClass -> Pitch.Hz -> TheoryFormat.Tonic -> Ratios -> Double -> Pitch.Pitch -> Pitch.Hz
split_fraction :: (RealFrac a, Integral b) => a -> (b, a)
degree_to_hz :: Ratios -> Pitch.Hz -> Pitch.Pitch -> Pitch.Hz
index_mod :: Vector.Vector a -> Int -> a
data Key = Key {
- key_tonic :: TheoryFormat.Tonic
- key_ratios :: Map Tuning Ratios
}
read_key :: ScaleMap -> Maybe Pitch.Key -> Either DeriveT.PitchError Key
make_keys :: [Text] -> [(Text, [(Tuning, Ratios)])] -> Keys
make_relative_fmt :: Keys -> Key -> TheoryFormat.RelativeFormat TheoryFormat.Tonic
default_named_intervals :: ScaleDegree.NamedIntervals

Documentation

type Ratios = Vector.Vector (Ratio.Ratio Int) Source #

just_base_control :: ScoreT.Control Source #

Hz frequency of 1/1.

data ScaleMap Source #

Bundle up data needed to construct a just scale.

Constructors

ScaleMap

Fields

smap_fmt :: TheoryFormat.Format
smap_keys :: Keys
smap_default_key :: Key
smap_default_tuning :: Maybe Tuning
Use this Tuning if there is no EnvKey.tuning. If Nothing, don't even look for EnvKey.tuning, and use "" for key_ratios.
smap_default_base_hz :: Pitch.Hz
Previously I would default to the 12TET of the tonic when just-base isn't set, but that doesn't work when the scale doesn't use 12TET names.
smap_named_intervals :: ScaleDegree.NamedIntervals
smap_accidental_interval :: Double
Sharps multiply by this, flats divide by this.
While these scales recognize sharps and flats, and input_to_note will create them, they are still considered diatonic scales, and the accidentals are not considered part of the scale. So chromatic transposition is treated the same as diatonic transposition, and you can't root a key on a note with an accidental.

type Tuning = Text Source #

type Keys = Map Pitch.Key Key Source #

scale_map :: Keys -> Key -> Maybe Tuning -> TheoryFormat.Format -> ScaleMap Source #

Make a just scale with the given set of keys. A "key" in a just scale is the set of ratios and the tonic. The number of ratios should be the same as the number of scale degrees as defined by the TheoryFormat.Format. If there are too many, the extras will never be reached, if too few, they'll wrap around.

layout :: Theory.Layout Source #

TODO this should be 'repeat 2', but as long as this is also controlling the input layout, it has to be piano layout, or it won't work properly with kbd and midi entry.

make_scale :: Pitch.ScaleId -> ScaleMap -> Doc.Doc -> [(Doc.Doc, Doc.Doc)] -> Scale Source #

default_call_doc :: DocumentedCall Source #

Call doc that assumes I'm using default_named_intervals.

group_relative_keys :: [(Pitch.Key, Key)] -> [(Doc.Doc, Doc.Doc)] Source #

Group keys and format them into fields suitable to pass to make_scale. The Keys are expected to be relative, so their key_tonics are ignored.

show_ratios :: Map Tuning Ratios -> Text Source #

just_doc :: Doc.Doc Source #

input_to_note

enharmonics :: Theory.Layout -> TheoryFormat.Format -> Enharmonics Source #

input_to_note :: ScaleMap -> Scales.InputToNote Source #

transpose

transpose :: TheoryFormat.Format -> Transpose Source #

note_to_call

note_to_call :: DeriveT.Scale -> ScaleMap -> Pitch.Note -> Maybe ValCall Source #

To modulate to another scale: just-base = (hz (4g)) | key = g-maj The order is important, so the (hz (4g)) happens in the context of the old key.

pitch_nn :: ScaleMap -> TheoryFormat.RelativePitch -> Scale.PitchNn Source #

pitch_note :: TheoryFormat.Format -> TheoryFormat.RelativePitch -> Scale.PitchNote Source #

transpose_to_hz :: Pitch.PitchClass -> Pitch.Hz -> TheoryFormat.Tonic -> Ratios -> Double -> Pitch.Pitch -> Pitch.Hz Source #

split_fraction :: (RealFrac a, Integral b) => a -> (b, a) Source #

Like properFraction, but the fraction is always positive.

degree_to_hz Source #

Arguments

:: Ratios
-> Pitch.Hz
-> Pitch.Pitch	should be relative to scale's tonic
-> Pitch.Hz

Given a Key, convert a pitch in that key to its hz value, calculated as a ratio from the given base hz.

index_mod :: Vector.Vector a -> Int -> a Source #

key

data Key Source #

Constructors

Key
Fields key_tonic :: TheoryFormat.Tonic key_ratios :: Map Tuning Ratios

Instances

Instances details

Show Key Source #
Instance details Defined in Derive.Scale.JustScales Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
Eq Key Source #
Instance details Defined in Derive.Scale.JustScales Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Pretty.Pretty Key Source #
Instance details Defined in Derive.Scale.JustScales Methods pretty :: Key -> Text Source # format :: Key -> Doc Source # formatList :: [Key] -> Doc Source #

read_key :: ScaleMap -> Maybe Pitch.Key -> Either DeriveT.PitchError Key Source #

make_keys :: [Text] -> [(Text, [(Tuning, Ratios)])] -> Keys Source #

format

make_relative_fmt Source #

Arguments

:: Keys
-> Key	only `key_tonic` is used
-> TheoryFormat.RelativeFormat TheoryFormat.Tonic

named intervals

default_named_intervals :: ScaleDegree.NamedIntervals Source #