doxygen/structbox__param.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: box_param Struct 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><!-- top -->
  40 <div class="header">
  41   <div class="summary">
  42 <a href="#pub-attribs">Data Fields</a>  </div>
  43   <div class="headertitle">
  44 <div class="title">box_param Struct Reference</div>  </div>
  45 </div><!--header-->
  46 <div class="contents">
  47
  48 <p>box parameters
  49  <a href="structbox__param.html#details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="box__manager_8h_source.html">box_manager.h</a>&gt;</code></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  54 Data Fields</h2></td></tr>
  55 <tr class="memitem:ab6a91091b8afeb3d5cea812a3c6b19a3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#ab6a91091b8afeb3d5cea812a3c6b19a3">fd</a></td></tr>
  56 <tr class="memdesc:ab6a91091b8afeb3d5cea812a3c6b19a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">file descriptor  <a href="#ab6a91091b8afeb3d5cea812a3c6b19a3">More...</a><br /></td></tr>
  57 <tr class="separator:ab6a91091b8afeb3d5cea812a3c6b19a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:a6ea7450cb7dad8229f9f80deeecb3653"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a6ea7450cb7dad8229f9f80deeecb3653">offset</a></td></tr>
  59 <tr class="memdesc:a6ea7450cb7dad8229f9f80deeecb3653"><td class="mdescLeft">&#160;</td><td class="mdescRight">byte position of the whole Box (LBox) in the file  <a href="#a6ea7450cb7dad8229f9f80deeecb3653">More...</a><br /></td></tr>
  60 <tr class="separator:a6ea7450cb7dad8229f9f80deeecb3653"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:aada29a9e2ee24be155b8a3dc3e3d2253"><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="structbox__param.html#aada29a9e2ee24be155b8a3dc3e3d2253">headlen</a></td></tr>
  62 <tr class="memdesc:aada29a9e2ee24be155b8a3dc3e3d2253"><td class="mdescLeft">&#160;</td><td class="mdescRight">header length 8 or 16  <a href="#aada29a9e2ee24be155b8a3dc3e3d2253">More...</a><br /></td></tr>
  63 <tr class="separator:aada29a9e2ee24be155b8a3dc3e3d2253"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <tr class="memitem:a3f675a72aeb95c732b88ab45e8446a4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a3f675a72aeb95c732b88ab45e8446a4e">length</a></td></tr>
  65 <tr class="memdesc:a3f675a72aeb95c732b88ab45e8446a4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">length of the whole Box  <a href="#a3f675a72aeb95c732b88ab45e8446a4e">More...</a><br /></td></tr>
  66 <tr class="separator:a3f675a72aeb95c732b88ab45e8446a4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:a24767e2a946d939983ba55efa8fdfb7a"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a24767e2a946d939983ba55efa8fdfb7a">type</a> [4]</td></tr>
  68 <tr class="memdesc:a24767e2a946d939983ba55efa8fdfb7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">type of information in the DBox  <a href="#a24767e2a946d939983ba55efa8fdfb7a">More...</a><br /></td></tr>
  69 <tr class="separator:a24767e2a946d939983ba55efa8fdfb7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:a8d5dba02e64d6c60e2805ee5c62c2d41"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structbox__param.html">box_param</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a8d5dba02e64d6c60e2805ee5c62c2d41">next</a></td></tr>
  71 <tr class="memdesc:a8d5dba02e64d6c60e2805ee5c62c2d41"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the next box  <a href="#a8d5dba02e64d6c60e2805ee5c62c2d41">More...</a><br /></td></tr>
  72 <tr class="separator:a8d5dba02e64d6c60e2805ee5c62c2d41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 </table>
  74 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  75 <div class="textblock"><p>box parameters </p>
  76 </div><h2 class="groupheader">Field Documentation</h2>
  77 <a id="ab6a91091b8afeb3d5cea812a3c6b19a3"></a>
  78 <h2 class="memtitle"><span class="permalink"><a href="#ab6a91091b8afeb3d5cea812a3c6b19a3">&#9670;&nbsp;</a></span>fd</h2>
  79
  80 <div class="memitem">
  81 <div class="memproto">
  82       <table class="memname">
  83         <tr>
  84           <td class="memname">int box_param::fd</td>
  85         </tr>
  86       </table>
  87 </div><div class="memdoc">
  88
  89 <p>file descriptor </p>
  90
  91 <p class="reference">Referenced by <a class="el" href="metadata__manager_8h.html#a03c8182628aa31f07dbca72fe966676a">const_metadatalist()</a>, <a class="el" href="box__manager_8h.html#ac907241542ef0cd6e13deafffde74363">fetch_DBox1byte()</a>, <a class="el" href="box__manager_8h.html#a28a029e965842146cac12fcf05757c66">fetch_DBox2bytebigendian()</a>, <a class="el" href="box__manager_8h.html#a1f18b967d9b8fd83fa70a6580ce9ab53">fetch_DBox4bytebigendian()</a>, <a class="el" href="box__manager_8h.html#a46342c34b100e9174966f70bf36936ef">fetch_DBox8bytebigendian()</a>, <a class="el" href="box__manager_8h.html#a0dcfa6897f3fd71d6336671a2a5b7e07">fetch_DBoxbytes()</a>, <a class="el" href="box__manager_8h.html#a7775b0d45b5e84a6d59ca1477ee0088c">fetch_headbytes()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#a748c2d73b85353a96c1f59feebed6eb2">gene_childboxbyOffset()</a>, <a class="el" href="box__manager_8h.html#a10d0b1c901f1ac161305c2b5b45aca5e">gene_childboxbyType()</a>, <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>, <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, <a class="el" href="index__manager_8c.html#a1050f654e8e86c3b4a72fb30dc8b034a">set_cptrdata()</a>, <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>, and <a class="el" href="index__manager_8c.html#ab16c783f41458fea838b5a8ebd892798">set_tpixdata()</a>.</p>
  92
  93 </div>
  94 </div>
  95 <a id="aada29a9e2ee24be155b8a3dc3e3d2253"></a>
  96 <h2 class="memtitle"><span class="permalink"><a href="#aada29a9e2ee24be155b8a3dc3e3d2253">&#9670;&nbsp;</a></span>headlen</h2>
  97
  98 <div class="memitem">
  99 <div class="memproto">
 100       <table class="memname">
 101         <tr>
 102           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> box_param::headlen</td>
 103         </tr>
 104       </table>
 105 </div><div class="memdoc">
 106
 107 <p>header length 8 or 16 </p>
 108
 109 <p class="reference">Referenced by <a class="el" href="box__manager_8h.html#a7775b0d45b5e84a6d59ca1477ee0088c">fetch_headbytes()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="placeholder__manager_8h.html#ab98bea9b6be61f2e65a04df5745d9eb7">gene_placeholder()</a>, <a class="el" href="box__manager_8h.html#a177899ef17695f68a34abaff3795175c">get_DBoxlen()</a>, <a class="el" href="box__manager_8h.html#aa6d6dd0304ffedcb0c67ef23cf62e38a">get_DBoxoff()</a>, and <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</a>.</p>
 110
 111 </div>
 112 </div>
 113 <a id="a3f675a72aeb95c732b88ab45e8446a4e"></a>
 114 <h2 class="memtitle"><span class="permalink"><a href="#a3f675a72aeb95c732b88ab45e8446a4e">&#9670;&nbsp;</a></span>length</h2>
 115
 116 <div class="memitem">
 117 <div class="memproto">
 118       <table class="memname">
 119         <tr>
 120           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> box_param::length</td>
 121         </tr>
 122       </table>
 123 </div><div class="memdoc">
 124
 125 <p>length of the whole Box </p>
 126
 127 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#a0c5e97f8df3073b59d319c237844d3fd">get_boxstructure()</a>, <a class="el" href="box__manager_8h.html#a177899ef17695f68a34abaff3795175c">get_DBoxlen()</a>, <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
 128
 129 </div>
 130 </div>
 131 <a id="a8d5dba02e64d6c60e2805ee5c62c2d41"></a>
 132 <h2 class="memtitle"><span class="permalink"><a href="#a8d5dba02e64d6c60e2805ee5c62c2d41">&#9670;&nbsp;</a></span>next</h2>
 133
 134 <div class="memitem">
 135 <div class="memproto">
 136       <table class="memname">
 137         <tr>
 138           <td class="memname">struct <a class="el" href="structbox__param.html">box_param</a>* box_param::next</td>
 139         </tr>
 140       </table>
 141 </div><div class="memdoc">
 142
 143 <p>pointer to the next box </p>
 144
 145 <p class="reference">Referenced by <a class="el" href="metadata__manager_8h.html#a03c8182628aa31f07dbca72fe966676a">const_metadatalist()</a>, <a class="el" href="box__manager_8h.html#a77ada7ec552ad6aecf1de5ecb1ec27bb">delete_box_in_list()</a>, <a class="el" href="box__manager_8h.html#ad72e15be902a7c0cdfee23468250fff5">delete_boxlist()</a>, <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#af1cdc6e87a93954e92d8e481208895d4">insert_box_into_list()</a>, <a class="el" href="box__manager_8h.html#a29a36ad1d80050083acd21c1131eea59">print_allbox()</a>, <a class="el" href="box__manager_8h.html#ad9d347a84614e1e2bfd4464f22fbd2c5">search_box()</a>, and <a class="el" href="metadata__manager_8h.html#a17ebaeb53c239a6b5e0d8f77ea88ffac">search_metadataidx()</a>.</p>
 146
 147 </div>
 148 </div>
 149 <a id="a6ea7450cb7dad8229f9f80deeecb3653"></a>
 150 <h2 class="memtitle"><span class="permalink"><a href="#a6ea7450cb7dad8229f9f80deeecb3653">&#9670;&nbsp;</a></span>offset</h2>
 151
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> box_param::offset</td>
 157         </tr>
 158       </table>
 159 </div><div class="memdoc">
 160
 161 <p>byte position of the whole Box (LBox) in the file </p>
 162
 163 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="box__manager_8h.html#a7775b0d45b5e84a6d59ca1477ee0088c">fetch_headbytes()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#aa6d6dd0304ffedcb0c67ef23cf62e38a">get_DBoxoff()</a>, <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
 164
 165 </div>
 166 </div>
 167 <a id="a24767e2a946d939983ba55efa8fdfb7a"></a>
 168 <h2 class="memtitle"><span class="permalink"><a href="#a24767e2a946d939983ba55efa8fdfb7a">&#9670;&nbsp;</a></span>type</h2>
 169
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">char box_param::type[4]</td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178
 179 <p>type of information in the DBox </p>
 180
 181 <p class="reference">Referenced by <a class="el" href="metadata__manager_8h.html#a03c8182628aa31f07dbca72fe966676a">const_metadatalist()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</a>, <a class="el" href="box__manager_8h.html#ad9d347a84614e1e2bfd4464f22fbd2c5">search_box()</a>, and <a class="el" href="metadata__manager_8h.html#a17ebaeb53c239a6b5e0d8f77ea88ffac">search_metadataidx()</a>.</p>
 182
 183 </div>
 184 </div>
 185 <hr/>The documentation for this struct was generated from the following file:<ul>
 186 <li><a class="el" href="box__manager_8h_source.html">box_manager.h</a></li>
 187 </ul>
 188 </div><!-- contents -->
 189 <!-- start footer part -->
 190 <hr class="footer"/><address class="footer"><small>
 191 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 192 <img class="footer" src="doxygen.png" alt="doxygen"/>
 193 </a> 1.8.13
 194 </small></address>
 195 </body>
 196 </html>