File: //usr/share/doc/openjpeg-devel-1.5.1/html/group___r_a_w.html
<!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.5"/>
<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
 <span id="projectnumber">1.5.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data 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> |
<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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__raw.html">opj_raw</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </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"> </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> </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"> </td><td class="mdescRight">RAW encoding operations. <a href="#ga64fe20ef13d830dd1611487c8d6c6832">More...</a><br/></td></tr>
<tr class="separator:ga64fe20ef13d830dd1611487c8d6c6832"><td class="memSeparator" colspan="2"> </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:ga5b8c5f8f0dac278fa47faaa93cf0c277"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#ga5b8c5f8f0dac278fa47faaa93cf0c277">raw_create</a> (void)</td></tr>
<tr class="memdesc:ga5b8c5f8f0dac278fa47faaa93cf0c277"><td class="mdescLeft"> </td><td class="mdescRight">Create a new RAW handle. <a href="#ga5b8c5f8f0dac278fa47faaa93cf0c277">More...</a><br/></td></tr>
<tr class="separator:ga5b8c5f8f0dac278fa47faaa93cf0c277"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabf8c913b8ab0b6a73a02090386425808"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gabf8c913b8ab0b6a73a02090386425808">raw_destroy</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
<tr class="memdesc:gabf8c913b8ab0b6a73a02090386425808"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a previously created RAW handle. <a href="#gabf8c913b8ab0b6a73a02090386425808">More...</a><br/></td></tr>
<tr class="separator:gabf8c913b8ab0b6a73a02090386425808"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae9717fd971d99e2199a6bbefa58deb2a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gae9717fd971d99e2199a6bbefa58deb2a">raw_numbytes</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
<tr class="memdesc:gae9717fd971d99e2199a6bbefa58deb2a"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bytes written/read since initialisation. <a href="#gae9717fd971d99e2199a6bbefa58deb2a">More...</a><br/></td></tr>
<tr class="separator:gae9717fd971d99e2199a6bbefa58deb2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa96f3b50a2e261963b9a4d949ef51ba8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaa96f3b50a2e261963b9a4d949ef51ba8">raw_init_dec</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw, unsigned char *bp, int len)</td></tr>
<tr class="memdesc:gaa96f3b50a2e261963b9a4d949ef51ba8"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the decoder. <a href="#gaa96f3b50a2e261963b9a4d949ef51ba8">More...</a><br/></td></tr>
<tr class="separator:gaa96f3b50a2e261963b9a4d949ef51ba8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae17f2570cc944ffbdb185dc1906c2fd0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gae17f2570cc944ffbdb185dc1906c2fd0">raw_decode</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
<tr class="memdesc:gae17f2570cc944ffbdb185dc1906c2fd0"><td class="mdescLeft"> </td><td class="mdescRight">Decode a symbol using raw-decoder. <a href="#gae17f2570cc944ffbdb185dc1906c2fd0">More...</a><br/></td></tr>
<tr class="separator:gae17f2570cc944ffbdb185dc1906c2fd0"><td class="memSeparator" colspan="2"> </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="ga5b8c5f8f0dac278fa47faaa93cf0c277"></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>* raw_create </td>
<td>(</td>
<td class="paramtype">void </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#ga81cd24ea7d7a7faa9091746695c7450e">t1_create()</a>.</p>
</div>
</div>
<a class="anchor" id="gae17f2570cc944ffbdb185dc1906c2fd0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int raw_decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> * </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#a33a59de3ab4425d2c1036328efc6184c">opj_raw::c</a>, <a class="el" href="structopj__raw.html#a1428c7ff1b0e57885e97c34a03bb2250">opj_raw::ct</a>, <a class="el" href="structopj__raw.html#a26f7c2bf9b55a3d4bfd052bf8661b588">opj_raw::len</a>, <a class="el" href="structopj__raw.html#a419eff1b8613ff9500d5602326f2ab0d">opj_raw::lenmax</a>, and <a class="el" href="structopj__raw.html#a03193e82112fc72b9038d8319eefaaf7">opj_raw::start</a>.</p>
<p>Referenced by <a class="el" href="group___t1.html#ga39f9a32ae54c466f9943641eeaadd6b8">t1_dec_refpass_step_raw()</a>, and <a class="el" href="group___t1.html#ga5fb1cb4d2472868ff6f5563e1d8db162">t1_dec_sigpass_step_raw()</a>.</p>
</div>
</div>
<a class="anchor" id="gabf8c913b8ab0b6a73a02090386425808"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void raw_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> * </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#ga5d599854d83d1b97fb01a5edfe26382c">t1_destroy()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa96f3b50a2e261963b9a4d949ef51ba8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void raw_init_dec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> * </td>
<td class="paramname"><em>raw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>bp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </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#a33a59de3ab4425d2c1036328efc6184c">opj_raw::c</a>, <a class="el" href="structopj__raw.html#a1428c7ff1b0e57885e97c34a03bb2250">opj_raw::ct</a>, <a class="el" href="structopj__raw.html#a26f7c2bf9b55a3d4bfd052bf8661b588">opj_raw::len</a>, <a class="el" href="structopj__raw.html#a419eff1b8613ff9500d5602326f2ab0d">opj_raw::lenmax</a>, and <a class="el" href="structopj__raw.html#a03193e82112fc72b9038d8319eefaaf7">opj_raw::start</a>.</p>
<p>Referenced by <a class="el" href="group___t1.html#ga44c9e19d0495db0974aa9d57eb4e88f7">t1_decode_cblk()</a>.</p>
</div>
</div>
<a class="anchor" id="gae9717fd971d99e2199a6bbefa58deb2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int raw_numbytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> * </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#a64b8c0def2e2b94425df4afbc41f25b9">opj_raw::bp</a>, and <a class="el" href="structopj__raw.html#a03193e82112fc72b9038d8319eefaaf7">opj_raw::start</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>