Re-enables test cases, including the rotation test
[opus.git] / libcelt / kiss_fft.c
index 4513498..98b3eff 100644 (file)
@@ -10,7 +10,6 @@ Redistribution and use in source and binary forms, with or without modification,
 
     * 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 author nor the names of any 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */
@@ -41,7 +40,7 @@ static void kf_bfly2(
                     )
 {
    kiss_fft_cpx * Fout2;
-   kiss_twiddle_cpx * tw1;
+   const kiss_twiddle_cpx * tw1;
    int i,j;
    kiss_fft_cpx * Fout_beg = Fout;
    for (i=0;i<N;i++)
@@ -74,7 +73,7 @@ static void ki_bfly2(
                     )
 {
    kiss_fft_cpx * Fout2;
-   kiss_twiddle_cpx * tw1;
+   const kiss_twiddle_cpx * tw1;
    kiss_fft_cpx t;
    int i,j;
    kiss_fft_cpx * Fout_beg = Fout;
@@ -104,7 +103,7 @@ static void kf_bfly4(
                      int mm
                     )
 {
-   kiss_twiddle_cpx *tw1,*tw2,*tw3;
+   const kiss_twiddle_cpx *tw1,*tw2,*tw3;
    kiss_fft_cpx scratch[6];
    const size_t m2=2*m;
    const size_t m3=3*m;
@@ -120,7 +119,7 @@ static void kf_bfly4(
          C_MUL4(scratch[0],Fout[m] , *tw1 );
          C_MUL4(scratch[1],Fout[m2] , *tw2 );
          C_MUL4(scratch[2],Fout[m3] , *tw3 );
-             
+
          Fout->r = PSHR(Fout->r, 2);
          Fout->i = PSHR(Fout->i, 2);
          C_SUB( scratch[5] , *Fout, scratch[1] );
@@ -134,7 +133,7 @@ static void kf_bfly4(
          tw2 += fstride*2;
          tw3 += fstride*3;
          C_ADDTO( *Fout , scratch[3] );
-             
+
          Fout[m].r = scratch[5].r + scratch[4].i;
          Fout[m].i = scratch[5].i - scratch[4].r;
          Fout[m3].r = scratch[5].r - scratch[4].i;
@@ -153,7 +152,7 @@ static void ki_bfly4(
                      int mm
                     )
 {
-   kiss_twiddle_cpx *tw1,*tw2,*tw3;
+   const kiss_twiddle_cpx *tw1,*tw2,*tw3;
    kiss_fft_cpx scratch[6];
    const size_t m2=2*m;
    const size_t m3=3*m;
@@ -169,7 +168,7 @@ static void ki_bfly4(
          C_MULC(scratch[0],Fout[m] , *tw1 );
          C_MULC(scratch[1],Fout[m2] , *tw2 );
          C_MULC(scratch[2],Fout[m3] , *tw3 );
-             
+
          C_SUB( scratch[5] , *Fout, scratch[1] );
          C_ADDTO(*Fout, scratch[1]);
          C_ADD( scratch[3] , scratch[0] , scratch[2] );
@@ -179,7 +178,7 @@ static void ki_bfly4(
          tw2 += fstride*2;
          tw3 += fstride*3;
          C_ADDTO( *Fout , scratch[3] );
-             
+
          Fout[m].r = scratch[5].r - scratch[4].i;
          Fout[m].i = scratch[5].i + scratch[4].r;
          Fout[m3].r = scratch[5].r + scratch[4].i;
@@ -203,7 +202,7 @@ static void kf_bfly3(
    int i;
    size_t k;
    const size_t m2 = 2*m;
-   kiss_twiddle_cpx *tw1,*tw2;
+   const kiss_twiddle_cpx *tw1,*tw2;
    kiss_fft_cpx scratch[5];
    kiss_twiddle_cpx epi3;
 
@@ -254,7 +253,7 @@ static void ki_bfly3(
 {
    size_t i, k;
    const size_t m2 = 2*m;
-   kiss_twiddle_cpx *tw1,*tw2;
+   const kiss_twiddle_cpx *tw1,*tw2;
    kiss_fft_cpx scratch[5];
    kiss_twiddle_cpx epi3;
 
@@ -293,7 +292,6 @@ static void ki_bfly3(
    }
 }
 
-
 static void kf_bfly5(
                      kiss_fft_cpx * Fout,
                      const size_t fstride,
@@ -306,8 +304,8 @@ static void kf_bfly5(
    kiss_fft_cpx *Fout0,*Fout1,*Fout2,*Fout3,*Fout4;
    int i, u;
    kiss_fft_cpx scratch[13];
-   kiss_twiddle_cpx * twiddles = st->twiddles;
-   kiss_twiddle_cpx *tw;
+   const kiss_twiddle_cpx * twiddles = st->twiddles;
+   const kiss_twiddle_cpx *tw;
    kiss_twiddle_cpx ya,yb;
    kiss_fft_cpx * Fout_beg = Fout;
 
@@ -375,8 +373,8 @@ static void ki_bfly5(
    kiss_fft_cpx *Fout0,*Fout1,*Fout2,*Fout3,*Fout4;
    int i, u;
    kiss_fft_cpx scratch[13];
-   kiss_twiddle_cpx * twiddles = st->twiddles;
-   kiss_twiddle_cpx *tw;
+   const kiss_twiddle_cpx * twiddles = st->twiddles;
+   const kiss_twiddle_cpx *tw;
    kiss_twiddle_cpx ya,yb;
    kiss_fft_cpx * Fout_beg = Fout;
 
@@ -433,57 +431,22 @@ static void ki_bfly5(
 
 #endif
 
-static
-void compute_bitrev_table(
-         int Fout,
-         celt_int16 *f,
-         const size_t fstride,
-         int in_stride,
-         celt_int16 * factors,
-         const kiss_fft_state *st
-            )
-{
-   const int p=*factors++; /* the radix  */
-   const int m=*factors++; /* stage's fft length/p */
-   
-    /*printf ("fft %d %d %d %d %d %d\n", p*m, m, p, s2, fstride*in_stride, N);*/
-   if (m==1)
-   {
-      int j;
-      for (j=0;j<p;j++)
-      {
-         *f = Fout+j;
-         f += fstride*in_stride;
-      }
-   } else {
-      int j;
-      for (j=0;j<p;j++)
-      {
-         compute_bitrev_table( Fout , f, fstride*p, in_stride, factors,st);
-         f += fstride*in_stride;
-         Fout += m;
-      }
-   }
-}
-
-
 static void kf_work(
         kiss_fft_cpx * Fout,
         const kiss_fft_cpx * f,
         size_t fstride,
         int in_stride,
-        celt_int16 * factors,
+        const opus_int16 * factors,
         const kiss_fft_state *st,
         int N,
-        int s2,
         int m2
         )
 {
     const int p=*factors++; /* the radix  */
     const int m=*factors++; /* stage's fft length/p */
     /*printf ("fft %d %d %d %d %d %d %d\n", p*m, m, p, s2, fstride*in_stride, N, m2);*/
-    if (m!=1) 
-        kf_work( Fout , f, fstride*p, in_stride, factors,st, N*p, fstride*in_stride, m);
+    if (m!=1)
+        kf_work( Fout , f, fstride*p, in_stride, factors,st, N*p, m);
 
     /* Compensate for longer twiddles table (when sharing) */
     if (st->shift>0)
@@ -494,30 +457,26 @@ static void kf_work(
 #ifndef RADIX_TWO_ONLY
         case 3: kf_bfly3(Fout,fstride,st,m, N, m2); break;
         case 5: kf_bfly5(Fout,fstride,st,m, N, m2); break;
-#else
-       default: celt_fatal("kiss_fft: only powers of two enabled");
 #endif
-    }    
+    }
 }
 
-
 static void ki_work(
              kiss_fft_cpx * Fout,
              const kiss_fft_cpx * f,
              size_t fstride,
              int in_stride,
-             celt_int16 * factors,
+             const opus_int16 * factors,
              const kiss_fft_state *st,
              int N,
-             int s2,
              int m2
             )
 {
    const int p=*factors++; /* the radix  */
    const int m=*factors++; /* stage's fft length/p */
    /*printf ("fft %d %d %d %d %d %d %d\n", p*m, m, p, s2, fstride*in_stride, N, m2);*/
-   if (m!=1) 
-      ki_work( Fout , f, fstride*p, in_stride, factors,st, N*p, fstride*in_stride, m);
+   if (m!=1)
+      ki_work( Fout , f, fstride*p, in_stride, factors,st, N*p, m);
 
    /* Compensate for longer twiddles table (when sharing) */
    if (st->shift>0)
@@ -528,18 +487,51 @@ static void ki_work(
 #ifndef RADIX_TWO_ONLY
       case 3: ki_bfly3(Fout,fstride,st,m, N, m2); break;
       case 5: ki_bfly5(Fout,fstride,st,m, N, m2); break;
-#else
-      default: celt_fatal("kiss_fft: only powers of two enabled");
 #endif
-   }    
+   }
+}
+
+#ifdef CUSTOM_MODES
+
+static
+void compute_bitrev_table(
+         int Fout,
+         opus_int16 *f,
+         const size_t fstride,
+         int in_stride,
+         opus_int16 * factors,
+         const kiss_fft_state *st
+            )
+{
+   const int p=*factors++; /* the radix  */
+   const int m=*factors++; /* stage's fft length/p */
+
+    /*printf ("fft %d %d %d %d %d %d\n", p*m, m, p, s2, fstride*in_stride, N);*/
+   if (m==1)
+   {
+      int j;
+      for (j=0;j<p;j++)
+      {
+         *f = Fout+j;
+         f += fstride*in_stride;
+      }
+   } else {
+      int j;
+      for (j=0;j<p;j++)
+      {
+         compute_bitrev_table( Fout , f, fstride*p, in_stride, factors,st);
+         f += fstride*in_stride;
+         Fout += m;
+      }
+   }
 }
 
 /*  facbuf is populated by p1,m1,p2,m2, ...
-    where 
+    where
     p[i] * m[i] = m[i-1]
     m0 = n                  */
-static 
-int kf_factor(int n,celt_int16 * facbuf)
+static
+int kf_factor(int n,opus_int16 * facbuf)
 {
     int p=4;
 
@@ -551,13 +543,16 @@ int kf_factor(int n,celt_int16 * facbuf)
                 case 2: p = 3; break;
                 default: p += 2; break;
             }
-            if (p>32000 || (celt_int32)p*(celt_int32)p > n)
+            if (p>32000 || (opus_int32)p*(opus_int32)p > n)
                 p = n;          /* no more factors, skip to end */
         }
         n /= p;
+#ifdef RADIX_TWO_ONLY
+        if (p!=2 && p != 4)
+#else
         if (p>5)
+#endif
         {
-           celt_warning("Only powers of 2, 3 and 5 are supported");
            return 0;
         }
         *facbuf++ = p;
@@ -571,7 +566,7 @@ static void compute_twiddles(kiss_twiddle_cpx *twiddles, int nfft)
    int i;
 #ifdef FIXED_POINT
    for (i=0;i<nfft;++i) {
-      celt_word32 phase = -i;
+      opus_val32 phase = -i;
       kf_cexp2(twiddles+i, DIV32(SHL32(phase,17),nfft));
    }
 #else
@@ -583,7 +578,6 @@ static void compute_twiddles(kiss_twiddle_cpx *twiddles, int nfft)
 #endif
 }
 
-
 /*
  *
  * User-callable function to allocate all necessary storage space for the fft.
@@ -591,7 +585,7 @@ static void compute_twiddles(kiss_twiddle_cpx *twiddles, int nfft)
  * The return value is a contiguous block of memory, allocated with malloc.  As such,
  * It can be freed with free(), rather than a kiss_fft-specific function.
  * */
-kiss_fft_state *kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem,  kiss_fft_state *base)
+kiss_fft_state *kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem,  const kiss_fft_state *base)
 {
     kiss_fft_state *st=NULL;
     size_t memneeded = sizeof(struct kiss_fft_state); /* twiddle factors*/
@@ -604,6 +598,9 @@ kiss_fft_state *kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem,  ki
         *lenmem = memneeded;
     }
     if (st) {
+        opus_int16 *bitrev;
+        kiss_twiddle_cpx *twiddles;
+
         st->nfft=nfft;
 #ifndef FIXED_POINT
         st->scale = 1./nfft;
@@ -614,25 +611,29 @@ kiss_fft_state *kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem,  ki
            st->shift = 0;
            while (nfft<<st->shift != base->nfft && st->shift < 32)
               st->shift++;
-           /* FIXME: Report error and do proper cleanup */
            if (st->shift>=32)
-              return NULL;
+              goto fail;
         } else {
-           st->twiddles = (kiss_twiddle_cpx*)KISS_FFT_MALLOC(sizeof(kiss_twiddle_cpx)*nfft);
-           compute_twiddles(st->twiddles, nfft);
+           st->twiddles = twiddles = (kiss_twiddle_cpx*)KISS_FFT_MALLOC(sizeof(kiss_twiddle_cpx)*nfft);
+           compute_twiddles(twiddles, nfft);
            st->shift = -1;
         }
         if (!kf_factor(nfft,st->factors))
         {
            kiss_fft_free(st);
-           return NULL;
+           goto fail;
         }
-        
+
         /* bitrev */
-        st->bitrev = (celt_int16*)KISS_FFT_MALLOC(sizeof(celt_int16)*nfft);
-        compute_bitrev_table(0, st->bitrev, 1,1, st->factors,st);
+        st->bitrev = bitrev = (opus_int16*)KISS_FFT_MALLOC(sizeof(opus_int16)*nfft);
+        if (st->bitrev==NULL)
+            goto fail;
+        compute_bitrev_table(0, bitrev, 1,1, st->factors,st);
     }
     return st;
+fail:
+    kiss_fft_free(st);
+    return NULL;
 }
 
 kiss_fft_state *kiss_fft_alloc(int nfft,void * mem,size_t * lenmem )
@@ -640,55 +641,52 @@ kiss_fft_state *kiss_fft_alloc(int nfft,void * mem,size_t * lenmem )
    return kiss_fft_alloc_twiddles(nfft, mem, lenmem, NULL);
 }
 
-    
-static void kiss_fft_stride(kiss_fft_state *st,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int in_stride)
+void kiss_fft_free(const kiss_fft_state *cfg)
+{
+   if (cfg)
+   {
+      celt_free((opus_int16*)cfg->bitrev);
+      if (cfg->shift < 0)
+         celt_free((kiss_twiddle_cpx*)cfg->twiddles);
+      celt_free((kiss_fft_state*)cfg);
+   }
+}
+
+#endif /* CUSTOM_MODES */
+
+static void kiss_fft_stride(const kiss_fft_state *st,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int in_stride)
 {
-    if (fin == fout) 
+    int i;
+    celt_assert2 (fin != fout, "In-place FFT not supported");
+    /* Bit-reverse the input */
+    for (i=0;i<st->nfft;i++)
     {
-       celt_fatal("In-place FFT not supported");
-    } else {
-       /* Bit-reverse the input */
-       int i;
-       for (i=0;i<st->nfft;i++)
-       {
-          fout[st->bitrev[i]] = fin[i];
+       fout[st->bitrev[i]] = fin[i];
 #ifndef FIXED_POINT
-          fout[st->bitrev[i]].r *= st->scale;
-          fout[st->bitrev[i]].i *= st->scale;
+       fout[st->bitrev[i]].r *= st->scale;
+       fout[st->bitrev[i]].i *= st->scale;
 #endif
-       }
-       kf_work( fout, fin, 1,in_stride, st->factors,st, 1, in_stride, 1);
     }
+    kf_work( fout, fin, 1,in_stride, st->factors,st, 1, 1);
 }
 
-void kiss_fft(kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout)
+void kiss_fft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout)
 {
     kiss_fft_stride(cfg,fin,fout,1);
 }
 
-static void kiss_ifft_stride(kiss_fft_state *st,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int in_stride)
+static void kiss_ifft_stride(const kiss_fft_state *st,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int in_stride)
 {
-   if (fin == fout) 
-   {
-      celt_fatal("In-place FFT not supported");
-   } else {
-      /* Bit-reverse the input */
-      int i;
-      for (i=0;i<st->nfft;i++)
-         fout[st->bitrev[i]] = fin[i];
-      ki_work( fout, fin, 1,in_stride, st->factors,st, 1, in_stride, 1);
-   }
+   int i;
+   celt_assert2 (fin != fout, "In-place FFT not supported");
+   /* Bit-reverse the input */
+   for (i=0;i<st->nfft;i++)
+      fout[st->bitrev[i]] = fin[i];
+   ki_work( fout, fin, 1,in_stride, st->factors,st, 1, 1);
 }
 
-void kiss_ifft(kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout)
+void kiss_ifft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout)
 {
    kiss_ifft_stride(cfg,fin,fout,1);
 }
 
-void kiss_fft_free(kiss_fft_state *cfg)
-{
-   celt_free(cfg->bitrev);
-   if (cfg->shift < 0)
-      celt_free(cfg->twiddles);
-   celt_free(cfg);
-}