Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-riff Reference Manual, version 0.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:07:15 2022 GMT+0.
Next: Systems, Previous: The cl-riff Reference Manual, Up: The cl-riff Reference Manual [Contents][Index]
The Resource Interchange File Format (RIFF) is a generic file container format for storing data in tagged chunks. It is primarily used to store multimedia such as sound and video, though it may also be used to store any arbitrary data.
I wrote this code as a cross-platform way of processing WAV audio files. (See cl-wav).
Use read-riff-file to load a whole file, returning it's content as a list of chunks, where each chunk is a plist.
Alternatively, open the stream yourself and call read-chunk successively until NIL.
Chunks are represented as plists, with accessor methods defined for chunk-id, chunk-data-size, chunk-data and file-type.
> (ql:quickload :cl-riff)
> (riff:read-riff-file "c:/windows/media/ding.wav")
...
> (riff:riff-file-type (first *))
"WAVE"
> (riff:write-riff-file (riff:read-riff-file "c:/windows/media/ding.wav")
"c:/windows/media/ding-copy.wav")
Resource Interchange File Format, Wikipedia
Resource Interchange File Format Services, MSDN
Resource Interchange File Format (RIFF), MSDN
Resource Interchange File Format (RIFF)
Write functionality by Patrick Stein. RIFX and XFIR detection and reading by Devon Sean McCullough.
Next: Files, Previous: Introduction, Up: The cl-riff Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Reads Resource Interchange File Format (RIFF) files.
Rob Blackwell
0.0.2
alexandria (system).
Next: Packages, Previous: Systems, Up: The cl-riff Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-riff/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-riff (system).
Next: cl-riff/riff.lisp, Previous: cl-riff/cl-riff.asd, Up: Lisp [Contents][Index]
Next: cl-riff/write.lisp, Previous: cl-riff/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
cl-riff (system).
Previous: cl-riff/riff.lisp, Up: Lisp [Contents][Index]
riff.lisp (file).
cl-riff (system).
Next: Definitions, Previous: Files, Up: The cl-riff Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: Indexes, Previous: Packages, Up: The cl-riff Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
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.
Previous: Ordinary functions, Up: Public Interface [Contents][Index]
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"
Previous: Public Interface, Up: Definitions [Contents][Index]
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.
Previous: Definitions, Up: The cl-riff Reference Manual [Contents][Index]
| 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 |
|---|