use-tuning 0.0.1

Tuning metadata primitives for RustUse.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# use-tuning

Tuning metadata primitives for `RustUse`.

## Experimental

use-tuning is experimental while use-music remains below version 0.3.0.

## Example

~~~rust
use use_tuning::{ConcertPitchStandard, ReferencePitch};

let reference = ReferencePitch::new(440.0)?;

assert_eq!(reference.value(), 440.0);
assert_eq!(ConcertPitchStandard::A440.as_str(), "a440");
# Ok::<(), use_tuning::TuningError>(())
~~~

## Scope

- Tuning systems, temperament kinds, reference pitch metadata, reference notes, concert pitch standards, cents, tuning ratios, microtonal divisions, and equal temperament divisions.

## Relationship to use-acoustics

`use-tuning` models tuning metadata only. `use-acoustics` owns physical sound calculations and `use-wave` owns wave primitives.

## Non-goals

- Wave calculation, acoustic frequency modeling, tuning engines, pitch detection, synthesis, or playback.

## License

Licensed under either Apache-2.0 or MIT.