opusic-sys 0.7.2

Bindings to libopus
Documentation
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
/* Copyright (c) 2011-2012 Xiph.Org Foundation, Mozilla Corporation
   Written by Jean-Marc Valin and Timothy B. Terriberry */
/*
   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.

   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.
*/

#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <string.h>
#include "mini_kfft.c"

#define MAX(a,b) ((a)>(b) ? (a) : (b))
#define OPUS_PI (3.14159265F)

#define OPUS_COSF(_x)        ((float)cos(_x))
#define OPUS_SINF(_x)        ((float)sin(_x))

static void *check_alloc(void *_ptr){
  if(_ptr==NULL){
    fprintf(stderr,"Out of memory.\n");
    exit(EXIT_FAILURE);
  }
  return _ptr;
}

static void *opus_malloc(size_t _size){
  return check_alloc(malloc(_size));
}

static void *opus_realloc(void *_ptr,size_t _size){
  return check_alloc(realloc(_ptr,_size));
}

#define FORMAT_S16_LE 0
#define FORMAT_S24_LE 1
#define FORMAT_F32_LE 2

#define NBANDS (28)
#define NFREQS (240*2)
#define TEST_WIN_SIZE (480*2)
#define TEST_WIN_STEP (120*2)

static const int format_size[3] = {2, 3, 4};
typedef union {
    int i;
    float f;
} float_bits;


static size_t read_pcm(float **_samples,FILE *_fin,int _nchannels, int format){
  unsigned char  buf[1024];
  float         *samples;
  size_t         nsamples;
  size_t         csamples;
  size_t         xi;
  size_t         nread;
  samples=NULL;
  nsamples=csamples=0;
  int size = format_size[format];

  for(;;){
    nread=fread(buf,size*_nchannels,1024/(size*_nchannels),_fin);
    if(nread<=0)break;
    if(nsamples+nread>csamples){
      do csamples=csamples<<1|1;
      while(nsamples+nread>csamples);
      samples=(float *)opus_realloc(samples,
       _nchannels*csamples*sizeof(*samples));
    }
    if (format==FORMAT_S16_LE) {
      for(xi=0;xi<nread;xi++){
        int ci;
        for(ci=0;ci<_nchannels;ci++){
          int s;
          s=buf[2*(xi*_nchannels+ci)+1]<<8|buf[2*(xi*_nchannels+ci)];
          s=((s&0xFFFF)^0x8000)-0x8000;
          samples[(nsamples+xi)*_nchannels+ci]=s;
        }
      }
    } else if (format==FORMAT_S24_LE) {
       for(xi=0;xi<nread;xi++){
         int ci;
         for(ci=0;ci<_nchannels;ci++){
           int s;
           s=buf[3*(xi*_nchannels+ci)+2]<<16|buf[3*(xi*_nchannels+ci)+1]<<8|buf[3*(xi*_nchannels+ci)];
           s=((s&0xFFFFFF)^0x800000)-0x800000;
           samples[(nsamples+xi)*_nchannels+ci]=(1.f/256.f)*s;
         }
       }
     } else if (format==FORMAT_F32_LE) {
        for(xi=0;xi<nread;xi++){
          int ci;
          for(ci=0;ci<_nchannels;ci++){
            float_bits s;
            s.i=(unsigned)buf[4*(xi*_nchannels+ci)+3]<<24|buf[4*(xi*_nchannels+ci)+2]<<16|buf[4*(xi*_nchannels+ci)+1]<<8|buf[4*(xi*_nchannels+ci)];
            samples[(nsamples+xi)*_nchannels+ci] = s.f*32768;
          }
        }
      } else {
        exit(1);
      }
    nsamples+=nread;
  }
  *_samples=(float *)opus_realloc(samples,
   _nchannels*nsamples*sizeof(*samples));
  return nsamples;
}

static void band_energy(float *_out,float *_ps,const int *_bands,int _nbands,
 const float *_in,int _nchannels,size_t _nframes,int _window_sz,
 int _step,int _downsample){
  float window[TEST_WIN_SIZE];
  float x[TEST_WIN_SIZE];
  size_t xi;
  int    xj;
  int    ps_sz;
  mini_kiss_fft_cpx X[2][NFREQS+1];
  mini_kiss_fftr_cfg kfft;
  ps_sz=_window_sz/2;
  /* Blackman-Harris window. */
  for(xj=0;xj<_window_sz;xj++){
    double n = (xj+.5)/_window_sz;
    window[xj]=0.35875 - 0.48829*cos(2*OPUS_PI*n) + 0.14128*cos(4*OPUS_PI*n) - 0.01168*cos(6*OPUS_PI*n);
  }
  kfft = mini_kiss_fftr_alloc(_window_sz, 0, NULL, NULL);
  for(xi=0;xi<_nframes;xi++){
    int ci;
    int xk;
    int bi;
    for(ci=0;ci<_nchannels;ci++){
      for(xk=0;xk<_window_sz;xk++){
        x[xk]=window[xk]*_in[(xi*_step+xk)*_nchannels+ci];
      }
      mini_kiss_fftr(kfft, x, X[ci]);
    }
    for(bi=xj=0;bi<_nbands;bi++){
      float p[2]={0};
      for(;xj<_bands[bi+1];xj++){
        for(ci=0;ci<_nchannels;ci++){
          float re;
          float im;
          re = X[ci][xj].r*_downsample;
          im = X[ci][xj].i*_downsample;
          _ps[(xi*ps_sz+xj)*_nchannels+ci]=re*re+im*im+.1;
          p[ci]+=_ps[(xi*ps_sz+xj)*_nchannels+ci];
        }
      }
      if(_out){
        _out[(xi*_nbands+bi)*_nchannels]=p[0]/(_bands[bi+1]-_bands[bi]);
        if(_nchannels==2){
          _out[(xi*_nbands+bi)*_nchannels+1]=p[1]/(_bands[bi+1]-_bands[bi]);
        }
      }
    }
  }
  free(kfft);
}


/*Bands on which we compute the pseudo-NMR (Bark-derived
  CELT bands).*/
static const int BANDS[NBANDS+1]={
  0,2,4,6,8,10,12,14,16,20,24,28,32,40,48,56,68,80,96,120,156,200, 240,280,320,360,400,440,480
};


void usage(const char *_argv0) {
   fprintf(stderr,"Usage: %s [-s] [-48k] [-s16|-s24|-f32] [-r rate2] [-thresholds err4 err16 rms] <file1.sw> <file2.sw>\n",
    _argv0);
}

int main(int _argc,const char **_argv){
  FILE    *fin1;
  FILE    *fin2;
  float   *x;
  float   *y;
  float   *xb;
  float   *X;
  float   *Y;
  double    err4;
  double    err16;
  size_t   xlength;
  size_t   ylength;
  size_t   nframes;
  size_t   xi;
  int      ci;
  int      xj;
  int      bi;
  int      nchannels;
  unsigned rate;
  unsigned base_rate;
  int      downsample;
  int      nbands;
  int      ybands;
  int      nfreqs;
  int      yfreqs;
  size_t   test_win_size;
  size_t   test_win_step;
  int      max_compare;
  int      format;
  int      skip=0;
  double rms=-1;
  const char *argv0 = _argv[0];
  double err4_threshold=-1, err16_threshold=-1, rms_threshold=-1;
  int compare_thresholds=0;
  if(_argc<3){
    usage(argv0);
    return EXIT_FAILURE;
  }
  nchannels=1;
  base_rate=96000;
  rate=0;
  nbands=NBANDS;
  nfreqs=NFREQS;
  test_win_size=TEST_WIN_SIZE;
  test_win_step=TEST_WIN_STEP;
  downsample=1;
  format=FORMAT_S16_LE;
  while (_argc > 3) {
    if(strcmp(_argv[1],"-s")==0){
      nchannels=2;
      _argv++;
      _argc--;
    } else if(strcmp(_argv[1],"-48k")==0){
      base_rate=48000;
      _argv++;
      _argc--;
    } else if(strcmp(_argv[1],"-s16")==0){
      format=FORMAT_S16_LE;
      _argv++;
      _argc--;
    } else if(strcmp(_argv[1],"-s24")==0){
      format=FORMAT_S24_LE;
      _argv++;
      _argc--;
    } else if(strcmp(_argv[1],"-f32")==0){
      format=FORMAT_F32_LE;
      _argv++;
      _argc--;
    } else if(strcmp(_argv[1],"-skip")==0){
      skip=atoi(_argv[2]);
      _argv+=2;
      _argc-=2;
    } else if(strcmp(_argv[1],"-thresholds")==0){
      if (_argc < 7) {
        usage(argv0);
        return EXIT_FAILURE;
      }
      err4_threshold=atof(_argv[2]);
      err16_threshold=atof(_argv[3]);
      rms_threshold=atof(_argv[4]);
      compare_thresholds=1;
      _argv+=4;
      _argc-=4;
    } else if(strcmp(_argv[1],"-r")==0){
      rate=atoi(_argv[2]);
      if(rate!=8000&&rate!=12000&&rate!=16000&&rate!=24000&&rate!=48000&&rate!=96000){
        fprintf(stderr,
              "Sampling rate must be 8000, 12000, 16000, 24000, 48000, or 96000\n");
        return EXIT_FAILURE;
      }
      _argv+=2;
      _argc-=2;
    } else {
      usage(argv0);
      return EXIT_FAILURE;
    }
  }
  if(_argc!=3){
    usage(argv0);
    return EXIT_FAILURE;
  }
  if (rate==0) rate=base_rate;
  if (base_rate == 48000) {
    test_win_size/=2;
    test_win_step/=2;
    nfreqs/=2;
    nbands=22;
  }
  switch(rate){
    case  8000:ybands=13;break;
    case 12000:ybands=15;break;
    case 16000:ybands=17;break;
    case 24000:ybands=19;break;
    case 48000:ybands=22;break;
    case 96000:ybands=NBANDS;break;
    default:
      usage(argv0);
      return EXIT_FAILURE;
  }
  downsample=base_rate/rate;
  yfreqs=nfreqs/downsample;
  fin1=fopen(_argv[1],"rb");
  if(fin1==NULL){
    fprintf(stderr,"Error opening '%s'.\n",_argv[1]);
    return EXIT_FAILURE;
  }
  fin2=fopen(_argv[2],"rb");
  if(fin2==NULL){
    fprintf(stderr,"Error opening '%s'.\n",_argv[2]);
    fclose(fin1);
    return EXIT_FAILURE;
  }
  /*Read in the data and allocate scratch space.*/
  xlength=read_pcm(&x,fin1,2,format);
  if(nchannels==1){
    for(xi=0;xi<xlength;xi++)x[xi]=.5*(x[2*xi]+x[2*xi+1]);
  }
  fclose(fin1);
  ylength=read_pcm(&y,fin2,nchannels,format);
  fclose(fin2);
  skip *= nchannels;
  y += skip/downsample;
  ylength -= skip/downsample;
  if (skip && ylength*downsample > xlength) ylength = xlength/downsample;
  if(xlength!=ylength*downsample){
    fprintf(stderr,"Sample counts do not match (%lu!=%lu).\n",
     (unsigned long)xlength,(unsigned long)ylength*downsample);
    return EXIT_FAILURE;
  }
  if(xlength<test_win_size){
    fprintf(stderr,"Insufficient sample data (%lu<%lu).\n",
     (unsigned long)xlength,(unsigned long)test_win_size);
    return EXIT_FAILURE;
  }
  if (nchannels==2 && downsample==1){
    size_t i;
    rms=0;
    for (i=0;i<xlength*nchannels;i++){
      double e=x[i]-y[i];
      rms+=e*e;
    }
    rms=sqrt(rms/(xlength*nchannels));
  }
  nframes=(xlength-test_win_size+test_win_step)/test_win_step;
  xb=(float *)opus_malloc(nframes*nbands*nchannels*sizeof(*xb));
  X=(float *)opus_malloc(nframes*nfreqs*nchannels*sizeof(*X));
  Y=(float *)opus_malloc(nframes*yfreqs*nchannels*sizeof(*Y));
  /*Compute the per-band spectral energy of the original signal
     and the error.*/
  band_energy(xb,X,BANDS,nbands,x,nchannels,nframes,
        test_win_size,test_win_step,1);
  free(x);
  band_energy(NULL,Y,BANDS,ybands,y,nchannels,nframes,
        test_win_size/downsample,test_win_step/downsample,downsample);
  free(y-skip/downsample);
  for(xi=0;xi<nframes;xi++){
    float maxE[2]={0};
    for(bi=0;bi<nbands;bi++){
      for(ci=0;ci<nchannels;ci++){
        maxE[ci] = MAX(maxE[ci], xb[(xi*nbands+bi)*nchannels+ci]);
      }
    }
    /* Allow for up to 105 dB instantaneous dynamic range (95dB here + 10dB in mask application). */
    for(bi=0;bi<nbands;bi++){
      for(ci=0;ci<nchannels;ci++){
        xb[(xi*nbands+bi)*nchannels+ci] = MAX(3.16e-10*maxE[ci], xb[(xi*nbands+bi)*nchannels+ci]);
      }
    }

    /*Frequency masking (low to high): 10 dB/Bark slope.*/
    for(bi=1;bi<nbands;bi++){
      for(ci=0;ci<nchannels;ci++){
        xb[(xi*nbands+bi)*nchannels+ci]+=
         0.1F*xb[(xi*nbands+bi-1)*nchannels+ci];
      }
    }
    /*Frequency masking (high to low): 15 dB/Bark slope.*/
    for(bi=nbands-2;bi-->0;){
      for(ci=0;ci<nchannels;ci++){
        xb[(xi*nbands+bi)*nchannels+ci]+=
         0.03F*xb[(xi*nbands+bi+1)*nchannels+ci];
      }
    }
    if(xi>0){
      /* Forward temporal masking: -3 dB/2.5ms slope.*/
      for(bi=0;bi<nbands;bi++){
        for(ci=0;ci<nchannels;ci++){
          xb[(xi*nbands+bi)*nchannels+ci]+=
           0.5F*xb[((xi-1)*nbands+bi)*nchannels+ci];
        }
      }
    }
  }
  /*Backward temporal masking: -10 dB/2.5ms slope.*/
  for(xi=nframes-2;xi-->0;){
     for(bi=0;bi<nbands;bi++){
       for(ci=0;ci<nchannels;ci++){
         xb[(xi*nbands+bi)*nchannels+ci]+=
          0.1F*xb[((xi+1)*nbands+bi)*nchannels+ci];
       }
     }
  }
  for(xi=0;xi<nframes;xi++){
    /* Allowing some cross-talk */
    if(nchannels==2){
      for(bi=0;bi<nbands;bi++){
        float l,r;
        l=xb[(xi*nbands+bi)*nchannels+0];
        r=xb[(xi*nbands+bi)*nchannels+1];
        xb[(xi*nbands+bi)*nchannels+0]+=0.000001F*r;
        xb[(xi*nbands+bi)*nchannels+1]+=0.000001F*l;
      }
    }

    /* Apply masking */
    for(bi=0;bi<ybands;bi++){
      for(xj=BANDS[bi];xj<BANDS[bi+1];xj++){
        for(ci=0;ci<nchannels;ci++){
          X[(xi*nfreqs+xj)*nchannels+ci]+=
           0.1F*xb[(xi*nbands+bi)*nchannels+ci];
          Y[(xi*yfreqs+xj)*nchannels+ci]+=
           0.1F*xb[(xi*nbands+bi)*nchannels+ci];
        }
      }
    }
  }

  /* Average of consecutive frames to make comparison slightly less sensitive */
  for(bi=0;bi<ybands;bi++){
    for(xj=BANDS[bi];xj<BANDS[bi+1];xj++){
      for(ci=0;ci<nchannels;ci++){
         float xtmp;
         float ytmp;
         xtmp = X[xj*nchannels+ci];
         ytmp = Y[xj*nchannels+ci];
         for(xi=1;xi<nframes;xi++){
           float xtmp2;
           float ytmp2;
           xtmp2 = X[(xi*nfreqs+xj)*nchannels+ci];
           ytmp2 = Y[(xi*yfreqs+xj)*nchannels+ci];
           X[(xi*nfreqs+xj)*nchannels+ci] += xtmp;
           Y[(xi*yfreqs+xj)*nchannels+ci] += ytmp;
           xtmp = xtmp2;
           ytmp = ytmp2;
         }
      }
    }
  }

  /*If working at a lower sampling rate, don't take into account the last
     300 Hz to allow for different transition bands.
    For 12 kHz, we don't skip anything, because the last band already skips
     400 Hz.*/
  if(rate==base_rate)max_compare=BANDS[nbands];
  else if(rate==12000)max_compare=BANDS[ybands];
  else max_compare=BANDS[ybands]-3;
  err4=0;
  err16=0;
  for(xi=0;xi<nframes;xi++){
    double Ef2, Ef4;
    Ef2=0;
    Ef4=0;
    for(bi=0;bi<ybands;bi++){
      double Eb2, Eb4;
      double w;
      Eb2=Eb4=0;
      w = .5+.5*tanh(.5*(22-bi));
      for(xj=BANDS[bi];xj<BANDS[bi+1]&&xj<max_compare;xj++){
        float f, thresh;
        f = xj*OPUS_PI/240;
        /* Shape the lower threshold similar to 1/(1 - 0.85*z^-1) deemphasis filter at 48 kHz. */
        thresh = .1/(.15*.15 + f*f);
        for(ci=0;ci<nchannels;ci++){
          float re;
          float im;
          re=(Y[(xi*yfreqs+xj)*nchannels+ci]+thresh)/(X[(xi*nfreqs+xj)*nchannels+ci]+thresh);
          im=re-log(re)-1;
          /* Per-band error weighting. */
          im *= w;
          Eb2+=im;
          /* Same for 4th power, but make it less sensitive to very low energies. */
          re=(Y[(xi*yfreqs+xj)*nchannels+ci]+10*thresh)/(X[(xi*nfreqs+xj)*nchannels+ci]+10*thresh);
          im=re-log(re)-1;
          /* Per-band error weighting. */
          im *= w;
          Eb4+=im;
        }
      }
      Eb2 /= (BANDS[bi+1]-BANDS[bi])*nchannels;
      Eb4 /= (BANDS[bi+1]-BANDS[bi])*nchannels;
      Ef2 += Eb2;
      Ef4 += Eb4*Eb4;
    }
    /*Using a fixed normalization value means we're willing to accept slightly
       lower quality for lower sampling rates.*/
    Ef2/=nbands;
    Ef4/=nbands;
    Ef4*=Ef4;
    err4+=Ef2*Ef2;
    err16+=Ef4*Ef4;
  }
  free(xb);
  free(X);
  free(Y);
  err4=pow(err4/nframes,1.0/4);
  err16=pow(err16/nframes,1.0/16);
  fprintf(stderr, "err4 = %f, err16 = %f, rms = %f\n", err4, err16, rms);
  if (compare_thresholds) {
    if (err4 <= err4_threshold && err16 <= err16_threshold && rms <= rms_threshold) {
      fprintf(stderr, "Comparison PASSED\n");
    } else {
      fprintf(stderr, "*** Comparison FAILED *** (thresholds were %f %f %f)\n", err4_threshold, err16_threshold, rms_threshold);
      return EXIT_FAILURE;
    }
  }
  return EXIT_SUCCESS;
}