@qvac/decoder-audio 0.1.0

package/utils/createStreamAccumulator.js

@@ -0,0 +1,64 @@
+const { QvacErrorDecoderAudio, ERR_CODES } = require('./error')
+
+const TARGET_SECONDS = 1 // Desired chunk size in seconds
+const SAMPLE_RATE = 16000 // PCM audio sample rate
+const BYTES_PER_SAMPLE = 4 // PCM S16LE (16-bit)
+const TARGET_BUFFER_SIZE = TARGET_SECONDS * SAMPLE_RATE * BYTES_PER_SAMPLE
+
+/**
+ * Creates a stream accumulator that processes incoming audio data in chunks of a specified size.
+ * The accumulator maintains a buffer of incoming data and emits chunks when the target size is reached.
+ *
+ * @param {Object} options - Configuration options for the stream accumulator
+ * @param {Function} options.onChunk - Callback function called when a chunk of data is ready to be processed
+ * @param {Function} options.onFinish - Callback function called when all data has been processed
+ * @param {number} [options.targetBufferSize=TARGET_BUFFER_SIZE] - Target size for each chunk in bytes
+ * @returns {Object} An object with methods to process data and finish the stream
+ * @throws {Error} If the target buffer size is smaller than the minimum required size
+ */
+function createStreamAccumulator ({
+  onChunk,
+  onFinish,
+  targetBufferSize = TARGET_BUFFER_SIZE
+}) {
+  if (targetBufferSize < TARGET_BUFFER_SIZE) {
+    throw new QvacErrorDecoderAudio(ERR_CODES.BUFFER_SIZE_TOO_SMALL)
+  }
+
+  let accumulator = Buffer.alloc(0)
+
+  return {
+    /**
+     * Process incoming data and emit chunks when target size is reached.
+     * Accumulates incoming data until it reaches the target buffer size,
+     * then emits a chunk and continues with the remaining data.
+     *
+     * @param {Buffer} data - The incoming data to process
+     * @returns {Promise<void>} A promise that resolves when the chunk is processed
+     */
+    async processData (data) {
+      accumulator = Buffer.concat([accumulator, data])
+
+      while (accumulator.length >= targetBufferSize) {
+        const chunk = accumulator.subarray(0, targetBufferSize)
+        await onChunk(new Uint8Array(chunk))
+        accumulator = accumulator.subarray(targetBufferSize)
+      }
+    },
+
+    /**
+     * Finish processing and emit any remaining data.
+     * Processes any remaining data in the accumulator and calls the finish callback.
+     *
+     * @returns {Promise<void>} A promise that resolves when all remaining data is processed
+     */
+    async finish () {
+      if (accumulator.length > 0) {
+        await onChunk(new Uint8Array(accumulator))
+      }
+      await onFinish()
+    }
+  }
+}
+
+module.exports = createStreamAccumulator

package/utils/error.js

@@ -0,0 +1,61 @@
+'use strict'
+
+const { QvacErrorBase, addCodes } = require('@qvac/error')
+const { name, version } = require('../package.json')
+
+class QvacErrorDecoderAudio extends QvacErrorBase { }
+
+// This library has error code range from 11,001 to 12,000
+const ERR_CODES = Object.freeze({
+  FAILED_TO_LOAD_WEIGHTS: 11001,
+  FAILED_TO_ACTIVATE: 11002,
+  FAILED_TO_PAUSE: 11003,
+  FAILED_TO_CANCEL: 11004,
+  FAILED_TO_APPEND: 11005,
+  FAILED_TO_GET_STATUS: 11006,
+  FAILED_TO_DESTROY: 11007,
+  BUFFER_SIZE_TOO_SMALL: 11008
+})
+
+addCodes({
+  [ERR_CODES.FAILED_TO_LOAD_WEIGHTS]: {
+    name: 'FAILED_TO_LOAD_WEIGHTS',
+    message: (message) => `Failed to load weights, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_ACTIVATE]: {
+    name: 'FAILED_TO_ACTIVATE',
+    message: (message) => `Failed to activate model, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_PAUSE]: {
+    name: 'FAILED_TO_PAUSE',
+    message: (message) => `Failed to pause inference, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_CANCEL]: {
+    name: 'FAILED_TO_CANCEL',
+    message: (message) => `Failed to cancel inference, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_APPEND]: {
+    name: 'FAILED_TO_APPEND',
+    message: (message) => `Failed to append data to processing queue, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_GET_STATUS]: {
+    name: 'FAILED_TO_GET_STATUS',
+    message: (message) => `Failed to get addon status, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_DESTROY]: {
+    name: 'FAILED_TO_DESTROY',
+    message: (message) => `Failed to destroy instance, error: ${message}`
+  },
+  [ERR_CODES.BUFFER_SIZE_TOO_SMALL]: {
+    name: 'BUFFER_SIZE_TOO_SMALL',
+    message: 'Target buffer size is too small'
+  }
+}, {
+  name,
+  version
+})
+
+module.exports = {
+  ERR_CODES,
+  QvacErrorDecoderAudio
+}