File: //usr/share/doc/openjpeg-devel-1.5.1/html/bio_8h_source.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: bio.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
 <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 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 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_99d2dc560f84dde124e930de108007a7.html">builddir</a></li><li class="navelem"><a class="el" href="dir_f6883469d6f26503444921bb15d930e9.html">build</a></li><li class="navelem"><a class="el" href="dir_37d5b7668ae03bfa373b2267d602ea0e.html">BUILD</a></li><li class="navelem"><a class="el" href="dir_9904e09c490f202282706830189faba0.html">openjpeg-1.5.1</a></li><li class="navelem"><a class="el" href="dir_10074df973a1c5851187da2011751b4d.html">libopenjpeg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">bio.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="bio_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> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (c) 2002-2007, Professor Benoit Macq</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2001-2003, David Janssens</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright (c) 2002-2003, Yannick Verschueren</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (c) 2005, Herve Drolon, FreeImage Team</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * modification, are permitted provided that the following conditions</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * are met:</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <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="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef __BIO_H</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#define __BIO_H</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structopj__bio.html"> 47</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structopj__bio.html">opj_bio</a> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structopj__bio.html#a1e49bc274ee063f8cb3890943f6a71ec"> 49</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *<a class="code" href="structopj__bio.html#a1e49bc274ee063f8cb3890943f6a71ec">start</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structopj__bio.html#ad009bf26f6ed6f767dfe739b4dfb3606"> 51</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *<a class="code" href="structopj__bio.html#ad009bf26f6ed6f767dfe739b4dfb3606">end</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structopj__bio.html#ae4bb6b38d6176a4881c23525fc4db3ae"> 53</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *<a class="code" href="structopj__bio.html#ae4bb6b38d6176a4881c23525fc4db3ae">bp</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structopj__bio.html#a3e4cb185e2ff512e3d4c341a0fa9b839"> 55</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structopj__bio.html#a3e4cb185e2ff512e3d4c341a0fa9b839">buf</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structopj__bio.html#a1b7b5746ec3daf85670fcc2d89a88d65"> 57</a></span>  <span class="keywordtype">int</span> <a class="code" href="structopj__bio.html#a1b7b5746ec3daf85670fcc2d89a88d65">ct</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <a class="code" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="structopj__bio.html">opj_bio_t</a>* <a class="code" href="group___b_i_o.html#gafa5537fe6cf2418fd2f31fcc812baa2b">bio_create</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> <a class="code" href="group___b_i_o.html#ga7af38eead67b1b281700391bed3505e0">bio_destroy</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">int</span> <a class="code" href="group___b_i_o.html#ga4facf6693c470dc139a8ca138f961310">bio_numbytes</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">void</span> <a class="code" href="group___b_i_o.html#gaae0ce26f1ac1e141eec1d5f54eae9b93">bio_init_enc</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *bp, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">void</span> <a class="code" href="group___b_i_o.html#gab660df41991f938ddcc1b4687ab07697">bio_init_dec</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *bp, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">void</span> <a class="code" href="group___b_i_o.html#ga0ef1ef3fb0d962f0b181c4306efdc50d">bio_write</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio, <span class="keywordtype">int</span> v, <span class="keywordtype">int</span> n);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">int</span> <a class="code" href="group___b_i_o.html#gaabcc1400d7f0d0fd724cf941fe86c231">bio_read</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio, <span class="keywordtype">int</span> n);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">int</span> <a class="code" href="group___b_i_o.html#gaebca615eb9025963d51c468f438dac5e">bio_flush</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="keywordtype">int</span> <a class="code" href="group___b_i_o.html#ga1e246d84c6cbc14881672a613c91dff7">bio_inalign</a>(<a class="code" href="structopj__bio.html">opj_bio_t</a> *bio);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif </span><span class="comment">/* __BIO_H */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor"></span></div>
<div class="ttc" id="group___b_i_o_html_gaabcc1400d7f0d0fd724cf941fe86c231"><div class="ttname"><a href="group___b_i_o.html#gaabcc1400d7f0d0fd724cf941fe86c231">bio_read</a></div><div class="ttdeci">int bio_read(opj_bio_t *bio, int n)</div><div class="ttdoc">Read bits. </div><div class="ttdef"><b>Definition:</b> bio.c:155</div></div>
<div class="ttc" id="structopj__bio_html_a1e49bc274ee063f8cb3890943f6a71ec"><div class="ttname"><a href="structopj__bio.html#a1e49bc274ee063f8cb3890943f6a71ec">opj_bio::start</a></div><div class="ttdeci">unsigned char * start</div><div class="ttdoc">pointer to the start of the buffer </div><div class="ttdef"><b>Definition:</b> bio.h:49</div></div>
<div class="ttc" id="group___b_i_o_html_gaebca615eb9025963d51c468f438dac5e"><div class="ttname"><a href="group___b_i_o.html#gaebca615eb9025963d51c468f438dac5e">bio_flush</a></div><div class="ttdeci">int bio_flush(opj_bio_t *bio)</div><div class="ttdoc">Flush bits. </div><div class="ttdef"><b>Definition:</b> bio.c:164</div></div>
<div class="ttc" id="group___b_i_o_html_ga7af38eead67b1b281700391bed3505e0"><div class="ttname"><a href="group___b_i_o.html#ga7af38eead67b1b281700391bed3505e0">bio_destroy</a></div><div class="ttdeci">void bio_destroy(opj_bio_t *bio)</div><div class="ttdoc">Destroy a previously created BIO handle. </div><div class="ttdef"><b>Definition:</b> bio.c:122</div></div>
<div class="ttc" id="group___b_i_o_html_gab660df41991f938ddcc1b4687ab07697"><div class="ttname"><a href="group___b_i_o.html#gab660df41991f938ddcc1b4687ab07697">bio_init_dec</a></div><div class="ttdeci">void bio_init_dec(opj_bio_t *bio, unsigned char *bp, int len)</div><div class="ttdoc">Init decoder. </div><div class="ttdef"><b>Definition:</b> bio.c:140</div></div>
<div class="ttc" id="structopj__bio_html"><div class="ttname"><a href="structopj__bio.html">opj_bio</a></div><div class="ttdoc">Individual bit input-output stream (BIO) </div><div class="ttdef"><b>Definition:</b> bio.h:47</div></div>
<div class="ttc" id="group___b_i_o_html_ga4facf6693c470dc139a8ca138f961310"><div class="ttname"><a href="group___b_i_o.html#ga4facf6693c470dc139a8ca138f961310">bio_numbytes</a></div><div class="ttdeci">int bio_numbytes(opj_bio_t *bio)</div><div class="ttdoc">Number of bytes written. </div><div class="ttdef"><b>Definition:</b> bio.c:128</div></div>
<div class="ttc" id="group___b_i_o_html_gac65cc716fac75e743f2e9980c8a05807"><div class="ttname"><a href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a></div><div class="ttdeci">struct opj_bio opj_bio_t</div><div class="ttdoc">Individual bit input-output stream (BIO) </div></div>
<div class="ttc" id="structopj__bio_html_a3e4cb185e2ff512e3d4c341a0fa9b839"><div class="ttname"><a href="structopj__bio.html#a3e4cb185e2ff512e3d4c341a0fa9b839">opj_bio::buf</a></div><div class="ttdeci">unsigned int buf</div><div class="ttdoc">temporary place where each byte is read or written </div><div class="ttdef"><b>Definition:</b> bio.h:55</div></div>
<div class="ttc" id="group___b_i_o_html_ga1e246d84c6cbc14881672a613c91dff7"><div class="ttname"><a href="group___b_i_o.html#ga1e246d84c6cbc14881672a613c91dff7">bio_inalign</a></div><div class="ttdeci">int bio_inalign(opj_bio_t *bio)</div><div class="ttdoc">Passes the ending bits (coming from flushing) </div><div class="ttdef"><b>Definition:</b> bio.c:178</div></div>
<div class="ttc" id="structopj__bio_html_ad009bf26f6ed6f767dfe739b4dfb3606"><div class="ttname"><a href="structopj__bio.html#ad009bf26f6ed6f767dfe739b4dfb3606">opj_bio::end</a></div><div class="ttdeci">unsigned char * end</div><div class="ttdoc">pointer to the end of the buffer </div><div class="ttdef"><b>Definition:</b> bio.h:51</div></div>
<div class="ttc" id="structopj__bio_html_ae4bb6b38d6176a4881c23525fc4db3ae"><div class="ttname"><a href="structopj__bio.html#ae4bb6b38d6176a4881c23525fc4db3ae">opj_bio::bp</a></div><div class="ttdeci">unsigned char * bp</div><div class="ttdoc">pointer to the present position in the buffer </div><div class="ttdef"><b>Definition:</b> bio.h:53</div></div>
<div class="ttc" id="group___b_i_o_html_gafa5537fe6cf2418fd2f31fcc812baa2b"><div class="ttname"><a href="group___b_i_o.html#gafa5537fe6cf2418fd2f31fcc812baa2b">bio_create</a></div><div class="ttdeci">opj_bio_t * bio_create(void)</div><div class="ttdoc">Create a new BIO handle. </div><div class="ttdef"><b>Definition:</b> bio.c:117</div></div>
<div class="ttc" id="group___b_i_o_html_ga0ef1ef3fb0d962f0b181c4306efdc50d"><div class="ttname"><a href="group___b_i_o.html#ga0ef1ef3fb0d962f0b181c4306efdc50d">bio_write</a></div><div class="ttdeci">void bio_write(opj_bio_t *bio, int v, int n)</div><div class="ttdoc">Write bits. </div><div class="ttdef"><b>Definition:</b> bio.c:148</div></div>
<div class="ttc" id="structopj__bio_html_a1b7b5746ec3daf85670fcc2d89a88d65"><div class="ttname"><a href="structopj__bio.html#a1b7b5746ec3daf85670fcc2d89a88d65">opj_bio::ct</a></div><div class="ttdeci">int ct</div><div class="ttdoc">coder : number of bits free to write. </div><div class="ttdef"><b>Definition:</b> bio.h:57</div></div>
<div class="ttc" id="group___b_i_o_html_gaae0ce26f1ac1e141eec1d5f54eae9b93"><div class="ttname"><a href="group___b_i_o.html#gaae0ce26f1ac1e141eec1d5f54eae9b93">bio_init_enc</a></div><div class="ttdeci">void bio_init_enc(opj_bio_t *bio, unsigned char *bp, int len)</div><div class="ttdoc">Init encoder. </div><div class="ttdef"><b>Definition:</b> bio.c:132</div></div>
</div><!-- fragment --></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>