greaseweazle-firmware/scripts/greaseweazle/tools/read.py

# greaseweazle/tools/read.py
#
# Greaseweazle control script: Read Disk to Image.
#
# Written & released by Keir Fraser <keir.xen@gmail.com>
#
# This is free and unencumbered software released into the public domain.
# See the file COPYING for more details, or visit <http://unlicense.org>.

description = "Read a disk to the specified image file."

import sys
import importlib

from greaseweazle.tools import util
from greaseweazle import error
from greaseweazle import usb as USB
from greaseweazle.flux import Flux


def open_image(args, image_class):
    error.check(hasattr(image_class, 'to_file'),
                "%s: Cannot create %s image files"
                % (args.file, image_class.__name__))
    image = image_class.to_file(args.scyl, args.nr_sides)
    if args.rate is not None:
        image.bitrate = args.rate
    for opt, val in args.file_opts.items():
        error.check(hasattr(image, 'opts') and hasattr(image.opts, opt),
                    "%s: Invalid file option: %s" % (args.file, opt))
        setattr(image.opts, opt, val)
    return image


def normalise_rpm(flux, rpm):
    """Adjust all revolutions in Flux object to have specified rotation speed.
    """

    index_list, freq = flux.index_list, flux.sample_freq
    
    norm_to_index = 60/rpm * flux.sample_freq
    norm_flux = []

    to_index, index_list = index_list[0], index_list[1:]
    factor = norm_to_index / to_index
    
    for x in flux.list:
        to_index -= x
        if to_index >= 0:
            norm_flux.append(x*factor)
            continue
        if not index_list:
            break
        n_to_index, index_list = index_list[0], index_list[1:]
        n_factor = norm_to_index / n_to_index
        norm_flux.append((x+to_index)*factor - to_index*n_factor)
        to_index, factor = n_to_index, n_factor

    return Flux([norm_to_index]*len(flux.index_list), norm_flux, freq)


def read_and_normalise(usb, args, revs):
    flux = usb.read_track(revs)
    if args.rpm is not None:
        flux = normalise_rpm(flux, args.rpm)
    return flux


def read_with_retry(usb, args, cyl, side, decoder):
    flux = read_and_normalise(usb, args, args.revs)
    if decoder is None:
        return flux
    dat = decoder(cyl, side, flux)
    if dat.nr_missing() != 0:
        for retry in range(3):
            print("T%u.%u: %s - %d sectors missing - Retrying (%d)"
                  % (cyl, side, dat.summary_string(),
                     dat.nr_missing(), retry+1))
            flux = read_and_normalise(usb, args, max(args.revs, 3))
            dat.decode_raw(flux)
            if dat.nr_missing() == 0:
                break
    return dat


def print_summary(args, summary):
    print("H. S: Cyls %d-%d -->" % (args.scyl, args.ecyl))
    tot_sec = good_sec = 0
    for side in range(0, args.nr_sides):
        nsec = max(x.nsec for x in summary[side])
        for sec in range(nsec):
            print("%d.%2d: " % (side, sec), end="")
            for cyl in range(args.scyl, args.ecyl+1):
                s = summary[side][cyl-args.scyl]
                if sec > s.nsec:
                    print(" ", end="")
                else:
                    tot_sec += 1
                    if s.has_sec(sec): good_sec += 1
                    print("." if s.has_sec(sec) else "X", end="")
            print()
    print("Found %d sectors of %d (%d%%)" %
          (good_sec, tot_sec, good_sec*100/tot_sec))


def read_to_image(usb, args, image, decoder=None):
    """Reads a floppy disk and dumps it into a new image file.
    """

    summary = [[],[]]

    for cyl in range(args.scyl, args.ecyl+1):
        for side in range(0, args.nr_sides):
            usb.seek((cyl, cyl*2)[args.double_step], side)
            dat = read_with_retry(usb, args, cyl, side, decoder)
            print("T%u.%u: %s" % (cyl, side, dat.summary_string()))
            summary[side].append(dat)
            image.append_track(dat)

    if decoder is not None:
        print_summary(args, summary)

    # Write the image file.
    with open(args.file, "wb") as f:
        f.write(image.get_image())

def range_str(s, e):
    str = "%d" % s
    if s != e: str += "-%d" % e
    return str

def main(argv):

    parser = util.ArgumentParser(usage='%(prog)s [options] file')
    parser.add_argument("--device", help="greaseweazle device name")
    parser.add_argument("--drive", type=util.drive_letter, default='A',
                        help="drive to read (A,B,0,1,2)")
    parser.add_argument("--format", help="disk format")
    parser.add_argument("--revs", type=int,
                        help="number of revolutions to read per track")
    parser.add_argument("--scyl", type=int,
                        help="first cylinder to read")
    parser.add_argument("--ecyl", type=int,
                        help="last cylinder to read")
    parser.add_argument("--single-sided", action="store_true",
                        help="single-sided read")
    parser.add_argument("--double-step", action="store_true",
                        help="double-step drive heads")
    parser.add_argument("--rate", type=int, help="data rate (kbit/s)")
    parser.add_argument("--rpm", type=int, help="convert drive speed to RPM")
    parser.add_argument("file", help="output filename")
    parser.description = description
    parser.prog += ' ' + argv[1]
    args = parser.parse_args(argv[2:])
    args.nr_sides = 1 if args.single_sided else 2

    args.file, args.file_opts = util.split_opts(args.file)

    try:
        usb = util.usb_open(args.device)
        image_class = util.get_image_class(args.file)
        if not args.format and hasattr(image_class, 'default_format'):
            args.format = image_class.default_format
        decoder = None
        if args.format:
            try:
                mod = importlib.import_module('greaseweazle.codec.'
                                              + args.format)
                decoder = mod.decode_track
            except (ModuleNotFoundError, AttributeError) as ex:
                raise error.Fatal("Unknown format '%s'" % args.format) from ex
            if args.scyl is None: args.scyl = mod.default_cyls[0]
            if args.ecyl is None: args.ecyl = mod.default_cyls[1]
            if args.revs is None: args.revs = mod.default_revs
        if args.scyl is None: args.scyl = 0
        if args.ecyl is None: args.ecyl = 81
        if args.revs is None: args.revs = 3
        print("Reading c=%s s=%s revs=%d" %
              (range_str(args.scyl, args.ecyl),
               range_str(0, args.nr_sides-1),
               args.revs))
        image = open_image(args, image_class)
        util.with_drive_selected(read_to_image, usb, args, image,
                                 decoder=decoder)
    except USB.CmdError as err:
        print("Command Failed: %s" % err)


if __name__ == "__main__":
    main(sys.argv)

# Local variables:
# python-indent: 4
# End: