doxygen/pi_8h.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: pi.h File Reference</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 class="current"><a href="files.html"><span>Files</span></a></li>
  37     </ul>
  38   </div>
  39   <div id="navrow2" class="tabs2">
  40     <ul class="tablist">
  41       <li><a href="files.html"><span>File&#160;List</span></a></li>
  42       <li><a href="globals.html"><span>Globals</span></a></li>
  43     </ul>
  44   </div>
  45 <div id="nav-path" class="navpath">
  46   <ul>
  47 <li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_68013e83e260d17d49dee5e209315608.html">openjp2</a></li>  </ul>
  48 </div>
  49 </div><!-- top -->
  50 <div class="header">
  51   <div class="summary">
  52 <a href="#nested-classes">Data Structures</a> &#124;
  53 <a href="#typedef-members">Typedefs</a>  </div>
  54   <div class="headertitle">
  55 <div class="title">pi.h File Reference</div>  </div>
  56 </div><!--header-->
  57 <div class="contents">
  58
  59 <p>Implementation of a packet iterator (PI)
  60 <a href="#details">More...</a></p>
  61
  62 <p><a href="pi_8h_source.html">Go to the source code of this file.</a></p>
  63 <table class="memberdecls">
  64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  65 Data Structures</h2></td></tr>
  66 <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>
  67 <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>
  68 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <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>
  70 <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>
  71 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <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>
  73 <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>
  74 <tr class="separator:"><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="typedef-members"></a>
  77 Typedefs</h2></td></tr>
  78 <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>
  79 <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>
  80 <tr class="separator:gaf3ba38306cb812def774ac9852bf11ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <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>
  82 <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>
  83 <tr class="separator:gaf5e0e4858311b5d80f5255c3607a55df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <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>
  85 <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>
  86 <tr class="separator:ga36e3009320d25edd589dd5edff649723"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table><table class="memberdecls">
  88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  89 Functions</h2></td></tr>
  90 <tr><td colspan="2"><div class="groupHeader">Exported functions</div></td></tr>
  91 <tr class="memitem:ga063e3300cc8f7553f0ea02652194409a"><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#ga063e3300cc8f7553f0ea02652194409a">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)</td></tr>
  92 <tr class="memdesc:ga063e3300cc8f7553f0ea02652194409a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a packet iterator for encoding.  <a href="group___p_i.html#ga063e3300cc8f7553f0ea02652194409a">More...</a><br /></td></tr>
  93 <tr class="separator:ga063e3300cc8f7553f0ea02652194409a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <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>
  95 <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>
  96 <tr class="separator:ga19c951dfab9ba88d65a9b78f32dd3397"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <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>
  98 <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>
  99 <tr class="separator:gacb01a23ef601a5e06c582c926c39a8e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 <tr class="memitem:ga4990d0324eb594434bd7ef61d746ac46"><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#ga4990d0324eb594434bd7ef61d746ac46">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)</td></tr>
 101 <tr class="memdesc:ga4990d0324eb594434bd7ef61d746ac46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a packet iterator for Decoder.  <a href="group___p_i.html#ga4990d0324eb594434bd7ef61d746ac46">More...</a><br /></td></tr>
 102 <tr class="separator:ga4990d0324eb594434bd7ef61d746ac46"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 <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>
 104 <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>
 105 <tr class="separator:ga2b305751720002ec7fd630d9c87d4dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 <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>
 107 <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>
 108 <tr class="separator:ga638f17d6f40f88cd90d1cedbf95147f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 109 </table>
 110 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 111 <div class="textblock"><p>Implementation of a packet iterator (PI) </p>
 112 <p>The functions in <a class="el" href="pi_8c.html">PI.C</a> 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 <a class="el" href="pi_8c.html">PI.C</a> are used by some function in <a class="el" href="t2_8c.html">T2.C</a>. </p>
 113 </div></div><!-- contents -->
 114 <!-- start footer part -->
 115 <hr class="footer"/><address class="footer"><small>
 116 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 117 <img class="footer" src="doxygen.png" alt="doxygen"/>
 118 </a> 1.8.10
 119 </small></address>
 120 </body>
 121 </html>