@qvac/decoder-audio 0.2.4 → 0.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,17 +1,26 @@
1
1
  'use strict'
2
2
 
3
- const { Worker } = require('bare-worker')
4
3
  const QvacResponse = require('@qvac/response')
5
4
  const QvacLogger = require('@qvac/logging')
6
- const path = require('bare-path')
7
- const Channel = require('bare-channel')
8
- const { FFmpegDecoderMessages, FFmpegWorkerMessages } = require('./constants')
5
+ const ffmpeg = require('bare-ffmpeg')
9
6
  const BaseInference = require('@qvac/infer-base/WeightsProvider/BaseInference')
10
7
 
11
8
  /**
12
- * FFmpeg-based audio decoder that runs in a worker thread
9
+ * FFmpeg-based audio decoder (single-threaded)
13
10
  */
14
11
  class FFmpegDecoder extends BaseInference {
12
+ SUPPORTED_AUDIO_FORMATS = {
13
+ s16le: {
14
+ format: null, // Will be set to ffmpeg.constants.sampleFormats.S16
15
+ byteLength: 2
16
+ },
17
+ f32le: {
18
+ format: null, // Will be set to ffmpeg.constants.sampleFormats.FLT
19
+ byteLength: 4
20
+ }
21
+ }
22
+
23
+ OUTPUT_CHANNEL_LAYOUT = null // Will be set to ffmpeg.constants.channelLayouts.MONO
15
24
  /**
16
25
  * Creates an instance of FFmpegDecoder.
17
26
  * @param {Object} config - Configuration options
@@ -37,15 +46,19 @@ class FFmpegDecoder extends BaseInference {
37
46
  super({ ...args, logger })
38
47
 
39
48
  this.config = {
40
- streamIndex,
41
- inputBitrate,
42
- audioFormat
49
+ streamIndex: config.streamIndex || streamIndex,
50
+ inputBitrate: config.inputBitrate || inputBitrate,
51
+ audioFormat: config.audioFormat || audioFormat,
52
+ sampleRate: config.sampleRate || 16000
43
53
  }
44
54
 
45
55
  this.logger = new QvacLogger(logger)
46
- this.worker = null
47
56
  this.isLoaded = false
48
57
  this.currentJob = null
58
+
59
+ // Encoder delay handling
60
+ this.samplesSkipped = 0
61
+ this.totalSkipSamples = 0
49
62
  }
50
63
 
51
64
  /**
@@ -59,25 +72,15 @@ class FFmpegDecoder extends BaseInference {
59
72
 
60
73
  this.logger.info('Loading FFmpegDecoder with config:', this.config)
61
74
 
62
- // Create worker thread
63
- const workerPath = path.join(__dirname, 'ffmpeg-worker.js')
64
- this.worker = new Worker(workerPath)
65
-
66
- // Wait for worker to be ready
67
- await new Promise((resolve, reject) => {
68
- const timeout = setTimeout(() => {
69
- reject(new Error('Worker initialization timeout'))
70
- }, 5000)
71
-
72
- this.worker.once('message', (msg) => {
73
- clearTimeout(timeout)
74
- if (msg.type === FFmpegWorkerMessages.READY) {
75
- resolve()
76
- } else {
77
- reject(new Error('Unexpected worker message during init'))
78
- }
79
- })
80
- })
75
+ // Initialize format constants
76
+ this.SUPPORTED_AUDIO_FORMATS.s16le.format = ffmpeg.constants.sampleFormats.S16
77
+ this.SUPPORTED_AUDIO_FORMATS.f32le.format = ffmpeg.constants.sampleFormats.FLT
78
+ this.OUTPUT_CHANNEL_LAYOUT = ffmpeg.constants.channelLayouts.MONO
79
+
80
+ // Validate audio format
81
+ if (!this.SUPPORTED_AUDIO_FORMATS[this.config.audioFormat]) {
82
+ throw new Error(`Unsupported audio format: ${this.config.audioFormat}`)
83
+ }
81
84
 
82
85
  this.isLoaded = true
83
86
  this.logger.info('FFmpegDecoder loaded successfully')
@@ -92,24 +95,7 @@ class FFmpegDecoder extends BaseInference {
92
95
  }
93
96
 
94
97
  this.logger.info('Unloading FFmpegDecoder')
95
-
96
- if (this.worker) {
97
- await new Promise((resolve) => {
98
- this.worker.postMessage({ type: FFmpegDecoderMessages.CLEANUP })
99
- this.worker.once('message', (msg) => {
100
- if (msg.type === FFmpegWorkerMessages.CLEANUP_DONE) {
101
- resolve()
102
- }
103
- })
104
-
105
- // Fallback timeout
106
- setTimeout(resolve, 1000)
107
- })
108
-
109
- await this.worker.terminate()
110
- this.worker = null
111
- }
112
-
98
+
113
99
  this.isLoaded = false
114
100
  this.currentJob = null
115
101
  this.logger.info('FFmpegDecoder unloaded')
@@ -149,69 +135,130 @@ class FFmpegDecoder extends BaseInference {
149
135
  return response
150
136
  }
151
137
 
152
- _handleWorkerMessage (job) {
153
- return new Promise((resolve, reject) => {
154
- const messageHandler = async (msg) => {
155
- this.logger.debug('[FFmpegDecoder] Received message from worker:', msg)
156
- switch (msg.type) {
157
- case FFmpegWorkerMessages.INIT_RESULT: {
158
- if (msg.success) {
159
- this.logger.info('[FFmpegDecoder] Decoder initialized successfully')
160
- this.worker.postMessage({
161
- type: FFmpegDecoderMessages.STREAM_START
162
- })
163
- } else {
164
- this.worker.off('message', messageHandler)
165
- this.logger.error('[FFmpegDecoder] Failed to initialize decoder:', msg.error)
166
- }
167
- break
168
- }
138
+ _getBufferSize (inputBitrate) {
139
+ const maxBufferSize = 1024 * 1024 // 1MB max
140
+ return Math.min((inputBitrate / 8) * 4, maxBufferSize)
141
+ }
169
142
 
170
- case FFmpegWorkerMessages.RESULT_CHUNK: {
171
- const decodedBuffer = Buffer.from(msg.data)
172
- this.logger.debug('[FFmpegDecoder] Result chunk', decodedBuffer.length)
173
- job.response.updateOutput({ outputArray: decodedBuffer })
174
- break
175
- }
143
+ _processFrame (decoder, raw, resampler, job) {
144
+ const OUTPUT_FORMAT = this.SUPPORTED_AUDIO_FORMATS[this.config.audioFormat].format
145
+ const OUTPUT_FORMAT_BYTE_LENGTH = this.SUPPORTED_AUDIO_FORMATS[this.config.audioFormat].byteLength
146
+ const OUTPUT_SAMPLE_RATE = this.config.sampleRate
147
+
148
+ while (decoder.receiveFrame(raw)) {
149
+ const output = new ffmpeg.Frame()
150
+ output.channelLayout = this.OUTPUT_CHANNEL_LAYOUT
151
+ output.format = OUTPUT_FORMAT
152
+ output.sampleRate = OUTPUT_SAMPLE_RATE
153
+ output.nbSamples = raw.nbSamples
154
+
155
+ const samples = new ffmpeg.Samples(
156
+ output.format,
157
+ output.channelLayout.nbChannels,
158
+ output.nbSamples
159
+ )
160
+ samples.fill(output)
161
+
162
+ const count = resampler.convert(raw, output)
163
+
164
+ // Handle encoder delay by skipping initial samples
165
+ if (this.samplesSkipped < this.totalSkipSamples) {
166
+ const samplesToSkip = Math.min(count, this.totalSkipSamples - this.samplesSkipped)
167
+ this.samplesSkipped += samplesToSkip
168
+ if (samplesToSkip >= count) continue // Skip entire frame
169
+
170
+ // Skip partial frame
171
+ const skipBytes = OUTPUT_FORMAT_BYTE_LENGTH * samplesToSkip * output.channelLayout.nbChannels
172
+ const length = OUTPUT_FORMAT_BYTE_LENGTH * (count - samplesToSkip) * output.channelLayout.nbChannels
173
+ const chunk = Buffer.from(samples.data.subarray(skipBytes, skipBytes + length))
174
+ job.response.updateOutput({ outputArray: chunk })
175
+ } else {
176
+ const length = OUTPUT_FORMAT_BYTE_LENGTH * count * output.channelLayout.nbChannels
177
+ const chunk = Buffer.from(samples.data.subarray(0, length))
178
+ job.response.updateOutput({ outputArray: chunk })
179
+ }
180
+ }
181
+ }
176
182
 
177
- case FFmpegWorkerMessages.RESULT_END: {
178
- this.logger.debug('[FFmpegDecoder] Result end')
179
- job.response.ended()
180
- this.worker.off('message', messageHandler)
181
- resolve()
182
- break
183
- }
183
+ _processPacket (format, packet, raw, decoder, resampler, job) {
184
+ while (format.readFrame(packet)) {
185
+ decoder.sendPacket(packet)
186
+ this._processFrame(decoder, raw, resampler, job)
187
+ packet.unref()
188
+ }
189
+ }
184
190
 
185
- case FFmpegWorkerMessages.ERROR: {
186
- const errorMessage = msg.error || msg.data?.error || 'Unknown error'
187
- this.logger.error('[FFmpegDecoder] Error from worker:', errorMessage)
188
- job.response.failed(errorMessage)
189
- this.worker.off('message', messageHandler)
190
- reject(new Error(errorMessage))
191
- break
192
- }
193
- }
194
- }
191
+ _processFFmpegStream (format, stream, job) {
192
+ const OUTPUT_FORMAT = this.SUPPORTED_AUDIO_FORMATS[this.config.audioFormat].format
193
+ const OUTPUT_FORMAT_BYTE_LENGTH = this.SUPPORTED_AUDIO_FORMATS[this.config.audioFormat].byteLength
194
+ const OUTPUT_SAMPLE_RATE = this.config.sampleRate
195
+
196
+ this.logger.debug('[FFmpegDecoder] Stream codec:', stream.codec, stream.codecParameters)
197
+
198
+ const packet = new ffmpeg.Packet()
199
+ const raw = new ffmpeg.Frame()
200
+
201
+ const resampler = new ffmpeg.Resampler(
202
+ stream.codecParameters.sampleRate,
203
+ stream.codecParameters.channelLayout,
204
+ stream.codecParameters.format,
205
+ OUTPUT_SAMPLE_RATE,
206
+ this.OUTPUT_CHANNEL_LAYOUT,
207
+ OUTPUT_FORMAT
208
+ )
209
+
210
+ const decoder = stream.decoder()
211
+ decoder.open()
212
+
213
+ // Auto-detect encoder delay: lossy codecs need ~400ms skipped to remove artifacts
214
+ const codecName = stream.codec.name.toLowerCase()
215
+ const SKIP_MS = {
216
+ mp3: 400,
217
+ vorbis: 400,
218
+ opus: 150,
219
+ aac: 300
220
+ }
195
221
 
196
- this.worker.on('message', messageHandler)
197
- this.worker.on('error', (err) => {
198
- this.logger.error('[FFmpegDecoder] Error from worker:', err)
199
- job.response.failed(err)
200
- this.worker.off('message', messageHandler)
201
- reject(err)
202
- })
203
- })
222
+ const skipMs = SKIP_MS[codecName] || 0
223
+ this.samplesSkipped = 0
224
+ this.totalSkipSamples = Math.floor((OUTPUT_SAMPLE_RATE * skipMs) / 1000)
225
+
226
+ if (this.totalSkipSamples > 0) {
227
+ this.logger.info(`[FFmpegDecoder] Skipping ${skipMs}ms (${this.totalSkipSamples} samples) for ${codecName} to remove encoder artifacts`)
228
+ }
229
+
230
+ this._processPacket(format, packet, raw, decoder, resampler, job)
231
+
232
+ // Flush resampler
233
+ const output = new ffmpeg.Frame()
234
+ output.channelLayout = this.OUTPUT_CHANNEL_LAYOUT
235
+ output.format = OUTPUT_FORMAT
236
+ output.sampleRate = OUTPUT_SAMPLE_RATE
237
+ output.nbSamples = 1024
238
+
239
+ const samples = new ffmpeg.Samples(
240
+ output.format,
241
+ output.channelLayout.nbChannels,
242
+ output.nbSamples
243
+ )
244
+ samples.fill(output)
245
+
246
+ while (resampler.flush(output) > 0) {
247
+ const chunk = Buffer.from(samples.data)
248
+ job.response.updateOutput({ outputArray: chunk })
249
+ }
250
+
251
+ decoder.destroy()
204
252
  }
205
253
 
206
- async _streamAudioToWorker (audioStream, port, job) {
207
- let chunkCount = 0
254
+ async _collectStreamData (audioStream, job) {
255
+ const chunks = []
256
+ let totalBytes = 0
257
+
208
258
  for await (const chunk of audioStream) {
209
- chunkCount++
210
-
211
- this.logger.debug(`[FFmpegDecoder] Received audio chunk #${chunkCount}, size: ${chunk.length} bytes`)
212
259
  if (!job.isActive) {
213
- this.logger.info('[FFmpegDecoder] Job cancelled, stopping stream collection at chunk', chunkCount)
214
- return
260
+ this.logger.info('[FFmpegDecoder] Job cancelled, stopping stream collection')
261
+ break
215
262
  }
216
263
 
217
264
  while (job.isPaused) {
@@ -219,9 +266,12 @@ class FFmpegDecoder extends BaseInference {
219
266
  await new Promise(resolve => setTimeout(resolve, 100))
220
267
  }
221
268
 
222
- port.writeSync(chunk)
269
+ chunks.push(chunk)
270
+ totalBytes += chunk.length
271
+ this.logger.debug(`[FFmpegDecoder] Collected chunk, total bytes: ${totalBytes}`)
223
272
  }
224
- return chunkCount
273
+
274
+ return Buffer.concat(chunks)
225
275
  }
226
276
 
227
277
  async _processStream (audioStream) {
@@ -231,32 +281,53 @@ class FFmpegDecoder extends BaseInference {
231
281
  }
232
282
 
233
283
  try {
234
- const channel = new Channel()
235
- const port = channel.connect()
284
+ this.logger.info('[FFmpegDecoder] Starting stream processing')
236
285
 
237
- this.logger.debug('[FFmpegDecoder] Processing audio stream with channel handle:', channel.handle)
286
+ // Collect all audio data from stream
287
+ const audioBuffer = await this._collectStreamData(audioStream, job)
288
+ this.logger.info(`[FFmpegDecoder] Collected ${audioBuffer.length} bytes of audio data`)
238
289
 
239
- // Worker promise to handle worker messages
240
- const workerCompletionPromise = this._handleWorkerMessage(job)
290
+ if (!job.isActive) {
291
+ this.logger.info('[FFmpegDecoder] Job cancelled after data collection')
292
+ return
293
+ }
294
+
295
+ // Create FFmpeg IO context with the buffer
296
+ const bufferSize = this._getBufferSize(this.config.inputBitrate)
297
+ let bufferOffset = 0
298
+
299
+ const io = new ffmpeg.IOContext(bufferSize, {
300
+ onread: (buffer, requestedLen) => {
301
+ const remainingBytes = audioBuffer.length - bufferOffset
302
+ const bytesToRead = Math.min(requestedLen, remainingBytes)
303
+
304
+ if (bytesToRead <= 0) {
305
+ return 0 // EOF
306
+ }
241
307
 
242
- // Initialize ffmpeg worker
243
- this.worker.postMessage({
244
- type: FFmpegDecoderMessages.INIT,
245
- data: {
246
- channelHandle: channel.handle,
247
- config: this.config
308
+ audioBuffer.copy(buffer, 0, bufferOffset, bufferOffset + bytesToRead)
309
+ bufferOffset += bytesToRead
310
+
311
+ this.logger.debug(`[FFmpegDecoder] Read ${bytesToRead} bytes from buffer, offset now: ${bufferOffset}`)
312
+ return bytesToRead
248
313
  }
249
314
  })
250
315
 
251
- // Stream all audio chunks to ffmpeg worker
252
- const chunkCount = await this._streamAudioToWorker(audioStream, port, job)
253
- this.logger.info(`[FFmpegDecoder] Finished streaming audio. Total chunks sent: ${chunkCount}`)
316
+ this.logger.debug('[FFmpegDecoder] IOContext created')
317
+ const format = new ffmpeg.InputFormatContext(io)
318
+ this.logger.debug('[FFmpegDecoder] InputFormatContext created')
319
+
320
+ const streamIndex = this.config.streamIndex || 0
321
+ if (format.streams[streamIndex] === undefined) {
322
+ throw new Error('Stream index out of bounds')
323
+ }
254
324
 
255
- // Signal to worker that we're done sending audio
256
- await port.close()
325
+ // Process the stream and generate decoded output
326
+ this._processFFmpegStream(format, format.streams[streamIndex], job)
257
327
 
258
- // Wait for worker to finish
259
- await workerCompletionPromise
328
+ // Mark as complete
329
+ job.response.ended()
330
+ this.logger.info('[FFmpegDecoder] Stream processing completed successfully')
260
331
  } catch (err) {
261
332
  this.logger.error('Error processing audio stream:', err)
262
333
  job.response.failed(err)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qvac/decoder-audio",
3
- "version": "0.2.4",
3
+ "version": "0.2.6",
4
4
  "description": "",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Tether",
@@ -47,8 +47,8 @@
47
47
  "typescript": "^5.3.0"
48
48
  },
49
49
  "dependencies": {
50
- "@qvac/infer-base": "^0.1.0",
51
50
  "@qvac/error": "^0.1.0",
51
+ "@qvac/infer-base": "^0.1.0",
52
52
  "@qvac/logging": "^0.1.0",
53
53
  "@qvac/response": "^0.1.0",
54
54
  "bare-assert": "^1.1.0",
@@ -57,8 +57,7 @@
57
57
  "bare-fs": "^4.5.1",
58
58
  "bare-path": "^3.0.0",
59
59
  "bare-process": "^4.2.2",
60
- "process": "npm:bare-process@^4.2.2",
61
- "bare-worker": "^4.1.0"
60
+ "process": "npm:bare-process@^4.2.2"
62
61
  },
63
62
  "bugs": "https://github.com/tetherto/qvac-lib-decoder-audio/issues",
64
63
  "types": "index.d.ts"
@@ -7,7 +7,7 @@
7
7
  ],
8
8
  "current_versions": [
9
9
  {
10
- "version": "0.2.4"
10
+ "version": "0.2.6"
11
11
  }
12
12
  ],
13
13
  "exported_symbols": [
@@ -7,7 +7,7 @@
7
7
  ],
8
8
  "current_versions": [
9
9
  {
10
- "version": "0.2.4"
10
+ "version": "0.2.6"
11
11
  }
12
12
  ],
13
13
  "exported_symbols": [
@@ -7,7 +7,7 @@
7
7
  ],
8
8
  "current_versions": [
9
9
  {
10
- "version": "0.2.4"
10
+ "version": "0.2.6"
11
11
  }
12
12
  ],
13
13
  "exported_symbols": [
@@ -7,7 +7,7 @@
7
7
  ],
8
8
  "current_versions": [
9
9
  {
10
- "version": "0.2.4"
10
+ "version": "0.2.6"
11
11
  }
12
12
  ],
13
13
  "exported_symbols": [
@@ -0,0 +1,105 @@
1
+ const { FFmpegDecoder } = require('@qvac/decoder-audio')
2
+
3
+ async function testFFmpegDecodeMp3() {
4
+ try {
5
+ const decoder = new FFmpegDecoder({
6
+ config: {
7
+ audioFormat: 's16le',
8
+ sampleRate: 16000
9
+ }
10
+ })
11
+
12
+ await decoder.load()
13
+
14
+ const audioPath = getAssetPath('sample.mp3')
15
+ const audioStream = fs.createReadStream(audioPath)
16
+
17
+ const response = await decoder.run(audioStream)
18
+
19
+ let totalBytes = 0
20
+ let updateCount = 0
21
+
22
+ await response
23
+ .onUpdate(output => {
24
+ if (output && output.outputArray) {
25
+ const bytes = new Uint8Array(output.outputArray)
26
+ totalBytes += bytes.length
27
+ updateCount++
28
+ }
29
+ })
30
+ .await()
31
+
32
+ if (totalBytes === 0) {
33
+ throw new Error('No audio data decoded')
34
+ }
35
+
36
+ if (updateCount === 0) {
37
+ throw new Error('No decoder updates received')
38
+ }
39
+
40
+ console.log(`MP3 decode complete: ${totalBytes} bytes, ${updateCount} updates`)
41
+
42
+ await decoder.unload()
43
+
44
+ return {
45
+ success: true,
46
+ totalBytes,
47
+ updateCount
48
+ }
49
+ } catch (error) {
50
+ console.error('Error during testFFmpegDecodeMp3:', error)
51
+ throw error
52
+ }
53
+ }
54
+
55
+ async function testFFmpegDecodeWav() {
56
+ try {
57
+ const decoder = new FFmpegDecoder({
58
+ config: {
59
+ audioFormat: 's16le',
60
+ sampleRate: 16000
61
+ }
62
+ })
63
+
64
+ await decoder.load()
65
+
66
+ const audioPath = getAssetPath('sample.wav')
67
+ const audioStream = fs.createReadStream(audioPath)
68
+
69
+ const response = await decoder.run(audioStream)
70
+
71
+ let totalBytes = 0
72
+ let updateCount = 0
73
+
74
+ await response
75
+ .onUpdate(output => {
76
+ if (output && output.outputArray) {
77
+ const bytes = new Uint8Array(output.outputArray)
78
+ totalBytes += bytes.length
79
+ updateCount++
80
+ }
81
+ })
82
+ .await()
83
+
84
+ if (totalBytes === 0) {
85
+ throw new Error('No audio data decoded')
86
+ }
87
+
88
+ if (updateCount === 0) {
89
+ throw new Error('No decoder updates received')
90
+ }
91
+
92
+ console.log(`MP3 decode complete: ${totalBytes} bytes, ${updateCount} updates`)
93
+
94
+ await decoder.unload()
95
+
96
+ return {
97
+ success: true,
98
+ totalBytes,
99
+ updateCount
100
+ }
101
+ } catch (error) {
102
+ console.error('Error during testFFmpegDecodeMp3:', error)
103
+ throw error
104
+ }
105
+ }