mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
202 lines
12 KiB
HTML
202 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.14.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libaaruformat: include/aaruformat/structs/metadata.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">libaaruformat<span id="projectnumber"> 1.0</span>
|
|
</div>
|
|
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.14.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('metadata_8h.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">metadata.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Packed on-disk metadata block headers for descriptive strings and CICM XML (if present).
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="metadata_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:MetadataBlockHeader" id="r_MetadataBlockHeader"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structMetadataBlockHeader.html">MetadataBlockHeader</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings. <a href="structMetadataBlockHeader.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:CicmMetadataBlock" id="r_CicmMetadataBlock"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCicmMetadataBlock.html">CicmMetadataBlock</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Header for a CICM XML metadata block (identifier == BlockType::CicmBlock). <a href="structCicmMetadataBlock.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:AaruMetadataJsonBlockHeader" id="r_AaruMetadataJsonBlockHeader"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAaruMetadataJsonBlockHeader.html">AaruMetadataJsonBlockHeader</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Header for an Aaru metadata JSON block (identifier == BlockType::AaruMetadataJsonBlock). <a href="structAaruMetadataJsonBlockHeader.html#details">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ad50b5e5d5745ccd2ef7ce17a023c2582" id="r_ad50b5e5d5745ccd2ef7ce17a023c2582"><td class="memItemLeft" align="right" valign="top">typedef struct MetadataBlockHeader </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad50b5e5d5745ccd2ef7ce17a023c2582">MetadataBlockHeader</a></td></tr>
|
|
<tr class="memitem:a3c0742e18c9397cba678e3d73dd5ea3d" id="r_a3c0742e18c9397cba678e3d73dd5ea3d"><td class="memItemLeft" align="right" valign="top">typedef struct CicmMetadataBlock </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c0742e18c9397cba678e3d73dd5ea3d">CicmMetadataBlock</a></td></tr>
|
|
<tr class="memitem:ab19461574aefdc3ef041175b624ec7be" id="r_ab19461574aefdc3ef041175b624ec7be"><td class="memItemLeft" align="right" valign="top">typedef struct AaruMetadataJsonBlockHeader </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab19461574aefdc3ef041175b624ec7be">AaruMetadataJsonBlockHeader</a></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Packed on-disk metadata block headers for descriptive strings and CICM XML (if present). </p>
|
|
<p>Two metadata-related block header layouts are defined:</p><ul>
|
|
<li><a class="el" href="structMetadataBlockHeader.html">MetadataBlockHeader</a> (BlockType::MetadataBlock): offsets + lengths for several UTF-16LE strings.</li>
|
|
<li><a class="el" href="structCicmMetadataBlock.html">CicmMetadataBlock</a> (BlockType::CicmBlock): length of embedded CICM XML metadata payload.</li>
|
|
</ul>
|
|
<p>All multi-byte integers are little-endian. Structures are packed (1-byte alignment). All textual fields referenced by offsets are UTF-16LE, null-terminated (0x0000). Length fields include the terminating null (i.e. length >= 2 and an even number). Offsets are relative to the start of the corresponding block header (byte 0 = first byte of the header). No padding is implicitly added between strings; producers may pack them tightly or align them manually (alignment not required by the specification).</p>
|
|
<p>Metadata block layout (conceptual): <a class="el" href="structMetadataBlockHeader.html" title="Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings.">MetadataBlockHeader</a> (fixed size) <variable region holding each present UTF-16LE string in any order chosen by the writer></p>
|
|
<p>Invariants / validation recommendations for <a class="el" href="structMetadataBlockHeader.html" title="Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings.">MetadataBlockHeader</a>:</p><ul>
|
|
<li>identifier == BlockType::MetadataBlock</li>
|
|
<li>blockSize >= sizeof(MetadataBlockHeader)</li>
|
|
<li>For every (offset,length) pair where length > 0:<ul>
|
|
<li>offset >= sizeof(MetadataBlockHeader)</li>
|
|
<li>offset + length <= blockSize</li>
|
|
<li>length % 2 == 0</li>
|
|
<li>The 16-bit code unit at (offset + length - 2) == 0x0000 (null terminator)</li>
|
|
</ul>
|
|
</li>
|
|
<li>mediaSequence >= 0 and lastMediaSequence >= 0; if lastMediaSequence > 0 then 0 <= mediaSequence < lastMediaSequence</li>
|
|
</ul>
|
|
<p>CICM metadata block layout: <a class="el" href="structCicmMetadataBlock.html" title="Header for a CICM XML metadata block (identifier == BlockType::CicmBlock).">CicmMetadataBlock</a> (header) <length bytes of UTF-8 or XML text payload (implementation-defined, not null-terminated)></p>
|
|
<p>NOTE: The library code reading these blocks must not assume strings are present; a zero length means the corresponding field is omitted. Offsets for omitted fields MAY be zero or arbitrary; readers should skip them whenever length == 0. </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="metadata_8h_source.html">metadata.h</a>.</p>
|
|
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
|
|
<a id="ab19461574aefdc3ef041175b624ec7be" name="ab19461574aefdc3ef041175b624ec7be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab19461574aefdc3ef041175b624ec7be">◆ </a></span>AaruMetadataJsonBlockHeader</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct AaruMetadataJsonBlockHeader AaruMetadataJsonBlockHeader</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c0742e18c9397cba678e3d73dd5ea3d" name="a3c0742e18c9397cba678e3d73dd5ea3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c0742e18c9397cba678e3d73dd5ea3d">◆ </a></span>CicmMetadataBlock</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct CicmMetadataBlock CicmMetadataBlock</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad50b5e5d5745ccd2ef7ce17a023c2582" name="ad50b5e5d5745ccd2ef7ce17a023c2582"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad50b5e5d5745ccd2ef7ce17a023c2582">◆ </a></span>MetadataBlockHeader</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct MetadataBlockHeader MetadataBlockHeader</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="metadata_8h.html">metadata.h</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|