openjpeg/doxygen/group___b_i_o.html

606 lines
35 KiB
HTML
Raw Normal View History

2015-07-10 18:06:19 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
2020-12-28 22:12:25 +01:00
<meta name="generator" content="Doxygen 1.8.11"/>
2015-07-10 18:06:19 +02:00
<title>OpenJPEG: BIO - Individual bit input-output stream</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;">
2016-09-29 22:38:29 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
2015-07-10 18:06:19 +02:00
<div id="projectname">OpenJPEG
2020-12-28 22:12:25 +01:00
&#160;<span id="projectnumber">2.4.0</span>
2015-07-10 18:06:19 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2020-12-28 22:12:25 +01:00
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2015-07-10 18:06:19 +02:00
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">BIO - Individual bit input-output stream</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<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>
<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>
<tr class="separator:gac65cc716fac75e743f2e9980c8a05807"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Local static functions</h2></td></tr>
2016-09-29 22:38:29 +02:00
<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>
<tr class="memdesc:ga4cff07dd767044b26fbbd3030680df36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a bit. <a href="#ga4cff07dd767044b26fbbd3030680df36">More...</a><br /></td></tr>
<tr class="separator:ga4cff07dd767044b26fbbd3030680df36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ga7aa126e3f12e3b56d83a0b19dce2370b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a bit. <a href="#ga7aa126e3f12e3b56d83a0b19dce2370b">More...</a><br /></td></tr>
<tr class="separator:ga7aa126e3f12e3b56d83a0b19dce2370b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ga9b06f926913047b80974f8f3c64be378"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a byte. <a href="#ga9b06f926913047b80974f8f3c64be378">More...</a><br /></td></tr>
<tr class="separator:ga9b06f926913047b80974f8f3c64be378"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ga1632241f1dd35ee1c895c89abf5f0fd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a byte. <a href="#ga1632241f1dd35ee1c895c89abf5f0fd0">More...</a><br /></td></tr>
<tr class="separator:ga1632241f1dd35ee1c895c89abf5f0fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-07-10 18:06:19 +02:00
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Exported functions</h2></td></tr>
<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>
<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>
<tr class="separator:ga00f1d2645b33a7281e2b2dbc20079957"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ga71dd985d85ece15f4b6c2ea92fae5239"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:gab895be8f05401452c080e42427408c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes written. <a href="#gab895be8f05401452c080e42427408c5c">More...</a><br /></td></tr>
<tr class="separator:gab895be8f05401452c080e42427408c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ga549d1ff56aa2c8bea27c031c8a33936f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init encoder. <a href="#ga549d1ff56aa2c8bea27c031c8a33936f">More...</a><br /></td></tr>
<tr class="separator:ga549d1ff56aa2c8bea27c031c8a33936f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ga8ab62fc21c5f26a774fb0e3590efeb4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init decoder. <a href="#ga8ab62fc21c5f26a774fb0e3590efeb4b">More...</a><br /></td></tr>
<tr class="separator:ga8ab62fc21c5f26a774fb0e3590efeb4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ga602b9d9f911b41d41d1d4cab1dc3ec97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write bits. <a href="#ga602b9d9f911b41d41d1d4cab1dc3ec97">More...</a><br /></td></tr>
<tr class="separator:ga602b9d9f911b41d41d1d4cab1dc3ec97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:gaea3bf04128de5bc78da6d06354eae62c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read bits. <a href="#gaea3bf04128de5bc78da6d06354eae62c">More...</a><br /></td></tr>
<tr class="separator:gaea3bf04128de5bc78da6d06354eae62c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:gac2e60a814729cbeb98d8ee747245320c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush bits. <a href="#gac2e60a814729cbeb98d8ee747245320c">More...</a><br /></td></tr>
<tr class="separator:gac2e60a814729cbeb98d8ee747245320c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ga830ee6789a9be0ae5f9a8ff056b771fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="gac65cc716fac75e743f2e9980c8a05807"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
<p>Individual bit input-output stream (BIO) </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga1632241f1dd35ee1c895c89abf5f0fd0"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2016-09-29 22:38:29 +02:00
<td class="memname">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_bytein </td>
2015-07-10 18:06:19 +02:00
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a byte. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga9b06f926913047b80974f8f3c64be378"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2016-09-29 22:38:29 +02:00
<td class="memname">static <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_byteout </td>
2015-07-10 18:06:19 +02:00
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a byte. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga00f1d2645b33a7281e2b2dbc20079957"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a>* opj_bio_create </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new BIO handle. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a new BIO handle if successful, returns NULL otherwise </dd></dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc()</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>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>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga71dd985d85ece15f4b6c2ea92fae5239"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_bio_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a previously created BIO handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle to destroy </td></tr>
</table>
</dd>
</dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>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>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="gac2e60a814729cbeb98d8ee747245320c"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga7aa126e3f12e3b56d83a0b19dce2370b"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2016-09-29 22:38:29 +02:00
<td class="memname">static <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio_getbit </td>
2015-07-10 18:06:19 +02:00
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the read bit </dd></dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="group___b_i_o.html#gaea3bf04128de5bc78da6d06354eae62c">opj_bio_read()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga830ee6789a9be0ae5f9a8ff056b771fe"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_bio_inalign </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Passes the ending bits (coming from flushing) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns OPJ_TRUE if successful, returns OPJ_FALSE otherwise </dd></dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga8ab62fc21c5f26a774fb0e3590efeb4b"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_bio_init_dec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
<td class="paramname"><em>bp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Init decoder. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
<tr><td class="paramname">bp</td><td>Input buffer </td></tr>
<tr><td class="paramname">len</td><td>Input buffer length </td></tr>
</table>
</dd>
</dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="group___t2.html#gafd30efdfea1361431cf3c8ad04d48458">opj_t2_read_packet_header()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga549d1ff56aa2c8bea27c031c8a33936f"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_bio_init_enc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
<td class="paramname"><em>bp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Init encoder. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
<tr><td class="paramname">bp</td><td>Output buffer </td></tr>
<tr><td class="paramname">len</td><td>Output buffer length </td></tr>
</table>
</dd>
</dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="group___t2.html#gaf46b03251519f1cba8bb01da5abc2169">opj_t2_encode_packet()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="gab895be8f05401452c080e42427408c5c"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ptrdiff_t opj_bio_numbytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bytes written. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of bytes written </dd></dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>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>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga4cff07dd767044b26fbbd3030680df36"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2016-09-29 22:38:29 +02:00
<td class="memname">static void opj_bio_putbit </td>
2015-07-10 18:06:19 +02:00
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
<tr><td class="paramname">b</td><td>Bit to write (0 or 1) </td></tr>
</table>
</dd>
</dl>
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>Referenced by <a class="el" href="group___b_i_o.html#ga602b9d9f911b41d41d1d4cab1dc3ec97">opj_bio_write()</a>.</p>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="gaea3bf04128de5bc78da6d06354eae62c"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>n</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
<tr><td class="paramname">n</td><td>Number of bits to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the corresponding read number </dd></dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<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>
2015-07-10 18:06:19 +02:00
</div>
</div>
2020-12-28 22:12:25 +01:00
<a class="anchor" id="ga602b9d9f911b41d41d1d4cab1dc3ec97"></a>
2015-07-10 18:06:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void opj_bio_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___b_i_o.html#gac65cc716fac75e743f2e9980c8a05807">opj_bio_t</a> *&#160;</td>
<td class="paramname"><em>bio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>n</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bio</td><td>BIO handle </td></tr>
<tr><td class="paramname">v</td><td>Value of bits </td></tr>
<tr><td class="paramname">n</td><td>Number of bits to write </td></tr>
</table>
</dd>
</dl>
2020-12-28 22:12:25 +01:00
<p>References <a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
2015-07-10 18:06:19 +02:00
2020-12-28 22:12:25 +01:00
<p>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>
2015-07-10 18:06:19 +02:00
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
2020-12-28 22:12:25 +01:00
</a> 1.8.11
2015-07-10 18:06:19 +02:00
</small></address>
</body>
</html>