https://github.com/njonsson/harmonex

A collection of tools for music theory — pronounced “harmonics”
https://github.com/njonsson/harmonex

elixir elixir-library music music-composition music-theory

Last synced: 3 months ago
JSON representation

A collection of tools for music theory — pronounced “harmonics”

• Host: GitHub
• URL: https://github.com/njonsson/harmonex
• Owner: njonsson
• License: other
• Created: 2017-05-07T04:57:34.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2021-08-02T11:15:20.000Z (about 4 years ago)
• Last Synced: 2025-04-14T01:36:00.034Z (6 months ago)
• Topics: elixir, elixir-library, music, music-composition, music-theory
• Language: Elixir
• Homepage: https://njonsson.github.io/harmonex
• Size: 167 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: License.md

Awesome Lists containing this project

README

          
#  Harmonex

[][Travis-CI-build-status]

[][HexFaktor-deps-status]

[][Coveralls-test-coverage-status]

[][Hex-release]

This is a collection of tools for music theory called _Harmonex_ (pronounced

“harmonics”).

**See what’s changed lately by reading [the project history][project-history].**

## Usage

Pitches and intervals are the two main constructs available in _Harmonex_ at

present.

You can refer to a **pitch** using any of the following styles of expressions:

* An **atom** representing a pitch class (A♮ in an unspecified octave), for

  example:

  - `:a`, or

  - `:a_natural`

* A **map** representing a pitch class (A𝄫 in an unspecified octave) or a pitch

  (A𝄫₄), for example:

  - `%{natural_name: :a, accidental: :double_flat}`, or

  - `%{natural_name: :a, accidental: :double_flat, octave: 4}`

* A **struct** representing a pitch class (A♯ in an unspecified octave) or a

  pitch (A♯₋₁) — constructed using `Harmonex.Pitch.new` — for example:

  - `Harmonex.Pitch.new(:a_sharp)`, or

  - `Harmonex.Pitch.new(:a, :sharp)`, or

  - `Harmonex.Pitch.new(:a_sharp, -1)`, or

  - `Harmonex.Pitch.new(:a, :sharp, -1)`, or

  - `Harmonex.Pitch.new(%{natural_name: :a, accidental: :sharp, octave: -1})`

You can refer to an **interval** using either of the following styles of

expressions:

* A **map** representing an interval (a doubly-diminished ninth), for example:

  `%{quality: :doubly_diminished, size: 9}`

* A **struct** representing an interval (a perfect unison) — constructed using

  `Harmonex.Interval.new` — for example:

  - `Harmonex.Interval.new(:perfect, 1)`, or

  - `Harmonex.Interval.new(%{quality: :perfect, size: 1})`

### What can you do with _Harmonex_?

Its functions can answer elementary textbook music theory questions such as:

* **Are C♯ and D♭ enharmonically equivalent pitches?**  

  _Answer:_ `Harmonex.Pitch.enharmonic?(:c_sharp, :d_flat) == true`  

  **What about B♯₄ and C₅?**  

  _Answer:_ `Harmonex.Pitch.enharmonic?(Harmonex.Pitch.new(:b_sharp, 4),

  Harmonex.Pitch.new(:c, 5)) == true`

* **What are the enharmonic equivalents of F𝄪?**  

  _Answer:_

  `Harmonex.Pitch.enharmonics(:f_double_sharp) == [:g_natural, :a_double_flat]`

* **How far apart, in semitones, are the pitches A♭ and D♯?**  

  _Answer:_ `Harmonex.Pitch.semitones(:a_flat, :d_sharp) == 5`  

* **How far across in semitones is a doubly augmented second?**  

  _Answer:_ `Harmonex.Pitch.interval(:c_flat, :d_sharp) |>

  Harmonex.Interval.semitones == 4`  

  _Answer:_

  `Harmonex.Interval.semitones(%{quality: :doubly_augmented, size: 2}) == 4`

* **What is the interval between the pitches F♮ and B𝄫?**  

  _Answer:_

  `Harmonex.Pitch.interval(:f, :b_double_flat) == %Harmonex.Interval{quality:

  :diminished, size: 4}`  

  _Answer:_

  `Harmonex.Interval.from_pitches(:f, :b_double_flat) ==

  %Harmonex.Interval{quality: :diminished, size: 4}`

* **Is a minor ninth enharmonically narrower or wider than a

  doubly-augmented octave?**  

  _Answer:_

  `Harmonex.Interval.compare(Harmonex.Interval.new(:minor, 9),

  Harmonex.Interval.new(:doubly_augmented, 8)) == :lt`

### Functionality still under development

* **What is the key signature of G harmonic minor?**  

  _Answer:_ two flats, one sharp — B♭, E♭, and F♯.

* **What keys and modes have the signature of three sharps?**  

  _Answer:_ A major/Ionian, B Dorian, C♯ Phrygian, D Lydian, E Mixolydian, F♯

  minor/Aeolian, and G♯ Locrian.

* **Does A♮ occur diatonically in the key of E♭ minor?**  

  _Answer:_ no.

* **What are the pitches of the simplest voicing of a D♭ minor triad in

  second inversion?**  

  _Answer:_ A♭, D♭, and F♭.

* **What is the name and inversion of the chord described by the pitches C♮, F♯,

  and A♮?**  

  _Answer:_ F♯ diminished triad in second inversion.  

  **of the chord described by A♭, C, and F♯?**  

  _Answer:_ A♭ Italian sixth.  

  **of the chord described by B, D♯, E, and G♯?**  

  _Answer:_ E major seventh in second inversion.

* **What are the jazz chart symbols of the chords just mentioned?**  

  _Answer:_ F♯o/C, A♭7(no 5), and E△7/B.

* **What is the functional-harmonic symbol of the chord described by the pitches

  C♮, E♮, F♯, and A♮ in C major?**  

  _Answer:_ viiø32/V.  

  **of the chord described by A♭, C, and F♯ in C minor?**  

  _Answer:_ It6.  

  **of the chord described by B, D♯, E, and G♯ in E major?**  

  _Answer:_ I43.

_Harmonex_ also will have functions for exploring compositional questions such

as:

* **What is the set of triads and seventh chords, including enharmonic

  equivalents, that the keys of B Mixolydian and D Lydian have in common?**

* **What is the set of seventh chords, including enharmonic equivalents, that are

  within one degree of difference (by shifting one note by a half or whole step)

  from an F major seventh chord?**  

  **within two degrees?**  

  **three?**  

  **four?**

* **What are sets of three-chord changes for modulating from the key of D minor

  to F♯ major?**  

  **four-chord changes?**  

  **five-chord changes?**

## Installation

Install [the Hex package][Hex-release] by adding `:harmonex` to the list of

dependencies in your project’s _mix.exs_ file:

```elixir

# mix.exs

# ...

def deps do

  [{:harmonex, "~> 0.6.1"}]

end

# ...

```

## Contributing

To submit a patch to the project:

1. [Fork][fork-project] the official repository.

2. Create your feature branch: `git checkout -b my-new-feature`.

3. Commit your changes: `git commit -am 'Add some feature'`.

4. Push to the branch: `git push origin my-new-feature`.

5. [Create][compare-project-branches] a new pull request.

After cloning the repository, `mix deps.get` to install dependencies. Then

`mix test` to run the tests. You can also `iex` to get an interactive prompt that

will allow you to experiment. To build this package, `mix hex.build`.

To release a new version:

1. Update [the project history in _History.md_][project-history], and then

   commit.

2. Update the version number in [_mix.exs_][mix-dot-exs-file] respecting

   [Semantic Versioning][Semantic-Versioning], update

   [the “Installation” section](#installation) of

   [this readme][readme-dot-md-file] to reference the new version, and then

   commit.

3. Build and publish [the Hex package][Hex-release] with `mix hex.publish`.

4. Tag with a name like `vMAJOR.MINOR.PATCH` corresponding to the new version,

   and then push commits and tags.

## License

Released under the [MIT License][MIT-License].

[Travis-CI-build-status]:         http://travis-ci.org/njonsson/harmonex                                  "Travis CI build status for ‘Harmonex’"

[HexFaktor-deps-status]:          https://beta.hexfaktor.org/github/njonsson/harmonex                     "HexFaktor dependencies status for ‘Harmonex’"

[Coveralls-test-coverage-status]: https://coveralls.io/r/njonsson/harmonex?branch=master                  "Coveralls test coverage status"

[Hex-release]:                    https://hex.pm/packages/harmonex                                        "Hex release of ‘Harmonex’"

[project-history]:                https://github.com/njonsson/harmonex/blob/master/History.md             "‘Harmonex’ project history"

[fork-project]:                   https://github.com/njonsson/harmonex/fork                               "Fork the official repository of ‘Harmonex’"

[compare-project-branches]:       https://github.com/njonsson/harmonex/compare                            "Compare branches of ‘Harmonex’ repositories"

[mix-dot-exs-file]:               https://github.com/njonsson/harmonex/blob/master/mix.exs                "‘Harmonex’ project ‘mix.exs’ file"

[Semantic-Versioning]:            http://semver.org/

[readme-dot-md-file]:             https://github.com/njonsson/harmonex/blob/master/README.md#installation "‘Harmonex’ project ‘README.md’ file"

[MIT-License]:                    http://github.com/njonsson/harmonex/blob/master/License.md              "MIT License claim for ‘Harmonex’"