Adds 3rd clause to CELT license
[opus.git] / celt / mdct.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2008 Xiph.Org Foundation
3    Written by Jean-Marc Valin */
4 /*
5    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8
9    - Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11
12    - Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15
16    - Neither the name of Internet Society, IETF or IETF Trust, nor the
17    names of specific contributors, may be used to endorse or promote
18    products derived from this software without specific prior written
19    permission.
20
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 /* This is a simple MDCT implementation that uses a N/4 complex FFT
35    to do most of the work. It should be relatively straightforward to
36    plug in pretty much and FFT here.
37
38    This replaces the Vorbis FFT (and uses the exact same API), which
39    was a bit too messy and that was ending up duplicating code
40    (might as well use the same FFT everywhere).
41
42    The algorithm is similar to (and inspired from) Fabrice Bellard's
43    MDCT implementation in FFMPEG, but has differences in signs, ordering
44    and scaling in many places.
45 */
46
47 #ifndef MDCT_H
48 #define MDCT_H
49
50 #include "kiss_fft.h"
51 #include "arch.h"
52
53 typedef struct {
54    int n;
55    int maxshift;
56    const kiss_fft_state *kfft[4];
57    const kiss_twiddle_scalar * restrict trig;
58 } mdct_lookup;
59
60 int clt_mdct_init(mdct_lookup *l,int N, int maxshift);
61 void clt_mdct_clear(mdct_lookup *l);
62
63 /** Compute a forward MDCT and scale by 4/N, trashes the input array */
64 void clt_mdct_forward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar *out,
65       const opus_val16 *window, int overlap, int shift, int stride);
66
67 /** Compute a backward MDCT (no scaling) and performs weighted overlap-add
68     (scales implicitly by 1/2) */
69 void clt_mdct_backward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar *out,
70       const opus_val16 * restrict window, int overlap, int shift, int stride);
71
72 #endif