tonic 0.2.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 69

Dart #

Build Status

Tonic is a Dart package that models components of music theory.

It also computes chord diagrams; this functionality is in progress. (I'm porting it from schoen.)

Installing via Pub #

The current version of this package requires Dart 2.0. Use version 0.1.1 with Dart 1.x.

Add the following to your pubspec.yaml, and run pub get.

dependencies:
  tonic: any

Example Usage #

  import 'package:tonic/tonic.dart';

  main() {
    // Hemholtz and Scientific pitch notation
    print(Pitch.parse('C4'));
    print(Pitch.parse('C♯4'));
    print(Pitch.parse('C♭4'));

    // Unicode and ASCII sharps and flats
    print(Pitch.parse('C#4') == Pitch.parse('C#4')); // => true
    print(Pitch.parse('Cb4') == Pitch.parse('Cb4')); // => true

    // Enharmonic equivalents
    print(Pitch.parse('E♯4').midiNumber == Pitch.parse('F4').midiNumber); // => true
    print(Pitch.parse('E4').midiNumber == Pitch.parse('F♭4').midiNumber); // => true
    print(Pitch.parse('E♯4') == Pitch.parse('F4')); // => false
    print(Pitch.parse('E4') == Pitch.parse('F♭4')); // => false

    print(Pitch.parse('C4').octave); // => 5
    print(Pitch.parse('C4').midiNumber); // => 60
    print(new Pitch.fromMidiNumber(60)); // => C4

    // Intervals
    print(Interval.M3);
    print(Interval.parse('M3'));
    print(Interval.m3.semitones); // => 3
    print(Interval.M3.semitones); // => 4
    print(Interval.A3.semitones); // => 5
    print(Interval.d4.semitones); // => 4
    print(Interval.P4.semitones); // => 5
    print(Interval.A4.semitones); // => 6
    print(Interval.M3.number); // => 3
    print(Interval.M3.qualityName); // => "M"

    // Interval arithmetic
    print(Interval.M3 + Interval.m3); // => P5
    print(Interval.m3 + Interval.M3); // => P5
    print(Interval.m3 + Interval.m3); // => d5
    print(Interval.M3 + Interval.M3); // => A5

    print(Pitch.parse('C4') + Interval.M3); // => E4
    print(Pitch.parse('C4') + Interval.A3); // => E♯4
    print(Pitch.parse('C4') + Interval.d4); // => F♭4
    print(Pitch.parse('C4') + Interval.P4); // => F4

    print(Pitch.parse('C4') - Pitch.parse('C4'));   // => P1
    print(Pitch.parse('D4') - Pitch.parse('C4'));   // => M2
    print(Pitch.parse('E4') - Pitch.parse('C4'));   // => M3
    print(Pitch.parse('E♯4') - Pitch.parse('C4')); // => A3
    print(Pitch.parse('F♭4') - Pitch.parse('C4')); // => d4
    print(Pitch.parse('F4') - Pitch.parse('C4'));  // => P4

    // Chords
    print(Chord.parse('E Major'));
    print(ChordPattern.parse('Dominant 7th')); // => Dom 7th
    print(ChordPattern.fromIntervals([Interval.P1, Interval.M3, Interval.P5])); // => Major
    print(ChordPattern.fromIntervals([Interval.P1, Interval.m3, Interval.P5])); // => Minor
    print(ChordPattern.fromIntervals([Interval.P1, Interval.m3, Interval.P5, Interval.m7])); // => Min 7th

    // Scales
    final scalePattern = ScalePattern.findByName('Diatonic Major');
    print(scalePattern.intervals); // => [P1, M2, M3, P4, P5, M6, M7]
    print(scalePattern.modes);
    print(scalePattern.modes['Dorian'].intervals); // => [P1, M2, m3, P4, P5, M6, m7]

    final scale = scalePattern.at(Pitch.parse('E4'));
    print(scale.intervals); // => [P1, M2, M3, P4, P5, M6, M7]
    print(scale.pitchClasses); // => [E4, F♯4, G♯4, A4, B4, C♯5, D♯5]

    // Instruments and fret fingerings
    final chord = Chord.parse('E Major');
    final instrument = Instrument.Guitar;
    print(bestFrettingFor(chord, instrument)); // => 022100
  }

More examples can be found in the tests in test/*_test.dart.

License #

MIT

[0.0.2] - Dart 2 / Flutter compatibility

  • Updated for Flutter and Dart 2 compatibility.

[0.0.1] - Initial release

  • Initial release.

example/tonic_example.dart

import 'package:tonic/tonic.dart';

main() {
  banner("Hemholtz and Scientific pitch notation");
  print(Pitch.parse('C4'));
  print(Pitch.parse('C♯4'));
  print(Pitch.parse('C♭4'));

  banner("Unicode and ASCII sharps and flats");
  print(Pitch.parse('C#4') == Pitch.parse('C#4')); // => true
  print(Pitch.parse('Cb4') == Pitch.parse('Cb4')); // => true

  banner("Enharmonic equivalents");
  print(
      Pitch.parse('E♯4').midiNumber == Pitch.parse('F4').midiNumber); // => true
  print(
      Pitch.parse('E4').midiNumber == Pitch.parse('F♭4').midiNumber); // => true
  print(Pitch.parse('E♯4') == Pitch.parse('F4')); // => false
  print(Pitch.parse('E4') == Pitch.parse('F♭4')); // => false

  print(Pitch.parse('C4').octave); // => 5
  print(Pitch.parse('C4').midiNumber); // => 60
  print(new Pitch.fromMidiNumber(60)); // => C4

  banner("Intervals");
  print(Interval.M3);
  print(Interval.parse('M3'));
  print(Interval.m3.semitones); // => 3
  print(Interval.M3.semitones); // => 4
  print(Interval.A3.semitones); // => 5
  print(Interval.d4.semitones); // => 4
  print(Interval.P4.semitones); // => 5
  print(Interval.A4.semitones); // => 6
  print(Interval.M3.number); // => 3
  print(Interval.M3.qualityName); // => "M"

  banner("Interval arithmetic");
  print(Interval.M3 + Interval.m3); // => P5
  print(Interval.m3 + Interval.M3); // => P5
  print(Interval.m3 + Interval.m3); // => d5
  print(Interval.M3 + Interval.M3); // => A5

  print(Pitch.parse('C4') + Interval.M3); // => E4
  print(Pitch.parse('C4') + Interval.A3); // => E♯4
  print(Pitch.parse('C4') + Interval.d4); // => F♭4
  print(Pitch.parse('C4') + Interval.P4); // => F4

  print(Pitch.parse('C4') - Pitch.parse('C4')); // => P1
  print(Pitch.parse('D4') - Pitch.parse('C4')); // => M2
  print(Pitch.parse('E4') - Pitch.parse('C4')); // => M3
  print(Pitch.parse('E♯4') - Pitch.parse('C4')); // => A3
  print(Pitch.parse('F♭4') - Pitch.parse('C4')); // => d4
  print(Pitch.parse('F4') - Pitch.parse('C4')); // => P4

  banner("Chords");
  print(Chord.parse('E Major'));
  print(ChordPattern.parse('Dominant 7th')); // => Dom 7th
  print(ChordPattern.fromIntervals(
      [Interval.P1, Interval.M3, Interval.P5])); // => Major
  print(ChordPattern.fromIntervals(
      [Interval.P1, Interval.m3, Interval.P5])); // => Minor
  print(ChordPattern.fromIntervals(
      [Interval.P1, Interval.m3, Interval.P5, Interval.m7])); // => Min 7th

  banner("Scales");
  final scalePattern = ScalePattern.findByName('Diatonic Major');
  print(scalePattern.intervals); // => [P1, M2, M3, P4, P5, M6, M7]
  print(scalePattern.modes);
  print(scalePattern
      .modes['Dorian'].intervals); // => [P1, M2, m3, P4, P5, M6, m7]

  final scale = scalePattern.at(PitchClass.parse('E4'));
  print(scale.intervals); // => [P1, M2, M3, P4, P5, M6, M7]
  print(scale.pitchClasses); // => [E4, F♯4, G♯4, A4, B4, C♯5, D♯5]

  final chord = Chord.parse('E Major');
  final instrument = Instrument.guitar;
  print(bestFrettingFor(chord, instrument)); // => 022100
}

void banner(msg) => print("\n" + msg + ":");

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  tonic: ^0.2.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:tonic/tonic.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
78
Health:
Code health derived from static analysis. [more]
59
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
59
Overall:
Weighted score of the above. [more]
69
Learn more about scoring.

We analyzed this package on Dec 10, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.0
  • pana: 0.13.1+4

Health suggestions

Fix lib/pitch.dart. (-11.33 points)

Analysis of lib/pitch.dart reported 24 hints, including:

line 55 col 19: Unnecessary new keyword.

line 58 col 7: DO use curly braces for all flow control structures.

line 58 col 13: Unnecessary new keyword.

line 80 col 25: Unnecessary new keyword.

line 85 col 5: DO use curly braces for all flow control structures.

Fix lib/interval.dart. (-10.44 points)

Analysis of lib/interval.dart reported 22 hints, including:

line 58 col 47: Use contains instead of indexOf

line 65 col 7: DO use curly braces for all flow control structures.

line 65 col 13: Unnecessary new keyword.

line 73 col 7: DO use curly braces for all flow control structures.

line 73 col 13: Unnecessary new keyword.

Fix lib/chord.dart. (-8.17 points)

Analysis of lib/chord.dart reported 17 hints, including:

line 37 col 7: DO use curly braces for all flow control structures.

line 37 col 13: Unnecessary new keyword.

line 52 col 7: DO use curly braces for all flow control structures.

line 52 col 13: Unnecessary new keyword.

line 80 col 16: Unnecessary new keyword.

Fix additional 5 files with analysis or formatting issues. (-20.48 points)

Additional issues in the following files:

  • lib/fretting.dart (16 hints)
  • lib/pitch_class.dart (11 hints)
  • lib/scale.dart (8 hints)
  • lib/instrument.dart (5 hints)
  • lib/src/utils.dart (2 hints)

Maintenance suggestions

Package is getting outdated. (-35.62 points)

The package was last published 70 weeks ago.

Homepage URL is insecure. (-5 points)

Update the homepage field and use a secure (https) URL.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.69.5 <3.0.0
collection ^1.14.0 1.14.12
Dev dependencies
test ^1.3.0