aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
03c091fdeefdcf6b1a6093294609c4693b5138ef
libaaruformat/docs/html/structTrackEntry.html

305 lines
16 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!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: TrackEntry Struct 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">&#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('structTrackEntry.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">TrackEntry Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Single optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags).
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="optical_8h_source.html">aaruformat/structs/optical.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa6464108b61ee648a5aa8e6ffcc9a59a" id="r_aa6464108b61ee648a5aa8e6ffcc9a59a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa6464108b61ee648a5aa8e6ffcc9a59a">sequence</a></td></tr>
<tr class="memdesc:aa6464108b61ee648a5aa8e6ffcc9a59a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Track number (1..99 typical for CD audio/data). 0 may indicate placeholder/non-standard. <br /></td></tr>
<tr class="memitem:ac8dd4cd45f2757b51a27385c7731dde4" id="r_ac8dd4cd45f2757b51a27385c7731dde4"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8dd4cd45f2757b51a27385c7731dde4">type</a></td></tr>
<tr class="memdesc:ac8dd4cd45f2757b51a27385c7731dde4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Track type (value from <a class="el" href="enums_8h.html#ad80740dd555f7d3688d2c4d9f44d3b04">TrackType</a>). <br /></td></tr>
<tr class="memitem:aa82e4a2aa2cfecee9891f117e9494cdf" id="r_aa82e4a2aa2cfecee9891f117e9494cdf"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa82e4a2aa2cfecee9891f117e9494cdf">start</a></td></tr>
<tr class="memdesc:aa82e4a2aa2cfecee9891f117e9494cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inclusive starting LBA of the track. <br /></td></tr>
<tr class="memitem:a7c545a1a4aa3547eacac09b3652034dd" id="r_a7c545a1a4aa3547eacac09b3652034dd"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c545a1a4aa3547eacac09b3652034dd">end</a></td></tr>
<tr class="memdesc:a7c545a1a4aa3547eacac09b3652034dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inclusive ending LBA of the track. <br /></td></tr>
<tr class="memitem:a84fbff0d6d7b4f6451386c1665fb43d6" id="r_a84fbff0d6d7b4f6451386c1665fb43d6"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a84fbff0d6d7b4f6451386c1665fb43d6">pregap</a></td></tr>
<tr class="memdesc:a84fbff0d6d7b4f6451386c1665fb43d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pre-gap length in sectors preceding track start (0 if none). <br /></td></tr>
<tr class="memitem:a74f57f3c7758ff4e156b2cceff461242" id="r_a74f57f3c7758ff4e156b2cceff461242"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74f57f3c7758ff4e156b2cceff461242">session</a></td></tr>
<tr class="memdesc:a74f57f3c7758ff4e156b2cceff461242"><td class="mdescLeft">&#160;</td><td class="mdescRight">Session number (1-based). 1 for single-session discs. <br /></td></tr>
<tr class="memitem:acb023e4728c59964c83fe85474c512c8" id="r_acb023e4728c59964c83fe85474c512c8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acb023e4728c59964c83fe85474c512c8">isrc</a> [13]</td></tr>
<tr class="memdesc:acb023e4728c59964c83fe85474c512c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">ISRC raw 13-byte code (no null terminator). All zeros if not present. <br /></td></tr>
<tr class="memitem:a7ae98d532f6dff50c2439b64d2cddb45" id="r_a7ae98d532f6dff50c2439b64d2cddb45"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ae98d532f6dff50c2439b64d2cddb45">flags</a></td></tr>
<tr class="memdesc:a7ae98d532f6dff50c2439b64d2cddb45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control / attribute bitfield (see file documentation for suggested bit mapping). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Single optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags). </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00071">71</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a7c545a1a4aa3547eacac09b3652034dd" name="a7c545a1a4aa3547eacac09b3652034dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c545a1a4aa3547eacac09b3652034dd">&#9670;&#160;</a></span>end</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t TrackEntry::end</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inclusive ending LBA of the track. </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00076">76</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, and <a class="el" href="write_8c_source.html#l00537">aaruf_write_sector_long()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a7ae98d532f6dff50c2439b64d2cddb45" name="a7ae98d532f6dff50c2439b64d2cddb45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ae98d532f6dff50c2439b64d2cddb45">&#9670;&#160;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t TrackEntry::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control / attribute bitfield (see file documentation for suggested bit mapping). </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00080">80</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, and <a class="el" href="write_8c_source.html#l02069">aaruf_write_sector_tag()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="acb023e4728c59964c83fe85474c512c8" name="acb023e4728c59964c83fe85474c512c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb023e4728c59964c83fe85474c512c8">&#9670;&#160;</a></span>isrc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t TrackEntry::isrc[13]</td>
</tr>
</table>
</div><div class="memdoc">
<p>ISRC raw 13-byte code (no null terminator). All zeros if not present. </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00079">79</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, and <a class="el" href="write_8c_source.html#l02069">aaruf_write_sector_tag()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a84fbff0d6d7b4f6451386c1665fb43d6" name="a84fbff0d6d7b4f6451386c1665fb43d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84fbff0d6d7b4f6451386c1665fb43d6">&#9670;&#160;</a></span>pregap</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t TrackEntry::pregap</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pre-gap length in sectors preceding track start (0 if none). </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00077">77</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
</div>
</div>
<a id="aa6464108b61ee648a5aa8e6ffcc9a59a" name="aa6464108b61ee648a5aa8e6ffcc9a59a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6464108b61ee648a5aa8e6ffcc9a59a">&#9670;&#160;</a></span>sequence</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t TrackEntry::sequence</td>
</tr>
</table>
</div><div class="memdoc">
<p>Track number (1..99 typical for CD audio/data). 0 may indicate placeholder/non-standard. </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00073">73</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00670">aaruf_read_track_sector()</a>, <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00537">aaruf_write_sector_long()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a74f57f3c7758ff4e156b2cceff461242" name="a74f57f3c7758ff4e156b2cceff461242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74f57f3c7758ff4e156b2cceff461242">&#9670;&#160;</a></span>session</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t TrackEntry::session</td>
</tr>
</table>
</div><div class="memdoc">
<p>Session number (1-based). 1 for single-session discs. </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00078">78</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>.</p>
</div>
</div>
<a id="aa82e4a2aa2cfecee9891f117e9494cdf" name="aa82e4a2aa2cfecee9891f117e9494cdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa82e4a2aa2cfecee9891f117e9494cdf">&#9670;&#160;</a></span>start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t TrackEntry::start</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inclusive starting LBA of the track. </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00075">75</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, <a class="el" href="read_8c_source.html#l00670">aaruf_read_track_sector()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00537">aaruf_write_sector_long()</a>, and <a class="el" href="write_8c_source.html#l02069">aaruf_write_sector_tag()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="ac8dd4cd45f2757b51a27385c7731dde4" name="ac8dd4cd45f2757b51a27385c7731dde4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8dd4cd45f2757b51a27385c7731dde4">&#9670;&#160;</a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t TrackEntry::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Track type (value from <a class="el" href="enums_8h.html#ad80740dd555f7d3688d2c4d9f44d3b04">TrackType</a>). </p>
<p class="definition">Definition at line <a class="el" href="optical_8h_source.html#l00074">74</a> of file <a class="el" href="optical_8h_source.html">optical.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, and <a class="el" href="write_8c_source.html#l00537">aaruf_write_sector_long()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="optical_8h_source.html">optical.h</a></li>
</ul>
</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="structTrackEntry.html">TrackEntry</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>
Reference in New Issue Copy Permalink