wave

Work with WAVE and RF64 files

Version on this page:	0.1.5
LTS Haskell 22.39:	0.2.1@rev:1
Stackage Nightly 2024-10-31:	0.2.1@rev:1
Latest on Hackage:	0.2.1@rev:1

See all snapshots wave appears in

BSD-3-Clause licensed and maintained by Mark Karpov

This version can be pinned in stack with:wave-0.1.5@sha256:0da3d5a2fdff5bee9c9b020ef0dfdee641309d013662712169daa027f5490048,2196

Module documentation for 0.1.5

Codec
- Codec.Audio
  - Codec.Audio.Wave

Depends on 6 packages(full list with versions):

base, bytestring, cereal, containers, data-default-class, transformers

Used by 1 package in lts-7.24(full list with versions):

flac

Wave

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 in the Wave record and do not allow user to specify it. We provide, however, a way to calculate it given Wave record, see waveBlockAlign. 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 receives a 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 fmt and 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.

Motivation

I needed a way to work with WAVE files to finish my flac package and for analyzing input data in WAVE format in general. The existing solutions (WAVE, 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).

This wave package is the first serious solution in Haskell that allows to work with WAVE data safely and efficiently.

Limitations

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.

Contribution

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.

License

Distributed under BSD 3 clause license.

Changes

Wave 0.1.5

Improved documentation and metadata.

Wave 0.1.4

The library now doesn’t write zero extra format information size when fmt chunk is not extensible. Previously it wrote zero size.

Wave 0.1.3

Adjust and document guessing of channel mask from number of channels alone for files with non-extensible fmt chunks.

Wave 0.1.2

Switched to using withBinaryFile instead of withFile, because the latter does nasty conversions on Windows, see docs for openBinaryFile.

Wave 0.1.1

Added *.rf64 audio samples to the distribution to allow the tests pass.

Wave 0.1.0

Initial release.