Update Doxygen doc
[openjpeg.git] / doxygen / marker__manager_8h_source.html
index 95fc143b2998a7051c8c34fe7bf5b33996f6bafd..7aa070e6dd5a5874c0da6f38ba7f313da803206e 100644 (file)
@@ -18,7 +18,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">OpenJPEG
-   &#160;<span id="projectnumber">2.1.2</span>
+   &#160;<span id="projectnumber">2.2.0</span>
    </div>
   </td>
  </tr>
 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> */</span></div>
 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
-<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef         MARKER_MANAGER_H_</span></div>
-<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define        MARKER_MANAGER_H_</span></div>
+<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef     MARKER_MANAGER_H_</span></div>
+<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"># define    MARKER_MANAGER_H_</span></div>
 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="codestream__manager_8h.html">codestream_manager.h</a>&quot;</span></div>
 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
-<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structmarker__param.html">   38</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmarker__param.html">marker_param</a>{</div>
-<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">   39</a></span>&#160;  <a class="code" href="structcodestream__param.html">codestream_param_t</a> <a class="code" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">cs</a>; </div>
-<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">   40</a></span>&#160;  <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">code</a>;          </div>
-<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">   41</a></span>&#160;  <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> <a class="code" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">offset</a>;        </div>
-<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">   42</a></span>&#160;  <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">length</a>;        </div>
+<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structmarker__param.html">   38</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structmarker__param.html">marker_param</a> {</div>
+<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">   39</a></span>&#160;    <a class="code" href="structcodestream__param.html">codestream_param_t</a> <a class="code" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">cs</a>; </div>
+<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">   40</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">code</a>;          </div>
+<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">   41</a></span>&#160;    <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> <a class="code" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">offset</a>;        </div>
+<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">   42</a></span>&#160;    <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">length</a>;        </div>
 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;} <a class="code" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>;</div>
 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
-<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<a class="code" href="structmarker__param.html">marker_param_t</a> <a class="code" href="marker__manager_8h.html#aeba6604c55d20ce4dafca1c0bd8e1fbc">set_marker</a>( <a class="code" href="structcodestream__param.html">codestream_param_t</a> cs, <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> length);</div>
-<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<a class="code" href="structmarker__param.html">marker_param_t</a> <a class="code" href="marker__manager_8h.html#aeba6604c55d20ce4dafca1c0bd8e1fbc">set_marker</a>(<a class="code" href="structcodestream__param.html">codestream_param_t</a> cs, <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset,</div>
+<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;                          <a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> length);</div>
 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
-<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<a class="code" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> <a class="code" href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a>( <a class="code" href="structmarker__param.html">marker_param_t</a> marker, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
-<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
-<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a>( <a class="code" href="structmarker__param.html">marker_param_t</a> marker, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
-<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
-<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<a class="code" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> <a class="code" href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a>( <a class="code" href="structmarker__param.html">marker_param_t</a> marker, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
-<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<a class="code" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> <a class="code" href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a>(<a class="code" href="structmarker__param.html">marker_param_t</a> marker, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
+<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
+<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<a class="code" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> <a class="code" href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a>(<a class="code" href="structmarker__param.html">marker_param_t</a> marker, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
+<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
+<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<a class="code" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> <a class="code" href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a>(<a class="code" href="structmarker__param.html">marker_param_t</a> marker, <a class="code" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset);</div>
 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
-<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="preprocessor">#endif      </span><span class="comment">/* !MARKER_MANAGER_H_ */</span><span class="preprocessor"></span></div>
+<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
+<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="preprocessor">#endif      </span><span class="comment">/* !MARKER_MANAGER_H_ */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="byte__manager_8h_html_ade896f5d51f03e046a004d006b53a8b0"><div class="ttname"><a href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a></div><div class="ttdeci">uint8_t Byte_t</div><div class="ttdef"><b>Definition:</b> byte_manager.h:37</div></div>
 <div class="ttc" id="openjpeg_8h_html_a64948c8a524dee101c5a4d7293e6158c"><div class="ttname"><a href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a></div><div class="ttdeci">int64_t OPJ_OFF_T</div><div class="ttdef"><b>Definition:</b> openjpeg.h:130</div></div>
 <div class="ttc" id="marker__manager_8h_html_aa224fdf1390f864fa5766cfb7b70d8df"><div class="ttname"><a href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a></div><div class="ttdeci">struct marker_param marker_param_t</div><div class="ttdoc">Marker parameters. </div></div>
 <div class="ttc" id="codestream__manager_8h_html"><div class="ttname"><a href="codestream__manager_8h.html">codestream_manager.h</a></div></div>
 <div class="ttc" id="structmarker__param_html_a74f9dda8b061c37c77d4c99a16ae9f92"><div class="ttname"><a href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">marker_param::length</a></div><div class="ttdeci">Byte2_t length</div><div class="ttdoc">marker segment length </div><div class="ttdef"><b>Definition:</b> marker_manager.h:42</div></div>
 <div class="ttc" id="structcodestream__param_html"><div class="ttname"><a href="structcodestream__param.html">codestream_param</a></div><div class="ttdoc">codestream parameters </div><div class="ttdef"><b>Definition:</b> codestream_manager.h:37</div></div>
-<div class="ttc" id="marker__manager_8h_html_a6531c0062e0d866e406543e3f63f9c86"><div class="ttname"><a href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a></div><div class="ttdeci">Byte4_t fetch_marker4bytebigendian(marker_param_t marker, OPJ_OFF_T offset)</div><div class="ttdoc">fetch marker content 4-byte big endian Byte codes in file stream </div><div class="ttdef"><b>Definition:</b> marker_manager.c:65</div></div>
-<div class="ttc" id="marker__manager_8h_html_a310269e7466f3a1588930e9cbc51570c"><div class="ttname"><a href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a></div><div class="ttdeci">Byte_t fetch_marker1byte(marker_param_t marker, OPJ_OFF_T offset)</div><div class="ttdoc">fetch marker content 1-bytes of data in file stream </div><div class="ttdef"><b>Definition:</b> marker_manager.c:55</div></div>
-<div class="ttc" id="marker__manager_8h_html_ac884dafb92a564a501b1cbc01333d248"><div class="ttname"><a href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a></div><div class="ttdeci">Byte2_t fetch_marker2bytebigendian(marker_param_t marker, OPJ_OFF_T offset)</div><div class="ttdoc">fetch marker content 2-byte big endian Byte codes in file stream </div><div class="ttdef"><b>Definition:</b> marker_manager.c:60</div></div>
+<div class="ttc" id="marker__manager_8h_html_a6531c0062e0d866e406543e3f63f9c86"><div class="ttname"><a href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a></div><div class="ttdeci">Byte4_t fetch_marker4bytebigendian(marker_param_t marker, OPJ_OFF_T offset)</div><div class="ttdoc">fetch marker content 4-byte big endian Byte codes in file stream </div><div class="ttdef"><b>Definition:</b> marker_manager.c:66</div></div>
+<div class="ttc" id="marker__manager_8h_html_a310269e7466f3a1588930e9cbc51570c"><div class="ttname"><a href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a></div><div class="ttdeci">Byte_t fetch_marker1byte(marker_param_t marker, OPJ_OFF_T offset)</div><div class="ttdoc">fetch marker content 1-bytes of data in file stream </div><div class="ttdef"><b>Definition:</b> marker_manager.c:56</div></div>
+<div class="ttc" id="marker__manager_8h_html_ac884dafb92a564a501b1cbc01333d248"><div class="ttname"><a href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a></div><div class="ttdeci">Byte2_t fetch_marker2bytebigendian(marker_param_t marker, OPJ_OFF_T offset)</div><div class="ttdoc">fetch marker content 2-byte big endian Byte codes in file stream </div><div class="ttdef"><b>Definition:</b> marker_manager.c:61</div></div>
 <div class="ttc" id="structmarker__param_html_a631774a24ccb8eddb0fd3c71d99cb7fa"><div class="ttname"><a href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">marker_param::code</a></div><div class="ttdeci">Byte2_t code</div><div class="ttdoc">marker code </div><div class="ttdef"><b>Definition:</b> marker_manager.h:40</div></div>
 <div class="ttc" id="structmarker__param_html"><div class="ttname"><a href="structmarker__param.html">marker_param</a></div><div class="ttdoc">Marker parameters. </div><div class="ttdef"><b>Definition:</b> marker_manager.h:38</div></div>
 <div class="ttc" id="byte__manager_8h_html_aad2d957f29839c12c87e4dd945807d36"><div class="ttname"><a href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a></div><div class="ttdeci">uint32_t Byte4_t</div><div class="ttdef"><b>Definition:</b> byte_manager.h:39</div></div>