flux.h

Go to the documentation of this file.

/*
 * 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_FLUX_H
#define LIBAARUFORMAT_FLUX_H
 
#include <stdint.h>
 
#pragma pack(push, 1)

typedef struct FluxHeader
{
    uint32_t identifier;          
    uint16_t entries;             
    uint8_t  blockAlignmentShift; 
    uint64_t crc64;               
} FluxHeader;

typedef struct FluxEntry
{
    uint32_t head;            
    uint16_t track;           
    uint8_t  subtrack;        
    uint32_t captureIndex;    
    uint64_t indexResolution; 
    uint64_t dataResolution;  
    uint64_t indexOffset;     
    uint64_t payloadOffset;   
} FluxEntry;

typedef struct FluxCaptureMeta
{
    uint32_t head;           
    uint16_t track;          
    uint8_t  subtrack;       
    uint32_t captureIndex;   
    uint64_t indexResolution; 
    uint64_t dataResolution;  
} FluxCaptureMeta;

typedef struct FluxCaptureMapEntry FluxCaptureMapEntry;

typedef struct DataStreamPayloadHeader
{
    uint32_t identifier;   
    uint16_t dataType;     
    uint16_t compression;  
    uint32_t cmpLength;    
    uint32_t length;       
    uint64_t cmpCrc64;     
    uint64_t crc64;        
} DataStreamPayloadHeader;

typedef struct FluxCaptureRecord
{
    FluxEntry entry;        
    uint8_t  *data_buffer;  
    uint32_t  data_length;  
    uint8_t  *index_buffer; 
    uint32_t  index_length; 
} FluxCaptureRecord;

typedef struct FluxCaptureKey
{
    uint32_t head;         
    uint16_t track;        
    uint8_t  subtrack;     
    uint32_t captureIndex; 
} FluxCaptureKey;
 
#pragma pack(pop)
 
#endif  // LIBAARUFORMAT_FLUX_H