doxygen/structopj__stream__private.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>OpenJPEG: opj_stream_private 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.5.0</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.17 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#pub-attribs">Data Fields</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">opj_stream_private Struct Reference</div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48
  49 <p>Byte input-output stream.
  50  <a href="structopj__stream__private.html#details">More...</a></p>
  51
  52 <p><code>#include &lt;<a class="el" href="cio_8h_source.html">cio.h</a>&gt;</code></p>
  53 <table class="memberdecls">
  54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  55 Data Fields</h2></td></tr>
  56 <tr class="memitem:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a326f2fe5dc1fccce2788bf09ddf4931c">m_user_data</a></td></tr>
  57 <tr class="memdesc:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data, be it files, ...  <a href="structopj__stream__private.html#a326f2fe5dc1fccce2788bf09ddf4931c">More...</a><br /></td></tr>
  58 <tr class="separator:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 <tr class="memitem:a262bea0d39f7c5a0bd5ef07434e38723"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a0647bc8a4688ee69cd35ff71bc43145f">opj_stream_free_user_data_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a262bea0d39f7c5a0bd5ef07434e38723">m_free_user_data_fn</a></td></tr>
  60 <tr class="memdesc:a262bea0d39f7c5a0bd5ef07434e38723"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to function to free m_user_data (NULL at initialization) when destroying the stream.  <a href="structopj__stream__private.html#a262bea0d39f7c5a0bd5ef07434e38723">More...</a><br /></td></tr>
  61 <tr class="separator:a262bea0d39f7c5a0bd5ef07434e38723"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 <tr class="memitem:a53cb7b3992a382231554bdc73cb0c7bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a53cb7b3992a382231554bdc73cb0c7bd">m_user_data_length</a></td></tr>
  63 <tr class="memdesc:a53cb7b3992a382231554bdc73cb0c7bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data length.  <a href="structopj__stream__private.html#a53cb7b3992a382231554bdc73cb0c7bd">More...</a><br /></td></tr>
  64 <tr class="separator:a53cb7b3992a382231554bdc73cb0c7bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:acce2d2187feff70fa3057b0439591f76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a8bb2e4d69989824fee3edc53370726a6">opj_stream_read_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#acce2d2187feff70fa3057b0439591f76">m_read_fn</a></td></tr>
  66 <tr class="memdesc:acce2d2187feff70fa3057b0439591f76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual read function (NULL at the initialization of the cio.  <a href="structopj__stream__private.html#acce2d2187feff70fa3057b0439591f76">More...</a><br /></td></tr>
  67 <tr class="separator:acce2d2187feff70fa3057b0439591f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a5a43391a5d2fd7b09c6f1957b9ad0337">opj_stream_write_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#aacd57b4e429ddf5ca3a4913a2f963d6a">m_write_fn</a></td></tr>
  69 <tr class="memdesc:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual write function (NULL at the initialization of the cio.  <a href="structopj__stream__private.html#aacd57b4e429ddf5ca3a4913a2f963d6a">More...</a><br /></td></tr>
  70 <tr class="separator:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a2ca719761a9cd88dc350486e38b41790"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ae8918d618c0a2fe1447f70f036e4afd8">opj_stream_skip_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a2ca719761a9cd88dc350486e38b41790">m_skip_fn</a></td></tr>
  72 <tr class="memdesc:a2ca719761a9cd88dc350486e38b41790"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual skip function (NULL at the initialization of the cio.  <a href="structopj__stream__private.html#a2ca719761a9cd88dc350486e38b41790">More...</a><br /></td></tr>
  73 <tr class="separator:a2ca719761a9cd88dc350486e38b41790"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:adab26f9f0a32253aefdce763331c641a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a27083300f8491e805c4b7e3f3abe245c">opj_stream_seek_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#adab26f9f0a32253aefdce763331c641a">m_seek_fn</a></td></tr>
  75 <tr class="memdesc:adab26f9f0a32253aefdce763331c641a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual seek function (if available).  <a href="structopj__stream__private.html#adab26f9f0a32253aefdce763331c641a">More...</a><br /></td></tr>
  76 <tr class="separator:adab26f9f0a32253aefdce763331c641a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:aca072a59b683dc106263ba04d3c28577"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#aca072a59b683dc106263ba04d3c28577">m_stored_data</a></td></tr>
  78 <tr class="memdesc:aca072a59b683dc106263ba04d3c28577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Actual data stored into the stream if read from.  <a href="structopj__stream__private.html#aca072a59b683dc106263ba04d3c28577">More...</a><br /></td></tr>
  79 <tr class="separator:aca072a59b683dc106263ba04d3c28577"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a954a54c078a817c3eeffd66b45419cfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a954a54c078a817c3eeffd66b45419cfc">m_current_data</a></td></tr>
  81 <tr class="memdesc:a954a54c078a817c3eeffd66b45419cfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the current read data.  <a href="structopj__stream__private.html#a954a54c078a817c3eeffd66b45419cfc">More...</a><br /></td></tr>
  82 <tr class="separator:a954a54c078a817c3eeffd66b45419cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:a2a6abddd3fd66514df26494a1d7a0090"><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="structopj__stream__private.html#a2a6abddd3fd66514df26494a1d7a0090">m_opj_skip</a> )(struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td></tr>
  84 <tr class="memdesc:a2a6abddd3fd66514df26494a1d7a0090"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="structopj__stream__private.html#a2a6abddd3fd66514df26494a1d7a0090">More...</a><br /></td></tr>
  85 <tr class="separator:a2a6abddd3fd66514df26494a1d7a0090"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a7cb7f7bab15475f5547f684049c41cf7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a7cb7f7bab15475f5547f684049c41cf7">m_opj_seek</a> )(struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td></tr>
  87 <tr class="memdesc:a7cb7f7bab15475f5547f684049c41cf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="structopj__stream__private.html#a7cb7f7bab15475f5547f684049c41cf7">More...</a><br /></td></tr>
  88 <tr class="separator:a7cb7f7bab15475f5547f684049c41cf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a8bbf688a608e52a52d1cf89c7103ac5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a8bbf688a608e52a52d1cf89c7103ac5b">m_bytes_in_buffer</a></td></tr>
  90 <tr class="memdesc:a8bbf688a608e52a52d1cf89c7103ac5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of bytes containing in the buffer.  <a href="structopj__stream__private.html#a8bbf688a608e52a52d1cf89c7103ac5b">More...</a><br /></td></tr>
  91 <tr class="separator:a8bbf688a608e52a52d1cf89c7103ac5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a5c0c669ab30776a58afc458b7f33a75b"><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="structopj__stream__private.html#a5c0c669ab30776a58afc458b7f33a75b">m_byte_offset</a></td></tr>
  93 <tr class="memdesc:a5c0c669ab30776a58afc458b7f33a75b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of bytes read/written from the beginning of the stream.  <a href="structopj__stream__private.html#a5c0c669ab30776a58afc458b7f33a75b">More...</a><br /></td></tr>
  94 <tr class="separator:a5c0c669ab30776a58afc458b7f33a75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 <tr class="memitem:a83e54b51fe859e0aa93ebf292edf054c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a83e54b51fe859e0aa93ebf292edf054c">m_buffer_size</a></td></tr>
  96 <tr class="memdesc:a83e54b51fe859e0aa93ebf292edf054c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the buffer.  <a href="structopj__stream__private.html#a83e54b51fe859e0aa93ebf292edf054c">More...</a><br /></td></tr>
  97 <tr class="separator:a83e54b51fe859e0aa93ebf292edf054c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:ac2b84e72997fde0bf510faf6c8df5798"><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="structopj__stream__private.html#ac2b84e72997fde0bf510faf6c8df5798">m_status</a></td></tr>
  99 <tr class="memdesc:ac2b84e72997fde0bf510faf6c8df5798"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags to tell the status of the stream.  <a href="structopj__stream__private.html#ac2b84e72997fde0bf510faf6c8df5798">More...</a><br /></td></tr>
 100 <tr class="separator:ac2b84e72997fde0bf510faf6c8df5798"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 </table>
 102 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 103 <div class="textblock"><p>Byte input-output stream. </p>
 104 </div><h2 class="groupheader">Field Documentation</h2>
 105 <a id="a83e54b51fe859e0aa93ebf292edf054c"></a>
 106 <h2 class="memtitle"><span class="permalink"><a href="#a83e54b51fe859e0aa93ebf292edf054c">&#9670;&nbsp;</a></span>m_buffer_size</h2>
 107
 108 <div class="memitem">
 109 <div class="memproto">
 110       <table class="memname">
 111         <tr>
 112           <td class="memname"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> opj_stream_private::m_buffer_size</td>
 113         </tr>
 114       </table>
 115 </div><div class="memdoc">
 116
 117 <p>The size of the buffer. </p>
 118
 119 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, and <a class="el" href="cio_8h.html#a8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>.</p>
 120
 121 </div>
 122 </div>
 123 <a id="a5c0c669ab30776a58afc458b7f33a75b"></a>
 124 <h2 class="memtitle"><span class="permalink"><a href="#a5c0c669ab30776a58afc458b7f33a75b">&#9670;&nbsp;</a></span>m_byte_offset</h2>
 125
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_stream_private::m_byte_offset</td>
 131         </tr>
 132       </table>
 133 </div><div class="memdoc">
 134
 135 <p>The number of bytes read/written from the beginning of the stream. </p>
 136
 137 <p class="reference">Referenced by <a class="el" href="cio_8h.html#aec7225a845169469fd1aa8db2a3fac9e">opj_stream_get_number_byte_left()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="cio_8h.html#a5c59a39f3664f9deb654c269153c600a">opj_stream_tell()</a>, <a class="el" href="cio_8h.html#a8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>, and <a class="el" href="cio_8h.html#a9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
 138
 139 </div>
 140 </div>
 141 <a id="a8bbf688a608e52a52d1cf89c7103ac5b"></a>
 142 <h2 class="memtitle"><span class="permalink"><a href="#a8bbf688a608e52a52d1cf89c7103ac5b">&#9670;&nbsp;</a></span>m_bytes_in_buffer</h2>
 143
 144 <div class="memitem">
 145 <div class="memproto">
 146       <table class="memname">
 147         <tr>
 148           <td class="memname"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> opj_stream_private::m_bytes_in_buffer</td>
 149         </tr>
 150       </table>
 151 </div><div class="memdoc">
 152
 153 <p>number of bytes containing in the buffer. </p>
 154
 155 <p class="reference">Referenced by <a class="el" href="cio_8h.html#a3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="cio_8h.html#a8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>, and <a class="el" href="cio_8h.html#a9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
 156
 157 </div>
 158 </div>
 159 <a id="a954a54c078a817c3eeffd66b45419cfc"></a>
 160 <h2 class="memtitle"><span class="permalink"><a href="#a954a54c078a817c3eeffd66b45419cfc">&#9670;&nbsp;</a></span>m_current_data</h2>
 161
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_stream_private::m_current_data</td>
 167         </tr>
 168       </table>
 169 </div><div class="memdoc">
 170
 171 <p>Pointer to the current read data. </p>
 172
 173 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#a3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="cio_8h.html#a8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, and <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>.</p>
 174
 175 </div>
 176 </div>
 177 <a id="a262bea0d39f7c5a0bd5ef07434e38723"></a>
 178 <h2 class="memtitle"><span class="permalink"><a href="#a262bea0d39f7c5a0bd5ef07434e38723">&#9670;&nbsp;</a></span>m_free_user_data_fn</h2>
 179
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname"><a class="el" href="openjpeg_8h.html#a0647bc8a4688ee69cd35ff71bc43145f">opj_stream_free_user_data_fn</a> opj_stream_private::m_free_user_data_fn</td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 <p>Pointer to function to free m_user_data (NULL at initialization) when destroying the stream. </p>
 190 <p>If pointer is NULL the function is not called and the m_user_data is not freed (even if non-NULL). </p>
 191
 192 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a0703208df785be60460eb83c5d40b10f">opj_stream_destroy()</a>, and <a class="el" href="openjpeg_8h.html#a6cd79f0336b039391ffd67cddca0ac67">opj_stream_set_user_data()</a>.</p>
 193
 194 </div>
 195 </div>
 196 <a id="a7cb7f7bab15475f5547f684049c41cf7"></a>
 197 <h2 class="memtitle"><span class="permalink"><a href="#a7cb7f7bab15475f5547f684049c41cf7">&#9670;&nbsp;</a></span>m_opj_seek</h2>
 198
 199 <div class="memitem">
 200 <div class="memproto">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>(* opj_stream_private::m_opj_seek) (struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td>
 204         </tr>
 205       </table>
 206 </div><div class="memdoc">
 207
 208 <p>FIXME DOC. </p>
 209
 210 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, and <a class="el" href="cio_8h.html#a9061d0624a17af80b74e1a114b0c7f06">opj_stream_seek()</a>.</p>
 211
 212 </div>
 213 </div>
 214 <a id="a2a6abddd3fd66514df26494a1d7a0090"></a>
 215 <h2 class="memtitle"><span class="permalink"><a href="#a2a6abddd3fd66514df26494a1d7a0090">&#9670;&nbsp;</a></span>m_opj_skip</h2>
 216
 217 <div class="memitem">
 218 <div class="memproto">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>(* opj_stream_private::m_opj_skip) (struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>FIXME DOC. </p>
 227
 228 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, and <a class="el" href="cio_8h.html#a8a8ab9c9e1ccdc20a6dd2a2925a3f8c0">opj_stream_skip()</a>.</p>
 229
 230 </div>
 231 </div>
 232 <a id="acce2d2187feff70fa3057b0439591f76"></a>
 233 <h2 class="memtitle"><span class="permalink"><a href="#acce2d2187feff70fa3057b0439591f76">&#9670;&nbsp;</a></span>m_read_fn</h2>
 234
 235 <div class="memitem">
 236 <div class="memproto">
 237       <table class="memname">
 238         <tr>
 239           <td class="memname"><a class="el" href="openjpeg_8h.html#a8bb2e4d69989824fee3edc53370726a6">opj_stream_read_fn</a> opj_stream_private::m_read_fn</td>
 240         </tr>
 241       </table>
 242 </div><div class="memdoc">
 243
 244 <p>Pointer to actual read function (NULL at the initialization of the cio. </p>
 245
 246 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, and <a class="el" href="openjpeg_8h.html#a32646f57f2e8450e57165d085dadb8c8">opj_stream_set_read_function()</a>.</p>
 247
 248 </div>
 249 </div>
 250 <a id="adab26f9f0a32253aefdce763331c641a"></a>
 251 <h2 class="memtitle"><span class="permalink"><a href="#adab26f9f0a32253aefdce763331c641a">&#9670;&nbsp;</a></span>m_seek_fn</h2>
 252
 253 <div class="memitem">
 254 <div class="memproto">
 255       <table class="memname">
 256         <tr>
 257           <td class="memname"><a class="el" href="openjpeg_8h.html#a27083300f8491e805c4b7e3f3abe245c">opj_stream_seek_fn</a> opj_stream_private::m_seek_fn</td>
 258         </tr>
 259       </table>
 260 </div><div class="memdoc">
 261
 262 <p>Pointer to actual seek function (if available). </p>
 263
 264 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#ae456419611db729983d8ca337e3f3293">opj_stream_has_seek()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="openjpeg_8h.html#abad6efc7d4b7a75b2223bef8a444ccb4">opj_stream_set_seek_function()</a>, and <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>.</p>
 265
 266 </div>
 267 </div>
 268 <a id="a2ca719761a9cd88dc350486e38b41790"></a>
 269 <h2 class="memtitle"><span class="permalink"><a href="#a2ca719761a9cd88dc350486e38b41790">&#9670;&nbsp;</a></span>m_skip_fn</h2>
 270
 271 <div class="memitem">
 272 <div class="memproto">
 273       <table class="memname">
 274         <tr>
 275           <td class="memname"><a class="el" href="openjpeg_8h.html#ae8918d618c0a2fe1447f70f036e4afd8">opj_stream_skip_fn</a> opj_stream_private::m_skip_fn</td>
 276         </tr>
 277       </table>
 278 </div><div class="memdoc">
 279
 280 <p>Pointer to actual skip function (NULL at the initialization of the cio. </p>
 281 <p>There is no seek function to prevent from back and forth slow procedures. </p>
 282
 283 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="openjpeg_8h.html#aecb87205464e2f2e90e4a2458f0bbcd5">opj_stream_set_skip_function()</a>, and <a class="el" href="cio_8h.html#a9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
 284
 285 </div>
 286 </div>
 287 <a id="ac2b84e72997fde0bf510faf6c8df5798"></a>
 288 <h2 class="memtitle"><span class="permalink"><a href="#ac2b84e72997fde0bf510faf6c8df5798">&#9670;&nbsp;</a></span>m_status</h2>
 289
 290 <div class="memitem">
 291 <div class="memproto">
 292       <table class="memname">
 293         <tr>
 294           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_stream_private::m_status</td>
 295         </tr>
 296       </table>
 297 </div><div class="memdoc">
 298
 299 <p>Flags to tell the status of the stream. </p>
 300 <p>Used with OPJ_STREAM_STATUS_* defines. </p>
 301
 302 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#a3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="openjpeg_8h.html#a32646f57f2e8450e57165d085dadb8c8">opj_stream_set_read_function()</a>, <a class="el" href="openjpeg_8h.html#a5d196d304c431d2c1d462397976aa763">opj_stream_set_write_function()</a>, <a class="el" href="cio_8h.html#a8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>, and <a class="el" href="cio_8h.html#a9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
 303
 304 </div>
 305 </div>
 306 <a id="aca072a59b683dc106263ba04d3c28577"></a>
 307 <h2 class="memtitle"><span class="permalink"><a href="#aca072a59b683dc106263ba04d3c28577">&#9670;&nbsp;</a></span>m_stored_data</h2>
 308
 309 <div class="memitem">
 310 <div class="memproto">
 311       <table class="memname">
 312         <tr>
 313           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_stream_private::m_stored_data</td>
 314         </tr>
 315       </table>
 316 </div><div class="memdoc">
 317
 318 <p>Actual data stored into the stream if read from. </p>
 319 <p>Data is read by chunk of fixed size. you should never access this data directly. </p>
 320
 321 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="openjpeg_8h.html#a0703208df785be60460eb83c5d40b10f">opj_stream_destroy()</a>, <a class="el" href="cio_8h.html#a3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="cio_8h.html#a8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, and <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>.</p>
 322
 323 </div>
 324 </div>
 325 <a id="a326f2fe5dc1fccce2788bf09ddf4931c"></a>
 326 <h2 class="memtitle"><span class="permalink"><a href="#a326f2fe5dc1fccce2788bf09ddf4931c">&#9670;&nbsp;</a></span>m_user_data</h2>
 327
 328 <div class="memitem">
 329 <div class="memproto">
 330       <table class="memname">
 331         <tr>
 332           <td class="memname">void* opj_stream_private::m_user_data</td>
 333         </tr>
 334       </table>
 335 </div><div class="memdoc">
 336
 337 <p>User data, be it files, ... </p>
 338 <p>The actual data depends on the type of the stream. </p>
 339
 340 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a0703208df785be60460eb83c5d40b10f">opj_stream_destroy()</a>, <a class="el" href="cio_8h.html#a3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="cio_8h.html#a6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="cio_8h.html#a7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="openjpeg_8h.html#a6cd79f0336b039391ffd67cddca0ac67">opj_stream_set_user_data()</a>, <a class="el" href="cio_8h.html#aa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>, and <a class="el" href="cio_8h.html#a9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
 341
 342 </div>
 343 </div>
 344 <a id="a53cb7b3992a382231554bdc73cb0c7bd"></a>
 345 <h2 class="memtitle"><span class="permalink"><a href="#a53cb7b3992a382231554bdc73cb0c7bd">&#9670;&nbsp;</a></span>m_user_data_length</h2>
 346
 347 <div class="memitem">
 348 <div class="memproto">
 349       <table class="memname">
 350         <tr>
 351           <td class="memname"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a> opj_stream_private::m_user_data_length</td>
 352         </tr>
 353       </table>
 354 </div><div class="memdoc">
 355
 356 <p>User data length. </p>
 357
 358 <p class="reference">Referenced by <a class="el" href="cio_8h.html#aec7225a845169469fd1aa8db2a3fac9e">opj_stream_get_number_byte_left()</a>, <a class="el" href="cio_8h.html#a092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, and <a class="el" href="openjpeg_8h.html#a2845fa5ff8031ef4a0b46314a19c0dc5">opj_stream_set_user_data_length()</a>.</p>
 359
 360 </div>
 361 </div>
 362 <a id="aacd57b4e429ddf5ca3a4913a2f963d6a"></a>
 363 <h2 class="memtitle"><span class="permalink"><a href="#aacd57b4e429ddf5ca3a4913a2f963d6a">&#9670;&nbsp;</a></span>m_write_fn</h2>
 364
 365 <div class="memitem">
 366 <div class="memproto">
 367       <table class="memname">
 368         <tr>
 369           <td class="memname"><a class="el" href="openjpeg_8h.html#a5a43391a5d2fd7b09c6f1957b9ad0337">opj_stream_write_fn</a> opj_stream_private::m_write_fn</td>
 370         </tr>
 371       </table>
 372 </div><div class="memdoc">
 373
 374 <p>Pointer to actual write function (NULL at the initialization of the cio. </p>
 375
 376 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="cio_8h.html#a3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, and <a class="el" href="openjpeg_8h.html#a5d196d304c431d2c1d462397976aa763">opj_stream_set_write_function()</a>.</p>
 377
 378 </div>
 379 </div>
 380 <hr/>The documentation for this struct was generated from the following file:<ul>
 381 <li><a class="el" href="cio_8h_source.html">cio.h</a></li>
 382 </ul>
 383 </div><!-- contents -->
 384 <!-- start footer part -->
 385 <hr class="footer"/><address class="footer"><small>
 386 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 387 <img class="footer" src="doxygen.png" alt="doxygen"/>
 388 </a> 1.8.17
 389 </small></address>
 390 </body>
 391 </html>