summaryrefslogtreecommitdiff
path: root/doc/tmpl/liboilfuncs-dct.sgml
blob: 6a20dc794b06a56c23949e2dfd149cbb743c331b (plain)
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
<!-- ##### SECTION Title ##### -->
DCT

<!-- ##### SECTION Short_Description ##### -->
Discrete Cosine Transform Related Function Classes

<!-- ##### SECTION Long_Description ##### -->
<para>
Functions operate on arrays of data.  The arrays can be either source
arrays (input only), destination arrays (output only), or in-place
arrays (both input and output).
</para>

<para>
The interpretation of a parameter can usually be determined from its
name.  Parameters for arrays are of the form d1_1xn, where the first
character represents the direction (source, destination, or in-place),
the second represents the index for that particular direction, and
the characters after the underscore indicate the size of the array.
In this case, "1xn" represents an array that is 1 by N.  Note that
the index and the size can both be omitted, giving a default of 1
for the index and 1xn for the size.
</para>

<para>
Parameters that represent strides are of the form "d1s".  The
interpretation is similar to above, except that the s indicates
a stride parameter.
</para>

<para>
The exceptions to the above rule are "dest", "src", "dstr", "sstr", etc.
These are aliases for "d1", "s1", "d1s", and "s1s", respectively.  This
form is deprecated and will be removed in the 0.4 series.
</para>

<para>
Two special parameters are "n" and "m", which determine the size of
the arrays in other parameters.
</para>

<para>
Data arrays are laid out such that rows are separated by the number
of bytes given by the corresponding stride.  Elements in each row
are contiguous.  If there is no stride parameter corresponding to an
array, the rows of the array are contiguous.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### FUNCTION oil_dct36_f32 ##### -->
<para>

</para>

@d_36: 
@dstr: 
@s_36: 
@sstr: 


<!-- ##### FUNCTION oil_fdct8_f64 ##### -->
<para>

Calculates the forward discrete cosine transform on the source array.
</para>

@d_8: 
@s_8: 
@dstr: 
@sstr: 


<!-- ##### FUNCTION oil_fdct8x8_f64 ##### -->
<para>

Calculates the 2-D forward discrete cosine transform on the source array.
</para>

@d_8x8: 
@dstr: 
@s_8x8: 
@sstr: 


<!-- ##### FUNCTION oil_fdct8x8s_s16 ##### -->
<para>

Calculates the 2-D forward discrete cosine transform on the source array,
multiplying some values in the destination array by values interesting
to the algorithm.  This function is not recommended.
</para>

@d_8x8: 
@ds: 
@s_8x8: 
@ss: 


<!-- ##### FUNCTION oil_idct8_f64 ##### -->
<para>

Calculates the inverse discrete cosine transform on the source array.
</para>

@d_8: 
@dstr: 
@s_8: 
@sstr: 


<!-- ##### FUNCTION oil_idct8x8_f64 ##### -->
<para>

Calculates the 2-D inverse discrete cosine transform on the source array.
</para>

@d_8x8: 
@dstr: 
@s_8x8: 
@sstr: 


<!-- ##### FUNCTION oil_idct8x8_s16 ##### -->
<para>

Calculates the 2-D inverse discrete cosine transform on the source array,
multiplying some values in the destination array by values interesting
to the algorithm.  This function is not recommended.
</para>

@d_8x8: 
@dstr: 
@s_8x8: 
@sstr: 


<!-- ##### FUNCTION oil_imdct12_f64 ##### -->
<para>

Calculate the inverse modified discrete cosine transform of the source
array.  This function is interesting in mp3 decoding.
</para>

@d_12: 
@s_6: 


<!-- ##### FUNCTION oil_imdct32_f32 ##### -->
<para>

Calculate the inverse modified discrete cosine transform of the source
array.  This function is interesting in mp3 decoding.
</para>

@d_32: 
@s_32: 


<!-- ##### FUNCTION oil_imdct36_f64 ##### -->
<para>

Calculate the inverse modified discrete cosine transform of the source
array.  This function is interesting in mp3 decoding.
</para>

@d_36: 
@s_18: 


<!-- ##### FUNCTION oil_mdct12_f64 ##### -->
<para>

Calculates the modified discrete cosine transform of the source array.
</para>

@d_6: 
@s_12: 


<!-- ##### FUNCTION oil_mdct36_f64 ##### -->
<para>

Calculates the modified discrete cosine transform of the source array.
</para>

@d_18: 
@s_36: 


<!-- ##### FUNCTION oil_idct8theora_s16 ##### -->
<para>
Requires version 0.3.2
</para>

@d_8: 
@dstr: 
@s_8: 
@sstr: 


<!-- ##### FUNCTION oil_idct8x8lim10_f64 ##### -->
<para>
Requires version 0.3.2
</para>

@d_8x8: 
@dstr: 
@s_8x8: 
@sstr: 


<!-- ##### FUNCTION oil_idct8x8lim10_s16 ##### -->
<para>
Requires version 0.3.2
</para>

@d_8x8: 
@dstr: 
@s_8x8: 
@sstr: 


<!-- ##### FUNCTION oil_idct8x8theora_s16 ##### -->
<para>
Requires version 0.3.2
</para>

@d_8x8: 
@dstr: 
@s_8x8: 
@sstr: