This is the cl-riff Reference Manual, version 0.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 04:16:15 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-riffReads Resource Interchange File Format (RIFF) files.
Rob Blackwell
0.0.2
alexandria (system).
package.lisp (file).
riff.lisp (file).
write.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-riff/riff.lisppackage.lisp (file).
cl-riff (system).
default-chunk-data-reader (function).
find-riff-chunk (function).
read-riff-chunk (function).
read-riff-chunks (function).
read-riff-file (function).
read-u2 (function).
read-u2* (function).
read-u4 (function).
read-u4* (function).
riff-chunk-data (generic function).
riff-chunk-data-end (method).
riff-chunk-data-size (generic function).
riff-chunk-data-start (method).
riff-chunk-id (generic function).
riff-file-type (generic function).
read-fourcc (function).
read-fourcc* (function).
cl-riff/write.lispriff.lisp (file).
cl-riff (system).
default-chunk-data-writer (function).
write-riff-chunk (function).
write-riff-chunks (function).
write-riff-file (function).
write-u2 (function).
write-u4 (function).
write-fourcc (function).
write-riff-section (function).
Packages are listed by definition order.
riffalexandria.
common-lisp.
default-chunk-data-reader (function).
default-chunk-data-writer (function).
find-riff-chunk (function).
read-riff-chunk (function).
read-riff-chunks (function).
read-riff-file (function).
read-u2 (function).
read-u2* (function).
read-u4 (function).
read-u4* (function).
riff-chunk-data (generic function).
riff-chunk-data-end (generic function).
riff-chunk-data-size (generic function).
riff-chunk-data-start (generic function).
riff-chunk-id (generic function).
riff-file-type (generic function).
write-riff-chunk (function).
write-riff-chunks (function).
write-riff-file (function).
write-u2 (function).
write-u4 (function).
read-fourcc (function).
read-fourcc* (function).
write-fourcc (function).
write-riff-section (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Reads chunk-data from STREAM as an array of CHUNK-DATA-SIZE bytes. Second argument CHUNK-ID is ignored.
Writes chunk-data as an array of bytes.
riff.
Reads chunks from stream until a chunk with chunk-id is found, or nil meaning not found. Optional keyword FORMAT defaults to nil to detect the format from the file, otherwise :riff, :rifx or :xfir to specify the format.
Read a riff file chunk from STREAM and return it as a
plist or nil if end of file. Optional keyword FORMAT
nil to accept "RIFF", "RIFX" or "XFIR"
as the chunk id and process accordingly; otherwise
:riff (default), :rifx or :xfir to specify the format.
Chunks and subchunks are returned indiscriminately -
discerning subchunk structure is up to the caller.
First returned value is a plist keyed by :chunk-id,
:chunk-data-size and either :file-type or :chunk-data.
Second returned value is the actual format as a keyword.
Reads all the chunks from STREAM until end of file. Returns a list of chunks. Optional keyword FORMAT defaults to nil to detect the format from the stream, otherwise :riff, :rifx or :xfir to specify the format.
Reads a riff format file named by FILESPEC, returning a list of chunks. Optional keyword FORMAT defaults to nil to detect the format from the file, otherwise :riff, :rifx or :xfir to specify the format.
Reads a 2 byte little-endian integer from STREAM.
Reads a 2 byte big-endian integer from STREAM.
Reads a 4 byte little-endian integer from STREAM.
Reads a 4 byte big-endian integer from STREAM. Used with rifx and xfir formats.
Writes a riff file chunk to stream.
riff.
Writes all the chunks to stream.
riff.
Writes a RIFF format file named by filespec from the given chunks.
riff.
Writes a 2 byte little-endian integer to stream.
riff.
Writes a 4 byte little-endian integer to stream.
riff.
Returns a byte array being the data in the riff CHUNK.
Returns the size of the riff CHUNK data.
Returns the chunk-id of a riff CHUNK - a four character ascii tag.
Returns a four character riff file type - e.g. "WAVE"
Reads a four character tag (fourcc) from STREAM and returns it as an ascii string. Returns nil at end of file.
Reads a four character tag (fourcc) from STREAM and returns it as
a reversed ascii string. Returns nil at end of file.
Used with xfir format.
Writes a four character tag (FOURCC) to stream.
riff.
Writes a riff subsection header to stream.
riff.
| Jump to: | D F G M R W |
|---|
| Jump to: | D F G M R W |
|---|
| Jump to: | C F P R S W |
|---|
| Jump to: | C F P R S W |
|---|