Merge.

doc/using.md

@@ -129,6 +129,25 @@ based on the extension:
     geometry will be autodetected if left unspecified. For input files you
     normally have to specify it.
 
+  - `.ldbs`: John Elliott's [LDBS disk image
+    format](http://www.seasip.info/Unix/LibDsk/ldbs.html), which is
+    consumable by the [libdsk](http://www.seasip.info/Unix/LibDsk/) suite of
+    tools. This allows things like variable numbers of sectors per track
+    (e.g. Macintosh or Commodore 64) and also provides information about
+    whether sectors were read correctly. You can use libdsk to convert this
+    to other formats, using a command like this:
+
+    ```
+    $ dsktrans out.ldbs -otype tele out.td0
+    ```
+
+    ...to convert to TeleDisk format. (Note you have to use dsktrans rather
+    than dskconv due to a minor bug in the geometry hadnling.)
+
+    FluxEngine's LDBS support is currently limited to write only, and
+    it doesn't store a lot of the more esoteric LDBS features like format
+    types, timings, and data rates.
+
 ### High density disks
 
 High density disks use a different magnetic medium to low and double density

lib/bytes.cc

@@ -2,6 +2,7 @@
 #include "bytes.h"
 #include "fmt/format.h"
 #include "common/crunch.h"
+#include <fstream>
 #include <zlib.h>
 
 static std::shared_ptr<std::vector<uint8_t>> createVector(unsigned size)
@@ -280,6 +281,16 @@ Bytes Bytes::uncrunch() const
     return output;
 }
 
+void Bytes::writeToFile(const std::string& filename) const
+{
+    std::ofstream f(filename, std::ios::out | std::ios::binary);
+    if (!f.is_open())
+        Error() << fmt::format("cannot open output file '{}'", filename);
+
+    f.write((const char*) cbegin(), size());
+    f.close();
+}
+
 ByteReader Bytes::reader() const
 {
     return ByteReader(*this);

lib/bytes.h

@@ -56,6 +56,8 @@ public:
     ByteReader reader() const;
     ByteWriter writer();
 
+    void writeToFile(const std::string& filename) const;
+
 private:
     std::shared_ptr<std::vector<uint8_t>> _data;
     unsigned _low;

lib/imagewriter/imagewriter.cc

@@ -20,6 +20,8 @@ std::unique_ptr<ImageWriter> ImageWriter::create(const SectorSet& sectors, const
 
     if (ends_with(filename, ".img") || ends_with(filename, ".adf"))
         return createImgImageWriter(sectors, spec);
+	else if (ends_with(filename, ".ldbs"))
+		return createLDBSImageWriter(sectors, spec);
 
     Error() << "unrecognised image filename extension";
     return std::unique_ptr<ImageWriter>();

lib/imagewriter/imagewriter.h

@@ -16,6 +16,8 @@ public:
 private:
     static std::unique_ptr<ImageWriter> createImgImageWriter(
 		const SectorSet& sectors, const ImageSpec& spec);
+    static std::unique_ptr<ImageWriter> createLDBSImageWriter(
+		const SectorSet& sectors, const ImageSpec& spec);
 
 public:
 	virtual void adjustGeometry();

lib/imagewriter/ldbsimagewriter.cc

@@ -0,0 +1,107 @@
+#include "globals.h"
+#include "image.h"
+#include "flags.h"
+#include "dataspec.h"
+#include "sector.h"
+#include "sectorset.h"
+#include "imagewriter/imagewriter.h"
+#include "fmt/format.h"
+#include "ldbs.h"
+#include <algorithm>
+#include <iostream>
+#include <fstream>
+
+class LDBSImageWriter : public ImageWriter
+{
+public:
+	LDBSImageWriter(const SectorSet& sectors, const ImageSpec& spec):
+		ImageWriter(sectors, spec)
+	{}
+
+	void writeImage()
+	{
+        LDBS ldbs;
+
+		unsigned numCylinders = spec.cylinders;
+		unsigned numHeads = spec.heads;
+		unsigned numSectors = spec.sectors;
+		unsigned numBytes = spec.bytes;
+		std::cout << fmt::format("writing {} tracks, {} heads, {} sectors, {} bytes per sector",
+						numCylinders, numHeads,
+						numSectors, numBytes)
+				<< std::endl;
+
+        Bytes trackDirectory;
+        ByteWriter trackDirectoryWriter(trackDirectory);
+        int trackDirectorySize = 0;
+        trackDirectoryWriter.write_le16(0);
+
+		for (int track = 0; track < numCylinders; track++)
+		{
+			for (int head = 0; head < numHeads; head++)
+			{
+                Bytes trackHeader;
+                ByteWriter trackHeaderWriter(trackHeader);
+
+                int actualSectors = 0;
+				for (int sectorId = 0; sectorId < numSectors; sectorId++)
+				{
+					const auto& sector = sectors.get(track, head, sectorId);
+					if (sector)
+                        actualSectors++;
+                }
+
+                trackHeaderWriter.write_le16(0x000C); /* offset of sector headers */
+                trackHeaderWriter.write_le16(0x0012); /* length of each sector descriptor */
+                trackHeaderWriter.write_le16(actualSectors);
+                trackHeaderWriter.write_8(0); /* data rate unknown */
+                trackHeaderWriter.write_8(0); /* recording mode unknown */
+                trackHeaderWriter.write_8(0); /* format gap length */
+                trackHeaderWriter.write_8(0); /* filler byte */
+                trackHeaderWriter.write_le16(0); /* approximate track length */
+
+				for (int sectorId = 0; sectorId < numSectors; sectorId++)
+				{
+					const auto& sector = sectors.get(track, head, sectorId);
+					if (sector)
+					{
+                        uint32_t sectorLabel = (('S') << 24) | ((track & 0xff) << 16) | (head << 8) | sectorId;
+                        uint32_t sectorAddress = ldbs.put(sector->data, sectorLabel);
+
+                        trackHeaderWriter.write_8(track);
+                        trackHeaderWriter.write_8(head);
+                        trackHeaderWriter.write_8(sectorId);
+                        trackHeaderWriter.write_8(0); /* power-of-two size */
+                        trackHeaderWriter.write_8((sector->status == Sector::OK) ? 0x00 : 0x20); /* 8272 status 1 */
+                        trackHeaderWriter.write_8(0); /* 8272 status 2 */
+                        trackHeaderWriter.write_8(1); /* number of copies */
+                        trackHeaderWriter.write_8(0); /* filler byte */
+                        trackHeaderWriter.write_le32(sectorAddress);
+                        trackHeaderWriter.write_le16(0); /* trailing bytes */
+                        trackHeaderWriter.write_le16(0); /* approximate offset */
+                        trackHeaderWriter.write_le16(sector->data.size());
+					}
+				}
+
+                uint32_t trackLabel = (('T') << 24) | ((track & 0xff) << 16) | ((track >> 8) << 8) | head;
+                uint32_t trackHeaderAddress = ldbs.put(trackHeader, trackLabel);
+                trackDirectoryWriter.write_be32(trackLabel);
+                trackDirectoryWriter.write_le32(trackHeaderAddress);
+                trackDirectorySize++;
+			}
+		}
+
+        trackDirectoryWriter.seek(0);
+        trackDirectoryWriter.write_le16(trackDirectorySize);
+
+        uint32_t trackDirectoryAddress = ldbs.put(trackDirectory, LDBS_TRACK_BLOCK);
+        Bytes data = ldbs.write(trackDirectoryAddress);
+        data.writeToFile(spec.filename);
+    }
+};
+
+std::unique_ptr<ImageWriter> ImageWriter::createLDBSImageWriter(
+	const SectorSet& sectors, const ImageSpec& spec)
+{
+    return std::unique_ptr<ImageWriter>(new LDBSImageWriter(sectors, spec));
+}

lib/ldbs.cc

@@ -0,0 +1,81 @@
+#include "globals.h"
+#include <string.h>
+#include "bytes.h"
+#include "ldbs.h"
+#include "fmt/format.h"
+
+LDBS::LDBS()
+{}
+
+uint32_t LDBS::put(const Bytes& data, uint32_t type)
+{
+    uint32_t address = top;
+    Block& block = blocks[address];
+    block.type = type;
+    block.data = data;
+
+    top += data.size() + 20;
+    return address;
+}
+
+uint32_t LDBS::read(const Bytes& data)
+{
+    ByteReader br(data);
+
+    br.seek(0);
+    if ((br.read_be32() != LDBS_FILE_MAGIC)
+        || (br.read_be32() != LDBS_FILE_TYPE))
+        Error() << "not a valid LDBS file";
+
+    uint32_t address = br.read_le32();
+    br.skip(4);
+    uint32_t trackDirectory = br.read_le32();
+
+    while (address)
+    {
+        br.seek(address);
+        if (br.read_be32() != LDBS_BLOCK_MAGIC)
+            Error() << fmt::format("invalid block at address 0x{:x}", address);
+
+        Block& block = blocks[address];
+        block.type = br.read_be32();
+
+        uint32_t size = br.read_le32();
+        br.skip(4);
+        address = br.read_le32();
+
+        block.data.writer().append(br.read(size));
+    }
+        
+    top = data.size();
+    return trackDirectory;
+}
+
+const Bytes LDBS::write(uint32_t trackDirectory)
+{
+    Bytes data(top);
+    ByteWriter bw(data);
+
+    uint32_t previous = 0;
+    for (const auto& e : blocks)
+    {
+        bw.seek(e.first);
+        bw.write_be32(LDBS_BLOCK_MAGIC);
+        bw.write_be32(e.second.type);
+        bw.write_le32(e.second.data.size());
+        bw.write_le32(e.second.data.size());
+        bw.write_le32(previous);
+        bw.append(e.second.data);
+
+        previous = e.first;
+    }
+
+    bw.seek(0);
+    bw.write_be32(LDBS_FILE_MAGIC);
+    bw.write_be32(LDBS_FILE_TYPE);
+    bw.write_le32(previous);
+    bw.write_le32(0);
+    bw.write_le32(trackDirectory);
+    
+    return data;
+}

lib/ldbs.h

@@ -0,0 +1,41 @@
+#ifndef LDBS_H
+#define LDBS_H
+
+class Bytes;
+
+/* A very simple interface to John Elliott's LDBS image format:
+ * http://www.seasip.info/Unix/LibDsk/ldbs.html
+ */
+
+#define LDBS_FILE_MAGIC 0x4C425301 /* "LBS\01" */
+#define LDBS_FILE_TYPE 0x44534B02 /* "DSK\02" */
+#define LDBS_BLOCK_MAGIC 0x4C444201 /* "LDB\01" */
+#define LDBS_TRACK_BLOCK 0x44495201 /* "DIR\01" */
+
+class LDBS
+{
+public:
+    LDBS();
+
+public:
+    const Bytes& get(uint32_t address) const
+    { return blocks.at(address).data; }
+
+    uint32_t put(const Bytes& data, uint32_t type);
+
+public:
+    const Bytes write(uint32_t trackDirectory);
+    uint32_t read(const Bytes& bytes);
+
+private:
+    struct Block
+    {
+        uint32_t type;
+        Bytes data;
+    };
+
+    std::map<uint32_t, Block> blocks;
+    unsigned top = 20;
+};
+
+#endif

mkninja.sh

@@ -137,6 +137,11 @@ buildlibrary libfmt.a \
     dep/fmt/posix.cc \
 
 buildlibrary libbackend.a \
+	lib/imagereader/imagereader.cc \
+	lib/imagereader/imgimagereader.cc \
+	lib/imagewriter/imagewriter.cc \
+	lib/imagewriter/imgimagewriter.cc \
+	lib/imagewriter/ldbsimagewriter.cc \
     arch/aeslanier/decoder.cc \
     arch/amiga/decoder.cc \
     arch/apple2/decoder.cc \
@@ -169,13 +174,10 @@ buildlibrary libbackend.a \
     lib/fluxsource/kryoflux.cc \
     lib/fluxsource/sqlitefluxsource.cc \
     lib/fluxsource/streamfluxsource.cc \
-	lib/imagereader/imagereader.cc \
-	lib/imagereader/imgimagereader.cc \
-	lib/imagewriter/imagewriter.cc \
-	lib/imagewriter/imgimagewriter.cc \
     lib/globals.cc \
     lib/hexdump.cc \
     lib/image.cc \
+    lib/ldbs.cc \
     lib/reader.cc \
     lib/sector.cc \
     lib/sectorset.cc \
@@ -229,12 +231,13 @@ buildsimpleprogram brother120tool \
     libemu.a \
     libfmt.a \
 
+runtest bitaccumulator-test tests/bitaccumulator.cc
+runtest bytes-test          tests/bytes.cc
+runtest compression-test    tests/compression.cc
+runtest crunch-test         tests/crunch.cc
 runtest dataspec-test       tests/dataspec.cc
 runtest flags-test          tests/flags.cc
-runtest fmmfm-test          tests/fmmfm.cc
-runtest bitaccumulator-test tests/bitaccumulator.cc
-runtest kryoflux-test       tests/kryoflux.cc
-runtest compression-test    tests/compression.cc
-runtest bytes-test          tests/bytes.cc
-runtest crunch-test         tests/crunch.cc
 runtest fluxpattern-test    tests/fluxpattern.cc
+runtest fmmfm-test          tests/fmmfm.cc
+runtest kryoflux-test       tests/kryoflux.cc
+runtest ldbs-test           tests/ldbs.cc

tests/ldbs.cc

@@ -0,0 +1,70 @@
+#include <stdio.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include "globals.h"
+#include "bytes.h"
+#include "ldbs.h"
+
+static Bytes testdata
+{
+    'L',  'B',  'S',  0x01,  'D',  'S',  'K',  0x02,
+    0x29, 0x00, 0x00, 0x00,  0x00, 0x00, 0x00, 0x00,
+    0x34, 0x12, 0x00, 0x00,  'L',  'D',  'B',  0x01,
+    0x00, 0x00, 0x00, 0x01,  0x01, 0x00, 0x00, 0x00,
+    0x01, 0x00, 0x00, 0x00,  0x00, 0x00, 0x00, 0x00,
+    0x01, 'L',  'D',  'B',   0x01, 0x00, 0x00, 0x00,
+    0x02, 0x01, 0x00, 0x00,  0x00, 0x01, 0x00, 0x00,
+    0x00, 0x14, 0x00, 0x00,  0x00, 0x02
+};
+
+static void assertBytes(const Bytes& want, const Bytes& got)
+{
+    if (want != got)
+    {
+        std::cout << "Wanted bytes:" << std::endl;
+        hexdump(std::cout, want);
+        std::cout << std::endl << "Produced bytes:" << std::endl;
+        hexdump(std::cout, got);
+        abort();
+    }
+}
+static void test_getset()
+{
+    LDBS ldbs;
+
+    uint32_t block1 = ldbs.put(Bytes { 1 }, 1);
+    uint32_t block2 = ldbs.put(Bytes { 2 }, 2);
+    assert(block1 != block2);
+
+    assert(ldbs.get(block1) == Bytes { 1 });
+    assert(ldbs.get(block2) == Bytes { 2 });
+}
+
+static void test_write()
+{
+    LDBS ldbs;
+
+    uint32_t block1 = ldbs.put(Bytes { 1 }, 1);
+    uint32_t block2 = ldbs.put(Bytes { 2 }, 2);
+    Bytes data = ldbs.write(0x1234);
+
+    assertBytes(testdata, data);
+}
+
+static void test_read()
+{
+    LDBS ldbs;
+    uint32_t trackDirectory = ldbs.read(testdata);
+
+    assert(trackDirectory == 0x1234);
+    assert(ldbs.get(0x14) == Bytes { 1 });
+    assert(ldbs.get(0x29) == Bytes { 2 });
+}
+
+int main(int argc, const char* argv[])
+{
+    test_getset();
+    test_write();
+    test_read();
+    return 0;
+}