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.10"/>
   7 <title>OpenJPEG: BIO - Individual bit input-output stream</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td id="projectalign" style="padding-left: 0.5em;">
  20    <div id="projectname">OpenJPEG
  21    &#160;<span id="projectnumber">2.2.0</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.10 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34       <li><a href="modules.html"><span>Modules</span></a></li>
  35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  36       <li><a href="files.html"><span>Files</span></a></li>
  37     </ul>
  38   </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 class="anchor" id="gac65cc716fac75e743f2e9980c8a05807"></a>
 109 <div class="memitem">
 110 <div class="memproto">
 111       <table class="memname">
 112         <tr>
 113           <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>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117
 118 <p>Individual bit input-output stream (BIO) </p>
 119
 120 </div>
 121 </div>
 122 <h2 class="groupheader">Function Documentation</h2>
 123 <a class="anchor" id="ga1632241f1dd35ee1c895c89abf5f0fd0"></a>
 124 <div class="memitem">
 125 <div class="memproto">
 126 <table class="mlabels">
 127   <tr>
 128   <td class="mlabels-left">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_bytein </td>
 132           <td>(</td>
 133           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 134           <td class="paramname"><em>bio</em></td><td>)</td>
 135           <td></td>
 136         </tr>
 137       </table>
 138   </td>
 139   <td class="mlabels-right">
 140 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 141   </tr>
 142 </table>
 143 </div><div class="memdoc">
 144
 145 <p>Read a byte. </p>
 146 <dl class="params"><dt>Parameters</dt><dd>
 147   <table class="params">
 148     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 149   </table>
 150   </dd>
 151 </dl>
 152 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
 153
 154 <p>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>
 155
 156 <p>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>
 157
 158 </div>
 159 </div>
 160 <a class="anchor" id="ga9b06f926913047b80974f8f3c64be378"></a>
 161 <div class="memitem">
 162 <div class="memproto">
 163 <table class="mlabels">
 164   <tr>
 165   <td class="mlabels-left">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_byteout </td>
 169           <td>(</td>
 170           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 171           <td class="paramname"><em>bio</em></td><td>)</td>
 172           <td></td>
 173         </tr>
 174       </table>
 175   </td>
 176   <td class="mlabels-right">
 177 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 178   </tr>
 179 </table>
 180 </div><div class="memdoc">
 181
 182 <p>Write a byte. </p>
 183 <dl class="params"><dt>Parameters</dt><dd>
 184   <table class="params">
 185     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 186   </table>
 187   </dd>
 188 </dl>
 189 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
 190
 191 <p>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>
 192
 193 <p>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>
 194
 195 </div>
 196 </div>
 197 <a class="anchor" id="ga00f1d2645b33a7281e2b2dbc20079957"></a>
 198 <div class="memitem">
 199 <div class="memproto">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a>* opj_bio_create </td>
 203           <td>(</td>
 204           <td class="paramtype">void&#160;</td>
 205           <td class="paramname"></td><td>)</td>
 206           <td></td>
 207         </tr>
 208       </table>
 209 </div><div class="memdoc">
 210
 211 <p>Create a new BIO handle. </p>
 212 <dl class="section return"><dt>Returns</dt><dd>Returns a new BIO handle if successful, returns NULL otherwise </dd></dl>
 213
 214 <p>References <a class="el" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc()</a>.</p>
 215
 216 <p>Referenced by <a class="el" href="group___t2.html#ga08a6b4ac26dfd81119b329f02c480f39">opj_t2_encode_packet()</a>, and <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
 217
 218 </div>
 219 </div>
 220 <a class="anchor" id="ga71dd985d85ece15f4b6c2ea92fae5239"></a>
 221 <div class="memitem">
 222 <div class="memproto">
 223       <table class="memname">
 224         <tr>
 225           <td class="memname">void opj_bio_destroy </td>
 226           <td>(</td>
 227           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 228           <td class="paramname"><em>bio</em></td><td>)</td>
 229           <td></td>
 230         </tr>
 231       </table>
 232 </div><div class="memdoc">
 233
 234 <p>Destroy a previously created BIO handle. </p>
 235 <dl class="params"><dt>Parameters</dt><dd>
 236   <table class="params">
 237     <tr><td class="paramname">bio</td><td>BIO handle to destroy </td></tr>
 238   </table>
 239   </dd>
 240 </dl>
 241
 242 <p>References <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>.</p>
 243
 244 <p>Referenced by <a class="el" href="group___t2.html#ga08a6b4ac26dfd81119b329f02c480f39">opj_t2_encode_packet()</a>, and <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
 245
 246 </div>
 247 </div>
 248 <a class="anchor" id="gac2e60a814729cbeb98d8ee747245320c"></a>
 249 <div class="memitem">
 250 <div class="memproto">
 251       <table class="memname">
 252         <tr>
 253           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_flush </td>
 254           <td>(</td>
 255           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 256           <td class="paramname"><em>bio</em></td><td>)</td>
 257           <td></td>
 258         </tr>
 259       </table>
 260 </div><div class="memdoc">
 261
 262 <p>Flush bits. </p>
 263 <dl class="params"><dt>Parameters</dt><dd>
 264   <table class="params">
 265     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 266   </table>
 267   </dd>
 268 </dl>
 269 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
 270
 271 <p>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>
 272
 273 <p>Referenced by <a class="el" href="group___t2.html#ga08a6b4ac26dfd81119b329f02c480f39">opj_t2_encode_packet()</a>.</p>
 274
 275 </div>
 276 </div>
 277 <a class="anchor" id="ga7aa126e3f12e3b56d83a0b19dce2370b"></a>
 278 <div class="memitem">
 279 <div class="memproto">
 280 <table class="mlabels">
 281   <tr>
 282   <td class="mlabels-left">
 283       <table class="memname">
 284         <tr>
 285           <td class="memname">static <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio_getbit </td>
 286           <td>(</td>
 287           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 288           <td class="paramname"><em>bio</em></td><td>)</td>
 289           <td></td>
 290         </tr>
 291       </table>
 292   </td>
 293   <td class="mlabels-right">
 294 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 295   </tr>
 296 </table>
 297 </div><div class="memdoc">
 298
 299 <p>Read a bit. </p>
 300 <dl class="params"><dt>Parameters</dt><dd>
 301   <table class="params">
 302     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 303   </table>
 304   </dd>
 305 </dl>
 306 <dl class="section return"><dt>Returns</dt><dd>Returns the read bit </dd></dl>
 307
 308 <p>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>
 309
 310 <p>Referenced by <a class="el" href="group___b_i_o.html#gaea3bf04128de5bc78da6d06354eae62c">opj_bio_read()</a>.</p>
 311
 312 </div>
 313 </div>
 314 <a class="anchor" id="ga830ee6789a9be0ae5f9a8ff056b771fe"></a>
 315 <div class="memitem">
 316 <div class="memproto">
 317       <table class="memname">
 318         <tr>
 319           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_inalign </td>
 320           <td>(</td>
 321           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 322           <td class="paramname"><em>bio</em></td><td>)</td>
 323           <td></td>
 324         </tr>
 325       </table>
 326 </div><div class="memdoc">
 327
 328 <p>Passes the ending bits (coming from flushing) </p>
 329 <dl class="params"><dt>Parameters</dt><dd>
 330   <table class="params">
 331     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 332   </table>
 333   </dd>
 334 </dl>
 335 <dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
 336
 337 <p>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>
 338
 339 <p>Referenced by <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
 340
 341 </div>
 342 </div>
 343 <a class="anchor" id="ga8ab62fc21c5f26a774fb0e3590efeb4b"></a>
 344 <div class="memitem">
 345 <div class="memproto">
 346       <table class="memname">
 347         <tr>
 348           <td class="memname">void opj_bio_init_dec </td>
 349           <td>(</td>
 350           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 351           <td class="paramname"><em>bio</em>, </td>
 352         </tr>
 353         <tr>
 354           <td class="paramkey"></td>
 355           <td></td>
 356           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
 357           <td class="paramname"><em>bp</em>, </td>
 358         </tr>
 359         <tr>
 360           <td class="paramkey"></td>
 361           <td></td>
 362           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 363           <td class="paramname"><em>len</em>&#160;</td>
 364         </tr>
 365         <tr>
 366           <td></td>
 367           <td>)</td>
 368           <td></td><td></td>
 369         </tr>
 370       </table>
 371 </div><div class="memdoc">
 372
 373 <p>Init decoder. </p>
 374 <dl class="params"><dt>Parameters</dt><dd>
 375   <table class="params">
 376     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 377     <tr><td class="paramname">bp</td><td>Input buffer </td></tr>
 378     <tr><td class="paramname">len</td><td>Input buffer length </td></tr>
 379   </table>
 380   </dd>
 381 </dl>
 382
 383 <p>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>
 384
 385 <p>Referenced by <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
 386
 387 </div>
 388 </div>
 389 <a class="anchor" id="ga549d1ff56aa2c8bea27c031c8a33936f"></a>
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname">void opj_bio_init_enc </td>
 395           <td>(</td>
 396           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 397           <td class="paramname"><em>bio</em>, </td>
 398         </tr>
 399         <tr>
 400           <td class="paramkey"></td>
 401           <td></td>
 402           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
 403           <td class="paramname"><em>bp</em>, </td>
 404         </tr>
 405         <tr>
 406           <td class="paramkey"></td>
 407           <td></td>
 408           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 409           <td class="paramname"><em>len</em>&#160;</td>
 410         </tr>
 411         <tr>
 412           <td></td>
 413           <td>)</td>
 414           <td></td><td></td>
 415         </tr>
 416       </table>
 417 </div><div class="memdoc">
 418
 419 <p>Init encoder. </p>
 420 <dl class="params"><dt>Parameters</dt><dd>
 421   <table class="params">
 422     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 423     <tr><td class="paramname">bp</td><td>Output buffer </td></tr>
 424     <tr><td class="paramname">len</td><td>Output buffer length </td></tr>
 425   </table>
 426   </dd>
 427 </dl>
 428
 429 <p>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>
 430
 431 <p>Referenced by <a class="el" href="group___t2.html#ga08a6b4ac26dfd81119b329f02c480f39">opj_t2_encode_packet()</a>.</p>
 432
 433 </div>
 434 </div>
 435 <a class="anchor" id="gab895be8f05401452c080e42427408c5c"></a>
 436 <div class="memitem">
 437 <div class="memproto">
 438       <table class="memname">
 439         <tr>
 440           <td class="memname">ptrdiff_t opj_bio_numbytes </td>
 441           <td>(</td>
 442           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 443           <td class="paramname"><em>bio</em></td><td>)</td>
 444           <td></td>
 445         </tr>
 446       </table>
 447 </div><div class="memdoc">
 448
 449 <p>Number of bytes written. </p>
 450 <dl class="params"><dt>Parameters</dt><dd>
 451   <table class="params">
 452     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 453   </table>
 454   </dd>
 455 </dl>
 456 <dl class="section return"><dt>Returns</dt><dd>Returns the number of bytes written </dd></dl>
 457
 458 <p>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>
 459
 460 <p>Referenced by <a class="el" href="group___t2.html#ga08a6b4ac26dfd81119b329f02c480f39">opj_t2_encode_packet()</a>, and <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
 461
 462 </div>
 463 </div>
 464 <a class="anchor" id="ga4cff07dd767044b26fbbd3030680df36"></a>
 465 <div class="memitem">
 466 <div class="memproto">
 467 <table class="mlabels">
 468   <tr>
 469   <td class="mlabels-left">
 470       <table class="memname">
 471         <tr>
 472           <td class="memname">static void opj_bio_putbit </td>
 473           <td>(</td>
 474           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 475           <td class="paramname"><em>bio</em>, </td>
 476         </tr>
 477         <tr>
 478           <td class="paramkey"></td>
 479           <td></td>
 480           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 481           <td class="paramname"><em>b</em>&#160;</td>
 482         </tr>
 483         <tr>
 484           <td></td>
 485           <td>)</td>
 486           <td></td><td></td>
 487         </tr>
 488       </table>
 489   </td>
 490   <td class="mlabels-right">
 491 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 492   </tr>
 493 </table>
 494 </div><div class="memdoc">
 495
 496 <p>Write a bit. </p>
 497 <dl class="params"><dt>Parameters</dt><dd>
 498   <table class="params">
 499     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 500     <tr><td class="paramname">b</td><td>Bit to write (0 or 1) </td></tr>
 501   </table>
 502   </dd>
 503 </dl>
 504
 505 <p>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>
 506
 507 <p>Referenced by <a class="el" href="group___b_i_o.html#ga602b9d9f911b41d41d1d4cab1dc3ec97">opj_bio_write()</a>.</p>
 508
 509 </div>
 510 </div>
 511 <a class="anchor" id="gaea3bf04128de5bc78da6d06354eae62c"></a>
 512 <div class="memitem">
 513 <div class="memproto">
 514       <table class="memname">
 515         <tr>
 516           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio_read </td>
 517           <td>(</td>
 518           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 519           <td class="paramname"><em>bio</em>, </td>
 520         </tr>
 521         <tr>
 522           <td class="paramkey"></td>
 523           <td></td>
 524           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 525           <td class="paramname"><em>n</em>&#160;</td>
 526         </tr>
 527         <tr>
 528           <td></td>
 529           <td>)</td>
 530           <td></td><td></td>
 531         </tr>
 532       </table>
 533 </div><div class="memdoc">
 534
 535 <p>Read bits. </p>
 536 <dl class="params"><dt>Parameters</dt><dd>
 537   <table class="params">
 538     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 539     <tr><td class="paramname">n</td><td>Number of bits to read </td></tr>
 540   </table>
 541   </dd>
 542 </dl>
 543 <dl class="section return"><dt>Returns</dt><dd>Returns the corresponding read number </dd></dl>
 544
 545 <p>References <a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>.</p>
 546
 547 <p>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>
 548
 549 </div>
 550 </div>
 551 <a class="anchor" id="ga602b9d9f911b41d41d1d4cab1dc3ec97"></a>
 552 <div class="memitem">
 553 <div class="memproto">
 554       <table class="memname">
 555         <tr>
 556           <td class="memname">void opj_bio_write </td>
 557           <td>(</td>
 558           <td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
 559           <td class="paramname"><em>bio</em>, </td>
 560         </tr>
 561         <tr>
 562           <td class="paramkey"></td>
 563           <td></td>
 564           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 565           <td class="paramname"><em>v</em>, </td>
 566         </tr>
 567         <tr>
 568           <td class="paramkey"></td>
 569           <td></td>
 570           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 571           <td class="paramname"><em>n</em>&#160;</td>
 572         </tr>
 573         <tr>
 574           <td></td>
 575           <td>)</td>
 576           <td></td><td></td>
 577         </tr>
 578       </table>
 579 </div><div class="memdoc">
 580
 581 <p>Write bits. </p>
 582 <dl class="params"><dt>Parameters</dt><dd>
 583   <table class="params">
 584     <tr><td class="paramname">bio</td><td>BIO handle </td></tr>
 585     <tr><td class="paramname">v</td><td>Value of bits </td></tr>
 586     <tr><td class="paramname">n</td><td>Number of bits to write </td></tr>
 587   </table>
 588   </dd>
 589 </dl>
 590
 591 <p>References <a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
 592
 593 <p>Referenced by <a class="el" href="group___t2.html#ga08a6b4ac26dfd81119b329f02c480f39">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>
 594
 595 </div>
 596 </div>
 597 </div><!-- contents -->
 598 <!-- start footer part -->
 599 <hr class="footer"/><address class="footer"><small>
 600 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 601 <img class="footer" src="doxygen.png" alt="doxygen"/>
 602 </a> 1.8.10
 603 </small></address>
 604 </body>
 605 </html>