Update for OpenJPEG 2.4.0
[openjpeg.git] / doxygen / openjpip_8h_source.html
index a0347a2c822663f3e6f323f6fdbc6f79edab52d2..32f5709f39dfd85dd9dbbf52945b5990ca1d7284 100644 (file)
@@ -3,8 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<meta name="generator" content="Doxygen 1.8.11"/>
 <title>OpenJPEG: openjpip.h Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -19,7 +18,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">OpenJPEG
-   &#160;<span id="projectnumber">2.3.1</span>
+   &#160;<span id="projectnumber">2.4.0</span>
    </div>
   </td>
  </tr>
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
-<script type="text/javascript" src="menudata.js"></script>
-<script type="text/javascript" src="menu.js"></script>
-<script type="text/javascript">
-$(function() {
-  initMenu('',false,false,'search.php','Search');
-});
-</script>
-<div id="main-nav"></div>
+<!-- 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>
 <div id="nav-path" class="navpath">
   <ul>
-<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_6ec2d9a1b37a1187cc46aeaf3b19e1b3.html">openjpip</a></li>  </ul>
+<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_54d80c9412497e935deb5677b5fae801.html">openjpip</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
@@ -58,27 +64,27 @@ $(function() {
 <div class="ttc" id="openjpip_8h_html_aeabf53674cdfc09c134a513fdd664b87"><div class="ttname"><a href="openjpip_8h.html#aeabf53674cdfc09c134a513fdd664b87">accept_connection</a></div><div class="ttdeci">OPJ_API client_t OPJ_CALLCONV accept_connection(dec_server_record_t *rec)</div><div class="ttdoc">Accept client connection. </div><div class="ttdef"><b>Definition:</b> openjpip.c:260</div></div>
 <div class="ttc" id="openjpeg_8h_html_abb5dad6294f4611f1925388e919b16f4"><div class="ttname"><a href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a></div><div class="ttdeci">int OPJ_BOOL</div><div class="ttdef"><b>Definition:</b> openjpeg.h:110</div></div>
 <div class="ttc" id="openjpip_8h_html_a43441d763d72585d9cc6c9b4b4ea422e"><div class="ttname"><a href="openjpip_8h.html#a43441d763d72585d9cc6c9b4b4ea422e">handle_clientreq</a></div><div class="ttdeci">OPJ_API OPJ_BOOL OPJ_CALLCONV handle_clientreq(client_t client, dec_server_record_t *rec)</div><div class="ttdoc">Handle client request. </div><div class="ttdef"><b>Definition:</b> openjpip.c:272</div></div>
-<div class="ttc" id="openjpip_8h_html_ab156b0a2b84b452a759cd7657a4f3585"><div class="ttname"><a href="openjpip_8h.html#ab156b0a2b84b452a759cd7657a4f3585">destroy_jpipdecoder</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV destroy_jpipdecoder(jpip_dec_param_t **dec)</div><div class="ttdoc">Destroy jpip decoding parameters. </div><div class="ttdef"><b>Definition:</b> openjpip.c:433</div></div>
-<div class="ttc" id="openjpip_8h_html_a33462880bc3c9bca15ac1086d73e4080"><div class="ttname"><a href="openjpip_8h.html#a33462880bc3c9bca15ac1086d73e4080">output_log</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV output_log(OPJ_BOOL messages, OPJ_BOOL metadata, OPJ_BOOL ihdrbox, jpip_dec_param_t *dec)</div><div class="ttdoc">Option; print out parameter values to stderr. </div><div class="ttdef"><b>Definition:</b> openjpip.c:416</div></div>
+<div class="ttc" id="openjpip_8h_html_ab156b0a2b84b452a759cd7657a4f3585"><div class="ttname"><a href="openjpip_8h.html#ab156b0a2b84b452a759cd7657a4f3585">destroy_jpipdecoder</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV destroy_jpipdecoder(jpip_dec_param_t **dec)</div><div class="ttdoc">Destroy jpip decoding parameters. </div><div class="ttdef"><b>Definition:</b> openjpip.c:435</div></div>
+<div class="ttc" id="openjpip_8h_html_a33462880bc3c9bca15ac1086d73e4080"><div class="ttname"><a href="openjpip_8h.html#a33462880bc3c9bca15ac1086d73e4080">output_log</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV output_log(OPJ_BOOL messages, OPJ_BOOL metadata, OPJ_BOOL ihdrbox, jpip_dec_param_t *dec)</div><div class="ttdoc">Option; print out parameter values to stderr. </div><div class="ttdef"><b>Definition:</b> openjpip.c:418</div></div>
 <div class="ttc" id="structjpip__dec__param_html_a495cf208c9181a6141991a25fde6c5bc"><div class="ttname"><a href="structjpip__dec__param.html#a495cf208c9181a6141991a25fde6c5bc">jpip_dec_param::jp2klen</a></div><div class="ttdeci">Byte8_t jp2klen</div><div class="ttdoc">length of j2kstream or JP2 file </div><div class="ttdef"><b>Definition:</b> openjpip.h:224</div></div>
 <div class="ttc" id="index__manager_8h_html"><div class="ttname"><a href="index__manager_8h.html">index_manager.h</a></div></div>
-<div class="ttc" id="openjpip_8h_html_a2ff3d3894ccf463eb4f1fd87ca408dcb"><div class="ttname"><a href="openjpip_8h.html#a2ff3d3894ccf463eb4f1fd87ca408dcb">output_index</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV output_index(index_t *index)</div><div class="ttdoc">print index parameters </div><div class="ttdef"><b>Definition:</b> openjpip.c:479</div></div>
+<div class="ttc" id="openjpip_8h_html_a2ff3d3894ccf463eb4f1fd87ca408dcb"><div class="ttname"><a href="openjpip_8h.html#a2ff3d3894ccf463eb4f1fd87ca408dcb">output_index</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV output_index(index_t *index)</div><div class="ttdoc">print index parameters </div><div class="ttdef"><b>Definition:</b> openjpip.c:481</div></div>
 <div class="ttc" id="structjpip__dec__param_html_aa41cfeb8f514be44d42fc3a16a962372"><div class="ttname"><a href="structjpip__dec__param.html#aa41cfeb8f514be44d42fc3a16a962372">jpip_dec_param::ihdrbox</a></div><div class="ttdeci">ihdrbox_param_t * ihdrbox</div><div class="ttdoc">ihdr box going into JP2 file </div><div class="ttdef"><b>Definition:</b> openjpip.h:222</div></div>
 <div class="ttc" id="structcachelist__param_html"><div class="ttname"><a href="structcachelist__param.html">cachelist_param</a></div><div class="ttdef"><b>Definition:</b> cache_manager.h:50</div></div>
 <div class="ttc" id="metadata__manager_8h_html"><div class="ttname"><a href="metadata__manager_8h.html">metadata_manager.h</a></div></div>
 <div class="ttc" id="structdec__server__record_html_acf54a3183c24403af919253f273c703c"><div class="ttname"><a href="structdec__server__record.html#acf54a3183c24403af919253f273c703c">dec_server_record::cachelist</a></div><div class="ttdeci">cachelist_param_t * cachelist</div><div class="ttdoc">cache list </div><div class="ttdef"><b>Definition:</b> openjpip.h:158</div></div>
-<div class="ttc" id="openjpip_8h_html_a191391a64b5ce564276e3ed5f9ac138b"><div class="ttname"><a href="openjpip_8h.html#a191391a64b5ce564276e3ed5f9ac138b">get_index_from_JP2file</a></div><div class="ttdeci">OPJ_API index_t *OPJ_CALLCONV get_index_from_JP2file(int fd)</div><div class="ttdoc">Parse JP2 file and get index information from cidx box inside. </div><div class="ttdef"><b>Definition:</b> openjpip.c:446</div></div>
+<div class="ttc" id="openjpip_8h_html_a191391a64b5ce564276e3ed5f9ac138b"><div class="ttname"><a href="openjpip_8h.html#a191391a64b5ce564276e3ed5f9ac138b">get_index_from_JP2file</a></div><div class="ttdeci">OPJ_API index_t *OPJ_CALLCONV get_index_from_JP2file(int fd)</div><div class="ttdoc">Parse JP2 file and get index information from cidx box inside. </div><div class="ttdef"><b>Definition:</b> openjpip.c:448</div></div>
 <div class="ttc" id="openjpeg_8h_html_aba7397be054e36dc0284a6589736135e"><div class="ttname"><a href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a></div><div class="ttdeci">size_t OPJ_SIZE_T</div><div class="ttdef"><b>Definition:</b> openjpeg.h:133</div></div>
 <div class="ttc" id="structdec__server__record_html_a52f7141b9880f038a7f47dbdb98713a4"><div class="ttname"><a href="structdec__server__record.html#a52f7141b9880f038a7f47dbdb98713a4">dec_server_record::msgqueue</a></div><div class="ttdeci">msgqueue_param_t * msgqueue</div><div class="ttdoc">parsed message queue of jpipstream </div><div class="ttdef"><b>Definition:</b> openjpip.h:161</div></div>
 <div class="ttc" id="structjpip__dec__param_html_a3929502b6815b4ff21f3d7550f4f6a37"><div class="ttname"><a href="structjpip__dec__param.html#a3929502b6815b4ff21f3d7550f4f6a37">jpip_dec_param::jp2kstream</a></div><div class="ttdeci">Byte_t * jp2kstream</div><div class="ttdoc">J2K codestream or JP2 file codestream. </div><div class="ttdef"><b>Definition:</b> openjpip.h:223</div></div>
 <div class="ttc" id="structtargetlist__param_html"><div class="ttname"><a href="structtargetlist__param.html">targetlist_param</a></div><div class="ttdoc">Target list parameters. </div><div class="ttdef"><b>Definition:</b> target_manager.h:59</div></div>
-<div class="ttc" id="openjpip_8h_html_a94cba1bb36c08739e9983119af4d47e2"><div class="ttname"><a href="openjpip_8h.html#a94cba1bb36c08739e9983119af4d47e2">destroy_index</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV destroy_index(index_t **idx)</div><div class="ttdoc">Destroy index parameters. </div><div class="ttdef"><b>Definition:</b> openjpip.c:474</div></div>
+<div class="ttc" id="openjpip_8h_html_a94cba1bb36c08739e9983119af4d47e2"><div class="ttname"><a href="openjpip_8h.html#a94cba1bb36c08739e9983119af4d47e2">destroy_index</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV destroy_index(index_t **idx)</div><div class="ttdoc">Destroy index parameters. </div><div class="ttdef"><b>Definition:</b> openjpip.c:476</div></div>
 <div class="ttc" id="structdec__server__record_html_a73fae00e20bed648ff618a3be0d0a713"><div class="ttname"><a href="structdec__server__record.html#a73fae00e20bed648ff618a3be0d0a713">dec_server_record::jpipstream</a></div><div class="ttdeci">Byte_t * jpipstream</div><div class="ttdoc">JPT/JPP stream. </div><div class="ttdef"><b>Definition:</b> openjpip.h:159</div></div>
 <div class="ttc" id="sock__manager_8h_html_a8dc8083897335125630f1af5dafd5831"><div class="ttname"><a href="sock__manager_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a></div><div class="ttdeci">int SOCKET</div><div class="ttdef"><b>Definition:</b> sock_manager.h:40</div></div>
 <div class="ttc" id="structauxtrans__param_html"><div class="ttname"><a href="structauxtrans__param.html">auxtrans_param</a></div><div class="ttdoc">auxiliary transport setting parameters </div><div class="ttdef"><b>Definition:</b> auxtrans_manager.h:38</div></div>
 <div class="ttc" id="msgqueue__manager_8h_html"><div class="ttname"><a href="msgqueue__manager_8h.html">msgqueue_manager.h</a></div></div>
 <div class="ttc" id="target__manager_8h_html"><div class="ttname"><a href="target__manager_8h.html">target_manager.h</a></div></div>
-<div class="ttc" id="openjpip_8h_html_ac5f5f8d1b581e02b6f1afb417a7dbef8"><div class="ttname"><a href="openjpip_8h.html#ac5f5f8d1b581e02b6f1afb417a7dbef8">decode_jpip</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV decode_jpip(jpip_dec_param_t *dec)</div><div class="ttdoc">Decode jpip codestream. </div><div class="ttdef"><b>Definition:</b> openjpip.c:376</div></div>
+<div class="ttc" id="openjpip_8h_html_ac5f5f8d1b581e02b6f1afb417a7dbef8"><div class="ttname"><a href="openjpip_8h.html#ac5f5f8d1b581e02b6f1afb417a7dbef8">decode_jpip</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV decode_jpip(jpip_dec_param_t *dec)</div><div class="ttdoc">Decode jpip codestream. </div><div class="ttdef"><b>Definition:</b> openjpip.c:378</div></div>
 <div class="ttc" id="structindex__param_html"><div class="ttname"><a href="structindex__param.html">index_param</a></div><div class="ttdoc">index parameters </div><div class="ttdef"><b>Definition:</b> index_manager.h:86</div></div>
 <div class="ttc" id="imgsock__manager_8h_html"><div class="ttname"><a href="imgsock__manager_8h.html">imgsock_manager.h</a></div></div>
 <div class="ttc" id="openjpip_8h_html_a05f5e9a3abc177c5a18e0a97c77cc2e0"><div class="ttname"><a href="openjpip_8h.html#a05f5e9a3abc177c5a18e0a97c77cc2e0">terminate_dec_server</a></div><div class="ttdeci">OPJ_API void OPJ_CALLCONV terminate_dec_server(dec_server_record_t **rec)</div><div class="ttdoc">Terminate the image decoding server. </div><div class="ttdef"><b>Definition:</b> openjpip.c:244</div></div>
@@ -98,7 +104,7 @@ $(function() {
 <div class="ttc" id="byte__manager_8h_html"><div class="ttname"><a href="byte__manager_8h.html">byte_manager.h</a></div></div>
 <div class="ttc" id="openjpeg_8h_html_a90b59bf5c66846dc3317a89089091f91"><div class="ttname"><a href="openjpeg_8h.html#a90b59bf5c66846dc3317a89089091f91">OPJ_API</a></div><div class="ttdeci">#define OPJ_API</div><div class="ttdef"><b>Definition:</b> openjpeg.h:89</div></div>
 <div class="ttc" id="openjpip_8h_html_a1e7187bd7a446489759e2ea37c35cdf9"><div class="ttname"><a href="openjpip_8h.html#a1e7187bd7a446489759e2ea37c35cdf9">init_jpipdecoder</a></div><div class="ttdeci">OPJ_API jpip_dec_param_t *OPJ_CALLCONV init_jpipdecoder(OPJ_BOOL jp2)</div><div class="ttdoc">Initialize jpip decoder. </div><div class="ttdef"><b>Definition:</b> openjpip.c:334</div></div>
-<div class="ttc" id="openjpip_8h_html_a8a52ee0dcf764d6fe53e4bad8dd50c26"><div class="ttname"><a href="openjpip_8h.html#a8a52ee0dcf764d6fe53e4bad8dd50c26">fwrite_jp2k</a></div><div class="ttdeci">OPJ_API OPJ_BOOL OPJ_CALLCONV fwrite_jp2k(const char fname[], jpip_dec_param_t *dec)</div><div class="ttdoc">Write J2K/JP2 codestream to a file. </div><div class="ttdef"><b>Definition:</b> openjpip.c:394</div></div>
+<div class="ttc" id="openjpip_8h_html_a8a52ee0dcf764d6fe53e4bad8dd50c26"><div class="ttname"><a href="openjpip_8h.html#a8a52ee0dcf764d6fe53e4bad8dd50c26">fwrite_jp2k</a></div><div class="ttdeci">OPJ_API OPJ_BOOL OPJ_CALLCONV fwrite_jp2k(const char fname[], jpip_dec_param_t *dec)</div><div class="ttdoc">Write J2K/JP2 codestream to a file. </div><div class="ttdef"><b>Definition:</b> openjpip.c:396</div></div>
 <div class="ttc" id="openjpip_8h_html_a9ffc16809d0a534ebf55ed64394cedad"><div class="ttname"><a href="openjpip_8h.html#a9ffc16809d0a534ebf55ed64394cedad">client_t</a></div><div class="ttdeci">SOCKET client_t</div><div class="ttdoc">Client socket identifier. </div><div class="ttdef"><b>Definition:</b> openjpip.h:167</div></div>
 <div class="ttc" id="openjpip_8h_html_a6413b56e4cf2303b22da7498490447e6"><div class="ttname"><a href="openjpip_8h.html#a6413b56e4cf2303b22da7498490447e6">dec_server_record_t</a></div><div class="ttdeci">struct dec_server_record dec_server_record_t</div><div class="ttdoc">Decoding server static records. </div></div>
 <div class="ttc" id="cache__manager_8h_html"><div class="ttname"><a href="cache__manager_8h.html">cache_manager.h</a></div></div>
@@ -111,7 +117,7 @@ $(function() {
 <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"/>
-</a> 1.8.13
+</a> 1.8.11
 </small></address>
 </body>
 </html>