Add Aaru Metadata JSON block documentation

This commit is contained in:
2025-10-05 04:49:19 +01:00
parent 941123d16f
commit 1471248132
3 changed files with 32 additions and 1 deletions

View File

@@ -0,0 +1,25 @@
=== Aaru Metadata JSON Block (`JSMD`)
This block header signifies the inclusion of an embedded Aaru metadata JSON sidecar.
The contents of the JSON are preserved in their original form and are not parsed, interpreted, or validated by the format implementation.
==== Structure Definition
[source,c]
#define METADATA_JSON_MAGIC 0x444D534A
/**Header for the Aaru Metadata JSON block */
typedef struct AaruMetadataJsonBlock
{
/**Identifier, <see cref="BlockType.AaruMetadataJsonBlock" /> */
uint32_t identifier;
uint32_t length;
} AaruMetadataJsonBlock;
==== Field Descriptions
[cols="2,2,2,6",options="header"]
|===
|Type|Size|Name|Description
|uint32|4 bytes|identifier|The Aaru metadata JSON identifier, always `JSMD`
|uint32|4 bytes|length|The size in bytes of the embedded Aaru metadata JSON that follows this header.
|===

View File

@@ -74,6 +74,10 @@ include::blocks/tracks.adoc[]
<<<
include::blocks/aaru_metadata.adoc[]
<<<
include::blocks/cicm.adoc[]
<<<

View File

@@ -75,7 +75,7 @@ Define twin sector table.
Add annex explaining the meaning and relationship between user, bitstream and flux data.
| 31 July 2025
| 5 October 2025
| 2.0df
| Draft
| Natalia Portillo
@@ -96,4 +96,6 @@ Clarify deduplication table size type.
Clarify deduplication table sector status.
Add encrypted and decrypted sector status.
Add Aaru Metadata JSON.
|===