libaaruformat 1.0 Aaru Data Preservation Suite - Format Library

Loading...
Searching...
No Matches
MetadataBlockHeader Struct Reference

Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings. More...

`#include <aaruformat/structs/metadata.h>`

## Data Fields
uint32_t | identifier
| Block identifier, must be BlockType::MetadataBlock.
uint32_t | blockSize
| Total size in bytes of the entire metadata block (header + strings).
int32_t | mediaSequence
| Sequence number within a multi-disc / multi-volume set (0-based or 1-based as producer defines).
int32_t | lastMediaSequence
| Total number of media in the set; 0 or 1 if single item.
uint32_t | creatorOffset
| Offset to UTF-16LE creator string (or undefined if creatorLength==0).
uint32_t | creatorLength
| Length in bytes (including null) of creator string (0 if absent).
uint32_t | commentsOffset
| Offset to UTF-16LE comments string.
uint32_t | commentsLength
| Length in bytes (including null) of comments string.
uint32_t | mediaTitleOffset
| Offset to UTF-16LE media title string.
uint32_t | mediaTitleLength
| Length in bytes (including null) of media title string.
uint32_t | mediaManufacturerOffset
| Offset to UTF-16LE media manufacturer string.
uint32_t | mediaManufacturerLength
| Length in bytes (including null) of media manufacturer string.
uint32_t | mediaModelOffset
| Offset to UTF-16LE media model string.
uint32_t | mediaModelLength
| Length in bytes (including null) of media model string.
uint32_t | mediaSerialNumberOffset
| Offset to UTF-16LE media serial number string.
uint32_t | mediaSerialNumberLength
| Length in bytes (including null) of media serial number string.
uint32_t | mediaBarcodeOffset
| Offset to UTF-16LE media barcode string.
uint32_t | mediaBarcodeLength
| Length in bytes (including null) of media barcode string.
uint32_t | mediaPartNumberOffset
| Offset to UTF-16LE media part number string.
uint32_t | mediaPartNumberLength
| Length in bytes (including null) of media part number string.
uint32_t | driveManufacturerOffset
| Offset to UTF-16LE drive manufacturer string.
uint32_t | driveManufacturerLength
| Length in bytes (including null) of drive manufacturer string.
uint32_t | driveModelOffset
| Offset to UTF-16LE drive model string.
uint32_t | driveModelLength
| Length in bytes (including null) of drive model string.
uint32_t | driveSerialNumberOffset
| Offset to UTF-16LE drive serial number string.
uint32_t | driveSerialNumberLength
| Length in bytes (including null) of drive serial number string.
uint32_t | driveFirmwareRevisionOffset
| Offset to UTF-16LE drive firmware revision string.
uint32_t | driveFirmwareRevisionLength
| Length in bytes (including null) of drive firmware revision string.

## Detailed Description

Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings.

Descriptive fields (all optional): creator, comments, media title/manufacturer/model/serial/barcode/part number, drive manufacturer/model/serial/firmware revision. Strings can be used to describe both physical medium and acquisition hardware. Length values include the UTF-16LE null terminator (two zero bytes).

Definition at line 68 of file metadata.h.

## Field Documentation

## ◆ blockSize

uint32_t MetadataBlockHeader::blockSize

Total size in bytes of the entire metadata block (header + strings).

Definition at line 71 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ commentsLength

uint32_t MetadataBlockHeader::commentsLength

Length in bytes (including null) of comments string.

Definition at line 78 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_comments(), aaruf_set_comments(), process_metadata_block(), and write_metadata_block().

## ◆ commentsOffset

uint32_t MetadataBlockHeader::commentsOffset

Offset to UTF-16LE comments string.

Definition at line 77 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ creatorLength

uint32_t MetadataBlockHeader::creatorLength

Length in bytes (including null) of creator string (0 if absent).

Definition at line 76 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_creator(), aaruf_set_creator(), process_metadata_block(), and write_metadata_block().

## ◆ creatorOffset

uint32_t MetadataBlockHeader::creatorOffset

Offset to UTF-16LE creator string (or undefined if creatorLength==0).

Definition at line 75 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ driveFirmwareRevisionLength

uint32_t MetadataBlockHeader::driveFirmwareRevisionLength

Length in bytes (including null) of drive firmware revision string.

Definition at line 98 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_drive_firmware_revision(), aaruf_set_drive_firmware_revision(), process_metadata_block(), and write_metadata_block().

## ◆ driveFirmwareRevisionOffset

uint32_t MetadataBlockHeader::driveFirmwareRevisionOffset

Offset to UTF-16LE drive firmware revision string.

Definition at line 97 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ driveManufacturerLength

uint32_t MetadataBlockHeader::driveManufacturerLength

Length in bytes (including null) of drive manufacturer string.

Definition at line 92 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_drive_manufacturer(), aaruf_set_drive_manufacturer(), process_metadata_block(), and write_metadata_block().

## ◆ driveManufacturerOffset

uint32_t MetadataBlockHeader::driveManufacturerOffset

Offset to UTF-16LE drive manufacturer string.

Definition at line 91 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ driveModelLength

uint32_t MetadataBlockHeader::driveModelLength

Length in bytes (including null) of drive model string.

Definition at line 94 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_drive_model(), aaruf_set_drive_model(), process_metadata_block(), and write_metadata_block().

## ◆ driveModelOffset

uint32_t MetadataBlockHeader::driveModelOffset

Offset to UTF-16LE drive model string.

Definition at line 93 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ driveSerialNumberLength

uint32_t MetadataBlockHeader::driveSerialNumberLength

Length in bytes (including null) of drive serial number string.

Definition at line 96 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_drive_serial_number(), aaruf_set_drive_serial_number(), process_metadata_block(), and write_metadata_block().

## ◆ driveSerialNumberOffset

uint32_t MetadataBlockHeader::driveSerialNumberOffset

Offset to UTF-16LE drive serial number string.

Definition at line 95 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ identifier

uint32_t MetadataBlockHeader::identifier

Block identifier, must be BlockType::MetadataBlock.

Definition at line 70 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_comments(), aaruf_get_creator(), aaruf_get_drive_firmware_revision(), aaruf_get_drive_manufacturer(), aaruf_get_drive_model(), aaruf_get_drive_serial_number(), aaruf_get_media_barcode(), aaruf_get_media_manufacturer(), aaruf_get_media_model(), aaruf_get_media_part_number(), aaruf_get_media_sequence(), aaruf_get_media_serial_number(), aaruf_get_media_title(), aaruf_set_comments(), aaruf_set_creator(), aaruf_set_drive_firmware_revision(), aaruf_set_drive_manufacturer(), aaruf_set_drive_model(), aaruf_set_drive_serial_number(), aaruf_set_media_barcode(), aaruf_set_media_manufacturer(), aaruf_set_media_model(), aaruf_set_media_part_number(), aaruf_set_media_sequence(), aaruf_set_media_serial_number(), aaruf_set_media_title(), process_metadata_block(), and write_metadata_block().

## ◆ lastMediaSequence

int32_t MetadataBlockHeader::lastMediaSequence

Total number of media in the set; 0 or 1 if single item.

Definition at line 74 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_sequence(), aaruf_set_media_sequence(), process_metadata_block(), and write_metadata_block().

## ◆ mediaBarcodeLength

uint32_t MetadataBlockHeader::mediaBarcodeLength

Length in bytes (including null) of media barcode string.

Definition at line 88 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_barcode(), aaruf_set_media_barcode(), process_metadata_block(), and write_metadata_block().

## ◆ mediaBarcodeOffset

uint32_t MetadataBlockHeader::mediaBarcodeOffset

Offset to UTF-16LE media barcode string.

Definition at line 87 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ mediaManufacturerLength

uint32_t MetadataBlockHeader::mediaManufacturerLength

Length in bytes (including null) of media manufacturer string.

Definition at line 82 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_manufacturer(), aaruf_set_media_manufacturer(), process_metadata_block(), and write_metadata_block().

## ◆ mediaManufacturerOffset

uint32_t MetadataBlockHeader::mediaManufacturerOffset

Offset to UTF-16LE media manufacturer string.

Definition at line 81 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ mediaModelLength

uint32_t MetadataBlockHeader::mediaModelLength

Length in bytes (including null) of media model string.

Definition at line 84 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_model(), aaruf_set_media_model(), process_metadata_block(), and write_metadata_block().

## ◆ mediaModelOffset

uint32_t MetadataBlockHeader::mediaModelOffset

Offset to UTF-16LE media model string.

Definition at line 83 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ mediaPartNumberLength

uint32_t MetadataBlockHeader::mediaPartNumberLength

Length in bytes (including null) of media part number string.

Definition at line 90 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_part_number(), aaruf_set_media_part_number(), process_metadata_block(), and write_metadata_block().

## ◆ mediaPartNumberOffset

uint32_t MetadataBlockHeader::mediaPartNumberOffset

Offset to UTF-16LE media part number string.

Definition at line 89 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ mediaSequence

int32_t MetadataBlockHeader::mediaSequence

Sequence number within a multi-disc / multi-volume set (0-based or 1-based as producer defines).

Definition at line 72 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_sequence(), aaruf_set_media_sequence(), process_metadata_block(), and write_metadata_block().

## ◆ mediaSerialNumberLength

uint32_t MetadataBlockHeader::mediaSerialNumberLength

Length in bytes (including null) of media serial number string.

Definition at line 86 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_serial_number(), aaruf_set_media_serial_number(), process_metadata_block(), and write_metadata_block().

## ◆ mediaSerialNumberOffset

uint32_t MetadataBlockHeader::mediaSerialNumberOffset

Offset to UTF-16LE media serial number string.

Definition at line 85 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

## ◆ mediaTitleLength

uint32_t MetadataBlockHeader::mediaTitleLength

Length in bytes (including null) of media title string.

Definition at line 80 of file metadata.h.

Referenced by aaruf_clear_comments(), aaruf_clear_creator(), aaruf_clear_drive_firmware_revision(), aaruf_clear_drive_manufacturer(), aaruf_clear_drive_model(), aaruf_clear_drive_serial_number(), aaruf_clear_media_barcode(), aaruf_clear_media_manufacturer(), aaruf_clear_media_model(), aaruf_clear_media_part_number(), aaruf_clear_media_sequence(), aaruf_clear_media_serial_number(), aaruf_clear_media_title(), aaruf_get_media_title(), aaruf_set_media_title(), process_metadata_block(), and write_metadata_block().

## ◆ mediaTitleOffset

uint32_t MetadataBlockHeader::mediaTitleOffset

Offset to UTF-16LE media title string.

Definition at line 79 of file metadata.h.

Referenced by process_metadata_block(), and write_metadata_block().

The documentation for this struct was generated from the following file:

- include/aaruformat/structs/metadata.h