The cl-riff Reference Manual

Table of Contents

The cl-riff Reference Manual

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.

1 Introduction

cl-riff

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.

Example

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

References

Resource Interchange File Format, Wikipedia

Resource Interchange File Format Services, MSDN

Resource Interchange File Format (RIFF), MSDN

Contributors

Write functionality by Patrick Stein.

2 Systems

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

2.1 cl-riff

Author

Rob Blackwell

Description

Reads Resource Interchange File Format (RIFF) files.

Version

0.0.2

Dependency

alexandria

Source

cl-riff.asd (file)

Components

• package.lisp (file)
• riff.lisp (file)
• write.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-riff.asd

Location

cl-riff.asd

Systems

cl-riff (system)

3.1.2 cl-riff/package.lisp

Parent

cl-riff (system)

Location

package.lisp

Packages

riff

3.1.3 cl-riff/riff.lisp

Dependency

package.lisp (file)

Parent

cl-riff (system)

Location

riff.lisp

Exported Definitions

• 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-u4 (function)
• riff-chunk-data (generic function)
• riff-chunk-data (method)
• riff-chunk-data-end (method)
• riff-chunk-data-size (generic function)
• riff-chunk-data-size (method)
• riff-chunk-data-start (method)
• riff-chunk-id (generic function)
• riff-chunk-id (method)
• riff-file-type (generic function)
• riff-file-type (method)

Internal Definitions

read-fourcc (function)

3.1.4 cl-riff/write.lisp

Dependency

riff.lisp (file)

Parent

cl-riff (system)

Location

write.lisp

Exported Definitions

• default-chunk-data-writer (function)
• write-riff-chunk (function)
• write-riff-chunks (function)
• write-riff-file (function)
• write-u2 (function)
• write-u4 (function)

Internal Definitions

• write-fourcc (function)
• write-riff-section (function)

4 Packages

Packages are listed by definition order.

4.1 riff

Source

package.lisp (file)

Use List

• alexandria
• common-lisp

Exported Definitions

• 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-u4 (function)
• riff-chunk-data (generic function)
• riff-chunk-data (method)
• riff-chunk-data-end (generic function)
• riff-chunk-data-end (method)
• riff-chunk-data-size (generic function)
• riff-chunk-data-size (method)
• riff-chunk-data-start (generic function)
• riff-chunk-data-start (method)
• riff-chunk-id (generic function)
• riff-chunk-id (method)
• riff-file-type (generic function)
• riff-file-type (method)
• write-riff-chunk (function)
• write-riff-chunks (function)
• write-riff-file (function)
• write-u2 (function)
• write-u4 (function)

Internal Definitions

• read-fourcc (function)
• write-fourcc (function)
• write-riff-section (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: default-chunk-data-reader STREAM CHUNK-ID CHUNK-DATA-SIZE

Reads chunk-data as an array of chunk-data-size bytes.

Package

riff

Source

riff.lisp (file)

Function: default-chunk-data-writer CHUNK-ID CHUNK-DATA STREAM &key START END

Writes chunk-data as an array of bytes.

Package

riff

Source

write.lisp (file)

Function: find-riff-chunk STREAM CHUNK-ID &key CHUNK-DATA-READER

Reads chunks from stream until a chunk with chunk-id is found, or NIL meaning not found.

Package

riff

Source

riff.lisp (file)

Function: read-riff-chunk STREAM &key CHUNK-DATA-READER

Reads a riff file chunk from stream and returns it as a plist or NIL if end of file.

Package

riff

Source

riff.lisp (file)

Function: read-riff-chunks STREAM &key CHUNK-DATA-READER

Reads all the chunks from stream until end of file. Returns a list of chunks.

Package

riff

Source

riff.lisp (file)

Function: read-riff-file FILESPEC &key CHUNK-DATA-READER

Reads a RIFF format file named by filespec, returning a list of chunks.

Package

riff

Source

riff.lisp (file)

Function: read-u2 STREAM

Reads a 2 byte little-endian integer from stream.

Package

riff

Source

riff.lisp (file)

Function: read-u4 STREAM

Reads a 4 byte little-endian integer from stream.

Package

riff

Source

riff.lisp (file)

Function: write-riff-chunk CHUNK-ID CHUNK-DATA STREAM &key CHUNK-DATA-WRITER START END

Writes a riff file chunk to stream.

Package

riff

Source

write.lisp (file)

Function: write-riff-chunks CHUNKS STREAM &key CHUNK-DATA-WRITER

Writes all the chunks to stream.

Package

riff

Source

write.lisp (file)

Function: write-riff-file CHUNKS FILESPEC &key CHUNK-DATA-WRITER

Writes a RIFF format file named by filespec from the given chunks.

Package

riff

Source

write.lisp (file)

Function: write-u2 U2 STREAM

Writes a 2 byte little-endian integer to stream.

Package

riff

Source

write.lisp (file)

Function: write-u4 U4 STREAM

Writes a 4 byte little-endian integer to stream.

Package

riff

Source

write.lisp (file)

5.1.2 Generic functions

Generic Function: riff-chunk-data CHUNK

Returns a byte array being the data in the riff chunk.

Package

riff

Source

riff.lisp (file)

Methods

Method: riff-chunk-data (CHUNK cons)

Generic Function: riff-chunk-data-end CHUNK

Package

riff

Methods

Method: riff-chunk-data-end CHUNK

Source

riff.lisp (file)

Generic Function: riff-chunk-data-size CHUNK

Returns the size of the riff chunk data.

Package

riff

Source

riff.lisp (file)

Methods

Method: riff-chunk-data-size (CHUNK cons)

Generic Function: riff-chunk-data-start CHUNK

Package

riff

Methods

Method: riff-chunk-data-start (CHUNK cons)

Source

riff.lisp (file)

Generic Function: riff-chunk-id CHUNK

Returns the chunk-id of a riff chunk - a four character Ascii tag.

Package

riff

Source

riff.lisp (file)

Methods

Method: riff-chunk-id (CHUNK cons)

Generic Function: riff-file-type CHUNK

Returns a four character riff file type - e.g. "WAVE"

Package

riff

Source

riff.lisp (file)

Methods

Method: riff-file-type (CHUNK cons)

5.2 Internal definitions

5.2.1 Functions

Function: read-fourcc STREAM

Reads a four character tag (FOURCC) from stream and returns it as an ASCII string. Returns NIL if end of file.

Package

riff

Source

riff.lisp (file)

Function: write-fourcc FOURCC STREAM

Writes a four character tag (FOURCC) to stream.

Package

riff

Source

write.lisp (file)

Function: write-riff-section CHUNK-ID SECTION-TYPE CHUNK-DATA-SIZE STREAM

Writes a riff subsection header to stream.

Package

riff

Source

write.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types