書き出しファイル名をカスタマイズ可能にする #789

k-chop · 2022-04-17T07:34:27Z

内容

書き出すファイル名をユーザが自由に組み立てられるようになる機能を追加しました。
文字列にタグを指定すると実際のデータに置き換えられて出力されます。
$キャラ$.wav のような指定にして音声を一括出力しようとした場合の重複解消ロジックが重めだったので、
コード差分の少ない「$連番$を必須にする」ことで対処しています。

スクリーンショット・動画など

ダイアログの動作

出力

（テキストにタグが入るようにしていても悪いことはできないようになっています）

その他

差分はコンポーネント周りが8割です。vueは公式ドキュメント一通り目は通しましたが、経験が浅いので何かやらかしてるかもしれません。。。
全400行とちょっと重めですがレビューよろしくお願いします... 🙇‍♂️

This reverts commit 8a1be6b.

k-chop · 2022-04-17T07:51:45Z

src/components/FileNamePatternDialog.vue

+
+    const store = useStore();
+    const patternInput = ref<QInput>();
+    const maxLength = 128;


あまり際限なく長くされても困るかなと思い、なんとなくの128文字（※）制限しています。
（※絵文字などのサロゲートペア文字列入るともっと短くなります）

k-chop · 2022-04-17T07:55:25Z

src/components/FileNamePatternDialog.vue

+
+    const initializeInput = () => {
+      const pattern = savingSetting.value.fileNamePattern;
+      currentFileNamePattern.value = removeExtension(pattern);


.wav は必須なので、ユーザには .wav 抜きで編集させて設定に保存時に付け足す形になっています。

src/components/FileNamePatternDialog.vue

k-chop · 2022-04-17T08:14:03Z

src/store/audio.ts

-
-  const sanitizedStyleName = sanitizeFileName(styleName);
-  return preFileName + `_${characterName}（${sanitizedStyleName}）_${text}.wav`;
+  return buildFileNameFromRawData(fileNamePattern, {


buildFileName 内ではstate, audioKeyから必要なデータを取得するだけにして、 buildFileNameFromRawData でそのデータをファイル名向けに加工（タグ置換も含む）する、という感じに処理を分けました。

k-chop · 2022-04-17T08:18:24Z

src/store/utility.ts

+const replaceTagStringToTagId: { [tagString: string]: ReplaceTagId } =
+  Object.entries(replaceTagIdToTagString).reduce(
+    (prev, [k, v]) => ({ ...prev, [v]: k }),
+    {}


Object.entries(replaceTagIdToTagString).find(([k, v]) => v === "連番") を
replaceTagStringToTagId["連番"] で済ませたかったがために生まれました...

src/store/utility.ts

Hiroshiba

LGTM！！！

良い機能だと感じました！！
いくつか気づいたことがあったのでコメントしてみました！

src/components/FileNamePatternDialog.vue

Hiroshiba · 2022-04-20T15:40:46Z

src/store/utility.ts

+  styleName: "（スタイル）",
+  text: "テキスト",
+  rawStyleName: "スタイル",


括弧なしのstyleNameだけ用意しておいて、デフォルトのパターンは$連番$_$キャラ$（$スタイル$）_$テキスト$にする（スタイルを括弧で囲う）にする手もあるなと感じました。

元コードにstyleNameが空になるケースがあるとのコメントがあったため
空になるなら （） をタグの外に出すと （） だけ出力されるケースが出て困りそう、と思い両方追加したんですが、
今試してみたらどのキャラでも全部（ノーマル）ついて出力されていますね・・・確認不足でしたすみません！！
括弧なしのstyleNameだけに修正します。

EDIT: c13ef4f でかっこなしのstyleNameだけにして、デフォルトのパターンも修正しました。

あーーーーなるほどです！！

スタイルが１つの場合は（ノーマル）がなくても良さそうに感じましたが、いつの間にか入るようになってますね･･･！
ご配慮ありがとうございます！！

src/store/utility.ts

k-chop · 2022-04-20T18:07:25Z

@Hiroshiba レビューありがとうございます！！
コメントしていただいたところ一通り対応しました。

あとは

見返していてこの型いらんのでは・・・？となった部分を修正しています（ロジック自体に変更はありません）
- 48b2cf7
合わせて設定ファイル消して確認したとき初回のフォームが空だったのでデフォルト値を入れるようにしました。
- aafa541

2点の変更を加えています🙇

Hiroshiba · 2022-05-10T16:02:44Z

お待たせしました、マージさせていただきます！！
結構要望を頂いていた機能なので、ユーザーさんからの反応が楽しみです！

commit 9d742ac Author: Hiroshiba <hihokaruta@gmail.com> Date: Mon May 16 01:13:58 2022 +0900 エンジンのバージョンを0.12.4-previewに (VOICEVOX#809) commit 4ffd776 Author: kantas-spike <101532773+kantas-spike@users.noreply.github.com> Date: Sat May 14 04:12:08 2022 +0900 テキストの「読み込み」及び「繋げて書き出し」で「キャラ名(スタイル名)」を利用可能に (VOICEVOX#805) * テキストの「読み込み」及び「繋げて書き出し」で「キャラ名(スタイル名)」を利用可能に * StyleInfo型のstyleNameが未定義時は"ノーマル"をテキスト出力する commit f40f4ad Author: Hiroshiba <hihokaruta@gmail.com> Date: Wed May 11 01:06:36 2022 +0900 キャラ数が多いときにスクロールバーを表示する (VOICEVOX#749) * キャラ数が多いときにスクロールバーを表示する * .transparent-backdropクラス追加、seamless除去 * 追加し忘れ commit c3d67b1 Author: Gray Suitcase <41382894+PickledChair@users.noreply.github.com> Date: Wed May 11 01:04:48 2022 +0900 Fix: LinuxとmacOSの配布パッケージを動作可能にする (VOICEVOX#798) * ビルド後はappDirPathにある.envを読みに行く * .envのパス指定に関するコメントを追加 commit 4157aec Author: kchop <whelmaze@gmail.com> Date: Wed May 11 01:02:47 2022 +0900 書き出しファイル名をカスタマイズ可能にする (VOICEVOX#789) * 設定値の型等に項目追加 * 与えたパターンからファイル名が決定できるようにした * 値を取ってくるのとファイル名のために加工するメソッドを分ける * utilityへ移動 * ツールチップが特定条件でしか出てこなかったのを修正 * コンポーネントの実装 * スタイルの調整 * 重複し得るファイル名指定で一括出力した場合に上書きされないようにする * 日付も挿入可能にする * デバッグ出力の削除 * 連番を必須にしつつコンポーネントを多少リファクタ * テストの修正 * Revert "重複し得るファイル名指定で一括出力した場合に上書きされないようにする" This reverts commit 8a1be6b. * サンプルテキストの修正 * テキストにタグ文字列を含めたとき悪いことができないようにする * 変数名などのリファクタ * 別名つけただけの型を削除 * 表示される文言の調整 * 出力ファイル名に$を使えなくしてマッチ対象の問題をちょっと強引に解決 * nextTickを使う * 日付がyyyymmddじゃなかった問題を修正 * 型定義をシンプルに * styleNameタグにかっこを含めない * 初回に設定ダイアログを開いたときデフォルト値をフォームに入れるように commit fc04a18 Author: madosuki <yurikasamaaikatsu@gmail.com> Date: Mon May 9 02:34:46 2022 +0900 「エンジンを再起動する機能」を機能するように修正 (VOICEVOX#800) * add detectNvidia function * follow to menu bar * remove no longer a variable * run fmt * fix typo * remove utils.ts and some changes in background.ts * change message box type and detail, and change behaviour of setOnLaunchModeItemClicked * recreate package-lock.json using node 12.18.2 * re recreate package-lock.json using node 12.18.2 and npm 7.20.5 * recreate package-lock.json using node 12.18.2 and npm 6.14.5 * recreate package-lock.json using node 12.18.2 and npm 7.20.3 * fix conflict * fix feature of restart engine, add a argument commit 9f8cf04 Author: kantas-spike <101532773+kantas-spike@users.noreply.github.com> Date: Thu May 5 03:13:57 2022 +0900 全テキスト欄の文章をキャラ名とともに一括してテキスト書き出す機能 (VOICEVOX#787) * 全テキスト欄の文章をキャラ名とともに一括してテキスト書き出す機能を追加 * 一括して出力することがわかるようにメニューの文言を修正 * "つなげて書き出す"ことがわかるように関数とメッセージの名称を修正 connectAndExportTextで名称を統一 * メニューハンドラ名 exportTextFile => connectAndExportText * ダイアログ名 exportTextFileWithDialog => connectAndExportTextWithDialog * メッセージ名 EXPORT_TEXT_FILE => CONNECT_AND_EXPORT_TEXT * 未定義判定の誤り修正 * スタイルIDとスピーカー名の対応付けを修正デフォルトスタイルIDではなく全てのスタイルIDとスピーカー名を対応付ける * コードフォーマット実施漏れを修正 commit 8accdfe Author: nebocco <73807432+nebocco@users.noreply.github.com> Date: Tue May 3 03:07:09 2022 +0900 イントネーション欄の文字横幅をそろえる (VOICEVOX#792) * fix: .q-slider width * fix: centered text in .text-cell * fix: getHoveredClass -> isHovered * fix: .text-cell-inner { z-index: 10; } * fix: CSS commit e1ab04c Author: MT <mt224244@gmail.com> Date: Tue May 3 01:57:29 2022 +0900 .envのDEFAULT_ENGINE_INFOSを改行して定義 (VOICEVOX#794) * ➕ dependenciesにdotenvを追加 * 🔧 DEFAULT_ENGINE_INFOSを改行して定義 * 🩹 開発時にdotenvが動いていないっぽかったので修正 commit 2088b1e Author: MT <mt224244@gmail.com> Date: Thu Apr 28 01:05:40 2022 +0900 lodash.debounceを削除 (VOICEVOX#795) * ♻️ debounce関数はquasarにもあるので、そちらを使用するよう変更 * ➖ lodash.debounceを削除 commit f48c89b Author: madosuki <yurikasamaaikatsu@gmail.com> Date: Wed Apr 20 17:43:30 2022 +0900 タイトルバーのモード表示が固定化されているのを修正 (VOICEVOX#791) * add detectNvidia function * follow to menu bar * remove no longer a variable * run fmt * fix typo * remove utils.ts and some changes in background.ts * change message box type and detail, and change behaviour of setOnLaunchModeItemClicked * recreate package-lock.json using node 12.18.2 * re recreate package-lock.json using node 12.18.2 and npm 7.20.5 * recreate package-lock.json using node 12.18.2 and npm 6.14.5 * recreate package-lock.json using node 12.18.2 and npm 7.20.3 * fix conflict * become computed commit 3641a4b Author: madosuki <yurikasamaaikatsu@gmail.com> Date: Sun Apr 17 13:54:53 2022 +0900 設定に入れたペースト時の挙動を変える項目を「保存」から「操作」に移動 (VOICEVOX#781) * add detectNvidia function * follow to menu bar * remove no longer a variable * run fmt * fix typo * remove utils.ts and some changes in background.ts * change message box type and detail, and change behaviour of setOnLaunchModeItemClicked * recreate package-lock.json using node 12.18.2 * re recreate package-lock.json using node 12.18.2 and npm 7.20.5 * recreate package-lock.json using node 12.18.2 and npm 6.14.5 * recreate package-lock.json using node 12.18.2 and npm 7.20.3 * fix conflict * move splitTextWhenPaste from saving to 操作 * add restore from store feature * change place of process of init splitTextWhenPaste * move init process to Home.vue's onMounted * move process of initial splitTextWhenPaste, at Home.vue to store/index.ts * fix conflict * Revert "fix conflict" This reverts commit 7f6cd34. * refix conflict commit 5a37c37 Author: kchop <whelmaze@gmail.com> Date: Sat Apr 16 20:02:44 2022 +0900 ウィンドウ位置・splitterの位置を記憶できるようにする (VOICEVOX#782) * electron-window-stateのインストール * windowの位置を記憶するように * splitterの位置をとりあえず保存・復元できるようにする * 最大化状態の復元時、vuexのstoreにも反映する manageメソッドの中で最大化状態の復元を行っているので、maximizeハンドラを追加してからでないとstoreのisMaximizedがfalseのままになる * 設定ファイル書き換えで異常値が入り得るケースの対策 * 共通部分の切り出し * 書き込みもawaitしておく * set時の型が間違っていたので修正 * viewから直接window.electronを呼ぶのをやめる * テスト修正 * typo修正 commit 35b00ea Author: 南風 <cyatarow@outlook.com> Date: Sat Apr 16 16:54:46 2022 +0900 DirectMLへの対応 (VOICEVOX#788) * Update build.yml * directmlの記述を追加 * DirectMLの記述をさらに追加 * 微調整 VOICEVOX#775 (comment) * 1個修正忘れ VOICEVOX#788 (review) commit 15763fc Author: Haruki Tazoe <40142697+jdkfx@users.noreply.github.com> Date: Fri Apr 8 22:49:49 2022 +0900 設定画面の項目の詳細情報をヘルプとして表示する (VOICEVOX#780) * パラメータの引き継ぎの詳細表示アイコンを追加 * 書き出し先を固定についての詳細表示アイコンを追加 * 上書き防止の詳細表示アイコンを追加 * txtファイルを書き出しの詳細表示アイコンを追加 * labファイルを書き出しの詳細表示アイコンを追加 * 音声をステレオ化の詳細表示アイコンを追加 * プリセット機能の詳細表示アイコンを追加 * 疑問文を自動調整の詳細表示アイコンを追加 * 利用状況のデータ収集の詳細表示アイコンを追加 * 再生位置を追従の詳細表示アイコンを追加 * エンジンモードの詳細表示アイコンを追加 * 文字コードの詳細表示アイコンを追加 * 分割の挙動の詳細表示アイコンを追加 * 再生デバイスの詳細表示アイコンを追加 * 音声のサンプリングレートの詳細表示アイコンを追加 commit 8aa6157 Author: kchop <whelmaze@gmail.com> Date: Fri Apr 8 22:47:08 2022 +0900 選択中のアクセント句をリセットする機能を追加 (VOICEVOX#779) * 選択中のアクセント句のみリセットするコマンドとショートカットキー追加 * 全体リセットのショートカットキー * エラーが起きたことが分からなくなるのでここでcatchしない commit b641f4b Author: madosuki <yurikasamaaikatsu@gmail.com> Date: Fri Apr 8 22:43:51 2022 +0900 Fix UNLOCK_UI (VOICEVOX#774) * add detectNvidia function * follow to menu bar * remove no longer a variable * run fmt * fix typo * remove utils.ts and some changes in background.ts * change message box type and detail, and change behaviour of setOnLaunchModeItemClicked * recreate package-lock.json using node 12.18.2 * re recreate package-lock.json using node 12.18.2 and npm 7.20.5 * recreate package-lock.json using node 12.18.2 and npm 6.14.5 * recreate package-lock.json using node 12.18.2 and npm 7.20.3 * fix conflict * add process of check whether 0 for state.uiLockCount * add console.warn * add eslint disable line * fix commit be239a1 Author: Hiroshiba <hihokaruta@gmail.com> Date: Fri Apr 8 14:19:23 2022 +0900 .envのエンジンへのパスは\区切りではなく/区切りだとわかりやすくする (VOICEVOX#778) * .envのエンジンへのパスは\ではなく * Update .env.production * Update README.md commit 09c1a18 Author: Hiroshiba <hihokaruta@gmail.com> Date: Tue Apr 5 19:56:39 2022 +0900 テキスト読み込み時にデフォルトスタイルが適用されるように変更 (VOICEVOX#765) commit 64044d1 Author: kchop <whelmaze@gmail.com> Date: Mon Apr 4 00:36:47 2022 +0900 アクセントからイントネーションを再設定する機能 (VOICEVOX#776) * FETCH_MORA_DATAで取ってきたaccentPhrasesでまるっと上書きするactionを追加 * ショートカットキーで実行できるように * 何をリセットするのか明確にする * FETCH_MORA_PITCHを追加してそちらを使うように * デフォルトショートカットキーをRに変更 * FETCH_MORA_DATAを使い音素長もリセットする * 長さも変更することを示すためaction名の変更

k-chop added 18 commits April 17, 2022 15:28

設定値の型等に項目追加

81c8bc1

与えたパターンからファイル名が決定できるようにした

71c29e5

値を取ってくるのとファイル名のために加工するメソッドを分ける

95d2103

utilityへ移動

f87ea66

ツールチップが特定条件でしか出てこなかったのを修正

a9e5c37

コンポーネントの実装

c9c6de7

スタイルの調整

82e9f71

重複し得るファイル名指定で一括出力した場合に上書きされないようにする

191ad90

日付も挿入可能にする

ab2e5df

デバッグ出力の削除

fa09838

連番を必須にしつつコンポーネントを多少リファクタ

b401826

テストの修正

9a6c3b0

Revert "重複し得るファイル名指定で一括出力した場合に上書きされないようにする"

15072e2

This reverts commit 8a1be6b.

サンプルテキストの修正

b701cf6

テキストにタグ文字列を含めたとき悪いことができないようにする

362e5ec

変数名などのリファクタ

8bc5997

別名つけただけの型を削除

0762472

表示される文言の調整

61eb4c9

k-chop commented Apr 17, 2022

View reviewed changes

src/components/FileNamePatternDialog.vue Outdated Show resolved Hide resolved

k-chop commented Apr 17, 2022

View reviewed changes

src/store/utility.ts Show resolved Hide resolved

k-chop changed the title ~~書き出しファイル名をカスタマイズ可能にする~~ [WIP] 書き出しファイル名をカスタマイズ可能にする Apr 17, 2022

出力ファイル名に$を使えなくしてマッチ対象の問題をちょっと強引に解決

95b4424

k-chop changed the title ~~[WIP] 書き出しファイル名をカスタマイズ可能にする~~ 書き出しファイル名をカスタマイズ可能にする Apr 17, 2022

Hiroshiba approved these changes Apr 20, 2022

View reviewed changes

k-chop added 2 commits April 21, 2022 01:46

nextTickを使う

7ec7acb

日付がyyyymmddじゃなかった問題を修正

13b535d

k-chop added 3 commits April 21, 2022 02:18

型定義をシンプルに

48b2cf7

styleNameタグにかっこを含めない

c13ef4f

初回に設定ダイアログを開いたときデフォルト値をフォームに入れるように

aafa541

Hiroshiba merged commit 4157aec into VOICEVOX:main May 10, 2022

k-chop deleted the issue569/customizable-output-filename branch May 10, 2022 17:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

書き出しファイル名をカスタマイズ可能にする #789

書き出しファイル名をカスタマイズ可能にする #789

k-chop commented Apr 17, 2022 •

edited

Loading

k-chop Apr 17, 2022

k-chop Apr 17, 2022 •

edited

Loading

k-chop Apr 17, 2022 •

edited

Loading

k-chop Apr 17, 2022

Hiroshiba left a comment

Hiroshiba Apr 20, 2022

k-chop Apr 20, 2022 •

edited

Loading

Hiroshiba Apr 21, 2022

k-chop commented Apr 20, 2022

Hiroshiba commented May 10, 2022

書き出しファイル名をカスタマイズ可能にする #789

書き出しファイル名をカスタマイズ可能にする #789

Conversation

k-chop commented Apr 17, 2022 • edited Loading

内容

関連 Issue

スクリーンショット・動画など

ダイアログの動作

出力

その他

k-chop Apr 17, 2022

Choose a reason for hiding this comment

k-chop Apr 17, 2022 • edited Loading

Choose a reason for hiding this comment

k-chop Apr 17, 2022 • edited Loading

Choose a reason for hiding this comment

k-chop Apr 17, 2022

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

Hiroshiba Apr 20, 2022

Choose a reason for hiding this comment

k-chop Apr 20, 2022 • edited Loading

Choose a reason for hiding this comment

Hiroshiba Apr 21, 2022

Choose a reason for hiding this comment

k-chop commented Apr 20, 2022

Hiroshiba commented May 10, 2022

k-chop commented Apr 17, 2022 •

edited

Loading

k-chop Apr 17, 2022 •

edited

Loading

k-chop Apr 17, 2022 •

edited

Loading

k-chop Apr 20, 2022 •

edited

Loading