libcelt/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 the Xiph.org Foundation nor the names of its
  17    contributors may be used to endorse or promote products derived from
  18    this software without specific prior written permission.
  19
  20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 */
  32
  33 /* This is a simple MDCT implementation that uses a N/4 complex FFT
  34    to do most of the work. It should be relatively straightforward to
  35    plug in pretty much and FFT here.
  36
  37    This replaces the Vorbis FFT (and uses the exact same API), which
  38    was a bit too messy and that was ending up duplicating code
  39    (might as well use the same FFT everywhere).
  40
  41    The algorithm is similar to (and inspired from) Fabrice Bellard's
  42    MDCT implementation in FFMPEG, but has differences in signs, ordering
  43    and scaling in many places.
  44 */
  45
  46 #ifndef MDCT_H
  47 #define MDCT_H
  48
  49 #include "kiss_fft.h"
  50 #include "arch.h"
  51
  52 typedef struct {
  53    int n;
  54    int maxshift;
  55    const kiss_fft_state *kfft[4];
  56    const kiss_twiddle_scalar * restrict trig;
  57 } mdct_lookup;
  58
  59 void clt_mdct_init(mdct_lookup *l,int N, int maxshift);
  60 void clt_mdct_clear(mdct_lookup *l);
  61
  62 /** Compute a forward MDCT and scale by 4/N */
  63 void clt_mdct_forward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar *out, const celt_word16 *window, int overlap, int shift);
  64
  65 /** Compute a backward MDCT (no scaling) and performs weighted overlap-add
  66     (scales implicitly by 1/2) */
  67 void clt_mdct_backward(const mdct_lookup *l, kiss_fft_scalar *in, kiss_fft_scalar *out, const celt_word16 * restrict window, int overlap, int shift);
  68
  69 #endif