soundkit 0.12.2

Audio format optimised for low-latency audio.
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

const test = require("tap").test;

const { ringbuffer_from_data, sharedbuffer_growable, sharedbuffer, ringbuffer } = require("./../ringbuffer");

test("from data", (t) => {
  const testData = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
  const frame_size = 2;
  const rb = ringbuffer_from_data(testData, Uint8Array, frame_size);

  t.equal(rb.count(), 4);

  t.same(rb.pop(), [1, 2]);
  t.same(rb.pop(), [3, 4]);
  t.same(rb.pop(), [5, 6]);
  t.same(rb.pop(), [7, 8]);
  t.equal(rb.pop(), undefined);


  t.end();

});

const tests = (shared_buffer) => {
  test("pop should return undefined when buffer is empty", (t) => {
    const frame_size = 4;
    const max_frames = 8;

    const sb = shared_buffer(frame_size, max_frames, Uint8Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Uint8Array);
    const poppedFrame = rb.pop();
    t.equal(
      poppedFrame,
      undefined,
      "Popping from an empty buffer should return undefined"
    );

    t.end();
  });

  test("fifo push and pop", (t) => {
    const frame_size = 4;
    const max_frames = 100;
    const sb = shared_buffer(frame_size, max_frames, Uint8Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Uint8Array);

    const frames = [
      new Uint8Array([1, 2, 3, 4]),
      new Uint8Array([5, 6, 7, 8]),
      new Uint8Array([9, 10, 11, 12]),
      new Uint8Array([13, 14, 15, 16]),
      new Uint8Array([2, 2, 3, 4]),
      new Uint8Array([3, 6, 7, 8]),
      new Uint8Array([4, 10, 11, 12]),
      new Uint8Array([5, 14, 15, 16]),
    ];

    for (let i = 0; i < frames.length; i++) {
      rb.push(frames[i]);
    }

    for (let i = 0; i < frames.length; i++) {
      const res = rb.pop();
      t.same(res, frames[i], `frame ${i} should match`);
    }

    t.end();
  });

  test("fifo push and pop float", (t) => {
    const frame_size = 4;
    const max_frames = 100;
    const sb = shared_buffer(frame_size, max_frames, Float32Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Float32Array);

    const frames = [
      new Float32Array([1, 2, 3.2, 4]),
      new Float32Array([5, 6.44, 7, 8]),
      new Float32Array([9.1, 10.22, 11, 12]),
      new Float32Array([13, 14, 15, 16]),
      new Float32Array([2, 2.2, 3, 4]),
    ];

    for (let i = 0; i < frames.length; i++) {
      rb.push(frames[i]);
    }

    for (let i = 0; i < frames.length; i++) {
      const res = rb.pop();
      t.same(res, frames[i], `frame ${i} should match`);
    }

    t.end();
  });

  test("push and pop with wrapping", (t) => {
    const frame_size = 4;
    const max_frames = 2;

    const sb = shared_buffer(frame_size, max_frames, Uint8Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Uint8Array);

    const frame1 = new Uint8Array([1, 2, 3, 4]);
    const frame2 = new Uint8Array([5, 6, 7, 8]);
    const frame3 = new Uint8Array([9, 10, 11, 12]);
    const frame4 = new Uint8Array([13, 14, 15, 16]);

    rb.push(frame1);
    rb.push(frame2);

    t.same(rb.pop(), frame1);
    t.same(rb.pop(), frame2);

    rb.push(frame3);
    rb.push(frame4);

    t.same(rb.pop(), frame3);
    t.same(rb.pop(), frame4);

    t.end();
  });

  test("push and pop with wrapping overwrite", (t) => {
    const frame_size = 4;
    const max_frames = 2;

    const sb = shared_buffer(frame_size, max_frames, Uint8Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Uint8Array);

    const frame1 = new Uint8Array([1, 2, 3, 4]);
    const frame2 = new Uint8Array([5, 6, 7, 8]);
    const frame3 = new Uint8Array([9, 10, 11, 12]);
    const frame4 = new Uint8Array([13, 14, 15, 16]);

    rb.push(frame1);
    rb.push(frame2);
    rb.push(frame3);
    rb.push(frame4);

    t.same(rb.pop(), frame3);
    t.same(rb.pop(), frame4);
    t.same(rb.pop(), undefined);

    t.same(rb.dropped_count(), 2);

    t.end();
  });

  test("push and pop with multiple wrapping overwrite", (t) => {
    const frame_size = 4;
    const max_frames = 2;

    const sb = shared_buffer(frame_size, max_frames, Uint8Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Uint8Array);

    const frame1 = new Uint8Array([1, 2, 3, 4]);
    const frame2 = new Uint8Array([5, 6, 7, 8]);
    const frame3 = new Uint8Array([9, 10, 11, 12]);
    const frame4 = new Uint8Array([13, 14, 15, 16]);

    rb.push(frame1);
    rb.push(frame2);
    rb.push(frame3);
    rb.push(frame4);
    rb.push(frame1);
    rb.push(frame2);
    rb.push(frame3);
    rb.push(frame4);

    t.same(rb.pop(), frame3);
    t.same(rb.pop(), frame4);
    t.same(rb.pop(), undefined);

    t.same(rb.dropped_count(), 6);
    t.end();
  });

  test("float data type multiple", (t) => {
    const frame_size = 4;
    const max_frames = 2;

    const sb = shared_buffer(frame_size, max_frames, Float32Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Float32Array);

    const frame1 = new Float32Array([1, 2, 3, 4.23]);
    const frame2 = new Float32Array([5, 6.44, 2, 7]);
    const frame3 = new Float32Array([9, 10, 11, 12]);
    const frame4 = new Float32Array([13.2, 14, 15, 16]);

    rb.push(frame1);
    rb.push(frame2);
    rb.push(frame3);
    rb.push(frame4);
    rb.push(frame1);
    rb.push(frame2);
    rb.push(frame3);
    rb.push(frame4);

    t.same(rb.pop(), frame3);
    t.same(rb.pop(), frame4);
    t.same(rb.pop(), undefined);

    t.same(rb.dropped_count(), 6);

    t.end();
  });

  test("float data type", (t) => {
    const frame_size = 4;
    const max_frames = 2;

    const sb = shared_buffer(frame_size, max_frames, Float32Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Float32Array);

    const frame1 = new Float32Array([1, 2, 3, 4.23]);
    const frame2 = new Float32Array([5, 6.44, 2, 7]);
    const frame3 = new Float32Array([9, 10, 11, 12]);
    const frame4 = new Float32Array([13.2, 14, 15, 16]);

    rb.push(frame1);
    rb.push(frame2);
    rb.push(frame3);
    rb.push(frame4);

    t.same(rb.pop(), frame3);
    t.same(rb.pop(), frame4);
    t.same(rb.pop(), undefined);

    t.same(rb.dropped_count(), 2);

    t.end();
  });

  test("push and pop with", (t) => {
    const frame_size = 2;
    const max_frames = 64;

    const sb = shared_buffer(frame_size, max_frames, Uint8Array);
    const rb = ringbuffer(sb, frame_size, max_frames, Uint8Array);

    const a = [];
    for (let i = 0; i < 100; i++) {
      a.push(new Uint8Array([i, 0]));
    }
    const b = [];
    for (let i = 0; i < 100; i++) {
      b.push(new Uint8Array([i, 1]));
    }

    for (let i = 0; i < a.length; i++) {
      rb.push(a[i]);
      rb.push(b[i]);

      const res = [];

      while (true) {
        let r = rb.pop();
        if (r) {
          res.push(r);
        } else {
          break;
        }
      }

      t.same(res[0], a[i]);
      t.same(res[1], b[i]);
      t.same(res.length, 2);
    }

    t.end();
  });
}

tests(sharedbuffer);
tests(sharedbuffer_growable);