Explicitly include a boost "windows" folder even on linux
[supercollider.git] / HelpSource / Classes / Tuning.schelp
blob3e3715b9c16cb2c2505ca8a23bfe0d4e9eb72662
1 CLASS::Tuning
2 summary::represents a musical tuning
3 related::Classes/Scale
4 categories:: Tuning
6 DESCRIPTION::
7 Represents a musical tuning (e.g. equal temperament, just intonation, etc.). Used in conjunction with link::Classes/Scale:: to generate pitch information.
9 code::
10 t = Tuning.et12;
11 t.semitones;            // [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
12 t.ratios;               // [ 1, 1.0594630943591, 1.1224620483089, 1.1892071150019, etc. ]
14 Pbind(\scale, Scale.major(t), \degree, Pseq((0..7) ++ (6..0) ++ [\rest], 1), \dur, 0.25).play;
16 // use non-standard tuning
17 t = Tuning.just;
18 t.semitones;            // [ 0, 1.1173128526978, 2.0391000173077, 3.1564128700055, etc. ]
19 t.ratios.collect(_.round(0.001));       // [ 1, 1.067, 1.125, 1.2, 1.25, 1.333, 1.406, 1.5, etc. ]
21 Pbind(\scale, Scale.major(t), \degree, Pseq((0..7) ++ (6..0) ++ [\rest], 1), \dur, 0.25).play;
24 subsection::Creation
26 strong::just, pythagorean, werckmeister, johnston, partch, wcAlpha, bp, etc.::
28 Creates a tuning from the library stored in link::Classes/TuningInfo::. For a complete list of available tunings, execute
29 code::
30 Tuning.directory
33 CLASSMETHODS::
35 method::et
36 Creates an equal-tempered scale based on pitchesPerOctave.
38 method::choose
39 Creates a random tuning from the library, constrained by size (which defaults to 12).
40 code::
41 Scale.major(Tuning.choose).tuning.name;
44 method::new
45 Creates a Tuning using some or all of the parameters as follows: strong::tuning:: can be the name of a library tuning (in which case that tuning is returned); an array of floats representing the semitone values of the tuning (in which case pitchesPerOctave will be set to the size of the array regardless of the second parameter); or nil (in which case the default tuning for strong::pitchesPerOctave:: will be returned). strong::octaveRatio:: defaults to 2.0, but can be set differently for stretched or compressed tunings.
46 code::
47 Tuning.new(\et12);      // standard equal temperament
48 // custom tuning
49 Tuning.new(#[ 0, 0.795, 2.251, 3.251, 4.036, 4.680, 5.915, 7.221, 8.013, 9.29, 9.930, 11.032 ]);
50 Tuning.new((0..11).collect(_ * (2.08 ** (1/12))), 2.08, "Stretched ET12");
53 INSTANCEMETHODS::
55 private::storeOn, storedKey, storeArgs, printOn
57 method::semitones
58 Returns an array of semitone values for the pitch set. link::#-as::(Array) is equivalent; link::#-as::(List) returns it as a list, etc.
60 method::cents
61 Returns a array of cent values for the pitch set.
63 method::ratios
64 Returns a tuned array of ratios for the pitch set.
66 EXAMPLES::
68 For examples of use, see the link::Classes/Scale:: help file.