Files
Aaru/Aaru.Images/CopyQM/Read.cs

246 lines
10 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Read.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Reads Sydex CopyQM disk images.
//
// --[ License ] --------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2025 Natalia Portillo
// ****************************************************************************/
using System;
using System.IO;
using Aaru.CommonTypes;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Helpers;
using Aaru.Logging;
namespace Aaru.Images;
public sealed partial class CopyQm
{
#region IVerifiableImage Members
/// <inheritdoc />
public bool? VerifyMediaImage() => _calculatedDataCrc == _header.crc && _headerChecksumOk;
#endregion
#region IMediaImage Members
/// <inheritdoc />
public ErrorNumber Open(IFilter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();
stream.Seek(0, SeekOrigin.Begin);
var hdr = new byte[133];
stream.EnsureRead(hdr, 0, 133);
_header = Marshal.ByteArrayToStructureLittleEndian<Header>(hdr);
AaruLogging.Debug(MODULE_NAME, "header.magic = 0x{0:X4}", _header.magic);
AaruLogging.Debug(MODULE_NAME, "header.mark = 0x{0:X2}", _header.mark);
AaruLogging.Debug(MODULE_NAME, "header.sectorSize = {0}", _header.sectorSize);
AaruLogging.Debug(MODULE_NAME, "header.sectorPerCluster = {0}", _header.sectorPerCluster);
AaruLogging.Debug(MODULE_NAME, "header.reservedSectors = {0}", _header.reservedSectors);
AaruLogging.Debug(MODULE_NAME, "header.fatCopy = {0}", _header.fatCopy);
AaruLogging.Debug(MODULE_NAME, "header.rootEntries = {0}", _header.rootEntries);
AaruLogging.Debug(MODULE_NAME, "header.sectors = {0}", _header.sectors);
AaruLogging.Debug(MODULE_NAME, "header.mediaType = 0x{0:X2}", _header.mediaType);
AaruLogging.Debug(MODULE_NAME, "header.sectorsPerFat = {0}", _header.sectorsPerFat);
AaruLogging.Debug(MODULE_NAME, "header.sectorsPerTrack = {0}", _header.sectorsPerTrack);
AaruLogging.Debug(MODULE_NAME, "header.heads = {0}", _header.heads);
AaruLogging.Debug(MODULE_NAME, "header.hidden = {0}", _header.hidden);
AaruLogging.Debug(MODULE_NAME, "header.sectorsBig = {0}", _header.sectorsBig);
AaruLogging.Debug(MODULE_NAME, "header.description = {0}", _header.description);
AaruLogging.Debug(MODULE_NAME, "header.blind = {0}", _header.blind);
AaruLogging.Debug(MODULE_NAME, "header.density = {0}", _header.density);
AaruLogging.Debug(MODULE_NAME, "header.imageCylinders = {0}", _header.imageCylinders);
AaruLogging.Debug(MODULE_NAME, "header.totalCylinders = {0}", _header.totalCylinders);
AaruLogging.Debug(MODULE_NAME, "header.crc = 0x{0:X8}", _header.crc);
AaruLogging.Debug(MODULE_NAME, "header.volumeLabel = {0}", _header.volumeLabel);
AaruLogging.Debug(MODULE_NAME, "header.time = 0x{0:X4}", _header.time);
AaruLogging.Debug(MODULE_NAME, "header.date = 0x{0:X4}", _header.date);
AaruLogging.Debug(MODULE_NAME, "header.commentLength = {0}", _header.commentLength);
AaruLogging.Debug(MODULE_NAME, "header.secbs = {0}", _header.secbs);
AaruLogging.Debug(MODULE_NAME, "header.unknown = 0x{0:X4}", _header.unknown);
AaruLogging.Debug(MODULE_NAME, "header.interleave = {0}", _header.interleave);
AaruLogging.Debug(MODULE_NAME, "header.skew = {0}", _header.skew);
AaruLogging.Debug(MODULE_NAME, "header.drive = {0}", _header.drive);
var cmt = new byte[_header.commentLength];
stream.EnsureRead(cmt, 0, _header.commentLength);
_imageInfo.Comments = StringHandlers.CToString(cmt);
_decodedImage = new MemoryStream();
_calculatedDataCrc = 0;
while(stream.Position + 2 < stream.Length)
{
var runLengthBytes = new byte[2];
if(stream.EnsureRead(runLengthBytes, 0, 2) != 2) break;
var runLength = BitConverter.ToInt16(runLengthBytes, 0);
switch(runLength)
{
case < 0:
{
var repeatedByte = (byte)stream.ReadByte();
var repeatedArray = new byte[runLength * -1];
ArrayHelpers.ArrayFill(repeatedArray, repeatedByte);
for(var i = 0; i < runLength * -1; i++)
{
_decodedImage.WriteByte(repeatedByte);
_calculatedDataCrc = _copyQmCrcTable[(repeatedByte ^ _calculatedDataCrc) & 0x3F] ^
_calculatedDataCrc >> 8;
}
break;
}
case > 0:
{
var nonRepeated = new byte[runLength];
stream.EnsureRead(nonRepeated, 0, runLength);
_decodedImage.Write(nonRepeated, 0, runLength);
foreach(byte c in nonRepeated)
_calculatedDataCrc = _copyQmCrcTable[(c ^ _calculatedDataCrc) & 0x3F] ^ _calculatedDataCrc >> 8;
break;
}
}
}
// In case there is omitted data
long sectors = _header.sectorsPerTrack * _header.heads * _header.totalCylinders;
long fillingLen = sectors * _header.sectorSize - _decodedImage.Length;
if(fillingLen > 0)
{
var filling = new byte[fillingLen];
ArrayHelpers.ArrayFill(filling, (byte)0xF6);
_decodedImage.Write(filling, 0, filling.Length);
}
var sum = 0;
for(var i = 0; i < hdr.Length - 1; i++) sum += hdr[i];
_headerChecksumOk = (-1 * sum & 0xFF) == _header.headerChecksum;
AaruLogging.Debug(MODULE_NAME,
Localization.Calculated_header_checksum_equals_0_X2_1,
-1 * sum & 0xFF,
_headerChecksumOk);
AaruLogging.Debug(MODULE_NAME,
Localization.Calculated_data_CRC_equals_0_X8_1,
_calculatedDataCrc,
_calculatedDataCrc == _header.crc);
_imageInfo.Application = "CopyQM";
_imageInfo.CreationTime = DateHandlers.DosToDateTime(_header.date, _header.time);
_imageInfo.LastModificationTime = _imageInfo.CreationTime;
_imageInfo.MediaTitle = _header.volumeLabel;
_imageInfo.ImageSize = (ulong)(stream.Length - 133 - _header.commentLength);
_imageInfo.Sectors = (ulong)sectors;
_imageInfo.SectorSize = _header.sectorSize;
_imageInfo.MediaType = Geometry.GetMediaType((_header.totalCylinders, (byte)_header.heads,
_header.sectorsPerTrack, _header.sectorSize, MediaEncoding.MFM,
false));
switch(_imageInfo.MediaType)
{
case MediaType.NEC_525_HD when _header.drive is COPYQM_35_HD or COPYQM_35_ED:
_imageInfo.MediaType = MediaType.NEC_35_HD_8;
break;
case MediaType.DOS_525_HD when _header.drive is COPYQM_35_HD or COPYQM_35_ED:
_imageInfo.MediaType = MediaType.NEC_35_HD_15;
break;
case MediaType.RX50 when _header.drive is COPYQM_525_DD or COPYQM_525_HD:
_imageInfo.MediaType = MediaType.ATARI_35_SS_DD;
break;
}
_imageInfo.MetadataMediaType = MetadataMediaType.BlockMedia;
_decodedDisk = _decodedImage.ToArray();
_decodedImage.Close();
AaruLogging.Verbose(Localization.CopyQM_image_contains_a_disk_of_type_0, _imageInfo.MediaType);
if(!string.IsNullOrEmpty(_imageInfo.Comments))
AaruLogging.Verbose(Localization.CopyQM_comments_0, _imageInfo.Comments);
_imageInfo.Heads = _header.heads;
_imageInfo.Cylinders = _header.totalCylinders;
_imageInfo.SectorsPerTrack = _header.sectorsPerTrack;
return ErrorNumber.NoError;
}
/// <inheritdoc />
public ErrorNumber ReadSector(ulong sectorAddress, bool negative, out byte[] buffer, out SectorStatus sectorStatus)
{
sectorStatus = SectorStatus.Dumped;
return ReadSectors(sectorAddress, negative, 1, out buffer, out _);
}
/// <inheritdoc />
public ErrorNumber ReadSectors(ulong sectorAddress, bool negative, uint length, out byte[] buffer,
out SectorStatus[] sectorStatus)
{
buffer = null;
sectorStatus = null;
if(negative) return ErrorNumber.NotSupported;
if(sectorAddress > _imageInfo.Sectors - 1) return ErrorNumber.OutOfRange;
if(sectorAddress + length > _imageInfo.Sectors) return ErrorNumber.OutOfRange;
buffer = new byte[length * _imageInfo.SectorSize];
sectorStatus = new SectorStatus[length];
for(uint i = 0; i < length; i++) sectorStatus[i] = SectorStatus.Dumped;
Array.Copy(_decodedDisk, (int)sectorAddress * _imageInfo.SectorSize, buffer, 0, length * _imageInfo.SectorSize);
return ErrorNumber.NoError;
}
#endregion
}