Create CNAME
[openjpeg.git] / doxygen / structopj__bio.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.17"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_bio Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.5.0</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.17 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 </div><!-- top -->
41 <div class="header">
42   <div class="summary">
43 <a href="#pub-attribs">Data Fields</a>  </div>
44   <div class="headertitle">
45 <div class="title">opj_bio Struct Reference</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>Individual bit input-output stream (BIO)  
50  <a href="structopj__bio.html#details">More...</a></p>
51
52 <p><code>#include &lt;<a class="el" href="bio_8h_source.html">bio.h</a>&gt;</code></p>
53 <table class="memberdecls">
54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
55 Data Fields</h2></td></tr>
56 <tr class="memitem:a5b7b5826e12247721d21b8b118beaf38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#a5b7b5826e12247721d21b8b118beaf38">start</a></td></tr>
57 <tr class="memdesc:a5b7b5826e12247721d21b8b118beaf38"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the start of the buffer  <a href="structopj__bio.html#a5b7b5826e12247721d21b8b118beaf38">More...</a><br /></td></tr>
58 <tr class="separator:a5b7b5826e12247721d21b8b118beaf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
59 <tr class="memitem:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">end</a></td></tr>
60 <tr class="memdesc:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the end of the buffer  <a href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">More...</a><br /></td></tr>
61 <tr class="separator:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:afbbfc81d9624cfd55add60bef5d0fb42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">bp</a></td></tr>
63 <tr class="memdesc:afbbfc81d9624cfd55add60bef5d0fb42"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the present position in the buffer  <a href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">More...</a><br /></td></tr>
64 <tr class="separator:afbbfc81d9624cfd55add60bef5d0fb42"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 <tr class="memitem:a91e6c579ced7a356d042b27cbeba3e03"><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="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">buf</a></td></tr>
66 <tr class="memdesc:a91e6c579ced7a356d042b27cbeba3e03"><td class="mdescLeft">&#160;</td><td class="mdescRight">temporary place where each byte is read or written  <a href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">More...</a><br /></td></tr>
67 <tr class="separator:a91e6c579ced7a356d042b27cbeba3e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a739743b6883a37747cd417edaa18cf88"><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="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">ct</a></td></tr>
69 <tr class="memdesc:a739743b6883a37747cd417edaa18cf88"><td class="mdescLeft">&#160;</td><td class="mdescRight">coder : number of bits free to write.  <a href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">More...</a><br /></td></tr>
70 <tr class="separator:a739743b6883a37747cd417edaa18cf88"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 </table>
72 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
73 <div class="textblock"><p>Individual bit input-output stream (BIO) </p>
74 </div><h2 class="groupheader">Field Documentation</h2>
75 <a id="afbbfc81d9624cfd55add60bef5d0fb42"></a>
76 <h2 class="memtitle"><span class="permalink"><a href="#afbbfc81d9624cfd55add60bef5d0fb42">&#9670;&nbsp;</a></span>bp</h2>
77
78 <div class="memitem">
79 <div class="memproto">
80       <table class="memname">
81         <tr>
82           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::bp</td>
83         </tr>
84       </table>
85 </div><div class="memdoc">
86
87 <p>pointer to the present position in the buffer </p>
88
89 <p class="reference">Referenced by <a class="el" href="bio_8c.html#a1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="bio_8c.html#a9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="bio_8h.html#a8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="bio_8h.html#a549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="bio_8h.html#ab895be8f05401452c080e42427408c5c">opj_bio_numbytes()</a>.</p>
90
91 </div>
92 </div>
93 <a id="a91e6c579ced7a356d042b27cbeba3e03"></a>
94 <h2 class="memtitle"><span class="permalink"><a href="#a91e6c579ced7a356d042b27cbeba3e03">&#9670;&nbsp;</a></span>buf</h2>
95
96 <div class="memitem">
97 <div class="memproto">
98       <table class="memname">
99         <tr>
100           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio::buf</td>
101         </tr>
102       </table>
103 </div><div class="memdoc">
104
105 <p>temporary place where each byte is read or written </p>
106
107 <p class="reference">Referenced by <a class="el" href="bio_8c.html#a1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="bio_8c.html#a9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="bio_8c.html#a7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>, <a class="el" href="bio_8h.html#a830ee6789a9be0ae5f9a8ff056b771fe">opj_bio_inalign()</a>, <a class="el" href="bio_8h.html#a8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="bio_8h.html#a549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="bio_8c.html#a4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
108
109 </div>
110 </div>
111 <a id="a739743b6883a37747cd417edaa18cf88"></a>
112 <h2 class="memtitle"><span class="permalink"><a href="#a739743b6883a37747cd417edaa18cf88">&#9670;&nbsp;</a></span>ct</h2>
113
114 <div class="memitem">
115 <div class="memproto">
116       <table class="memname">
117         <tr>
118           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio::ct</td>
119         </tr>
120       </table>
121 </div><div class="memdoc">
122
123 <p>coder : number of bits free to write. </p>
124 <p>decoder : number of bits read </p>
125
126 <p class="reference">Referenced by <a class="el" href="bio_8c.html#a1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="bio_8c.html#a9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="bio_8h.html#ac2e60a814729cbeb98d8ee747245320c">opj_bio_flush()</a>, <a class="el" href="bio_8c.html#a7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>, <a class="el" href="bio_8h.html#a830ee6789a9be0ae5f9a8ff056b771fe">opj_bio_inalign()</a>, <a class="el" href="bio_8h.html#a8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="bio_8h.html#a549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="bio_8c.html#a4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
127
128 </div>
129 </div>
130 <a id="a82d1b48ca5f22eeb8ab2139982b576ba"></a>
131 <h2 class="memtitle"><span class="permalink"><a href="#a82d1b48ca5f22eeb8ab2139982b576ba">&#9670;&nbsp;</a></span>end</h2>
132
133 <div class="memitem">
134 <div class="memproto">
135       <table class="memname">
136         <tr>
137           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::end</td>
138         </tr>
139       </table>
140 </div><div class="memdoc">
141
142 <p>pointer to the end of the buffer </p>
143
144 <p class="reference">Referenced by <a class="el" href="bio_8c.html#a1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="bio_8c.html#a9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="bio_8h.html#a8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, and <a class="el" href="bio_8h.html#a549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>.</p>
145
146 </div>
147 </div>
148 <a id="a5b7b5826e12247721d21b8b118beaf38"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#a5b7b5826e12247721d21b8b118beaf38">&#9670;&nbsp;</a></span>start</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153       <table class="memname">
154         <tr>
155           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::start</td>
156         </tr>
157       </table>
158 </div><div class="memdoc">
159
160 <p>pointer to the start of the buffer </p>
161
162 <p class="reference">Referenced by <a class="el" href="bio_8h.html#a8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="bio_8h.html#a549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="bio_8h.html#ab895be8f05401452c080e42427408c5c">opj_bio_numbytes()</a>.</p>
163
164 </div>
165 </div>
166 <hr/>The documentation for this struct was generated from the following file:<ul>
167 <li><a class="el" href="bio_8h_source.html">bio.h</a></li>
168 </ul>
169 </div><!-- contents -->
170 <!-- start footer part -->
171 <hr class="footer"/><address class="footer"><small>
172 Generated by &#160;<a href="http://www.doxygen.org/index.html">
173 <img class="footer" src="doxygen.png" alt="doxygen"/>
174 </a> 1.8.17
175 </small></address>
176 </body>
177 </html>