@qvac/decoder-audio 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,257 @@
+# qvac-lib-decoder-audio
+
+This decoder addon leverages the GStreamer pipeline for efficient, asynchronous audio decoding. It simplifies processing of input audio, particularly as a preprocessing step for other addons.
+
+## Table of Contents
+
+- [Installation](#installation)  
+- [Usage](#usage)  
+  - [1. Creating the Decoder Instance](#1-creating-the-decoder-instance)  
+  - [2. Loading the Decoder](#2-loading-the-decoder)  
+  - [3. Decoding Audio](#3-decoding-audio)  
+  - [4. Handling Response Updates](#4-handling-response-updates)  
+  - [5. Unloading the Decoder](#5-unloading-the-decoder)
+- [Quickstart Example](#quickstart-example)  
+- [Testing](#testing)  
+  - [Running Unit Tests](#running-unit-tests)  
+  - [Test Coverage](#test-coverage)  
+- [Glossary](#glossary)  
+- [Resources](#resources)  
+- [License](#license)  
+
+## Installation
+
+### Prerequisites
+
+Ensure that the [`Bare`](#glossary) Runtime is installed globally on your system. If it's not already installed, you can add it using:
+
+```bash
+npm install -g bare@latest
+```
+
+Before proceeding with the installation, please generate a **classic GitHub Personal Access Token (PAT)** with the `read:packages` scope. Once generated, add the token to your environment variables using the name `NPM_TOKEN`.
+
+```bash
+export NPM_TOKEN=your_personal_access_token
+```
+
+Next, create a `.npmrc` file in the root of your project with the following content:
+
+```ini
+@tetherto:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${NPM_TOKEN}
+```
+
+This configuration ensures secure access to GitHub Packages when installing scoped packages.
+
+### Installing the Package
+
+Install the latest version of the decoder addon with the following command:
+
+```bash
+npm install @tetherto/qvac-lib-decoder-audio@latest
+```
+
+## Usage
+
+This library provides a simple workflow for decoding audio streams.
+
+### 1. Creating the Decoder Instance
+
+To get started, import the decoder addon and create an instance:
+
+```javascript
+const GSTDecoder = require('@tetherto/qvac-lib-decoder-audio')
+
+const decoder = new GSTDecoder({
+  config: {
+    audioFormat: 'encoded', // 'encoded' | 's16le' | 'f32le'; default is 'encoded'
+    sampleRate: 16000 // in Hz; default is 16000
+  }
+})
+```
+
+The `config` object accepts the following parameters:
+
+* **`audioFormat`**: Specifies the format of the input audio. Supported values:
+
+  * `'encoded'`: For encoded audio input. Currently supported formats are OGG, WAV, MP3 and M4A.
+  * `'s16le'`: Signed 16-bit little-endian PCM — a widely used raw format.
+  * `'f32le'`: 32-bit floating-point little-endian PCM — ideal for high-precision audio processing.
+
+  Default: `'encoded'`.
+
+* **`sampleRate`**: Sample rate of the input audio in Hertz (Hz).
+  Default: `16000` (16 kHz), commonly used for speech processing.
+
+### 2. Loading the Decoder
+
+Initializes and activates the decoder addon with the provided or default configuration. This method must be called before decoding any audio input.
+
+```javascript
+try {
+  await decoder.load()
+} catch (err) {
+  console.error('Failed to load decoder:', err)
+}
+```
+
+### 3. Decoding Audio
+
+In order to decode audio, we must create an audio stream and pass it to the `run()` method. This method returns a [`QVACResponse`](#glossary) object.
+
+```javascript
+const fs = require('bare-fs')
+const audioFilePath = './sample.ogg'
+const audioStream = fs.createReadStream(audioFilePath)
+
+const response = await decoder.run(audioStream)
+```
+
+### 4. Handling Response Updates
+
+The response supports real-time updates via `.onUpdate()`. Each update delivers a chunk of decoded audio data, which can be processed or saved as needed:
+
+```javascript
+await response
+  .onUpdate(output => {
+    // `output.outputArray` is a Uint8Array
+    console.log('Decoded chunk:', new Uint8Array(output.outputArray))
+  })
+  .await() // wait for the stream to finish
+```
+
+You can append or otherwise process these frames as needed.
+
+### 5. Unloading the decoder
+
+Always unload the decoder when done to free memory:
+
+```javascript
+try {
+  await decoder.unload()
+} catch (err) {
+  console.error('Failed to unload decoder:', err)
+}
+```
+
+## Quickstart Example
+
+The following example demonstrates how to use the decoder addon to decode a sample OGG file into a raw audio file. Follow these steps, to run the example:
+
+### 1. Create a new project:
+   
+```bash
+mkdir decoder-example
+cd decoder-example
+npm init -y
+```
+
+### 2. Install the required dependencies:
+   
+```bash
+npm install bare-fs @tetherto/qvac-lib-decoder-audio
+```
+
+### 3. Create a file named `example.js` and paste the following code:
+
+```javascript
+'use strict'
+
+const fs = require('bare-fs')
+const GSTDecoder = require('@tetherto/qvac-lib-decoder-audio')
+
+const audioFilePath = './path/to/audio/file.ogg'
+const outputFilePath = './path/to/output/file.raw'
+
+async function main () {
+  // 1. Create a decoder instance
+  const decoder = new GSTDecoder({
+    config: {
+      audioFormat: 'encoded' // Use 'encoded' for OGG input
+    }
+  })
+
+  try {
+    // 2. Load the decoder
+    await decoder.load()
+
+    // 3. Create audio stream and pass it to the decoder
+    const audioStream = fs.createReadStream(audioFilePath)
+    const response = await decoder.run(audioStream)
+
+    const decodedFileBuffer = []
+
+    // 4. Handle response updates
+    await response
+      .onUpdate(output => {
+        const bytes = new Uint8Array(output.outputArray)
+
+        // Collect decoded bytes
+        decodedFileBuffer.push(bytes)
+      })
+      .onFinish(() => {
+        // Write the decoded bytes to a file on finish
+        fs.writeFileSync(outputFilePath, Buffer.concat(decodedFileBuffer))
+        console.log('Decoded file saved to', outputFilePath)
+      })
+      .await()
+  } finally {
+    // 5. Unload the decoder
+    await decoder.unload()
+  }
+}
+
+main().catch(console.error)
+```
+
+### 4. Run the example:
+
+Make sure to set the correct `audioFilePath` and `outputFilePath` before running the example with the following command:
+
+```bash
+bare example.js
+```
+
+## Testing
+
+### Running Unit Tests
+
+To run unit tests (using the 'brittle-bare' runner):
+
+```sh
+npm run test:unit
+```
+
+### Test Coverage
+
+To generate a unit test coverage report (using 'brittle' and 'istanbul'):
+
+```sh
+npm run coverage:unit
+```
+
+Or simply:
+
+```sh
+npm run coverage
+```
+
+Coverage reports are generated in the 'coverage/unit/' directory. Open the corresponding `index.html` file in your browser to view the detailed report.
+
+## Glossary
+
+* [**Bare** ](https://bare.pears.com/) – A lightweight, modular JavaScript runtime for desktop and mobile.
+* [**QVACResponse**](https://github.com/tetherto/qvac-lib-response) – the response object used by QVAC API
+* **QVAC** – Our decentralized AI SDK for building runtime-portable inference apps.
+
+## Resources
+
+* GitHub Repo: [tetherto/qvac-lib-decoder-audio](https://github.com/tetherto/qvac-lib-decoder-audio)
+* GStreamer: [gstreamer.freedesktop.org](https://gstreamer.freedesktop.org/)
+
+## License
+
+This project is licensed under the Apache-2.0 License – see the [LICENSE](LICENSE) file for details.
+
+*For questions or issues, please open an issue on the GitHub repository.*

package/binding.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require.addon()

package/gstreamer.js

@@ -0,0 +1,131 @@
+'use strict'
+
+const binding = require('./binding')
+const { QvacErrorDecoderAudio, ERR_CODES } = require('./utils/error')
+
+/**
+ * An interface between Bare addon in C++ and JS runtime.
+ */
+class GSTDecoderInterface {
+  /**
+   *
+   * @param {Object} configurationParams - all the required configuration for inference setup
+   * @param {Function} outputCb - to be called on any inference event ( started, new output, error, etc )
+   * @param {Function} transitionCb - to be called on addon state changes (LISTENING, IDLE, STOPPED, etc )
+   */
+  constructor (configurationParams, outputCb, transitionCb = null) {
+    this._handle = binding.createInstance(this, configurationParams, outputCb, transitionCb)
+  }
+
+  /**
+   *
+   * @param {Object} weightsData
+   * @param {String} weightsData.filename
+   * @param {Uint8Array} weightsData.contents
+   * @param {Boolean} weightsData.completed
+   */
+  async loadWeights (weightsData) {
+    try {
+      binding.loadWeights(this._handle, weightsData)
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_LOAD_WEIGHTS,
+        err.message
+      )
+    }
+  }
+
+  /**
+   * Moves addon to the LISTENING state after all the initialization is done
+   */
+  async activate () {
+    try {
+      binding.activate(this._handle)
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_ACTIVATE,
+        err.message
+      )
+    }
+  }
+
+  /**
+   * Pauses current inference process
+   */
+  async pause () {
+    try {
+      binding.pause(this._handle)
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_PAUSE,
+        err.message
+      )
+    }
+  }
+
+  /**
+   * Cancel a inference process by jobId, if no jobId is provided it cancel the whole queue
+   */
+  async cancel (jobId) {
+    try {
+      binding.cancel(this._handle, jobId)
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_CANCEL,
+        err.message
+      )
+    }
+  }
+
+  /**
+   * Adds new input to the processing queue
+   * @param {Object} data
+   * @param {String} data.type
+   * @param {String} data.input
+   * @returns {Number} - job ID
+   */
+  async append (data) {
+    try {
+      return binding.append(this._handle, data)
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_APPEND,
+        err.message
+      )
+    }
+  }
+
+  /**
+   * Addon process status
+   * @returns {String}
+   */
+  async status () {
+    try {
+      return binding.status(this._handle)
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_GET_STATUS,
+        err.message
+      )
+    }
+  }
+
+  /**
+   * Stops addon process and clears resources (including memory).
+   */
+  async destroy () {
+    try {
+      binding.destroyInstance(this._handle)
+      this._handle = null
+    } catch (err) {
+      throw new QvacErrorDecoderAudio(
+        ERR_CODES.FAILED_TO_DESTROY,
+        err.message
+      )
+    }
+  }
+}
+
+module.exports = {
+  GSTDecoderInterface
+}

package/index.d.ts

@@ -0,0 +1,57 @@
+import BaseInference = require('@qvac/infer-base/WeightsProvider/BaseInference')
+import QvacResponse from '@qvac/response'
+
+type AppendInput = {
+  type: 'audio' | 'end of job'
+  input?: ArrayBuffer
+  priority?: number
+}
+
+interface DecoderConfig {
+  audioFormat?: string
+  sampleRate?: number
+  [key: string]: any
+}
+
+interface AudioStream {
+  [Symbol.asyncIterator](): AsyncIterator<{ buffer: Buffer }>
+}
+
+interface Addon {
+  activate(): Promise<void>
+  append(input: AppendInput): Promise<number>
+  cancel(jobId: number): Promise<void>
+  pause(): Promise<void>
+  continue(): Promise<void>
+  status(): Promise<any>
+  loadWeights?(params: {
+    filename: string
+    contents?: Buffer
+    completed: boolean
+  }): Promise<void>
+}
+
+interface GSTDecoderConstructorParams {
+  config: DecoderConfig
+  [key: string]: any
+}
+
+/**
+ * GSTDecoder client implementation for the Whisper transcription model
+ */
+declare class GSTDecoder extends BaseInference {
+  /**
+   * Creates an instance of GSTDecoder.
+   * @constructor
+   * @param {Object} config - environment-specific inference setup configuration
+   */
+  constructor({ config, ...args }: GSTDecoderConstructorParams)
+  private config: DecoderConfig
+  private addon: Addon
+  load(): Promise<void>
+  createAddon(config: DecoderConfig): Addon
+  protected _runInternal(audioStream: AudioStream): Promise<QvacResponse>
+  getStatus(): Promise<any>
+}
+
+export = GSTDecoder