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

138 lines
20 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.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>
<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_68013e83e260d17d49dee5e209315608.html">openjp2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">raw.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="raw_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * The copyright in this software is being made available under the 2-clauses </span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * BSD License, included below. This software may be subject to other third </span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * party and contributor rights, including patent rights, and no such rights</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * are granted under this license.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Professor Benoit Macq</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * Copyright (c) 2003-2007, Francois-Olivier Devaux </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Copyright (c) 2003-2014, Antonin Descampe</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Copyright (c) 2005, Herve Drolon, FreeImage Team</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * are met:</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#ifndef __RAW_H</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define __RAW_H</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structopj__raw.html"> 52</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structopj__raw.html">opj_raw</a> {</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4"> 54</a></span>&#160; <a class="code" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> <a class="code" href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">c</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed"> 56</a></span>&#160; <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed">ct</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73"> 58</a></span>&#160; <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73">lenmax</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf"> 60</a></span>&#160; <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf">len</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structopj__raw.html#a873ec3b4abf06832cb492f1fe0f9dde9"> 62</a></span>&#160; <a class="code" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *<a class="code" href="structopj__raw.html#a873ec3b4abf06832cb492f1fe0f9dde9">bp</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f"> 64</a></span>&#160; <a class="code" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *<a class="code" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">start</a>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structopj__raw.html#ad81abd256f06335bd3d23872cbad204a"> 66</a></span>&#160; <a class="code" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *<a class="code" href="structopj__raw.html#ad81abd256f06335bd3d23872cbad204a">end</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;} <a class="code" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<a class="code" href="structopj__raw.html">opj_raw_t</a>* <a class="code" href="group___r_a_w.html#ga84d58773379209bf64c3e48e0d174670">opj_raw_create</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___r_a_w.html#gabb2f5b65ad948ccccf595df86d0e305d">opj_raw_destroy</a>(<a class="code" href="structopj__raw.html">opj_raw_t</a> *raw);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="group___r_a_w.html#gaee1cb91b1c5183234a36f53e0624f733">opj_raw_numbytes</a>(<a class="code" href="structopj__raw.html">opj_raw_t</a> *raw);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec</a>(<a class="code" href="structopj__raw.html">opj_raw_t</a> *raw, <a class="code" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *bp, <a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> len);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<a class="code" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> <a class="code" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode</a>(<a class="code" href="structopj__raw.html">opj_raw_t</a> *raw);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __RAW_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="structopj__raw_html_a873ec3b4abf06832cb492f1fe0f9dde9"><div class="ttname"><a href="structopj__raw.html#a873ec3b4abf06832cb492f1fe0f9dde9">opj_raw::bp</a></div><div class="ttdeci">OPJ_BYTE * bp</div><div class="ttdoc">pointer to the current position in the buffer </div><div class="ttdef"><b>Definition:</b> raw.h:62</div></div>
<div class="ttc" id="group___r_a_w_html_ga84d58773379209bf64c3e48e0d174670"><div class="ttname"><a href="group___r_a_w.html#ga84d58773379209bf64c3e48e0d174670">opj_raw_create</a></div><div class="ttdeci">opj_raw_t * opj_raw_create(void)</div><div class="ttdoc">Create a new RAW handle. </div><div class="ttdef"><b>Definition:</b> raw.c:51</div></div>
<div class="ttc" id="structopj__raw_html_ad81abd256f06335bd3d23872cbad204a"><div class="ttname"><a href="structopj__raw.html#ad81abd256f06335bd3d23872cbad204a">opj_raw::end</a></div><div class="ttdeci">OPJ_BYTE * end</div><div class="ttdoc">pointer to the end of the buffer </div><div class="ttdef"><b>Definition:</b> raw.h:66</div></div>
<div class="ttc" id="structopj__raw_html_a9e5a976d8f55e567af92c9ff6fd492e4"><div class="ttname"><a href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">opj_raw::c</a></div><div class="ttdeci">OPJ_BYTE c</div><div class="ttdoc">temporary buffer where bits are coded or decoded </div><div class="ttdef"><b>Definition:</b> raw.h:54</div></div>
<div class="ttc" id="openjpeg_8h_html_a22de44e15bddae7edfacf4e9ac9bb199"><div class="ttname"><a href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a></div><div class="ttdeci">unsigned char OPJ_BYTE</div><div class="ttdef"><b>Definition:</b> openjpeg.h:117</div></div>
<div class="ttc" id="structopj__raw_html"><div class="ttname"><a href="structopj__raw.html">opj_raw</a></div><div class="ttdoc">RAW encoding operations. </div><div class="ttdef"><b>Definition:</b> raw.h:52</div></div>
<div class="ttc" id="group___r_a_w_html_gabb2f5b65ad948ccccf595df86d0e305d"><div class="ttname"><a href="group___r_a_w.html#gabb2f5b65ad948ccccf595df86d0e305d">opj_raw_destroy</a></div><div class="ttdeci">void opj_raw_destroy(opj_raw_t *raw)</div><div class="ttdoc">Destroy a previously created RAW handle. </div><div class="ttdef"><b>Definition:</b> raw.c:56</div></div>
<div class="ttc" id="structopj__raw_html_a49edd2e5113c2727bebb56937c0811bf"><div class="ttname"><a href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf">opj_raw::len</a></div><div class="ttdeci">OPJ_UINT32 len</div><div class="ttdoc">length decoded </div><div class="ttdef"><b>Definition:</b> raw.h:60</div></div>
<div class="ttc" id="group___r_a_w_html_gaa4e879e1d733e459b94c29141b7df142"><div class="ttname"><a href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode</a></div><div class="ttdeci">OPJ_UINT32 opj_raw_decode(opj_raw_t *raw)</div><div class="ttdoc">Decode a symbol using raw-decoder. </div><div class="ttdef"><b>Definition:</b> raw.c:76</div></div>
<div class="ttc" id="structopj__raw_html_ab135fadf2a1c829503331c3bf909496f"><div class="ttname"><a href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</a></div><div class="ttdeci">OPJ_BYTE * start</div><div class="ttdoc">pointer to the start of the buffer </div><div class="ttdef"><b>Definition:</b> raw.h:64</div></div>
<div class="ttc" id="group___r_a_w_html_ga64fe20ef13d830dd1611487c8d6c6832"><div class="ttname"><a href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a></div><div class="ttdeci">struct opj_raw opj_raw_t</div><div class="ttdoc">RAW encoding operations. </div></div>
<div class="ttc" id="structopj__raw_html_afb86b09eef74471031c6d4144e4951ed"><div class="ttname"><a href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed">opj_raw::ct</a></div><div class="ttdeci">OPJ_UINT32 ct</div><div class="ttdoc">number of bits already read or free to write </div><div class="ttdef"><b>Definition:</b> raw.h:56</div></div>
<div class="ttc" id="structopj__raw_html_a37d9f82ef382e011692f6d03e2be1b73"><div class="ttname"><a href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73">opj_raw::lenmax</a></div><div class="ttdeci">OPJ_UINT32 lenmax</div><div class="ttdoc">maximum length to decode </div><div class="ttdef"><b>Definition:</b> raw.h:58</div></div>
<div class="ttc" id="openjpeg_8h_html_a4cb1e6e6b6ef2df499d5c02f7df54cbb"><div class="ttname"><a href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a></div><div class="ttdeci">uint32_t OPJ_UINT32</div><div class="ttdef"><b>Definition:</b> openjpeg.h:126</div></div>
<div class="ttc" id="group___r_a_w_html_gaebd3e67e3b8673e4e4c3fa1834406389"><div class="ttname"><a href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec</a></div><div class="ttdeci">void opj_raw_init_dec(opj_raw_t *raw, OPJ_BYTE *bp, OPJ_UINT32 len)</div><div class="ttdoc">Initialize the decoder. </div><div class="ttdef"><b>Definition:</b> raw.c:68</div></div>
<div class="ttc" id="group___r_a_w_html_gaee1cb91b1c5183234a36f53e0624f733"><div class="ttname"><a href="group___r_a_w.html#gaee1cb91b1c5183234a36f53e0624f733">opj_raw_numbytes</a></div><div class="ttdeci">OPJ_UINT32 opj_raw_numbytes(opj_raw_t *raw)</div><div class="ttdoc">Return the number of bytes written/read since initialisation. </div><div class="ttdef"><b>Definition:</b> raw.c:62</div></div>
</div><!-- fragment --></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>