Organize tree module

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        tc: [1.60.0, stable, beta, nightly]
+        tc: [beta, nightly]
     steps:
     - uses: actions/checkout@v2
     - uses: actions-rs/toolchain@v1
@@ -25,7 +25,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        tc: [1.60.0]
+        tc: [1.70.0]
         cc:
         - aarch64-fuchsia
         - aarch64-linux-android
@@ -52,7 +52,7 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest]
-        tc: [1.60.0]
+        tc: [1.70.0]
         cc: [aarch64-apple-ios]
     steps:
     - uses: actions/checkout@v2

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to `twang` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://github.com/AldaronLau/semver).
 
+## [0.10.0] - Unreleased
+### Changed
+ - Bump MSRV to 1.70.0
+
 ## [0.9.0] - 2022-10-23
 ### Changed
  - Bump MSRV to 1.60.0

Cargo.toml

@@ -9,10 +9,10 @@
 
 [package]
 name = "twang"
-version = "0.9.0"
+version = "0.10.0"
 license = "Apache-2.0 OR BSL-1.0 OR MIT"
 edition = "2021"
-rust-version = "1.60.0"
+rust-version = "1.70.0"
 documentation = "https://docs.rs/twang"
 homepage = "https://aldaronlau.github.io/twang"
 repository = "https://github.com/AldaronLau/twang"
@@ -37,6 +37,7 @@ include = ["README.md", "Cargo.toml", "src/*", "build.rs"]
 [dependencies]
 libm = "0.2"
 fon = "0.6"
+traitful = "0.3"
 
 [dev-dependencies]
 splotch = "0.0.1"

README.md

@@ -104,10 +104,12 @@ Examples can be found in the [Documentation](https://docs.rs/twang) and the
 examples folder.
 
 ## MSRV
-The minimum supported Rust version of twang is 1.60.0.  MSRV may only be updated
+The minimum supported Rust version of twang is 1.70.0.  MSRV may only be updated
 when increasing the leftmost version number of twang.
 
 ## License
+Copyright © 2018-2024 The Twang Contributors.
+
 Licensed under either of
  - Apache License, Version 2.0
    ([LICENSE_APACHE_2_0.txt](https://github.com/AldaronLau/twang/blob/stable/LICENSE_APACHE_2_0.txt) or

examples/sine.rs

@@ -1,22 +1,19 @@
 use fon::{chan::Ch16, Audio, Frame};
-use twang::tree::{Synth, Sine, Hz, Wave};
+use twang::tree::{osc::{Osc, Sine}, Synth, Wave};
 
 mod wav;
-
-// Define waveform
-const fn waveform() -> impl Wave {
-    Sine(Hz(440.0))
-}
+//mod plot;
 
 fn main() {
+    // Define waveform
+    let waveform = const { Osc(440.0).sine() };
     // Initialize audio, and create synthesizer
     let mut audio = Audio::<Ch16, 2>::with_silence(48_000, 48_000 * 5);
-    let mut synth = Synth::new(waveform());
+    let mut synth = Synth::new(waveform);
 
     // Synthesize 5 seconds of audio
     synth.stream(audio.sink(), &[]);
-
     // Plot synthesized audio, and write to a WAV file
-    // plot::write(&audio);
+    //plot::write(&audio);
     wav::write(audio, "sine.wav").expect("Failed to write WAV file");
 }

rust-toolchain.toml

@@ -0,0 +1,3 @@
+[toolchain]
+# Currently using beta for tests, MSRV of examples is 1.79
+channel = "beta"

src/file.rs

@@ -1,14 +1,7 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 //! Twang synthesis file format
 
+#![allow(warnings)]
+
 use alloc::vec::Vec;
 use fon::chan::{Ch32, Channel};
 use fon::{Audio, Sink};

src/lib.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 //! Library for pure Rust advanced audio synthesis.
 //!
 //! Most audio DSP (Digital Signal Processing) libraries have a concept of an
@@ -105,8 +96,8 @@
     variant_size_differences
 )]
 
-extern crate std; // FIXME: for debugging
 extern crate alloc;
+extern crate std; // FIXME: for debugging
 
 mod math;
 mod synth;

src/math.rs

@@ -1,11 +1,4 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
+#![allow(warnings)]
 
 use core::ops::Rem;
 

src/next.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 //! # Twang File Format (Alpha)
 //! The twang file format is a simple list of 32-bit instructions and data.  The
 //! file must begin with magic bytes: `\xFF\xFETwAnG\0`.  Suggested file
@@ -117,6 +108,8 @@
 //! ### 17 - MAX
 //!  - `index` points to input node.
 
+#![allow(warnings)]
+
 use fon::Sink;
 
 use alloc::vec::Vec;

src/noise.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 //! A collection of noise generators.
 
 mod pink;

src/noise/pink.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use fon::chan::Ch16;
 
 // Constants PFIRA and PFIRB

src/noise/white.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use core::num::Wrapping;
 use fon::chan::Ch24;
 

src/ops.rs

@@ -1,14 +1,7 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 //! A collection of auditory effects.
 
+#![allow(warnings)]
+
 mod clip;
 mod far;
 mod gain;

src/ops/clip.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 #[cfg(not(test))]
 use crate::math::Libm;
 

src/ops/far.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 #[cfg(not(test))]
 use crate::math::Libm;
 

src/ops/gain.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 #[cfg(not(test))]
 use crate::math::Libm;
 

src/ops/gate.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use fon::chan::{Ch32, Channel};
 
 /// Noise gate.

src/ops/invert.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use fon::chan::Ch32;
 
 /// Signal inverter.

src/ops/limiter.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 #[cfg(not(test))]
 use crate::math::Libm;
 

src/ops/max.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use fon::chan::{Ch32, Channel};
 
 /// Maximum value of two samples (warning: -0.25 > -0.5, if you want maximum

src/ops/min.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use fon::chan::{Ch32, Channel};
 
 /// Minimum value of two samples (warning: -0.5 < -0.25, if you want minimum

src/ops/near.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 #[cfg(not(test))]
 use crate::math::Libm;
 

src/ops/room.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 use alloc::collections::VecDeque;
 use fon::chan::{Ch32, Channel};
 

src/osc.rs

@@ -1,14 +1,7 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 //! A collection of basic oscillators (wave generators).
 
+#![allow(warnings)]
+
 mod pulse;
 mod sawtooth;
 mod sine;

src/osc/pulse.rs

@@ -1,12 +1,3 @@
-// Copyright © 2018-2022 The Twang Contributors.
-//
-// Licensed under any of:
-// - Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0)
-// - Boost Software License, Version 1.0 (https://www.boost.org/LICENSE_1_0.txt)
-// - MIT License (https://mit-license.org/)
-// At your choosing (See accompanying files LICENSE_APACHE_2_0.txt,
-// LICENSE_MIT.txt and LICENSE_BOOST_1_0.txt).
-
 #[cfg(not(test))]
 use crate::math::Libm;