Patch for trac #1965; clarify in comments and docs that a failed call
[platform/upstream/libvorbis.git] / lib / floor0.c
index fb9e1ba..99a083b 100644 (file)
 /********************************************************************
  *                                                                  *
- * THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
- * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
- * THE GNU PUBLIC LICENSE 2, WHICH IS INCLUDED WITH THIS SOURCE.    *
- * PLEASE READ THESE TERMS DISTRIBUTING.                            *
+ * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
+ * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
+ * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
+ * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
  *                                                                  *
- * THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-2000             *
- * by Monty <monty@xiph.org> and The XIPHOPHORUS Company            *
- * http://www.xiph.org/                                             *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2009             *
+ * by the Xiph.Org Foundation http://www.xiph.org/                  *
  *                                                                  *
  ********************************************************************
 
  function: floor backend 0 implementation
- last mod: $Id: floor0.c,v 1.12 2000/03/10 13:21:18 xiphmont Exp $
+ last mod: $Id$
 
  ********************************************************************/
 
 #include <stdlib.h>
 #include <string.h>
 #include <math.h>
+#include <ogg/ogg.h>
 #include "vorbis/codec.h"
-#include "bitwise.h"
+#include "codec_internal.h"
 #include "registry.h"
 #include "lpc.h"
 #include "lsp.h"
-#include "bookinternal.h"
+#include "codebook.h"
 #include "scales.h"
 #include "misc.h"
+#include "os.h"
+
+#include "misc.h"
+#include <stdio.h>
 
 typedef struct {
-  long n;
-  long m;
-  
-  double ampscale;
-  double ampvals;
+  int ln;
+  int  m;
+  int **linearmap;
+  int  n[2];
 
   vorbis_info_floor0 *vi;
-  lpc_lookup lpclook;
+
+  long bits;
+  long frames;
 } vorbis_look_floor0;
 
-static void free_info(vorbis_info_floor *i){
-  if(i){
-    memset(i,0,sizeof(vorbis_info_floor0));
-    free(i);
+
+/***********************************************/
+
+static void floor0_free_info(vorbis_info_floor *i){
+  vorbis_info_floor0 *info=(vorbis_info_floor0 *)i;
+  if(info){
+    memset(info,0,sizeof(*info));
+    _ogg_free(info);
   }
 }
 
-static void free_look(vorbis_look_floor *i){
+static void floor0_free_look(vorbis_look_floor *i){
   vorbis_look_floor0 *look=(vorbis_look_floor0 *)i;
-  if(i){
-    lpc_clear(&look->lpclook);
-    memset(look,0,sizeof(vorbis_look_floor0));
-    free(look);
+  if(look){
+
+    if(look->linearmap){
+
+      if(look->linearmap[0])_ogg_free(look->linearmap[0]);
+      if(look->linearmap[1])_ogg_free(look->linearmap[1]);
+
+      _ogg_free(look->linearmap);
+    }
+    memset(look,0,sizeof(*look));
+    _ogg_free(look);
   }
 }
 
-static void pack (vorbis_info_floor *i,oggpack_buffer *opb){
-  vorbis_info_floor0 *info=(vorbis_info_floor0 *)i;
+static vorbis_info_floor *floor0_unpack (vorbis_info *vi,oggpack_buffer *opb){
+  codec_setup_info     *ci=vi->codec_setup;
   int j;
-  _oggpack_write(opb,info->order,8);
-  _oggpack_write(opb,info->rate,16);
-  _oggpack_write(opb,info->barkmap,16);
-  _oggpack_write(opb,info->ampbits,6);
-  _oggpack_write(opb,info->ampdB,8);
-  _oggpack_write(opb,info->stages-1,4);
-  for(j=0;j<info->stages;j++)
-    _oggpack_write(opb,info->books[j],8);
-}
 
-static vorbis_info_floor *unpack (vorbis_info *vi,oggpack_buffer *opb){
-  int j;
-  vorbis_info_floor0 *info=malloc(sizeof(vorbis_info_floor0));
-  info->order=_oggpack_read(opb,8);
-  info->rate=_oggpack_read(opb,16);
-  info->barkmap=_oggpack_read(opb,16);
-  info->ampbits=_oggpack_read(opb,6);
-  info->ampdB=_oggpack_read(opb,8);
-  info->stages=_oggpack_read(opb,4)+1;
-  
+  vorbis_info_floor0 *info=_ogg_malloc(sizeof(*info));
+  info->order=oggpack_read(opb,8);
+  info->rate=oggpack_read(opb,16);
+  info->barkmap=oggpack_read(opb,16);
+  info->ampbits=oggpack_read(opb,6);
+  info->ampdB=oggpack_read(opb,8);
+  info->numbooks=oggpack_read(opb,4)+1;
+
   if(info->order<1)goto err_out;
   if(info->rate<1)goto err_out;
   if(info->barkmap<1)goto err_out;
-  if(info->stages<1)goto err_out;
+  if(info->numbooks<1)goto err_out;
 
-  for(j=0;j<info->stages;j++){
-    info->books[j]=_oggpack_read(opb,8);
-    if(info->books[j]<0 || info->books[j]>=vi->books)goto err_out;
+  for(j=0;j<info->numbooks;j++){
+    info->books[j]=oggpack_read(opb,8);
+    if(info->books[j]<0 || info->books[j]>=ci->books)goto err_out;
+    if(ci->book_param[info->books[j]]->maptype==0)goto err_out;
+    if(ci->book_param[info->books[j]]->dim<1)goto err_out;
   }
-  return(info);  
+  return(info);
+
  err_out:
-  free_info(info);
+  floor0_free_info(info);
   return(NULL);
 }
 
-static vorbis_look_floor *look (vorbis_dsp_state *vd,vorbis_info_mode *mi,
-                              vorbis_info_floor *i){
-  vorbis_info        *vi=vd->vi;
+/* initialize Bark scale and normalization lookups.  We could do this
+   with static tables, but Vorbis allows a number of possible
+   combinations, so it's best to do it computationally.
+
+   The below is authoritative in terms of defining scale mapping.
+   Note that the scale depends on the sampling rate as well as the
+   linear block and mapping sizes */
+
+static void floor0_map_lazy_init(vorbis_block      *vb,
+                                 vorbis_info_floor *infoX,
+                                 vorbis_look_floor0 *look){
+  if(!look->linearmap[vb->W]){
+    vorbis_dsp_state   *vd=vb->vd;
+    vorbis_info        *vi=vd->vi;
+    codec_setup_info   *ci=vi->codec_setup;
+    vorbis_info_floor0 *info=(vorbis_info_floor0 *)infoX;
+    int W=vb->W;
+    int n=ci->blocksizes[W]/2,j;
+
+    /* we choose a scaling constant so that:
+       floor(bark(rate/2-1)*C)=mapped-1
+     floor(bark(rate/2)*C)=mapped */
+    float scale=look->ln/toBARK(info->rate/2.f);
+
+    /* the mapping from a linear scale to a smaller bark scale is
+       straightforward.  We do *not* make sure that the linear mapping
+       does not skip bark-scale bins; the decoder simply skips them and
+       the encoder may do what it wishes in filling them.  They're
+       necessary in some mapping combinations to keep the scale spacing
+       accurate */
+    look->linearmap[W]=_ogg_malloc((n+1)*sizeof(**look->linearmap));
+    for(j=0;j<n;j++){
+      int val=floor( toBARK((info->rate/2.f)/n*j)
+                     *scale); /* bark numbers represent band edges */
+      if(val>=look->ln)val=look->ln-1; /* guard against the approximation */
+      look->linearmap[W][j]=val;
+    }
+    look->linearmap[W][j]=-1;
+    look->n[W]=n;
+  }
+}
+
+static vorbis_look_floor *floor0_look(vorbis_dsp_state *vd,
+                                      vorbis_info_floor *i){
   vorbis_info_floor0 *info=(vorbis_info_floor0 *)i;
-  vorbis_look_floor0 *look=malloc(sizeof(vorbis_look_floor0));
+  vorbis_look_floor0 *look=_ogg_calloc(1,sizeof(*look));
   look->m=info->order;
-  look->n=vi->blocksizes[mi->blockflag]/2;
+  look->ln=info->barkmap;
   look->vi=info;
-  lpc_init(&look->lpclook,look->n,info->barkmap,info->rate,look->m);
+
+  look->linearmap=_ogg_calloc(2,sizeof(*look->linearmap));
 
   return look;
 }
 
-#include <stdio.h>
-
-static int forward(vorbis_block *vb,vorbis_look_floor *i,
-                   double *in,double *out){
-  long j,k,stage;
+static void *floor0_inverse1(vorbis_block *vb,vorbis_look_floor *i){
   vorbis_look_floor0 *look=(vorbis_look_floor0 *)i;
   vorbis_info_floor0 *info=look->vi;
-  double amp;
-  long bits=0;
-
-  /* use 'out' as temp storage */
-  /* Convert our floor to a set of lpc coefficients */ 
-  amp=sqrt(vorbis_curve_to_lpc(in,out,&look->lpclook));
-
-  /* amp is in the range 0. to 1. (well, more like .7). Log scale it */
-  
-  /* 0              == 0 dB
-     (1<<ampbits)-1 == amp dB   = 1. amp */
-  {
-    long ampscale=fromdB(info->ampdB);
-    long maxval=(1<<info->ampbits)-1;
-
-    long val=todB(amp*ampscale)/info->ampdB*maxval+1;
-
-    if(val<0)val=0;           /* likely */
-    if(val>maxval)val=maxval; /* not bloody likely */
+  int j,k;
 
-    _oggpack_write(&vb->opb,val,info->ampbits);
-    if(val>0)
-      amp=fromdB((val-.5)/maxval*info->ampdB)/ampscale;
-    else
-      amp=0;
-  }
-
-  if(amp>0){
-    double *work=alloca(sizeof(double)*look->m);
-    
-    /* LSP <-> LPC is orthogonal and LSP quantizes more stably  */
-    vorbis_lpc_to_lsp(out,out,look->m);
-    memcpy(work,out,sizeof(double)*look->m);
-
-#ifdef TRAIN
-    {
-      int j;
-      FILE *of;
-      char buffer[80];
-      sprintf(buffer,"lsp0coeff_%d.vqd",vb->mode);
-      of=fopen(buffer,"a");
-      for(j=0;j<look->m;j++)
-       fprintf(of,"%g, ",out[j]);
-      fprintf(of,"\n");
-      fclose(of);
-    }
-#endif
-
-    /* code the spectral envelope, and keep track of the actual
-       quantized values; we don't want creeping error as each block is
-       nailed to the last quantized value of the previous block. */
-    
-    /* first stage is a bit different because quantization error must be
-       handled carefully */
-    for(stage=0;stage<info->stages;stage++){
-      codebook *b=vb->vd->fullbooks+info->books[stage];
-      
-      if(stage==0){
-       double last=0.;
-       for(j=0;j<look->m;){
-         for(k=0;k<b->dim;k++)out[j+k]-=last;
-         bits+=vorbis_book_encodev(b,out+j,&vb->opb);
-         for(k=0;k<b->dim;k++,j++){
-           out[j]+=last;
-           work[j]-=out[j];
-         }
-         last=out[j-1];
-       }
-      }else{
-       memcpy(out,work,sizeof(double)*look->m);
-       for(j=0;j<look->m;){
-         bits+=vorbis_book_encodev(b,out+j,&vb->opb);
-         for(k=0;k<b->dim;k++,j++)work[j]-=out[j];
-       }
+  int ampraw=oggpack_read(&vb->opb,info->ampbits);
+  if(ampraw>0){ /* also handles the -1 out of data case */
+    long maxval=(1<<info->ampbits)-1;
+    float amp=(float)ampraw/maxval*info->ampdB;
+    int booknum=oggpack_read(&vb->opb,_ilog(info->numbooks));
+
+    if(booknum!=-1 && booknum<info->numbooks){ /* be paranoid */
+      codec_setup_info  *ci=vb->vd->vi->codec_setup;
+      codebook *b=ci->fullbooks+info->books[booknum];
+      float last=0.f;
+
+      /* the additional b->dim is a guard against any possible stack
+         smash; b->dim is provably more than we can overflow the
+         vector */
+      float *lsp=_vorbis_block_alloc(vb,sizeof(*lsp)*(look->m+b->dim+1));
+
+      if(vorbis_book_decodev_set(b,lsp,&vb->opb,look->m)==-1)goto eop;
+      for(j=0;j<look->m;){
+        for(k=0;j<look->m && k<b->dim;k++,j++)lsp[j]+=last;
+        last=lsp[j-1];
       }
+
+      lsp[look->m]=amp;
+      return(lsp);
     }
-    /* take the coefficients back to a spectral envelope curve */
-    vorbis_lsp_to_lpc(out,out,look->m); 
-    vorbis_lpc_to_curve(out,out,amp,&look->lpclook);
-    fprintf(stderr,"Encoded %ld LSP coefficients in %ld bits\n",look->m,bits);
-    return(1);
   }
-
-  fprintf(stderr,"Encoded %ld LSP coefficients in %ld bits\n",look->m,bits);
-
-  memset(out,0,sizeof(double)*look->n);
-  return(0);
+ eop:
+  return(NULL);
 }
 
-static int inverse(vorbis_block *vb,vorbis_look_floor *i,double *out){
+static int floor0_inverse2(vorbis_block *vb,vorbis_look_floor *i,
+                           void *memo,float *out){
   vorbis_look_floor0 *look=(vorbis_look_floor0 *)i;
   vorbis_info_floor0 *info=look->vi;
-  int j,k,stage;
-  
-  long ampraw=_oggpack_read(&vb->opb,info->ampbits);
-  if(ampraw>0){
-    long ampscale=fromdB(info->ampdB);
-    long maxval=(1<<info->ampbits)-1;
-    double amp=fromdB((ampraw-.5)/maxval*info->ampdB)/ampscale;
-
-    memset(out,0,sizeof(double)*look->m);    
-    for(stage=0;stage<info->stages;stage++){
-      codebook *b=vb->vd->fullbooks+info->books[stage];
-      for(j=0;j<look->m;j+=b->dim)
-       vorbis_book_decodev(b,out+j,&vb->opb);
-      if(stage==0){
-       double last=0.;
-       for(j=0;j<look->m;){
-         for(k=0;k<b->dim;k++,j++)out[j]+=last;
-         last=out[j-1];
-       }
-      }
-    }
-  
+
+  floor0_map_lazy_init(vb,info,look);
+
+  if(memo){
+    float *lsp=(float *)memo;
+    float amp=lsp[look->m];
 
     /* take the coefficients back to a spectral envelope curve */
-    vorbis_lsp_to_lpc(out,out,look->m); 
-    vorbis_lpc_to_curve(out,out,amp,&look->lpclook);
+    vorbis_lsp_to_curve(out,
+                        look->linearmap[vb->W],
+                        look->n[vb->W],
+                        look->ln,
+                        lsp,look->m,amp,(float)info->ampdB);
     return(1);
-  }else
-    memset(out,0,sizeof(double)*look->n);
+  }
+  memset(out,0,sizeof(*out)*look->n[vb->W]);
   return(0);
 }
 
 /* export hooks */
-vorbis_func_floor floor0_exportbundle={
-  &pack,&unpack,&look,&free_info,&free_look,&forward,&inverse
+const vorbis_func_floor floor0_exportbundle={
+  NULL,&floor0_unpack,&floor0_look,&floor0_free_info,
+  &floor0_free_look,&floor0_inverse1,&floor0_inverse2
 };
-
-