enums.h

Go to the documentation of this file.

/*
 * This file is part of the Aaru Data Preservation Suite.
 * Copyright (c) 2019-2026 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_ENUMS_H
#define LIBAARUFORMAT_ENUMS_H
 
#ifndef _MSC_VER
#pragma clang diagnostic push
#pragma ide diagnostic ignored "OCUnusedGlobalDeclarationInspection"
#endif

typedef enum
{
    kCompressionNone    = 0,  
    kCompressionLzma    = 1,  
    kCompressionFlac    = 2,  
    kCompressionLzmaCst = 3,  
    kCompressionZstd    = 4,  
    kCompressionZstdCst = 5   
} CompressionType;

typedef enum
{
    kDataTypeNone                         = 0,   
    kDataTypeUserData                     = 1,   
    kDataTypeCdToc                        = 2,   
    kDataTypeSessionInfo                  = 3,   
    kDataTypeFullToc                      = 4,   
    kDataTypeCdPma                        = 5,   
    kDataTypeCdAtip                       = 6,   
    kDataTypeCdText                       = 7,   
    kDataTypeDvdPfi                       = 8,   
    kDataTypeDvdCmi                       = 9,   
    kDataTypeDvdDiscKey                   = 10,  
    kDataTypeDvdBca                       = 11,  
    kDataTypeDvdDmi                       = 12,  
    kDataTypeDvdMediaIdentifier           = 13,  
    kDataTypeDvdMkb                       = 14,  
    kDataTypeDvdRamDds                    = 15,  
    kDataTypeDvdRamMediumStatus           = 16,  
    kDataTypeDvdRamSpareArea              = 17,  
    kDataTypeDvdrRmd                      = 18,  
    kDataTypeDvdrPreRecordedInfo          = 19,  
    kDataTypeDvdrMediaIdentifier          = 20,  
    kDataTypeDvdrPfi                      = 21,  
    kDataTypeDvdAdip                      = 22,  
    kDataTypeHddvdCpi                     = 23,  
    kDataTypeHddvdMediumStatus            = 24,  
    kDataTypeDvddlLayerCapacity           = 25,  
    kDataTypeDvddlMiddleZoneAddress       = 26,  
    kDataTypeDvddlJumpIntervalSize        = 27,  
    kDataTypeDvddlManualLayerJumpLba      = 28,  
    kDataTypeBlurayDi                     = 29,  
    kDataTypeBlurayBca                    = 30,  
    kDataTypeBlurayDds                    = 31,  
    kDataTypeBlurayCartridgeStatus        = 32,  
    kDataTypeBluraySpareArea              = 33,  
    kDataTypeAacsVolumeIdentifier         = 34,  
    kDataTypeAacsSerialNumber             = 35,  
    kDataTypeAacsMediaIdentifier          = 36,  
    kDataTypeAacsMkb                      = 37,  
    kDataTypeAacsDataKeys                 = 38,  
    kDataTypeAacsLbaExtents               = 39,  
    kDataTypeCprmMkb                      = 40,  
    kDataTypeHybridRecognizedLayers       = 41,  
    kDataTypeMmcWriteProtection           = 42,  
    kDataTypeMmcDiscInformation           = 43,  
    kDataTypeMmcTrackResourcesInformation = 44,  
    kDataTypeMmcPowResourcesInformation   = 45,  
    kDataTypeScsiInquiry                  = 46,  
    kDataTypeScsiModePage2A               = 47,  
    kDataTypeAtaIdentify                  = 48,  
    kDataTypeAtapiIdentify                = 49,  
    kDataTypePcmciaCis                    = 50,  
    kDataTypeSdCid                        = 51,  
    kDataTypeSdCsd                        = 52,  
    kDataTypeSdScr                        = 53,  
    kDataTypeSdOcr                        = 54,  
    kDataTypeMmcCid                       = 55,  
    kDataTypeMmcCsd                       = 56,  
    kDataTypeMmcOcr                       = 57,  
    kDataTypeExtendedCsd                  = 58,  
    kDataTypeXboxSecuritySector           = 59,  
    kDataTypeFloppyLeadOut                = 60,  
    kDataTypeDiscControlBlock             = 61,  
    kDataTypeCdFirstTrackPregap           = 62,  
    kDataTypeCdLeadOut                    = 63,  
    kDataTypeScsiModeSense6               = 64,  
    kDataTypeScsiModeSense10              = 65,  
    kDataTypeUsbDescriptors               = 66,  
    kDataTypeXboxDmi                      = 67,  
    kDataTypeXboxPfi                      = 68,  
    kDataTypeCdSectorPrefix               = 69,  
    kDataTypeCdSectorSuffix               = 70,  
    kDataTypeCdSubchannel                 = 71,  
    kDataTypeAppleProfileTag              = 72,  
    kDataTypeAppleSonyTag                 = 73,  
    kDataTypePriamDataTowerTag            = 74,  
    kDataTypeCdMcn                        = 75,  
    kDataTypeCdSectorPrefixCorrected      = 76,  
    kDataTypeCdSectorSuffixCorrected = 77,  
    kDataTypeCdSubHeader             = 78,  
    kDataTypeCdLeadIn                = 79,  
    kDataTypeDvdDiscKeyDecrypted     = 80,  
    kDataTypeDvdSectorCprMai         = 81,  
    kDataTypeDvdTitleKeyDecrypted    = 82,  
    kDataTypeDvdSectorId             = 83,  
    kDataTypeDvdSectorIed            = 84,  
    kDataTypeDvdSectorEdc            = 85,  
    kDataTypeDvdSectorEccPi          = 86,  
    kDataTypeDvdEccBlockPo           = 87,  
    kDataTypeDvdPfi2ndLayer          = 88,  
    kDataTypeFluxData                = 89,  
    kDataTypeBitstreamData           = 90,  
    kDataTypeFloppyWriteProtect      = 91,  
    kDataTypeWiiUDiscKey             = 92,  
    kDataTypePs3DiscKey              = 93,  
    kDataTypePs3Data1                = 94,  
    kDataTypePs3Data2                = 95,  
    kDataTypePs3Pic                  = 96,  
    kDataTypePs3EncryptionMap        = 97,  
    kDataTypeWiiUPartitionKeyMap     = 98,  
    kDataTypeWiiPartitionKeyMap      = 99,  
    kDataTypeNgcwJunkMap             = 100, 
    kDataTypeAacsMediaKey            = 101, 
    kDataTypeAacsVolumeUniqueKey     = 102, 
    kDataTypeBdSectorEdc             = 103, 
    kDataTypeErasureParity           = 104, 
    kDataTypeErasureParityDdt        = 105, 
    kDataTypeErasureParityDdtPrimary = 106, 
    kDataTypeErasureParityMeta       = 107, 
    kDataTypeErasureParityIndex      = 108, 
} DataType;

typedef enum
{
    DataBlock                    = 0x4B4C4244,  
    DeDuplicationTable           = 0x2A544444,  
    DeDuplicationTable2          = 0x32544444,  
    DeDuplicationTableSAlpha     = 0x53545444,  
    DeDuplicationTableSecondary  = 0x53544444,  
    IndexBlock                   = 0x58444E49,  
    IndexBlock2                  = 0x32584449,  
    IndexBlock3                  = 0x33584449,  
    GeometryBlock                = 0x4D4F4547,  
    MetadataBlock                = 0x4154454D,  
    TracksBlock                  = 0x534B5254,  
    CicmBlock                    = 0x4D434943,  
    ChecksumBlock                = 0x4D534B43,  
    DataPositionMeasurementBlock = 0x2A4D5044,  
    SnapshotBlock                = 0x50414E53,  
    ParentBlock                  = 0x50524E54,  
    DumpHardwareBlock            = 0x2A504D44,  
    TapeFileBlock                = 0x454C4654,  
    TapePartitionBlock           = 0x54425054,  
    AaruMetadataJsonBlock        = 0x444D534A,  
    FluxDataBlock                = 0x58554C46,  
    DataStreamPayloadBlock =
        0x4C505344,  
    ErasureCodingMapBlock = 0x424D4345  
} BlockType;

typedef enum
{
    Invalid = 0,  
    Md5     = 1,  
    Sha1    = 2,  
    Sha256  = 3,  
    SpamSum = 4,  
    Blake3  = 5,  
} ChecksumAlgorithm;

typedef enum
{
    NotDumped       = 0x10000000,  
    Correct         = 0x20000000,  
    Mode2Form1Ok    = 0x30000000,  
    Mode2Form2Ok    = 0x40000000,  
    Mode2Form2NoCrc = 0x50000000   
} CdFixFlags;

typedef enum
{
    kTrackTypeAudio           = 0,  
    kTrackTypeData            = 1,  
    kTrackTypeCdMode1         = 2,  
    kTrackTypeCdMode2Formless = 3,  
    kTrackTypeCdMode2Form1    = 4,  
    kTrackTypeCdMode2Form2    = 5   
} TrackType;

typedef enum
{
    AARUF_STATUS_INVALID_CONTEXT = -1  
} AaruformatStatus;

typedef enum
{
    OpticalDisc = 0,  
    BlockMedia  = 1,  
    LinearMedia = 2,  
    AudioMedia  = 3   
} XmlMediaType;

typedef enum
{
    SectorStatusNotDumped       = 0x0,  
    SectorStatusDumped          = 0x1,  
    SectorStatusErrored         = 0x2,  
    SectorStatusMode1Correct    = 0x3,  
    SectorStatusMode2Form1Ok    = 0x4,  
    SectorStatusMode2Form2Ok    = 0x5,  
    SectorStatusMode2Form2NoCrc = 0x6,  
    SectorStatusTwin            = 0x7,  
    SectorStatusUnrecorded      = 0x8,  
    SectorStatusEncrypted       = 0x9,  
    SectorStatusUnencrypted     = 0xA,  
    SectorStatusGenerable       = 0xB   
} SectorStatus;

typedef enum
{
    AARU_FEATURE_RW_BLAKE3 = 0x1,  
} FeaturesCompatible;

typedef enum
{
    AARU_FEATURE_INCOMPAT_ZSTD = 0x1,  
} FeaturesIncompatible;

typedef enum
{
    AARU_FEATURE_ROCOMPAT_ERASURE = 0x1,  
} FeaturesCompatibleRo;

typedef enum
{
    kErasureCodingXor          = 0,  
    kErasureCodingRsVandermonde = 1   
} ErasureCodingAlgorithm;

typedef enum
{
    kECGroupData       = 0,  
    kECGroupDdtSecondary = 1, 
    kECGroupDdtPrimary  = 2,  
    kECGroupMetadata    = 3,  
    kECGroupIndex       = 4   
} ErasureCodingGroupType;
 
#ifndef _MSC_VER
#pragma clang diagnostic pop
#endif
 
#endif  // LIBAARUFORMAT_ENUMS_H