19#ifndef LIBAARUFORMAT_CONTEXT_H
20#define LIBAARUFORMAT_CONTEXT_H
74#ifndef MD5_DIGEST_LENGTH
75#define MD5_DIGEST_LENGTH 16
78#ifndef SHA1_DIGEST_LENGTH
79#define SHA1_DIGEST_LENGTH 20
82#ifndef SHA256_DIGEST_LENGTH
83#define SHA256_DIGEST_LENGTH 32
422#ifndef AARUFORMAT_CONTEXT_DECLARED
423#define AARUFORMAT_CONTEXT_DECLARED
#define MD5_DIGEST_LENGTH
struct FluxCaptureMapEntry FluxCaptureMapEntry
struct TapeFileHashEntry tapeFileHashEntry
CRC64 (ECMA-182) core context and precomputed slicing-by-4 tables.
Data structures for flux transition capture support in Aaru disk images.
#define SHA1_DIGEST_LENGTH
#define SHA256_DIGEST_LENGTH
Lookup tables and state for Compact Disc EDC/ECC (P/Q) regeneration / verification.
uint8_t * ecc_f_table
Forward (F) ECC table.
bool inited_edc
True once EDC/ECC tables have been initialized.
uint32_t * edc_table
EDC (CRC) lookup table.
uint8_t * ecc_b_table
Backward (B) ECC table (allocated, size implementation-defined).
Collected whole‑image checksums / hashes present in a checksum block.
uint8_t * spamsum
SpamSum fuzzy hash (ASCII), allocated length+1 with trailing 0.
bool hasSha256
True if sha256[] buffer populated.
uint8_t sha1[20]
SHA-1 digest (20 bytes).
uint8_t sha256[32]
SHA-256 digest (32 bytes).
uint8_t md5[16]
MD5 digest (16 bytes).
bool hasSpamSum
True if spamsum pointer allocated and signature read.
bool hasSha1
True if sha1[] buffer populated.
uint8_t blake3[BLAKE3_OUT_LEN]
BLAKE3 digest (32 bytes).
bool hasMd5
True if md5[] buffer populated.
bool hasBlake3
True if blake3[] buffer populated.
Inclusive [start,end] logical sector range contributed by a single hardware environment.
uint64_t end
Ending LBA (inclusive); >= start.
uint64_t start
Starting LBA (inclusive).
In-memory representation of a dump hardware entry plus decoded variable-length fields & extents.
uint8_t * firmware
Firmware version string or NULL.
uint8_t * revision
Hardware revision string or NULL.
uint8_t * model
Model string or NULL.
uint8_t * softwareName
Dump software name or NULL.
struct DumpExtent * extents
Array of extents (entry.extents elements) or NULL.
uint8_t * manufacturer
Manufacturer string (UTF-8) or NULL.
uint8_t * softwareVersion
Dump software version or NULL.
uint8_t * serial
Serial number string or NULL.
DumpHardwareEntry entry
Fixed-size header with lengths & counts.
uint8_t * softwareOperatingSystem
Host operating system string or NULL.
Per-environment length table describing subsequent UTF-8 strings and optional extent array.
Internal hash table entry for flux capture lookup.
Metadata entry describing a single flux capture in the FluxDataBlock.
High-level summary of an opened Aaru image containing metadata and media characteristics.
UT_hash_handle hh
UTHASH handle.
uint64_t key
Key: sector address.
uint64_t value
Value: DDT entry.
Describes a single logical file on a tape medium.
UT_hash_handle hh
UTHASH handle.
uint64_t key
Composite key: partition << 32 | file.
TapeFileEntry fileEntry
The actual tape file data.
Describes a single physical partition on a tape medium.
UT_hash_handle hh
UTHASH handle.
uint8_t key
Key: partition.
TapePartitionEntry partitionEntry
The actual tape partition data.
Single optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags).
Master context representing an open or in‑creation Aaru image.
uint8_t * ps3_disc_key
Cached disc key (16 bytes), NULL if not loaded.
bool wiiu_building_crypto_block
True while gathering sectors for re-encryption (suppresses recursion).
uint64_t * ec_data_shard_crcs
Array of K * K CRC64 values for blocks in active stripes.
uint8_t * media_barcode
Barcode of the media represented by the image.
DdtHeader2 user_data_ddt_header
Active user data DDT v2 header (primary table meta).
uint32_t * ec_data_block_sizes
Array of K * K actual on-disk sizes for blocks in active stripes.
Checksums checksums
Whole-image checksums discovered.
uint8_t library_major_version
Linked library major version.
uint8_t * creator
Who (person) created the image?
bool dirty_checksum_block
True if checksum block should be written during close.
bool deduplicate
Storage deduplication active (duplicates coalesce).
size_t dpm_block_length
Length of dpm_block in bytes, 0 if not present.
void * wiiu_partition_regions
Parsed WiiuPartitionRegion array, NULL if not loaded.
size_t sector_suffix_length
Length of sector_suffix.
bool compression_enabled
True if block compression enabled (writing path).
uint64_t last_written_block
Last written block number (write path).
uint8_t * cicm_block
CICM XML payload.
uint8_t * sector_cpr_mai
DVD sector CPR_MAI (6 bytes) if present.
bool dirty_media_tags
True if media tags should be written during close.
hash_map_t * sector_hash_map
Deduplication hash map (fingerprint->entry mapping).
FluxHeader flux_data_header
Flux data header (if present).
uint32_t ps3_plaintext_region_count
Number of plaintext regions.
uint8_t * sector_prefix_corrected
Corrected variant (post error correction) if stored.
uint64_t * user_data_ddt
Legacy flat DDT pointer (NULL when using v2 mini/big arrays).
uint32_t wiiu_partition_region_count
Number of partition regions.
UT_array * flux_captures
Pending flux capture payloads (write path).
bool dirty_dpm_block
True if DPM block should be written or removed during close.
uint16_t ngcw_junk_seed_size
LFG seed size in uint32 words (expected: 17).
sha256_ctx sha256_context
Opaque SHA-256 context for streaming updates.
void * ec_rs_ctx
rs_context* (opaque RS codec), NULL if EC disabled.
uint32_t ec_meta_stripe_count
Number of metadata stripes.
uint8_t ec_algorithm
ErasureCodingAlgorithm (0=XOR, 1=RS-Vandermonde).
TrackEntry * data_tracks
Filtered list of data tracks (subset of trackEntries).
uint32_t cylinders
Cylinders of the media represented by the image.
bool calculating_sha256
True if whole-image SHA-256 being calculated on-the-fly.
bool dirty_primary_ddt
True if primary DDT table should be written during close.
uint8_t * drive_firmware_revision
Firmware revision of the drive used to read the media represented by the image.
uint8_t * media_serial_number
Serial number of the media represented by the image.
uint8_t * wiiu_encrypted_block_cache
Cached re-encrypted 0x8000-byte physical sector.
bool ec_recovery_in_progress
Recursion guard for recovery (prevents infinite loops).
void * ngcw_junk_entries
Parsed NgcwJunkEntry array, NULL if not loaded.
struct CacheHeader block_header_cache
LRU/Cache header for block headers.
uint8_t * sector_ied
DVD sector IED (2 bytes) if present.
md5_ctx md5_context
Opaque MD5 context for streaming updates.
bool dirty_sector_suffix_block
True if sector suffix block should be written during close.
uint64_t * user_data_ddt2
DDT entries (big variant) primary/secondary current.
uint32_t ec_data_shard_size
Max on-disk block size for data blocks (fixed at creation).
uint32_t ec_read_stripe_count
Number of data stripes parsed from ECMB.
MetadataBlockHeader metadata_block_header
Metadata block header.
int32_t media_sequence
Number in sequence for the media represented by the image.
uint8_t shift
Legacy overall shift (deprecated by data_shift/table_shift).
uint8_t * sector_prefix
Raw per-sector prefix (e.g., sync+header) uncorrected.
uint64_t wii_cached_physical_group
Physical group number of cached block.
bool dirty_dvd_title_key_decrypted_block
True if decrypted title key block should be written during close.
uint32_t ec_ddt_stripe_count
Number of DDT-secondary stripes.
FluxCaptureMapEntry * flux_map
Hash map for flux capture lookup by head/track/subtrack/capture index.
uint64_t * sector_suffix_ddt2
CD sector suffix DDT V2.
tapeFileHashEntry * tape_files
Hash table root for tape files.
bool dirty_mode2_subheaders_block
True if MODE2 subheader block should be written during close.
bool dirty_tape_partition_block
True if tape partition block should be written during close.
uint64_t cached_ddt_offset
File offset of currently cached secondary DDT (0=none).
bool dirty_cicm_block
True if CICM metadata block should be written during close.
bool is_tape
True if the image is a tape image.
uint8_t * sector_edc
DVD or Blu-ray sector EDC (4 bytes) if present (see DvdSectorEdc / BdSectorEdc data types).
bool calculating_sha1
True if whole-image SHA-1 being calculated on-the-fly.
uint8_t * media_model
Model of the media represented by the image.
bool dirty_tracks_block
True if tracks block should be written during close.
uint8_t * drive_serial_number
Serial number of the drive used to read the media represented by the image.
CdEccContext * ecc_cd_context
CD ECC/EDC helper tables (allocated on demand).
bool rewinded
True if stream has been rewound after open (write path).
struct CacheHeader block_cache
LRU/Cache header for block payloads.
bool ps3_encryption_initialized
Whether lazy init has occurred.
uint64_t wiiu_cached_physical_sector
Physical sector number of cached block.
uint32_t ec_meta_shard_size
Shard size for metadata group.
void * ec_ddt_block_lookup
uthash: block file offset → stripe index + position (DDT group).
uint32_t * sector_suffix_ddt
Legacy CD sector suffix DDT.
bool dirty_sector_prefix_block
True if sector prefix block should be written during close.
uint8_t * drive_manufacturer
Manufacturer of the drive used to read the media represented by the image.
bool in_memory_ddt
True if primary (and possibly secondary) DDT loaded.
bool dirty_index_block
True if index block should be written during close.
uint8_t * sector_suffix
Raw per-sector suffix (EDC/ECC) uncorrected.
uint64_t dpm_damaged_offset
Offset of a DPM block that failed to load, to recover it with erasure coding, or 0.
AaruHeaderV2 header
Parsed container header (v2).
int current_block_offset
Logical offset inside block (units: bytes or sectors depending on path).
UT_array * ec_data_stripes
Completed data stripe descriptors (serialized to ECMB).
FluxEntry * flux_entries
Array of flux entries (flux_data_header.entries elements).
bool dirty_json_block
True if JSON metadata block should be written during close.
bool is_writing
True if context opened/created for writing.
TapeDdtHashEntry * tape_ddt
Hash table root for tape DDT entries.
uint16_t ec_ddt_M
M for DDT-secondary group.
spamsum_ctx * spamsum_context
Opaque SpamSum context for streaming updates.
CicmMetadataBlock cicm_block_header
CICM metadata header (if present).
size_t sector_prefix_offset
Current position in sector_prefix.
uint8_t * drive_model
Model of the drive used to read the media represented by the image.
BlockHeader current_block_header
Header for block currently being assembled (write path).
bool dirty_single_level_ddt
True if single-level DDT should be written during close.
int ddt_version
DDT version in use (1=legacy, 2=v2 hierarchical).
uint64_t magic
File magic (AARU_MAGIC) post-open.
uint8_t * writing_buffer
Accumulation buffer for current block data.
uint64_t * sector_prefix_ddt2
CD sector prefix DDT V2.
uint16_t ec_meta_M
M for metadata group.
bool calculating_spamsum
True if whole-image SpamSum being calculated on-the-fly.
int32_t(*) finalize_write(struct aaruformat_context *ctx)
Writer finalization hook (NULL for reader).
uint64_t primary_ddt_offset
File offset of the primary DDT v2 table.
bool wii_building_crypto_block
True while gathering sectors for re-encryption (suppresses recursion).
size_t sector_prefix_length
Length of sector_prefix.
mediaTagEntry * mediaTags
Hash table of extra media tags (uthash root).
blake3_hasher * blake3_context
Opaque BLAKE3 context for streaming updates.
bool calculating_blake3
True if whole-image BLAKE3 being calculated on-the-fly.
uint8_t * wiiu_disc_key
Cached disc key (16 bytes), NULL if not loaded.
uint8_t library_minor_version
Linked library minor version;.
struct DumpHardwareEntriesWithData * dump_hardware_entries_with_data
Array of dump hardware entries + strings.
uint32_t ngcw_junk_entry_count
Number of junk entries.
uint64_t next_block_position
Absolute file offset where next block will be written.
bool calculating_md5
True if whole-image MD5 being calculated on-the-fly.
bool dirty_sector_suffix_ddt
True if sector suffix DDT should be written during close.
uint64_t * ec_data_block_offsets
Array of K * K file offsets for blocks in active stripes.
GeometryBlockHeader geometry_block
Logical geometry block (if present).
uint32_t ec_total_data_blocks
Total data blocks written (counter for round-robin assignment).
size_t sector_suffix_offset
Current position in sector_suffix.
uint16_t ec_M
Parity blocks per stripe.
bool has_zstd_blocks
True if any block was actually written with Zstandard compression.
uint64_t * cached_secondary_ddt2
Cached secondary table (big entries) or NULL.
uint8_t * json_block
JSON metadata block payload (UTF-8).
int zstd_level
Zstandard compression level (writing path, default 19).
uint8_t * media_part_number
Part number of the media represented by the image.
uint32_t wii_partition_region_count
Number of partition regions.
bool wiiu_encryption_initialized
Whether lazy init has occurred.
uint16_t * ec_data_stripe_counts
Array of K: blocks accumulated per stripe slot.
uint8_t * sector_decrypted_title_key
DVD decrypted title key (5 bytes) if present.
bool wii_encryption_initialized
Whether lazy init has occurred.
bool dirty_dumphw_block
True if dump hardware block should be written during close.
AaruMetadataJsonBlockHeader json_block_header
JSON metadata block header (if present).
int writing_buffer_position
Current size / position within writingBuffer.
bool dirty_metadata_block
True if metadata block should be written during close.
bool block_zero_written
True if block zero has been written (writing path).
void * ec_read_stripes
Parsed EcReadStripe array for data group, NULL if no ECMB.
crc64_ctx * crc64_context
Opaque CRC64 context for streaming updates.
uint32_t sectors_per_track
Sectors per track of the media represented by the image (for variable image, the smallest).
uint8_t * sector_subchannel
Raw 96-byte subchannel (if captured).
void * wii_partition_regions
Parsed WiiPartitionRegion array, NULL if not loaded.
void * ec_block_lookup
uthash: block file offset → stripe index + position (data group).
uint8_t * comments
Image comments.
uint32_t heads
Heads of the media represented by the image.
bool dirty_sector_subchannel_block
True if subchannel block should be written during close.
void * ec_ddt_stripes
Parsed EcReadStripe array for DDT-secondary group.
FILE * imageStream
Underlying FILE* stream (binary mode).
void * ec_meta_block_lookup
uthash: block file offset → stripe index + position (metadata group).
bool dirty_dvd_long_sector_blocks
True if DVD long sector blocks should be written during close.
bool no_user_data_ddt
True if image intentionally has no user-data DDT (e.g. flux-only image). When set,...
bool dirty_sector_prefix_ddt
True if sector prefix DDT should be written during close.
UT_array * index_entries
Flattened index entries (UT_array of IndexEntry).
int num_threads
Compression worker threads (1 = single-threaded, default).
bool dirty_tape_file_block
True if tape file block should be written during close.
uint32_t ec_ddt_shard_size
Shard size for DDT-secondary group.
bool ec_enabled
True if erasure coding is active.
uint8_t ** ec_data_parity
Array of K * M parity buffers (interleaved stripe slots).
uint16_t ec_ddt_K
K for DDT-secondary group.
uint8_t * mode2_subheaders
MODE2 Form1/Form2 8-byte subheaders (concatenated).
bool dirty_bd_sector_edc_block
True if Blu-ray sector EDC data block should be written during close.
ImageInfo image_info
Exposed high-level image info summary.
bool wii_cache_valid
Whether the encrypted group cache is valid.
bool dirty_flux_block
True if flux block should be written during close.
uint8_t * sector_id
DVD sector ID (4 bytes) if present.
DumpHardwareHeader dump_hardware_header
Dump hardware header.
void * ec_meta_stripes
Parsed EcReadStripe array for metadata group.
void * ps3_plaintext_regions
Parsed Ps3PlaintextRegion array (max 32), NULL if not loaded.
bool use_zstd
Use Zstandard instead of LZMA for data blocks.
sha1_ctx sha1_context
Opaque SHA-1 context for streaming updates.
bool dirty_secondary_ddt
True if secondary DDT tables should be written during close.
bool * readableSectorTags
Per-sector boolean array (optical tags read successfully?).
bool dirty_tape_ddt
True if tape DDT should be written during close.
TapePartitionHashEntry * tape_partitions
Hash table root for tape partitions.
uint32_t * sector_prefix_ddt
Legacy CD sector prefix DDT (deprecated by *2).
uint8_t * dpm_block
Data Position Measurement block, header included.
uint32_t lzma_dict_size
LZMA dictionary size (writing path).
bool wiiu_cache_valid
Whether the encrypted block cache is valid.
TrackEntry * track_entries
Full track list (tracksHeader.entries elements).
uint8_t number_of_data_tracks
Count of tracks considered "data" (sequence 1..99 heuristics).
uint8_t * sector_suffix_corrected
Corrected suffix if stored separately.
uint8_t * metadata_block
Raw metadata UTF-16LE concatenated strings.
uint8_t * wii_encrypted_group_cache
Cached re-encrypted 0x8000-byte group.
uint64_t cached_ddt_position
Position index of cached secondary DDT.
uint16_t ec_meta_K
K for metadata group.
uint8_t current_track_type
Current track type (when writing optical images with tracks, needed for block compression type).
bool writing_long
True if writing long sectors.
bool ngcw_junk_initialized
Whether junk map has been loaded.
uint8_t * media_title
Title of the media represented by the image.
bool dirty_geometry_block
True if geometry block should be written during close.
uint16_t ec_K
Data blocks per stripe.
int32_t last_media_sequence
Last media of the sequence the media represented by the image corresponds to.
bool ec_recovery_available
True if ECMB loaded and recovery is possible.
size_t mapped_memory_ddt_size
Length of mmapped DDT if userDataDdt is mmapped.
uint8_t * media_manufacturer
Manufacturer of the media represented by the image.
TracksHeader tracks_header
Tracks header (optical) if present.
Minimal ECMA-182 CRC64 incremental state container (running value only).
Minimal open-addressing hash map for 64-bit key/value pairs used in deduplication lookup.
Hash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor).
uint8_t * data
Tag data blob (opaque to library core); length bytes long.
int32_t type
Numeric type identifier.
uint32_t length
Length in bytes of data.
UT_hash_handle hh
uthash linkage.
1.18.0