Module documentation for 0.2.1
This library provides a safe interface that allows us to manipulate WAVE files in their “classic” form as well as files in the RF64 format. RF64 adds the ability to store files larger than 4 Gb.
The main feature of the API is that it does not allow the user to duplicate
information and introduce errors in that way. For example, the block
alignment can be calculated from other parameters of an audio stream, thus
we do not store it in the
Wave record and do not allow the user to specify
it. We provide, however, a way to calculate it given a
Wave record, see
waveBlockAlign. The same is true for the number of channels. The channel
mask is a more general means of providing the information about the number
of channels and the corresponding speaker positions, thus we only store the
Another feature of the library is that it does not dictate how to read or
write the audio data. To write the audio data the user passes a callback
that receives a
Handle as an argument. The size of the written data block
is deduced automatically. This makes the library fast and open to different
ways of handling the audio data, including via foreign code.
I needed a way to work with WAVE files to finish the
flac package and for analyzing input
data in WAVE format in general. The existing solutions
wavy) are not maintained and
poorly designed. Suffice it to say that they read samples of audio stream
and put them in a linked list, like
[[Sample]] (the inner linked list is
to store multi-channel data).
The library only supports PCM format with samples represented as integers and floating point values.
Issues, bugs, and questions may be reported in the GitHub issue tracker for this project.
Pull requests are also welcome.
Copyright © 2016–present Mark Karpov
Distributed under BSD 3 clause license.
- Maintenance release with more modern and minimal dependencies.
- Got rid of
Wavenow is not an instance of
- Dropped support for GHC 7.8.
- Improved documentation and metadata.
- The library now doesn’t write zero extra format information size when
fmtchunk is not extensible. Previously it wrote zero size.
- Adjust and document guessing of channel mask from number of channels alone
for files with non-extensible
- Switched to using
withFile, because the latter does nasty conversions on Windows, see docs for
*.rf64audio samples to the distribution to allow the tests pass.
- Initial release.