The cl-wave-file-writer Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-wave-file-writer Reference Manual

This is the cl-wave-file-writer Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 12:54:45 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 cl-wave-file-writer

Maintainer

Oliver <frechmatz@gmx.de>

Author

Oliver <frechmatz@gmx.de>

Home Page

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

License

MIT

Description

A wave file writer

Long Description

A wave file writer

Version

1.0.0

Source

cl-wave-file-writer.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

2 Modules

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


Previous: , Up: Modules   [Contents][Index]

2.1 cl-wave-file-writer/src

Parent

cl-wave-file-writer (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-wave-file-writer.asd

Location

cl-wave-file-writer.asd

Systems

cl-wave-file-writer (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/packages.lisp

Packages

cl-wave-file-writer


Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/wave-file-writer.lisp

Exported Definitions

make-writer (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-wave-file-writer

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

make-writer (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 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 (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *sample-width-mapping*
Package

cl-wave-file-writer

Source

wave-file-writer.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: clip-value VALUE
Package

cl-wave-file-writer

Source

wave-file-writer.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: value-to-16bit-signed VALUE

value: -1.0 ... 1.0

Package

cl-wave-file-writer

Source

wave-file-writer.lisp (file)

Function: value-to-24bit-signed VALUE

value: -1.0 ... 1.0

Package

cl-wave-file-writer

Source

wave-file-writer.lisp (file)

Function: value-to-8bit-unsigned VALUE

value: -1.0 ... 1.0

Package

cl-wave-file-writer

Source

wave-file-writer.lisp (file)

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 (file)

Function: write-tag STREAM TAG

Writes a 4-character ASCII tag to the stream.

Package

cl-wave-file-writer

Source

wave-file-writer.lisp (file)

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 (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-wave-file-writer.asd: The cl-wave-file-writer․asd file
cl-wave-file-writer/src: The cl-wave-file-writer/src module
cl-wave-file-writer/src/packages.lisp: The cl-wave-file-writer/src/packages․lisp file
cl-wave-file-writer/src/wave-file-writer.lisp: The cl-wave-file-writer/src/wave-file-writer․lisp file

F
File, Lisp, cl-wave-file-writer.asd: The cl-wave-file-writer․asd file
File, Lisp, cl-wave-file-writer/src/packages.lisp: The cl-wave-file-writer/src/packages․lisp file
File, Lisp, cl-wave-file-writer/src/wave-file-writer.lisp: The cl-wave-file-writer/src/wave-file-writer․lisp file

L
Lisp File, cl-wave-file-writer.asd: The cl-wave-file-writer․asd file
Lisp File, cl-wave-file-writer/src/packages.lisp: The cl-wave-file-writer/src/packages․lisp file
Lisp File, cl-wave-file-writer/src/wave-file-writer.lisp: The cl-wave-file-writer/src/wave-file-writer․lisp file

M
Module, cl-wave-file-writer/src: The cl-wave-file-writer/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   F   M   V   W  
Index Entry  Section

C
clip-value: Internal macros

F
Function, make-writer: Exported functions
Function, value-to-16bit-signed: Internal functions
Function, value-to-24bit-signed: Internal functions
Function, value-to-8bit-unsigned: Internal functions
Function, write-sint: Internal functions
Function, write-tag: Internal functions
Function, write-uint: Internal functions

M
Macro, clip-value: Internal macros
make-writer: Exported functions

V
value-to-16bit-signed: Internal functions
value-to-24bit-signed: Internal functions
value-to-8bit-unsigned: Internal functions

W
write-sint: Internal functions
write-tag: Internal functions
write-uint: Internal functions

Jump to:   C   F   M   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*sample-width-mapping*: Internal special variables

S
Special Variable, *sample-width-mapping*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-wave-file-writer: The cl-wave-file-writer system
cl-wave-file-writer: The cl-wave-file-writer package

P
Package, cl-wave-file-writer: The cl-wave-file-writer package

S
System, cl-wave-file-writer: The cl-wave-file-writer system

Jump to:   C   P   S