This is the cl-qoa Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:18:15 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-qoaAn implementation of the Quite Okay Audio format.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/shinmera/cl-qoa.git)
zlib
1.0.0
documentation-utils (system).
binary-structures (system).
package.lisp (file).
format.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-qoa/format.lisppackage.lisp (file).
cl-qoa (system).
channel-layout (function).
channels (method).
channels (method).
convert-wav (function).
decode-file (function).
decode-frame (function).
decode-to-buffer (function).
encode-file (function).
encode-from-buffer (function).
file (structure).
frame (structure).
frames (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
print-object (method).
print-object (method).
print-object (method).
read-file (function).
samplerate (method).
samplerate (method).
samples/channel (method).
samples/channel (method).
write-file (function).
clamp (function).
clamp-16 (function).
compute-frame-size (function).
copy-file (function).
copy-frame (function).
copy-lms (function).
copy-lms* (function).
copy-state (function).
decode-frame/ptr (function).
dequantization-table (constant).
div (function).
encode-frame (function).
file-frames (reader).
(setf file-frames) (writer).
file-p (function).
file-samples (reader).
(setf file-samples) (writer).
frame-channels (reader).
(setf frame-channels) (writer).
frame-length (constant).
frame-p (function).
frame-samplerate (reader).
(setf frame-samplerate) (writer).
frame-samples/channel (reader).
(setf frame-samples/channel) (writer).
frame-size (reader).
(setf frame-size) (writer).
frame-slices (reader).
(setf frame-slices) (writer).
frame-state (reader).
(setf frame-state) (writer).
lms (type).
lms-length (constant).
lms-predict (function).
lms-update (function).
make-file (function).
make-frame (function).
make-lms (function).
make-state (function).
max-channels (constant).
quantization-table (constant).
read-frame (function).
read-io-octet-vector-file (function).
read-io-octet-vector-frame (function).
read-io-stream-file (function).
read-io-stream-frame (function).
reciprocal-table (constant).
scale-factor-table (constant).
slice-length (constant).
slices/frame (constant).
state (structure).
state-channels (reader).
(setf state-channels) (writer).
state-lms (reader).
(setf state-lms) (writer).
state-p (function).
state-samplerate (reader).
(setf state-samplerate) (writer).
state-samples (reader).
(setf state-samples) (writer).
wav-samples (function).
write-frame (function).
write-io-octet-vector-file (function).
write-io-octet-vector-frame (function).
write-io-stream-file (function).
write-io-stream-frame (function).
cl-qoa/documentation.lispformat.lisp (file).
cl-qoa (system).
Packages are listed by definition order.
org.shirakumo.qoacommon-lisp.
org.shirakumo.binary-structures.types.
channel-layout (function).
channels (generic function).
convert-wav (function).
decode-file (function).
decode-frame (function).
decode-to-buffer (function).
encode-file (function).
encode-from-buffer (function).
file (structure).
frame (structure).
frames (generic function).
octet-size (generic function).
read-file (function).
samplerate (generic function).
samples/channel (generic function).
write-file (function).
clamp (function).
clamp-16 (function).
compute-frame-size (function).
copy-file (function).
copy-frame (function).
copy-lms (function).
copy-lms* (function).
copy-state (function).
decode-frame/ptr (function).
dequantization-table (constant).
div (function).
encode-frame (function).
file-frames (reader).
(setf file-frames) (writer).
file-p (function).
file-samples (reader).
(setf file-samples) (writer).
frame-channels (reader).
(setf frame-channels) (writer).
frame-length (constant).
frame-p (function).
frame-samplerate (reader).
(setf frame-samplerate) (writer).
frame-samples/channel (reader).
(setf frame-samples/channel) (writer).
frame-size (reader).
(setf frame-size) (writer).
frame-slices (reader).
(setf frame-slices) (writer).
frame-state (reader).
(setf frame-state) (writer).
lms (type).
lms-length (constant).
lms-predict (function).
lms-update (function).
make-file (function).
make-frame (function).
make-lms (function).
make-state (function).
max-channels (constant).
quantization-table (constant).
read-frame (function).
read-io-octet-vector-file (function).
read-io-octet-vector-frame (function).
read-io-stream-file (function).
read-io-stream-frame (function).
reciprocal-table (constant).
scale-factor-table (constant).
slice-length (constant).
slices/frame (constant).
state (structure).
state-channels (reader).
(setf state-channels) (writer).
state-lms (reader).
(setf state-lms) (writer).
state-p (function).
state-samplerate (reader).
(setf state-samplerate) (writer).
state-samples (reader).
(setf state-samples) (writer).
wav-samples (function).
write-frame (function).
write-io-octet-vector-file (function).
write-io-octet-vector-frame (function).
write-io-stream-file (function).
write-io-stream-frame (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the layout of the channels within the packed sample buffer for a given channel count.
The following speaker types are provided:
:center :left :right :left-front :right-front :subwoofer :left-rear
:right-rear :left-side :right-side
Converts a wav file to a QOA file.
IN should be the path to a RIFF WAVE file with sint16_le encoded audio
samples to convert. OUT should be the path to which the QOA file
should be written.
Returns OUT.
If the source file is not a wave file or does not contain the correct
sample format, an error is signalled.
See ENCODE-FILE
Decodes a QOA file to a sample buffer.
Returns three values:
The sample buffer,
The number of channels of audio,
The samplerate of the audio.
This assumes that the entire file has a constant channel count and
samplerate.
See DECODE-TO-BUFFER
See DECODE-FILE
Decodes a single audio frame to a raw sample buffer.
FRAME must be a FRAME instance, SAMPLES must be a
(SIMPLE-ARRAY (SIGNED-BYTE 16) (*)) and START and END must be indices
into the SAMPLES array denoting the region to fill.
Returns the index into the SAMPLES array up to which samples were
written, same as CL:READ-SEQUENCE.
If the sample buffer is not big enough to contain the entire frame,
START is returned.
See FRAME (type)
Decodes the entire FILE to a raw sample buffer.
FILE must be a FILE, SAMPLES must be a
(SIMPLE-ARRAY (SIGNED-BYTE 16) (*)) or a CFFI:FOREIGN-POINTER and
START and END must be indices into the SAMPLES array denoting the
region to fill. FRAME-START can designate the first frame of the file
that should be decoded.
Returns the index into the SAMPLES array up to which samples were
written, same as CL:READ-SEQUENCE, as well as the index of the next
frame to be decoded.
This assumes that the entire file has a constant channel count and
samplerate.
See FILE (type)
See DECODE-FRAME
Encode a sample buffer and write it to storage immediately.
OUTPUT may be a storage backend supported by WRITE-FILE, or the symbol
VECTOR, in which case a vector of sufficient size is allocated for you
and returned.
See FILE (type)
See ENCODE-FROM-BUFFER
See WRITE-FILE
Creates a FILE from a buffer of audio samples.
SAMPLES must be a (SIMPLE-ARRAY (SIGNED-BYTE 16) (*)), CHANNELS should
be within [1,8], and SAMPLERATE within [1,16777215].
Returns a fresh FILE instance.
See FILE (type)
Reads a QOA file from its binary representation.
The STORAGE may be any storage backend supported by binary-structures.
Returns a fresh FILE instance as well as the index at which reading
stopped, if applicable.
See FILE (type)
Writes a QOA file to its binary representation.
The STORAGE may be any storage backend supported by binary-structures.
It must have enough space available to contain the entire file. To
check this beforehand, you can call OCTET-SIZE.
Returns the index at which writing stopped.
See FILE (type)
See OCTET-SIZE
Returns the number of channels of the file or frame.
See FILE (type)
See FRAME (type)
Returns the vector of FRAME instances of the FILE
See FILE (type)
See FRAME (type)
Returns the octet-size of the QOA file or frame if it were written out.
See FILE (type)
See FRAME (type)
Returns the samplerate of the file or frame in Herz.
See FILE (type)
See FRAME (type)
Returns the number of samples per channel in the file or frame.
See FILE (type)
See FRAME (type)
Representation of an encoded QOA file.
QOA files contain PCM-encoded audio with a 16-bit signed integer representation. Each file is composed out of multiple frames of encoded data, with possibly variable numbers of channels and samplerates per frame, though this is not typically the case.
See OCTET-SIZE
See SAMPLES/CHANNEL
See FRAMES
See SAMPLERATE
See CHANNELS
See READ-FILE
See WRITE-FILE
See ENCODE-FILE
See ENCODE-FROM-BUFFER
See DECODE-FRAME
See DECODE-TO-BUFFER
Representation of an audio frame as part of a QOA file.
A frame contains the encoding of the sample data, a LMS state buffer,
and an array of encoded audio slices.
See OCTET-SIZE
See SAMPLERATE
See CHANNELS
See DECODE-FRAME
See SAMPLES/CHANNEL
See FILE (type)
io-structure-object.
(unsigned-byte 8)
0
(unsigned-byte 24)
0
(unsigned-byte 16)
0
(unsigned-byte 16)
0
(array (simple-array (signed-byte 16) (8)) (*))
(make-array 0 :element-type (quote (simple-array (signed-byte 16) (8))))
(array (unsigned-byte 64) (*))
(make-array 0 :element-type (quote (unsigned-byte 64)))
size.
lms.
structure-object.
(unsigned-byte 8)
2
(unsigned-byte 32)
44100
(unsigned-byte 32)
0
(simple-array org.shirakumo.qoa::lms (8))
(map-into (make-array org.shirakumo.qoa::max-channels) (function org.shirakumo.qoa::make-lms))
| Jump to: | (
C D E F G L M O P R S W |
|---|
| Jump to: | (
C D E F G L M O P R S W |
|---|
| Jump to: | C D F L M Q R S |
|---|
| Jump to: | C D F L M Q R S |
|---|
| Jump to: | C D F L O P S T |
|---|
| Jump to: | C D F L O P S T |
|---|