libschroedinger-doc 1.0.11-2ubuntu1 / usr / share / gtk-doc / html / schroedinger / schroedinger-schroparams.html

This file is indexed.

/usr/share/gtk-doc/html/schroedinger/schroedinger-schroparams.html is in libschroedinger-doc 1.0.11-2ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>schroparams</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Schroedinger Reference Manual">
<link rel="up" href="schrointernal.html" title="Schroedinger Internal API">
<link rel="prev" href="schroedinger-schropack.html" title="schropack">
<link rel="next" href="schroedinger-schroqueue.html" title="schroqueue">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="schroedinger-schropack.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="schrointernal.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Schroedinger Reference Manual</th>
<td><a accesskey="n" href="schroedinger-schroqueue.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#schroedinger-schroparams.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#schroedinger-schroparams.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="schroedinger-schroparams"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="schroedinger-schroparams.top_of_page"></a>schroparams</span></h2>
<p>schroparams</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="schroedinger-schroparams.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="schroedinger-schroparams.html#SchroVideoFormat" title="struct SchroVideoFormat">SchroVideoFormat</a>;
struct              <a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams">SchroParams</a>;
struct              <a class="link" href="schroedinger-schroparams.html#SchroMotionVector" title="struct SchroMotionVector">SchroMotionVector</a>;
struct              <a class="link" href="schroedinger-schroparams.html#SchroMotionField" title="struct SchroMotionField">SchroMotionField</a>;
struct              <a class="link" href="schroedinger-schroparams.html#SchroGlobalMotion" title="struct SchroGlobalMotion">SchroGlobalMotion</a>;
typedef             <a class="link" href="schroedinger-schroparams.html#SchroPictureNumber" title="SchroPictureNumber">SchroPictureNumber</a>;
<span class="returnvalue">void</span>                <a class="link" href="schroedinger-schroparams.html#schro-params-calculate-iwt-sizes" title="schro_params_calculate_iwt_sizes ()">schro_params_calculate_iwt_sizes</a>    (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="schroedinger-schroparams.html#schro-params-calculate-mc-sizes" title="schro_params_calculate_mc_sizes ()">schro_params_calculate_mc_sizes</a>     (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="schroedinger-schroparams.html#schro-params-set-block-params" title="schro_params_set_block_params ()">schro_params_set_block_params</a>       (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> index</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="schroedinger-schroparams.html#schro-params-set-default-codeblock" title="schro_params_set_default_codeblock ()">schro_params_set_default_codeblock</a>  (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="schroedinger-schroparams.html#schro-params-get-block-params" title="schro_params_get_block_params ()">schro_params_get_block_params</a>       (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="schroedinger-schroparams.html#schro-params-get-frame-format" title="schro_params_get_frame_format ()">schro_params_get_frame_format</a>       (<em class="parameter"><code><span class="type">int</span> depth</code></em>,
                                                         <em class="parameter"><code><a class="link" href="schroedinger-schrobitstream.html#SchroChromaFormat" title="enum SchroChromaFormat"><span class="type">SchroChromaFormat</span></a> chroma_format</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="schroedinger-schroparams.html#schro-params-init" title="schro_params_init ()">schro_params_init</a>                   (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> video_format</code></em>);
<a class="link" href="schroedinger-schroutils.html#schro-bool" title="schro_bool"><span class="returnvalue">schro_bool</span></a>          <a class="link" href="schroedinger-schroparams.html#schro-params-is-default-codeblock" title="schro_params_is_default_codeblock ()">schro_params_is_default_codeblock</a>   (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<a class="link" href="schroedinger-schroutils.html#schro-bool" title="schro_bool"><span class="returnvalue">schro_bool</span></a>          <a class="link" href="schroedinger-schroparams.html#schro-params-is-default-quant-matrix" title="schro_params_is_default_quant_matrix ()">schro_params_is_default_quant_matrix</a>
                                                        (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="schroedinger-schroparams.html#schro-params-set-default-quant-matrix" title="schro_params_set_default_quant_matrix ()">schro_params_set_default_quant_matrix</a>
                                                        (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="schroedinger-schroparams.html#schro-params-verify-block-params" title="schro_params_verify_block_params ()">schro_params_verify_block_params</a>    (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="schroedinger-schroparams.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="schroedinger-schroparams.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SchroVideoFormat"></a><h3>struct SchroVideoFormat</h3>
<pre class="programlisting">struct SchroVideoFormat {
  SchroVideoFormatEnum index;
  int width;
  int height;
  SchroChromaFormat chroma_format;

  schro_bool interlaced;
  schro_bool top_field_first;

  int frame_rate_numerator;
  int frame_rate_denominator;
  int aspect_ratio_numerator;
  int aspect_ratio_denominator;

  int clean_width;
  int clean_height;
  int left_offset;
  int top_offset;

  int luma_offset;
  int luma_excursion;
  int chroma_offset;
  int chroma_excursion;

  SchroColourPrimaries colour_primaries;
  SchroColourMatrix colour_matrix;
  SchroTransferFunction transfer_function;

  int interlaced_coding;

  int unused0;
  int unused1;
  int unused2;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SchroParams"></a><h3>struct SchroParams</h3>
<pre class="programlisting">struct SchroParams {
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SchroMotionVector"></a><h3>struct SchroMotionVector</h3>
<pre class="programlisting">struct SchroMotionVector {
  unsigned int pred_mode : 2;
  unsigned int using_global : 1;
  unsigned int split : 2;
  unsigned int unused : 3;
  unsigned int scan : 8;
  uint32_t metric;
  uint32_t chroma_metric;
  union {
    struct {
      int16_t dx[2];
      int16_t dy[2];
    } vec;
    struct {
      int16_t dc[3];
    } dc;
  } u;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SchroMotionField"></a><h3>struct SchroMotionField</h3>
<pre class="programlisting">struct SchroMotionField {
  int x_num_blocks;
  int y_num_blocks;
  SchroMotionVector *motion_vectors;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SchroGlobalMotion"></a><h3>struct SchroGlobalMotion</h3>
<pre class="programlisting">struct SchroGlobalMotion {
  int b0;
  int b1;
  int a_exp;
  int a00;
  int a01;
  int a10;
  int a11;
  int c_exp;
  int c0;
  int c1;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SchroPictureNumber"></a><h3>SchroPictureNumber</h3>
<pre class="programlisting">typedef uint32_t SchroPictureNumber;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-calculate-iwt-sizes"></a><h3>schro_params_calculate_iwt_sizes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                schro_params_calculate_iwt_sizes    (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
Calculates the size of the array used for wavelet transformation
using the current video format and transformation depth in the
<em class="parameter"><code>params</code></em> structure.  The <em class="parameter"><code>params</code></em> structure is updated with the new
values.
</p>
<p>
The structure fields changed are: iwt_chroma_width, iwt_chroma_height,
iwt_luma_width, iwt_luma_height.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>pointer to <em class="parameter"><code>SchroParams</code></em> structure</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-calculate-mc-sizes"></a><h3>schro_params_calculate_mc_sizes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                schro_params_calculate_mc_sizes     (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
Calculates the size of the array used for motion compensation
using the current video format and motion compensation paramters
in the <em class="parameter"><code>params</code></em> structure.  The <em class="parameter"><code>params</code></em> structure is updated with
the new values.
</p>
<p>
The structure fields changed are: x_num_blocks, y_num_blocks,
mc_luma_width, mc_luma_height, mc_chroma_width, mc_chroma_height,
x_offset, y_offset.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>pointer to <em class="parameter"><code>SchroParams</code></em> structure</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-set-block-params"></a><h3>schro_params_set_block_params ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 schro_params_set_block_params       (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
<p>
Sets the block parameters for motion compensation in the parameters
structure pointed to by <em class="parameter"><code>params</code></em> to the
standard block parameters given by <em class="parameter"><code>index</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>pointer to SchroParams structure</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>index to standard block parameters</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-set-default-codeblock"></a><h3>schro_params_set_default_codeblock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                schro_params_set_default_codeblock  (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
Sets the codeblock parameters in the parameters structure pointed to
by <em class="parameter"><code>params</code></em> to the defaults.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>pointer to SchroParams structure</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-get-block-params"></a><h3>schro_params_get_block_params ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 schro_params_get_block_params       (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-get-frame-format"></a><h3>schro_params_get_frame_format ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 schro_params_get_frame_format       (<em class="parameter"><code><span class="type">int</span> depth</code></em>,
                                                         <em class="parameter"><code><a class="link" href="schroedinger-schrobitstream.html#SchroChromaFormat" title="enum SchroChromaFormat"><span class="type">SchroChromaFormat</span></a> chroma_format</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-init"></a><h3>schro_params_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                schro_params_init                   (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> video_format</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-is-default-codeblock"></a><h3>schro_params_is_default_codeblock ()</h3>
<pre class="programlisting"><a class="link" href="schroedinger-schroutils.html#schro-bool" title="schro_bool"><span class="returnvalue">schro_bool</span></a>          schro_params_is_default_codeblock   (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>pointer to SchroParams structure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>True if the codeblocks in <em class="parameter"><code>params</code></em> are the default codeblocks.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-is-default-quant-matrix"></a><h3>schro_params_is_default_quant_matrix ()</h3>
<pre class="programlisting"><a class="link" href="schroedinger-schroutils.html#schro-bool" title="schro_bool"><span class="returnvalue">schro_bool</span></a>          schro_params_is_default_quant_matrix
                                                        (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-set-default-quant-matrix"></a><h3>schro_params_set_default_quant_matrix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                schro_params_set_default_quant_matrix
                                                        (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-params-verify-block-params"></a><h3>schro_params_verify_block_params ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 schro_params_verify_block_params    (<em class="parameter"><code><a class="link" href="schroedinger-schroparams.html#SchroParams" title="struct SchroParams"><span class="type">SchroParams</span></a> *params</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.