Aaru/CDChecksums.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : CDChecksums.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Checksums.
//
// --[ Description ] ----------------------------------------------------------
//
//     Implements CD checksums.
//
// --[ License ] --------------------------------------------------------------
//
//     This program is free software: you can redistribute it and/or modify
//     it under the terms of the GNU General Public License as published by
//     the Free Software Foundation, either version 3 of the License, or
//     (at your option) any later version.
//
//     This program 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 General Public License for more details.
//
//     You should have received a copy of the GNU General Public License
//     along with this program.If not, see<http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2020 Natalia Portillo
// ECC algorithm from ECM(c) 2002-2011 Neill Corlett
// ****************************************************************************/

using System;
using System.Collections.Generic;
using Aaru.Console;

namespace Aaru.Checksums
{
    /// <summary>Implements ReedSolomon and CRC32 algorithms as used by CD-ROM</summary>
    public static class CdChecksums
    {
        static byte[] eccFTable;
        static byte[] eccBTable;
        static uint[] edcTable;

        public static bool? CheckCdSector(byte[] buffer)
        {
            switch(buffer.Length)
            {
                case 2448:
                {
                    byte[] subchannel = new byte[96];
                    byte[] channel    = new byte[2352];

                    Array.Copy(buffer, 0, channel, 0, 2352);
                    Array.Copy(buffer, 2352, subchannel, 0, 96);

                    bool? channelStatus    = CheckCdSectorChannel(channel);
                    bool? subchannelStatus = CheckCdSectorSubChannel(subchannel);
                    bool? status           = null;

                    if(channelStatus    == false ||
                       subchannelStatus == false)
                        status = false;

                    switch(channelStatus)
                    {
                        case null when subchannelStatus == true:
                            status = true;

                            break;
                        case true when subchannelStatus == null:
                            status = true;

                            break;
                    }

                    return status;
                }

                case 2352: return CheckCdSectorChannel(buffer);
                default:   return null;
            }
        }

        static void EccInit()
        {
            eccFTable = new byte[256];
            eccBTable = new byte[256];
            edcTable  = new uint[256];

            for(uint i = 0; i < 256; i++)
            {
                uint edc = i;
                uint j   = (uint)((i << 1) ^ ((i & 0x80) == 0x80 ? 0x11D : 0));
                eccFTable[i]     = (byte)j;
                eccBTable[i ^ j] = (byte)i;

                for(j = 0; j < 8; j++)
                    edc = (edc >> 1) ^ ((edc & 1) > 0 ? 0xD8018001 : 0);

                edcTable[i] = edc;
            }
        }

        static bool CheckEcc(byte[] address, byte[] data, uint majorCount, uint minorCount, uint majorMult,
                             uint minorInc, byte[] ecc)
        {
            uint size = majorCount * minorCount;
            uint major;

            for(major = 0; major < majorCount; major++)
            {
                uint index = ((major >> 1) * majorMult) + (major & 1);
                byte eccA  = 0;
                byte eccB  = 0;
                uint minor;

                for(minor = 0; minor < minorCount; minor++)
                {
                    byte temp = index < 4 ? address[index] : data[index - 4];
                    index += minorInc;

                    if(index >= size)
                        index -= size;

                    eccA ^= temp;
                    eccB ^= temp;
                    eccA =  eccFTable[eccA];
                }

                eccA = eccBTable[eccFTable[eccA] ^ eccB];

                if(ecc[major]              != eccA ||
                   ecc[major + majorCount] != (eccA ^ eccB))
                    return false;
            }

            return true;
        }

        static bool? CheckCdSectorChannel(byte[] channel)
        {
            EccInit();

            if(channel[0x000] != 0x00 ||
               channel[0x001] != 0xFF ||
               channel[0x002] != 0xFF ||
               channel[0x003] != 0xFF ||
               channel[0x004] != 0xFF ||
               channel[0x005] != 0xFF ||
               channel[0x006] != 0xFF ||
               channel[0x007] != 0xFF ||
               channel[0x008] != 0xFF ||
               channel[0x009] != 0xFF ||
               channel[0x00A] != 0xFF ||
               channel[0x00B] != 0x00)
                return null;

            //AaruConsole.DebugWriteLine("CD checksums", "Data sector, address {0:X2}:{1:X2}:{2:X2}", channel[0x00C],
            //                          channel[0x00D], channel[0x00E]);

            if(channel[0x00F] == 0x00) // mode (1 byte)
            {
                //AaruConsole.DebugWriteLine("CD checksums", "Mode 0 sector at address {0:X2}:{1:X2}:{2:X2}",
                //                          channel[0x00C], channel[0x00D], channel[0x00E]);
                for(int i = 0x010; i < 0x930; i++)
                    if(channel[i] != 0x00)
                    {
                        AaruConsole.DebugWriteLine("CD checksums",
                                                   "Mode 0 sector with error at address: {0:X2}:{1:X2}:{2:X2}",
                                                   channel[0x00C], channel[0x00D], channel[0x00E]);

                        return false;
                    }

                return true;
            }

            if(channel[0x00F] == 0x01) // mode (1 byte)
            {
                //AaruConsole.DebugWriteLine("CD checksums", "Mode 1 sector at address {0:X2}:{1:X2}:{2:X2}",
                //                          channel[0x00C], channel[0x00D], channel[0x00E]);

                if(channel[0x814] != 0x00 || // reserved (8 bytes)
                   channel[0x815] != 0x00 ||
                   channel[0x816] != 0x00 ||
                   channel[0x817] != 0x00 ||
                   channel[0x818] != 0x00 ||
                   channel[0x819] != 0x00 ||
                   channel[0x81A] != 0x00 ||
                   channel[0x81B] != 0x00)
                {
                    AaruConsole.DebugWriteLine("CD checksums",
                                               "Mode 1 sector with data in reserved bytes at address: {0:X2}:{1:X2}:{2:X2}",
                                               channel[0x00C], channel[0x00D], channel[0x00E]);

                    return false;
                }

                byte[] address = new byte[4];
                byte[] data    = new byte[2060];
                byte[] data2   = new byte[2232];
                byte[] eccP    = new byte[172];
                byte[] eccQ    = new byte[104];

                Array.Copy(channel, 0x0C, address, 0, 4);
                Array.Copy(channel, 0x10, data, 0, 2060);
                Array.Copy(channel, 0x10, data2, 0, 2232);
                Array.Copy(channel, 0x81C, eccP, 0, 172);
                Array.Copy(channel, 0x8C8, eccQ, 0, 104);

                bool failedEccP = !CheckEcc(address, data, 86, 24, 2, 86, eccP);
                bool failedEccQ = !CheckEcc(address, data2, 52, 43, 86, 88, eccQ);

                if(failedEccP)
                    AaruConsole.DebugWriteLine("CD checksums",
                                               "Mode 1 sector at address: {0:X2}:{1:X2}:{2:X2}, fails ECC P check",
                                               channel[0x00C], channel[0x00D], channel[0x00E]);

                if(failedEccQ)
                    AaruConsole.DebugWriteLine("CD checksums",
                                               "Mode 1 sector at address: {0:X2}:{1:X2}:{2:X2}, fails ECC Q check",
                                               channel[0x00C], channel[0x00D], channel[0x00E]);

                uint storedEdc     = BitConverter.ToUInt32(channel, 0x810);
                uint calculatedEdc = ComputeEdc(0, channel, 0x810);

                if(calculatedEdc == storedEdc)
                    return !failedEccP && !failedEccQ;

                AaruConsole.DebugWriteLine("CD checksums",
                                           "Mode 1 sector at address: {0:X2}:{1:X2}:{2:X2}, got CRC 0x{3:X8} expected 0x{4:X8}",
                                           channel[0x00C], channel[0x00D], channel[0x00E], calculatedEdc, storedEdc);

                return false;
            }

            if(channel[0x00F] == 0x02) // mode (1 byte)
            {
                //AaruConsole.DebugWriteLine("CD checksums", "Mode 2 sector at address {0:X2}:{1:X2}:{2:X2}",
                //                          channel[0x00C], channel[0x00D], channel[0x00E]);
                byte[] mode2Sector = new byte[channel.Length - 0x10];
                Array.Copy(channel, 0x10, mode2Sector, 0, mode2Sector.Length);

                if((channel[0x012] & 0x20) == 0x20) // mode 2 form 2
                {
                    if(channel[0x010] != channel[0x014] ||
                       channel[0x011] != channel[0x015] ||
                       channel[0x012] != channel[0x016] ||
                       channel[0x013] != channel[0x017])
                        AaruConsole.DebugWriteLine("CD checksums",
                                                   "Subheader copies differ in mode 2 form 2 sector at address: {0:X2}:{1:X2}:{2:X2}",
                                                   channel[0x00C], channel[0x00D], channel[0x00E]);

                    uint storedEdc = BitConverter.ToUInt32(mode2Sector, 0x91C);

                    // No CRC stored!
                    if(storedEdc == 0x00000000)
                        return true;

                    uint calculatedEdc = ComputeEdc(0, mode2Sector, 0x91C);

                    if(calculatedEdc == storedEdc ||
                       storedEdc     == 0x00000000)
                        return true;

                    AaruConsole.DebugWriteLine("CD checksums",
                                               "Mode 2 form 2 sector at address: {0:X2}:{1:X2}:{2:X2}, got CRC 0x{3:X8} expected 0x{4:X8}",
                                               channel[0x00C], channel[0x00D], channel[0x00E], calculatedEdc,
                                               storedEdc);

                    return false;
                }
                else
                {
                    if(channel[0x010] != channel[0x014] ||
                       channel[0x011] != channel[0x015] ||
                       channel[0x012] != channel[0x016] ||
                       channel[0x013] != channel[0x017])
                        AaruConsole.DebugWriteLine("CD checksums",
                                                   "Subheader copies differ in mode 2 form 1 sector at address: {0:X2}:{1:X2}:{2:X2}",
                                                   channel[0x00C], channel[0x00D], channel[0x00E]);

                    byte[] address = new byte[4];
                    byte[] eccP    = new byte[172];
                    byte[] eccQ    = new byte[104];

                    Array.Copy(mode2Sector, 0x80C, eccP, 0, 172);
                    Array.Copy(mode2Sector, 0x8B8, eccQ, 0, 104);

                    bool failedEccP = !CheckEcc(address, mode2Sector, 86, 24, 2, 86, eccP);
                    bool failedEccQ = !CheckEcc(address, mode2Sector, 52, 43, 86, 88, eccQ);

                    if(failedEccP)
                        AaruConsole.DebugWriteLine("CD checksums",
                                                   "Mode 2 form 1 sector at address: {0:X2}:{1:X2}:{2:X2}, fails ECC P check",
                                                   channel[0x00C], channel[0x00D], channel[0x00E]);

                    if(failedEccQ)
                        AaruConsole.DebugWriteLine("CD checksums",
                                                   "Mode 2 form 1 sector at address: {0:X2}:{1:X2}:{2:X2}, fails ECC Q check",
                                                   channel[0x00C], channel[0x00D], channel[0x00E]);

                    uint storedEdc     = BitConverter.ToUInt32(mode2Sector, 0x808);
                    uint calculatedEdc = ComputeEdc(0, mode2Sector, 0x808);

                    if(calculatedEdc == storedEdc)
                        return !failedEccP && !failedEccQ;

                    AaruConsole.DebugWriteLine("CD checksums",
                                               "Mode 2 sector at address: {0:X2}:{1:X2}:{2:X2}, got CRC 0x{3:X8} expected 0x{4:X8}",
                                               channel[0x00C], channel[0x00D], channel[0x00E], calculatedEdc,
                                               storedEdc);

                    return false;
                }
            }

            AaruConsole.DebugWriteLine("CD checksums", "Unknown mode {0} sector at address: {1:X2}:{2:X2}:{3:X2}",
                                       channel[0x00F], channel[0x00C], channel[0x00D], channel[0x00E]);

            return null;
        }

        static uint ComputeEdc(uint edc, IReadOnlyList<byte> src, int size)
        {
            int pos = 0;

            for(; size > 0; size--)
                edc = (edc >> 8) ^ edcTable[(edc ^ src[pos++]) & 0xFF];

            return edc;
        }

        static bool? CheckCdSectorSubChannel(IReadOnlyList<byte> subchannel)
        {
            bool?  status       = true;
            byte[] qSubChannel  = new byte[12];
            byte[] cdTextPack1  = new byte[18];
            byte[] cdTextPack2  = new byte[18];
            byte[] cdTextPack3  = new byte[18];
            byte[] cdTextPack4  = new byte[18];
            byte[] cdSubRwPack1 = new byte[24];
            byte[] cdSubRwPack2 = new byte[24];
            byte[] cdSubRwPack3 = new byte[24];
            byte[] cdSubRwPack4 = new byte[24];

            int i = 0;

            for(int j = 0; j < 12; j++)
                qSubChannel[j] = 0;

            for(int j = 0; j < 18; j++)
            {
                cdTextPack1[j] = 0;
                cdTextPack2[j] = 0;
                cdTextPack3[j] = 0;
                cdTextPack4[j] = 0;
            }

            for(int j = 0; j < 24; j++)
            {
                cdSubRwPack1[j] = 0;
                cdSubRwPack2[j] = 0;
                cdSubRwPack3[j] = 0;
                cdSubRwPack4[j] = 0;
            }

            for(int j = 0; j < 12; j++)
            {
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) << 1));
                qSubChannel[j] = (byte)(qSubChannel[j] | (subchannel[i++] & 0x40));
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) >> 1));
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) >> 2));
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) >> 3));
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) >> 4));
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) >> 5));
                qSubChannel[j] = (byte)(qSubChannel[j] | ((subchannel[i++] & 0x40) >> 6));
            }

            i = 0;

            for(int j = 0; j < 18; j++)
            {
                if(j < 18)
                    cdTextPack1[j] = (byte)(cdTextPack1[j] | ((subchannel[i++] & 0x3F) << 2));

                if(j < 18)
                    cdTextPack1[j] = (byte)(cdTextPack1[j++] | ((subchannel[i] & 0xC0) >> 4));

                if(j < 18)
                    cdTextPack1[j] = (byte)(cdTextPack1[j] | ((subchannel[i++] & 0x0F) << 4));

                if(j < 18)
                    cdTextPack1[j] = (byte)(cdTextPack1[j++] | ((subchannel[i] & 0x3C) >> 2));

                if(j < 18)
                    cdTextPack1[j] = (byte)(cdTextPack1[j] | ((subchannel[i++] & 0x03) << 6));

                if(j < 18)
                    cdTextPack1[j] = (byte)(cdTextPack1[j] | (subchannel[i++] & 0x3F));
            }

            for(int j = 0; j < 18; j++)
            {
                if(j < 18)
                    cdTextPack2[j] = (byte)(cdTextPack2[j] | ((subchannel[i++] & 0x3F) << 2));

                if(j < 18)
                    cdTextPack2[j] = (byte)(cdTextPack2[j++] | ((subchannel[i] & 0xC0) >> 4));

                if(j < 18)
                    cdTextPack2[j] = (byte)(cdTextPack2[j] | ((subchannel[i++] & 0x0F) << 4));

                if(j < 18)
                    cdTextPack2[j] = (byte)(cdTextPack2[j++] | ((subchannel[i] & 0x3C) >> 2));

                if(j < 18)
                    cdTextPack2[j] = (byte)(cdTextPack2[j] | ((subchannel[i++] & 0x03) << 6));

                if(j < 18)
                    cdTextPack2[j] = (byte)(cdTextPack2[j] | (subchannel[i++] & 0x3F));
            }

            for(int j = 0; j < 18; j++)
            {
                if(j < 18)
                    cdTextPack3[j] = (byte)(cdTextPack3[j] | ((subchannel[i++] & 0x3F) << 2));

                if(j < 18)
                    cdTextPack3[j] = (byte)(cdTextPack3[j++] | ((subchannel[i] & 0xC0) >> 4));

                if(j < 18)
                    cdTextPack3[j] = (byte)(cdTextPack3[j] | ((subchannel[i++] & 0x0F) << 4));

                if(j < 18)
                    cdTextPack3[j] = (byte)(cdTextPack3[j++] | ((subchannel[i] & 0x3C) >> 2));

                if(j < 18)
                    cdTextPack3[j] = (byte)(cdTextPack3[j] | ((subchannel[i++] & 0x03) << 6));

                if(j < 18)
                    cdTextPack3[j] = (byte)(cdTextPack3[j] | (subchannel[i++] & 0x3F));
            }

            for(int j = 0; j < 18; j++)
            {
                if(j < 18)
                    cdTextPack4[j] = (byte)(cdTextPack4[j] | ((subchannel[i++] & 0x3F) << 2));

                if(j < 18)
                    cdTextPack4[j] = (byte)(cdTextPack4[j++] | ((subchannel[i] & 0xC0) >> 4));

                if(j < 18)
                    cdTextPack4[j] = (byte)(cdTextPack4[j] | ((subchannel[i++] & 0x0F) << 4));

                if(j < 18)
                    cdTextPack4[j] = (byte)(cdTextPack4[j++] | ((subchannel[i] & 0x3C) >> 2));

                if(j < 18)
                    cdTextPack4[j] = (byte)(cdTextPack4[j] | ((subchannel[i++] & 0x03) << 6));

                if(j < 18)
                    cdTextPack4[j] = (byte)(cdTextPack4[j] | (subchannel[i++] & 0x3F));
            }

            i = 0;

            for(int j = 0; j < 24; j++)
                cdSubRwPack1[j] = (byte)(subchannel[i++] & 0x3F);

            for(int j = 0; j < 24; j++)
                cdSubRwPack2[j] = (byte)(subchannel[i++] & 0x3F);

            for(int j = 0; j < 24; j++)
                cdSubRwPack3[j] = (byte)(subchannel[i++] & 0x3F);

            for(int j = 0; j < 24; j++)
                cdSubRwPack4[j] = (byte)(subchannel[i++] & 0x3F);

            switch(cdSubRwPack1[0])
            {
                case 0x00:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected Zero Pack in subchannel");

                    break;
                case 0x08:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected Line Graphics Pack in subchannel");

                    break;
                case 0x09:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected CD+G Pack in subchannel");

                    break;
                case 0x0A:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected CD+EG Pack in subchannel");

                    break;
                case 0x14:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected CD-TEXT Pack in subchannel");

                    break;
                case 0x18:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected CD+MIDI Pack in subchannel");

                    break;
                case 0x38:
                    AaruConsole.DebugWriteLine("CD checksums", "Detected User Pack in subchannel");

                    break;
                default:
                    AaruConsole.DebugWriteLine("CD checksums",
                                               "Detected unknown Pack type in subchannel: mode {0}, item {1}",
                                               Convert.ToString(cdSubRwPack1[0] & 0x38, 2),
                                               Convert.ToString(cdSubRwPack1[0] & 0x07, 2));

                    break;
            }

            ushort qSubChannelCrc    = BigEndianBitConverter.ToUInt16(qSubChannel, 10);
            byte[] qSubChannelForCrc = new byte[10];
            Array.Copy(qSubChannel, 0, qSubChannelForCrc, 0, 10);
            ushort calculatedQcrc = CRC16CCITTContext.Calculate(qSubChannelForCrc);

            if(qSubChannelCrc != calculatedQcrc)
            {
                AaruConsole.DebugWriteLine("CD checksums", "Q subchannel CRC 0x{0:X4}, expected 0x{1:X4}",
                                           calculatedQcrc, qSubChannelCrc);

                status = false;
            }

            if((cdTextPack1[0] & 0x80) == 0x80)
            {
                ushort cdTextPack1Crc    = BigEndianBitConverter.ToUInt16(cdTextPack1, 16);
                byte[] cdTextPack1ForCrc = new byte[16];
                Array.Copy(cdTextPack1, 0, cdTextPack1ForCrc, 0, 16);
                ushort calculatedCdtp1Crc = CRC16CCITTContext.Calculate(cdTextPack1ForCrc);

                if(cdTextPack1Crc != calculatedCdtp1Crc &&
                   cdTextPack1Crc != 0)
                {
                    AaruConsole.DebugWriteLine("CD checksums", "CD-Text Pack 1 CRC 0x{0:X4}, expected 0x{1:X4}",
                                               cdTextPack1Crc, calculatedCdtp1Crc);

                    status = false;
                }
            }

            if((cdTextPack2[0] & 0x80) == 0x80)
            {
                ushort cdTextPack2Crc    = BigEndianBitConverter.ToUInt16(cdTextPack2, 16);
                byte[] cdTextPack2ForCrc = new byte[16];
                Array.Copy(cdTextPack2, 0, cdTextPack2ForCrc, 0, 16);
                ushort calculatedCdtp2Crc = CRC16CCITTContext.Calculate(cdTextPack2ForCrc);

                AaruConsole.DebugWriteLine("CD checksums", "Cyclic CDTP2 0x{0:X4}, Calc CDTP2 0x{1:X4}", cdTextPack2Crc,
                                           calculatedCdtp2Crc);

                if(cdTextPack2Crc != calculatedCdtp2Crc &&
                   cdTextPack2Crc != 0)
                {
                    AaruConsole.DebugWriteLine("CD checksums", "CD-Text Pack 2 CRC 0x{0:X4}, expected 0x{1:X4}",
                                               cdTextPack2Crc, calculatedCdtp2Crc);

                    status = false;
                }
            }

            if((cdTextPack3[0] & 0x80) == 0x80)
            {
                ushort cdTextPack3Crc    = BigEndianBitConverter.ToUInt16(cdTextPack3, 16);
                byte[] cdTextPack3ForCrc = new byte[16];
                Array.Copy(cdTextPack3, 0, cdTextPack3ForCrc, 0, 16);
                ushort calculatedCdtp3Crc = CRC16CCITTContext.Calculate(cdTextPack3ForCrc);

                AaruConsole.DebugWriteLine("CD checksums", "Cyclic CDTP3 0x{0:X4}, Calc CDTP3 0x{1:X4}", cdTextPack3Crc,
                                           calculatedCdtp3Crc);

                if(cdTextPack3Crc != calculatedCdtp3Crc &&
                   cdTextPack3Crc != 0)
                {
                    AaruConsole.DebugWriteLine("CD checksums", "CD-Text Pack 3 CRC 0x{0:X4}, expected 0x{1:X4}",
                                               cdTextPack3Crc, calculatedCdtp3Crc);

                    status = false;
                }
            }

            if((cdTextPack4[0] & 0x80) != 0x80)
                return status;

            ushort cdTextPack4Crc    = BigEndianBitConverter.ToUInt16(cdTextPack4, 16);
            byte[] cdTextPack4ForCrc = new byte[16];
            Array.Copy(cdTextPack4, 0, cdTextPack4ForCrc, 0, 16);
            ushort calculatedCdtp4Crc = CRC16CCITTContext.Calculate(cdTextPack4ForCrc);

            AaruConsole.DebugWriteLine("CD checksums", "Cyclic CDTP4 0x{0:X4}, Calc CDTP4 0x{1:X4}", cdTextPack4Crc,
                                       calculatedCdtp4Crc);

            if(cdTextPack4Crc == calculatedCdtp4Crc ||
               cdTextPack4Crc == 0)
                return status;

            AaruConsole.DebugWriteLine("CD checksums", "CD-Text Pack 4 CRC 0x{0:X4}, expected 0x{1:X4}", cdTextPack4Crc,
                                       calculatedCdtp4Crc);

            return false;
        }
    }
}