[BCI] QVAC-17057 feat: add bci-whispercpp POC with batch transcription

packages/bci-whispercpp/.gitignore

@@ -0,0 +1,27 @@
+.vs/
+build/
+models/
+node_modules/
+.idea/
+prebuilds/
+vcpkg/cache/
+vcpkg/ports/
+!vcpkg/triplets/
+!vcpkg/toolchains/
+
+test/fixtures/*.bin
+test/unit/all.js
+test/integration/all.js
+
+package-lock.json
+.npmrc
+
+__pycache__/
+.pytest_cache/
+.vscode
+
+cpp-test-results.xml
+
+.clang-format
+.clang-tidy
+.valgrind.supp

packages/bci-whispercpp/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0]
+
+Initial POC release of `@qvac/bci-whispercpp`, a brain-computer-interface neural
+signal transcription addon powered by a BCI-patched fork of whisper.cpp.
+
+### Added
+
+- `BCIWhispercpp` client class (standalone, built on `createJobHandler` +
+  `exclusiveRunQueue` from `@qvac/infer-base`) with `load()`, `transcribe()`,
+  `transcribeFile()`, `unload()`, `destroy()`, `cancel()`, `getState()`.
+- Low-level `BCIInterface` (`./bci` subpath export) for users that need direct
+  control over the native addon lifecycle.
+- `./addonLogging` subpath exposing `setLogger` / `releaseLogger` for wiring a
+  native log handler.
+- C++ native addon (`NeuralProcessor`, `BCIModel`, `BCIConfig`) using the
+  `qvac-lib-inference-addon-cpp` framework, with BCI-specific preprocessing
+  (Gaussian smoothing, low-rank day projection, softsign non-linearity) and
+  mel-layout injection into a patched whisper.cpp encoder.
+- Integration tests for load/destroy, batch transcription, and a 5-sample
+  WER measurement (avg 6.0% on the reference fixtures).
+- GoogleTest C++ unit tests covering mel shape, gaussian smoothing, padded
+  frames, truncation handling, invalid-config rejection, and range validation.
+- `scripts/convert-model.py` to convert a BrainWhisperer checkpoint into the
+  GGML model + embedder binary pair consumed at runtime.
+- `scripts/download-models.sh` to fetch the reference model and test fixtures
+  from the `bci-test-assets-v0.1.0` GitHub release.
+
+### Known Limitations
+
+- Streaming transcription is not implemented in this release; see follow-up
+  work tracked under QVAC-17062.
+- Inference error codes live in the `26001-27000` range in the current
+  implementation.

packages/bci-whispercpp/CMakeLists.txt

@@ -0,0 +1,136 @@
+cmake_minimum_required(VERSION 3.25)
+
+option(BUILD_TESTING "Build tests" OFF)
+
+if(BUILD_TESTING)
+  list(APPEND VCPKG_MANIFEST_FEATURES "tests")
+endif()
+
+find_package(cmake-bare REQUIRED PATHS node_modules/cmake-bare)
+find_package(cmake-vcpkg REQUIRED PATHS node_modules/cmake-vcpkg)
+
+# Prepend the local overlay triplets on every platform and preserve any
+# externally-set value (matches the other qvac addons). Only the Linux
+# triplets actually differ from vcpkg's defaults today, but exposing the
+# directory uniformly avoids platform-conditional surprises.
+set(VCPKG_OVERLAY_TRIPLETS "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/triplets;${VCPKG_OVERLAY_TRIPLETS}")
+
+project(bci-whispercpp CXX C)
+
+if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+  add_compile_options(-stdlib=libc++)
+  add_link_options(-stdlib=libc++ -static-libstdc++)
+endif()
+
+find_path(VCPKG_INSTALLED_PATH share/qvac-lint-cpp/.clang-format REQUIRED)
+configure_file(${VCPKG_INSTALLED_PATH}/share/qvac-lint-cpp/.clang-format
+               ${CMAKE_CURRENT_SOURCE_DIR}/.clang-format COPYONLY)
+configure_file(${VCPKG_INSTALLED_PATH}/share/qvac-lint-cpp/.clang-tidy
+               ${CMAKE_CURRENT_SOURCE_DIR}/.clang-tidy COPYONLY)
+configure_file(${VCPKG_INSTALLED_PATH}/share/qvac-lint-cpp/.valgrind.supp
+               ${CMAKE_CURRENT_SOURCE_DIR}/.valgrind.supp COPYONLY)
+
+find_path(QVAC_LIB_INFERENCE_ADDON_CPP_INCLUDE_DIRS "qvac-lib-inference-addon-cpp/ModelInterfaces.hpp")
+find_package(whisper CONFIG REQUIRED)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+  add_definitions(-D_DEBUG)
+endif()
+
+if(WIN32)
+  add_definitions(-DNOMINMAX -DWIN32_LEAN_AND_MEAN -DNOGDI)
+endif()
+
+add_bare_module(bci-whispercpp EXPORTS)
+
+if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+  target_link_options(${bci-whispercpp}_module PRIVATE -Wl,--exclude-libs,ALL)
+endif()
+
+target_sources(
+  ${bci-whispercpp}
+  PRIVATE
+    ${PROJECT_SOURCE_DIR}/addon/src/js-interface/binding.cpp
+    ${PROJECT_SOURCE_DIR}/addon/src/js-interface/JSAdapter.cpp
+    ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/BCIConfig.cpp
+    ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/BCIModel.cpp
+    ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/NeuralProcessor.cpp
+)
+
+target_include_directories(
+  ${bci-whispercpp}
+  PRIVATE
+    ${PROJECT_SOURCE_DIR}/addon
+    ${PROJECT_SOURCE_DIR}/addon/src
+    ${CMAKE_BINARY_DIR}/_bare/node_modules/bare-headers/include
+    ${QVAC_LIB_INFERENCE_ADDON_CPP_INCLUDE_DIRS}
+)
+
+target_link_libraries(
+  ${bci-whispercpp}
+  PRIVATE
+    whisper::whisper
+)
+
+target_compile_definitions(${bci-whispercpp} PUBLIC JS_LOGGER)
+
+if(WIN32)
+  target_link_libraries(
+    ${bci-whispercpp}
+    PRIVATE
+      msvcrt.lib
+  )
+endif()
+
+if(BUILD_TESTING)
+  find_package(GTest REQUIRED)
+
+  set(CORE_SRCS
+      ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/BCIConfig.cpp
+      ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/BCIModel.cpp
+      ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/NeuralProcessor.cpp
+  )
+
+  add_library(bci-core STATIC ${CORE_SRCS})
+
+  target_link_libraries(bci-core PRIVATE
+      whisper::whisper
+  )
+
+  target_include_directories(bci-core PRIVATE
+      ${PROJECT_SOURCE_DIR}/addon/
+      ${PROJECT_SOURCE_DIR}/addon/src/
+      ${CMAKE_BINARY_DIR}/_bare/node_modules/bare-headers/include
+      ${QVAC_LIB_INFERENCE_ADDON_CPP_INCLUDE_DIRS}
+  )
+
+  add_executable(
+      test-bci-core
+      ${PROJECT_SOURCE_DIR}/addon/tests/test_core.cpp
+  )
+
+  target_include_directories(test-bci-core PRIVATE
+      ${PROJECT_SOURCE_DIR}/addon/
+      ${PROJECT_SOURCE_DIR}/addon/src/
+      ${PROJECT_SOURCE_DIR}/addon/src/model-interface
+      ${PROJECT_SOURCE_DIR}/addon/src/model-interface/bci/
+      ${PROJECT_SOURCE_DIR}/addon/tests/
+      ${CMAKE_BINARY_DIR}/_bare/node_modules/bare-headers/include
+      ${QVAC_LIB_INFERENCE_ADDON_CPP_INCLUDE_DIRS}
+  )
+
+  target_link_libraries(test-bci-core PRIVATE
+      bci-core
+      whisper::whisper
+      GTest::gtest_main
+      GTest::gmock
+  )
+
+  set_target_properties(test-bci-core PROPERTIES
+      RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/addon/tests
+  )
+endif()

packages/bci-whispercpp/LICENSE

@@ -0,0 +1,179 @@
+
+                                 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
+
+Copyright 2026 Tether Data, S.A. de C.V.