Files
Aaru/Aaru.Images/CDRDAO/Write.cs

867 lines
27 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Write.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Writes cdrdao cuesheets (toc/bin).
//
// --[ 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.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using Aaru.CommonTypes;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
using Aaru.Logging;
using Track = Aaru.CommonTypes.Structs.Track;
using TrackType = Aaru.CommonTypes.Enums.TrackType;
namespace Aaru.Images;
public sealed partial class Cdrdao
{
#region IWritableOpticalImage Members
/// <inheritdoc />
public bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors,
uint negativeSectors, uint overflowSectors, uint sectorSize)
{
if(options != null)
{
if(options.TryGetValue("separate", out string tmpValue))
{
if(!bool.TryParse(tmpValue, out _separateTracksWriting))
{
ErrorMessage = Localization.Invalid_value_for_split_option;
return false;
}
if(_separateTracksWriting)
{
ErrorMessage = Localization.Separate_tracks_not_yet_implemented;
return false;
}
}
}
else
_separateTracksWriting = false;
if(negativeSectors != 0)
{
ErrorMessage = Localization.Negative_sectors_are_not_supported;
return false;
}
if(overflowSectors != 0)
{
ErrorMessage = Localization.Overflow_sectors_are_not_supported;
return false;
}
if(!SupportedMediaTypes.Contains(mediaType))
{
ErrorMessage = string.Format(Localization.Unsupported_media_format_0, mediaType);
return false;
}
_imageInfo = new ImageInfo
{
MediaType = mediaType,
SectorSize = sectorSize,
Sectors = sectors
};
// TODO: Separate tracks
try
{
_writingBaseName = Path.Combine(Path.GetDirectoryName(path) ?? "", Path.GetFileNameWithoutExtension(path));
_descriptorStream = new StreamWriter(path, false, Encoding.ASCII);
}
catch(IOException ex)
{
ErrorMessage = string.Format(Localization.Could_not_create_new_image_file_exception_0, ex.Message);
AaruLogging.Exception(ex, Localization.Could_not_create_new_image_file_exception_0, ex.Message);
return false;
}
_discimage = new CdrdaoDisc
{
Disktype = mediaType,
Tracks = []
};
_trackFlags = new Dictionary<byte, byte>();
_trackIsrcs = new Dictionary<byte, string>();
IsWriting = true;
ErrorMessage = null;
return true;
}
/// <inheritdoc />
public bool WriteMediaTag(byte[] data, MediaTagType tag)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
switch(tag)
{
case MediaTagType.CD_MCN:
_discimage.Mcn = Encoding.ASCII.GetString(data);
return true;
default:
ErrorMessage = string.Format(Localization.Unsupported_media_tag_0, tag);
return false;
}
}
/// <inheritdoc />
public bool WriteSector(byte[] data, ulong sectorAddress, bool negative, SectorStatus sectorStatus)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
Track track =
_writingTracks.FirstOrDefault(trk => sectorAddress >= trk.StartSector && sectorAddress <= trk.EndSector);
if(track is null)
{
ErrorMessage = string.Format(Localization.Cant_find_track_containing_0, sectorAddress);
return false;
}
FileStream trackStream = _writingStreams.FirstOrDefault(kvp => kvp.Key == track.Sequence).Value;
if(trackStream == null)
{
ErrorMessage = string.Format(Localization.Cant_find_file_containing_0, sectorAddress);
return false;
}
if(track.BytesPerSector != track.RawBytesPerSector)
{
ErrorMessage = Localization.Invalid_write_mode_for_this_sector;
return false;
}
if(data.Length != track.RawBytesPerSector)
{
ErrorMessage = Localization.Incorrect_data_size;
return false;
}
// cdrdao audio tracks are endian swapped corresponding to Aaru
if(track.Type == TrackType.Audio)
{
var swapped = new byte[data.Length];
for(long i = 0; i < swapped.Length; i += 2)
{
swapped[i] = data[i + 1];
swapped[i + 1] = data[i];
}
data = swapped;
}
trackStream.Seek((long)(track.FileOffset +
(sectorAddress - track.StartSector) * (ulong)track.RawBytesPerSector),
SeekOrigin.Begin);
trackStream.Write(data, 0, data.Length);
return true;
}
/// <inheritdoc />
public bool WriteSectors(byte[] data, ulong sectorAddress, bool negative, uint length, SectorStatus[] sectorStatus)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
Track track =
_writingTracks.FirstOrDefault(trk => sectorAddress >= trk.StartSector && sectorAddress <= trk.EndSector);
if(track is null)
{
ErrorMessage = string.Format(Localization.Cant_find_track_containing_0, sectorAddress);
return false;
}
FileStream trackStream = _writingStreams.FirstOrDefault(kvp => kvp.Key == track.Sequence).Value;
if(trackStream == null)
{
ErrorMessage = string.Format(Localization.Cant_find_file_containing_0, sectorAddress);
return false;
}
if(track.BytesPerSector != track.RawBytesPerSector)
{
ErrorMessage = Localization.Invalid_write_mode_for_this_sector;
return false;
}
if(sectorAddress + length > track.EndSector + 1)
{
ErrorMessage = Localization.Cant_cross_tracks;
return false;
}
if(data.Length % track.RawBytesPerSector != 0)
{
ErrorMessage = Localization.Incorrect_data_size;
return false;
}
// cdrdao audio tracks are endian swapped corresponding to Aaru
if(track.Type == TrackType.Audio)
{
var swapped = new byte[data.Length];
for(long i = 0; i < swapped.Length; i += 2)
{
swapped[i] = data[i + 1];
swapped[i + 1] = data[i];
}
data = swapped;
}
switch(track.SubchannelType)
{
case TrackSubchannelType.None:
trackStream.Seek((long)(track.FileOffset +
(sectorAddress - track.StartSector) * (ulong)track.RawBytesPerSector),
SeekOrigin.Begin);
trackStream.Write(data, 0, data.Length);
ErrorMessage = "";
return true;
case TrackSubchannelType.Raw:
case TrackSubchannelType.RawInterleaved:
trackStream.Seek((long)(track.FileOffset +
(sectorAddress - track.StartSector) * (ulong)(track.RawBytesPerSector + 96)),
SeekOrigin.Begin);
for(uint i = 0; i < length; i++)
{
trackStream.Write(data, (int)(i * track.RawBytesPerSector), track.RawBytesPerSector);
trackStream.Position += 96;
}
ErrorMessage = "";
return true;
default:
ErrorMessage = Localization.Invalid_subchannel_mode_for_this_sector;
return false;
}
}
/// <inheritdoc />
public bool WriteSectorLong(byte[] data, ulong sectorAddress, bool negative, SectorStatus sectorStatus)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
Track track =
_writingTracks.FirstOrDefault(trk => sectorAddress >= trk.StartSector && sectorAddress <= trk.EndSector);
if(track is null)
{
ErrorMessage = string.Format(Localization.Cant_find_track_containing_0, sectorAddress);
return false;
}
FileStream trackStream = _writingStreams.FirstOrDefault(kvp => kvp.Key == track.Sequence).Value;
if(trackStream == null)
{
ErrorMessage = string.Format(Localization.Cant_find_file_containing_0, sectorAddress);
return false;
}
if(data.Length != track.RawBytesPerSector)
{
ErrorMessage = Localization.Incorrect_data_size;
return false;
}
// cdrdao audio tracks are endian swapped corresponding to Aaru
if(track.Type == TrackType.Audio)
{
var swapped = new byte[data.Length];
for(long i = 0; i < swapped.Length; i += 2)
{
swapped[i] = data[i + 1];
swapped[i + 1] = data[i];
}
data = swapped;
}
var subchannelSize = (uint)(track.SubchannelType != TrackSubchannelType.None ? 96 : 0);
trackStream.Seek((long)(track.FileOffset +
(sectorAddress - track.StartSector) *
(ulong)(track.RawBytesPerSector + subchannelSize)),
SeekOrigin.Begin);
trackStream.Write(data, 0, data.Length);
return true;
}
/// <inheritdoc />
public bool WriteSectorsLong(byte[] data, ulong sectorAddress, bool negative, uint length,
SectorStatus[] sectorStatus)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
Track track =
_writingTracks.FirstOrDefault(trk => sectorAddress >= trk.StartSector && sectorAddress <= trk.EndSector);
if(track is null)
{
ErrorMessage = string.Format(Localization.Cant_find_track_containing_0, sectorAddress);
return false;
}
FileStream trackStream = _writingStreams.FirstOrDefault(kvp => kvp.Key == track.Sequence).Value;
if(trackStream == null)
{
ErrorMessage = string.Format(Localization.Cant_find_file_containing_0, sectorAddress);
return false;
}
if(sectorAddress + length > track.EndSector + 1)
{
ErrorMessage = Localization.Cant_cross_tracks;
return false;
}
if(data.Length % track.RawBytesPerSector != 0)
{
ErrorMessage = Localization.Incorrect_data_size;
return false;
}
// cdrdao audio tracks are endian swapped corresponding to Aaru
if(track.Type == TrackType.Audio)
{
var swapped = new byte[data.Length];
for(long i = 0; i < swapped.Length; i += 2)
{
swapped[i] = data[i + 1];
swapped[i + 1] = data[i];
}
data = swapped;
}
var subchannelSize = (uint)(track.SubchannelType != TrackSubchannelType.None ? 96 : 0);
for(uint i = 0; i < length; i++)
{
trackStream.Seek((long)(track.FileOffset +
(i + sectorAddress - track.StartSector) *
(ulong)(track.RawBytesPerSector + subchannelSize)),
SeekOrigin.Begin);
trackStream.Write(data, (int)(i * track.RawBytesPerSector), track.RawBytesPerSector);
}
return true;
}
/// <inheritdoc />
public bool SetTracks(List<Track> tracks)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(tracks == null || tracks.Count == 0)
{
ErrorMessage = Localization.Invalid_tracks_sent;
return false;
}
if(_writingTracks != null && _writingStreams != null)
{
foreach(FileStream oldTrack in _writingStreams.Select(static t => t.Value).Distinct()) oldTrack.Close();
}
ulong currentOffset = 0;
_writingTracks = [];
foreach(Track track in tracks.OrderBy(static t => t.Sequence))
{
if(track.SubchannelType is TrackSubchannelType.Q16 or TrackSubchannelType.Q16Interleaved)
{
ErrorMessage = string.Format(Localization.Unsupported_subchannel_type_0_for_track_1,
track.SubchannelType,
track.Sequence);
return false;
}
track.File = _separateTracksWriting
? _writingBaseName + $"_track{track.Sequence:D2}.bin"
: _writingBaseName + ".bin";
track.FileOffset = _separateTracksWriting ? 0 : currentOffset;
_writingTracks.Add(track);
currentOffset += (ulong)track.RawBytesPerSector * (track.EndSector - track.StartSector + 1);
if(track.SubchannelType != TrackSubchannelType.None)
currentOffset += 96 * (track.EndSector - track.StartSector + 1);
}
_writingStreams = new Dictionary<uint, FileStream>();
if(_separateTracksWriting)
{
foreach(Track track in _writingTracks)
{
_writingStreams.Add(track.Sequence,
new FileStream(track.File,
FileMode.OpenOrCreate,
FileAccess.ReadWrite,
FileShare.None));
}
}
else
{
var jointStream = new FileStream(_writingBaseName + ".bin",
FileMode.OpenOrCreate,
FileAccess.ReadWrite,
FileShare.None);
foreach(Track track in _writingTracks) _writingStreams.Add(track.Sequence, jointStream);
}
return true;
}
/// <inheritdoc />
public bool Close()
{
if(!IsWriting)
{
ErrorMessage = Localization.Image_is_not_opened_for_writing;
return false;
}
if(_separateTracksWriting)
{
foreach(FileStream writingStream in _writingStreams.Values)
{
writingStream.Flush();
writingStream.Close();
}
}
else
{
_writingStreams.First().Value.Flush();
_writingStreams.First().Value.Close();
}
bool data = _writingTracks.Count(static t => t.Type != TrackType.Audio) > 0;
bool mode2 =
_writingTracks.Count(static t => t.Type is TrackType.CdMode2Form1
or TrackType.CdMode2Form2
or TrackType.CdMode2Formless) >
0;
if(mode2)
_descriptorStream.WriteLine("CD_ROM_XA");
else if(data)
_descriptorStream.WriteLine("CD_ROM");
else
_descriptorStream.WriteLine("CD_DA");
if(!string.IsNullOrWhiteSpace(_discimage.Comment))
{
string[] commentLines = _discimage.Comment.Split(['\n'], StringSplitOptions.RemoveEmptyEntries);
foreach(string line in commentLines) _descriptorStream.WriteLine("// {0}", line);
}
_descriptorStream.WriteLine();
if(!string.IsNullOrEmpty(_discimage.Mcn)) _descriptorStream.WriteLine("CATALOG {0}", _discimage.Mcn);
foreach(Track track in _writingTracks)
{
_descriptorStream.WriteLine();
_descriptorStream.WriteLine("// Track {0}", track.Sequence);
string subchannelType = track.SubchannelType switch
{
TrackSubchannelType.Packed or TrackSubchannelType.PackedInterleaved => " RW",
TrackSubchannelType.Raw or TrackSubchannelType.RawInterleaved => " RW_RAW",
_ => ""
};
_descriptorStream.WriteLine("TRACK {0}{1}", GetTrackMode(track), subchannelType);
_trackFlags.TryGetValue((byte)track.Sequence, out byte flagsByte);
var flags = (CdFlags)flagsByte;
_descriptorStream.WriteLine("{0}COPY", flags.HasFlag(CdFlags.CopyPermitted) ? "" : "NO ");
if(track.Type == TrackType.Audio)
{
_descriptorStream.WriteLine("{0}PRE_EMPHASIS", flags.HasFlag(CdFlags.PreEmphasis) ? "" : "NO ");
_descriptorStream.WriteLine("{0}_CHANNEL_AUDIO", flags.HasFlag(CdFlags.FourChannel) ? "FOUR" : "TWO");
}
if(_trackIsrcs.TryGetValue((byte)track.Sequence, out string isrc) && !string.IsNullOrWhiteSpace(isrc))
_descriptorStream.WriteLine("ISRC {0}", isrc);
(byte minute, byte second, byte frame) msf = LbaToMsf(track.EndSector - track.StartSector + 1);
_descriptorStream.WriteLine("DATAFILE \"{0}\" #{1} {2:D2}:{3:D2}:{4:D2} // length in bytes: {5}",
Path.GetFileName(track.File),
track.FileOffset,
msf.minute,
msf.second,
msf.frame,
(track.EndSector - track.StartSector + 1) *
(ulong)(track.RawBytesPerSector +
(track.SubchannelType != TrackSubchannelType.None ? 96 : 0)));
foreach(KeyValuePair<ushort, int> index in track.Indexes.Where(static i => i.Key > 1)
.OrderBy(static i => i.Key))
{
msf = LbaToMsf((ulong)index.Value - (track.Pregap + track.StartSector));
_descriptorStream.WriteLine("INDEX {0:D2}:{1:D2}:{2:D2}", msf.minute, msf.second, msf.frame);
}
_descriptorStream.WriteLine();
}
_descriptorStream.Flush();
_descriptorStream.Close();
IsWriting = false;
ErrorMessage = "";
return true;
}
/// <inheritdoc />
public bool SetImageInfo(ImageInfo imageInfo)
{
_discimage.Barcode = imageInfo.MediaBarcode;
_discimage.Comment = imageInfo.Comments;
return true;
}
/// <inheritdoc />
public bool SetGeometry(uint cylinders, uint heads, uint sectorsPerTrack)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
/// <inheritdoc />
public bool WriteSectorTag(byte[] data, ulong sectorAddress, bool negative, SectorTagType tag)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
Track track =
_writingTracks.FirstOrDefault(trk => sectorAddress >= trk.StartSector && sectorAddress <= trk.EndSector);
if(track is null)
{
ErrorMessage = string.Format(Localization.Cant_find_track_containing_0, sectorAddress);
return false;
}
switch(tag)
{
case SectorTagType.CdTrackFlags:
{
if(data.Length != 1)
{
ErrorMessage = Localization.Incorrect_data_size_for_track_flags;
return false;
}
_trackFlags[(byte)sectorAddress] = data[0];
return true;
}
case SectorTagType.CdTrackIsrc:
{
if(data != null) _trackIsrcs[(byte)sectorAddress] = Encoding.UTF8.GetString(data);
return true;
}
case SectorTagType.CdSectorSubchannel:
{
if(track.SubchannelType == 0)
{
ErrorMessage =
string.Format(Localization.Trying_to_write_subchannel_to_track_0_that_does_not_have_subchannel,
track.Sequence);
return false;
}
if(data.Length != 96)
{
ErrorMessage = Localization.Incorrect_data_size_for_subchannel;
return false;
}
FileStream trackStream = _writingStreams.FirstOrDefault(kvp => kvp.Key == track.Sequence).Value;
if(trackStream == null)
{
ErrorMessage = string.Format(Localization.Cant_find_file_containing_0, sectorAddress);
return false;
}
trackStream.Seek((long)(track.FileOffset +
(sectorAddress - track.StartSector) * (ulong)(track.RawBytesPerSector + 96)) +
track.RawBytesPerSector,
SeekOrigin.Begin);
trackStream.Write(data, 0, data.Length);
return true;
}
default:
ErrorMessage = string.Format(Localization.Unsupported_tag_type_0, tag);
return false;
}
}
/// <inheritdoc />
public bool WriteSectorsTag(byte[] data, ulong sectorAddress, bool negative, uint length, SectorTagType tag)
{
if(!IsWriting)
{
ErrorMessage = Localization.Tried_to_write_on_a_non_writable_image;
return false;
}
if(negative)
{
ErrorMessage = Localization.Unsupported_feature;
return false;
}
Track track =
_writingTracks.FirstOrDefault(trk => sectorAddress >= trk.StartSector && sectorAddress <= trk.EndSector);
if(track is null)
{
ErrorMessage = string.Format(Localization.Cant_find_track_containing_0, sectorAddress);
return false;
}
switch(tag)
{
case SectorTagType.CdTrackFlags:
case SectorTagType.CdTrackIsrc:
return WriteSectorTag(data, sectorAddress, false, tag);
case SectorTagType.CdSectorSubchannel:
{
if(track.SubchannelType == 0)
{
ErrorMessage =
string.Format(Localization.Trying_to_write_subchannel_to_track_0_that_does_not_have_subchannel,
track.Sequence);
return false;
}
if(data.Length % 96 != 0)
{
ErrorMessage = Localization.Incorrect_data_size_for_subchannel;
return false;
}
FileStream trackStream = _writingStreams.FirstOrDefault(kvp => kvp.Key == track.Sequence).Value;
if(trackStream == null)
{
ErrorMessage = string.Format(Localization.Cant_find_file_containing_0, sectorAddress);
return false;
}
for(uint i = 0; i < length; i++)
{
trackStream.Seek((long)(track.FileOffset +
(i + sectorAddress - track.StartSector) *
(ulong)(track.RawBytesPerSector + 96)) +
track.RawBytesPerSector,
SeekOrigin.Begin);
trackStream.Write(data, (int)(i * 96), 96);
}
return true;
}
default:
ErrorMessage = string.Format(Localization.Unsupported_tag_type_0, tag);
return false;
}
}
/// <inheritdoc />
public bool SetDumpHardware(List<DumpHardware> dumpHardware) => false;
/// <inheritdoc />
public bool SetMetadata(Metadata metadata) => false;
#endregion
}