libaaruformat/include/aaruformat/context.h

/*
 * This file is part of the Aaru Data Preservation Suite.
 * Copyright (c) 2019-2025 Natalia Portillo.
 *
 * 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/>.
 */

#ifndef LIBAARUFORMAT_CONTEXT_H
#define LIBAARUFORMAT_CONTEXT_H

#include "crc64.h"
#include "hash_map.h"
#include "lru.h"
#include "structs.h"
#include "utarray.h"

#ifndef MD5_DIGEST_LENGTH
#define MD5_DIGEST_LENGTH 16
#endif

#ifndef SHA1_DIGEST_LENGTH
#define SHA1_DIGEST_LENGTH 20
#endif

#ifndef SHA256_DIGEST_LENGTH
#define SHA256_DIGEST_LENGTH 32
#endif

typedef struct Crc64Context
{
    uint64_t finalSeed;
    uint64_t table[256];
    uint64_t hashInt;
} Crc64Context;

typedef struct CdEccContext
{
    bool      inited_edc;
    uint8_t  *ecc_b_table;
    uint8_t  *ecc_f_table;
    uint32_t *edc_table;
} CdEccContext;

typedef struct Checksums
{
    bool     hasMd5;
    bool     hasSha1;
    bool     hasSha256;
    bool     hasSpamSum;
    uint8_t  md5[MD5_DIGEST_LENGTH];
    uint8_t  sha1[SHA1_DIGEST_LENGTH];
    uint8_t  sha256[SHA256_DIGEST_LENGTH];
    uint8_t *spamsum;
} Checksums;

typedef struct mediaTagEntry
{
    uint8_t       *data;
    int32_t        type;
    uint32_t       length;
    UT_hash_handle hh;
} mediaTagEntry;

typedef struct aaruformatContext
{
    uint64_t                            magic;
    uint8_t                             libraryMajorVersion;
    uint8_t                             libraryMinorVersion;
    FILE                               *imageStream;
    AaruHeaderV2                        header;
    uint8_t                            *sectorPrefix;
    uint8_t                            *sectorPrefixCorrected;
    uint8_t                            *sectorSuffix;
    uint8_t                            *sectorSuffixCorrected;
    uint8_t                            *sectorSubchannel;
    uint8_t                            *mode2Subheaders;
    uint8_t                             shift;
    bool                                inMemoryDdt;
    uint64_t                           *userDataDdt;
    size_t                              mappedMemoryDdtSize;
    uint32_t                           *sectorPrefixDdt;
    uint32_t                           *sectorSuffixDdt;
    GeometryBlockHeader                 geometryBlock;
    MetadataBlockHeader                 metadataBlockHeader;
    uint8_t                            *metadataBlock;
    TracksHeader                        tracksHeader;
    TrackEntry                         *trackEntries;
    CicmMetadataBlock                   cicmBlockHeader;
    uint8_t                            *cicmBlock;
    DumpHardwareHeader                  dumpHardwareHeader;
    struct DumpHardwareEntriesWithData *dumpHardwareEntriesWithData;
    ImageInfo                           imageInfo;
    CdEccContext                       *eccCdContext;
    uint8_t                             numberOfDataTracks;
    TrackEntry                         *dataTracks;
    bool                               *readableSectorTags;
    struct CacheHeader                  blockHeaderCache;
    struct CacheHeader                  blockCache;
    Checksums                           checksums;
    mediaTagEntry                      *mediaTags;
    DdtHeader2                          userDataDdtHeader;
    int                                 ddtVersion;
    uint16_t                           *userDataDdtMini;
    uint32_t                           *userDataDdtBig;
    uint16_t                           *sectorPrefixDdtMini;
    uint16_t                           *sectorSuffixDdtMini;
    uint64_t                            cachedDdtOffset;
    uint64_t                            cachedDdtPosition;
    uint64_t                            primaryDdtOffset;
    uint16_t                           *cachedSecondaryDdtSmall;
    uint32_t                           *cachedSecondaryDdtBig;
    bool                                isWriting;
    BlockHeader                         currentBlockHeader;
    uint8_t                            *writingBuffer;
    int                                 currentBlockOffset;
    crc64_ctx                          *crc64Context;
    int                                 writingBufferPosition;
    uint64_t                            nextBlockPosition;
    UT_array                           *indexEntries;
    hash_map_t                         *sectorHashMap;
    bool                                deduplicate;
} aaruformatContext;

typedef struct DumpHardwareEntriesWithData
{
    DumpHardwareEntry  entry;
    struct DumpExtent *extents;
    uint8_t           *manufacturer;
    uint8_t           *model;
    uint8_t           *revision;
    uint8_t           *firmware;
    uint8_t           *serial;
    uint8_t           *softwareName;
    uint8_t           *softwareVersion;
    uint8_t           *softwareOperatingSystem;
} DumpHardwareEntriesWithData;

#pragma pack(push, 1)

typedef struct DumpExtent
{
    uint64_t start;
    uint64_t end;
} DumpExtent;

#pragma pack(pop)

#endif  // LIBAARUFORMAT_CONTEXT_H