Rename TimeSig::beats_in_a_bar to beats_per_bar. Add TimeSig::ticks_per_bar. Publish 0.12.

Author: mitchmindtree

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "time_calc"
 description = "A library for music/DSP time conversions! Provides functions and methods for converting between ticks, ms, samples, bars, beats and measures."
-version = "0.11.1"
+version = "0.12.0"
 authors = ["[email protected]"]
 readme = "README.md"
 keywords = ["time", "dsp", "audio", "music", "conversion"]

examples/test.rs

@@ -25,7 +25,6 @@ const SAMPLE_HZ: SampleHz = 44_100.0;
 const PPQN: Ppqn = 19_200;
 
 fn main() {
-
     println!("time_calc demonstration!");
 
     // Out `Bars` type is a simplified version of a Measure.
@@ -48,12 +47,12 @@ fn main() {
 
     // We also need to know the "time signature" if we are to convert from "Bars".
     // This is because different time signatures can have a different duration in "Beats".
-    let beats_in_a_bar = TimeSig { top: 4, bottom: 4 }.beats_in_a_bar();
-    println!("Duration of a bar in `Beats` with a 4/4 Time Signature: {}", beats_in_a_bar);
-    let beats_in_a_bar = TimeSig { top: 3, bottom: 4 }.beats_in_a_bar();
-    println!("Duration of a bar in `Beats` with a 3/4 Time Signature: {}", beats_in_a_bar);
-    let beats_in_a_bar = TimeSig { top: 7, bottom: 8 }.beats_in_a_bar();
-    println!("Duration of a bar in `Beats` with a 7/8 Time Signature: {}", beats_in_a_bar);
+    let beats_per_bar = TimeSig { top: 4, bottom: 4 }.beats_per_bar();
+    println!("Duration of a bar in `Beats` with a 4/4 Time Signature: {}", beats_per_bar);
+    let beats_per_bar = TimeSig { top: 3, bottom: 4 }.beats_per_bar();
+    println!("Duration of a bar in `Beats` with a 3/4 Time Signature: {}", beats_per_bar);
+    let beats_per_bar = TimeSig { top: 7, bottom: 8 }.beats_per_bar();
+    println!("Duration of a bar in `Beats` with a 7/8 Time Signature: {}", beats_per_bar);
     let time_sig = TimeSig { top: 4, bottom: 4 };
     println!("Duration of a bar at 120bpm, 44_100 sample_hz and 4/4 Time Sig in samples: {}",
              Bars(1).samples(bpm, time_sig, SAMPLE_HZ));
@@ -66,5 +65,4 @@ fn main() {
              Samples(176_400).bars(bpm, time_sig, SAMPLE_HZ));
 
     println!("Great Success!");
-
 }

src/calc.rs

@@ -28,7 +28,7 @@ pub const SECOND_IN_MS: Ms =  1_000.0;
 /// Calculate and return the duration of a bar in milliseconds.
 #[inline]
 pub fn bar_in_ms(bpm: Bpm, ts: TimeSig) -> Ms {
-    beat_in_ms(bpm) * ts.beats_in_a_bar()
+    beat_in_ms(bpm) * ts.beats_per_bar()
 }
 
 /// Calculate and return the duration of a beat in milliseconds.

src/division.rs

@@ -41,7 +41,7 @@ impl Division {
     pub fn beats(&self, ts: TimeSig) -> f64 {
         use num::Float;
         match *self {
-            Division::Bar => ts.beats_in_a_bar(),
+            Division::Bar => ts.beats_per_bar(),
             _ => 2.0.powi(Division::Beat as i32 - *self as i32),
         }
     }
@@ -50,7 +50,7 @@ impl Division {
     pub fn bars(&self, ts: TimeSig) -> f64 {
         match *self {
             Division::Bar => 1.0,
-            _ => self.beats(ts) / ts.beats_in_a_bar(),
+            _ => self.beats(ts) / ts.beats_per_bar(),
         }
     }
 

src/time_sig.rs

@@ -1,3 +1,5 @@
+use {Bars, Ppqn, Ticks};
+
 pub type Top = u16;
 pub type Bottom = u16;
 
@@ -9,9 +11,17 @@ pub struct TimeSig {
 }
 
 impl TimeSig {
+
     /// Return how many beats there are in a bar under this time signature.
     #[inline]
-    pub fn beats_in_a_bar(&self) -> f64 {
+    pub fn beats_per_bar(&self) -> f64 {
         4.0 * self.top as f64 / self.bottom as f64
     }
+
+    /// The number of `Ticks` in a single `Bar` with this `TimeSig`.
+    #[inline]
+    pub fn ticks_per_bar(&self, ppqn: Ppqn) -> Ticks {
+        Bars(1).to_ticks(*self, ppqn)
+    }
+
 }