jspiel
The jspiel package implements a set of types and functions for manipulating
RIFF files. It provides efficient parsing and serialization of RIFF files.
Features
- Ultra-efficient memory-mapped RIFF parsing.
- Safe, easy, and correct lazy RIFF file output with chunk streaming.
- Command-line tools and API.
- Strongly-typed interfaces with a heavy emphasis on immutable value types.
- Fully documented (JavaDoc).
- Example code included.
- OSGi-ready
- JPMS-ready
- ISC license.
- High-coverage automated test suite.
Usage
Reading
Memory-map a RIFF file and use a RiffFileParserType to obtain the RIFF
structure of the file:
final var parsers =
ServiceLoader.load(RiffFileParserProviderType.class)
.findFirst()
.orElseThrow(() -> new IllegalStateException("No RIFF file parser service available"));
try (var channel = FileChannel.open(path, READ)) {
final var map = channel.map(READ_ONLY, 0L, channel.size());
final var parser = parsers.createForByteBuffer(this.path.toUri(), map);
final var file = parser.parse();
for (final var chunk : file.chunks()) {
// Examine chunks and use the information to seek the channel
// to different offsets within the chunks to obtain data.
//
// The chunks form a tree structure and have full parent/child
// connectivity information.
}
}
Writing
Use a RiffFileBuilderType to express the RIFF structure of the intended file,
and then pass the built description to a RiffFileWriterType to serialize it.
final var builders =
ServiceLoader.load(RiffFileBuilderProviderType.class)
.findFirst()
.orElseThrow(() -> new IllegalStateException("No RIFF file builder service available"));
final var writers =
ServiceLoader.load(RiffFileWriterProviderType.class)
.findFirst()
.orElseThrow(() -> new IllegalStateException("No RIFF file writer service available"));
// Create a little-endian RIFF file description
final var builder =
this.builders()
.create(LITTLE_ENDIAN);
// The root chunk of the RIFF file must be RIFF, and has an "io7m" form
// in this case.
try (var root = builder.setRootChunk(RiffChunkID.of("RIFF"), "io7m")) {
// The AAAA chunk is variable-length; the given writer function
// can write as much data as it likes. The writer function is
// presented with an NIO seekable byte channel interface where position 0
// on the channel represents the start of the data section in the
// chunk.
try (var c = root.addSubChunk(RiffChunkID.of("AAAA"))) {
c.setDataWriter(data -> data.write(...));
}
// The BBBB chunk is declared to have a length of 27 bytes; the given
// writer function can write at most 27 bytes (and writing will be
// terminated with an exception if it tries to write more). The library
// will zero-pad any space that the writer does not use.
//
// The library also takes care of adding the padding
// byte required by the RIFF specification (because 27 is not evenly
// divisible into 16-bit words and so must be padded to 28 bytes).
try (var c = root.addSubChunk(RiffChunkID.of("BBBB"))) {
c.setSize(27L);
c.setDataWriter(data -> data.write(...));
}
// The LIST chunk with form "cwss" contains three subchunks of varying
// types and sizes.
try (var c = root.addSubChunk(RiffChunkID.of("LIST"))) {
c.setForm("cwss");
try (var d = c.addSubChunk(RiffChunkID.of("cw05"))) {
d.setSize(5L);
d.setDataWriter(data -> data.write(...));
}
try (var d = c.addSubChunk(RiffChunkID.of("cw10"))) {
d.setSize(10L);
d.setDataWriter(data -> data.write(...));
}
try (var d = c.addSubChunk(RiffChunkID.of("cw20"))) {
d.setSize(20L);
d.setDataWriter(data -> data.write(...));
}
}
}
// Build the description and serialize it to the given byte channel.
// The writer functions specified in the description are called as the
// file is serialized.
final var description = builder.build();
try (final var channel = FileChannel.open(file, TRUNCATE_EXISTING, WRITE, CREATE)) {
final var writer = writers.createForChannel(URI.create(file.toUri()), description, channel);
writer.write();
}
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.0.
1.0.0 Release (2024-05-16Z)
- Initial public release.
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.jspiel</group> <artifactId>com.io7m.jspiel.api</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.jspiel</group> <artifactId>com.io7m.jspiel.tests</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.jspiel</group> <artifactId>com.io7m.jspiel.vanilla</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.jspiel</group> <artifactId>com.io7m.jspiel.cmdline</artifactId> <version>1.0.0</version> </dependency>
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.0.1-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/jspiel
$ git clone --recursive https://www.github.com/io7m-com/jspiel
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.