feat!: liberate VOICEVOX CORE

.github/workflows/build_and_deploy.yml

@@ -16,11 +16,6 @@ on:
         type: boolean
         required: false
         default: false
-      is_production:
-        description: "製品版をビルドする"
-        type: boolean
-        required: false
-        default: false
   release:
     types:
       - published
@@ -158,30 +153,15 @@ jobs:
 
   build_and_deploy:
     needs: config
-    environment: ${{ inputs.is_production && 'production' || '' }} # 製品版のenvironment
+    environment: ${{ inputs.code_signing && 'production' || '' }} # コード署名用のenvironment
     strategy:
       matrix:
         include: ${{ fromJson(needs.config.outputs.includes) }}
     runs-on: ${{ matrix.os }}
     env:
       ASSET_NAME: voicevox_core-${{ matrix.artifact_name }}-${{ needs.config.outputs.version }}
     steps:
-      - uses: actions/checkout@v4 # 製品版ではない場合
-        if: ${{ !inputs.is_production }}
-      - uses: actions/checkout@v4 # 製品版の場合
-        if: inputs.is_production
-        with:
-          fetch-depth: 0 # 全履歴取得
-          token: ${{ secrets.PRODUCTION_GITHUB_TOKEN }}
-      - name: Merge production branch
-        if: inputs.is_production
-        shell: bash
-        run: |
-          (
-            git remote add private ${{ secrets.PRODUCTION_REPOSITORY_URL }}
-            git fetch private refs/tags/${{ env.PRODUCTION_REPOSITORY_TAG }}
-            git -c user.name=dummy -c [email protected] merge FETCH_HEAD
-          ) > /dev/null 2>&1
+      - uses: actions/checkout@v4
       - name: Set up Python 3.8
         if: matrix.python_whl
         uses: actions/setup-python@v5
@@ -206,18 +186,6 @@ jobs:
         run: |
           echo "$ANDROID_NDK/toolchains/llvm/prebuilt/linux-x86_64/bin" >> "$GITHUB_PATH"
           echo "AR_${{ matrix.target }}=llvm-ar" >> "$GITHUB_ENV"
-      - name: Checkout VOICEVOX RESOURCE
-        if: inputs.is_production
-        uses: actions/checkout@v4
-        with:
-          repository: VOICEVOX/voicevox_resource
-          ref: ${{ env.VOICEVOX_RESOURCE_VERSION }}
-          path: download/resource
-      - name: Raplace resource
-        if: inputs.is_production
-        shell: bash
-        run:
-          mv -f download/resource/core/README.md ./README.md
       - name: Install cargo-binstall
         uses: taiki-e/install-action@cargo-binstall
       - name: Install cargo-edit
@@ -228,22 +196,14 @@ jobs:
           if ${{ matrix.python_whl }}; then cargo set-version "$VERSION" -p voicevox_core_python_api; fi
       - name: cache target
         uses: Swatinem/rust-cache@v2
-        if: ${{ !inputs.is_production }}
       - name: build voicevox_core_c_api
         shell: bash
         run: |
           case ${{ matrix.c_release_format }} in
             plain-cdylib) linking=load-onnxruntime ;;
             ios-xcframework) linking=link-onnxruntime ;;
           esac
-          function build() {
-            cargo build -p voicevox_core_c_api -vv --features "$linking" --target ${{ matrix.target }} --release
-          }
-          if ${{ !inputs.is_production }}; then
-            build
-          else
-            build > /dev/null 2>&1
-          fi
+          cargo build -p voicevox_core_c_api -vv --features "$linking" --target ${{ matrix.target }} --release
         env:
           RUSTFLAGS: -C panic=abort
       - name: build voicevox_core_python_api
@@ -254,26 +214,11 @@ jobs:
           pip install --upgrade poetry
           poetry config virtualenvs.create false
           (cd crates/voicevox_core_python_api && poetry install --with dev)
-          function build() {
-            maturin build --manifest-path ./crates/voicevox_core_python_api/Cargo.toml --target ${{ matrix.target }} --release
-          }
-          if ${{ !inputs.is_production }}; then
-            build
-          else
-            build > /dev/null 2>&1
-          fi
+          maturin build --manifest-path ./crates/voicevox_core_python_api/Cargo.toml --target ${{ matrix.target }} --release
           echo "whl=$(find ./target/wheels -type f)" >> "$GITHUB_OUTPUT"
       - name: build voicevox_core_java_api
         if: contains(matrix.target, 'android')
-        run: |
-          function build() {
-            cargo build -p voicevox_core_java_api -vv --target ${{ matrix.target }} --release
-          }
-          if ${{ !inputs.is_production }}; then
-            build
-          else
-            build > /dev/null 2>&1
-          fi
+        run: cargo build -p voicevox_core_java_api -vv --target ${{ matrix.target }} --release
       - name: Organize artifact
         run: |
           mkdir -p "artifact/${{ env.ASSET_NAME }}"
@@ -377,25 +322,13 @@ jobs:
             ${{ env.ASSET_NAME }}.zip
           target_commitish: ${{ github.sha }}
 
-  deploy_model:
+  deploy_sample_model:
     runs-on: ubuntu-latest
     needs: config
     env:
-      ASSET_NAME: model-${{ needs.config.outputs.version }}
+      ASSET_NAME: sample-model-${{ needs.config.outputs.version }}
     steps:
       - uses: actions/checkout@v4
-      - name: Checkout VOICEVOX FAT RESOURCE
-        if: inputs.is_production
-        uses: actions/checkout@v4
-        with:
-          repository: VOICEVOX/voicevox_fat_resource
-          ref: ${{ env.VOICEVOX_FAT_RESOURCE_VERSION }}
-          path: download/fat_resource
-      - name: Raplace resource
-        if: inputs.is_production
-        shell: bash
-        run:
-          rm -r ./model; mv download/fat_resource/core/model ./model
       - name: Create artifact
         run: |
           mkdir "artifact"

.github/workflows/build_and_deploy_downloader.yml

@@ -11,11 +11,6 @@ on:
         type: boolean
         required: false
         default: false
-      is_production:
-        description: "製品版をビルドする"
-        type: boolean
-        required: false
-        default: false
   release:
     types:
       - published
@@ -42,7 +37,7 @@ defaults:
 
 jobs:
   deploy_and_deploy_downloader:
-    environment: ${{ inputs.is_production && 'production' || '' }} # コード署名用のenvironment
+    environment: ${{ inputs.code_signing && 'production' || '' }} # コード署名用のenvironment
     strategy:
       matrix:
         include:

.github/workflows/test.yml

@@ -284,17 +284,12 @@ jobs:
       - run: cargo build -p test_util -vv # build scriptにより/crates/test_util/data/の生成
       - run: poetry run maturin build --locked
       - run: poetry run maturin develop --locked
-      - name: 必要なDLLをコピーしてpytestを実行
-        run: |
-          cp -v ../../target/debug/onnxruntime.dll . || true
-          cp -v ../../target/debug/libonnxruntime.so.* . || true
-          cp -v ../../target/debug/libonnxruntime.*.dylib . || true
-
-          poetry run pytest
+      - name: pytestを実行
+        run: poetry run pytest
       - name: Exampleを実行
         run: |
           for file in ../../example/python/run{,-asyncio}.py; do
-            poetry run python "$file" ../test_util/data/model/sample.vvm --dict-dir ../test_util/data/open_jtalk_dic_utf_8-1.11
+            poetry run python "$file" ../test_util/data/model/sample.vvm --dict-dir ../test_util/data/open_jtalk_dic_utf_8-1.11 --onnxruntime ../test_util/data/lib/*onnxruntime*
           done
   build-and-test-java-api:
     strategy:

Cargo.toml

@@ -91,8 +91,8 @@ windows = "0.43.0"
 zip = "0.6.3"
 
 [workspace.dependencies.voicevox-ort]
-git = "https://github.com/VOICEVOX/ort.git"
-rev = "8627833456a69e7841ae2a29fd184752df8de8d9"
+git = "https://github.com/qryxip/ort.git"
+rev = "5b5b22a135bd5257b31df9156d1cb6a51fbf92f0"
 
 [workspace.dependencies.open_jtalk]
 git = "https://github.com/VOICEVOX/open_jtalk-rs.git"

crates/voicevox_core/src/devices.rs

@@ -57,12 +57,7 @@ fn test_gpu(
 /// use voicevox_core::{tokio::Onnxruntime, SupportedDevices};
 ///
 /// # voicevox_core::blocking::Onnxruntime::load_once()
-/// #     .filename(if cfg!(windows) {
-/// #         // Windows\System32\onnxruntime.dllを回避
-/// #         test_util::ONNXRUNTIME_DYLIB_PATH
-/// #     } else {
-/// #         voicevox_core::blocking::Onnxruntime::LIB_VERSIONED_FILENAME
-/// #     })
+/// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
 /// #     .exec()?;
 /// #
 /// let onnxruntime = Onnxruntime::get().unwrap();

crates/voicevox_core/src/infer.rs

@@ -1,5 +1,4 @@
 pub(crate) mod domains;
-mod model_file;
 pub(crate) mod runtimes;
 pub(crate) mod session_set;
 
@@ -13,6 +12,7 @@ use thiserror::Error;
 
 use crate::{
     devices::{DeviceSpec, GpuSpec},
+    voice_model::ModelBytes,
     StyleType, SupportedDevices,
 };
 
@@ -33,7 +33,7 @@ pub(crate) trait InferenceRuntime: 'static {
     #[allow(clippy::type_complexity)]
     fn new_session(
         &self,
-        model: impl FnOnce() -> std::result::Result<Vec<u8>, DecryptModelError>,
+        model: &ModelBytes,
         options: InferenceSessionOptions,
     ) -> anyhow::Result<(
         Self::Session,
@@ -204,7 +204,3 @@ pub(crate) enum ExtractError {
     #[error(transparent)]
     Shape(#[from] ShapeError),
 }
-
-#[derive(Error, Debug)]
-#[error("不正なモデルファイルです")]
-pub(crate) struct DecryptModelError;

crates/voicevox_core/src/infer/runtimes/onnxruntime.rs

@@ -11,11 +11,12 @@ use ort::{
 use crate::{
     devices::{DeviceSpec, GpuSpec, SupportedDevices},
     error::ErrorRepr,
+    voice_model::ModelBytes,
 };
 
 use super::super::{
-    DecryptModelError, InferenceRuntime, InferenceSessionOptions, InputScalarKind,
-    OutputScalarKind, OutputTensor, ParamInfo, PushInputTensor,
+    InferenceRuntime, InferenceSessionOptions, InputScalarKind, OutputScalarKind, OutputTensor,
+    ParamInfo, PushInputTensor,
 };
 
 // TODO: `trait AsyncRuntime`みたいなものを作って抽象化しながら同期版と非同期版に別個の役割を
@@ -62,7 +63,7 @@ impl InferenceRuntime for self::blocking::Onnxruntime {
 
     fn new_session(
         &self,
-        model: impl FnOnce() -> std::result::Result<Vec<u8>, DecryptModelError>,
+        model: &ModelBytes,
         options: InferenceSessionOptions,
     ) -> anyhow::Result<(
         Self::Session,
@@ -86,8 +87,10 @@ impl InferenceRuntime for self::blocking::Onnxruntime {
             }
         };
 
-        let model = model()?;
-        let sess = builder.commit_from_memory(&{ model })?;
+        let sess = match model {
+            ModelBytes::Onnx(onnx) => builder.commit_from_memory(onnx),
+            ModelBytes::VvBin(bin) => builder.commit_from_vv_bin(bin),
+        }?;
 
         let input_param_infos = sess
             .inputs
@@ -261,12 +264,10 @@ pub(crate) mod blocking {
     /// # use voicevox_core as another_lib;
     /// #
     /// # fn main() -> anyhow::Result<()> {
-    /// # if cfg!(windows) {
-    /// #     // Windows\System32\onnxruntime.dllを回避
-    /// #     voicevox_core::blocking::Onnxruntime::load_once()
-    /// #         .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-    /// #         .exec()?;
-    /// # }
+    /// # voicevox_core::blocking::Onnxruntime::load_once()
+    /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
+    /// #     .exec()?;
+    /// #
     /// let ort1 = voicevox_core::blocking::Onnxruntime::load_once().exec()?;
     /// let ort2 = another_lib::tokio::Onnxruntime::get().expect("`ort1`と同一のはず");
     /// assert_eq!(ptr_addr(ort1), ptr_addr(ort2));
@@ -289,7 +290,7 @@ pub(crate) mod blocking {
         /// ONNX Runtimeのライブラリ名。
         #[cfg(feature = "load-onnxruntime")]
         #[cfg_attr(docsrs, doc(cfg(feature = "load-onnxruntime")))]
-        pub const LIB_NAME: &'static str = "onnxruntime";
+        pub const LIB_NAME: &'static str = "voicevox_onnxruntime";
 
         /// 推奨されるONNX Runtimeのバージョン。
         #[cfg(feature = "load-onnxruntime")]
@@ -450,12 +451,10 @@ pub(crate) mod tokio {
     /// #
     /// # #[tokio::main]
     /// # async fn main() -> anyhow::Result<()> {
-    /// # if cfg!(windows) {
-    /// #     // Windows\System32\onnxruntime.dllを回避
-    /// #     voicevox_core::blocking::Onnxruntime::load_once()
-    /// #         .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-    /// #         .exec()?;
-    /// # }
+    /// # voicevox_core::blocking::Onnxruntime::load_once()
+    /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
+    /// #     .exec()?;
+    /// #
     /// let ort1 = voicevox_core::tokio::Onnxruntime::load_once().exec().await?;
     /// let ort2 = another_lib::blocking::Onnxruntime::get().expect("`ort1`と同一のはず");
     /// assert_eq!(ptr_addr(ort1), ptr_addr(ort2));
@@ -477,7 +476,7 @@ pub(crate) mod tokio {
         #[cfg(feature = "load-onnxruntime")]
         #[cfg_attr(docsrs, doc(cfg(feature = "load-onnxruntime")))]
         // ブロッキング版と等しいことはテストで担保
-        pub const LIB_NAME: &'static str = "onnxruntime";
+        pub const LIB_NAME: &'static str = "voicevox_onnxruntime";
 
         /// 推奨されるONNX Runtimeのバージョン。
         #[cfg(feature = "load-onnxruntime")]

crates/voicevox_core/src/infer/session_set.rs

@@ -4,10 +4,10 @@ use anyhow::bail;
 use enum_map::{Enum as _, EnumMap};
 use itertools::Itertools as _;
 
-use crate::error::ErrorRepr;
+use crate::{error::ErrorRepr, voice_model::ModelBytes};
 
 use super::{
-    model_file, InferenceDomain, InferenceInputSignature, InferenceOperation, InferenceRuntime,
+    InferenceDomain, InferenceInputSignature, InferenceOperation, InferenceRuntime,
     InferenceSessionOptions, InferenceSignature, ParamInfo,
 };
 
@@ -18,7 +18,7 @@ pub(crate) struct InferenceSessionSet<R: InferenceRuntime, D: InferenceDomain>(
 impl<R: InferenceRuntime, D: InferenceDomain> InferenceSessionSet<R, D> {
     pub(crate) fn new(
         rt: &R,
-        model_bytes: &EnumMap<D::Operation, Vec<u8>>,
+        model_bytes: &EnumMap<D::Operation, ModelBytes>,
         options: &EnumMap<D::Operation, InferenceSessionOptions>,
     ) -> anyhow::Result<Self> {
         let mut sessions = model_bytes
@@ -28,7 +28,7 @@ impl<R: InferenceRuntime, D: InferenceDomain> InferenceSessionSet<R, D> {
                     <D::Operation as InferenceOperation>::PARAM_INFOS[op];
 
                 let (sess, actual_input_param_infos, actual_output_param_infos) =
-                    rt.new_session(|| model_file::decrypt(model_bytes), options[op])?;
+                    rt.new_session(model_bytes, options[op])?;
 
                 check_param_infos(expected_input_param_infos, &actual_input_param_infos)?;
                 check_param_infos(expected_output_param_infos, &actual_output_param_infos)?;

crates/voicevox_core/src/lib.rs

@@ -10,7 +10,7 @@
 //!     開きます。[CUDA]と[DirectML]が利用できます。
 //! - **`link-onnxruntime`**: ONNX Runtimeをロード時動的リンクします。iOSのような`dlopen`の利用が
 //!     困難な環境でのみこちらを利用するべきです。_Note_:
-//!     [動的リンク対象のライブラリ名]は`onnxruntime`で固定です。変更
+//!     [動的リンク対象のライブラリ名]は`voicevox_onnxruntime`で固定です。変更
 //!     は`patchelf(1)`や`install_name_tool(1)`で行ってください。また、[ONNX RuntimeのGPU機能]を使う
 //!     ことはできません。
 //!