Update doxygen for release 2.3.1
[openjpeg.git] / doxygen / group___b_i_o.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: BIO - Individual bit input-output stream</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.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#nested-classes">Data Structures</a> &#124;
43 <a href="#typedef-members">Typedefs</a>  </div>
44   <div class="headertitle">
45 <div class="title">BIO - Individual bit input-output stream</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48 <table class="memberdecls">
49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
50 Data Structures</h2></td></tr>
51 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html">opj_bio</a></td></tr>
52 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Individual bit input-output stream (BIO)  <a href="structopj__bio.html#details">More...</a><br /></td></tr>
53 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
54 </table><table class="memberdecls">
55 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
56 Typedefs</h2></td></tr>
57 <tr class="memitem:gac65cc716fac75e743f2e9980c8a05807"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__bio.html">opj_bio</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a></td></tr>
58 <tr class="memdesc:gac65cc716fac75e743f2e9980c8a05807"><td class="mdescLeft">&#160;</td><td class="mdescRight">Individual bit input-output stream (BIO)  <a href="#gac65cc716fac75e743f2e9980c8a05807">More...</a><br /></td></tr>
59 <tr class="separator:gac65cc716fac75e743f2e9980c8a05807"><td class="memSeparator" colspan="2">&#160;</td></tr>
60 </table><table class="memberdecls">
61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
62 Local static functions</h2></td></tr>
63 <tr class="memitem:ga4cff07dd767044b26fbbd3030680df36"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> b)</td></tr>
64 <tr class="memdesc:ga4cff07dd767044b26fbbd3030680df36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a bit.  <a href="#ga4cff07dd767044b26fbbd3030680df36">More...</a><br /></td></tr>
65 <tr class="separator:ga4cff07dd767044b26fbbd3030680df36"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <tr class="memitem:ga7aa126e3f12e3b56d83a0b19dce2370b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
67 <tr class="memdesc:ga7aa126e3f12e3b56d83a0b19dce2370b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a bit.  <a href="#ga7aa126e3f12e3b56d83a0b19dce2370b">More...</a><br /></td></tr>
68 <tr class="separator:ga7aa126e3f12e3b56d83a0b19dce2370b"><td class="memSeparator" colspan="2">&#160;</td></tr>
69 <tr class="memitem:ga9b06f926913047b80974f8f3c64be378"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
70 <tr class="memdesc:ga9b06f926913047b80974f8f3c64be378"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a byte.  <a href="#ga9b06f926913047b80974f8f3c64be378">More...</a><br /></td></tr>
71 <tr class="separator:ga9b06f926913047b80974f8f3c64be378"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 <tr class="memitem:ga1632241f1dd35ee1c895c89abf5f0fd0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
73 <tr class="memdesc:ga1632241f1dd35ee1c895c89abf5f0fd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a byte.  <a href="#ga1632241f1dd35ee1c895c89abf5f0fd0">More...</a><br /></td></tr>
74 <tr class="separator:ga1632241f1dd35ee1c895c89abf5f0fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
75 </table><table class="memberdecls">
76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
77 Exported functions</h2></td></tr>
78 <tr class="memitem:ga00f1d2645b33a7281e2b2dbc20079957"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga00f1d2645b33a7281e2b2dbc20079957">opj_bio_create</a> (void)</td></tr>
79 <tr class="memdesc:ga00f1d2645b33a7281e2b2dbc20079957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new BIO handle.  <a href="#ga00f1d2645b33a7281e2b2dbc20079957">More...</a><br /></td></tr>
80 <tr class="separator:ga00f1d2645b33a7281e2b2dbc20079957"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 <tr class="memitem:ga71dd985d85ece15f4b6c2ea92fae5239"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga71dd985d85ece15f4b6c2ea92fae5239">opj_bio_destroy</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
82 <tr class="memdesc:ga71dd985d85ece15f4b6c2ea92fae5239"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a previously created BIO handle.  <a href="#ga71dd985d85ece15f4b6c2ea92fae5239">More...</a><br /></td></tr>
83 <tr class="separator:ga71dd985d85ece15f4b6c2ea92fae5239"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:gab895be8f05401452c080e42427408c5c"><td class="memItemLeft" align="right" valign="top">ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#gab895be8f05401452c080e42427408c5c">opj_bio_numbytes</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
85 <tr class="memdesc:gab895be8f05401452c080e42427408c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes written.  <a href="#gab895be8f05401452c080e42427408c5c">More...</a><br /></td></tr>
86 <tr class="separator:gab895be8f05401452c080e42427408c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:ga549d1ff56aa2c8bea27c031c8a33936f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <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>
88 <tr class="memdesc:ga549d1ff56aa2c8bea27c031c8a33936f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init encoder.  <a href="#ga549d1ff56aa2c8bea27c031c8a33936f">More...</a><br /></td></tr>
89 <tr class="separator:ga549d1ff56aa2c8bea27c031c8a33936f"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:ga8ab62fc21c5f26a774fb0e3590efeb4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <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>
91 <tr class="memdesc:ga8ab62fc21c5f26a774fb0e3590efeb4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init decoder.  <a href="#ga8ab62fc21c5f26a774fb0e3590efeb4b">More...</a><br /></td></tr>
92 <tr class="separator:ga8ab62fc21c5f26a774fb0e3590efeb4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:ga602b9d9f911b41d41d1d4cab1dc3ec97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga602b9d9f911b41d41d1d4cab1dc3ec97">opj_bio_write</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> v, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> n)</td></tr>
94 <tr class="memdesc:ga602b9d9f911b41d41d1d4cab1dc3ec97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write bits.  <a href="#ga602b9d9f911b41d41d1d4cab1dc3ec97">More...</a><br /></td></tr>
95 <tr class="separator:ga602b9d9f911b41d41d1d4cab1dc3ec97"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:gaea3bf04128de5bc78da6d06354eae62c"><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___b_i_o.html#gaea3bf04128de5bc78da6d06354eae62c">opj_bio_read</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> n)</td></tr>
97 <tr class="memdesc:gaea3bf04128de5bc78da6d06354eae62c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read bits.  <a href="#gaea3bf04128de5bc78da6d06354eae62c">More...</a><br /></td></tr>
98 <tr class="separator:gaea3bf04128de5bc78da6d06354eae62c"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:gac2e60a814729cbeb98d8ee747245320c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#gac2e60a814729cbeb98d8ee747245320c">opj_bio_flush</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
100 <tr class="memdesc:gac2e60a814729cbeb98d8ee747245320c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush bits.  <a href="#gac2e60a814729cbeb98d8ee747245320c">More...</a><br /></td></tr>
101 <tr class="separator:gac2e60a814729cbeb98d8ee747245320c"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:ga830ee6789a9be0ae5f9a8ff056b771fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_i_o.html#ga830ee6789a9be0ae5f9a8ff056b771fe">opj_bio_inalign</a> (<a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *bio)</td></tr>
103 <tr class="memdesc:ga830ee6789a9be0ae5f9a8ff056b771fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes the ending bits (coming from flushing)  <a href="#ga830ee6789a9be0ae5f9a8ff056b771fe">More...</a><br /></td></tr>
104 <tr class="separator:ga830ee6789a9be0ae5f9a8ff056b771fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 </table>
106 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
107 <h2 class="groupheader">Typedef Documentation</h2>
108 <a id="gac65cc716fac75e743f2e9980c8a05807"></a>
109 <h2 class="memtitle"><span class="permalink"><a href="#gac65cc716fac75e743f2e9980c8a05807">&#9670;&nbsp;</a></span>opj_bio_t</h2>
110
111 <div class="memitem">
112 <div class="memproto">
113       <table class="memname">
114         <tr>
115           <td class="memname">typedef struct <a class="el" href="structopj__bio.html">opj_bio</a>  <a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a></td>
116         </tr>
117       </table>
118 </div><div class="memdoc">
119
120 <p>Individual bit input-output stream (BIO) </p>
121
122 </div>
123 </div>
124 <h2 class="groupheader">Function Documentation</h2>
125 <a id="ga1632241f1dd35ee1c895c89abf5f0fd0"></a>
126 <h2 class="memtitle"><span class="permalink"><a href="#ga1632241f1dd35ee1c895c89abf5f0fd0">&#9670;&nbsp;</a></span>opj_bio_bytein()</h2>
127
128 <div class="memitem">
129 <div class="memproto">
130 <table class="mlabels">
131   <tr>
132   <td class="mlabels-left">
133       <table class="memname">
134         <tr>
135           <td class="memname">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_bytein </td>
136           <td>(</td>
137           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
138           <td class="paramname"><em>bio</em></td><td>)</td>
139           <td></td>
140         </tr>
141       </table>
142   </td>
143   <td class="mlabels-right">
144 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
145   </tr>
146 </table>
147 </div><div class="memdoc">
148
149 <p>Read a byte. </p>
150 <dl class="params"><dt>Parameters</dt><dd>
151   <table class="params">
152     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
153   </table>
154   </dd>
155 </dl>
156 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
157
158 <p class="reference">References <a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">opj_bio::bp</a>, <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, <a class="el" href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">opj_bio::end</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
159
160 <p class="reference">Referenced by <a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>, and <a class="el" href="group___b_i_o.html#ga830ee6789a9be0ae5f9a8ff056b771fe">opj_bio_inalign()</a>.</p>
161
162 </div>
163 </div>
164 <a id="ga9b06f926913047b80974f8f3c64be378"></a>
165 <h2 class="memtitle"><span class="permalink"><a href="#ga9b06f926913047b80974f8f3c64be378">&#9670;&nbsp;</a></span>opj_bio_byteout()</h2>
166
167 <div class="memitem">
168 <div class="memproto">
169 <table class="mlabels">
170   <tr>
171   <td class="mlabels-left">
172       <table class="memname">
173         <tr>
174           <td class="memname">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_byteout </td>
175           <td>(</td>
176           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
177           <td class="paramname"><em>bio</em></td><td>)</td>
178           <td></td>
179         </tr>
180       </table>
181   </td>
182   <td class="mlabels-right">
183 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
184   </tr>
185 </table>
186 </div><div class="memdoc">
187
188 <p>Write a byte. </p>
189 <dl class="params"><dt>Parameters</dt><dd>
190   <table class="params">
191     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
192   </table>
193   </dd>
194 </dl>
195 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
196
197 <p class="reference">References <a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">opj_bio::bp</a>, <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, <a class="el" href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">opj_bio::end</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
198
199 <p class="reference">Referenced by <a class="el" href="group___b_i_o.html#gac2e60a814729cbeb98d8ee747245320c">opj_bio_flush()</a>, and <a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
200
201 </div>
202 </div>
203 <a id="ga00f1d2645b33a7281e2b2dbc20079957"></a>
204 <h2 class="memtitle"><span class="permalink"><a href="#ga00f1d2645b33a7281e2b2dbc20079957">&#9670;&nbsp;</a></span>opj_bio_create()</h2>
205
206 <div class="memitem">
207 <div class="memproto">
208       <table class="memname">
209         <tr>
210           <td class="memname"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a>* opj_bio_create </td>
211           <td>(</td>
212           <td class="paramtype">void&#160;</td>
213           <td class="paramname"></td><td>)</td>
214           <td></td>
215         </tr>
216       </table>
217 </div><div class="memdoc">
218
219 <p>Create a new BIO handle. </p>
220 <dl class="section return"><dt>Returns</dt><dd>Returns a new BIO handle if successful, returns NULL otherwise </dd></dl>
221
222 <p class="reference">References <a class="el" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc()</a>.</p>
223
224 <p class="reference">Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>, and <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
225
226 </div>
227 </div>
228 <a id="ga71dd985d85ece15f4b6c2ea92fae5239"></a>
229 <h2 class="memtitle"><span class="permalink"><a href="#ga71dd985d85ece15f4b6c2ea92fae5239">&#9670;&nbsp;</a></span>opj_bio_destroy()</h2>
230
231 <div class="memitem">
232 <div class="memproto">
233       <table class="memname">
234         <tr>
235           <td class="memname">void opj_bio_destroy </td>
236           <td>(</td>
237           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
238           <td class="paramname"><em>bio</em></td><td>)</td>
239           <td></td>
240         </tr>
241       </table>
242 </div><div class="memdoc">
243
244 <p>Destroy a previously created BIO handle. </p>
245 <dl class="params"><dt>Parameters</dt><dd>
246   <table class="params">
247     <tr><td class="paramname">bio</td><td>BIO handle to destroy </td></tr>
248   </table>
249   </dd>
250 </dl>
251
252 <p class="reference">References <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>.</p>
253
254 <p class="reference">Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>, and <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
255
256 </div>
257 </div>
258 <a id="gac2e60a814729cbeb98d8ee747245320c"></a>
259 <h2 class="memtitle"><span class="permalink"><a href="#gac2e60a814729cbeb98d8ee747245320c">&#9670;&nbsp;</a></span>opj_bio_flush()</h2>
260
261 <div class="memitem">
262 <div class="memproto">
263       <table class="memname">
264         <tr>
265           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_flush </td>
266           <td>(</td>
267           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
268           <td class="paramname"><em>bio</em></td><td>)</td>
269           <td></td>
270         </tr>
271       </table>
272 </div><div class="memdoc">
273
274 <p>Flush bits. </p>
275 <dl class="params"><dt>Parameters</dt><dd>
276   <table class="params">
277     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
278   </table>
279   </dd>
280 </dl>
281 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
282
283 <p class="reference">References <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, <a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
284
285 <p class="reference">Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>.</p>
286
287 </div>
288 </div>
289 <a id="ga7aa126e3f12e3b56d83a0b19dce2370b"></a>
290 <h2 class="memtitle"><span class="permalink"><a href="#ga7aa126e3f12e3b56d83a0b19dce2370b">&#9670;&nbsp;</a></span>opj_bio_getbit()</h2>
291
292 <div class="memitem">
293 <div class="memproto">
294 <table class="mlabels">
295   <tr>
296   <td class="mlabels-left">
297       <table class="memname">
298         <tr>
299           <td class="memname">static <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio_getbit </td>
300           <td>(</td>
301           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
302           <td class="paramname"><em>bio</em></td><td>)</td>
303           <td></td>
304         </tr>
305       </table>
306   </td>
307   <td class="mlabels-right">
308 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
309   </tr>
310 </table>
311 </div><div class="memdoc">
312
313 <p>Read a bit. </p>
314 <dl class="params"><dt>Parameters</dt><dd>
315   <table class="params">
316     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
317   </table>
318   </dd>
319 </dl>
320 <dl class="section return"><dt>Returns</dt><dd>Returns the read bit </dd></dl>
321
322 <p class="reference">References <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, and <a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>.</p>
323
324 <p class="reference">Referenced by <a class="el" href="group___b_i_o.html#gaea3bf04128de5bc78da6d06354eae62c">opj_bio_read()</a>.</p>
325
326 </div>
327 </div>
328 <a id="ga830ee6789a9be0ae5f9a8ff056b771fe"></a>
329 <h2 class="memtitle"><span class="permalink"><a href="#ga830ee6789a9be0ae5f9a8ff056b771fe">&#9670;&nbsp;</a></span>opj_bio_inalign()</h2>
330
331 <div class="memitem">
332 <div class="memproto">
333       <table class="memname">
334         <tr>
335           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_inalign </td>
336           <td>(</td>
337           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
338           <td class="paramname"><em>bio</em></td><td>)</td>
339           <td></td>
340         </tr>
341       </table>
342 </div><div class="memdoc">
343
344 <p>Passes the ending bits (coming from flushing) </p>
345 <dl class="params"><dt>Parameters</dt><dd>
346   <table class="params">
347     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
348   </table>
349   </dd>
350 </dl>
351 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
352
353 <p class="reference">References <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, <a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
354
355 <p class="reference">Referenced by <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
356
357 </div>
358 </div>
359 <a id="ga8ab62fc21c5f26a774fb0e3590efeb4b"></a>
360 <h2 class="memtitle"><span class="permalink"><a href="#ga8ab62fc21c5f26a774fb0e3590efeb4b">&#9670;&nbsp;</a></span>opj_bio_init_dec()</h2>
361
362 <div class="memitem">
363 <div class="memproto">
364       <table class="memname">
365         <tr>
366           <td class="memname">void opj_bio_init_dec </td>
367           <td>(</td>
368           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
369           <td class="paramname"><em>bio</em>, </td>
370         </tr>
371         <tr>
372           <td class="paramkey"></td>
373           <td></td>
374           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
375           <td class="paramname"><em>bp</em>, </td>
376         </tr>
377         <tr>
378           <td class="paramkey"></td>
379           <td></td>
380           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
381           <td class="paramname"><em>len</em>&#160;</td>
382         </tr>
383         <tr>
384           <td></td>
385           <td>)</td>
386           <td></td><td></td>
387         </tr>
388       </table>
389 </div><div class="memdoc">
390
391 <p>Init decoder. </p>
392 <dl class="params"><dt>Parameters</dt><dd>
393   <table class="params">
394     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
395     <tr><td class="paramname">bp</td><td>Input buffer </td></tr>
396     <tr><td class="paramname">len</td><td>Input buffer length </td></tr>
397   </table>
398   </dd>
399 </dl>
400
401 <p class="reference">References <a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">opj_bio::bp</a>, <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, <a class="el" href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">opj_bio::end</a>, and <a class="el" href="structopj__bio.html#a5b7b5826e12247721d21b8b118beaf38">opj_bio::start</a>.</p>
402
403 <p class="reference">Referenced by <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
404
405 </div>
406 </div>
407 <a id="ga549d1ff56aa2c8bea27c031c8a33936f"></a>
408 <h2 class="memtitle"><span class="permalink"><a href="#ga549d1ff56aa2c8bea27c031c8a33936f">&#9670;&nbsp;</a></span>opj_bio_init_enc()</h2>
409
410 <div class="memitem">
411 <div class="memproto">
412       <table class="memname">
413         <tr>
414           <td class="memname">void opj_bio_init_enc </td>
415           <td>(</td>
416           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
417           <td class="paramname"><em>bio</em>, </td>
418         </tr>
419         <tr>
420           <td class="paramkey"></td>
421           <td></td>
422           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
423           <td class="paramname"><em>bp</em>, </td>
424         </tr>
425         <tr>
426           <td class="paramkey"></td>
427           <td></td>
428           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
429           <td class="paramname"><em>len</em>&#160;</td>
430         </tr>
431         <tr>
432           <td></td>
433           <td>)</td>
434           <td></td><td></td>
435         </tr>
436       </table>
437 </div><div class="memdoc">
438
439 <p>Init encoder. </p>
440 <dl class="params"><dt>Parameters</dt><dd>
441   <table class="params">
442     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
443     <tr><td class="paramname">bp</td><td>Output buffer </td></tr>
444     <tr><td class="paramname">len</td><td>Output buffer length </td></tr>
445   </table>
446   </dd>
447 </dl>
448
449 <p class="reference">References <a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">opj_bio::bp</a>, <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, <a class="el" href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">opj_bio::end</a>, and <a class="el" href="structopj__bio.html#a5b7b5826e12247721d21b8b118beaf38">opj_bio::start</a>.</p>
450
451 <p class="reference">Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>.</p>
452
453 </div>
454 </div>
455 <a id="gab895be8f05401452c080e42427408c5c"></a>
456 <h2 class="memtitle"><span class="permalink"><a href="#gab895be8f05401452c080e42427408c5c">&#9670;&nbsp;</a></span>opj_bio_numbytes()</h2>
457
458 <div class="memitem">
459 <div class="memproto">
460       <table class="memname">
461         <tr>
462           <td class="memname">ptrdiff_t opj_bio_numbytes </td>
463           <td>(</td>
464           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
465           <td class="paramname"><em>bio</em></td><td>)</td>
466           <td></td>
467         </tr>
468       </table>
469 </div><div class="memdoc">
470
471 <p>Number of bytes written. </p>
472 <dl class="params"><dt>Parameters</dt><dd>
473   <table class="params">
474     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
475   </table>
476   </dd>
477 </dl>
478 <dl class="section return"><dt>Returns</dt><dd>Returns the number of bytes written </dd></dl>
479
480 <p class="reference">References <a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">opj_bio::bp</a>, and <a class="el" href="structopj__bio.html#a5b7b5826e12247721d21b8b118beaf38">opj_bio::start</a>.</p>
481
482 <p class="reference">Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>, and <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
483
484 </div>
485 </div>
486 <a id="ga4cff07dd767044b26fbbd3030680df36"></a>
487 <h2 class="memtitle"><span class="permalink"><a href="#ga4cff07dd767044b26fbbd3030680df36">&#9670;&nbsp;</a></span>opj_bio_putbit()</h2>
488
489 <div class="memitem">
490 <div class="memproto">
491 <table class="mlabels">
492   <tr>
493   <td class="mlabels-left">
494       <table class="memname">
495         <tr>
496           <td class="memname">static void opj_bio_putbit </td>
497           <td>(</td>
498           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
499           <td class="paramname"><em>bio</em>, </td>
500         </tr>
501         <tr>
502           <td class="paramkey"></td>
503           <td></td>
504           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
505           <td class="paramname"><em>b</em>&#160;</td>
506         </tr>
507         <tr>
508           <td></td>
509           <td>)</td>
510           <td></td><td></td>
511         </tr>
512       </table>
513   </td>
514   <td class="mlabels-right">
515 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
516   </tr>
517 </table>
518 </div><div class="memdoc">
519
520 <p>Write a bit. </p>
521 <dl class="params"><dt>Parameters</dt><dd>
522   <table class="params">
523     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
524     <tr><td class="paramname">b</td><td>Bit to write (0 or 1) </td></tr>
525   </table>
526   </dd>
527 </dl>
528
529 <p class="reference">References <a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">opj_bio::buf</a>, <a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">opj_bio::ct</a>, and <a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>.</p>
530
531 <p class="reference">Referenced by <a class="el" href="group___b_i_o.html#ga602b9d9f911b41d41d1d4cab1dc3ec97">opj_bio_write()</a>.</p>
532
533 </div>
534 </div>
535 <a id="gaea3bf04128de5bc78da6d06354eae62c"></a>
536 <h2 class="memtitle"><span class="permalink"><a href="#gaea3bf04128de5bc78da6d06354eae62c">&#9670;&nbsp;</a></span>opj_bio_read()</h2>
537
538 <div class="memitem">
539 <div class="memproto">
540       <table class="memname">
541         <tr>
542           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio_read </td>
543           <td>(</td>
544           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
545           <td class="paramname"><em>bio</em>, </td>
546         </tr>
547         <tr>
548           <td class="paramkey"></td>
549           <td></td>
550           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
551           <td class="paramname"><em>n</em>&#160;</td>
552         </tr>
553         <tr>
554           <td></td>
555           <td>)</td>
556           <td></td><td></td>
557         </tr>
558       </table>
559 </div><div class="memdoc">
560
561 <p>Read bits. </p>
562 <dl class="params"><dt>Parameters</dt><dd>
563   <table class="params">
564     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
565     <tr><td class="paramname">n</td><td>Number of bits to read </td></tr>
566   </table>
567   </dd>
568 </dl>
569 <dl class="section return"><dt>Returns</dt><dd>Returns the corresponding read number </dd></dl>
570
571 <p class="reference">References <a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>.</p>
572
573 <p class="reference">Referenced by <a class="el" href="group___t2.html#ga5a05d5b618bf6e2113e661c1e4bc56ff">opj_t2_getcommacode()</a>, <a class="el" href="group___t2.html#ga1bf09a22f7af3f4120072d45dd95d84d">opj_t2_getnumpasses()</a>, <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>, and <a class="el" href="group___t_g_t.html#ga5b970bfd9b761cdf2ff36001821b06aa">opj_tgt_decode()</a>.</p>
574
575 </div>
576 </div>
577 <a id="ga602b9d9f911b41d41d1d4cab1dc3ec97"></a>
578 <h2 class="memtitle"><span class="permalink"><a href="#ga602b9d9f911b41d41d1d4cab1dc3ec97">&#9670;&nbsp;</a></span>opj_bio_write()</h2>
579
580 <div class="memitem">
581 <div class="memproto">
582       <table class="memname">
583         <tr>
584           <td class="memname">void opj_bio_write </td>
585           <td>(</td>
586           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
587           <td class="paramname"><em>bio</em>, </td>
588         </tr>
589         <tr>
590           <td class="paramkey"></td>
591           <td></td>
592           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
593           <td class="paramname"><em>v</em>, </td>
594         </tr>
595         <tr>
596           <td class="paramkey"></td>
597           <td></td>
598           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
599           <td class="paramname"><em>n</em>&#160;</td>
600         </tr>
601         <tr>
602           <td></td>
603           <td>)</td>
604           <td></td><td></td>
605         </tr>
606       </table>
607 </div><div class="memdoc">
608
609 <p>Write bits. </p>
610 <dl class="params"><dt>Parameters</dt><dd>
611   <table class="params">
612     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
613     <tr><td class="paramname">v</td><td>Value of bits </td></tr>
614     <tr><td class="paramname">n</td><td>Number of bits to write </td></tr>
615   </table>
616   </dd>
617 </dl>
618
619 <p class="reference">References <a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
620
621 <p class="reference">Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>, <a class="el" href="group___t2.html#ga1951aad7fbb01854f045800994960443">opj_t2_putcommacode()</a>, <a class="el" href="group___t2.html#ga4749f4e156e4bf89913995de5a9bb2d7">opj_t2_putnumpasses()</a>, and <a class="el" href="group___t_g_t.html#gafe36abfc042710c566552ed3adfcb2a9">opj_tgt_encode()</a>.</p>
622
623 </div>
624 </div>
625 </div><!-- contents -->
626 <!-- start footer part -->
627 <hr class="footer"/><address class="footer"><small>
628 Generated by &#160;<a href="http://www.doxygen.org/index.html">
629 <img class="footer" src="doxygen.png" alt="doxygen"/>
630 </a> 1.8.13
631 </small></address>
632 </body>
633 </html>