From 0907857501f68aa0e9b020e13232a35fd6c6ba62 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Thu, 15 Aug 2024 01:01:53 -0700 Subject: [PATCH] Documentation updates --- src/source/mod.rs | 2 +- src/source/test_waveform.rs | 29 +++++++++++++++++++++-------- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/src/source/mod.rs b/src/source/mod.rs index 6043318c..3448529e 100644 --- a/src/source/mod.rs +++ b/src/source/mod.rs @@ -33,8 +33,8 @@ pub use self::skippable::Skippable; pub use self::spatial::Spatial; pub use self::speed::Speed; pub use self::stoppable::Stoppable; -pub use self::test_waveform::{TestWaveform, TestWaveformFunction}; pub use self::take::TakeDuration; +pub use self::test_waveform::{TestWaveform, TestWaveformFunction}; pub use self::uniform::UniformSourceIterator; pub use self::zero::Zero; diff --git a/src/source/test_waveform.rs b/src/source/test_waveform.rs index 6919bead..1b2214bd 100644 --- a/src/source/test_waveform.rs +++ b/src/source/test_waveform.rs @@ -1,23 +1,38 @@ +//! Generator sources for various periodic test waveforms. +//! +//! This module provides several periodic, deterministic waveforms for testing other sources. Every +//! source oscillates in the codomain `[-1.0f32, 1.0f32]`. +//! +//! # Example +//! +//! ``` +//! use rodio::source::{TestWaveform,TestWaveformFunction}; +//! +//! let tone = TestWaveform::new(cpal::SampleRate(48000), 440.0, TestWaveformFunction::Sine); +//! ``` use std::f32::consts::TAU; use std::time::Duration; use super::SeekError; use crate::Source; -/// Syntheizer waveform functions. All of the synth waveforms are in the -/// codomain [-1.0, 1.0]. +/// Test waveform functions. #[derive(Clone, Debug)] pub enum TestWaveformFunction { + /// A sinusoidal waveform. Sine, + /// A triangle wave. Triangle, + /// A square wave, rising edge at t=0. Square, + /// A rising swatooth wave. Sawtooth, } impl TestWaveformFunction { /// Create a single sample for the given waveform #[inline] - pub fn render(&self, i: u64, period: f32) -> f32 { + fn render(&self, i: u64, period: f32) -> f32 { let i_div_p: f32 = i as f32 / period; match self { @@ -35,8 +50,7 @@ impl TestWaveformFunction { } } -/// An infinite source that produces one of a selection of synthesizer -/// waveforms. +/// An infinite source that produces one of a selection of test waveforms. #[derive(Clone, Debug)] pub struct TestWaveform { sample_rate: cpal::SampleRate, @@ -46,7 +60,7 @@ pub struct TestWaveform { } impl TestWaveform { - /// Create a new `SynthWaveform` object that generates an endless waveform + /// Create a new `TestWaveform` object that generates an endless waveform /// `f`. #[inline] pub fn new( @@ -168,8 +182,7 @@ mod tests { #[test] fn sine() { - let mut wf = - TestWaveform::new(cpal::SampleRate(1000), 100f32, TestWaveformFunction::Sine); + let mut wf = TestWaveform::new(cpal::SampleRate(1000), 100f32, TestWaveformFunction::Sine); assert_abs_diff_eq!(wf.next().unwrap(), 0.0f32); assert_abs_diff_eq!(wf.next().unwrap(), 0.58778525f32);