# keirf/disk-utilities architecture

> Architecture diagram of the GitHub repository keirf/disk-utilities, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/keirf/disk-utilities
- Repository: https://github.com/keirf/disk-utilities

## Overview

Disk Utilities is a collection of command-line tools and a reusable disk-image library for ripping, inspecting, converting, and modifying floppy data. A central workflow is to provide an image or flux dump to disk-analyse, which uses libdisk to interpret tracks and convert supported formats. Other tools handle focused ADF/IPF/IMD tasks or acquire Supercard Pro flux data. The README documents broad format and emulator capabilities; where sampled source does not establish internal call relationships, the graph omits or marks them unverified.

Main entry points: [`disk-analyse/disk-analyse.c`](https://github.com/keirf/disk-utilities/blob/master/disk-analyse/disk-analyse.c) (Analyse / convert), [`libdisk/container`](https://github.com/keirf/disk-utilities/tree/master/libdisk/container) (Image containers), [`scp/scp_dump.c`](https://github.com/keirf/disk-utilities/blob/master/scp/scp_dump.c) (Capture SCP flux), [`libdisk/util.c`](https://github.com/keirf/disk-utilities/blob/master/libdisk/util.c) (Shared utilities)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tools["Disk Tools"]
  node_disk_analyse["Analyse / convert<br/>[disk-analyse.c]"]
  node_config["Format config<br/>[config.c]"]
  node_adf_read["Extract ADF files<br/>[adfread.c]"]
  node_adf_write["Write ADF sectors<br/>[adfwrite.c]"]
  node_adf_boot["Check boot blocks<br/>[adfbb.c]"]
  node_ipf_info["Inspect IPF<br/>[ipfinfo.c]"]
  node_imd_info["Inspect IMD<br/>[imdinfo.c]"]
  node_diskread["Amiga disk dump<br/>[diskread.c]"]
end

subgraph group_library["Disk Library"]
  node_libdisk["Disk model<br/>[disk.c]"]
  node_streams["Flux readers"]
  node_disk_utils["Shared utilities<br/>[util.c]"]
end

subgraph group_formats["Image Formats"]
  node_containers["Image containers"]
  node_format_decode["Track decoders"]
  node_adf_container["ADF container<br/>[adf.c]"]
  node_ipf_container["IPF container<br/>[ipf.c]"]
  node_hfe_container["HFE container<br/>[hfe.c]"]
  node_scp_container["SCP container<br/>[scp.c]"]
end

subgraph group_acquisition["Flux Acquisition"]
  node_scp_dump["Capture SCP flux<br/>[scp_dump.c]"]
  node_scp_protocol["SCP device protocol<br/>[scp.c]"]
end

subgraph group_emulation["m68k Tools"]
  node_disassemble["Disassemble code<br/>[disassemble.c]"]
  node_m68k_emulator["680x0 emulator<br/>[m68k_emulate.c]"]
  node_amiga_emulator["Amiga emulator<br/>[amiga.c]"]
  node_copylock["Copylock runner<br/>[copylock.c]"]
end

node_user(("Disk user"))
node_scp_device(("Supercard Pro"))
node_ipf_caps(("CAPS/SPS library"))

node_user -->|"provides image"| node_disk_analyse
node_disk_analyse -->|"converts with"| node_libdisk
node_disk_analyse -.->|"uses configuration"| node_config
node_streams -.->|"supplies flux data"| node_disk_analyse
node_disk_analyse -.->|"reads / writes"| node_containers
node_disk_analyse -.->|"decodes tracks"| node_format_decode
node_libdisk -->|"supports conversion"| node_containers
node_libdisk -->|"interprets formats"| node_format_decode
node_user -->|"selects ADF"| node_adf_read
node_adf_read -->|"uses helpers"| node_disk_utils
node_user -->|"selects ADF"| node_adf_write
node_adf_write -->|"uses helpers"| node_disk_utils
node_user -->|"checks or modifies"| node_adf_boot
node_adf_boot -->|"uses helpers"| node_disk_utils
node_user -->|"inspects image"| node_ipf_info
node_ipf_info -->|"uses helpers"| node_disk_utils
node_user -->|"inspects image"| node_imd_info
node_user -->|"requests dump"| node_diskread
node_user -->|"starts capture"| node_scp_dump
node_scp_dump -->|"captures flux"| node_scp_device
node_scp_dump -.->|"issues commands"| node_scp_protocol
node_scp_dump -.->|"writes image"| node_scp_container
node_scp_container -.->|"implements format"| node_containers
node_adf_container -.->|"implements format"| node_containers
node_ipf_container -.->|"implements format"| node_containers
node_hfe_container -.->|"implements format"| node_containers
node_user -->|"provides binary"| node_disassemble
node_disassemble -->|"emulates instructions"| node_m68k_emulator
node_user -->|"provides routine"| node_copylock
node_copylock -.->|"runs in"| node_amiga_emulator
node_amiga_emulator -.->|"uses CPU emulation"| node_m68k_emulator
node_ipf_caps -->|"enables IPF support"| node_ipf_container

click node_disk_analyse "https://github.com/keirf/disk-utilities/blob/master/disk-analyse/disk-analyse.c"
click node_config "https://github.com/keirf/disk-utilities/blob/master/disk-analyse/config.c"
click node_adf_read "https://github.com/keirf/disk-utilities/blob/master/adf/adfread.c"
click node_adf_write "https://github.com/keirf/disk-utilities/blob/master/adf/adfwrite.c"
click node_adf_boot "https://github.com/keirf/disk-utilities/blob/master/adf/adfbb.c"
click node_ipf_info "https://github.com/keirf/disk-utilities/blob/master/ipfinfo/ipfinfo.c"
click node_imd_info "https://github.com/keirf/disk-utilities/blob/master/imdinfo/imdinfo.c"
click node_diskread "https://github.com/keirf/disk-utilities/blob/master/amiga/native/diskread.c"
click node_libdisk "https://github.com/keirf/disk-utilities/blob/master/libdisk/disk.c"
click node_streams "https://github.com/keirf/disk-utilities/tree/master/libdisk/stream"
click node_containers "https://github.com/keirf/disk-utilities/tree/master/libdisk/container"
click node_format_decode "https://github.com/keirf/disk-utilities/tree/master/libdisk/format"
click node_adf_container "https://github.com/keirf/disk-utilities/blob/master/libdisk/container/adf.c"
click node_ipf_container "https://github.com/keirf/disk-utilities/blob/master/libdisk/container/ipf.c"
click node_hfe_container "https://github.com/keirf/disk-utilities/blob/master/libdisk/container/hfe.c"
click node_scp_container "https://github.com/keirf/disk-utilities/blob/master/libdisk/container/scp.c"
click node_scp_dump "https://github.com/keirf/disk-utilities/blob/master/scp/scp_dump.c"
click node_scp_protocol "https://github.com/keirf/disk-utilities/blob/master/scp/scp.c"
click node_disassemble "https://github.com/keirf/disk-utilities/blob/master/m68k/disassemble.c"
click node_m68k_emulator "https://github.com/keirf/disk-utilities/blob/master/m68k/m68k/m68k_emulate.c"
click node_amiga_emulator "https://github.com/keirf/disk-utilities/blob/master/m68k/amiga/amiga.c"
click node_copylock "https://github.com/keirf/disk-utilities/blob/master/m68k/copylock.c"
click node_disk_utils "https://github.com/keirf/disk-utilities/blob/master/libdisk/util.c"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_disk_analyse,node_config,node_adf_read,node_adf_write,node_adf_boot,node_ipf_info,node_imd_info,node_diskread,node_user toneBlue
class node_libdisk,node_streams,node_disk_utils toneAmber
class node_containers,node_format_decode,node_adf_container,node_ipf_container,node_hfe_container,node_scp_container toneMint
class node_scp_dump,node_scp_protocol toneRose
class node_disassemble,node_m68k_emulator,node_amiga_emulator,node_copylock,node_scp_device,node_ipf_caps toneIndigo
```

## Components

### Disk Tools

- [Analyse / convert](https://github.com/keirf/disk-utilities/blob/master/disk-analyse/disk-analyse.c): `disk-analyse/disk-analyse.c`
- [Format config](https://github.com/keirf/disk-utilities/blob/master/disk-analyse/config.c): `disk-analyse/config.c`
- [Extract ADF files](https://github.com/keirf/disk-utilities/blob/master/adf/adfread.c): `adf/adfread.c`
- [Write ADF sectors](https://github.com/keirf/disk-utilities/blob/master/adf/adfwrite.c): `adf/adfwrite.c`
- [Check boot blocks](https://github.com/keirf/disk-utilities/blob/master/adf/adfbb.c): `adf/adfbb.c`
- [Inspect IPF](https://github.com/keirf/disk-utilities/blob/master/ipfinfo/ipfinfo.c): `ipfinfo/ipfinfo.c`
- [Inspect IMD](https://github.com/keirf/disk-utilities/blob/master/imdinfo/imdinfo.c): `imdinfo/imdinfo.c`
- [Amiga disk dump](https://github.com/keirf/disk-utilities/blob/master/amiga/native/diskread.c): `amiga/native/diskread.c`

### Disk Library

- [Disk model](https://github.com/keirf/disk-utilities/blob/master/libdisk/disk.c): `libdisk/disk.c`
- [Flux readers](https://github.com/keirf/disk-utilities/tree/master/libdisk/stream): `libdisk/stream`
- [Shared utilities](https://github.com/keirf/disk-utilities/blob/master/libdisk/util.c): `libdisk/util.c`

### Image Formats

- [Image containers](https://github.com/keirf/disk-utilities/tree/master/libdisk/container): `libdisk/container`
- [Track decoders](https://github.com/keirf/disk-utilities/tree/master/libdisk/format): `libdisk/format`
- [ADF container](https://github.com/keirf/disk-utilities/blob/master/libdisk/container/adf.c): `libdisk/container/adf.c`
- [IPF container](https://github.com/keirf/disk-utilities/blob/master/libdisk/container/ipf.c): `libdisk/container/ipf.c`
- [HFE container](https://github.com/keirf/disk-utilities/blob/master/libdisk/container/hfe.c): `libdisk/container/hfe.c`
- [SCP container](https://github.com/keirf/disk-utilities/blob/master/libdisk/container/scp.c): `libdisk/container/scp.c`

### Flux Acquisition

- [Capture SCP flux](https://github.com/keirf/disk-utilities/blob/master/scp/scp_dump.c): `scp/scp_dump.c`
- [SCP device protocol](https://github.com/keirf/disk-utilities/blob/master/scp/scp.c): `scp/scp.c`

### m68k Tools

- [Disassemble code](https://github.com/keirf/disk-utilities/blob/master/m68k/disassemble.c): `m68k/disassemble.c`
- [680x0 emulator](https://github.com/keirf/disk-utilities/blob/master/m68k/m68k/m68k_emulate.c): `m68k/m68k/m68k_emulate.c`
- [Amiga emulator](https://github.com/keirf/disk-utilities/blob/master/m68k/amiga/amiga.c): `m68k/amiga/amiga.c`
- [Copylock runner](https://github.com/keirf/disk-utilities/blob/master/m68k/copylock.c): `m68k/copylock.c`

### Other components

- **Disk user**
- **Supercard Pro**
- **CAPS/SPS library**

## Connections

- Disk user → Analyse / convert: provides image
- Analyse / convert → Disk model: converts with
- Analyse / convert → Format config: uses configuration
- Flux readers → Analyse / convert: supplies flux data
- Analyse / convert → Image containers: reads / writes
- Analyse / convert → Track decoders: decodes tracks
- Disk model → Image containers: supports conversion
- Disk model → Track decoders: interprets formats
- Disk user → Extract ADF files: selects ADF
- Extract ADF files → Shared utilities: uses helpers (evidence: `adf/adfread.c`)
- Disk user → Write ADF sectors: selects ADF
- Write ADF sectors → Shared utilities: uses helpers (evidence: `adf/adfwrite.c`)
- Disk user → Check boot blocks: checks or modifies
- Check boot blocks → Shared utilities: uses helpers (evidence: `adf/adfbb.c`)
- Disk user → Inspect IPF: inspects image
- Inspect IPF → Shared utilities: uses helpers (evidence: `ipfinfo/ipfinfo.c`)
- Disk user → Inspect IMD: inspects image
- Disk user → Amiga disk dump: requests dump
- Disk user → Capture SCP flux: starts capture
- Capture SCP flux → Supercard Pro: captures flux
- Capture SCP flux → SCP device protocol: issues commands
- Capture SCP flux → SCP container: writes image
- SCP container → Image containers: implements format
- ADF container → Image containers: implements format
- IPF container → Image containers: implements format
- HFE container → Image containers: implements format
- Disk user → Disassemble code: provides binary
- Disassemble code → 680x0 emulator: emulates instructions (evidence: `m68k/disassemble.c`)
- Disk user → Copylock runner: provides routine
- Copylock runner → Amiga emulator: runs in
- Amiga emulator → 680x0 emulator: uses CPU emulation
- CAPS/SPS library → IPF container: enables IPF support
