Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-wav Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:56:39 2020 GMT+0.
| • Introduction | What cl-wav is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
Waveform audio file format (WAV files) uses Resource Interchange File Format (RIFF) to store audio.
This project provides a cross platform reader for the WAV file format, implemented in Common Lisp.
Optionally, you can customise the chunk data reader, for example see wrap-data-chunk-data-samples-reader to read the data as an array of float samples.
N.B. The data from WAV files can be quite long and can be very slow to print out in a REPL. You probably don't want to do that.
For large files or streamed files, you can use cl-riff read-riff-chunk to read chunks on demand, whilst still using the chunk-data-readers provided here.
N.B. cl-wav has only been tested with a limited range of WAV files.
> (ql:quickload :cl-wav)
> (wav:read-wav-file "c:/windows/media/ding.wav")
...
> (second *)
(:CHUNK-ID "fmt " :CHUNK-DATA-SIZE 16 :CHUNK-DATA
(:COMPRESSION-CODE 1 :NUMBER-OF-CHANNELS 2 :SAMPLE-RATE 44100
:AVERAGE-BYTES-PER-SECOND 176400 :BLOCK-ALIGN 4 :SIGNIFICANT-BITS-PER-SAMPLE
16))
> (wav:read-wav-file "c:/windows/media/ding.wav" :chunk-data-reader (wav:wrap-data-chunk-data-samples-reader))
...
Currently only supports reading files, not writing.
Wave File Format, The Sonic Spot
Rob Blackwell
February 2014
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-wav system |
Rob Blackwell
Reads Wave Audio File Format, WAV files.
0.0.1
cl-wav.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The cl-wav.asd file | ||
| • The cl-wav/package.lisp file | ||
| • The cl-wav/wav.lisp file |
Next: The cl-wav/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-wav.asd
cl-wav (system)
Next: The cl-wav/wav․lisp file, Previous: The cl-wav․asd file, Up: Lisp files [Contents][Index]
Previous: The cl-wav/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-wav (system)
wav.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The wav package |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported constants | ||
| • Exported functions |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Previous: Exported constants, Up: Exported definitions [Contents][Index]
Returns an array of float samples by reading and converting the underlying data sample representation.
Reads and parses the chunk-data from a format chunk.
Reads a wav file from filespec.
Creates a new chunk-data-reader function that wraps the supplied chunk-data-reader with the ability to read data chunks as floating point samples. Can be used as an alternative to the default chunk-data-reader when calling read-wav-file.
Creates a new chunk-data-reader function that wraps the supplied chunk-data-reader with the ability to parse format chunks.
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal functions |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Reads a 2 byte signed integer sample from stream.
Reads a 2 byte sample from stream, returning a corresponding float between -1.0 and 1.0.
Reads a 1 byte sample from stream, returning a corresponding float between -1.0 and 1.0.
Returns an array of float samples corresponding to the 2 byte signed samples read from data chunk.
Returns an array of float samples corresponding to the 1 byte samples read from data chunk.
Creates a new chunk-data-writer that wraps the supplied chunk-data-writer with the ability to emit format chunks.
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | D F R S U W |
|---|
| Jump to: | D F R S U W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
+
C S |
|---|
| Jump to: | *
+
C S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C P S W |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| C | |||
cl-wav: | The cl-wav system | ||
| | |||
| P | |||
Package, wav: | The wav package | ||
| | |||
| S | |||
System, cl-wav: | The cl-wav system | ||
| | |||
| W | |||
wav: | The wav package | ||
| | |||
| Jump to: | C P S W |
|---|