https://github.com/cheerfulstoic/music

Library for performing calculations on musical elements
https://github.com/cheerfulstoic/music

Last synced: 3 days ago
JSON representation

Library for performing calculations on musical elements

• Host: GitHub
• URL: https://github.com/cheerfulstoic/music
• Owner: cheerfulstoic
• License: mit
• Created: 2012-04-15T14:48:07.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-11-27T10:21:08.000Z (almost 2 years ago)
• Last Synced: 2024-08-08T15:29:33.404Z (3 months ago)
• Language: Ruby
• Size: 92.8 KB
• Stars: 54
• Watchers: 10
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
music

=====

The *music* gem provides a means on calculating notes and chords.

[![Build Status](https://travis-ci.org/cheerfulstoic/music.png)](https://travis-ci.org/cheerfulstoic/music)

[![PullReview stats](https://www.pullreview.com/github/cheerfulstoic/music/badges/master.svg?)](https://www.pullreview.com/github/cheerfulstoic/music/reviews/master)

Examples:

---------

All examples below assume that `include Music` has been called, though you can also use `Music::Note`, `Music::Chord`, etc...

Creating notes:

    note = Note.new(698.46) # Creates a note object with the frequency 698.46

    note = Note.new('F#6') # Creates an F sharp note in the 6th octave

Comparing notes:

    Note.new(698.46) < Note.new(1975.53)    # => true

    Note.new(698.46) == Note.new('F5')      # => true

Converting from frequency to note string and vice versa:

    Note.new(698.46).note_string    # => 'F5'

    Note.new('Bb3').frequency       # => 233.08

Find how many semitones two notes are apart:

    Note.note_distance('A4', 'A#4')     # => 1

    Note.note_distance('B1', 'F1')      # => -6

    Note.note_distance('G#1', 'Ab1')    # => 0

Adjust frequencies by semitones:

    Note.frequency_adjustment(440.0, 15)    # => 1046.50

Create chords:

    chord = Chord.new(['C4', 'E4', 'G4'])   # Create a C major chord

Describe chords:

    Chord.new(['C4', 'Eb4', 'Gb4'])     # => ['C', :diminished]

*For further usage:*

 * Docs: http://rubydoc.info/github/cheerfulstoic/music/frames

 * See the examples in the spec files

TODOs:

======

 * Use the term musical term 'interval' or 'semitones' instead of 'distance' in code

 * 'C-' can be used to represent C minor

 * There can be many versions of chords.  See: http://giventowail.com/lessons/evan/the-basics-major-minor-and-power-chords?phpMyAdmin=97715a053dab6cd797cf01c69d7492a4

 * Implement calculation of 'cents'

Contributing to music

=====================

Contributions are welcome.  Check out the issues list and feel free to fork and make a pull request if you have any fixes/additions.

Copyright

=========

Copyright (c) 2012 Brian Underwood. See LICENSE.txt for

further details.