refactor(rust): モジュールを再編する (#1065)

- 「コアとしての領分」を`crate::core`、「エンジンとしての領分」を
  `crate::engine`とする
    - `devices`, `infer`, `manifest`, `metas`, `status`,
      `voice_model`は`crate::core`下に置く
    - `text_analyzer`, `user_dict`は`crate::engine`下に置く
- Rust 2015スタイルのmod.rsをやめる

Author: qryxip

crates/voicevox_core/src/__internal.rs

@@ -1,13 +1,15 @@
 pub mod doctest_fixtures;
 pub mod interop;
 
+use crate::engine::user_dict;
+
 // VOICEVOX CORE内のラッパー向けの実装
 // FIXME: 要議論: https://github.com/VOICEVOX/voicevox_core/issues/595
 
 pub fn to_zenkaku(surface: &str) -> String {
-    crate::user_dict::to_zenkaku(surface)
+    user_dict::to_zenkaku(surface)
 }
 
 pub fn validate_pronunciation(pronunciation: &str) -> crate::Result<()> {
-    crate::user_dict::validate_pronunciation(pronunciation).map_err(Into::into)
+    user_dict::validate_pronunciation(pronunciation).map_err(Into::into)
 }

crates/voicevox_core/src/__internal/interop.rs

@@ -2,11 +2,11 @@ pub mod raii;
 
 pub use crate::{
     convert::ToJsonValue,
-    metas::merge as merge_metas,
+    core::metas::merge as merge_metas,
+    engine::user_dict::{DEFAULT_PRIORITY, DEFAULT_WORD_TYPE},
     synthesizer::{
         blocking::PerformInference, BlockingTextAnalyzerExt, NonblockingTextAnalyzerExt,
         DEFAULT_CPU_NUM_THREADS, DEFAULT_ENABLE_INTERROGATIVE_UPSPEAK,
         DEFAULT_HEAVY_INFERENCE_CANCELLABLE, MARGIN,
     },
-    user_dict::{DEFAULT_PRIORITY, DEFAULT_WORD_TYPE},
 };

crates/voicevox_core/src/blocking.rs

@@ -1,9 +1,14 @@
 //! ブロッキング版API。
 
 pub use crate::{
-    engine::open_jtalk::blocking::OpenJtalk, infer::runtimes::onnxruntime::blocking::Onnxruntime,
-    synthesizer::blocking::Synthesizer, text_analyzer::blocking::TextAnalyzer,
-    user_dict::dict::blocking::UserDict, voice_model::blocking::VoiceModelFile,
+    core::{
+        infer::runtimes::onnxruntime::blocking::Onnxruntime, voice_model::blocking::VoiceModelFile,
+    },
+    engine::{
+        open_jtalk::blocking::OpenJtalk, text_analyzer::blocking::TextAnalyzer,
+        user_dict::dict::blocking::UserDict,
+    },
+    synthesizer::blocking::Synthesizer,
 };
 
 // TODO: 後で復活させる
@@ -14,7 +19,7 @@ pub use crate::synthesizer::blocking::AudioFeature as __AudioFeature;
 pub mod onnxruntime {
     #[cfg(feature = "load-onnxruntime")]
     #[cfg_attr(docsrs, doc(cfg(feature = "load-onnxruntime")))]
-    pub use crate::infer::runtimes::onnxruntime::blocking::LoadOnce;
+    pub use crate::core::infer::runtimes::onnxruntime::blocking::LoadOnce;
 }
 
 pub mod synthesizer {

crates/voicevox_core/src/core.rs

@@ -1,3 +1,11 @@
-mod adjust;
+//! 音声モデルの取り扱いと推論に関する「コア」の領域。
+
+pub(crate) mod adjust;
+pub(crate) mod devices;
+pub(crate) mod infer;
+mod manifest;
+pub(crate) mod metas;
+pub(crate) mod status;
+pub(crate) mod voice_model;
 
 pub(crate) use self::adjust::{ensure_minimum_phoneme_length, pad_decoder_feature};

crates/voicevox_core/src/devices.rs renamed to crates/voicevox_core/src/core/devices.rs

@@ -12,9 +12,12 @@ use thiserror::Error;
 
 use crate::{
     asyncs::{Async, BlockingThreadPool, SingleTasked},
+    StyleType, SupportedDevices,
+};
+
+use super::{
     devices::{DeviceSpec, GpuSpec},
     voice_model::ModelBytes,
-    StyleType, SupportedDevices,
 };
 
 pub(crate) trait AsyncExt: Async {
@@ -150,7 +153,7 @@ pub(crate) trait InferenceInputSignature {
     ) -> anyhow::Result<R::RunContext>;
 }
 
-pub(crate) trait InputScalar: Sized {
+trait InputScalar: Sized {
     const KIND: InputScalarKind;
 
     // TODO: `Array`ではなく`ArrayView`を取ることができるかもしれない
@@ -210,7 +213,7 @@ pub(crate) trait InferenceOutputSignature:
     const PARAM_INFOS: &'static [ParamInfo<OutputScalarKind>];
 }
 
-pub(crate) trait OutputScalar: Sized {
+trait OutputScalar: Sized {
     const KIND: OutputScalarKind;
     fn extract(tensor: OutputTensor) -> std::result::Result<ArrayD<Self>, ExtractError>;
 }

crates/voicevox_core/src/infer.rs renamed to crates/voicevox_core/src/core/infer.rs

@@ -34,7 +34,7 @@ pub(crate) struct InferenceDomainMap<V: InferenceDomainMapValues + ?Sized> {
 }
 
 impl<T, X, S, F> InferenceDomainMap<(T, X, S, F)> {
-    pub(crate) fn each_ref(&self) -> InferenceDomainMap<(&T, &X, &S, &F)> {
+    pub(in super::super) fn each_ref(&self) -> InferenceDomainMap<(&T, &X, &S, &F)> {
         let talk = &self.talk;
         let experimental_talk = &self.experimental_talk;
         let singing_teacher = &self.singing_teacher;
@@ -47,7 +47,7 @@ impl<T, X, S, F> InferenceDomainMap<(T, X, S, F)> {
         }
     }
 
-    pub(crate) fn map<
+    pub(in super::super) fn map<
         T2,
         X2,
         S2,
@@ -74,7 +74,7 @@ impl<T, X, S, F> InferenceDomainMap<(T, X, S, F)> {
 }
 
 impl<T, X, S, F, E> InferenceDomainMap<(Result<T, E>, Result<X, E>, Result<S, E>, Result<F, E>)> {
-    pub(crate) fn collect(self) -> Result<InferenceDomainMap<(T, X, S, F)>, E> {
+    pub(in super::super) fn collect(self) -> Result<InferenceDomainMap<(T, X, S, F)>, E> {
         let talk = self.talk?;
         let experimental_talk = self.experimental_talk?;
         let singing_teacher = self.singing_teacher?;
@@ -141,19 +141,19 @@ macro_rules! inference_domain_map_values {
         (
             ::macros::substitute_type!(
                 $body
-                where $arg = crate::infer::domains::TalkDomain as crate::infer::InferenceDomain
+                where $arg = crate::core::infer::domains::TalkDomain as crate::core::infer::InferenceDomain
             ),
             ::macros::substitute_type!(
                 $body
-                where $arg = crate::infer::domains::ExperimentalTalkDomain as crate::infer::InferenceDomain
+                where $arg = crate::core::infer::domains::ExperimentalTalkDomain as crate::core::infer::InferenceDomain
             ),
             ::macros::substitute_type!(
                 $body
-                where $arg = crate::infer::domains::SingingTeacherDomain as crate::infer::InferenceDomain
+                where $arg = crate::core::infer::domains::SingingTeacherDomain as crate::core::infer::InferenceDomain
             ),
             ::macros::substitute_type!(
                 $body
-                where $arg = crate::infer::domains::FrameDecodeDomain as crate::infer::InferenceDomain
+                where $arg = crate::core::infer::domains::FrameDecodeDomain as crate::core::infer::InferenceDomain
             ),
         )
     };

crates/voicevox_core/src/infer/domains.rs renamed to crates/voicevox_core/src/core/infer/domains.rs

@@ -5,10 +5,11 @@ use macros::{InferenceInputSignature, InferenceOperation, InferenceOutputSignatu
 use ndarray::{Array0, Array1, Array2};
 use serde::Deserialize;
 
-use crate::{manifest::ExperimentalTalkManifest, StyleType};
+use crate::StyleType;
 
 use super::super::{
-    InferenceDomain, InferenceInputSignature as _, InferenceOutputSignature as _, OutputTensor,
+    super::manifest::ExperimentalTalkManifest, InferenceDomain, InferenceInputSignature as _,
+    InferenceOutputSignature as _, OutputTensor,
 };
 
 pub(crate) enum ExperimentalTalkDomain {}

crates/voicevox_core/src/infer/domains/experimental_talk.rs renamed to crates/voicevox_core/src/core/infer/domains/experimental_talk.rs

@@ -5,10 +5,11 @@ use macros::{InferenceInputSignature, InferenceOperation, InferenceOutputSignatu
 use ndarray::{Array1, Array2};
 use serde::Deserialize;
 
-use crate::{manifest::FrameDecodeManifest, StyleType};
+use crate::StyleType;
 
 use super::super::{
-    InferenceDomain, InferenceInputSignature as _, InferenceOutputSignature as _, OutputTensor,
+    super::manifest::FrameDecodeManifest, InferenceDomain, InferenceInputSignature as _,
+    InferenceOutputSignature as _, OutputTensor,
 };
 
 pub(crate) enum FrameDecodeDomain {}

crates/voicevox_core/src/infer/domains/frame_decode.rs renamed to crates/voicevox_core/src/core/infer/domains/frame_decode.rs

@@ -5,10 +5,11 @@ use macros::{InferenceInputSignature, InferenceOperation, InferenceOutputSignatu
 use ndarray::{Array1, Array2};
 use serde::Deserialize;
 
-use crate::{manifest::SingingTeacherManifest, StyleType};
+use crate::StyleType;
 
 use super::super::{
-    InferenceDomain, InferenceInputSignature as _, InferenceOutputSignature as _, OutputTensor,
+    super::manifest::SingingTeacherManifest, InferenceDomain, InferenceInputSignature as _,
+    InferenceOutputSignature as _, OutputTensor,
 };
 
 pub(crate) enum SingingTeacherDomain {}