Update ABI/API compatibility reports after commit 491299eb073c80602ca8ee333303a31a581...
[openjpeg.git] / doxygen / structopj__encoding__param.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_encoding_param Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#pub-attribs">Data Fields</a>  </div>
43   <div class="headertitle">
44 <div class="title">opj_encoding_param Struct Reference<div class="ingroups"><a class="el" href="group___j2_k.html">J2K - JPEG-2000 codestream reader/writer</a></div></div>  </div>
45 </div><!--header-->
46 <div class="contents">
47
48 <p><code>#include &lt;<a class="el" href="j2k_8h_source.html">j2k.h</a>&gt;</code></p>
49 <table class="memberdecls">
50 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
51 Data Fields</h2></td></tr>
52 <tr class="memitem:ab14cfb8a5c9d4dd7ea8a312783644ca9"><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__encoding__param.html#ab14cfb8a5c9d4dd7ea8a312783644ca9">m_max_comp_size</a></td></tr>
53 <tr class="memdesc:ab14cfb8a5c9d4dd7ea8a312783644ca9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum rate for each component.  <a href="#ab14cfb8a5c9d4dd7ea8a312783644ca9">More...</a><br /></td></tr>
54 <tr class="separator:ab14cfb8a5c9d4dd7ea8a312783644ca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
55 <tr class="memitem:a35052c5561f363438a8f34d103ae0dd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__encoding__param.html#a35052c5561f363438a8f34d103ae0dd4">m_tp_pos</a></td></tr>
56 <tr class="memdesc:a35052c5561f363438a8f34d103ae0dd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position of tile part flag in progression order.  <a href="#a35052c5561f363438a8f34d103ae0dd4">More...</a><br /></td></tr>
57 <tr class="separator:a35052c5561f363438a8f34d103ae0dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:af268e3dd2359f30d23f7dc24540ffb1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__encoding__param.html#af268e3dd2359f30d23f7dc24540ffb1d">m_matrice</a></td></tr>
59 <tr class="memdesc:af268e3dd2359f30d23f7dc24540ffb1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">fixed layer  <a href="#af268e3dd2359f30d23f7dc24540ffb1d">More...</a><br /></td></tr>
60 <tr class="separator:af268e3dd2359f30d23f7dc24540ffb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <tr class="memitem:a6962c8590554475172a56607fe328e6e"><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__encoding__param.html#a6962c8590554475172a56607fe328e6e">m_tp_flag</a></td></tr>
62 <tr class="memdesc:a6962c8590554475172a56607fe328e6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag determining tile part generation.  <a href="#a6962c8590554475172a56607fe328e6e">More...</a><br /></td></tr>
63 <tr class="separator:a6962c8590554475172a56607fe328e6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a53f7ee9dec382419e922cbb93aa6f479"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__encoding__param.html#a53f7ee9dec382419e922cbb93aa6f479">m_disto_alloc</a>: 1</td></tr>
65 <tr class="memdesc:a53f7ee9dec382419e922cbb93aa6f479"><td class="mdescLeft">&#160;</td><td class="mdescRight">allocation by rate/distortion  <a href="#a53f7ee9dec382419e922cbb93aa6f479">More...</a><br /></td></tr>
66 <tr class="separator:a53f7ee9dec382419e922cbb93aa6f479"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a93ae2cd807a0c716c39acf0532fa7e18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__encoding__param.html#a93ae2cd807a0c716c39acf0532fa7e18">m_fixed_alloc</a>: 1</td></tr>
68 <tr class="memdesc:a93ae2cd807a0c716c39acf0532fa7e18"><td class="mdescLeft">&#160;</td><td class="mdescRight">allocation by fixed layer  <a href="#a93ae2cd807a0c716c39acf0532fa7e18">More...</a><br /></td></tr>
69 <tr class="separator:a93ae2cd807a0c716c39acf0532fa7e18"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a2ffde36961e37f417b8e9b10c0efa171"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__encoding__param.html#a2ffde36961e37f417b8e9b10c0efa171">m_fixed_quality</a>: 1</td></tr>
71 <tr class="memdesc:a2ffde36961e37f417b8e9b10c0efa171"><td class="mdescLeft">&#160;</td><td class="mdescRight">add fixed_quality  <a href="#a2ffde36961e37f417b8e9b10c0efa171">More...</a><br /></td></tr>
72 <tr class="separator:a2ffde36961e37f417b8e9b10c0efa171"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a77d5159cfc449455fefaa378ed3ed411"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__encoding__param.html#a77d5159cfc449455fefaa378ed3ed411">m_tp_on</a>: 1</td></tr>
74 <tr class="memdesc:a77d5159cfc449455fefaa378ed3ed411"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enabling Tile part generation.  <a href="#a77d5159cfc449455fefaa378ed3ed411">More...</a><br /></td></tr>
75 <tr class="separator:a77d5159cfc449455fefaa378ed3ed411"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 </table>
77 <h2 class="groupheader">Field Documentation</h2>
78 <a id="a53f7ee9dec382419e922cbb93aa6f479"></a>
79 <h2 class="memtitle"><span class="permalink"><a href="#a53f7ee9dec382419e922cbb93aa6f479">&#9670;&nbsp;</a></span>m_disto_alloc</h2>
80
81 <div class="memitem">
82 <div class="memproto">
83       <table class="memname">
84         <tr>
85           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_disto_alloc</td>
86         </tr>
87       </table>
88 </div><div class="memdoc">
89
90 <p>allocation by rate/distortion </p>
91
92 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="tcd_8c.html#aa237637abb5431aa9db59ba0776a8a75">opj_tcd_rate_allocate_encode()</a>, and <a class="el" href="group___t_c_d.html#ga15fc40d9b891d32df8ec516473d9f15e">opj_tcd_rateallocate()</a>.</p>
93
94 </div>
95 </div>
96 <a id="a93ae2cd807a0c716c39acf0532fa7e18"></a>
97 <h2 class="memtitle"><span class="permalink"><a href="#a93ae2cd807a0c716c39acf0532fa7e18">&#9670;&nbsp;</a></span>m_fixed_alloc</h2>
98
99 <div class="memitem">
100 <div class="memproto">
101       <table class="memname">
102         <tr>
103           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_fixed_alloc</td>
104         </tr>
105       </table>
106 </div><div class="memdoc">
107
108 <p>allocation by fixed layer </p>
109
110 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>.</p>
111
112 </div>
113 </div>
114 <a id="a2ffde36961e37f417b8e9b10c0efa171"></a>
115 <h2 class="memtitle"><span class="permalink"><a href="#a2ffde36961e37f417b8e9b10c0efa171">&#9670;&nbsp;</a></span>m_fixed_quality</h2>
116
117 <div class="memitem">
118 <div class="memproto">
119       <table class="memname">
120         <tr>
121           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_fixed_quality</td>
122         </tr>
123       </table>
124 </div><div class="memdoc">
125
126 <p>add fixed_quality </p>
127
128 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="tcd_8c.html#aa237637abb5431aa9db59ba0776a8a75">opj_tcd_rate_allocate_encode()</a>, and <a class="el" href="group___t_c_d.html#ga15fc40d9b891d32df8ec516473d9f15e">opj_tcd_rateallocate()</a>.</p>
129
130 </div>
131 </div>
132 <a id="af268e3dd2359f30d23f7dc24540ffb1d"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#af268e3dd2359f30d23f7dc24540ffb1d">&#9670;&nbsp;</a></span>m_matrice</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137       <table class="memname">
138         <tr>
139           <td class="memname"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a>* opj_encoding_param::m_matrice</td>
140         </tr>
141       </table>
142 </div><div class="memdoc">
143
144 <p>fixed layer </p>
145
146 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#ga0c57b021edd36e64c83e43c534ce6e00">opj_j2k_cp_destroy()</a>, <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, and <a class="el" href="group___t_c_d.html#ga31ece0bd1f42ea10d6f5fc342db86936">opj_tcd_makelayer_fixed()</a>.</p>
147
148 </div>
149 </div>
150 <a id="ab14cfb8a5c9d4dd7ea8a312783644ca9"></a>
151 <h2 class="memtitle"><span class="permalink"><a href="#ab14cfb8a5c9d4dd7ea8a312783644ca9">&#9670;&nbsp;</a></span>m_max_comp_size</h2>
152
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_encoding_param::m_max_comp_size</td>
158         </tr>
159       </table>
160 </div><div class="memdoc">
161
162 <p>Maximum rate for each component. </p>
163 <p>If == 0, component size limitation is not considered </p>
164
165 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, and <a class="el" href="group___t2.html#ga4b315a332b59404266c1c1655fe8088c">opj_t2_encode_packets()</a>.</p>
166
167 </div>
168 </div>
169 <a id="a6962c8590554475172a56607fe328e6e"></a>
170 <h2 class="memtitle"><span class="permalink"><a href="#a6962c8590554475172a56607fe328e6e">&#9670;&nbsp;</a></span>m_tp_flag</h2>
171
172 <div class="memitem">
173 <div class="memproto">
174       <table class="memname">
175         <tr>
176           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> opj_encoding_param::m_tp_flag</td>
177         </tr>
178       </table>
179 </div><div class="memdoc">
180
181 <p>Flag determining tile part generation. </p>
182
183 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#gae83b2192904667bdc4837ac4038e928e">opj_j2k_get_num_tp()</a>, and <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>.</p>
184
185 </div>
186 </div>
187 <a id="a77d5159cfc449455fefaa378ed3ed411"></a>
188 <h2 class="memtitle"><span class="permalink"><a href="#a77d5159cfc449455fefaa378ed3ed411">&#9670;&nbsp;</a></span>m_tp_on</h2>
189
190 <div class="memitem">
191 <div class="memproto">
192       <table class="memname">
193         <tr>
194           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_tp_on</td>
195         </tr>
196       </table>
197 </div><div class="memdoc">
198
199 <p>Enabling Tile part generation. </p>
200
201 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#gae83b2192904667bdc4837ac4038e928e">opj_j2k_get_num_tp()</a>, <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="group___j2_k.html#gae73d42871d377e6fa71701f85a017bd8">opj_j2k_update_rates()</a>, <a class="el" href="group___p_i.html#gacb01a23ef601a5e06c582c926c39a8e4">opj_pi_create_encode()</a>, <a class="el" href="group___p_i.html#ga063e3300cc8f7553f0ea02652194409a">opj_pi_initialise_encode()</a>, <a class="el" href="group___t2.html#ga08fffa34be41f4811d8bd99e9364de2e">opj_t2_decode_packets()</a>, and <a class="el" href="group___t2.html#ga4b315a332b59404266c1c1655fe8088c">opj_t2_encode_packets()</a>.</p>
202
203 </div>
204 </div>
205 <a id="a35052c5561f363438a8f34d103ae0dd4"></a>
206 <h2 class="memtitle"><span class="permalink"><a href="#a35052c5561f363438a8f34d103ae0dd4">&#9670;&nbsp;</a></span>m_tp_pos</h2>
207
208 <div class="memitem">
209 <div class="memproto">
210       <table class="memname">
211         <tr>
212           <td class="memname"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> opj_encoding_param::m_tp_pos</td>
213         </tr>
214       </table>
215 </div><div class="memdoc">
216
217 <p>Position of tile part flag in progression order. </p>
218
219 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#gae83b2192904667bdc4837ac4038e928e">opj_j2k_get_num_tp()</a>, and <a class="el" href="group___t_c_d.html#ga8f9a0eceb5f11b164555a302db07cb5c">opj_tcd_init()</a>.</p>
220
221 </div>
222 </div>
223 <hr/>The documentation for this struct was generated from the following file:<ul>
224 <li><a class="el" href="j2k_8h_source.html">j2k.h</a></li>
225 </ul>
226 </div><!-- contents -->
227 <!-- start footer part -->
228 <hr class="footer"/><address class="footer"><small>
229 Generated by &#160;<a href="http://www.doxygen.org/index.html">
230 <img class="footer" src="doxygen.png" alt="doxygen"/>
231 </a> 1.8.13
232 </small></address>
233 </body>
234 </html>