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

258 lines
14 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: RAW - Implementation of operations for raw encoding</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><a href="files.html"><span>Files</span></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> </div>
<div class="headertitle">
<div class="title">RAW - Implementation of operations for raw encoding</div> </div>
</div><!--header-->
<div class="contents">
<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="structopj__raw.html">opj_raw</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RAW encoding operations. <a href="structopj__raw.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:ga64fe20ef13d830dd1611487c8d6c6832"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__raw.html">opj_raw</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a></td></tr>
<tr class="memdesc:ga64fe20ef13d830dd1611487c8d6c6832"><td class="mdescLeft">&#160;</td><td class="mdescRight">RAW encoding operations. <a href="#ga64fe20ef13d830dd1611487c8d6c6832">More...</a><br /></td></tr>
<tr class="separator:ga64fe20ef13d830dd1611487c8d6c6832"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Exported functions</h2></td></tr>
<tr class="memitem:ga84d58773379209bf64c3e48e0d174670"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#ga84d58773379209bf64c3e48e0d174670">opj_raw_create</a> (void)</td></tr>
<tr class="memdesc:ga84d58773379209bf64c3e48e0d174670"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new RAW handle. <a href="#ga84d58773379209bf64c3e48e0d174670">More...</a><br /></td></tr>
<tr class="separator:ga84d58773379209bf64c3e48e0d174670"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabb2f5b65ad948ccccf595df86d0e305d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gabb2f5b65ad948ccccf595df86d0e305d">opj_raw_destroy</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
<tr class="memdesc:gabb2f5b65ad948ccccf595df86d0e305d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a previously created RAW handle. <a href="#gabb2f5b65ad948ccccf595df86d0e305d">More...</a><br /></td></tr>
<tr class="separator:gabb2f5b65ad948ccccf595df86d0e305d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee1cb91b1c5183234a36f53e0624f733"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaee1cb91b1c5183234a36f53e0624f733">opj_raw_numbytes</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
<tr class="memdesc:gaee1cb91b1c5183234a36f53e0624f733"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of bytes written/read since initialisation. <a href="#gaee1cb91b1c5183234a36f53e0624f733">More...</a><br /></td></tr>
<tr class="separator:gaee1cb91b1c5183234a36f53e0624f733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaebd3e67e3b8673e4e4c3fa1834406389"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw, <a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *bp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> len)</td></tr>
<tr class="memdesc:gaebd3e67e3b8673e4e4c3fa1834406389"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the decoder. <a href="#gaebd3e67e3b8673e4e4c3fa1834406389">More...</a><br /></td></tr>
<tr class="separator:gaebd3e67e3b8673e4e4c3fa1834406389"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa4e879e1d733e459b94c29141b7df142"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
<tr class="memdesc:gaa4e879e1d733e459b94c29141b7df142"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode a symbol using raw-decoder. <a href="#gaa4e879e1d733e459b94c29141b7df142">More...</a><br /></td></tr>
<tr class="separator:gaa4e879e1d733e459b94c29141b7df142"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga64fe20ef13d830dd1611487c8d6c6832"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structopj__raw.html">opj_raw</a> <a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>RAW encoding operations. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga84d58773379209bf64c3e48e0d174670"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a>* opj_raw_create </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new RAW handle. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a new RAW handle if successful, returns NULL otherwise </dd></dl>
<p>References <a class="el" href="group___m_i_s_c.html#gaed655b4c0cec54620065ab1abf56e8cc">opj_malloc</a>.</p>
<p>Referenced by <a class="el" href="group___t1.html#ga7f1a52a233804744f2c7384ac04117f8">opj_t1_create()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa4e879e1d733e459b94c29141b7df142"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw_decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
<td class="paramname"><em>raw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode a symbol using raw-decoder. </p>
<p>Cfr p.506 TAUBMAN </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">raw</td><td>RAW handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the decoded symbol (0 or 1) </dd></dl>
<p>References <a class="el" href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">opj_raw::c</a>, <a class="el" href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed">opj_raw::ct</a>, <a class="el" href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf">opj_raw::len</a>, <a class="el" href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73">opj_raw::lenmax</a>, and <a class="el" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</a>.</p>
<p>Referenced by <a class="el" href="group___t1.html#ga4c2f45449e3d905c148a5763f1b1f7f7">opj_t1_dec_refpass_step_raw()</a>, and <a class="el" href="group___t1.html#gad7b4fc8f0264a0a1eebc5020986789d7">opj_t1_dec_sigpass_step_raw()</a>.</p>
</div>
</div>
<a class="anchor" id="gabb2f5b65ad948ccccf595df86d0e305d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_raw_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
<td class="paramname"><em>raw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a previously created RAW handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">raw</td><td>RAW handle to destroy </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="group___m_i_s_c.html#ga700b1aef6148bd6c3edde626610ffe2f">opj_free</a>.</p>
<p>Referenced by <a class="el" href="group___t1.html#gadbc87000940d2fc0c5f3e2f0ad28938a">opj_t1_destroy()</a>.</p>
</div>
</div>
<a class="anchor" id="gaebd3e67e3b8673e4e4c3fa1834406389"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_raw_init_dec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
<td class="paramname"><em>raw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
<td class="paramname"><em>bp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the decoder. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">raw</td><td>RAW handle </td></tr>
<tr><td class="paramname">bp</td><td>Pointer to the start of the buffer from which the bytes will be read </td></tr>
<tr><td class="paramname">len</td><td>Length of the input buffer </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">opj_raw::c</a>, <a class="el" href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed">opj_raw::ct</a>, <a class="el" href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf">opj_raw::len</a>, <a class="el" href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73">opj_raw::lenmax</a>, and <a class="el" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</a>.</p>
<p>Referenced by <a class="el" href="group___t1.html#gaa07574c44606911bd26716b4f72aa0bd">opj_t1_decode_cblk()</a>.</p>
</div>
</div>
<a class="anchor" id="gaee1cb91b1c5183234a36f53e0624f733"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw_numbytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
<td class="paramname"><em>raw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of bytes written/read since initialisation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">raw</td><td>RAW handle to destroy </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of bytes already encoded </dd></dl>
<p>References <a class="el" href="structopj__raw.html#a873ec3b4abf06832cb492f1fe0f9dde9">opj_raw::bp</a>, and <a class="el" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</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>