The cl-wave-file-writer Reference Manual

This is the cl-wave-file-writer Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:31:57 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 cl-wave-file-writer

A wave file writer

Maintainer

Oliver <>

Author

Oliver <>

Home Page

https://github.com/Frechmatz/cl-wave-writer

License

MIT

Long Description

A wave file writer

Version

1.0.1

Source

cl-wave-file-writer.asd.

Child Component

src (module).


2 Modules

Modules are listed depth-first from the system components tree.


2.1 cl-wave-file-writer/src

Source

cl-wave-file-writer.asd.

Parent Component

cl-wave-file-writer (system).

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-wave-file-writer/cl-wave-file-writer.asd

Source

cl-wave-file-writer.asd.

Parent Component

cl-wave-file-writer (system).

ASDF Systems

cl-wave-file-writer.


3.1.2 cl-wave-file-writer/src/packages.lisp

Source

cl-wave-file-writer.asd.

Parent Component

src (module).

Packages

cl-wave-file-writer.


3.1.3 cl-wave-file-writer/src/wave-file-writer.lisp

Dependency

packages.lisp (file).

Source

cl-wave-file-writer.asd.

Parent Component

src (module).

Public Interface

make-writer (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 cl-wave-file-writer

Source

packages.lisp.

Use List

common-lisp.

Public Interface

make-writer (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-writer (&key filename channel-count sample-rate sample-width)

Creates a Wave-File writer. The function has the following arguments:
<ul>
<li>:filename Path of the file to be written. An existing file will be replaced.</li> <li>:channel-count Number of channels.</li>
<li>:sample-rate The sample rate, for example 44100.</li>
<li>:sample-width The width (resolution) of the samples. One of :8Bit, :16Bit, :24Bit</li> </ul>
Returns a property list with the following keys:
<ul>
<li>:open-file A function with no arguments that opens the file.</li>
<li>:close-file A function with no arguments that closes the file.</li> <li>:write-sample A function with one argument that writes a sample.
-1.0 <= sample <= 1.0. Must be called for each channel.</li>
</ul>

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *sample-width-mapping*
Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.


5.2.2 Ordinary functions

Function: value-to-16bit-signed (value)

value: -1.0 ... 1.0

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.

Function: value-to-24bit-signed (value)

value: -1.0 ... 1.0

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.

Function: value-to-8bit-unsigned (value)

value: -1.0 ... 1.0

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.

Function: write-sint (stream sint bytes)

Writes a signed integer to the stream with the specified number of bytes.

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.

Function: write-tag (stream tag)

Writes a 4-character ASCII tag to the stream.

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.

Function: write-uint (stream uint bytes)

Writes an unsigned integer to the stream with the specified number of bytes.

Package

cl-wave-file-writer.

Source

wave-file-writer.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables