Files
libaaruformat/docs/html/optical_8h_source.html

170 lines
18 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/optical.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('optical_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">optical.h</div></div>
</div><!--header-->
<div class="contents">
<a href="optical_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_OPTICAL_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_OPTICAL_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="l00057" name="l00057"></a><span class="lineno"> 57</span></div>
<div class="foldopen" id="foldopen00061" data-start="{" data-end="};">
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="structTracksHeader.html"> 61</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structTracksHeader.html">TracksHeader</a></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>{</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structTracksHeader.html#a8f78b3d1336efc46e97bbd84deab8e80"> 63</a></span> uint32_t <a class="code hl_variable" href="structTracksHeader.html#a8f78b3d1336efc46e97bbd84deab8e80">identifier</a>; </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structTracksHeader.html#a98df23dccacc04396f07f450a742527a"> 64</a></span> uint16_t <a class="code hl_variable" href="structTracksHeader.html#a98df23dccacc04396f07f450a742527a">entries</a>; </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structTracksHeader.html#ad85cd14bec1034946445058d45b97993"> 65</a></span> uint64_t <a class="code hl_variable" href="structTracksHeader.html#ad85cd14bec1034946445058d45b97993">crc64</a>; </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="optical_8h.html#ab11869cb71789b4d8e2cde0cbe2149d5"> 66</a></span>} <a class="code hl_struct" href="structTracksHeader.html">TracksHeader</a>;</div>
</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span></div>
<div class="foldopen" id="foldopen00071" data-start="{" data-end="};">
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="structTrackEntry.html"> 71</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structTrackEntry.html">TrackEntry</a></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span>{</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="structTrackEntry.html#aa6464108b61ee648a5aa8e6ffcc9a59a"> 73</a></span> uint8_t <a class="code hl_variable" href="structTrackEntry.html#aa6464108b61ee648a5aa8e6ffcc9a59a">sequence</a>; </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structTrackEntry.html#ac8dd4cd45f2757b51a27385c7731dde4"> 74</a></span> uint8_t <a class="code hl_variable" href="structTrackEntry.html#ac8dd4cd45f2757b51a27385c7731dde4">type</a>; </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="structTrackEntry.html#aa82e4a2aa2cfecee9891f117e9494cdf"> 75</a></span> int64_t <a class="code hl_variable" href="structTrackEntry.html#aa82e4a2aa2cfecee9891f117e9494cdf">start</a>; </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structTrackEntry.html#a7c545a1a4aa3547eacac09b3652034dd"> 76</a></span> int64_t <a class="code hl_variable" href="structTrackEntry.html#a7c545a1a4aa3547eacac09b3652034dd">end</a>; </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="structTrackEntry.html#a84fbff0d6d7b4f6451386c1665fb43d6"> 77</a></span> int64_t <a class="code hl_variable" href="structTrackEntry.html#a84fbff0d6d7b4f6451386c1665fb43d6">pregap</a>; </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structTrackEntry.html#a74f57f3c7758ff4e156b2cceff461242"> 78</a></span> uint8_t <a class="code hl_variable" href="structTrackEntry.html#a74f57f3c7758ff4e156b2cceff461242">session</a>; </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="structTrackEntry.html#acb023e4728c59964c83fe85474c512c8"> 79</a></span> uint8_t <a class="code hl_variable" href="structTrackEntry.html#acb023e4728c59964c83fe85474c512c8">isrc</a>[13]; </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="structTrackEntry.html#a7ae98d532f6dff50c2439b64d2cddb45"> 80</a></span> uint8_t <a class="code hl_variable" href="structTrackEntry.html#a7ae98d532f6dff50c2439b64d2cddb45">flags</a>; </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="optical_8h.html#a8701d2178c6ffebf82e4d3f267a7dd8e"> 81</a></span>} <a class="code hl_struct" href="structTrackEntry.html">TrackEntry</a>;</div>
</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_OPTICAL_H</span></div>
<div class="ttc" id="astructTrackEntry_html"><div class="ttname"><a href="structTrackEntry.html">TrackEntry</a></div><div class="ttdoc">Single optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags).</div><div class="ttdef"><b>Definition</b> <a href="#l00071">optical.h:72</a></div></div>
<div class="ttc" id="astructTrackEntry_html_a74f57f3c7758ff4e156b2cceff461242"><div class="ttname"><a href="structTrackEntry.html#a74f57f3c7758ff4e156b2cceff461242">TrackEntry::session</a></div><div class="ttdeci">uint8_t session</div><div class="ttdoc">Session number (1-based). 1 for single-session discs.</div><div class="ttdef"><b>Definition</b> <a href="#l00078">optical.h:78</a></div></div>
<div class="ttc" id="astructTrackEntry_html_a7ae98d532f6dff50c2439b64d2cddb45"><div class="ttname"><a href="structTrackEntry.html#a7ae98d532f6dff50c2439b64d2cddb45">TrackEntry::flags</a></div><div class="ttdeci">uint8_t flags</div><div class="ttdoc">Control / attribute bitfield (see file documentation for suggested bit mapping).</div><div class="ttdef"><b>Definition</b> <a href="#l00080">optical.h:80</a></div></div>
<div class="ttc" id="astructTrackEntry_html_a7c545a1a4aa3547eacac09b3652034dd"><div class="ttname"><a href="structTrackEntry.html#a7c545a1a4aa3547eacac09b3652034dd">TrackEntry::end</a></div><div class="ttdeci">int64_t end</div><div class="ttdoc">Inclusive ending LBA of the track.</div><div class="ttdef"><b>Definition</b> <a href="#l00076">optical.h:76</a></div></div>
<div class="ttc" id="astructTrackEntry_html_a84fbff0d6d7b4f6451386c1665fb43d6"><div class="ttname"><a href="structTrackEntry.html#a84fbff0d6d7b4f6451386c1665fb43d6">TrackEntry::pregap</a></div><div class="ttdeci">int64_t pregap</div><div class="ttdoc">Pre-gap length in sectors preceding track start (0 if none).</div><div class="ttdef"><b>Definition</b> <a href="#l00077">optical.h:77</a></div></div>
<div class="ttc" id="astructTrackEntry_html_aa6464108b61ee648a5aa8e6ffcc9a59a"><div class="ttname"><a href="structTrackEntry.html#aa6464108b61ee648a5aa8e6ffcc9a59a">TrackEntry::sequence</a></div><div class="ttdeci">uint8_t sequence</div><div class="ttdoc">Track number (1..99 typical for CD audio/data). 0 may indicate placeholder/non-standard.</div><div class="ttdef"><b>Definition</b> <a href="#l00073">optical.h:73</a></div></div>
<div class="ttc" id="astructTrackEntry_html_aa82e4a2aa2cfecee9891f117e9494cdf"><div class="ttname"><a href="structTrackEntry.html#aa82e4a2aa2cfecee9891f117e9494cdf">TrackEntry::start</a></div><div class="ttdeci">int64_t start</div><div class="ttdoc">Inclusive starting LBA of the track.</div><div class="ttdef"><b>Definition</b> <a href="#l00075">optical.h:75</a></div></div>
<div class="ttc" id="astructTrackEntry_html_ac8dd4cd45f2757b51a27385c7731dde4"><div class="ttname"><a href="structTrackEntry.html#ac8dd4cd45f2757b51a27385c7731dde4">TrackEntry::type</a></div><div class="ttdeci">uint8_t type</div><div class="ttdoc">Track type (value from TrackType).</div><div class="ttdef"><b>Definition</b> <a href="#l00074">optical.h:74</a></div></div>
<div class="ttc" id="astructTrackEntry_html_acb023e4728c59964c83fe85474c512c8"><div class="ttname"><a href="structTrackEntry.html#acb023e4728c59964c83fe85474c512c8">TrackEntry::isrc</a></div><div class="ttdeci">uint8_t isrc[13]</div><div class="ttdoc">ISRC raw 13-byte code (no null terminator). All zeros if not present.</div><div class="ttdef"><b>Definition</b> <a href="#l00079">optical.h:79</a></div></div>
<div class="ttc" id="astructTracksHeader_html"><div class="ttname"><a href="structTracksHeader.html">TracksHeader</a></div><div class="ttdoc">Header for an optical tracks block listing track entries.</div><div class="ttdef"><b>Definition</b> <a href="#l00061">optical.h:62</a></div></div>
<div class="ttc" id="astructTracksHeader_html_a8f78b3d1336efc46e97bbd84deab8e80"><div class="ttname"><a href="structTracksHeader.html#a8f78b3d1336efc46e97bbd84deab8e80">TracksHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier (must be BlockType::TracksBlock).</div><div class="ttdef"><b>Definition</b> <a href="#l00063">optical.h:63</a></div></div>
<div class="ttc" id="astructTracksHeader_html_a98df23dccacc04396f07f450a742527a"><div class="ttname"><a href="structTracksHeader.html#a98df23dccacc04396f07f450a742527a">TracksHeader::entries</a></div><div class="ttdeci">uint16_t entries</div><div class="ttdoc">Number of TrackEntry records following this header.</div><div class="ttdef"><b>Definition</b> <a href="#l00064">optical.h:64</a></div></div>
<div class="ttc" id="astructTracksHeader_html_ad85cd14bec1034946445058d45b97993"><div class="ttname"><a href="structTracksHeader.html#ad85cd14bec1034946445058d45b97993">TracksHeader::crc64</a></div><div class="ttdeci">uint64_t crc64</div><div class="ttdoc">CRC64-ECMA of the TrackEntry array (header excluded, legacy byte-swap for early versions).</div><div class="ttdef"><b>Definition</b> <a href="#l00065">optical.h:65</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="optical_8h.html">optical.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>