Files
Aaru/Aaru.Filesystems/Nintendo/Info.cs

368 lines
17 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Info.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Nintendo optical filesystems plugin.
//
// --[ 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.Text;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Helpers;
using Aaru.Logging;
using Partition = Aaru.CommonTypes.Partition;
namespace Aaru.Filesystems;
/// <inheritdoc />
/// <summary>Implements detection of the filesystem used by Nintendo Gamecube and Wii discs</summary>
public sealed partial class NintendoPlugin
{
#region IFilesystem Members
/// <inheritdoc />
public bool Identify(IMediaImage imagePlugin, Partition partition)
{
if(partition.Start != 0) return false;
if(imagePlugin.Info.Sectors * imagePlugin.Info.SectorSize < 0x50000) return false;
ErrorNumber errno = imagePlugin.ReadSectors(0, 0x50000 / imagePlugin.Info.SectorSize, out byte[] header);
if(errno != ErrorNumber.NoError) return false;
uint magicGc = BigEndianBitConverter.ToUInt32(header, 0x1C);
uint magicWii = BigEndianBitConverter.ToUInt32(header, 0x18);
return magicGc == 0xC2339F3D || magicWii == 0x5D1C9EA3;
}
/// <inheritdoc />
public void GetInformation(IMediaImage imagePlugin, Partition partition, Encoding encoding, out string information,
out FileSystem metadata)
{
encoding ??= Encoding.GetEncoding("shift_jis");
var sbInformation = new StringBuilder();
information = "";
metadata = new FileSystem();
var fields = new NintendoFields();
ErrorNumber errno = imagePlugin.ReadSectors(0, 0x50000 / imagePlugin.Info.SectorSize, out byte[] header);
if(errno != ErrorNumber.NoError) return;
bool wii = false;
uint magicGc = BigEndianBitConverter.ToUInt32(header, 0x1C);
uint magicWii = BigEndianBitConverter.ToUInt32(header, 0x18);
if(magicWii == 0x5D1C9EA3)
wii = true;
else if(magicGc != 0xC2339F3D) return;
fields.DiscType = Encoding.ASCII.GetString(header, 0, 1);
fields.GameCode = Encoding.ASCII.GetString(header, 1, 2);
fields.RegionCode = Encoding.ASCII.GetString(header, 3, 1);
fields.PublisherCode = Encoding.ASCII.GetString(header, 4, 2);
fields.DiscId = Encoding.ASCII.GetString(header, 0, 6);
fields.DiscNumber = header[6];
fields.DiscVersion = header[7];
fields.Streaming |= header[8] > 0;
fields.StreamBufferSize = header[9];
byte[] temp = new byte[64];
Array.Copy(header, 0x20, temp, 0, 64);
fields.Title = StringHandlers.CToString(temp, encoding);
if(!wii)
{
fields.DebugOff = BigEndianBitConverter.ToUInt32(header, 0x0400);
fields.DebugAddr = BigEndianBitConverter.ToUInt32(header, 0x0404);
fields.DolOff = BigEndianBitConverter.ToUInt32(header, 0x0420);
fields.FstOff = BigEndianBitConverter.ToUInt32(header, 0x0424);
fields.FstSize = BigEndianBitConverter.ToUInt32(header, 0x0428);
fields.FstMax = BigEndianBitConverter.ToUInt32(header, 0x042C);
}
if(wii)
{
uint offset1 = BigEndianBitConverter.ToUInt32(header, 0x40004) << 2;
uint offset2 = BigEndianBitConverter.ToUInt32(header, 0x4000C) << 2;
uint offset3 = BigEndianBitConverter.ToUInt32(header, 0x40014) << 2;
uint offset4 = BigEndianBitConverter.ToUInt32(header, 0x4001C) << 2;
fields.FirstPartitions = new NintendoPartition[BigEndianBitConverter.ToUInt32(header, 0x40000)];
fields.SecondPartitions = new NintendoPartition[BigEndianBitConverter.ToUInt32(header, 0x40008)];
fields.ThirdPartitions = new NintendoPartition[BigEndianBitConverter.ToUInt32(header, 0x40010)];
fields.FourthPartitions = new NintendoPartition[BigEndianBitConverter.ToUInt32(header, 0x40018)];
for(int i = 0; i < fields.FirstPartitions.Length; i++)
{
if(offset1 + i * 8 + 8 >= 0x50000) continue;
fields.FirstPartitions[i].Offset =
BigEndianBitConverter.ToUInt32(header, (int)(offset1 + i * 8 + 0)) << 2;
fields.FirstPartitions[i].Type = BigEndianBitConverter.ToUInt32(header, (int)(offset1 + i * 8 + 4));
}
for(int i = 0; i < fields.SecondPartitions.Length; i++)
{
if(offset1 + i * 8 + 8 >= 0x50000) continue;
fields.FirstPartitions[i].Offset =
BigEndianBitConverter.ToUInt32(header, (int)(offset2 + i * 8 + 0)) << 2;
fields.FirstPartitions[i].Type = BigEndianBitConverter.ToUInt32(header, (int)(offset2 + i * 8 + 4));
}
for(int i = 0; i < fields.ThirdPartitions.Length; i++)
{
if(offset1 + i * 8 + 8 >= 0x50000) continue;
fields.FirstPartitions[i].Offset =
BigEndianBitConverter.ToUInt32(header, (int)(offset3 + i * 8 + 0)) << 2;
fields.FirstPartitions[i].Type = BigEndianBitConverter.ToUInt32(header, (int)(offset3 + i * 8 + 4));
}
for(int i = 0; i < fields.FourthPartitions.Length; i++)
{
if(offset1 + i * 8 + 8 >= 0x50000) continue;
fields.FirstPartitions[i].Offset =
BigEndianBitConverter.ToUInt32(header, (int)(offset4 + i * 8 + 0)) << 2;
fields.FirstPartitions[i].Type = BigEndianBitConverter.ToUInt32(header, (int)(offset4 + i * 8 + 4));
}
fields.Region = header[0x4E000];
fields.JapanAge = header[0x4E010];
fields.UsaAge = header[0x4E011];
fields.GermanAge = header[0x4E013];
fields.PegiAge = header[0x4E014];
fields.FinlandAge = header[0x4E015];
fields.PortugalAge = header[0x4E016];
fields.UkAge = header[0x4E017];
fields.AustraliaAge = header[0x4E018];
fields.KoreaAge = header[0x4E019];
}
else
{
fields.FirstPartitions = [];
fields.SecondPartitions = [];
fields.ThirdPartitions = [];
fields.FourthPartitions = [];
}
AaruLogging.Debug(MODULE_NAME, "discType = {0}", fields.DiscType);
AaruLogging.Debug(MODULE_NAME, "gameCode = {0}", fields.GameCode);
AaruLogging.Debug(MODULE_NAME, "regionCode = {0}", fields.RegionCode);
AaruLogging.Debug(MODULE_NAME, "publisherCode = {0}", fields.PublisherCode);
AaruLogging.Debug(MODULE_NAME, "discID = {0}", fields.DiscId);
AaruLogging.Debug(MODULE_NAME, "discNumber = {0}", fields.DiscNumber);
AaruLogging.Debug(MODULE_NAME, "discVersion = {0}", fields.DiscVersion);
AaruLogging.Debug(MODULE_NAME, "streaming = {0}", fields.Streaming);
AaruLogging.Debug(MODULE_NAME, "streamBufferSize = {0}", fields.StreamBufferSize);
AaruLogging.Debug(MODULE_NAME, "title = \"{0}\"", fields.Title);
AaruLogging.Debug(MODULE_NAME, "debugOff = 0x{0:X8}", fields.DebugOff);
AaruLogging.Debug(MODULE_NAME, "debugAddr = 0x{0:X8}", fields.DebugAddr);
AaruLogging.Debug(MODULE_NAME, "dolOff = 0x{0:X8}", fields.DolOff);
AaruLogging.Debug(MODULE_NAME, "fstOff = 0x{0:X8}", fields.FstOff);
AaruLogging.Debug(MODULE_NAME, "fstSize = {0}", fields.FstSize);
AaruLogging.Debug(MODULE_NAME, "fstMax = {0}", fields.FstMax);
for(int i = 0; i < fields.FirstPartitions.Length; i++)
{
AaruLogging.Debug(MODULE_NAME,
"firstPartitions[{1}].offset = {0}",
fields.FirstPartitions[i].Offset,
i);
AaruLogging.Debug(MODULE_NAME,
"firstPartitions[{1}].type = {0}",
fields.FirstPartitions[i].Type,
i);
}
for(int i = 0; i < fields.SecondPartitions.Length; i++)
{
AaruLogging.Debug(MODULE_NAME,
"secondPartitions[{1}].offset = {0}",
fields.SecondPartitions[i].Offset,
i);
AaruLogging.Debug(MODULE_NAME,
"secondPartitions[{1}].type = {0}",
fields.SecondPartitions[i].Type,
i);
}
for(int i = 0; i < fields.ThirdPartitions.Length; i++)
{
AaruLogging.Debug(MODULE_NAME,
"thirdPartitions[{1}].offset = {0}",
fields.ThirdPartitions[i].Offset,
i);
AaruLogging.Debug(MODULE_NAME,
"thirdPartitions[{1}].type = {0}",
fields.ThirdPartitions[i].Type,
i);
}
for(int i = 0; i < fields.FourthPartitions.Length; i++)
{
AaruLogging.Debug(MODULE_NAME,
"fourthPartitions[{1}].offset = {0}",
fields.FourthPartitions[i].Offset,
i);
AaruLogging.Debug(MODULE_NAME,
"fourthPartitions[{1}].type = {0}",
fields.FourthPartitions[i].Type,
i);
}
AaruLogging.Debug(MODULE_NAME, "region = {0}", fields.Region);
AaruLogging.Debug(MODULE_NAME, "japanAge = {0}", fields.JapanAge);
AaruLogging.Debug(MODULE_NAME, "usaAge = {0}", fields.UsaAge);
AaruLogging.Debug(MODULE_NAME, "germanAge = {0}", fields.GermanAge);
AaruLogging.Debug(MODULE_NAME, "pegiAge = {0}", fields.PegiAge);
AaruLogging.Debug(MODULE_NAME, "finlandAge = {0}", fields.FinlandAge);
AaruLogging.Debug(MODULE_NAME, "portugalAge = {0}", fields.PortugalAge);
AaruLogging.Debug(MODULE_NAME, "ukAge = {0}", fields.UkAge);
AaruLogging.Debug(MODULE_NAME, "australiaAge = {0}", fields.AustraliaAge);
AaruLogging.Debug(MODULE_NAME, "koreaAge = {0}", fields.KoreaAge);
sbInformation.AppendLine(Localization.Nintendo_optical_filesystem);
sbInformation.AppendLine(wii
? Localization.Nintendo_Wii_Optical_Disc
: Localization.Nintendo_GameCube_Optical_Disc);
sbInformation.AppendFormat(Localization.Disc_ID_is_0, fields.DiscId).AppendLine();
sbInformation.AppendFormat(Localization.Disc_is_a_0_disc, DiscTypeToString(fields.DiscType)).AppendLine();
sbInformation.AppendFormat(Localization.Disc_region_is_0, RegionCodeToString(fields.RegionCode)).AppendLine();
sbInformation.AppendFormat(Localization.Published_by_0, PublisherCodeToString(fields.PublisherCode))
.AppendLine();
if(fields.DiscNumber > 0)
{
sbInformation.AppendFormat(Localization.Disc_number_0_of_a_multi_disc_set, fields.DiscNumber + 1)
.AppendLine();
}
if(fields.Streaming) sbInformation.AppendLine(Localization.Disc_is_prepared_for_audio_streaming);
if(fields.StreamBufferSize > 0)
{
sbInformation.AppendFormat(Localization.Audio_streaming_buffer_size_is_0_bytes, fields.StreamBufferSize)
.AppendLine();
}
sbInformation.AppendFormat(Localization.Title_0, fields.Title).AppendLine();
if(wii)
{
for(int i = 0; i < fields.FirstPartitions.Length; i++)
{
sbInformation.AppendFormat(Localization.First_0_partition_starts_at_sector_1,
PartitionTypeToString(fields.FirstPartitions[i].Type),
fields.FirstPartitions[i].Offset / 2048)
.AppendLine();
}
for(int i = 0; i < fields.SecondPartitions.Length; i++)
{
sbInformation.AppendFormat(Localization.Second_0_partition_starts_at_sector_1,
PartitionTypeToString(fields.SecondPartitions[i].Type),
fields.SecondPartitions[i].Offset / 2048)
.AppendLine();
}
for(int i = 0; i < fields.ThirdPartitions.Length; i++)
{
sbInformation.AppendFormat(Localization.Third_0_partition_starts_at_sector_1,
PartitionTypeToString(fields.ThirdPartitions[i].Type),
fields.ThirdPartitions[i].Offset / 2048)
.AppendLine();
}
for(int i = 0; i < fields.FourthPartitions.Length; i++)
{
sbInformation.AppendFormat(Localization.Fourth_0_partition_starts_at_sector_1,
PartitionTypeToString(fields.FourthPartitions[i].Type),
fields.FourthPartitions[i].Offset / 2048)
.AppendLine();
}
// sbInformation.AppendFormat("Region byte is {0}", fields.region).AppendLine();
if((fields.JapanAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.Japan_age_rating_is_0, fields.JapanAge).AppendLine();
if((fields.UsaAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.ESRB_age_rating_is_0, fields.UsaAge).AppendLine();
if((fields.GermanAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.German_age_rating_is_0, fields.GermanAge).AppendLine();
if((fields.PegiAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.PEGI_age_rating_is_0, fields.PegiAge).AppendLine();
if((fields.FinlandAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.Finland_age_rating_is_0, fields.FinlandAge).AppendLine();
if((fields.PortugalAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.Portugal_age_rating_is_0, fields.PortugalAge).AppendLine();
if((fields.UkAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.UK_age_rating_is_0, fields.UkAge).AppendLine();
if((fields.AustraliaAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.Australia_age_rating_is_0, fields.AustraliaAge).AppendLine();
if((fields.KoreaAge & 0x80) != 0x80)
sbInformation.AppendFormat(Localization.Korea_age_rating_is_0, fields.KoreaAge).AppendLine();
}
else
{
sbInformation.AppendFormat(Localization.FST_starts_at_0_and_has_1_bytes, fields.FstOff, fields.FstSize)
.AppendLine();
}
information = sbInformation.ToString();
metadata.Bootable = true;
metadata.Clusters = imagePlugin.Info.Sectors * imagePlugin.Info.SectorSize / 2048;
metadata.ClusterSize = 2048;
metadata.Type = wii ? FS_TYPE_WII : FS_TYPE_NGC;
metadata.VolumeName = fields.Title;
metadata.VolumeSerial = fields.DiscId;
}
#endregion
}