Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-riff Reference Manual, version 0.0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:44:16 2020 GMT+0.
• Introduction | What cl-riff is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
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
Write functionality by Patrick Stein.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-riff system |
Rob Blackwell
Reads Resource Interchange File Format (RIFF) files.
0.0.2
alexandria
cl-riff.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-riff.asd file | ||
• The cl-riff/package.lisp file | ||
• The cl-riff/riff.lisp file | ||
• The cl-riff/write.lisp file |
Next: The cl-riff/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-riff.asd
cl-riff (system)
Next: The cl-riff/riff․lisp file, Previous: The cl-riff․asd file, Up: Lisp files [Contents][Index]
Next: The cl-riff/write․lisp file, Previous: The cl-riff/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-riff (system)
riff.lisp
read-fourcc (function)
Previous: The cl-riff/riff․lisp file, Up: Lisp files [Contents][Index]
riff.lisp (file)
cl-riff (system)
write.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The riff package |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported functions | ||
• Exported generic functions |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Reads chunk-data as an array of chunk-data-size bytes.
Writes chunk-data as an array of bytes.
write.lisp (file)
Reads chunks from stream until a chunk with chunk-id is found, or NIL meaning not found.
Reads a riff file chunk from stream and returns it as a plist or NIL if end of file.
Reads all the chunks from stream until end of file. Returns a list of chunks.
Reads a RIFF format file named by filespec, returning a list of chunks.
Reads a 2 byte little-endian integer from stream.
Reads a 4 byte little-endian integer from stream.
Writes a riff file chunk to stream.
write.lisp (file)
Writes all the chunks to stream.
write.lisp (file)
Writes a RIFF format file named by filespec from the given chunks.
write.lisp (file)
Writes a 2 byte little-endian integer to stream.
write.lisp (file)
Writes a 4 byte little-endian integer to stream.
write.lisp (file)
Previous: Exported functions, Up: Exported definitions [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: Exported definitions, Up: Definitions [Contents][Index]
• Internal functions |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Reads a four character tag (FOURCC) from stream and returns it as an ASCII string. Returns NIL if end of file.
Writes a four character tag (FOURCC) to stream.
write.lisp (file)
Writes a riff subsection header to stream.
write.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | D F G M R W |
---|
Jump to: | D F G M R W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P R S |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
C | |||
cl-riff : | The cl-riff system | ||
| |||
P | |||
Package, riff : | The riff package | ||
| |||
R | |||
riff : | The riff package | ||
| |||
S | |||
System, cl-riff : | The cl-riff system | ||
|
Jump to: | C P R S |
---|