Create CNAME
[openjpeg.git] / doxygen / structopj__encoding__param.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_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.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_encoding_param Struct Reference</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p><code>#include &lt;<a class="el" href="j2k_8h_source.html">j2k.h</a>&gt;</code></p>
50 <table class="memberdecls">
51 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
52 Data Fields</h2></td></tr>
53 <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>
54 <tr class="memdesc:ab14cfb8a5c9d4dd7ea8a312783644ca9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum rate for each component.  <a href="structopj__encoding__param.html#ab14cfb8a5c9d4dd7ea8a312783644ca9">More...</a><br /></td></tr>
55 <tr class="separator:ab14cfb8a5c9d4dd7ea8a312783644ca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
56 <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>
57 <tr class="memdesc:a35052c5561f363438a8f34d103ae0dd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position of tile part flag in progression order.  <a href="structopj__encoding__param.html#a35052c5561f363438a8f34d103ae0dd4">More...</a><br /></td></tr>
58 <tr class="separator:a35052c5561f363438a8f34d103ae0dd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
59 <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>
60 <tr class="memdesc:af268e3dd2359f30d23f7dc24540ffb1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">fixed layer  <a href="structopj__encoding__param.html#af268e3dd2359f30d23f7dc24540ffb1d">More...</a><br /></td></tr>
61 <tr class="separator:af268e3dd2359f30d23f7dc24540ffb1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <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>
63 <tr class="memdesc:a6962c8590554475172a56607fe328e6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag determining tile part generation.  <a href="structopj__encoding__param.html#a6962c8590554475172a56607fe328e6e">More...</a><br /></td></tr>
64 <tr class="separator:a6962c8590554475172a56607fe328e6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 <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>
66 <tr class="memdesc:a53f7ee9dec382419e922cbb93aa6f479"><td class="mdescLeft">&#160;</td><td class="mdescRight">allocation by rate/distortion  <a href="structopj__encoding__param.html#a53f7ee9dec382419e922cbb93aa6f479">More...</a><br /></td></tr>
67 <tr class="separator:a53f7ee9dec382419e922cbb93aa6f479"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <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>
69 <tr class="memdesc:a93ae2cd807a0c716c39acf0532fa7e18"><td class="mdescLeft">&#160;</td><td class="mdescRight">allocation by fixed layer  <a href="structopj__encoding__param.html#a93ae2cd807a0c716c39acf0532fa7e18">More...</a><br /></td></tr>
70 <tr class="separator:a93ae2cd807a0c716c39acf0532fa7e18"><td class="memSeparator" colspan="2">&#160;</td></tr>
71 <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>
72 <tr class="memdesc:a2ffde36961e37f417b8e9b10c0efa171"><td class="mdescLeft">&#160;</td><td class="mdescRight">add fixed_quality  <a href="structopj__encoding__param.html#a2ffde36961e37f417b8e9b10c0efa171">More...</a><br /></td></tr>
73 <tr class="separator:a2ffde36961e37f417b8e9b10c0efa171"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <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>
75 <tr class="memdesc:a77d5159cfc449455fefaa378ed3ed411"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enabling Tile part generation.  <a href="structopj__encoding__param.html#a77d5159cfc449455fefaa378ed3ed411">More...</a><br /></td></tr>
76 <tr class="separator:a77d5159cfc449455fefaa378ed3ed411"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 </table>
78 <h2 class="groupheader">Field Documentation</h2>
79 <a id="a53f7ee9dec382419e922cbb93aa6f479"></a>
80 <h2 class="memtitle"><span class="permalink"><a href="#a53f7ee9dec382419e922cbb93aa6f479">&#9670;&nbsp;</a></span>m_disto_alloc</h2>
81
82 <div class="memitem">
83 <div class="memproto">
84       <table class="memname">
85         <tr>
86           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_disto_alloc</td>
87         </tr>
88       </table>
89 </div><div class="memdoc">
90
91 <p>allocation by rate/distortion </p>
92
93 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="tcd_8c.html#aa237637abb5431aa9db59ba0776a8a75">opj_tcd_rate_allocate_encode()</a>, and <a class="el" href="tcd_8h.html#a15fc40d9b891d32df8ec516473d9f15e">opj_tcd_rateallocate()</a>.</p>
94
95 </div>
96 </div>
97 <a id="a93ae2cd807a0c716c39acf0532fa7e18"></a>
98 <h2 class="memtitle"><span class="permalink"><a href="#a93ae2cd807a0c716c39acf0532fa7e18">&#9670;&nbsp;</a></span>m_fixed_alloc</h2>
99
100 <div class="memitem">
101 <div class="memproto">
102       <table class="memname">
103         <tr>
104           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_fixed_alloc</td>
105         </tr>
106       </table>
107 </div><div class="memdoc">
108
109 <p>allocation by fixed layer </p>
110
111 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>.</p>
112
113 </div>
114 </div>
115 <a id="a2ffde36961e37f417b8e9b10c0efa171"></a>
116 <h2 class="memtitle"><span class="permalink"><a href="#a2ffde36961e37f417b8e9b10c0efa171">&#9670;&nbsp;</a></span>m_fixed_quality</h2>
117
118 <div class="memitem">
119 <div class="memproto">
120       <table class="memname">
121         <tr>
122           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_fixed_quality</td>
123         </tr>
124       </table>
125 </div><div class="memdoc">
126
127 <p>add fixed_quality </p>
128
129 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="tcd_8c.html#aa237637abb5431aa9db59ba0776a8a75">opj_tcd_rate_allocate_encode()</a>, and <a class="el" href="tcd_8h.html#a15fc40d9b891d32df8ec516473d9f15e">opj_tcd_rateallocate()</a>.</p>
130
131 </div>
132 </div>
133 <a id="af268e3dd2359f30d23f7dc24540ffb1d"></a>
134 <h2 class="memtitle"><span class="permalink"><a href="#af268e3dd2359f30d23f7dc24540ffb1d">&#9670;&nbsp;</a></span>m_matrice</h2>
135
136 <div class="memitem">
137 <div class="memproto">
138       <table class="memname">
139         <tr>
140           <td class="memname"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a>* opj_encoding_param::m_matrice</td>
141         </tr>
142       </table>
143 </div><div class="memdoc">
144
145 <p>fixed layer </p>
146
147 <p class="reference">Referenced by <a class="el" href="j2k_8c.html#a0c57b021edd36e64c83e43c534ce6e00">opj_j2k_cp_destroy()</a>, <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, and <a class="el" href="tcd_8h.html#a31ece0bd1f42ea10d6f5fc342db86936">opj_tcd_makelayer_fixed()</a>.</p>
148
149 </div>
150 </div>
151 <a id="ab14cfb8a5c9d4dd7ea8a312783644ca9"></a>
152 <h2 class="memtitle"><span class="permalink"><a href="#ab14cfb8a5c9d4dd7ea8a312783644ca9">&#9670;&nbsp;</a></span>m_max_comp_size</h2>
153
154 <div class="memitem">
155 <div class="memproto">
156       <table class="memname">
157         <tr>
158           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_encoding_param::m_max_comp_size</td>
159         </tr>
160       </table>
161 </div><div class="memdoc">
162
163 <p>Maximum rate for each component. </p>
164 <p>If == 0, component size limitation is not considered </p>
165
166 <p class="reference">Referenced by <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, and <a class="el" href="t2_8h.html#af330a34bcb961487cee45f0121b3531e">opj_t2_encode_packets()</a>.</p>
167
168 </div>
169 </div>
170 <a id="a6962c8590554475172a56607fe328e6e"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#a6962c8590554475172a56607fe328e6e">&#9670;&nbsp;</a></span>m_tp_flag</h2>
172
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> opj_encoding_param::m_tp_flag</td>
178         </tr>
179       </table>
180 </div><div class="memdoc">
181
182 <p>Flag determining tile part generation. </p>
183
184 <p class="reference">Referenced by <a class="el" href="j2k_8c.html#ae83b2192904667bdc4837ac4038e928e">opj_j2k_get_num_tp()</a>, and <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>.</p>
185
186 </div>
187 </div>
188 <a id="a77d5159cfc449455fefaa378ed3ed411"></a>
189 <h2 class="memtitle"><span class="permalink"><a href="#a77d5159cfc449455fefaa378ed3ed411">&#9670;&nbsp;</a></span>m_tp_on</h2>
190
191 <div class="memitem">
192 <div class="memproto">
193       <table class="memname">
194         <tr>
195           <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_encoding_param::m_tp_on</td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <p>Enabling Tile part generation. </p>
201
202 <p class="reference">Referenced by <a class="el" href="j2k_8c.html#ae83b2192904667bdc4837ac4038e928e">opj_j2k_get_num_tp()</a>, <a class="el" href="j2k_8h.html#a4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>, <a class="el" href="j2k_8c.html#ae73d42871d377e6fa71701f85a017bd8">opj_j2k_update_rates()</a>, <a class="el" href="pi_8h.html#acb01a23ef601a5e06c582c926c39a8e4">opj_pi_create_encode()</a>, <a class="el" href="pi_8h.html#a2e76cd9983f766b757fd0cdfae9d6d43">opj_pi_initialise_encode()</a>, <a class="el" href="t2_8h.html#a08fffa34be41f4811d8bd99e9364de2e">opj_t2_decode_packets()</a>, and <a class="el" href="t2_8h.html#af330a34bcb961487cee45f0121b3531e">opj_t2_encode_packets()</a>.</p>
203
204 </div>
205 </div>
206 <a id="a35052c5561f363438a8f34d103ae0dd4"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#a35052c5561f363438a8f34d103ae0dd4">&#9670;&nbsp;</a></span>m_tp_pos</h2>
208
209 <div class="memitem">
210 <div class="memproto">
211       <table class="memname">
212         <tr>
213           <td class="memname"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> opj_encoding_param::m_tp_pos</td>
214         </tr>
215       </table>
216 </div><div class="memdoc">
217
218 <p>Position of tile part flag in progression order. </p>
219
220 <p class="reference">Referenced by <a class="el" href="j2k_8c.html#ae83b2192904667bdc4837ac4038e928e">opj_j2k_get_num_tp()</a>, and <a class="el" href="tcd_8h.html#a8f9a0eceb5f11b164555a302db07cb5c">opj_tcd_init()</a>.</p>
221
222 </div>
223 </div>
224 <hr/>The documentation for this struct was generated from the following file:<ul>
225 <li><a class="el" href="j2k_8h_source.html">j2k.h</a></li>
226 </ul>
227 </div><!-- contents -->
228 <!-- start footer part -->
229 <hr class="footer"/><address class="footer"><small>
230 Generated by &#160;<a href="http://www.doxygen.org/index.html">
231 <img class="footer" src="doxygen.png" alt="doxygen"/>
232 </a> 1.8.17
233 </small></address>
234 </body>
235 </html>