walkero
/
openjpeg
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
openjpeg/doxygen/marker__manager_8h.html

289 lines
18 KiB
HTML
Raw Normal View History

added doxygen for latest release
2015-07-10 18:06:19 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>OpenJPEG: marker_manager.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>
<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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
&#160;<span id="projectnumber">2.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_6ec2d9a1b37a1187cc46aeaf3b19e1b3.html">openjpip</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">marker_manager.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="codestream__manager_8h_source.html">codestream_manager.h</a>&quot;</code><br />
</div>
<p><a href="marker__manager_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmarker__param.html">marker_param</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marker parameters. <a href="structmarker__param.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa224fdf1390f864fa5766cfb7b70d8df"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmarker__param.html">marker_param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a></td></tr>
<tr class="memdesc:aa224fdf1390f864fa5766cfb7b70d8df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marker parameters. <a href="#aa224fdf1390f864fa5766cfb7b70d8df">More...</a><br /></td></tr>
<tr class="separator:aa224fdf1390f864fa5766cfb7b70d8df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#aeba6604c55d20ce4dafca1c0bd8e1fbc">set_marker</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> cs, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> length)</td></tr>
<tr class="memdesc:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">set marker parameters from inputs <a href="#aeba6604c55d20ce4dafca1c0bd8e1fbc">More...</a><br /></td></tr>
<tr class="separator:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a310269e7466f3a1588930e9cbc51570c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
<tr class="memdesc:a310269e7466f3a1588930e9cbc51570c"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 1-bytes of data in file stream <a href="#a310269e7466f3a1588930e9cbc51570c">More...</a><br /></td></tr>
<tr class="separator:a310269e7466f3a1588930e9cbc51570c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac884dafb92a564a501b1cbc01333d248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
<tr class="memdesc:ac884dafb92a564a501b1cbc01333d248"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 2-byte big endian Byte codes in file stream <a href="#ac884dafb92a564a501b1cbc01333d248">More...</a><br /></td></tr>
<tr class="separator:ac884dafb92a564a501b1cbc01333d248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6531c0062e0d866e406543e3f63f9c86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
<tr class="memdesc:a6531c0062e0d866e406543e3f63f9c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 4-byte big endian Byte codes in file stream <a href="#a6531c0062e0d866e406543e3f63f9c86">More...</a><br /></td></tr>
<tr class="separator:a6531c0062e0d866e406543e3f63f9c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="aa224fdf1390f864fa5766cfb7b70d8df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmarker__param.html">marker_param</a> <a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Marker parameters. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a310269e7466f3a1588930e9cbc51570c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> fetch_marker1byte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
<td class="paramname"><em>marker</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>fetch marker content 1-bytes of data in file stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
<p>References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#af659af47f43c4ef6cea74c5697acf078">fetch_codestream1byte()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
<p>Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
</div>
</div>
<a class="anchor" id="ac884dafb92a564a501b1cbc01333d248"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> fetch_marker2bytebigendian </td>
<td>(</td>
<td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
<td class="paramname"><em>marker</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>fetch marker content 2-byte big endian Byte codes in file stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
<p>References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#a6dbb4634cd0d3c32cc641750119d1a65">fetch_codestream2bytebigendian()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
<p>Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
</div>
</div>
<a class="anchor" id="a6531c0062e0d866e406543e3f63f9c86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> fetch_marker4bytebigendian </td>
<td>(</td>
<td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
<td class="paramname"><em>marker</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>fetch marker content 4-byte big endian Byte codes in file stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
<p>References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#aee603a657d0cf18f32e86bd2b2efdafe">fetch_codestream4bytebigendian()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
<p>Referenced by <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
</div>
</div>
<a class="anchor" id="aeba6604c55d20ce4dafca1c0bd8e1fbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> set_marker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a>&#160;</td>
<td class="paramname"><em>cs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set marker parameters from inputs </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>marker code </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>marker code </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset in the codestream </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>marker segment length </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>structure of generated marker parameters </dd></dl>
<p>References <a class="el" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">marker_param::code</a>, <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">marker_param::length</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
<p>Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>