indexedfile_types_v201_v301.h

Go to the documentation of this file.

 
#ifndef INDEXEDFILE_V201_V301_TYPE_HEADER
#define INDEXEDFILE_V201_V301_TYPE_HEADER
 
#include <ifhd/indexedfile_types.h>
 
namespace ifhd
{
namespace v201_v301
{

static inline uint32_t getFileId()
{
    static uint32_t file_id = *((uint32_t*) "IFHD");
    return file_id;
}

static constexpr uint32_t version_id_beta = 0x0200;
static constexpr uint32_t version_id = 0x00000201;
static constexpr uint32_t version_id_with_history = 0x00000300;
static const uint32_t version_id_with_history_end_offset = 0x00000301;
 

enum TimeFormat
{
    tf_chunk_index = 1,
    tf_chunk_time = 2,
    tf_stream_index = 3
};

enum FieldMask
{
    fm_none = 0x00,
    fm_description = 0x01,
    fm_date_time = 0x02
};

enum ReadFlags
{
    rf_none              = 0x0,
    rf_use_external_buffer = 0x1,
    rf_backwards         = 0x2
};
 
#pragma pack(push)
#pragma pack(1)

struct FileHeader
{
    uint32_t                         file_id;
    uint32_t                         version_id;
    uint32_t                         flags;
    uint32_t                         extension_count;
    uint64_t                         extension_offset;
    uint64_t                         data_offset;
    uint64_t                         data_size;
    uint64_t                         chunk_count;
    uint64_t                         max_chunk_size;
    uint64_t                         duration;
    uint64_t                         file_time;
    uint8_t                          header_byte_order;
    uint64_t                         time_offset;
    uint8_t                          patch_number;
    uint64_t                         first_chunk_offset;
    uint64_t                         continuous_offset;
    uint64_t                         ring_buffer_end_offset;
    int8_t                           reserved[30];
    int8_t                           description[1912];
};   // size is 2048 Bytes

struct FileExtension
{
    int8_t                           identifier[max_file_extension_identifier_length];
    uint16_t                         stream_id;
    uint8_t                          reserved1[2];
    uint32_t                         user_id;
    uint32_t                         type_id;
    uint32_t                         version_id;
    uint64_t                         data_pos;
    uint64_t                         data_size;
    uint8_t                          reserved[96];
};  // size is 512 Bytes

struct ChunkHeader
{
    uint64_t                         time_stamp;
    uint32_t                         ref_master_table_index;
    uint32_t                         offset_to_last;
    uint32_t                         size;
    uint16_t                         stream_id;
    uint16_t                         flags;
    uint64_t                         stream_index;
};  // size is 32 Bytes

struct ChunkRef
{
    uint64_t                         time_stamp;
    uint32_t                         size;
    uint16_t                         stream_id;
    uint16_t                         flags;
    uint64_t                         chunk_offset;
    uint64_t                         chunk_index;
    uint64_t                         stream_index;
    uint32_t                         ref_stream_table_index;
};    // size is 44 Bytes

struct StreamRef
{
    uint32_t ref_master_table_index;
};    // size is 4 Bytes

struct StreamInfoHeader
{
    uint64_t                         stream_index_count;
    uint64_t                         stream_first_time;
    uint64_t                         stream_last_time;
    uint32_t                         info_data_size;
    int8_t                           stream_name[max_streamname_length]; //use Ascii 7
}; // size is 256 Byte

struct AdditionalIndexInfo
{
    uint64_t stream_index_offset;
    uint32_t stream_table_index_offset;
    uint8_t  reserved[20];
};

enum ChecksumType : uint32_t
{
    xxh3_64 = 0
};

struct ChecksumExtensionHeader
{
    ChecksumType type;
    uint64_t count;
};

struct FileRangeChecksumXxh3_64
{
    uint64_t offset;
    uint64_t size;
    uint64_t checksum;
};
 
#pragma pack(pop)
 
 
 

enum SeekFlags
{
    sf_default = 0x0,
    sf_keydata = 0x1,
    sf_before = 0x02
};

enum ChunkType
{
    ct_data = 0x00,
    ct_keydata = 0x01,
    ct_info = 0x02,
    ct_marker = 0x04,
    ct_type = 0x08,
    ct_trigger = 0x10
};

enum OpenMode
{
    om_none = 0x00,
    om_query_info = 0x04,
    om_validate_chunk_header = 0x08,
    om_file_change_mode = 0x10,

    om_no_overwrite = 0x20,

    om_store_checksums = 0x40
};
 
}  // namespace v201_301
} // namespace  ifhd
 
#endif // _INDEXEDFILE_V201_v301_TYPE_HEADER_