Module documentation for 0.1.5
This module provides a safe interface that allows 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, block align may
be calculated from other parameters of audio stream, thus we do not store it
Wave record and do not allow user to specify it. We provide,
however, a way to calculate it given
Wave record, see
The same is done for channels. Channel mask is a more general means of
providing information about number of channels and corresponding speaker
positions, thus we only store channel mask in user-friendly form, and number
of channels can be derived from that information.
Another feature of the library is that it does not dictate how to read/write
audio data. What we give is the information about audio data and offset in
file where it begins. To write data the user may use a callback that
Handle as an argument. Size of data block is deduced
automatically for you. Exclusion of audio data from consideration makes the
library pretty fast and open to different ways to handle audio data itself,
including using foreign code (such as C).
The library provides control over all parts of WAVE file that may be of
interest. In particular, it even allows to write arbitrary chunks between
data chunks, although it’s rarely useful (and may actually
confuse buggy applications that don’t know how to skip unknown chunks).
Please read the Haddocks for a more detailed documentation, the usage should be trivial.
I needed a way to work with WAVE files to finish
flac package and for analyzing input
data in WAVE format in general. The existing solutions
wavy) are not maintained and
poorly designed. It suffices to say that they read samples of audio stream
and put them into a linked list, like
[[Sample]] (the inner linked list
is to store multi-channel data, yeah).
wave package is the first serious solution in Haskell that allows to
work with WAVE data safely and efficiently.
The library only supports PCM format with samples represented as integers and floating point values. Support for other formats will be added on request, please contact me at https://github.com/mrkkrp/wave/issues.
Issues, bugs, and questions may be reported in the GitHub issue tracker for this project.
Pull requests are also welcome and will be reviewed quickly.
Copyright © 2016–2017 Mark Karpov
Distributed under BSD 3 clause license.
- 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.