refactor(frequency): ♻️ extract reference as 440 Hz

albertms10 · Mar 27, 2024 · 40b347d · 40b347d
1 parent 34eda40
commit 40b347d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/lib/src/note/closest_pitch.dart b/lib/src/note/closest_pitch.dart
@@ -66,7 +66,7 @@ class ClosestPitch {
   /// (Note.a.inOctave(4) + const Cent(12)).frequency() == const Frequency(443)
   /// ```
   Frequency frequency({
-    Frequency referenceFrequency = const Frequency(440),
+    Frequency referenceFrequency = Frequency.reference,
     TuningSystem tuningSystem = const EqualTemperament.edo12(),
   }) =>
       Frequency(

diff --git a/lib/src/note/frequency.dart b/lib/src/note/frequency.dart
@@ -22,6 +22,9 @@ extension type const Frequency._(num hertz) implements num {
   /// The symbol for the Hertz unit.
   static const hertzUnitSymbol = 'Hz';
 
+  /// The standard reference [Frequency].
+  static const reference = Frequency(440);
+
   /// Whether this [Frequency] is inside the [HearingRange.human].
   ///
   /// Example:
@@ -52,7 +55,7 @@ extension type const Frequency._(num hertz) implements num {
   /// frequency.closestPitch().frequency() == frequency;
   /// ```
   ClosestPitch closestPitch({
-    Frequency referenceFrequency = const Frequency(440),
+    Frequency referenceFrequency = Frequency.reference,
     TuningSystem tuningSystem = const EqualTemperament.edo12(),
   }) {
     final cents = Ratio(hertz / referenceFrequency).cents;

diff --git a/lib/src/note/pitch.dart b/lib/src/note/pitch.dart
@@ -404,7 +404,7 @@ final class Pitch extends Scalable<Pitch> implements Comparable<Pitch> {
   /// pitch.frequency().closestPitch().pitch == pitch;
   /// ```
   Frequency frequency({
-    Frequency referenceFrequency = const Frequency(440),
+    Frequency referenceFrequency = Frequency.reference,
     TuningSystem tuningSystem = const EqualTemperament.edo12(),
   }) =>
       Frequency(referenceFrequency * tuningSystem.ratio(this));
@@ -419,7 +419,7 @@ final class Pitch extends Scalable<Pitch> implements Comparable<Pitch> {
   /// ```
   Set<ClosestPitch> harmonics({
     required int upToIndex,
-    Frequency referenceFrequency = const Frequency(440),
+    Frequency referenceFrequency = Frequency.reference,
     TuningSystem tuningSystem = const EqualTemperament.edo12(),
   }) =>
       frequency(