The cl-wav Reference Manual

This is the cl-wav Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:38:32 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-wav

Reads Wave Audio File Format, WAV files.

Author

Rob Blackwell

Version

0.0.1

Dependencies
  • alexandria (system).
  • cl-riff (system).
Source

cl-wav.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-wav/cl-wav.asd

Source

cl-wav.asd.

Parent Component

cl-wav (system).

ASDF Systems

cl-wav.


3.1.2 cl-wav/package.lisp

Source

cl-wav.asd.

Parent Component

cl-wav (system).

Packages

wav.


3.1.3 cl-wav/wav.lisp

Dependency

package.lisp (file).

Source

cl-wav.asd.

Parent Component

cl-wav (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 wav

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Constants

Constant: +experimental+
Package

wav.

Source

wav.lisp.

Constant: +gsm-610+
Package

wav.

Source

wav.lisp.

Constant: +ima-adpcm+
Package

wav.

Source

wav.lisp.

Constant: +itu-g711-a-law+
Package

wav.

Source

wav.lisp.

Constant: +itu-g711-mu-law+
Package

wav.

Source

wav.lisp.

Constant: +itu-g721+adpcm+
Package

wav.

Source

wav.lisp.

Constant: +itu-g723-adpcm-yamaha+
Package

wav.

Source

wav.lisp.

Constant: +microsoft-adpcm+
Package

wav.

Source

wav.lisp.

Constant: +mpeg+
Package

wav.

Source

wav.lisp.

Constant: +pcmi-uncompressed+
Package

wav.

Source

wav.lisp.

Constant: +unknown+
Package

wav.

Source

wav.lisp.


5.1.2 Ordinary functions

Function: data-chunk-data-samples-reader (stream chunk-id chunk-data-size)

Returns an array of float samples by reading and converting the underlying data sample representation.

Package

wav.

Source

wav.lisp.

Function: format-chunk-data-reader (stream chunk-id chunk-data-size)

Reads and parses the chunk-data from a format chunk.

Package

wav.

Source

wav.lisp.

Function: read-wav-file (filespec &key chunk-data-reader)

Reads a wav file from filespec.

Package

wav.

Source

wav.lisp.

Function: wrap-data-chunk-data-samples-reader (&optional chunk-data-reader)

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.

Package

wav.

Source

wav.lisp.

Function: wrap-format-chunk-data-reader (&optional chunk-data-reader)

Creates a new chunk-data-reader function that wraps the supplied chunk-data-reader with the ability to parse format chunks.

Package

wav.

Source

wav.lisp.

Function: write-wav-file (chunks filespec &key chunk-data-writer)
Package

wav.

Source

wav.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *format-chunk*
Package

wav.

Source

wav.lisp.


5.2.2 Ordinary functions

Function: format-chunk-data-writer (chunk-data stream)
Package

wav.

Source

wav.lisp.

Function: read-s2 (stream)

Reads a 2 byte signed integer sample from stream.

Package

wav.

Source

wav.lisp.

Function: read-s2-sample (stream)

Reads a 2 byte sample from stream, returning a corresponding float between -1.0 and 1.0.

Package

wav.

Source

wav.lisp.

Function: read-u1-sample (stream)

Reads a 1 byte sample from stream, returning a corresponding float between -1.0 and 1.0.

Package

wav.

Source

wav.lisp.

Function: s2-sample-data-chunk-reader (stream chunk-id chunk-data-size)

Returns an array of float samples corresponding to the 2 byte signed samples read from data chunk.

Package

wav.

Source

wav.lisp.

Function: u1-sample-data-chunk-reader (stream chunk-id chunk-data-size)

Returns an array of float samples corresponding to the 1 byte samples read from data chunk.

Package

wav.

Source

wav.lisp.

Function: wrap-format-chunk-data-writer (&optional chunk-data-writer)

Creates a new chunk-data-writer that wraps the supplied chunk-data-writer with the ability to emit format chunks.

Package

wav.

Source

wav.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   D   F   R   S   U   W  
Index Entry  Section

D
data-chunk-data-samples-reader: Public ordinary functions

F
format-chunk-data-reader: Public ordinary functions
format-chunk-data-writer: Private ordinary functions
Function, data-chunk-data-samples-reader: Public ordinary functions
Function, format-chunk-data-reader: Public ordinary functions
Function, format-chunk-data-writer: Private ordinary functions
Function, read-s2: Private ordinary functions
Function, read-s2-sample: Private ordinary functions
Function, read-u1-sample: Private ordinary functions
Function, read-wav-file: Public ordinary functions
Function, s2-sample-data-chunk-reader: Private ordinary functions
Function, u1-sample-data-chunk-reader: Private ordinary functions
Function, wrap-data-chunk-data-samples-reader: Public ordinary functions
Function, wrap-format-chunk-data-reader: Public ordinary functions
Function, wrap-format-chunk-data-writer: Private ordinary functions
Function, write-wav-file: Public ordinary functions

R
read-s2: Private ordinary functions
read-s2-sample: Private ordinary functions
read-u1-sample: Private ordinary functions
read-wav-file: Public ordinary functions

S
s2-sample-data-chunk-reader: Private ordinary functions

U
u1-sample-data-chunk-reader: Private ordinary functions

W
wrap-data-chunk-data-samples-reader: Public ordinary functions
wrap-format-chunk-data-reader: Public ordinary functions
wrap-format-chunk-data-writer: Private ordinary functions
write-wav-file: Public ordinary functions