Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
madskjeldgaard committed Apr 9, 2024
1 parent e815a97 commit d1346e9
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# music-math
[![crates.io](https://img.shields.io/crates/v/music-math.svg)](https://crates.io/crates/music_math)
[![docs.rs](https://img.shields.io/docsrs/music-math)](https://docs.rs/music_math)
[![CI](https://github.com/madskjeldgaard/music-math/workflows/CI/badge.svg)](https://github.com/madskjeldgaard/music-math/actions?query=workflow%3ACI)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/madskjeldgaard/music-math/blob/main/LICENSE-MIT)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
Expand All @@ -11,8 +9,21 @@ Most of these are inspired by similar functions found in different computer musi

It features the following modules:
- `midi`: Functions for converting between MIDI note numbers and frequencies, transposing, etc.
- `get_midi_note_name`: Get the name of a MIDI note number.
- `get_midinote_from_name`: Get the MIDI note number of a note name.
- `note_name_to_octave_position`: Get the octave position of a note name, eg "D" = 2.
- `octave_position_to_note_name`: Get the note name of an octave position, eg 2 = "D".
- `to_frequency`: Convert a MIDI note number to a frequency.
- `transpose`: Safely transpose a MIDI note number, making sure it is within range.
- `scaling`: Functions for scaling values between different ranges, among other things it includes conversions between db and amplitudes, linlin and linexp, etc.
- `binaryops`: Functions for binary operations on numbers, like clip, wrap, fold, etc.
- `linlin`: Linearly scale a value from one range to another.
- `linexp`: Linearly scale a value from one range to another, but with an exponential curve.
- `dbamp`: Convert a decibel value to an amplitude value.
- `ampdb`: Convert an amplitude value to a decibel value.
- `binaryops`:
- `clip`: Clip a value between a min and max value.
- `fold`: Fold a value between a min and max value.
- `wrap`: Wrap a value between a min and max value.

See the documentation for more information.

Expand Down

0 comments on commit d1346e9

Please sign in to comment.