mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 15:36:52 +08:00
88 lines
76 KiB
HTML
88 lines
76 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>openNURBS SDK Help: D:/BuildAgent/work/d8e3bf9e94f4c621/src4/bin/opennurbs_public/opennurbs_compress.h Source File</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!-- bootstrap -->
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
<!-- smartmenus -->
|
|
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
|
|
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
|
|
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
|
|
</head>
|
|
<body>
|
|
<!-- <div class="version-banner">
|
|
Go back to the <a href="/">main site</a>...
|
|
</div> -->
|
|
<div class="container">
|
|
<!-- navbar -->
|
|
<nav class="navbar navbar-default">
|
|
<div class="container-fluid">
|
|
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
|
|
<div class="navbar-collapse collapse" id="main-nav-placeholder">
|
|
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Latest (6.x)</a></li>
|
|
<li class="disabled"><a href="#">WIP (7.x)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="page-content">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="../../dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">opennurbs_compress.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (c) 1993-2012 Robert McNeel & Associates. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// McNeel & Associates.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// For complete openNURBS copyright information see <http://www.opennurbs.org>.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span>*/</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#if !defined(OPENNURBS_COMPRESS_INC_)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define OPENNURBS_COMPRESS_INC_</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">typedef</span> bool (*ON_StreamCallbackFunction)( <span class="keywordtype">void</span>* context, ON__UINT32 size, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer );</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="../../d7/d8c/class_o_n___compress_stream.html"> 22</a></span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a>();</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">virtual</span> ~<a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a>();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">/*</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> ON_CompressStream delivers the compressed stream by calling</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> a compressed stream output handler function. There are two</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> options for specifying the compressed stream output handler</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> function.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> 1. Overriding the virtual Out() function.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> 2. Providing a callback function.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> SetCallback() is used to specify a callback function to handle</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> the compressed stream and to specify a context pointer to be </span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> passed to either option of the handler.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> callback_function - [in]</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Function to call with sections of the compressed stream.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> If callback_function is null, then the virtual Out() </span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> function will be called. When callback_function </span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> is specified, it must return true if the compression </span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> calculation should continue and false to cancel the </span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> compression calculation.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> callback_context - [in]</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> This value is passed as the first argument when calling </span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> callback_function or the virutal Out() function.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> True if successful.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> Once compression has started, it would be unusual to</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> intentionally change the compressed stream output handler,</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> but you can do this if you need to. </span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">bool</span> SetCallback( </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  ON_StreamCallbackFunction callback_function,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span>* callback_context</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  );</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">/*</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> Current value of the callback function for handling</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> the compressed stream. If the callback function is</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> null, the the virtual Out() function is used to</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> handle</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  ON_StreamCallbackFunction CallbackFunction() <span class="keyword">const</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">/*</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> Current value of the context pointer passed as the first</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> argument to the compressed stream output handler function.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> */</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span>* CallbackContext() <span class="keyword">const</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">/*</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> Call Begin() one time to initialize the compression</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> calculation. Then call In() one or more times </span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> to submit the uncompressed stream to the compression calculation. </span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> When you reach the end of the uncompressed stream, call </span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> End().</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> true if successful, false if an error occured.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">bool</span> Begin();</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">/*</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> Call In() one or more times to compress a stream of uncompressed</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> bytes. After the last call to In(), call End(). Calling In()</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> may generate zero or more calls to the output stream handler.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> in_buffer_size - [in]</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> number of bytes in in_buffer</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> in_buffer - [in]</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> true if successful, false if an error occured.</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">bool</span> In( </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  ON__UINT64 in_buffer_size, </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* in_buffer </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  );</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">/*</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> If an explicit compressed stream output handler is not specified</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> ( CallbackFunction() returns null ), then the virtual Out() </span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> function is called to handle the compressed output stream.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> As the input stream is compressed, one or more calls to Out()</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> will occur.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> True to continue compressing and false to cancel the compression</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> calculation.</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> In general, it is probably going to be easier to test and debug</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> your code if you ignore the callback_context parameter and add </span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> a member variable to your derived class to make additional</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> information accessable to your Out function.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> */</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Out( </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">void</span>* callback_context, </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  ON__UINT32 out_buffer_size, </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* out_buffer </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  );</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="comment">/*</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> After the last call to In(), call End(). </span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> Calling End() may generate zero or more </span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> calls to the output stream handler.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> true if successful, false if an error occured.</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">bool</span> End();</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="comment">/*</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> Then the returned value is the total number bytes in the input</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> stream. The size is updated every time In() is called before </span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> any calls are made to the output stream handler. If the </span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> calculation is finished ( End() has been called ), then the</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> returned value is the total number of bytes in the entire </span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> input stream.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> */</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  ON__UINT64 InSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">/*</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> Then the returned value is the total number bytes in the output</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> stream. The size is incremented immediately after each call to</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> the output stream handler. If the compression calculation is </span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> finished ( End() has been called ), then the returned value is</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> the total number of bytes in the entire output stream.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  ON__UINT64 OutSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">/*</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> Then the returned value is the 32-bit crc of the input stream.</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> The crc is updated every time In() is called before any calls</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> are made to the output stream handler. If the compression </span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> calculation is finished ( End() has been called ), then the</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> returned value is the 32-bit crc of the entire input stream.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> */</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  ON__UINT32 InCRC() <span class="keyword">const</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="comment">/*</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> Then the returned value is the 32bit crc of the output stream.</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> The crc is updated immediately after each call to the output</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> stream handler. If the calculation is finished ( End() has </span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> been called ), then the returned value is the 32-bit crc of</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> the entire output stream.</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> */</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  ON__UINT32 OutCRC() <span class="keyword">const</span>;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  ON_StreamCallbackFunction m_out_callback_function;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">void</span>* m_out_callback_context;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  ON__UINT64 m_in_size;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  ON__UINT64 m_out_size;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  ON__UINT32 m_in_crc;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  ON__UINT32 m_out_crc;</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordtype">void</span>* m_implementation;</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">void</span>* m_reserved;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordtype">void</span> ErrorHandler();</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00193"></a><span class="lineno"><a class="line" href="../../db/da6/class_o_n___uncompress_stream.html"> 193</a></span>  <span class="comment">// prohibit use - no implementation</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a>(<span class="keyword">const</span> <a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a>&);</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a>&);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> };</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> {</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a>();</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keyword">virtual</span> ~<a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a>();</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="comment">/*</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> ON_UncompressStream delivers the uncompressed stream by calling</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> an uncompressed stream output handler function. There are two</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> options for specifying the uncompressed stream output handler</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> function.</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> 1. Overriding the virtual Out() function.</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> 2. Providing a callback function.</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> SetCallback() is used to specify a callback function to handle</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> the uncompressed stream and to specify a context pointer to be </span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> passed to either option of the handler.</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> callback_function - [in]</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> Function to call with sections of the uncompressed stream.</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> If callback_function is null, then the virtual Out() </span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> function will be called. When callback_function </span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> is specified, it must return true if the uncompression </span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> calculation should continue and false to cancel the </span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> uncompression calculation.</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> callback_context - [in]</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> This value is passed as the first argument when calling </span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> callback_function or the virutal Out() function.</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> True if successful.</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> Once uncompression has started, it would be unusual to</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> intentionally change the uncompressed stream output handler,</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> but you can do this if you need to. </span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> */</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordtype">bool</span> SetCallback( </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  ON_StreamCallbackFunction callback_function,</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordtype">void</span>* callback_context</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  );</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="comment">/*</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> Current value of the callback function for handling</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> the uncompressed stream. If the callback function is</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> null, the the virtual UncompressedStreamOut() function</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> is used.</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> */</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  ON_StreamCallbackFunction CallbackFunction() <span class="keyword">const</span>;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="comment">/*</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> Current value of the context pointer passed as the first</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> argument to the uncompressed stream output handler function.</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> */</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keywordtype">void</span>* CallbackContext() <span class="keyword">const</span>;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="comment">/*</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> Call BeginUnompressStream() one time to initialize the compression</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> calculation. Then call In() one or more times </span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> to submit the compressed stream to the uncompression calculation. </span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> When you reach the end of the compressed stream, call </span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> End().</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> true if successful, false if an error occured.</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> */</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keywordtype">bool</span> Begin();</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="comment">/*</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> Call In() one or more times to uncompress a stream of compressed</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> bytes. After the last call to In(), call End(). Calling End()</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> may generate zero or more calls to the output stream handler.</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> in_buffer_size - [in]</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> number of bytes in in_buffer</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> in_buffer - [in]</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> true if successful, false if an error occured.</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> */</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keywordtype">bool</span> In(</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  ON__UINT64 in_buffer_size,</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* in_buffer</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  );</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> </div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="comment">/*</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> If an explicit uncompressed stream handler is not specified</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> ( CallbackFunction() returns null ), then the virtual Out() </span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> function is called to handle the uncompressed output stream.</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> As the input stream is uncompressed, one or more calls to Out()</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> will occur.</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> True to continue uncompressing and false to cancel the </span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> uncompression calculation.</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> Remarks:</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> In general, it is probably going to be easier to test and debug</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> your code if you ignore the callback_context parameter and add </span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> a member variable to your derived class to make additional</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> information accessable to your Out function.</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> */</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Out( </div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keywordtype">void</span>* callback_context, </div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  ON__UINT32 out_buffer_size, </div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* out_buffer </div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  );</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="comment">/*</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> After the last call to In(), call End(). </span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> Calling End() may generate zero or more </span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> calls to the output stream handler.</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> true if successful, false if an error occured.</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> */</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keywordtype">bool</span> End();</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="comment">/*</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> Then the returned value is the total number bytes in the input</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> stream. The size is updated every time In() is called before </span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> any calls are made to the output stream handler. If the </span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> calculation is finished ( End() has been called ), then the</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> returned value is the total number of bytes in the entire </span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> input stream.</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> */</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  ON__UINT64 InSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> </div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <span class="comment">/*</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> Then the returned value is the total number bytes in the output</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> stream. The size is incremented immediately after each call to</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> the output stream handler. If the compression calculation is </span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> finished ( End() has been called ), then the returned value is</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> the total number of bytes in the entire output stream.</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> */</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  ON__UINT64 OutSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> </div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  <span class="comment">/*</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> Then the returned value is the 32-bit crc of the input stream.</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> The crc is updated every time In() is called before any calls</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> are made to the output stream handler. If the compression </span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> calculation is finished ( End() has been called ), then the</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> returned value is the 32-bit crc of the entire input stream.</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> */</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  ON__UINT32 InCRC() <span class="keyword">const</span>;</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> </div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  <span class="comment">/*</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> Then the returned value is the 32bit crc of the output stream.</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> The crc is updated immediately after each call to the output</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> stream handler. If the calculation is finished ( End() has </span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> been called ), then the returned value is the 32-bit crc of</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> the entire output stream.</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> */</span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  ON__UINT32 OutCRC() <span class="keyword">const</span>;</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> </div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  ON_StreamCallbackFunction m_out_callback_function;</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keywordtype">void</span>* m_out_callback_context;</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  ON__UINT64 m_in_size;</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  ON__UINT64 m_out_size;</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  ON__UINT32 m_in_crc;</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  ON__UINT32 m_out_crc;</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="keywordtype">void</span>* m_implementation;</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  <span class="keywordtype">void</span>* m_reserved;</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> </div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="keywordtype">void</span> ErrorHandler();</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> </div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="comment">// prohibit use - no implementation</span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a>(<span class="keyword">const</span> <a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a>&);</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a>&);</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> };</div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> </div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment">/*</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment">Description:</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> Simple tool for uncompressing a buffer when the output</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> buffer size is known.</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment">Parameters:</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> sizeof_compressed_buffer - [in]</span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> byte count</span></div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> compressed_buffer - [in]</span></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> sizeof_uncompressed_buffer</span></div><div class="line"><a name="l00384"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html"> 384</a></span> <span class="comment"> byte count</span></div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> uncompressed_buffer - [out]</span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment">Returns:</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> Number of bytes written to uncompressed_buffer.</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment">*/</span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> ON_DECL</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="keywordtype">size_t</span> ON_UncompressBuffer(</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  <span class="keywordtype">size_t</span> sizeof_compressed_buffer,</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* compressed_buffer,</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <span class="keywordtype">size_t</span> sizeof_uncompressed_buffer,</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  <span class="keywordtype">void</span>* uncompressed_buffer</div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  );</div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span> </div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="keyword">class </span>ON_CLASS <a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a></div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span> {</div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  <a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a>();</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  ~<a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a>();</div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a>(<span class="keyword">const</span> <a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a>& src);</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a>& src);</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span> </div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  <span class="comment">/*</span></div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> Compress inbuffer.</span></div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> sizeof__inbuffer - [in]</span></div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> Number of bytes in inbuffer.</span></div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> inbuffer - [in]</span></div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> Uncompressed information.</span></div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> sizeof_element - [out]</span></div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> This parameter only matters if the buffer will be compressed,</span></div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> and decompressed on CPUs with different endianness. If this</span></div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> is the case, then the types in the buffer need to have the</span></div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> same size (2,4, or 8).</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> True if inbuffer is successfully compressed.</span></div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> */</span></div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <span class="keywordtype">bool</span> Compress(</div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  <span class="keywordtype">size_t</span> sizeof__inbuffer, <span class="comment">// sizeof uncompressed input data</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* inbuffer, <span class="comment">// uncompressed input data</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  <span class="keywordtype">int</span> sizeof_element</div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  );</div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span> </div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  <span class="comment">/*</span></div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> Number of bytes in the uncompressed information.</span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> */</span></div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  <span class="keywordtype">size_t</span> SizeOfUncompressedBuffer() <span class="keyword">const</span>;</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span> </div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  <span class="comment">/*</span></div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> Uncompress the contents of this ON_CompressedBuffer.</span></div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> Parameters:</span></div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> outbuffer - [in/out]</span></div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> This buffer must have at least SizeOfUncompressedBuffer() bytes.</span></div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> If the function returns true, then the uncopressed information</span></div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> is stored in this buffer.</span></div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> bFailedCRC - [out]</span></div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> If not null, then this boolean is set to true if the CRC</span></div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> of the uncompressed information has changed.</span></div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> Returns:</span></div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> True if uncompressed information is returned in outbuffer.</span></div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> */</span></div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  <span class="keywordtype">bool</span> Uncompress( <span class="comment">// read and uncompress</span></div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  <span class="keywordtype">void</span>* outbuffer, <span class="comment">// uncompressed output data returned here</span></div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keywordtype">int</span>* bFailedCRC</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span> </div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  <span class="comment">/*</span></div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"> Description:</span></div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> Destroy the current informtion in the ON_CompressedBuffer</span></div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"> so the class can be reused.</span></div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> */</span></div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  <span class="keywordtype">void</span> Destroy();</div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span> </div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="keywordtype">bool</span> Write(<a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>& binary_archive) <span class="keyword">const</span>;</div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="keywordtype">bool</span> Read(<a class="code" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a>& binary_archive);</div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"></span></div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> /////////////////////////////////////////////////</span></div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"></span> <span class="comment">//</span></div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  <span class="comment">// Implementation</span></div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  <span class="comment">//</span></div><div class="line"><a name="l00466"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#a3d3f913759006670642cbea3f9fd39bf"> 466</a></span>  <span class="keywordtype">bool</span> CompressionInit(<span class="keyword">struct</span> ON_CompressedBufferHelper*) <span class="keyword">const</span>;</div><div class="line"><a name="l00467"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#a713a6d9b0eb496f29f07748ec70934e0"> 467</a></span>  <span class="keywordtype">bool</span> CompressionEnd(<span class="keyword">struct</span> ON_CompressedBufferHelper*) <span class="keyword">const</span>;</div><div class="line"><a name="l00468"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#a195f92487d9bab0b86ae4062cb6167fb"> 468</a></span>  <span class="keywordtype">size_t</span> DeflateHelper( <span class="comment">// returns number of bytes written</span></div><div class="line"><a name="l00469"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#a70be5dc88d68d3315f8752f49fbbbdde"> 469</a></span>  <span class="keyword">struct</span> ON_CompressedBufferHelper*,</div><div class="line"><a name="l00470"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#a5b18c2f541ebc3f00206cb75dd5fbf19"> 470</a></span>  <span class="keywordtype">size_t</span> sizeof___inbuffer, <span class="comment">// sizeof uncompressed input data ( > 0 )</span></div><div class="line"><a name="l00471"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#a4b73cb10d453c4d49a20a227a48068e5"> 471</a></span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* in___buffer <span class="comment">// uncompressed input data ( != nullptr )</span></div><div class="line"><a name="l00472"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#aa7406d1f74bb1e288e5219075a76c269"> 472</a></span>  );</div><div class="line"><a name="l00473"></a><span class="lineno"><a class="line" href="../../d6/d66/class_o_n___compressed_buffer.html#aa7d7774809ace3840d8035d86829c4e4"> 473</a></span>  <span class="keywordtype">bool</span> InflateHelper(</div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  <span class="keyword">struct</span> ON_CompressedBufferHelper*,</div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  <span class="keywordtype">size_t</span> sizeof___outbuffer, <span class="comment">// sizeof uncompressed data</span></div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  <span class="keywordtype">void</span>* out___buffer <span class="comment">// buffer for uncompressed data</span></div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  ) <span class="keyword">const</span>;</div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  <span class="keywordtype">bool</span> WriteChar(</div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  <span class="keywordtype">size_t</span> count,</div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer</div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  );</div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span> </div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  <span class="keywordtype">size_t</span> m_sizeof_uncompressed;</div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  <span class="keywordtype">size_t</span> m_sizeof_compressed;</div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  ON__UINT32 m_crc_uncompressed;</div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  ON__UINT32 m_crc_compressed;</div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  <span class="keywordtype">int</span> m_method; <span class="comment">// 0 = copied, 1 = compressed</span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  <span class="keywordtype">int</span> m_sizeof_element;</div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordtype">size_t</span> m_buffer_compressed_capacity;</div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="keywordtype">void</span>* m_buffer_compressed;</div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span> };</div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span> </div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_o_n___uncompress_stream_html"><div class="ttname"><a href="../../db/da6/class_o_n___uncompress_stream.html">ON_UncompressStream</a></div><div class="ttdef"><b>Definition:</b> opennurbs_compress.h:193</div></div>
|
|
<div class="ttc" id="class_o_n___binary_archive_html"><div class="ttname"><a href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a></div><div class="ttdef"><b>Definition:</b> opennurbs_archive.h:1783</div></div>
|
|
<div class="ttc" id="class_o_n___compress_stream_html"><div class="ttname"><a href="../../d7/d8c/class_o_n___compress_stream.html">ON_CompressStream</a></div><div class="ttdef"><b>Definition:</b> opennurbs_compress.h:22</div></div>
|
|
<div class="ttc" id="class_o_n___compressed_buffer_html"><div class="ttname"><a href="../../d6/d66/class_o_n___compressed_buffer.html">ON_CompressedBuffer</a></div><div class="ttdef"><b>Definition:</b> opennurbs_compress.h:384</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
</div> <!-- page-content -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Feb 3 2018 11:08:26 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
|
|
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
|
|
Doxygen
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</div> <!-- container -->
|
|
<!-- doxy-boot -->
|
|
<script type="text/javascript" src="../../doxy-boot.js"></script>
|
|
</body>
|
|
</html>
|