openjpeg/doxygen/pi_8h.html

125 lines
14 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: pi.h File Reference</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><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
2015-07-10 18:06:19 +02:00
<div id="nav-path" class="navpath">
<ul>
2020-12-28 22:12:25 +01:00
<li class="navelem"><a class="el" href="dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="dir_cb9b2b419d92b64f7cee83d8faf7a4ab.html">even</a></li><li class="navelem"><a class="el" href="dir_f75d9a0165d6564a1e04793ef847d41d.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_5f588d7ea139c1aae751d03c13a16064.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_378f732e812ef6cbaaae22e96a4fa79f.html">src</a></li><li class="navelem"><a class="el" href="dir_19dcb5713315405a27e1bde75a489a4c.html">lib</a></li><li class="navelem"><a class="el" href="dir_54e5bc4f0640fea590afaf04f4d9c88d.html">openjp2</a></li> </ul>
2015-07-10 18:06:19 +02:00
</div>
</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">pi.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of a packet iterator (PI)
<a href="#details">More...</a></p>
<p><a href="pi_8h_source.html">Go to the source code of this file.</a></p>
<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__pi__resolution.html">opj_pi_resolution</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC. <a href="structopj__pi__resolution.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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__pi__comp.html">opj_pi_comp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC. <a href="structopj__pi__comp.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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__pi__iterator.html">opj_pi_iterator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet iterator. <a href="structopj__pi__iterator.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:gaf3ba38306cb812def774ac9852bf11ef"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__pi__resolution.html">opj_pi_resolution</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#gaf3ba38306cb812def774ac9852bf11ef">opj_pi_resolution_t</a></td></tr>
<tr class="memdesc:gaf3ba38306cb812def774ac9852bf11ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC. <a href="group___p_i.html#gaf3ba38306cb812def774ac9852bf11ef">More...</a><br /></td></tr>
<tr class="separator:gaf3ba38306cb812def774ac9852bf11ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5e0e4858311b5d80f5255c3607a55df"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__pi__comp.html">opj_pi_comp</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#gaf5e0e4858311b5d80f5255c3607a55df">opj_pi_comp_t</a></td></tr>
<tr class="memdesc:gaf5e0e4858311b5d80f5255c3607a55df"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC. <a href="group___p_i.html#gaf5e0e4858311b5d80f5255c3607a55df">More...</a><br /></td></tr>
<tr class="separator:gaf5e0e4858311b5d80f5255c3607a55df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36e3009320d25edd589dd5edff649723"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__pi__iterator.html">opj_pi_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a></td></tr>
<tr class="memdesc:ga36e3009320d25edd589dd5edff649723"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packet iterator. <a href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">More...</a><br /></td></tr>
<tr class="separator:ga36e3009320d25edd589dd5edff649723"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Exported functions</div></td></tr>
2020-12-28 22:12:25 +01:00
<tr class="memitem:ga2e76cd9983f766b757fd0cdfae9d6d43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#ga2e76cd9983f766b757fd0cdfae9d6d43">opj_pi_initialise_encode</a> (const <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *image, <a class="el" href="group___j2_k.html#gace226c035f4c2a151cb26bf65cf3353e">opj_cp_t</a> *cp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> tileno, <a class="el" href="group___j2_k.html#gaef98ee083d0fd9e3804ffffbccbe6b97">J2K_T2_MODE</a> t2_mode, <a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *manager)</td></tr>
<tr class="memdesc:ga2e76cd9983f766b757fd0cdfae9d6d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a packet iterator for encoding. <a href="group___p_i.html#ga2e76cd9983f766b757fd0cdfae9d6d43">More...</a><br /></td></tr>
<tr class="separator:ga2e76cd9983f766b757fd0cdfae9d6d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-07-10 18:06:19 +02:00
<tr class="memitem:ga19c951dfab9ba88d65a9b78f32dd3397"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#ga19c951dfab9ba88d65a9b78f32dd3397">opj_pi_update_encoding_parameters</a> (const <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image, <a class="el" href="group___j2_k.html#gace226c035f4c2a151cb26bf65cf3353e">opj_cp_t</a> *p_cp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> p_tile_no)</td></tr>
<tr class="memdesc:ga19c951dfab9ba88d65a9b78f32dd3397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the encoding parameters of the codec. <a href="group___p_i.html#ga19c951dfab9ba88d65a9b78f32dd3397">More...</a><br /></td></tr>
<tr class="separator:ga19c951dfab9ba88d65a9b78f32dd3397"><td class="memSeparator" colspan="2">&#160;</td></tr>
2017-08-10 06:39:58 +02:00
<tr class="memitem:gacb01a23ef601a5e06c582c926c39a8e4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#gacb01a23ef601a5e06c582c926c39a8e4">opj_pi_create_encode</a> (<a class="el" href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a> *pi, <a class="el" href="group___j2_k.html#gace226c035f4c2a151cb26bf65cf3353e">opj_cp_t</a> *cp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> tileno, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> pino, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> tpnum, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> tppos, <a class="el" href="group___j2_k.html#gaef98ee083d0fd9e3804ffffbccbe6b97">J2K_T2_MODE</a> t2_mode)</td></tr>
2015-07-10 18:06:19 +02:00
<tr class="memdesc:gacb01a23ef601a5e06c582c926c39a8e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modify the packet iterator for enabling tile part generation. <a href="group___p_i.html#gacb01a23ef601a5e06c582c926c39a8e4">More...</a><br /></td></tr>
<tr class="separator:gacb01a23ef601a5e06c582c926c39a8e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-12-28 22:12:25 +01:00
<tr class="memitem:ga6c75d9a1f16b692ab5d4cd759e6c4c90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#ga6c75d9a1f16b692ab5d4cd759e6c4c90">opj_pi_create_decode</a> (<a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *image, <a class="el" href="group___j2_k.html#gace226c035f4c2a151cb26bf65cf3353e">opj_cp_t</a> *cp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> tileno, <a class="el" href="event_8h.html#a4cba85f9ee037b1f2c6bceb903051d96">opj_event_mgr_t</a> *manager)</td></tr>
<tr class="memdesc:ga6c75d9a1f16b692ab5d4cd759e6c4c90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a packet iterator for Decoder. <a href="group___p_i.html#ga6c75d9a1f16b692ab5d4cd759e6c4c90">More...</a><br /></td></tr>
<tr class="separator:ga6c75d9a1f16b692ab5d4cd759e6c4c90"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-07-10 18:06:19 +02:00
<tr class="memitem:ga2b305751720002ec7fd630d9c87d4dd4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_i.html#ga2b305751720002ec7fd630d9c87d4dd4">opj_pi_destroy</a> (<a class="el" href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a> *p_pi, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> p_nb_elements)</td></tr>
<tr class="memdesc:ga2b305751720002ec7fd630d9c87d4dd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys a packet iterator array. <a href="group___p_i.html#ga2b305751720002ec7fd630d9c87d4dd4">More...</a><br /></td></tr>
<tr class="separator:ga2b305751720002ec7fd630d9c87d4dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga638f17d6f40f88cd90d1cedbf95147f9"><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___p_i.html#ga638f17d6f40f88cd90d1cedbf95147f9">opj_pi_next</a> (<a class="el" href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a> *pi)</td></tr>
<tr class="memdesc:ga638f17d6f40f88cd90d1cedbf95147f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modify the packet iterator to point to the next packet. <a href="group___p_i.html#ga638f17d6f40f88cd90d1cedbf95147f9">More...</a><br /></td></tr>
<tr class="separator:ga638f17d6f40f88cd90d1cedbf95147f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-12-28 22:12:25 +01:00
<tr class="memitem:ga7366cd1b06e22a71734d95f27ceaa20b"><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___p_i.html#ga7366cd1b06e22a71734d95f27ceaa20b">opj_get_encoding_packet_count</a> (const <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image, const <a class="el" href="group___j2_k.html#gace226c035f4c2a151cb26bf65cf3353e">opj_cp_t</a> *p_cp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> p_tile_no)</td></tr>
<tr class="memdesc:ga7366cd1b06e22a71734d95f27ceaa20b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of packets in the tile. <a href="group___p_i.html#ga7366cd1b06e22a71734d95f27ceaa20b">More...</a><br /></td></tr>
<tr class="separator:ga7366cd1b06e22a71734d95f27ceaa20b"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-07-10 18:06:19 +02:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of a packet iterator (PI) </p>
2020-12-28 22:12:25 +01:00
<p>The functions in PI.C have for goal to realize a packet iterator that permits to get the next packet following the progression order and change of it. The functions in PI.C are used by some function in T2.C. </p>
2015-07-10 18:06:19 +02:00
</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>