summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/webaudio/the-audio-api/the-biquadfilternode-interface/no-dezippering.html
blob: 79dc27035c7dbd8176f980278bdddab55a76c731 (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
<!DOCTYPE html>
<html>
  <head>
    <title>
      biquad-bandpass.html
    </title>
    <script src="/resources/testharness.js"></script>
    <script src="/resources/testharnessreport.js"></script>
    <script src="/webaudio/resources/audit-util.js"></script>
    <script src="/webaudio/resources/audit.js"></script>
    <script src="/webaudio/resources/biquad-filters.js"></script>
  </head>
  <body>
    <script id="layout-test-code">
      let audit = Audit.createTaskRunner();

      // In the tests below, the initial values are not important, except that
      // we wanted them to be all different so that the output contains
      // different values for the first few samples.  Otherwise, the actual
      // values don't really matter.  A peaking filter is used because the
      // frequency, Q, gain, and detune parameters are used by this filter.
      //
      // Also, for the changeList option, the times and new values aren't really
      // important.  They just need to change so that we can verify that the
      // outputs from the .value setter still matches the output from the
      // corresponding setValueAtTime.
      audit.define(
          {label: 'Test 0', description: 'No dezippering for frequency'},
          (task, should) => {
            doTest(should, {
              paramName: 'frequency',
              initializer: {type: 'peaking', Q: 1, gain: 5},
              changeList:
                  [{quantum: 2, newValue: 800}, {quantum: 7, newValue: 200}],
              threshold: 3.0399e-6
            }).then(() => task.done());
          });

      audit.define(
          {label: 'Test 1', description: 'No dezippering for detune'},
          (task, should) => {
            doTest(should, {
              paramName: 'detune',
              initializer:
                  {type: 'peaking', frequency: 400, Q: 3, detune: 33, gain: 10},
              changeList:
                  [{quantum: 2, newValue: 1000}, {quantum: 5, newValue: -400}],
              threshold: 4.0532e-6
            }).then(() => task.done());
          });

      audit.define(
          {label: 'Test 2', description: 'No dezippering for Q'},
          (task, should) => {
            doTest(should, {
              paramName: 'Q',
              initializer: {type: 'peaking', Q: 5},
              changeList:
                  [{quantum: 2, newValue: 10}, {quantum: 8, newValue: -10}]
            }).then(() => task.done());
          });

      audit.define(
          {label: 'Test 3', description: 'No dezippering for gain'},
          (task, should) => {
            doTest(should, {
              paramName: 'gain',
              initializer: {type: 'peaking', gain: 1},
              changeList:
                  [{quantum: 2, newValue: 5}, {quantum: 6, newValue: -.3}],
              threshold: 1.9074e-6
            }).then(() => task.done());
          });

      // This test compares the filter output against a JS implementation of the
      // filter.  We're only testing a change in the frequency for a lowpass
      // filter.  This assumes we don't need to test other AudioParam changes
      // with JS code because any mistakes would be exposed in the tests above.
      audit.define(
          {
            label: 'Test 4',
            description: 'No dezippering of frequency vs JS filter'
          },
          (task, should) => {
            // Channel 0 is the source, channel 1 is the filtered output.
            let context = new OfflineAudioContext(2, 2048, 16384);

            let merger = new ChannelMergerNode(
                context, {numberOfInputs: context.destination.channelCount});
            merger.connect(context.destination);

            let src = new OscillatorNode(context);
            let f = new BiquadFilterNode(context, {type: 'lowpass'});

            // Remember the initial filter parameters.
            let initialFilter = {
              type: f.type,
              frequency: f.frequency.value,
              gain: f.gain.value,
              detune: f.detune.value,
              Q: f.Q.value
            };

            src.connect(merger, 0, 0);
            src.connect(f).connect(merger, 0, 1);

            // Apply the filter change at frame |changeFrame| with a new
            // frequency value of |newValue|.
            let changeFrame = 2 * RENDER_QUANTUM_FRAMES;
            let newValue = 750;

            context.suspend(changeFrame / context.sampleRate)
                .then(() => f.frequency.value = newValue)
                .then(() => context.resume());

            src.start();

            context.startRendering()
                .then(audio => {
                  let signal = audio.getChannelData(0);
                  let actual = audio.getChannelData(1);

                  // Get initial filter coefficients and updated coefficients
                  let nyquistFreq = context.sampleRate / 2;
                  let initialCoef = createFilter(
                      initialFilter.type, initialFilter.frequency / nyquistFreq,
                      initialFilter.Q, initialFilter.gain);

                  let finalCoef = createFilter(
                      f.type, f.frequency.value / nyquistFreq, f.Q.value,
                      f.gain.value);

                  let expected = new Float32Array(signal.length);

                  // Filter the initial part of the signal.
                  expected[0] =
                      filterSample(signal[0], initialCoef, 0, 0, 0, 0);
                  expected[1] = filterSample(
                      signal[1], initialCoef, expected[0], 0, signal[0], 0);

                  for (let k = 2; k < changeFrame; ++k) {
                    expected[k] = filterSample(
                        signal[k], initialCoef, expected[k - 1],
                        expected[k - 2], signal[k - 1], signal[k - 2]);
                  }

                  // Filter the rest of the input with the new coefficients
                  for (let k = changeFrame; k < signal.length; ++k) {
                    expected[k] = filterSample(
                        signal[k], finalCoef, expected[k - 1], expected[k - 2],
                        signal[k - 1], signal[k - 2]);
                  }

                  // The JS filter should match the actual output.
                  let match =
                      should(actual, 'Output from ' + f.type + ' filter')
                          .beCloseToArray(
                              expected, {absoluteThreshold: 6.8546e-7});
                  should(match, 'Output matches JS filter results').beTrue();
                })
                .then(() => task.done());
          });

      audit.define(
          {label: 'Test 5', description: 'Test with modulation'},
          (task, should) => {
            doTest(should, {
              prefix: 'Modulation: ',
              paramName: 'frequency',
              initializer: {type: 'peaking', Q: 5, gain: 5},
              modulation: true,
              changeList:
                  [{quantum: 2, newValue: 10}, {quantum: 8, newValue: -10}]
            }).then(() => task.done());

          });

      audit.run();

      // Run test, returning the promise from startRendering. |options|
      // specifies the parameters for the test. |options.paramName| is the name
      // of the AudioParam of the filter that is being tested.
      // |options.initializer| is the initial value to be used in constructing
      // the filter. |options.changeList| is an array consisting of dictionary
      // with two members: |quantum| is the rendering quantum at which time we
      // want to change the AudioParam value, and |newValue| is the value to be
      // used.
      function doTest(should, options) {
        let paramName = options.paramName;
        let newValue = options.newValue;
        let prefix = options.prefix || '';

        // Create offline audio context.  The sample rate should be a power of
        // two to eliminate any round-off errors in computing the time at which
        // to suspend the context for the parameter change.  The length is
        // fairly arbitrary as long as it's big enough to the changeList
        // values. There are two channels:  channel 0 is output for the filter
        // under test, and channel 1 is the output of referencef filter.
        let context = new OfflineAudioContext(2, 2048, 16384);

        let merger = new ChannelMergerNode(
            context, {numberOfInputs: context.destination.channelCount});
        merger.connect(context.destination);

        let src = new OscillatorNode(context);

        // |f0| is the filter under test that will have its AudioParam value
        // changed. |f1| is the reference filter that uses setValueAtTime to
        // update the AudioParam value.
        let f0 = new BiquadFilterNode(context, options.initializer);
        let f1 = new BiquadFilterNode(context, options.initializer);

        src.connect(f0).connect(merger, 0, 0);
        src.connect(f1).connect(merger, 0, 1);

        // Modulate the AudioParam with an input signal, if requested.
        if (options.modulation) {
          // The modulation signal is a sine wave with amplitude 1/3 the cutoff
          // frequency of the test filter.  The amplitude is fairly arbitrary,
          // but we want it to be a significant fraction of the cutoff so that
          // the cutoff varies quite a bit in the test.
          let mod =
              new OscillatorNode(context, {type: 'sawtooth', frequency: 1000});
          let modGain = new GainNode(context, {gain: f0.frequency.value / 3});
          mod.connect(modGain);
          modGain.connect(f0[paramName]);
          modGain.connect(f1[paramName]);
          mod.start();
        }
        // Output a message showing where we're starting from.
        should(f0[paramName].value, prefix + `At time 0, ${paramName}`)
            .beEqualTo(f0[paramName].value);

        // Schedule all of the desired changes from |changeList|.
        options.changeList.forEach(change => {
          let changeTime =
              change.quantum * RENDER_QUANTUM_FRAMES / context.sampleRate;
          let value = change.newValue;

          // Just output a message to show what we're doing.
          should(value, prefix + `At time ${changeTime}, ${paramName}`)
              .beEqualTo(value);

          // Update the AudioParam value of each filter using setValueAtTime or
          // the value setter.
          f1[paramName].setValueAtTime(value, changeTime);
          context.suspend(changeTime)
              .then(() => f0[paramName].value = value)
              .then(() => context.resume());
        });

        src.start();

        return context.startRendering().then(audio => {
          let actual = audio.getChannelData(0);
          let expected = audio.getChannelData(1);

          // The output from both filters MUST match exactly if dezippering has
          // been properly removed.
          let match = should(actual, `${prefix}Output from ${paramName} setter`)
                          .beCloseToArray(
                              expected, {absoluteThreshold: options.threshold});

          // Just an extra message saying that what we're comparing, to make the
          // output clearer. (Not really neceesary, but nice.)
          should(
              match,
              `${prefix}Output from ${
                                      paramName
                                    } setter matches setValueAtTime output`)
              .beTrue();
        });
      }

      // Filter one sample:
      //
      //   y[n] = b0 * x[n] + b1*x[n-1] + b2*x[n-2] - a1*y[n-1] - a2*y[n-2]
      //
      // where |x| is x[n], |xn1| is x[n-1], |xn2| is x[n-2], |yn1| is y[n-1],
      // and |yn2| is y[n-2].  |coef| is a dictonary of the filter coefficients
      // |b0|, |b1|, |b2|, |a1|, and |a2|.
      function filterSample(x, coef, yn1, yn2, xn1, xn2) {
        return coef.b0 * x + coef.b1 * xn1 + coef.b2 * xn2 - coef.a1 * yn1 -
            coef.a2 * yn2;
      }
    </script>
  </body>
</html>