WIP: Add solved/reconstructed fluxmap support.

This proof of concept adds an optional encoder and fluxsink that
runs after the image is written.

This currently exposes the config of the solvedEncoder, though I
think I ultimately don't want it to be exposed as part of the
config proto.

Another way to do this would be by extending the decoders and/or
directly reading their records. That is actually closer to what I
want in many ways, however those records would need to be
deduplicated from multiple reads, etc.

The ultimate goal is to exactly replicate the timing of the
original sectors, but with a stable clock, sectors reread if a
bad read happens, and garbage between sectors removed. This
requires extending the sector struct to have more information
than it currently holds.

Author: tdaede

arch/ibm/encoder.cc

@@ -315,3 +315,24 @@ std::unique_ptr<AbstractEncoder> createIbmEncoder(const EncoderProto& config)
 {
     return std::unique_ptr<AbstractEncoder>(new IbmEncoder(config));
 }
+
+std::unique_ptr<AbstractEncoder> createIbmEncoderFromImage(EncoderProto& config, const Image& image)
+{
+    IbmEncoderProto* ibm;
+    Geometry geometry;
+    IbmEncoderProto::TrackdataProto* trackdata;
+    IbmEncoderProto::TrackdataProto::SectorRangeProto* sector_range;
+    ibm = config.mutable_ibm();
+    geometry = image.getGeometry();
+    trackdata = ibm->mutable_trackdata()->Add();
+    sector_range = trackdata->mutable_sector_range();
+    sector_range->set_min_sector(geometry.firstSector);
+    sector_range->set_max_sector(geometry.firstSector + geometry.numSectors);
+    trackdata->set_gap0(0x1b);
+    trackdata->set_gap2(0x09);
+    trackdata->set_gap3(0x1b);
+    trackdata->set_target_clock_period_us(1e3/250);
+    trackdata->set_target_rotational_period_ms(200);
+    trackdata->set_sector_size(256);
+    return createIbmEncoder(config);
+}

arch/ibm/ibm.h

@@ -33,5 +33,6 @@ class EncoderProto;
 
 extern std::unique_ptr<AbstractDecoder> createIbmDecoder(const DecoderProto& config);
 extern std::unique_ptr<AbstractEncoder> createIbmEncoder(const EncoderProto& config);
+extern std::unique_ptr<AbstractEncoder> createIbmEncoderFromImage(EncoderProto& config, const Image& image);
 
 #endif

lib/config.proto

@@ -11,7 +11,7 @@ import "lib/drive.proto";
 import "lib/mapper.proto";
 import "lib/common.proto";
 
-// NEXT_TAG: 17
+// NEXT_TAG: 19
 message ConfigProto {
 	optional string comment = 8;
 	optional bool is_extension = 13;
@@ -21,9 +21,11 @@ message ConfigProto {
 
 	optional FluxSourceProto flux_source = 10;
 	optional FluxSinkProto flux_sink = 11;
+	optional FluxSinkProto solved_flux = 17;
 	optional DriveProto drive = 15;
 
 	optional EncoderProto encoder = 3;
+	optional EncoderProto solved_encoder = 18;
 	optional DecoderProto decoder = 4;
 	optional UsbProto usb = 5;
 

lib/encoders/encoders.cc

@@ -13,6 +13,8 @@
 #include "arch/tids990/tids990.h"
 #include "arch/victor9k/victor9k.h"
 #include "lib/encoders/encoders.pb.h"
+#include "lib/decoders/decoders.pb.h"
+#include "lib/image.h"
 #include "protocol.h"
 
 std::unique_ptr<AbstractEncoder> AbstractEncoder::create(
@@ -40,6 +42,22 @@ std::unique_ptr<AbstractEncoder> AbstractEncoder::create(
     return (encoder->second)(config);
 }
 
+std::unique_ptr<AbstractEncoder> AbstractEncoder::createFromImage(EncoderProto& encoderConfig,
+    const DecoderProto& decoderConfig, const Image& image)
+{
+        static const std::map<int,
+        std::function<std::unique_ptr<AbstractEncoder>(EncoderProto&, const Image&)>>
+        encoders = {
+            {DecoderProto::kIbm, createIbmEncoderFromImage},
+    };
+
+    auto encoder = encoders.find(decoderConfig.format_case());
+    if (encoder == encoders.end())
+        Error() << "solved fluxmaps not supported for this format";
+
+    return (encoder->second)(encoderConfig, image);
+}
+
 Fluxmap& Fluxmap::appendBits(const std::vector<bool>& bits, nanoseconds_t clock)
 {
     nanoseconds_t now = duration();

lib/encoders/encoders.h

@@ -2,6 +2,7 @@
 #define ENCODERS_H
 
 class EncoderProto;
+class DecoderProto;
 class Fluxmap;
 class Image;
 class Location;
@@ -14,6 +15,8 @@ class AbstractEncoder
     virtual ~AbstractEncoder() {}
 
     static std::unique_ptr<AbstractEncoder> create(const EncoderProto& config);
+    static std::unique_ptr<AbstractEncoder> createFromImage(EncoderProto& encoderConfig,
+    const DecoderProto& decoderConfig, const Image& image);
 
 public:
     virtual std::vector<std::shared_ptr<const Sector>> collectSectors(

lib/readerwriter.cc

@@ -470,14 +470,19 @@ std::shared_ptr<const DiskFlux> readDiskCommand(
 }
 
 void readDiskCommand(
-    FluxSource& fluxsource, AbstractDecoder& decoder, ImageWriter& writer)
+    FluxSource& fluxsource, AbstractDecoder& decoder, ImageWriter& writer,FluxSink* solvedFlux)
 {
     auto diskflux = readDiskCommand(fluxsource, decoder);
 
     writer.printMap(*diskflux->image);
     if (config.decoder().has_write_csv_to())
         writer.writeCsv(*diskflux->image, config.decoder().write_csv_to());
     writer.writeImage(*diskflux->image);
+    if (config.has_solved_flux()) {
+        std::unique_ptr<AbstractEncoder> solvedEncoder = AbstractEncoder::createFromImage(*config.mutable_encoder(),
+    config.decoder(), *diskflux->image);
+        writeTracks(*solvedFlux, *solvedEncoder, *diskflux->image);
+    }
 }
 
 void rawReadDiskCommand(FluxSource& fluxsource, FluxSink& fluxsink)

lib/readerwriter.h

@@ -34,7 +34,7 @@ extern std::unique_ptr<TrackDataFlux> readAndDecodeTrack(
 		FluxSource& source, AbstractDecoder& decoder, unsigned track, unsigned head);
 
 extern std::shared_ptr<const DiskFlux> readDiskCommand(FluxSource& fluxsource, AbstractDecoder& decoder);
-extern void readDiskCommand(FluxSource& source, AbstractDecoder& decoder, ImageWriter& writer);
+extern void readDiskCommand(FluxSource& source, AbstractDecoder& decoder, ImageWriter& writer, FluxSink* solvedFlux);
 extern void rawReadDiskCommand(FluxSource& source, FluxSink& sink);
 
 #endif

src/fe-read.cc

@@ -3,6 +3,7 @@
 #include "readerwriter.h"
 #include "fluxmap.h"
 #include "decoders/decoders.h"
+#include "encoders/encoders.h"
 #include "macintosh/macintosh.h"
 #include "sector.h"
 #include "proto.h"
@@ -45,6 +46,15 @@ static StringFlag copyFluxTo(
 		FluxSink::updateConfigForFilename(config.mutable_decoder()->mutable_copy_flux_to(), value);
 	});
 
+static StringFlag solvedFlux(
+	{ "-r", "--solved" },
+	"after reading, write a reconstructed/solved fluxmap to this file",
+	"",
+	[](const auto& value)
+	{
+		FluxSink::updateConfigForFilename(config.mutable_solved_flux(), value);
+	});
+
 static StringFlag srcTracks(
 	{ "--cylinders", "-c" },
 	"tracks to read from",
@@ -76,8 +86,12 @@ int mainRead(int argc, const char* argv[])
 	std::unique_ptr<FluxSource> fluxSource(FluxSource::create(config.flux_source()));
 	std::unique_ptr<AbstractDecoder> decoder(AbstractDecoder::create(config.decoder()));
 	std::unique_ptr<ImageWriter> writer(ImageWriter::create(config.image_writer()));
+	std::unique_ptr<FluxSink> solvedFlux;
+	std::unique_ptr<AbstractEncoder> solvedEncoder;
+	if (config.has_solved_flux()) {
+		solvedFlux = FluxSink::create(config.solved_flux());	}
 
-	readDiskCommand(*fluxSource, *decoder, *writer);
+	readDiskCommand(*fluxSource, *decoder, *writer, solvedFlux.get());
 
     return 0;
 }