doxygen/marker__manager_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.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>OpenJPEG: marker_manager.h File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">OpenJPEG
  22    &#160;<span id="projectnumber">2.3.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.13 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 $(function() {
  35   initMenu('',false,false,'search.php','Search');
  36 });
  37 </script>
  38 <div id="main-nav"></div>
  39 <div id="nav-path" class="navpath">
  40   <ul>
  41 <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>
  42 </div>
  43 </div><!-- top -->
  44 <div class="header">
  45   <div class="summary">
  46 <a href="#nested-classes">Data Structures</a> &#124;
  47 <a href="#typedef-members">Typedefs</a> &#124;
  48 <a href="#func-members">Functions</a>  </div>
  49   <div class="headertitle">
  50 <div class="title">marker_manager.h File Reference</div>  </div>
  51 </div><!--header-->
  52 <div class="contents">
  53 <div class="textblock"><code>#include &quot;<a class="el" href="codestream__manager_8h_source.html">codestream_manager.h</a>&quot;</code><br />
  54 </div>
  55 <p><a href="marker__manager_8h_source.html">Go to the source code of this file.</a></p>
  56 <table class="memberdecls">
  57 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  58 Data Structures</h2></td></tr>
  59 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmarker__param.html">marker_param</a></td></tr>
  60 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marker parameters.  <a href="structmarker__param.html#details">More...</a><br /></td></tr>
  61 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 </table><table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  64 Typedefs</h2></td></tr>
  65 <tr class="memitem:aa224fdf1390f864fa5766cfb7b70d8df"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmarker__param.html">marker_param</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a></td></tr>
  66 <tr class="memdesc:aa224fdf1390f864fa5766cfb7b70d8df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marker parameters.  <a href="#aa224fdf1390f864fa5766cfb7b70d8df">More...</a><br /></td></tr>
  67 <tr class="separator:aa224fdf1390f864fa5766cfb7b70d8df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 </table><table class="memberdecls">
  69 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  70 Functions</h2></td></tr>
  71 <tr class="memitem:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#aeba6604c55d20ce4dafca1c0bd8e1fbc">set_marker</a> (<a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a> cs, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> code, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset, <a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> length)</td></tr>
  72 <tr class="memdesc:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">set marker parameters from inputs  <a href="#aeba6604c55d20ce4dafca1c0bd8e1fbc">More...</a><br /></td></tr>
  73 <tr class="separator:aeba6604c55d20ce4dafca1c0bd8e1fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:a310269e7466f3a1588930e9cbc51570c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#a310269e7466f3a1588930e9cbc51570c">fetch_marker1byte</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
  75 <tr class="memdesc:a310269e7466f3a1588930e9cbc51570c"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 1-bytes of data in file stream  <a href="#a310269e7466f3a1588930e9cbc51570c">More...</a><br /></td></tr>
  76 <tr class="separator:a310269e7466f3a1588930e9cbc51570c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:ac884dafb92a564a501b1cbc01333d248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#ac884dafb92a564a501b1cbc01333d248">fetch_marker2bytebigendian</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
  78 <tr class="memdesc:ac884dafb92a564a501b1cbc01333d248"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 2-byte big endian Byte codes in file stream  <a href="#ac884dafb92a564a501b1cbc01333d248">More...</a><br /></td></tr>
  79 <tr class="separator:ac884dafb92a564a501b1cbc01333d248"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a6531c0062e0d866e406543e3f63f9c86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marker__manager_8h.html#a6531c0062e0d866e406543e3f63f9c86">fetch_marker4bytebigendian</a> (<a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> marker, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> offset)</td></tr>
  81 <tr class="memdesc:a6531c0062e0d866e406543e3f63f9c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">fetch marker content 4-byte big endian Byte codes in file stream  <a href="#a6531c0062e0d866e406543e3f63f9c86">More...</a><br /></td></tr>
  82 <tr class="separator:a6531c0062e0d866e406543e3f63f9c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 </table>
  84 <h2 class="groupheader">Typedef Documentation</h2>
  85 <a id="aa224fdf1390f864fa5766cfb7b70d8df"></a>
  86 <h2 class="memtitle"><span class="permalink"><a href="#aa224fdf1390f864fa5766cfb7b70d8df">&#9670;&nbsp;</a></span>marker_param_t</h2>
  87
  88 <div class="memitem">
  89 <div class="memproto">
  90       <table class="memname">
  91         <tr>
  92           <td class="memname">typedef struct <a class="el" href="structmarker__param.html">marker_param</a>  <a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a></td>
  93         </tr>
  94       </table>
  95 </div><div class="memdoc">
  96
  97 <p>Marker parameters. </p>
  98
  99 </div>
 100 </div>
 101 <h2 class="groupheader">Function Documentation</h2>
 102 <a id="a310269e7466f3a1588930e9cbc51570c"></a>
 103 <h2 class="memtitle"><span class="permalink"><a href="#a310269e7466f3a1588930e9cbc51570c">&#9670;&nbsp;</a></span>fetch_marker1byte()</h2>
 104
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> fetch_marker1byte </td>
 110           <td>(</td>
 111           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
 112           <td class="paramname"><em>marker</em>, </td>
 113         </tr>
 114         <tr>
 115           <td class="paramkey"></td>
 116           <td></td>
 117           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 118           <td class="paramname"><em>offset</em>&#160;</td>
 119         </tr>
 120         <tr>
 121           <td></td>
 122           <td>)</td>
 123           <td></td><td></td>
 124         </tr>
 125       </table>
 126 </div><div class="memdoc">
 127
 128 <p>fetch marker content 1-bytes of data in file stream </p>
 129 <dl class="params"><dt>Parameters</dt><dd>
 130   <table class="params">
 131     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
 132     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
 133   </table>
 134   </dd>
 135 </dl>
 136 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
 137
 138 <p class="reference">References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#af659af47f43c4ef6cea74c5697acf078">fetch_codestream1byte()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
 139
 140 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
 141
 142 </div>
 143 </div>
 144 <a id="ac884dafb92a564a501b1cbc01333d248"></a>
 145 <h2 class="memtitle"><span class="permalink"><a href="#ac884dafb92a564a501b1cbc01333d248">&#9670;&nbsp;</a></span>fetch_marker2bytebigendian()</h2>
 146
 147 <div class="memitem">
 148 <div class="memproto">
 149       <table class="memname">
 150         <tr>
 151           <td class="memname"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a> fetch_marker2bytebigendian </td>
 152           <td>(</td>
 153           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
 154           <td class="paramname"><em>marker</em>, </td>
 155         </tr>
 156         <tr>
 157           <td class="paramkey"></td>
 158           <td></td>
 159           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 160           <td class="paramname"><em>offset</em>&#160;</td>
 161         </tr>
 162         <tr>
 163           <td></td>
 164           <td>)</td>
 165           <td></td><td></td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <p>fetch marker content 2-byte big endian Byte codes in file stream </p>
 171 <dl class="params"><dt>Parameters</dt><dd>
 172   <table class="params">
 173     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
 174     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
 175   </table>
 176   </dd>
 177 </dl>
 178 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
 179
 180 <p class="reference">References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#a6dbb4634cd0d3c32cc641750119d1a65">fetch_codestream2bytebigendian()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
 181
 182 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
 183
 184 </div>
 185 </div>
 186 <a id="a6531c0062e0d866e406543e3f63f9c86"></a>
 187 <h2 class="memtitle"><span class="permalink"><a href="#a6531c0062e0d866e406543e3f63f9c86">&#9670;&nbsp;</a></span>fetch_marker4bytebigendian()</h2>
 188
 189 <div class="memitem">
 190 <div class="memproto">
 191       <table class="memname">
 192         <tr>
 193           <td class="memname"><a class="el" href="byte__manager_8h.html#aad2d957f29839c12c87e4dd945807d36">Byte4_t</a> fetch_marker4bytebigendian </td>
 194           <td>(</td>
 195           <td class="paramtype"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a>&#160;</td>
 196           <td class="paramname"><em>marker</em>, </td>
 197         </tr>
 198         <tr>
 199           <td class="paramkey"></td>
 200           <td></td>
 201           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 202           <td class="paramname"><em>offset</em>&#160;</td>
 203         </tr>
 204         <tr>
 205           <td></td>
 206           <td>)</td>
 207           <td></td><td></td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211
 212 <p>fetch marker content 4-byte big endian Byte codes in file stream </p>
 213 <dl class="params"><dt>Parameters</dt><dd>
 214   <table class="params">
 215     <tr><td class="paramdir">[in]</td><td class="paramname">marker</td><td>marker structure </td></tr>
 216     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>start Byte position in marker </td></tr>
 217   </table>
 218   </dd>
 219 </dl>
 220 <dl class="section return"><dt>Returns</dt><dd>fetched code </dd></dl>
 221
 222 <p class="reference">References <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="codestream__manager_8c.html#aee603a657d0cf18f32e86bd2b2efdafe">fetch_codestream4bytebigendian()</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
 223
 224 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
 225
 226 </div>
 227 </div>
 228 <a id="aeba6604c55d20ce4dafca1c0bd8e1fbc"></a>
 229 <h2 class="memtitle"><span class="permalink"><a href="#aeba6604c55d20ce4dafca1c0bd8e1fbc">&#9670;&nbsp;</a></span>set_marker()</h2>
 230
 231 <div class="memitem">
 232 <div class="memproto">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname"><a class="el" href="marker__manager_8h.html#aa224fdf1390f864fa5766cfb7b70d8df">marker_param_t</a> set_marker </td>
 236           <td>(</td>
 237           <td class="paramtype"><a class="el" href="codestream__manager_8h.html#ae63fd7d7c047905a5cd0229f824aff09">codestream_param_t</a>&#160;</td>
 238           <td class="paramname"><em>cs</em>, </td>
 239         </tr>
 240         <tr>
 241           <td class="paramkey"></td>
 242           <td></td>
 243           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
 244           <td class="paramname"><em>code</em>, </td>
 245         </tr>
 246         <tr>
 247           <td class="paramkey"></td>
 248           <td></td>
 249           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td>
 250           <td class="paramname"><em>offset</em>, </td>
 251         </tr>
 252         <tr>
 253           <td class="paramkey"></td>
 254           <td></td>
 255           <td class="paramtype"><a class="el" href="byte__manager_8h.html#a633aa9ecff048e1b8bfbdac4c4dfdb33">Byte2_t</a>&#160;</td>
 256           <td class="paramname"><em>length</em>&#160;</td>
 257         </tr>
 258         <tr>
 259           <td></td>
 260           <td>)</td>
 261           <td></td><td></td>
 262         </tr>
 263       </table>
 264 </div><div class="memdoc">
 265
 266 <p>set marker parameters from inputs </p>
 267 <dl class="params"><dt>Parameters</dt><dd>
 268   <table class="params">
 269     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>marker code </td></tr>
 270     <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>marker code </td></tr>
 271     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>offset in the codestream </td></tr>
 272     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>marker segment length </td></tr>
 273   </table>
 274   </dd>
 275 </dl>
 276 <dl class="section return"><dt>Returns</dt><dd>structure of generated marker parameters </dd></dl>
 277
 278 <p class="reference">References <a class="el" href="structmarker__param.html#a631774a24ccb8eddb0fd3c71d99cb7fa">marker_param::code</a>, <a class="el" href="structmarker__param.html#ab4a936d6d175dbf0a0295a3ec86e16c6">marker_param::cs</a>, <a class="el" href="structmarker__param.html#a74f9dda8b061c37c77d4c99a16ae9f92">marker_param::length</a>, and <a class="el" href="structmarker__param.html#acb6fa042e8be6c79cb461a5f9bc74750">marker_param::offset</a>.</p>
 279
 280 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#a7e9ae91b6cde958c7857680290cce24e">set_CODmkrdata()</a>, and <a class="el" href="index__manager_8c.html#a4031ccd48358b64a1720c15cf87cc5ff">set_SIZmkrdata()</a>.</p>
 281
 282 </div>
 283 </div>
 284 </div><!-- contents -->
 285 <!-- start footer part -->
 286 <hr class="footer"/><address class="footer"><small>
 287 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 288 <img class="footer" src="doxygen.png" alt="doxygen"/>
 289 </a> 1.8.13
 290 </small></address>
 291 </body>
 292 </html>