1
0
mirror of https://github.com/TomHarte/CLK.git synced 2024-07-01 14:29:51 +00:00
CLK/Storage/Disk/Encodings/AppleGCR/Encoder.hpp
2024-01-16 23:34:46 -05:00

94 lines
2.7 KiB
C++

//
// AppleGCR.hpp
// Clock Signal
//
// Created by Thomas Harte on 21/04/2018.
// Copyright 2018 Thomas Harte. All rights reserved.
//
#pragma once
#include <cstdint>
#include "../../../Disk/Track/PCMSegment.hpp"
namespace Storage::Encodings::AppleGCR {
/// Describes the standard three-byte prologue that begins a header on both the Macintosh and the Apple II from DOS 3.3.
constexpr uint8_t header_prologue[3] = {0xd5, 0xaa, 0x96};
/// Describes the standard three-byte prologue that begins a data section.
constexpr uint8_t data_prologue[3] = {0xd5, 0xaa, 0xad};
/// Describes the epilogue that ends both data sections and headers.
constexpr uint8_t epilogue[3] = {0xde, 0xaa, 0xeb};
/// Describes the standard three-byte prologue used by DOS 3.2 and earlier.
constexpr uint8_t five_and_three_header_prologue[3] = {0xd5, 0xaa, 0xb5};
namespace AppleII {
/*!
Produces the data section of an Apple II-style six-and-two format sector;
the segment returned will be 2,792 bits long, encoding the first 256 bytes
from @c source.
*/
Storage::Disk::PCMSegment six_and_two_data(const uint8_t *source);
/*!
Produces the Apple II-standard four-and-four per-sector header. This is the same
for both the 13- and 16-sector formats, and is 112 bits long.
*/
Storage::Disk::PCMSegment header(uint8_t volume, uint8_t track, uint8_t sector);
}
namespace Macintosh {
struct SectorSpan {
int start, length;
};
/*!
@returns the span of sectors included on track @c track using the Macintosh's
ordinary CLV variable-speed mechanish. Guaranteed to be 12 or fewer.
*/
SectorSpan sectors_in_track(int track);
/*!
Produces the data section of a Macintosh-format sector;
the segment returned will be 5680 bits long, encoding the first 524 bytes
from @c source and including a record of the @c sector.
*/
Storage::Disk::PCMSegment data(uint8_t sector, const uint8_t *source);
/*!
Produces the Mac-standard header. This is 88 bits long.
*/
Storage::Disk::PCMSegment header(uint8_t type, uint8_t track, uint8_t sector, bool side_two);
/// The on-disk type used for a 400kb floppy.
const uint8_t TypeMac400kb = 0x02;
/// The on-disk type used for a 800kb floppy.
const uint8_t TypeMac800kb = 0x22;
}
/*!
Produces @c length sync six-and-two format sync bytes. The segment returned
is @c 10*length bits long.
*/
Storage::Disk::PCMSegment six_and_two_sync(int length);
/*!
Produces the data section of a five-and-three format sector; the segment returned
will be 3,336 bits long, encoding the first 256 bytes from @c source.
(TODO).
*/
Storage::Disk::PCMSegment five_and_three_data(const uint8_t *source);
/*!
Produces @c length sync five-and-three format sync bytes. The segment returned
is @c 9*length bits long.
*/
Storage::Disk::PCMSegment five_and_three_sync(int length);
}