Add doxygen documentation

This commit is contained in:
2025-10-11 01:35:43 +01:00
parent 61850a9520
commit 697b755b1e
646 changed files with 124953 additions and 0 deletions

View File

@@ -0,0 +1,218 @@
<!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 Source File</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">&#160;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_source.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</div></div>
</div><!--header-->
<div class="contents">
<a href="metadata_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_METADATA_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_METADATA_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#pragma pack(push, 1)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span></div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="};">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html"> 68</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structMetadataBlockHeader.html">MetadataBlockHeader</a></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a16f0be711a2a0ddb48a0f092716e93dc"> 70</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a16f0be711a2a0ddb48a0f092716e93dc">identifier</a>; </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a3d1affce1a6ce2bda81aeaf85435b885"> 71</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a3d1affce1a6ce2bda81aeaf85435b885">blockSize</a>; </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a1359ce7deda764ea267459f3f5906473"> 72</a></span> int32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a1359ce7deda764ea267459f3f5906473">mediaSequence</a>; </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#aacd243f7f5a78c6087b797328197f522"> 74</a></span> int32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#aacd243f7f5a78c6087b797328197f522">lastMediaSequence</a>; </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a5ee9864c423b8acf6d15b3947587ed4c"> 75</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a5ee9864c423b8acf6d15b3947587ed4c">creatorOffset</a>; </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#af620858c254ea17f2d75b065134239c8"> 76</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#af620858c254ea17f2d75b065134239c8">creatorLength</a>; </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#abd56f9918aab6b6ee628abf6ca04c6d9"> 77</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#abd56f9918aab6b6ee628abf6ca04c6d9">commentsOffset</a>; </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a0bbbf0b6d7b48ebdc07d4a5e1138044f"> 78</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a0bbbf0b6d7b48ebdc07d4a5e1138044f">commentsLength</a>; </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a22d2307092bdc0046664f328e9da581e"> 79</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a22d2307092bdc0046664f328e9da581e">mediaTitleOffset</a>; </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a68deb35b7b070dcc18c790289192741c"> 80</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a68deb35b7b070dcc18c790289192741c">mediaTitleLength</a>; </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a6a443de2064b9c3eb31288afb81676d3"> 81</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a6a443de2064b9c3eb31288afb81676d3">mediaManufacturerOffset</a>; </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a7f2956f787d72b6981a22c050c0889cf"> 82</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a7f2956f787d72b6981a22c050c0889cf">mediaManufacturerLength</a>; </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a5340616394d88102e70054c673308469"> 83</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a5340616394d88102e70054c673308469">mediaModelOffset</a>; </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a9438f57b0304b42912b8c66e5a0f1051"> 84</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a9438f57b0304b42912b8c66e5a0f1051">mediaModelLength</a>; </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#ae4561c1f946fe76239810f29a237dfbc"> 85</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#ae4561c1f946fe76239810f29a237dfbc">mediaSerialNumberOffset</a>; </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#aeae9bce28abec33ffa90005f2a247e34"> 86</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#aeae9bce28abec33ffa90005f2a247e34">mediaSerialNumberLength</a>; </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#affd6e10a1ab8eb3714a6ff09b3471747"> 87</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#affd6e10a1ab8eb3714a6ff09b3471747">mediaBarcodeOffset</a>; </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#aef456689422a0514489b1c900ee2c741"> 88</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#aef456689422a0514489b1c900ee2c741">mediaBarcodeLength</a>; </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#aeb9233f4dd077e5b0985a3a776deb7c8"> 89</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#aeb9233f4dd077e5b0985a3a776deb7c8">mediaPartNumberOffset</a>; </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#aef055916275048b6496f1f74eef2f1ac"> 90</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#aef055916275048b6496f1f74eef2f1ac">mediaPartNumberLength</a>; </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#acb4e827848c2525a0fa5fcc6cfcf2887"> 91</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#acb4e827848c2525a0fa5fcc6cfcf2887">driveManufacturerOffset</a>; </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a380656568f47a838a8a3833844789064"> 92</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a380656568f47a838a8a3833844789064">driveManufacturerLength</a>; </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a4751e36473bffa529e5d1d1debca95a2"> 93</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a4751e36473bffa529e5d1d1debca95a2">driveModelOffset</a>; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a3757158a1386964537beb387b5bc03d2"> 94</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a3757158a1386964537beb387b5bc03d2">driveModelLength</a>; </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a7d44fe2fdfebf3d49179801eb72ff72c"> 95</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a7d44fe2fdfebf3d49179801eb72ff72c">driveSerialNumberOffset</a>; </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a78213f42c28f31038e6a9f130c660ad8"> 96</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a78213f42c28f31038e6a9f130c660ad8">driveSerialNumberLength</a>; </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#a9bcf425f7ae5ab41d030c9b1f2c72979"> 97</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#a9bcf425f7ae5ab41d030c9b1f2c72979">driveFirmwareRevisionOffset</a>; </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="structMetadataBlockHeader.html#afbf024f5492e45a3643ea7a1652b6420"> 98</a></span> uint32_t <a class="code hl_variable" href="structMetadataBlockHeader.html#afbf024f5492e45a3643ea7a1652b6420">driveFirmwareRevisionLength</a>; </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="metadata_8h.html#ad50b5e5d5745ccd2ef7ce17a023c2582"> 99</a></span>} <a class="code hl_struct" href="structMetadataBlockHeader.html">MetadataBlockHeader</a>;</div>
</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span></div>
<div class="foldopen" id="foldopen00107" data-start="{" data-end="};">
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="structCicmMetadataBlock.html"> 107</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structCicmMetadataBlock.html">CicmMetadataBlock</a></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>{</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="structCicmMetadataBlock.html#aee270357b6dc394ed9ac5f22c9903c90"> 109</a></span> uint32_t <a class="code hl_variable" href="structCicmMetadataBlock.html#aee270357b6dc394ed9ac5f22c9903c90">identifier</a>; </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structCicmMetadataBlock.html#a660c22d42c504d290f386f187707956f"> 110</a></span> uint32_t <a class="code hl_variable" href="structCicmMetadataBlock.html#a660c22d42c504d290f386f187707956f">length</a>; </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="metadata_8h.html#a3c0742e18c9397cba678e3d73dd5ea3d"> 111</a></span>} <a class="code hl_struct" href="structCicmMetadataBlock.html">CicmMetadataBlock</a>;</div>
</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span></div>
<div class="foldopen" id="foldopen00119" data-start="{" data-end="};">
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structAaruMetadataJsonBlockHeader.html"> 119</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structAaruMetadataJsonBlockHeader.html">AaruMetadataJsonBlockHeader</a></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>{</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structAaruMetadataJsonBlockHeader.html#a5e3db5d08dc09206cad6ea1b88b2db7d"> 121</a></span> uint32_t <a class="code hl_variable" href="structAaruMetadataJsonBlockHeader.html#a5e3db5d08dc09206cad6ea1b88b2db7d">identifier</a>; </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="structAaruMetadataJsonBlockHeader.html#aa9e35df2ccc7294a24187fff4bb559a9"> 122</a></span> uint32_t <a class="code hl_variable" href="structAaruMetadataJsonBlockHeader.html#aa9e35df2ccc7294a24187fff4bb559a9">length</a>; </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="metadata_8h.html#ab19461574aefdc3ef041175b624ec7be"> 123</a></span>} <a class="code hl_struct" href="structAaruMetadataJsonBlockHeader.html">AaruMetadataJsonBlockHeader</a>;</div>
</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_METADATA_H</span></div>
<div class="ttc" id="astructAaruMetadataJsonBlockHeader_html"><div class="ttname"><a href="structAaruMetadataJsonBlockHeader.html">AaruMetadataJsonBlockHeader</a></div><div class="ttdoc">Header for an Aaru metadata JSON block (identifier == BlockType::AaruMetadataJsonBlock).</div><div class="ttdef"><b>Definition</b> <a href="#l00119">metadata.h:120</a></div></div>
<div class="ttc" id="astructAaruMetadataJsonBlockHeader_html_a5e3db5d08dc09206cad6ea1b88b2db7d"><div class="ttname"><a href="structAaruMetadataJsonBlockHeader.html#a5e3db5d08dc09206cad6ea1b88b2db7d">AaruMetadataJsonBlockHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::AaruMetadataJsonBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l00121">metadata.h:121</a></div></div>
<div class="ttc" id="astructAaruMetadataJsonBlockHeader_html_aa9e35df2ccc7294a24187fff4bb559a9"><div class="ttname"><a href="structAaruMetadataJsonBlockHeader.html#aa9e35df2ccc7294a24187fff4bb559a9">AaruMetadataJsonBlockHeader::length</a></div><div class="ttdeci">uint32_t length</div><div class="ttdoc">Length in bytes of the Aaru metadata JSON payload that follows.</div><div class="ttdef"><b>Definition</b> <a href="#l00122">metadata.h:122</a></div></div>
<div class="ttc" id="astructCicmMetadataBlock_html"><div class="ttname"><a href="structCicmMetadataBlock.html">CicmMetadataBlock</a></div><div class="ttdoc">Header for a CICM XML metadata block (identifier == BlockType::CicmBlock).</div><div class="ttdef"><b>Definition</b> <a href="#l00107">metadata.h:108</a></div></div>
<div class="ttc" id="astructCicmMetadataBlock_html_a660c22d42c504d290f386f187707956f"><div class="ttname"><a href="structCicmMetadataBlock.html#a660c22d42c504d290f386f187707956f">CicmMetadataBlock::length</a></div><div class="ttdeci">uint32_t length</div><div class="ttdoc">Length in bytes of the CICM metadata payload that follows.</div><div class="ttdef"><b>Definition</b> <a href="#l00110">metadata.h:110</a></div></div>
<div class="ttc" id="astructCicmMetadataBlock_html_aee270357b6dc394ed9ac5f22c9903c90"><div class="ttname"><a href="structCicmMetadataBlock.html#aee270357b6dc394ed9ac5f22c9903c90">CicmMetadataBlock::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::CicmBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l00109">metadata.h:109</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html"><div class="ttname"><a href="structMetadataBlockHeader.html">MetadataBlockHeader</a></div><div class="ttdoc">Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings.</div><div class="ttdef"><b>Definition</b> <a href="#l00068">metadata.h:69</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a0bbbf0b6d7b48ebdc07d4a5e1138044f"><div class="ttname"><a href="structMetadataBlockHeader.html#a0bbbf0b6d7b48ebdc07d4a5e1138044f">MetadataBlockHeader::commentsLength</a></div><div class="ttdeci">uint32_t commentsLength</div><div class="ttdoc">Length in bytes (including null) of comments string.</div><div class="ttdef"><b>Definition</b> <a href="#l00078">metadata.h:78</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a1359ce7deda764ea267459f3f5906473"><div class="ttname"><a href="structMetadataBlockHeader.html#a1359ce7deda764ea267459f3f5906473">MetadataBlockHeader::mediaSequence</a></div><div class="ttdeci">int32_t mediaSequence</div><div class="ttdoc">Sequence number within a multi-disc / multi-volume set (0-based or 1-based as producer defines).</div><div class="ttdef"><b>Definition</b> <a href="#l00072">metadata.h:72</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a16f0be711a2a0ddb48a0f092716e93dc"><div class="ttname"><a href="structMetadataBlockHeader.html#a16f0be711a2a0ddb48a0f092716e93dc">MetadataBlockHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::MetadataBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l00070">metadata.h:70</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a22d2307092bdc0046664f328e9da581e"><div class="ttname"><a href="structMetadataBlockHeader.html#a22d2307092bdc0046664f328e9da581e">MetadataBlockHeader::mediaTitleOffset</a></div><div class="ttdeci">uint32_t mediaTitleOffset</div><div class="ttdoc">Offset to UTF-16LE media title string.</div><div class="ttdef"><b>Definition</b> <a href="#l00079">metadata.h:79</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a3757158a1386964537beb387b5bc03d2"><div class="ttname"><a href="structMetadataBlockHeader.html#a3757158a1386964537beb387b5bc03d2">MetadataBlockHeader::driveModelLength</a></div><div class="ttdeci">uint32_t driveModelLength</div><div class="ttdoc">Length in bytes (including null) of drive model string.</div><div class="ttdef"><b>Definition</b> <a href="#l00094">metadata.h:94</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a380656568f47a838a8a3833844789064"><div class="ttname"><a href="structMetadataBlockHeader.html#a380656568f47a838a8a3833844789064">MetadataBlockHeader::driveManufacturerLength</a></div><div class="ttdeci">uint32_t driveManufacturerLength</div><div class="ttdoc">Length in bytes (including null) of drive manufacturer string.</div><div class="ttdef"><b>Definition</b> <a href="#l00092">metadata.h:92</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a3d1affce1a6ce2bda81aeaf85435b885"><div class="ttname"><a href="structMetadataBlockHeader.html#a3d1affce1a6ce2bda81aeaf85435b885">MetadataBlockHeader::blockSize</a></div><div class="ttdeci">uint32_t blockSize</div><div class="ttdoc">Total size in bytes of the entire metadata block (header + strings).</div><div class="ttdef"><b>Definition</b> <a href="#l00071">metadata.h:71</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a4751e36473bffa529e5d1d1debca95a2"><div class="ttname"><a href="structMetadataBlockHeader.html#a4751e36473bffa529e5d1d1debca95a2">MetadataBlockHeader::driveModelOffset</a></div><div class="ttdeci">uint32_t driveModelOffset</div><div class="ttdoc">Offset to UTF-16LE drive model string.</div><div class="ttdef"><b>Definition</b> <a href="#l00093">metadata.h:93</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a5340616394d88102e70054c673308469"><div class="ttname"><a href="structMetadataBlockHeader.html#a5340616394d88102e70054c673308469">MetadataBlockHeader::mediaModelOffset</a></div><div class="ttdeci">uint32_t mediaModelOffset</div><div class="ttdoc">Offset to UTF-16LE media model string.</div><div class="ttdef"><b>Definition</b> <a href="#l00083">metadata.h:83</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a5ee9864c423b8acf6d15b3947587ed4c"><div class="ttname"><a href="structMetadataBlockHeader.html#a5ee9864c423b8acf6d15b3947587ed4c">MetadataBlockHeader::creatorOffset</a></div><div class="ttdeci">uint32_t creatorOffset</div><div class="ttdoc">Offset to UTF-16LE creator string (or undefined if creatorLength==0).</div><div class="ttdef"><b>Definition</b> <a href="#l00075">metadata.h:75</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a68deb35b7b070dcc18c790289192741c"><div class="ttname"><a href="structMetadataBlockHeader.html#a68deb35b7b070dcc18c790289192741c">MetadataBlockHeader::mediaTitleLength</a></div><div class="ttdeci">uint32_t mediaTitleLength</div><div class="ttdoc">Length in bytes (including null) of media title string.</div><div class="ttdef"><b>Definition</b> <a href="#l00080">metadata.h:80</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a6a443de2064b9c3eb31288afb81676d3"><div class="ttname"><a href="structMetadataBlockHeader.html#a6a443de2064b9c3eb31288afb81676d3">MetadataBlockHeader::mediaManufacturerOffset</a></div><div class="ttdeci">uint32_t mediaManufacturerOffset</div><div class="ttdoc">Offset to UTF-16LE media manufacturer string.</div><div class="ttdef"><b>Definition</b> <a href="#l00081">metadata.h:81</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a78213f42c28f31038e6a9f130c660ad8"><div class="ttname"><a href="structMetadataBlockHeader.html#a78213f42c28f31038e6a9f130c660ad8">MetadataBlockHeader::driveSerialNumberLength</a></div><div class="ttdeci">uint32_t driveSerialNumberLength</div><div class="ttdoc">Length in bytes (including null) of drive serial number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00096">metadata.h:96</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a7d44fe2fdfebf3d49179801eb72ff72c"><div class="ttname"><a href="structMetadataBlockHeader.html#a7d44fe2fdfebf3d49179801eb72ff72c">MetadataBlockHeader::driveSerialNumberOffset</a></div><div class="ttdeci">uint32_t driveSerialNumberOffset</div><div class="ttdoc">Offset to UTF-16LE drive serial number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00095">metadata.h:95</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a7f2956f787d72b6981a22c050c0889cf"><div class="ttname"><a href="structMetadataBlockHeader.html#a7f2956f787d72b6981a22c050c0889cf">MetadataBlockHeader::mediaManufacturerLength</a></div><div class="ttdeci">uint32_t mediaManufacturerLength</div><div class="ttdoc">Length in bytes (including null) of media manufacturer string.</div><div class="ttdef"><b>Definition</b> <a href="#l00082">metadata.h:82</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a9438f57b0304b42912b8c66e5a0f1051"><div class="ttname"><a href="structMetadataBlockHeader.html#a9438f57b0304b42912b8c66e5a0f1051">MetadataBlockHeader::mediaModelLength</a></div><div class="ttdeci">uint32_t mediaModelLength</div><div class="ttdoc">Length in bytes (including null) of media model string.</div><div class="ttdef"><b>Definition</b> <a href="#l00084">metadata.h:84</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a9bcf425f7ae5ab41d030c9b1f2c72979"><div class="ttname"><a href="structMetadataBlockHeader.html#a9bcf425f7ae5ab41d030c9b1f2c72979">MetadataBlockHeader::driveFirmwareRevisionOffset</a></div><div class="ttdeci">uint32_t driveFirmwareRevisionOffset</div><div class="ttdoc">Offset to UTF-16LE drive firmware revision string.</div><div class="ttdef"><b>Definition</b> <a href="#l00097">metadata.h:97</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_aacd243f7f5a78c6087b797328197f522"><div class="ttname"><a href="structMetadataBlockHeader.html#aacd243f7f5a78c6087b797328197f522">MetadataBlockHeader::lastMediaSequence</a></div><div class="ttdeci">int32_t lastMediaSequence</div><div class="ttdoc">Total number of media in the set; 0 or 1 if single item.</div><div class="ttdef"><b>Definition</b> <a href="#l00074">metadata.h:74</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_abd56f9918aab6b6ee628abf6ca04c6d9"><div class="ttname"><a href="structMetadataBlockHeader.html#abd56f9918aab6b6ee628abf6ca04c6d9">MetadataBlockHeader::commentsOffset</a></div><div class="ttdeci">uint32_t commentsOffset</div><div class="ttdoc">Offset to UTF-16LE comments string.</div><div class="ttdef"><b>Definition</b> <a href="#l00077">metadata.h:77</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_acb4e827848c2525a0fa5fcc6cfcf2887"><div class="ttname"><a href="structMetadataBlockHeader.html#acb4e827848c2525a0fa5fcc6cfcf2887">MetadataBlockHeader::driveManufacturerOffset</a></div><div class="ttdeci">uint32_t driveManufacturerOffset</div><div class="ttdoc">Offset to UTF-16LE drive manufacturer string.</div><div class="ttdef"><b>Definition</b> <a href="#l00091">metadata.h:91</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_ae4561c1f946fe76239810f29a237dfbc"><div class="ttname"><a href="structMetadataBlockHeader.html#ae4561c1f946fe76239810f29a237dfbc">MetadataBlockHeader::mediaSerialNumberOffset</a></div><div class="ttdeci">uint32_t mediaSerialNumberOffset</div><div class="ttdoc">Offset to UTF-16LE media serial number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00085">metadata.h:85</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_aeae9bce28abec33ffa90005f2a247e34"><div class="ttname"><a href="structMetadataBlockHeader.html#aeae9bce28abec33ffa90005f2a247e34">MetadataBlockHeader::mediaSerialNumberLength</a></div><div class="ttdeci">uint32_t mediaSerialNumberLength</div><div class="ttdoc">Length in bytes (including null) of media serial number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00086">metadata.h:86</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_aeb9233f4dd077e5b0985a3a776deb7c8"><div class="ttname"><a href="structMetadataBlockHeader.html#aeb9233f4dd077e5b0985a3a776deb7c8">MetadataBlockHeader::mediaPartNumberOffset</a></div><div class="ttdeci">uint32_t mediaPartNumberOffset</div><div class="ttdoc">Offset to UTF-16LE media part number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00089">metadata.h:89</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_aef055916275048b6496f1f74eef2f1ac"><div class="ttname"><a href="structMetadataBlockHeader.html#aef055916275048b6496f1f74eef2f1ac">MetadataBlockHeader::mediaPartNumberLength</a></div><div class="ttdeci">uint32_t mediaPartNumberLength</div><div class="ttdoc">Length in bytes (including null) of media part number string.</div><div class="ttdef"><b>Definition</b> <a href="#l00090">metadata.h:90</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_aef456689422a0514489b1c900ee2c741"><div class="ttname"><a href="structMetadataBlockHeader.html#aef456689422a0514489b1c900ee2c741">MetadataBlockHeader::mediaBarcodeLength</a></div><div class="ttdeci">uint32_t mediaBarcodeLength</div><div class="ttdoc">Length in bytes (including null) of media barcode string.</div><div class="ttdef"><b>Definition</b> <a href="#l00088">metadata.h:88</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_af620858c254ea17f2d75b065134239c8"><div class="ttname"><a href="structMetadataBlockHeader.html#af620858c254ea17f2d75b065134239c8">MetadataBlockHeader::creatorLength</a></div><div class="ttdeci">uint32_t creatorLength</div><div class="ttdoc">Length in bytes (including null) of creator string (0 if absent).</div><div class="ttdef"><b>Definition</b> <a href="#l00076">metadata.h:76</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_afbf024f5492e45a3643ea7a1652b6420"><div class="ttname"><a href="structMetadataBlockHeader.html#afbf024f5492e45a3643ea7a1652b6420">MetadataBlockHeader::driveFirmwareRevisionLength</a></div><div class="ttdeci">uint32_t driveFirmwareRevisionLength</div><div class="ttdoc">Length in bytes (including null) of drive firmware revision string.</div><div class="ttdef"><b>Definition</b> <a href="#l00098">metadata.h:98</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_affd6e10a1ab8eb3714a6ff09b3471747"><div class="ttname"><a href="structMetadataBlockHeader.html#affd6e10a1ab8eb3714a6ff09b3471747">MetadataBlockHeader::mediaBarcodeOffset</a></div><div class="ttdeci">uint32_t mediaBarcodeOffset</div><div class="ttdoc">Offset to UTF-16LE media barcode string.</div><div class="ttdef"><b>Definition</b> <a href="#l00087">metadata.h:87</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</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>