doxygen/cidx__manager_8h_source.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: cidx_manager.h Source File</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.3.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="headertitle">
  52 <div class="title">cidx_manager.h</div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55 <a href="cidx__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
  56 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * $Id: cidx_manager.h 897 2011-08-28 21:43:57Z Kaori.Hagihara@gmail.com $</span></div>
  57 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
  58 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium</span></div>
  59 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Copyright (c) 2002-2014, Professor Benoit Macq</span></div>
  60 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Copyright (c) 2003-2004, Yannick Verschueren</span></div>
  61 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Copyright (c) 2010-2011, Kaori Hagihara</span></div>
  62 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * All rights reserved.</span></div>
  63 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div>
  64 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
  65 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div>
  66 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * are met:</span></div>
  67 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
  68 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer.</span></div>
  69 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
  70 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div>
  71 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div>
  72 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *</span></div>
  73 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div>
  74 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
  75 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
  76 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
  77 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
  78 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
  79 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
  80 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
  81 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
  82 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
  83 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
  84 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> */</span></div>
  85 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
  86 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#ifndef  CIDX_MANAGER_H_</span></div>
  87 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor"># define CIDX_MANAGER_H_</span></div>
  88 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
  89 <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="openjpeg_8h.html">openjpeg.h</a>&quot;</span></div>
  90 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
  91 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
  92 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">/*</span></div>
  93 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"> * Write Codestream index box (superbox)</span></div>
  94 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"> *</span></div>
  95 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> * @param[in] offset    offset of j2k codestream</span></div>
  96 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> * @param[in] cio       file output handle</span></div>
  97 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> * @param[in] image     image data</span></div>
  98 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> * @param[in] cstr_info codestream information</span></div>
  99 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> * @param[in] j2klen    length of j2k codestream</span></div>
 100 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"> * @return              length of cidx box</span></div>
 101 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> */</span></div>
 102 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="keywordtype">int</span> <a class="code" href="cidx__manager_8h.html#ac7ecf358e9a5d8bdff7e26b4726aba20">opj_write_cidx</a>(<span class="keywordtype">int</span> offset, <a class="code" href="structopj__stream__private.html">opj_stream_private_t</a> *cio,</div>
 103 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;                   <a class="code" href="structopj__codestream__info.html">opj_codestream_info_t</a> cstr_info, <span class="keywordtype">int</span> j2klen,</div>
 104 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;                   <a class="code" href="structopj__event__mgr.html">opj_event_mgr_t</a> * p_manager);</div>
 105 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
 106 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">/*</span></div>
 107 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * Check if EPH option is used</span></div>
 108 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> *</span></div>
 109 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> * @param[in] coff    offset of j2k codestream</span></div>
 110 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> * @param[in] markers marker information</span></div>
 111 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> * @param[in] marknum number of markers</span></div>
 112 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> * @param[in] cio     file output handle</span></div>
 113 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> * @return            true if EPH is used</span></div>
 114 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> */</span></div>
 115 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<a class="code" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> <a class="code" href="cidx__manager_8h.html#ab67c4291dded54c0ca21a721f3ae25c9">opj_check_EPHuse</a>(<span class="keywordtype">int</span> coff, <a class="code" href="structopj__marker__info.html">opj_marker_info_t</a> *markers, <span class="keywordtype">int</span> marknum,</div>
 116 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                          <a class="code" href="structopj__stream__private.html">opj_stream_private_t</a> *cio,</div>
 117 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                          <a class="code" href="structopj__event__mgr.html">opj_event_mgr_t</a> * p_manager);</div>
 118 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
 119 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="preprocessor">#endif      </span><span class="comment">/* !CIDX_MANAGER_H_ */</span><span class="preprocessor"></span></div>
 120 <div class="ttc" id="structopj__event__mgr_html"><div class="ttname"><a href="structopj__event__mgr.html">opj_event_mgr</a></div><div class="ttdoc">Message handler object used for. </div><div class="ttdef"><b>Definition:</b> event.h:50</div></div>
 121 <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>
 122 <div class="ttc" id="structopj__stream__private_html"><div class="ttname"><a href="structopj__stream__private.html">opj_stream_private</a></div><div class="ttdoc">Byte input-output stream. </div><div class="ttdef"><b>Definition:</b> cio.h:81</div></div>
 123 <div class="ttc" id="structopj__marker__info_html"><div class="ttname"><a href="structopj__marker__info.html">opj_marker_info</a></div><div class="ttdoc">Marker structure. </div><div class="ttdef"><b>Definition:</b> openjpeg.h:742</div></div>
 124 <div class="ttc" id="openjpeg_8h_html"><div class="ttname"><a href="openjpeg_8h.html">openjpeg.h</a></div></div>
 125 <div class="ttc" id="cidx__manager_8h_html_ab67c4291dded54c0ca21a721f3ae25c9"><div class="ttname"><a href="cidx__manager_8h.html#ab67c4291dded54c0ca21a721f3ae25c9">opj_check_EPHuse</a></div><div class="ttdeci">OPJ_BOOL opj_check_EPHuse(int coff, opj_marker_info_t *markers, int marknum, opj_stream_private_t *cio, opj_event_mgr_t *p_manager)</div><div class="ttdef"><b>Definition:</b> cidx_manager.c:233</div></div>
 126 <div class="ttc" id="structopj__codestream__info_html"><div class="ttname"><a href="structopj__codestream__info.html">opj_codestream_info</a></div><div class="ttdoc">Index structure of the codestream. </div><div class="ttdef"><b>Definition:</b> openjpeg.h:811</div></div>
 127 <div class="ttc" id="cidx__manager_8h_html_ac7ecf358e9a5d8bdff7e26b4726aba20"><div class="ttname"><a href="cidx__manager_8h.html#ac7ecf358e9a5d8bdff7e26b4726aba20">opj_write_cidx</a></div><div class="ttdeci">int opj_write_cidx(int offset, opj_stream_private_t *cio, opj_codestream_info_t cstr_info, int j2klen, opj_event_mgr_t *p_manager)</div><div class="ttdef"><b>Definition:</b> cidx_manager.c:50</div></div>
 128 </div><!-- fragment --></div><!-- contents -->
 129 <!-- start footer part -->
 130 <hr class="footer"/><address class="footer"><small>
 131 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 132 <img class="footer" src="doxygen.png" alt="doxygen"/>
 133 </a> 1.8.10
 134 </small></address>
 135 </body>
 136 </html>