Node.js向けのFFIを実装

Cargo.toml

@@ -50,6 +50,8 @@ log = "0.4.17"
 nanoid = "0.4.0"
 ndarray = "0.15.6"
 ndarray-stats = "0.5.1"
+napi = { version = "2.12.2", default-features = false }
+napi-derive = "2.12.2"
 octocrab = { version = "0.19.0", default-features = false }
 once_cell = "1.18.0"
 ouroboros = "0.18.0"

crates/voicevox_core_node_api/.cargo/config.toml

@@ -0,0 +1,5 @@
+[target.aarch64-unknown-linux-musl]
+linker = "aarch64-linux-musl-gcc"
+rustflags = ["-C", "target-feature=-crt-static"]
+[target.x86_64-pc-windows-msvc]
+rustflags = ["-C", "target-feature=+crt-static"]

crates/voicevox_core_node_api/.gitignore

@@ -0,0 +1,203 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# End of https://www.toptal.com/developers/gitignore/api/node
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two 
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos
+
+# Created by https://www.toptal.com/developers/gitignore/api/windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=windows
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/windows
+
+#Added by cargo
+
+/target
+Cargo.lock
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+*.node
+
+# Manually added
+
+/index.d.ts
+/index.js
+/docs/

crates/voicevox_core_node_api/.npmignore

@@ -0,0 +1,13 @@
+target
+Cargo.lock
+.cargo
+.github
+npm
+.eslintrc
+.prettierignore
+rustfmt.toml
+yarn.lock
+*.node
+.yarn
+__test__
+renovate.json

crates/voicevox_core_node_api/.prettierignore

@@ -0,0 +1,3 @@
+/.yarn/
+index.js
+*.md

crates/voicevox_core_node_api/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

crates/voicevox_core_node_api/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "voicevox_core_node_api"
+version = "0.0.0"
+edition.workspace = true
+publish.workspace = true
+
+[lib]
+crate-type = ["cdylib"]
+
+[features]
+cuda = ["voicevox_core/cuda"]
+directml = ["voicevox_core/directml"]
+
+[dependencies]
+napi = { version = "2.16.0", features = ["napi4", "serde-json", "tokio_rt"] }
+napi-derive = "2.16.0"
+voicevox_core.workspace = true
+serde.workspace = true
+serde_json.workspace = true
+uuid.workspace = true
+
+[build-dependencies]
+napi-build = "2"

crates/voicevox_core_node_api/README.md

@@ -0,0 +1,56 @@
+# voicevox_core_node_api
+
+VOICEVOX CORE の Node.js バインディングです。
+
+## 環境構築
+
+以下の環境が必要です。
+
+- Rustup
+- Node > 10.0.0
+
+## ファイル構成
+
+```console
+.
+├── build.rs
+├── Cargo.toml           : Rust プロジェクトとしてのマニフェストファイルです。
+├── exports              : blocking および promises 名前空間下のクラスを再エクスポートするためのモジュールです。
+│   ├── blocking.d.ts
+│   ├── blocking.js
+│   ├── promises.d.ts
+│   └── promises.js
+├── package.json
+├── README.md
+├── src                  : Rust で書かれたソースファイルです。
+│   └── ...
+├── __test__             : TypeScript と AVA によるテストのソースファイルです。
+│   └── ...
+├── tsconfig.json
+└── yarn.lock
+```
+
+## ビルド
+
+npm で依存ライブラリをダウンロードし、`build` タスクによって `index.d.ts`, `index.js` および `node` 拡張子のネイティブモジュールを生成します。
+
+```console
+❯ npm install
+❯ npm run build
+```
+
+## テスト
+
+`npm test` でテストを行うことができます。
+
+```console
+❯ npm test
+```
+
+## ドキュメント
+
+`npm run docs` でドキュメントを生成できます。
+
+```console
+❯ npm run docs
+```

crates/voicevox_core_node_api/__test__/_testUtil.ts

@@ -0,0 +1,37 @@
+import path from "path";
+import { AccentPhrase, Mora } from "voicevox_core";
+
+export const openJtalkDicDir = path.join(
+  __dirname,
+  "..",
+  "..",
+  "test_util",
+  "data",
+  "open_jtalk_dic_utf_8-1.11",
+);
+export const modelFile = path.join(
+  __dirname,
+  "..",
+  "..",
+  "..",
+  "model",
+  "sample.vvm",
+);
+
+export function checkAllMoras(
+  accentPhrases: AccentPhrase[],
+  otherAccentPhrases: AccentPhrase[],
+  checker: (mora: Mora, otherMora: Mora) => boolean,
+): boolean {
+  for (let i = 0; i < accentPhrases.length; i++) {
+    const accentPhrase = accentPhrases[i];
+    for (let j = 0; j < accentPhrase.moras.length; j++) {
+      const mora = accentPhrase.moras[j];
+      const otherMora = otherAccentPhrases[i].moras[j];
+      if (!checker(mora, otherMora)) {
+        return false;
+      }
+    }
+  }
+  return true;
+}