Add AaruFormat skeleton.

This commit is contained in:
2025-10-11 15:58:21 +01:00
parent 71ae11f25a
commit cb29d80763
3 changed files with 305 additions and 0 deletions

View File

@@ -0,0 +1,35 @@
using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs;
namespace Aaru.Images;
/// <inheritdoc cref="Aaru.CommonTypes.Interfaces.IWritableOpticalImage" />
/// <summary>Implements reading and writing AaruFormat media images</summary>
public sealed partial class AaruFormat : IWritableOpticalImage, IVerifiableImage, IWritableTapeImage
{
readonly ImageInfo _imageInfo;
public AaruFormat() => _imageInfo = new ImageInfo
{
ReadableSectorTags = [],
ReadableMediaTags = [],
HasPartitions = false,
HasSessions = false,
Version = null,
Application = "Aaru",
ApplicationVersion = null,
Creator = null,
Comments = null,
MediaManufacturer = null,
MediaModel = null,
MediaSerialNumber = null,
MediaBarcode = null,
MediaPartNumber = null,
MediaSequence = 0,
LastMediaSequence = 0,
DriveManufacturer = null,
DriveModel = null,
DriveSerialNumber = null,
DriveFirmwareRevision = null
};
}

View File

@@ -0,0 +1,107 @@
using System;
using System.Collections.Generic;
using System.Linq;
using Aaru.CommonTypes;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
using Partition = Aaru.CommonTypes.Partition;
using Track = Aaru.CommonTypes.Structs.Track;
namespace Aaru.Images;
public sealed partial class AaruFormat
{
#region IWritableOpticalImage Members
/// <inheritdoc />
public OpticalImageCapabilities OpticalCapabilities => OpticalImageCapabilities.CanStoreAudioTracks |
OpticalImageCapabilities.CanStoreDataTracks |
OpticalImageCapabilities.CanStorePregaps |
OpticalImageCapabilities.CanStoreSubchannelRw |
OpticalImageCapabilities.CanStoreSessions |
OpticalImageCapabilities.CanStoreIsrc |
OpticalImageCapabilities.CanStoreCdText |
OpticalImageCapabilities.CanStoreMcn |
OpticalImageCapabilities.CanStoreRawData |
OpticalImageCapabilities.CanStoreCookedData |
OpticalImageCapabilities.CanStoreMultipleTracks |
OpticalImageCapabilities.CanStoreNotCdSessions |
OpticalImageCapabilities.CanStoreNotCdTracks |
OpticalImageCapabilities.CanStoreIndexes |
OpticalImageCapabilities.CanStoreHiddenTracks;
/// <inheritdoc />
// ReSharper disable once ConvertToAutoProperty
public ImageInfo Info => _imageInfo;
/// <inheritdoc />
public string Name => Localization.AaruFormat_Name;
/// <inheritdoc />
public Guid Id => new("D98C9259-482C-4F0A-B428-18736DC039A6");
/// <inheritdoc />
public string Format => "Aaru";
/// <inheritdoc />
public string Author => Authors.NataliaPortillo;
/// <inheritdoc />
public List<Partition> Partitions { get; private set; }
/// <inheritdoc />
public List<Track> Tracks { get; private set; }
/// <inheritdoc />
public List<Session> Sessions { get; private set; }
/// <inheritdoc />
public List<DumpHardware> DumpHardware { get; private set; }
/// <inheritdoc />
public Metadata AaruMetadata { get; private set; }
/// <inheritdoc />
public IEnumerable<MediaTagType> SupportedMediaTags => Enum.GetValues(typeof(MediaTagType)).Cast<MediaTagType>();
/// <inheritdoc />
public IEnumerable<SectorTagType> SupportedSectorTags =>
Enum.GetValues(typeof(SectorTagType)).Cast<SectorTagType>();
/// <inheritdoc />
public IEnumerable<MediaType> SupportedMediaTypes => Enum.GetValues(typeof(MediaType)).Cast<MediaType>();
/// <inheritdoc />
public IEnumerable<(string name, Type type, string description, object @default)> SupportedOptions =>
[
("dictionary", typeof(uint), Localization.Size_in_bytes_of_the_LZMA_dictionary, (uint)(1 << 25)),
("md5", typeof(bool), Localization.Calculate_and_store_MD5_of_image_user_data, false),
("sha1", typeof(bool), Localization.Calculate_and_store_SHA1_of_image_user_data, false),
("sha256", typeof(bool), Localization.Calculate_and_store_SHA256_of_image_user_data, false),
("spamsum", typeof(bool), Localization.Calculate_and_store_SpamSum_of_image_user_data, false),
("blake3", typeof(bool), "Calculate and store BLAKE3 of image's user data", false),
("deduplicate", typeof(bool),
Localization.Store_only_unique_sectors_This_consumes_more_memory_and_is_slower_but_its_enabled_by_default,
true),
("compress", typeof(bool), Localization.Compress_user_data_blocks_Other_blocks_will_always_be_compressed,
true),
("table_shift", typeof(int),
"Shift value of how many sectors are stored per primary table entry. -1 for automatic, 0 to use a single table level.",
-1),
("data_shift", typeof(int), "Shift value of how many sectors are stored per data block.", 12),
("block_alignment", typeof(uint), "Shift value of alignment of blocks in the image", 9)
];
/// <inheritdoc />
public IEnumerable<string> KnownExtensions => [".dicf", ".aaru", ".aaruformat", ".aaruf", ".aif"];
/// <inheritdoc />
public bool IsWriting { get; private set; }
/// <inheritdoc />
public string ErrorMessage { get; private set; }
#endregion
}

View File

@@ -0,0 +1,163 @@
using System;
using System.Collections.Generic;
using Aaru.CommonTypes;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.CommonTypes.Structs;
using TapeFile = Aaru.CommonTypes.Structs.TapeFile;
using TapePartition = Aaru.CommonTypes.Structs.TapePartition;
using Track = Aaru.CommonTypes.Structs.Track;
namespace Aaru.Images;
public sealed partial class AaruFormat
{
#region IVerifiableImage Members
/// <inheritdoc />
public bool? VerifyMediaImage() => throw new NotImplementedException();
#endregion
#region IWritableOpticalImage Members
/// <inheritdoc />
public bool Identify(IFilter imageFilter) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber Open(IFilter imageFilter) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadMediaTag(MediaTagType tag, out byte[] buffer) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSector(ulong sectorAddress, out byte[] buffer) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorLong(ulong sectorAddress, out byte[] buffer) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectors(ulong sectorAddress, uint length, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorsLong(ulong sectorAddress, uint length, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorsTag(ulong sectorAddress, uint length, SectorTagType tag, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorTag(ulong sectorAddress, SectorTagType tag, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors,
uint sectorSize) => throw new NotImplementedException();
/// <inheritdoc />
public bool Close() => throw new NotImplementedException();
/// <inheritdoc />
public bool SetMetadata(Metadata metadata) => throw new NotImplementedException();
/// <inheritdoc />
public bool SetDumpHardware(List<DumpHardware> dumpHardware) => throw new NotImplementedException();
/// <inheritdoc />
public bool SetImageInfo(ImageInfo imageInfo) => throw new NotImplementedException();
/// <inheritdoc />
public bool SetGeometry(uint cylinders, uint heads, uint sectorsPerTrack) => throw new NotImplementedException();
/// <inheritdoc />
public bool WriteMediaTag(byte[] data, MediaTagType tag) => throw new NotImplementedException();
/// <inheritdoc />
public bool WriteSector(byte[] data, ulong sectorAddress) => throw new NotImplementedException();
/// <inheritdoc />
public bool WriteSectorLong(byte[] data, ulong sectorAddress) => throw new NotImplementedException();
/// <inheritdoc />
public bool WriteSectors(byte[] data, ulong sectorAddress, uint length) => throw new NotImplementedException();
/// <inheritdoc />
public bool WriteSectorsLong(byte[] data, ulong sectorAddress, uint length) => throw new NotImplementedException();
/// <inheritdoc />
public bool WriteSectorsTag(byte[] data, ulong sectorAddress, uint length, SectorTagType tag) =>
throw new NotImplementedException();
/// <inheritdoc />
public bool WriteSectorTag(byte[] data, ulong sectorAddress, SectorTagType tag) =>
throw new NotImplementedException();
/// <inheritdoc />
public bool? VerifySector(ulong sectorAddress) => throw new NotImplementedException();
/// <inheritdoc />
public bool? VerifySectors(ulong sectorAddress, uint length, out List<ulong> failingLbas,
out List<ulong> unknownLbas) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSector(ulong sectorAddress, uint track, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorTag(ulong sectorAddress, uint track, SectorTagType tag, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectors(ulong sectorAddress, uint length, uint track, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorsTag(ulong sectorAddress, uint length, uint track, SectorTagType tag,
out byte[] buffer) => throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorLong(ulong sectorAddress, uint track, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public ErrorNumber ReadSectorsLong(ulong sectorAddress, uint length, uint track, out byte[] buffer) =>
throw new NotImplementedException();
/// <inheritdoc />
public List<Track> GetSessionTracks(Session session) => throw new NotImplementedException();
/// <inheritdoc />
public List<Track> GetSessionTracks(ushort session) => throw new NotImplementedException();
/// <inheritdoc />
public bool? VerifySectors(ulong sectorAddress, uint length, uint track, out List<ulong> failingLbas,
out List<ulong> unknownLbas) => throw new NotImplementedException();
/// <inheritdoc />
public bool SetTracks(List<Track> tracks) => throw new NotImplementedException();
#endregion
#region IWritableTapeImage Members
/// <inheritdoc />
public List<TapeFile> Files { get; }
/// <inheritdoc />
public List<TapePartition> TapePartitions { get; }
/// <inheritdoc />
public bool IsTape { get; }
/// <inheritdoc />
public bool AddFile(TapeFile file) => throw new NotImplementedException();
/// <inheritdoc />
public bool AddPartition(TapePartition partition) => throw new NotImplementedException();
/// <inheritdoc />
public bool SetTape() => throw new NotImplementedException();
#endregion
}