summaryrefslogtreecommitdiffstats
path: root/java/src/nz/ac/waikato/ffts/FFTS.java
blob: 5b6771c6c8fdd6847122d99994ea77ab71f07e04 (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
/*
 *  This file is part of FFTS -- The Fastest Fourier Transform in the South
 *
 * Copyright (c) 2013, Michael Zucchi <notzed@gmail.com>
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of the organization nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ANTHONY M. BLAKE BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package nz.ac.waikato.ffts;

import java.nio.FloatBuffer;

/**
 * A java wrapper for ffts plans.
 *
 * Plans must currently be freed explicitly.
 *
 * @author notzed
 */
public class FFTS {

	/**
	 * C pointer
	 */
	private long p;
	/**
	 * Minimum size of input
	 */
	final protected long inSize;
	/**
	 * Minimum size of output
	 */
	final protected long outSize;

	private FFTS(long p, long inSize) {
		this(p, inSize, inSize);
	}

	private FFTS(long p, long inSize, long outSize) {
		this.p = p;
		this.inSize = inSize;
		this.outSize = inSize;
	}
	/**
	 * The sign to use for a forward transform.
	 */
	public static final int FORWARD = -1;
	/**
	 * The sign to use for a backward transform.
	 */
	public static final int BACKWARD = 1;

	/**
	 * Create a FFT plan for a 1-dimensional complex transform.
	 *
	 * The src and dst parameters to execute() use complex data.
	 *
	 * @param sign The direction of the transform.
	 * @param N The size of the transform.
	 * @return
	 */
	public static FFTS complex(int sign, int N) {
		return new FFTS(complex_1d(N, sign), N * 2);
	}

	/**
	 * Create a FFT plan for a 2-dimensional complex transform.
	 * @param sign The direction of the transform.
	 * @param N1 The size of the transform.
	 * @param N2 The size of the transform.
	 * @return
	 */
	public static FFTS complex(int sign, int N1, int N2) {
		return new FFTS(complex_2d(N1, N2, sign), N1 * N2 * 2);
	}

	public static FFTS complex(int sign, int... Ns) {
		return new FFTS(complex_nd(Ns, sign), size(Ns) * 2);
	}

	public static FFTS real(int sign, int N) {
		return new FFTS(real_1d(N, sign), sign == FORWARD ? N : (N / 2 + 1) * 2, sign == FORWARD ? (N / 2 + 1) * 2 : N);
	}

	public static FFTS real(int sign, int N1, int N2) {
		return new FFTS(real_2d(N1, N2, sign), sign == FORWARD ? N1 * N2 : (N1 * N2 / 2 + 1) * 2, sign == FORWARD ? (N1 * N2 / 2 + 1) * 2 : N1 * N2);
	}

	public static FFTS real(int sign, int... Ns) {
		return new FFTS(real_nd(Ns, sign), sign == FORWARD ? size(Ns) : (size(Ns) / 2 + 1) * 2, sign == FORWARD ? (size(Ns) / 2 + 1) * 2 : size(Ns));
	}

	/**
	 * Execute this plan with the given array data.
	 *
	 * @param src
	 * @param dst
	 */
	public void execute(float[] src, float[] dst) {
		execute(src, 0, dst, 0);
	}

	/**
	 * Execute this plan with the given array data.
	 * @param src
	 * @param soff Start offset into src array.
	 * @param dst
	 * @param doff Start offset into dst array.
	 */
	public void execute(float[] src, int soff, float[] dst, int doff) {
		if (src.length - soff < inSize || dst.length - doff < outSize)
			throw new ArrayIndexOutOfBoundsException();
		if (p == 0)
			throw new NullPointerException();

		execute(p, inSize, src, soff, dst, doff);
	}

	/**
	 * Execute this plan with the given nio buffers.  The bufffers
	 * must be derived from direct buffers.
	 *
	 * The buffer position and limits are ignored.
	 *
	 * @param src
	 * @param dst
	 */
	public void execute(FloatBuffer src, FloatBuffer dst) {
		if (src.capacity() < inSize || dst.capacity() < outSize)
			throw new ArrayIndexOutOfBoundsException();
		if (p == 0)
			throw new NullPointerException();

		execute(p, inSize, src, dst);
	}

	/**
	 * Free the plan.
	 */
	public void free() {
		if (p == 0)
			throw new NullPointerException();
		free(p);
	}

	/*
	 * Calculate the number of elements required to store one
	 * set of n-dimensional data.
	 */
	protected static long size(int[] Ns) {
		long s = Ns[0];
		for (int i = 1; i < Ns.length; i++)
			s *= Ns[i];
		return s;
	}

	static {
		System.loadLibrary("ffts_jni");
	}

	/*
	 * Native interface
	 */
	protected static native long complex_1d(int N, int sign);

	protected static native long complex_2d(int N1, int N2, int sign);

	protected static native long complex_nd(int[] Ns, int sign);

	protected static native long real_1d(int N, int sign);

	protected static native long real_2d(int N1, int N2, int sign);

	protected static native long real_nd(int[] Ns, int sign);

	protected static native void execute(long p, long size, float[] src, int soff, float[] dst, int doff);

	protected static native void execute(long p, long size, FloatBuffer src, FloatBuffer dst);

	protected static native void free(long p);
}
OpenPOWER on IntegriCloud