Skip to content

Latest commit

 

History

History
216 lines (196 loc) · 7.05 KB

CHANGELOG.md

File metadata and controls

216 lines (196 loc) · 7.05 KB
Raw

Changelog

All notable changes to fon will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.6.0] - 2022-01-29

Added

  • Support for no-std!
  • chan::Ch24, a 24-bit integer channel
  • chan::Channel::to_f32()
  • pos module containing types for type-safe channel indexing on Frame
  • Audio::as_u8_slice()
  • Audio::silence() to silence the entire audio buffer
  • AudioSink public type returned from Audio::sink()
  • Audio::with_u8_buffer()
  • Audio::with_audio()
  • From<Audio> for both boxed primitive samples and Vec<Frame>
  • Frame::new()
  • Frame::pan()
  • Frame::gain()
  • SinkTo struct for converting audio while streaming
  • Sink::len()
  • Sink::sink_with()
  • Sink::is_empty()

Changed

  • Renamed Audio::as_slice() to Audio::as_mut_slice(), and Audio::as_slice() now returns an immutable slice
  • Frame is now a struct (rather than a trait), and makes use of const generics
  • Rename Frame::convert() to Frame::to()
  • Merged Stream trait and Resampler struct into a new Stream struct
  • Changed Audio back to being backed by a Box<[Frame]>
  • Sink is now object-safe
  • Sample rates are now represented as NonZeroU32

Removed

  • chan::Ch8 because 8-bit audio is uncommon today and you can use Ch16 for 8-bit audio as well as 12-bit audio.
  • Audio::with_i8_buffer()
  • chan::Channel::to_f64() and chan::Channel::from_f64()
  • Audio::with_frame(); Use Audio::with_frames(hz, vec![_; len]) instead
  • Audio::with_stream(); Use Audio::with_audio() or Audio::sink() instead
  • Audio as IntoIterator; Use Audio::iter() instead.
  • Frame::from_f64()
  • Frame::from_channel()
  • Frame::from_channels()
  • Frame::from_mono()
  • Sink::buffer()
  • Sink::resampler()
  • Sink::flush()
  • Sink::stream()

Fixed

  • Resampler now does proper resampling

[0.5.0] - 2021-01-17

Changed

  • Audio is now stored as a VecDeque<F> instead of a Box<[F]>
  • There are now less cases where a panic will happen.

Removed

  • as_*_slice_mut() and as_mut_slice() methods. All as_slice() methods now require a mutable reference due to the change to VecDeque<F> from Box<[F]>.

[0.4.0] - 2020-12-30

Added

  • ops::Pan for panning audio left and right.
  • ops::Blend::mix_frames() provided method on trait.
  • Audio now implements Stream.
  • Audio::as_i8_slice()
  • Audio::as_i8_slice_mut()
  • Audio::as_i16_slice()
  • Audio::as_i16_slice_mut()
  • Audio::as_f32_slice()
  • Audio::as_f32_slice_mut()
  • Audio::as_f64_slice()
  • Audio::as_f64_slice_mut()
  • Resampler::frame()
  • Resampler::index()
  • Frame::from_f64()
  • Frame::from_channel()
  • Frame::from_mono()
  • Sink::flush()
  • Stream::blend()
  • Stream::take()
  • Stream::set_sample_rate()
  • Stream::is_empty()

Changed

  • Rename Sample to Frame to be more consistent with the audio community.
  • Sample rate on Audio is no longer required to be an integer.
  • Rename ops::Mix to ops::Plus
  • Rename Audio::sample() to Audio::get()
  • Rename Audio::sample_mut() to Audio::get_mut()
  • Rename Audio::samples() to Audio::as_slice()
  • Rename Audio::samples_mut() to Audio::as_mut_slice()
  • Rename Audio::with_sample() to Audio::with_frame()
  • Replaced Audio::with_audio() with Audio::with_stream()
  • Replaced Audio::with_samples() with Audio::with_frames()
  • Audio::drain() no longer takes any arguments.
  • Audio::extend() now takes a stream instead of a mutable reference to a stream.
  • Resampler is now attached to the Sink rather than the Stream.
  • Rename Sink::sink() to Sink::stream()
  • Required methods on Sink and Stream

Removed

  • Audio::blend_sample()
  • Audio::blend_audio()
  • Audio::copy_silence()
  • Audio::copy_sample()
  • Audio::stream()
  • Sample::blend_sample()
  • Sample::blend_slice()
  • Sample::blend_blend()
  • Stream::stream()

Fixed

  • Almost none of the channel arithmetic working (it all works now and there's unit tests!).
  • Buggy resampler
  • A lot of other bugs

[0.3.0] - 2020-12-19

Added

  • CONFIG constant to Sample to define speaker configurations.
  • Extra generics on Stream and Sink allowing them to be used as conversion functions (to convert between different sample formats and speaker configurations).

Changed

  • No longer does Sample require Sealed meaning you can define custom speaker configurations as needed.
  • Renamed surround::Surround5x8 to Surround8
  • Renamed surround::Surround5x16 to Surround16
  • Renamed surround::Surround5x32 to Surround32
  • Renamed surround::Surround5x64 to Surround64
  • Renamed sample::Sample1 to mono::Mono
  • Renamed sample::Sample2 to stereo::Stereo
  • Renamed sample::Sample6 to surround::Surround
  • Moved Sample to the crate root (removing sample module)

Removed

  • sample::Sample4
  • sample::Sample8
  • surround::Surround4x8
  • surround::Surround4x16
  • surround::Surround4x32
  • surround::Surround4x64
  • surround::Surround7x8
  • surround::Surround7x16
  • surround::Surround7x32
  • surround::Surround7x64

Fixed

  • Reimplemented Sample::convert to be more accurate.

[0.2.0] - 2020-08-26

Added

  • From<Audio> for Box<[f64]> impl
  • From<Audio> for Box<[f32]> impl
  • From<Audio> for Box<[i8]> impl
  • From<Audio> for Box<[i16]> impl
  • Audio::samples method
  • Audio::samples_mut method
  • Audio::with_i8_buffer function
  • Audio::with_i16_buffer function
  • Audio::with_f32_buffer function
  • Audio::with_f64_buffer function
  • Audio::copy_silence method
  • Audio::copy_sample method
  • Surround4 and Surround4x{} aliases
  • Audio::sample method
  • Audio::sample_mut method
  • Resampler struct
  • Stream trait
  • Sink trait
  • Audio::stream method
  • Audio::drain method
  • Audio::sink method
  • Audio::extend method

Changed

  • Audio::blend_sample and Audio::blend_audio now take an additional reg argument to enable blending on part of the Audio buffer.
  • Rename Surround to Surround5
  • Rename SurroundHD to Surround7
  • Rename Surround{} to Surround5x{}
  • Rename SurroundHD{} to Surround7x{}
  • Speaker (channel) configuration order now matches the default on Linux ALSA

Removed

  • From<Audio> for Box<[u8]> impl
  • From<Audio> for Box<[u16]> impl
  • Audio::as_u8_slice method
  • Audio::as_u8_slice_mut method
  • Audio::with_u8_buffer function
  • Audio::with_u16_buffer function
  • Hz type
  • Config type

Fixed

  • Channel and Sample types not being marked #[repr(transparent)]

[0.1.0] - 2020-08-15

Added

  • Audio buffer
  • Hz newtype
  • Config trait
  • mono, stereo and surround modules
  • Sample1, Sample2, Sample6, and Sample8 implementing Sample
  • ops module with Amplify, Clear, Compress, Dest, Mix and Src
  • Ch8, Ch16, Ch32 and Ch64 implementing Channel