Project icon

com.io7m.jspiel

Build status Maven Central Codacy Codecov

The jspiel package implements a set of types and functions for manipulating RIFF files. It provides efficient parsing and serialization of RIFF files.

Contents

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.

Releases

The current release is 0.0.3.

Source code and binaries are available from the repository.

Documentation

Documentation for the 0.0.3 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

Reading

Memory-map a RIFF file and use a RiffFileParserType to obtain the RIFF structure of the file:

 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.

 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();
}
]]>

JavaDoc

API documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies:

<dependency>
  <groupId>com.io7m.jspiel</groupId>
  <artifactId>com.io7m.jspiel</artifactId>
  <version>0.0.3</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspiel</groupId>
  <artifactId>com.io7m.jspiel.api</artifactId>
  <version>0.0.3</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspiel</groupId>
  <artifactId>com.io7m.jspiel.tests</artifactId>
  <version>0.0.3</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspiel</groupId>
  <artifactId>com.io7m.jspiel.documentation</artifactId>
  <version>0.0.3</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspiel</groupId>
  <artifactId>com.io7m.jspiel.vanilla</artifactId>
  <version>0.0.3</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspiel</groupId>
  <artifactId>com.io7m.jspiel.cmdline</artifactId>
  <version>0.0.3</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

No formal releases have been made.

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/jspiel

$ git clone https://github.com/io7m/jspiel

License

Copyright ⓒ 2018 Mark Raynsford <code@io7m.com> http://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.

Bug Tracker

The project uses GitHub Issues to track issues.