retro-io

Java library and tool for reading and extracting floppy disk images of 8- and 16-bit computers

Description

The goal of this Java library is to allow to read, extract the contents of, and eventually also write various legacy floppy disk image formats of old 8- and 16-bit computer systems such as Commodore 64, Atari XL, ST or Amiga.

Some of the actual image processing code might not be implemented in this project; it may use other, existing libraries and code and bundle them in one library, with one common API. The "Credits" section below lists projects and people whose code was used to implement this library.

As a simple proof-of-concept and utility, the code will come as an executable Jar and contain a simple GUI tool that allows to load an image file and extract its contents.

Web app planned

A web application which allows to use the library functionality from within a web browser is currently planned.

API / Usage

To use the library in your own code to read an image file, you need the following classes / interface:

ImageHandler - a factory-provided implementation of a class that reads the image file
VirtualDisk - a POJO representation of the disk's contents, as read by the ImageHandler
VirtualDirectory - Allows to iterate through the disks' contents
VirtualFile - Gives access to the details and contents of a file.

Example for reading an Atari ST ".ST" image file and accessing its root directory:

ImageHandler handler = ImageHandlerFactory.get(ImageType.atarist_ST);
VirtualDisk stDisk = handler.loadImage(imageFile);
VirtualDirectory root = stDisk.getRootContents();
root.getContents().forEach(f -> System.out.println("Entry: " + f.getName() + ", is file: " + f.isFile()));

Then extract the contents into the local filesystem with

stDisk.exportToDirectory(new File("/tmp", "unpacked"));

Or export then into a .zip archive with

stDisk.exportAsZip(new File("/tmp", stDisk.getName() + ".zip"));

or send the zip to any output stream with

stDisk.exportAsZip(new FileOutputStream("/tmp/stuff.zip"));

Get the contents of a single "VirtualFile" file entry with "getContents()":

VirtualFile entry = ...
byte[] fileContents = entry.getContents().array();

Credits

https://github.com/waldheinz/fat32-lib - Great library for processing FAT images (DOS and Atari ST).
https://github.com/steffest/ADF-reader - JavaScript ADF reader which I used as a template for my Java code.
http://dangan.g.dgdg.jp/ - Java LHA/LZH library

Status / Disk Image Format Support

Currently supported disk image formats are:

MS DOS (.IMG)
Atari ST (.ST, .MSA)
Commodore Amiga (.ADF)
Commodore 64 (.D64)

NOTE: Support may not be 100%; there may be compatibility issues with some images that still need to be ironed out.

Planned for the future / currently looking into:

Atari XL (.ATR)
Commodore 64 Tapes (.T64)

Future releases might include write support (at least for some formats). Of course any contributions to include support for any missing retro system floppy format is welcome.

Build

This project requires Java 8 and Gradle to build it (I will probably add a Maven POM later too). To just compile it and run all the tests, run

$ gradle build

To build the fat, executable Jar with the extractor tool, run

$ gradle build shadowJar

Then run the extractor tool with this command:

$ java -jar build\libs\retro-io-1.0-SNAPSHOT-all.jar

Install to local Maven repository

To build the library and install it in your local Maven repository, run

$ gradle publishToMavenLocal

Maven Dependency

  <dependency>
      <groupId>org.retro.common</groupId>
      <artifactId>retro-io</artifactId>
  </dependency>

marcelschoen/retro-io