aboutsummaryrefslogtreecommitdiffstats
path: root/utils/bsincgen.c
blob: 657c78ca95272c79bdd253d1f32a8d45fa4e0e3d (plain)
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
/*
 * Sinc interpolator coefficient and delta generator for the OpenAL Soft
 * cross platform audio library.
 *
 * Copyright (C) 2015 by Christopher Fitzgerald.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 *
 * Or visit:  http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html
 *
 * --------------------------------------------------------------------------
 *
 * This is a modified version of the bandlimited windowed sinc interpolator
 * algorithm presented here:
 *
 *   Smith, J.O. "Windowed Sinc Interpolation", in
 *   Physical Audio Signal Processing,
 *   https://ccrma.stanford.edu/~jos/pasp/Windowed_Sinc_Interpolation.html,
 *   online book,
 *   accessed October 2012.
 */

#include <stdio.h>
#include <math.h>
#include <string.h>

#ifndef M_PI
#define M_PI                         (3.14159265358979323846)
#endif

// The number of distinct scale and phase intervals within the filter table.
#define BSINC_SCALE_COUNT (16)
#define BSINC_PHASE_COUNT (16)

#define BSINC_REJECTION (60.0)
#define BSINC_POINTS_MIN (12)
#define BSINC_ORDER (11)

static double MinDouble(double a, double b)
{ return (a <= b) ? a : b; }

static double MaxDouble(double a, double b)
{ return (a >= b) ? a : b; }

/* NOTE: This is the normalized (instead of just sin(x)/x) cardinal sine
 *       function.
 *       2 f_t sinc(2 f_t x)
 *       f_t -- normalized transition frequency (0.5 is nyquist)
 *       x   -- sample index (-N to N)
 */
static double Sinc(const double x)
{
    if(fabs(x) < 1e-15)
        return 1.0;
    return sin(M_PI * x) / (M_PI * x);
}

static double BesselI_0(const double x)
{
    double term, sum, last_sum, x2, y;
    int i;

    term = 1.0;
    sum = 1.0;
    x2 = x / 2.0;
    i = 1;

    do {
        y = x2 / i;
        i++;
        last_sum = sum;
        term *= y * y;
        sum += term;
    } while(sum != last_sum);

    return sum;
}

/* NOTE: k is assumed normalized (-1 to 1)
 *       beta is equivalent to 2 alpha
 */
static double Kaiser(const double b, const double k)
{
    double k2;

    if((k < -1.0) || (k > 1.0))
        return 0.0;

    k2 = MaxDouble(1.0 - (k * k), 0.0);

    return BesselI_0(b * sqrt(k2)) / BesselI_0(b);
}

/* NOTE: Calculates the transition width of the Kaiser window.  Rejection is
 *       in dB.
 */
static double CalcKaiserWidth(const double rejection, const int order)
{
    double w_t = 2.0 * M_PI;

    if(rejection > 21.0)
       return (rejection - 7.95) / (order * 2.285 * w_t);

    return 5.79 / (order * w_t);
}

static double CalcKaiserBeta(const double rejection)
{
    if(rejection > 50.0)
       return 0.1102 * (rejection - 8.7);
    else if(rejection >= 21.0)
       return (0.5842 * pow(rejection - 21.0, 0.4)) +
              (0.07886 * (rejection - 21.0));
    return 0.0;
}

/* Generates the coefficient, delta, and index tables required by the bsinc resampler */
static void BsiGenerateTables()
{
    static double   filter[BSINC_SCALE_COUNT][BSINC_PHASE_COUNT + 1][2 * BSINC_POINTS_MIN];
    static double scDeltas[BSINC_SCALE_COUNT][BSINC_PHASE_COUNT    ][2 * BSINC_POINTS_MIN];
    static double phDeltas[BSINC_SCALE_COUNT][BSINC_PHASE_COUNT + 1][2 * BSINC_POINTS_MIN];
    static double spDeltas[BSINC_SCALE_COUNT][BSINC_PHASE_COUNT    ][2 * BSINC_POINTS_MIN];
    static int mt[BSINC_SCALE_COUNT];
    static double at[BSINC_SCALE_COUNT];
    double width, beta, scaleBase, scaleRange;
    int si, pi, i;

    memset(filter, 0, sizeof(filter));
    memset(scDeltas, 0, sizeof(scDeltas));
    memset(phDeltas, 0, sizeof(phDeltas));
    memset(spDeltas, 0, sizeof(spDeltas));

    /* Calculate windowing parameters.  The width describes the transition
       band, but it may vary due to the linear interpolation between scales
       of the filter.
    */
    width = CalcKaiserWidth(BSINC_REJECTION, BSINC_ORDER);
    beta = CalcKaiserBeta(BSINC_REJECTION);
    scaleBase = width / 2.0;
    scaleRange = 1.0 - scaleBase;

    // Determine filter scaling.
    for(si = 0; si < BSINC_SCALE_COUNT; si++)
    {
        const double scale = scaleBase + (scaleRange * si / (BSINC_SCALE_COUNT - 1));
        const double a = MinDouble(BSINC_POINTS_MIN, BSINC_POINTS_MIN / (2.0 * scale));
        int m = 2 * (int)floor(a);

        // Make sure the number of points is a multiple of 4 (for SSE).
        m += ~(m - 1) & 3;

        mt[si] = m;
        at[si] = a;
    }

    /* Calculate the Kaiser-windowed Sinc filter coefficients for each scale
       and phase.
    */
    for(si = 0; si < BSINC_SCALE_COUNT; si++)
    {
        const int m = mt[si];
        const int o = BSINC_POINTS_MIN - (m / 2);
        const int l = (m / 2) - 1;
        const double a = at[si];
        const double scale = scaleBase + (scaleRange * si / (BSINC_SCALE_COUNT - 1));
        const double cutoff = (0.5 * scale) - (scaleBase * MaxDouble(0.5, scale));

        for(pi = 0; pi <= BSINC_PHASE_COUNT; pi++)
        {
            const double phase = l + ((double)pi / BSINC_PHASE_COUNT);

            for(i = 0; i < m; i++)
            {
                const double x = i - phase;
                filter[si][pi][o + i] = Kaiser(beta, x / a) * 2.0 * cutoff * Sinc(2.0 * cutoff * x);
            }
        }
    }

    /* Linear interpolation between scales is simplified by pre-calculating
       the delta (b - a) in: x = a + f (b - a)

       Given a difference in points between scales, the destination points
       will be 0, thus: x = a + f (-a)
    */
    for(si = 0; si < (BSINC_SCALE_COUNT - 1); si++)
    {
        const int m = mt[si];
        const int o = BSINC_POINTS_MIN - (m / 2);

        for(pi = 0; pi < BSINC_PHASE_COUNT; pi++)
        {
            for(i = 0; i < m; i++)
                scDeltas[si][pi][o + i] = filter[si + 1][pi][o + i] - filter[si][pi][o + i];
        }
    }

    // Linear interpolation between phases is also simplified.
    for(si = 0; si < BSINC_SCALE_COUNT; si++)
    {
        const int m = mt[si];
        const int o = BSINC_POINTS_MIN - (m / 2);

        for(pi = 0; pi < BSINC_PHASE_COUNT; pi++)
        {
            for(i = 0; i < m; i++)
                phDeltas[si][pi][o + i] = filter[si][pi + 1][o + i] - filter[si][pi][o + i];
        }
    }

    /* This last simplification is done to complete the bilinear equation for
       the combination of scale and phase.
    */
    for(si = 0; si < (BSINC_SCALE_COUNT - 1); si++)
    {
        const int m = mt[si];
        const int o = BSINC_POINTS_MIN - (m / 2);

        for(pi = 0; pi < BSINC_PHASE_COUNT; pi++)
        {
            for(i = 0; i < m; i++)
                spDeltas[si][pi][o + i] = phDeltas[si + 1][pi][o + i] - phDeltas[si][pi][o + i];
        }
    }

    // Calculate the table size.
    i = 0;
    for(si = 0; si < BSINC_SCALE_COUNT; si++)
        i += 4 * BSINC_PHASE_COUNT * mt[si];

    fprintf(stdout, "/* Generated by bsincgen, do not edit! */\n\n"
"/* Table of windowed sinc coefficients and deltas.  This %dth order filter\n"
" * has a rejection of -%gdB, yielding a transition width of ~%.3f\n"
" * (normalized frequency).  Order increases when downsampling to a limit of\n"
" * one octave, after which the quality of the filter (transition width)\n"
" * suffers to reduce the CPU cost.  The bandlimiting will cut all sound after\n"
" * downsampling by ~%.2f octaves.\n"
" */\n"
"static const struct {\n"
"    alignas(16) const float Tab[%d];\n"
"    const float scaleBase, scaleRange;\n"
"    const int m[BSINC_SCALE_COUNT];\n"
"    const int filterOffset[BSINC_SCALE_COUNT];\n"
"} bsinc = {\n", BSINC_ORDER, BSINC_REJECTION, width, log2(1.0/scaleBase), i);

    fprintf(stdout, "    /* Tab */ {\n");
    for(si = 0; si < BSINC_SCALE_COUNT; si++)
    {
        const int m = mt[si];
        const int o = BSINC_POINTS_MIN - (m / 2);

        for(pi = 0; pi < BSINC_PHASE_COUNT; pi++)
        {
            fprintf(stdout, "        /* %2d,%2d (%d) */", si, pi, m);
            fprintf(stdout, "\n       ");
            for(i = 0; i < m; i++)
                fprintf(stdout, " %+14.9ef,", filter[si][pi][o + i]);
            fprintf(stdout, "\n       ");
            for(i = 0; i < m; i++)
                fprintf(stdout, " %+14.9ef,", scDeltas[si][pi][o + i]);
            fprintf(stdout, "\n       ");
            for(i = 0; i < m; i++)
                fprintf(stdout, " %+14.9ef,", phDeltas[si][pi][o + i]);
            fprintf(stdout, "\n       ");
            for(i = 0; i < m; i++)
                fprintf(stdout, " %+14.9ef,", spDeltas[si][pi][o + i]);
            fprintf(stdout, "\n");
        }
    }
    fprintf(stdout, "    },\n\n");

    /* The scaleBase is calculated from the Kaiser window transition width.
       It represents the absolute limit to the filter before it fully cuts
       the signal.  The limit in octaves can be calculated by taking the
       base-2 logarithm of its inverse: log_2(1 / scaleBase)
    */
    fprintf(stdout, "    /* scaleBase */ %.9ef, /* scaleRange */ %.9ef,\n", scaleBase, 1.0 / scaleRange);

    fprintf(stdout, "    /* m */ {");
    fprintf(stdout, " %d", mt[0]);
    for(si = 1; si < BSINC_SCALE_COUNT; si++)
        fprintf(stdout, ", %d", mt[si]);
    fprintf(stdout, " },\n");

    fprintf(stdout, "    /* filterOffset */ {");
    fprintf(stdout, " %d", 0);
    i = mt[0]*4*BSINC_PHASE_COUNT;
    for(si = 1; si < BSINC_SCALE_COUNT; si++)
    {
        fprintf(stdout, ", %d", i);
        i += mt[si]*4*BSINC_PHASE_COUNT;
    }

    fprintf(stdout, " }\n};\n\n");
}


/* These methods generate a much simplified 4-point sinc interpolator using a
 * Kaiser window. This is much simpler to process at run-time, but has notably
 * more aliasing noise.
 */

/* Same as in alu.h! */
#define FRACTIONBITS (12)
#define FRACTIONONE  (1<<FRACTIONBITS)

static void Sinc4GenerateTables(void)
{
    static double filter[FRACTIONONE][4];

    const double width = CalcKaiserWidth(BSINC_REJECTION, 3);
    const double beta = CalcKaiserBeta(BSINC_REJECTION);
    const double scaleBase = width / 2.0;
    const double scaleRange = 1.0 - scaleBase;
    const double scale = scaleBase + scaleRange;
    const double a = MinDouble(4.0, 4.0 / (2.0*scale));
    const int m = 2 * (int)floor(a);
    const int l = (m/2) - 1;
    int pi;
    for(pi = 0;pi < FRACTIONONE;pi++)
    {
        const double phase = l + ((double)pi / FRACTIONONE);
        int i;

        for(i = 0;i < m;i++)
        {
            double x = i - phase;
            filter[pi][i] = Kaiser(beta, x / a) * Sinc(x);
        }
    }

    fprintf(stdout, "alignas(16) static const float sinc4Tab[FRACTIONONE][4] = {\n");
    for(pi = 0;pi < FRACTIONONE;pi++)
        fprintf(stdout, "    { %+14.9ef, %+14.9ef, %+14.9ef, %+14.9ef },\n",
                filter[pi][0], filter[pi][1], filter[pi][2], filter[pi][3]);
    fprintf(stdout, "};\n\n");
}

int main(void)
{
    BsiGenerateTables();
    Sinc4GenerateTables();
    return 0;
}