doxygen/group___r_a_w.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: RAW - Implementation of operations for raw encoding</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.1.2</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><a href="files.html"><span>Files</span></a></li>
  37     </ul>
  38   </div>
  39 </div><!-- top -->
  40 <div class="header">
  41   <div class="summary">
  42 <a href="#nested-classes">Data Structures</a> &#124;
  43 <a href="#typedef-members">Typedefs</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">RAW - Implementation of operations for raw encoding</div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  50 Data Structures</h2></td></tr>
  51 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__raw.html">opj_raw</a></td></tr>
  52 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RAW encoding operations.  <a href="structopj__raw.html#details">More...</a><br /></td></tr>
  53 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54 </table><table class="memberdecls">
  55 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  56 Typedefs</h2></td></tr>
  57 <tr class="memitem:ga64fe20ef13d830dd1611487c8d6c6832"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__raw.html">opj_raw</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a></td></tr>
  58 <tr class="memdesc:ga64fe20ef13d830dd1611487c8d6c6832"><td class="mdescLeft">&#160;</td><td class="mdescRight">RAW encoding operations.  <a href="#ga64fe20ef13d830dd1611487c8d6c6832">More...</a><br /></td></tr>
  59 <tr class="separator:ga64fe20ef13d830dd1611487c8d6c6832"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 </table><table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  62 Exported functions</h2></td></tr>
  63 <tr class="memitem:ga84d58773379209bf64c3e48e0d174670"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#ga84d58773379209bf64c3e48e0d174670">opj_raw_create</a> (void)</td></tr>
  64 <tr class="memdesc:ga84d58773379209bf64c3e48e0d174670"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new RAW handle.  <a href="#ga84d58773379209bf64c3e48e0d174670">More...</a><br /></td></tr>
  65 <tr class="separator:ga84d58773379209bf64c3e48e0d174670"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:gabb2f5b65ad948ccccf595df86d0e305d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gabb2f5b65ad948ccccf595df86d0e305d">opj_raw_destroy</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
  67 <tr class="memdesc:gabb2f5b65ad948ccccf595df86d0e305d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a previously created RAW handle.  <a href="#gabb2f5b65ad948ccccf595df86d0e305d">More...</a><br /></td></tr>
  68 <tr class="separator:gabb2f5b65ad948ccccf595df86d0e305d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:gaee1cb91b1c5183234a36f53e0624f733"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaee1cb91b1c5183234a36f53e0624f733">opj_raw_numbytes</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
  70 <tr class="memdesc:gaee1cb91b1c5183234a36f53e0624f733"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of bytes written/read since initialisation.  <a href="#gaee1cb91b1c5183234a36f53e0624f733">More...</a><br /></td></tr>
  71 <tr class="separator:gaee1cb91b1c5183234a36f53e0624f733"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:gaebd3e67e3b8673e4e4c3fa1834406389"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw, <a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *bp, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> len)</td></tr>
  73 <tr class="memdesc:gaebd3e67e3b8673e4e4c3fa1834406389"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the decoder.  <a href="#gaebd3e67e3b8673e4e4c3fa1834406389">More...</a><br /></td></tr>
  74 <tr class="separator:gaebd3e67e3b8673e4e4c3fa1834406389"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:gaa4e879e1d733e459b94c29141b7df142"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode</a> (<a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *raw)</td></tr>
  76 <tr class="memdesc:gaa4e879e1d733e459b94c29141b7df142"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode a symbol using raw-decoder.  <a href="#gaa4e879e1d733e459b94c29141b7df142">More...</a><br /></td></tr>
  77 <tr class="separator:gaa4e879e1d733e459b94c29141b7df142"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 </table>
  79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80 <h2 class="groupheader">Typedef Documentation</h2>
  81 <a class="anchor" id="ga64fe20ef13d830dd1611487c8d6c6832"></a>
  82 <div class="memitem">
  83 <div class="memproto">
  84       <table class="memname">
  85         <tr>
  86           <td class="memname">typedef struct <a class="el" href="structopj__raw.html">opj_raw</a>  <a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a></td>
  87         </tr>
  88       </table>
  89 </div><div class="memdoc">
  90
  91 <p>RAW encoding operations. </p>
  92
  93 </div>
  94 </div>
  95 <h2 class="groupheader">Function Documentation</h2>
  96 <a class="anchor" id="ga84d58773379209bf64c3e48e0d174670"></a>
  97 <div class="memitem">
  98 <div class="memproto">
  99       <table class="memname">
 100         <tr>
 101           <td class="memname"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a>* opj_raw_create </td>
 102           <td>(</td>
 103           <td class="paramtype">void&#160;</td>
 104           <td class="paramname"></td><td>)</td>
 105           <td></td>
 106         </tr>
 107       </table>
 108 </div><div class="memdoc">
 109
 110 <p>Create a new RAW handle. </p>
 111 <dl class="section return"><dt>Returns</dt><dd>Returns a new RAW handle if successful, returns NULL otherwise </dd></dl>
 112
 113 <p>References <a class="el" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc()</a>.</p>
 114
 115 <p>Referenced by <a class="el" href="group___t1.html#ga7f1a52a233804744f2c7384ac04117f8">opj_t1_create()</a>.</p>
 116
 117 </div>
 118 </div>
 119 <a class="anchor" id="gaa4e879e1d733e459b94c29141b7df142"></a>
 120 <div class="memitem">
 121 <div class="memproto">
 122       <table class="memname">
 123         <tr>
 124           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw_decode </td>
 125           <td>(</td>
 126           <td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
 127           <td class="paramname"><em>raw</em></td><td>)</td>
 128           <td></td>
 129         </tr>
 130       </table>
 131 </div><div class="memdoc">
 132
 133 <p>Decode a symbol using raw-decoder. </p>
 134 <p>Cfr p.506 TAUBMAN </p><dl class="params"><dt>Parameters</dt><dd>
 135   <table class="params">
 136     <tr><td class="paramname">raw</td><td>RAW handle </td></tr>
 137   </table>
 138   </dd>
 139 </dl>
 140 <dl class="section return"><dt>Returns</dt><dd>Returns the decoded symbol (0 or 1) </dd></dl>
 141
 142 <p>References <a class="el" href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">opj_raw::c</a>, <a class="el" href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed">opj_raw::ct</a>, <a class="el" href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf">opj_raw::len</a>, <a class="el" href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73">opj_raw::lenmax</a>, and <a class="el" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</a>.</p>
 143
 144 <p>Referenced by <a class="el" href="group___t1.html#gac10f219c32faf19a1b5cdf62ef54ad33">opj_t1_dec_refpass_step_raw()</a>, and <a class="el" href="group___t1.html#gad7b4fc8f0264a0a1eebc5020986789d7">opj_t1_dec_sigpass_step_raw()</a>.</p>
 145
 146 </div>
 147 </div>
 148 <a class="anchor" id="gabb2f5b65ad948ccccf595df86d0e305d"></a>
 149 <div class="memitem">
 150 <div class="memproto">
 151       <table class="memname">
 152         <tr>
 153           <td class="memname">void opj_raw_destroy </td>
 154           <td>(</td>
 155           <td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
 156           <td class="paramname"><em>raw</em></td><td>)</td>
 157           <td></td>
 158         </tr>
 159       </table>
 160 </div><div class="memdoc">
 161
 162 <p>Destroy a previously created RAW handle. </p>
 163 <dl class="params"><dt>Parameters</dt><dd>
 164   <table class="params">
 165     <tr><td class="paramname">raw</td><td>RAW handle to destroy </td></tr>
 166   </table>
 167   </dd>
 168 </dl>
 169
 170 <p>References <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>.</p>
 171
 172 <p>Referenced by <a class="el" href="group___t1.html#gadbc87000940d2fc0c5f3e2f0ad28938a">opj_t1_destroy()</a>.</p>
 173
 174 </div>
 175 </div>
 176 <a class="anchor" id="gaebd3e67e3b8673e4e4c3fa1834406389"></a>
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">void opj_raw_init_dec </td>
 182           <td>(</td>
 183           <td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
 184           <td class="paramname"><em>raw</em>, </td>
 185         </tr>
 186         <tr>
 187           <td class="paramkey"></td>
 188           <td></td>
 189           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td>
 190           <td class="paramname"><em>bp</em>, </td>
 191         </tr>
 192         <tr>
 193           <td class="paramkey"></td>
 194           <td></td>
 195           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 196           <td class="paramname"><em>len</em>&#160;</td>
 197         </tr>
 198         <tr>
 199           <td></td>
 200           <td>)</td>
 201           <td></td><td></td>
 202         </tr>
 203       </table>
 204 </div><div class="memdoc">
 205
 206 <p>Initialize the decoder. </p>
 207 <dl class="params"><dt>Parameters</dt><dd>
 208   <table class="params">
 209     <tr><td class="paramname">raw</td><td>RAW handle </td></tr>
 210     <tr><td class="paramname">bp</td><td>Pointer to the start of the buffer from which the bytes will be read </td></tr>
 211     <tr><td class="paramname">len</td><td>Length of the input buffer </td></tr>
 212   </table>
 213   </dd>
 214 </dl>
 215
 216 <p>References <a class="el" href="structopj__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">opj_raw::c</a>, <a class="el" href="structopj__raw.html#afb86b09eef74471031c6d4144e4951ed">opj_raw::ct</a>, <a class="el" href="structopj__raw.html#a49edd2e5113c2727bebb56937c0811bf">opj_raw::len</a>, <a class="el" href="structopj__raw.html#a37d9f82ef382e011692f6d03e2be1b73">opj_raw::lenmax</a>, and <a class="el" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</a>.</p>
 217
 218 <p>Referenced by <a class="el" href="group___t1.html#gac0eda7cad23045baec567ddbe0a4da3f">opj_t1_decode_cblk()</a>.</p>
 219
 220 </div>
 221 </div>
 222 <a class="anchor" id="gaee1cb91b1c5183234a36f53e0624f733"></a>
 223 <div class="memitem">
 224 <div class="memproto">
 225       <table class="memname">
 226         <tr>
 227           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw_numbytes </td>
 228           <td>(</td>
 229           <td class="paramtype"><a class="el" href="group___r_a_w.html#ga64fe20ef13d830dd1611487c8d6c6832">opj_raw_t</a> *&#160;</td>
 230           <td class="paramname"><em>raw</em></td><td>)</td>
 231           <td></td>
 232         </tr>
 233       </table>
 234 </div><div class="memdoc">
 235
 236 <p>Return the number of bytes written/read since initialisation. </p>
 237 <dl class="params"><dt>Parameters</dt><dd>
 238   <table class="params">
 239     <tr><td class="paramname">raw</td><td>RAW handle to destroy </td></tr>
 240   </table>
 241   </dd>
 242 </dl>
 243 <dl class="section return"><dt>Returns</dt><dd>Returns the number of bytes already encoded </dd></dl>
 244
 245 <p>References <a class="el" href="structopj__raw.html#a873ec3b4abf06832cb492f1fe0f9dde9">opj_raw::bp</a>, and <a class="el" href="structopj__raw.html#ab135fadf2a1c829503331c3bf909496f">opj_raw::start</a>.</p>
 246
 247 </div>
 248 </div>
 249 </div><!-- contents -->
 250 <!-- start footer part -->
 251 <hr class="footer"/><address class="footer"><small>
 252 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 253 <img class="footer" src="doxygen.png" alt="doxygen"/>
 254 </a> 1.8.10
 255 </small></address>
 256 </body>
 257 </html>