summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/webaudio/the-audio-api/the-audioparam-interface/k-rate-oscillator-connections.html
blob: 475b36436728709ad58d25ee300af094ea208eac (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
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
<!doctype html>
<html>
  <head>
    <title>
      k-rate AudioParams with inputs for OscillatorNode
    </title>
    <script src="/resources/testharness.js"></script>
    <script src="/resources/testharnessreport.js"></script>
    <script src="/webaudio/resources/audit.js"></script>
    <script src="/webaudio/resources/audit-util.js"></script>
  </head>

  <body>
    <script>
      let audit = Audit.createTaskRunner();

      // Sample rate must be a power of two to eliminate round-off when
      // computing time from frames and vice versa.  Using a non-power of two
      // will work, but the thresholds below will not be zero.  They're probably
      // closer to 1e-5 or so, but if everything is working correctly, the
      // outputs really should be exactly equal.
      const sampleRate = 8192;

      // Fairly arbitrary but short duration to limit runtime.
      const testFrames = 5 * RENDER_QUANTUM_FRAMES;
      const testDuration = testFrames / sampleRate;

      audit.define(
          {label: 'Test 1', description: 'k-rate frequency input'},
          async (task, should) => {
            // Test that an input to the frequency AudioParam set to k-rate
            // works.

            // Fairly arbitrary start and end frequencies for the automation.
            const freqStart = 100;
            const freqEnd = 2000;

            let refSetup = (context) => {
              let srcRef = new OscillatorNode(context, {frequency: 0});

              should(
                  () => srcRef.frequency.automationRate = 'k-rate',
                  `${task.label}: srcRef.frequency.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => srcRef.frequency.setValueAtTime(freqStart, 0),
                  `${task.label}: srcRef.frequency.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();
              should(
                  () => srcRef.frequency.linearRampToValueAtTime(
                      freqEnd, testDuration),
                  `${task.label}: srcRef.frequency.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();

              return srcRef;
            };

            let testSetup = (context) => {
              let srcTest = new OscillatorNode(context, {frequency: 0});
              should(
                  () => srcTest.frequency.automationRate = 'k-rate',
                  `${task.label}: srcTest.frequency.automationRate = 'k-rate'`)
                  .notThrow();

              return srcTest;
            };

            let modSetup = (context) => {
              let mod = new ConstantSourceNode(context, {offset: 0});

              should(
                  () => mod.offset.setValueAtTime(freqStart, 0),
                  `${task.label}: modFreq.offset.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();
              should(
                  () =>
                      mod.offset.linearRampToValueAtTime(freqEnd, testDuration),
                  `${task.label}: modFreq.offset.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();

              // This node is going to be connected to the frequency AudioParam.
              return {frequency: mod};
            };

            await testParams(should, {
              prefix: task.label,
              summary: 'k-rate frequency with input',
              setupRefOsc: refSetup,
              setupTestOsc: testSetup,
              setupMod: modSetup
            });

            task.done();
          });

      audit.define(
          {label: 'Test 2', description: 'k-rate detune input'},
          async (task, should) => {
            // Test that an input to the detune AudioParam set to k-rate works.
            // Threshold experimentally determined.  It should be probably not
            // be much larger than 5e-5. or something is not right.

            // Fairly arbitrary start and end detune values for automation.
            const detuneStart = 0;
            const detuneEnd = 2000;

            let refSetup = (context) => {
              let srcRef = new OscillatorNode(context, {detune: 0});

              should(
                  () => srcRef.detune.automationRate = 'k-rate',
                  `${task.label}: srcRef.detune.automationRate = 'k-rate'`)
                  .notThrow();

              should(
                  () => srcRef.detune.setValueAtTime(detuneStart, 0),
                  `${task.label}: srcRef.detune.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => srcRef.detune.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: srcRef.detune.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return srcRef;
            };

            let testSetup = (context) => {
              let srcTest = new OscillatorNode(context, {detune: 0});

              should(
                  () => srcTest.detune.automationRate = 'k-rate',
                  `${task.label}: srcTest.detune.automationRate = 'k-rate'`)
                  .notThrow();

              return srcTest;
            };

            let modSetup = (context) => {
              let mod = new ConstantSourceNode(context, {offset: 0});

              should(
                  () => mod.offset.setValueAtTime(detuneStart, 0),
                  `${task.label}: modDetune.offset.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => mod.offset.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: modDetune.offset.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return {detune: mod};
            };

            await testParams(should, {
              prefix: task.label,
              summary: 'k-rate detune with input',
              setupRefOsc: refSetup,
              setupTestOsc: testSetup,
              setupMod: modSetup
            });

            task.done();
          });

      audit.define(
          {
            label: 'Test 3',
            description: 'k-rate frequency input with a-rate detune'
          },
          async (task, should) => {
            // Test OscillatorNode with a k-rate frequency with input and an
            // a-rate detune iwth automations.

            // Fairly arbitrary start and end values for the frequency and
            // detune automations.
            const freqStart = 100;
            const freqEnd = 2000;
            const detuneStart = 0;
            const detuneEnd = -2000;

            let refSetup = (context) => {
              let node = new OscillatorNode(context, {frequency: 0});

              // Set up k-rate frequency and a-rate detune
              should(
                  () => node.frequency.automationRate = 'k-rate',
                  `${task.label}: srcRef.frequency.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.frequency.setValueAtTime(freqStart, 0),
                  `${task.label}: srcRef.frequency.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();
              should(
                  () => node.frequency.linearRampToValueAtTime(
                      2000, testDuration),
                  `${task.label}: srcRef.frequency.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();
              should(
                  () => node.detune.setValueAtTime(detuneStart, 0),
                  `${task.label}: srcRef.detune.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => node.detune.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: srcRef.detune.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return node;
            };

            let testSetup = (context) => {
              let node = new OscillatorNode(context, {frequency: 0});

              should(
                  () => node.frequency.automationRate = 'k-rate',
                  `${task.label}: srcTest.frequency.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.detune.setValueAtTime(detuneStart, 0),
                  `${task.label}: srcTest.detune.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => node.detune.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: srcTest.detune.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return node;
            };

            let modSetup = (context) => {
              let mod = {};
              mod['frequency'] = new ConstantSourceNode(context, {offset: 0});

              should(
                  () => mod['frequency'].offset.setValueAtTime(freqStart, 0),
                  `${task.label}: modFreq.offset.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();

              should(
                  () => mod['frequency'].offset.linearRampToValueAtTime(
                      2000, testDuration),
                  `${task.label}: modFreq.offset.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();

              return mod;
            };

            await testParams(should, {
              prefix: task.label,
              summary: 'k-rate frequency input with a-rate detune',
              setupRefOsc: refSetup,
              setupTestOsc: testSetup,
              setupMod: modSetup
            });

            task.done();
          });

      audit.define(
          {
            label: 'Test 4',
            description: 'a-rate frequency with k-rate detune input'
          },
          async (task, should) => {
            // Test OscillatorNode with an a-rate frequency with automations and
            // a k-rate detune with input.

            // Fairly arbitrary start and end values for the frequency and
            // detune automations.
            const freqStart = 100;
            const freqEnd = 2000;
            const detuneStart = 0;
            const detuneEnd = -2000;

            let refSetup = (context) => {
              let node = new OscillatorNode(context, {detune: 0});

              // Set up a-rate frequency and k-rate detune
              should(
                  () => node.frequency.setValueAtTime(freqStart, 0),
                  `${task.label}: srcRef.frequency.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();
              should(
                  () => node.frequency.linearRampToValueAtTime(
                      2000, testDuration),
                  `${task.label}: srcRef.frequency.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();
              should(
                  () => node.detune.automationRate = 'k-rate',
                  `${task.label}: srcRef.detune.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.detune.setValueAtTime(detuneStart, 0),
                  `${task.label}: srcRef.detune.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => node.detune.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: srcRef.detune.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return node;
            };

            let testSetup = (context) => {
              let node = new OscillatorNode(context, {detune: 0});

              should(
                  () => node.detune.automationRate = 'k-rate',
                  `${task.label}: srcTest.detune.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.frequency.setValueAtTime(freqStart, 0),
                  `${task.label}: srcTest.frequency.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();
              should(
                  () => node.frequency.linearRampToValueAtTime(
                      freqEnd, testDuration),
                  `${task.label}: srcTest.frequency.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();

              return node;
            };

            let modSetup = (context) => {
              let mod = {};
              const name = 'detune';

              mod['detune'] = new ConstantSourceNode(context, {offset: 0});
              should(
                  () => mod[name].offset.setValueAtTime(detuneStart, 0),
                  `${task.label}: modDetune.offset.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();

              should(
                  () => mod[name].offset.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: modDetune.offset.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return mod;
            };

            await testParams(should, {
              prefix: task.label,
              summary: 'k-rate detune input with a-rate frequency',
              setupRefOsc: refSetup,
              setupTestOsc: testSetup,
              setupMod: modSetup
            });

            task.done();
          });

      audit.define(
          {
            label: 'Test 5',
            description: 'k-rate inputs for frequency and detune'
          },
          async (task, should) => {
            // Test OscillatorNode with k-rate frequency and detune with inputs
            // on both.

            // Fairly arbitrary start and end values for the frequency and
            // detune automations.
            const freqStart = 100;
            const freqEnd = 2000;
            const detuneStart = 0;
            const detuneEnd = -2000;

            let refSetup = (context) => {
              let node = new OscillatorNode(context, {frequency: 0, detune: 0});

              should(
                  () => node.frequency.automationRate = 'k-rate',
                  `${task.label}: srcRef.frequency.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.frequency.setValueAtTime(freqStart, 0),
                  `${task.label}: srcRef.setValueAtTime(${freqStart}, 0)`)
                  .notThrow();
              should(
                  () => node.frequency.linearRampToValueAtTime(
                      freqEnd, testDuration),
                  `${task.label}: srcRef;.frequency.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();
              should(
                  () => node.detune.automationRate = 'k-rate',
                  `${task.label}: srcRef.detune.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.detune.setValueAtTime(detuneStart, 0),
                  `${task.label}: srcRef.detune.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => node.detune.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: srcRef.detune.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return node;
            };

            let testSetup = (context) => {
              let node = new OscillatorNode(context, {frequency: 0, detune: 0});

              should(
                  () => node.frequency.automationRate = 'k-rate',
                  `${task.label}: srcTest.frequency.automationRate = 'k-rate'`)
                  .notThrow();
              should(
                  () => node.detune.automationRate = 'k-rate',
                  `${task.label}: srcTest.detune.automationRate = 'k-rate'`)
                  .notThrow();

              return node;
            };

            let modSetup = (context) => {
              let modF = new ConstantSourceNode(context, {offset: 0});

              should(
                  () => modF.offset.setValueAtTime(freqStart, 0),
                  `${task.label}: modFreq.offset.setValueAtTime(${
                      freqStart}, 0)`)
                  .notThrow();
              should(
                  () => modF.offset.linearRampToValueAtTime(
                      freqEnd, testDuration),
                  `${task.label}: modFreq.offset.linearRampToValueAtTime(${
                      freqEnd}, ${testDuration})`)
                  .notThrow();

              let modD = new ConstantSourceNode(context, {offset: 0});

              should(
                  () => modD.offset.setValueAtTime(detuneStart, 0),
                  `${task.label}: modDetune.offset.setValueAtTime(${
                      detuneStart}, 0)`)
                  .notThrow();
              should(
                  () => modD.offset.linearRampToValueAtTime(
                      detuneEnd, testDuration),
                  `${task.label}: modDetune.offset.linearRampToValueAtTime(${
                      detuneEnd}, ${testDuration})`)
                  .notThrow();

              return {frequency: modF, detune: modD};
            };

            await testParams(should, {
              prefix: task.label,
              summary: 'k-rate inputs for both frequency and detune',
              setupRefOsc: refSetup,
              setupTestOsc: testSetup,
              setupMod: modSetup
            });

            task.done();
          });

      audit.run();

      async function testParams(should, options) {
        // Test a-rate and k-rate AudioParams of an OscillatorNode.
        //
        // |options| should be a dictionary with these members:
        //   prefix       - prefix to use for messages
        //   summary      - message to be printed with the final results
        //   setupRefOsc  - function returning the reference oscillator
        //   setupTestOsc - function returning the test oscillator
        //   setupMod     - function returning nodes to be connected to the
        //   AudioParams.
        //
        // |setupRefOsc| and |setupTestOsc| are given the context and each
        // method is expected to create an OscillatorNode with the appropriate
        // automations for testing.  The constructed OscillatorNode is returned.
        //
        // The reference oscillator
        // should automate the desired AudioParams at the appropriate automation
        // rate, and the output is the expected result.
        //
        // The test oscillator should set up the AudioParams but expect the
        // AudioParam(s) have an input that matches the automation for the
        // reference oscillator.
        //
        // |setupMod| must create one or two ConstantSourceNodes with exactly
        // the same automations as used for the reference oscillator.  This node
        // is used as the input to an AudioParam of the test oscillator.  This
        // function returns a dictionary whose members are named 'frequency' and
        // 'detune'.  The name indicates which AudioParam the constant source
        // node should be connected to.

        // Two channels: 0 = reference signal, 1 = test signal
        let context = new OfflineAudioContext({
          numberOfChannels: 2,
          sampleRate: sampleRate,
          length: testDuration * sampleRate
        });

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

        // The reference oscillator.
        let srcRef = options.setupRefOsc(context);

        // The test oscillator.
        let srcTest = options.setupTestOsc(context);

        // Inputs to AudioParam.
        let mod = options.setupMod(context);

        if (mod['frequency']) {
          should(
              () => mod['frequency'].connect(srcTest.frequency),
              `${options.prefix}: modFreq.connect(srcTest.frequency)`)
              .notThrow();
          mod['frequency'].start()
        }

        if (mod['detune']) {
          should(
              () => mod['detune'].connect(srcTest.detune),
              `${options.prefix}: modDetune.connect(srcTest.detune)`)
              .notThrow();
          mod['detune'].start()
        }

        srcRef.connect(merger, 0, 0);
        srcTest.connect(merger, 0, 1);

        srcRef.start();
        srcTest.start();

        let buffer = await context.startRendering();
        let expected = buffer.getChannelData(0);
        let actual = buffer.getChannelData(1);

        // The output of the reference and test oscillator should be
        // exactly equal because the AudioParam values should be exactly
        // equal.
        should(actual, options.summary).beCloseToArray(expected, {
          absoluteThreshold: 0
        });
      }
    </script>
  </body>
</html>