ソングエディタの編集状態を保存できるようにする #1829

y-chan · 2024-02-06T22:12:26Z

内容

題の通りです。ソングエディタの状態をプロジェクトとして保存できるようにします。
また、これに合わせてプロジェクトの構造を変更しました。

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

その他

zodのスキーマを有効活用するために一部リファクタリングを行っています。

また、現状ではソング部分のプロジェクトの変更検知を行っていない(変更検知がCOMMANDに依存しているため)ので、変更していてもプロジェクトを保存せずに閉じれてしまう問題があります。wipでもいいので、ソング部分のプロジェクト変更検知機能を付けるか迷ったのですが、変更前のプロジェクトを保持しておく以外に変更検知をする手段が思いつかなかったので、このPRでは取り組んでいません。

src/store/project.ts

src/store/type.ts

Hiroshiba · 2024-02-07T09:20:53Z

src/store/project.ts

            prevAudioKey = await context.dispatch("REGISTER_AUDIO_ITEM", {
              prevAudioKey,
              audioItem,
            });
          }
+
+          const { tpqn, tempos, timeSignatures, tracks, phrases } =
+            parsedProjectData.sing;


あ、名詞のsongのが良さそうかもです！

（エディタ結構singになってるとこあるので、songにするissue作ってみました）

名詞っぽい場所にあるsingをsongにする #1837

Hiroshiba

とりあえず一旦コメントです･･･！

Hiroshiba · 2024-02-07T09:29:13Z

src/store/project.ts

+            value.state = "WAITING_TO_BE_RENDERED";
+            context.commit("SET_PHRASE", { phraseKey: key, phrase: value });
+          }
+          context.dispatch("RENDER");


これを実行する責務はLOAD_PROJECT_FILEを呼んだ側かも

なるほどです、確かにそうですね...!

修正しようと思います....!

Hiroshiba · 2024-02-07T09:30:12Z

src/store/project.ts

+            value.state = "WAITING_TO_BE_RENDERED";
+            context.commit("SET_PHRASE", { phraseKey: key, phrase: value });


stateが入っているものをproejctとして保存するのちょっと違和感あるかもです！
phraseはレンダリング用に作られるキャッシュで、保存しなくても良いものかも･･･？
（@sigprogramming さんが詳しいかも）

あ、phrase内にqueryがあるから違うかも。stateだけ保存しないようにするのが良い気がしました！
（たぶんphraseにidを持たせて、phraseStateだけメモリに持つ構成が合ってるかも）

ピッチやボリュームの編集データはqueryとは別で持つ形になると思うので、phraseは保存しなくても良いかなと思います！（キャッシュの保存についてはまた後ほど考慮できれば…！）

なるほどです...!
ピッチやボリュームのデータはリクエストする度に差異が発生する可能性があるので、できれば今の内から一度リクエストされたものは保存するようにと思っていたのですが、一旦phrasesは保存しない方向で行きたいと思います！

src/store/project.ts

y-chan · 2024-02-07T11:15:15Z

Discordで議論した結果をまとめておきます

議題: ソングとトークでプロジェクトを分けて保存すべきか？

議論の始まり: https://discord.com/channels/879570910208733277/893889888208977960/1204721860189757460
結論: https://discord.com/channels/879570910208733277/893889888208977960/1204745814375931924

結論としては一旦両方とも同じプロジェクトに保存
- 実装コストとか、データ消失リスクとか
- リスクについて、両方持たせると
  - セーブ時の想定外が減る
  - ロード時に想定外（もう片方が空で上書きされた）になるかも？
- 片方だけにすると
  - セーブ時に想定外（もう片方が保存されてなかった）になるかも？
  - ロード時に想定外にならない
- 多分、どっちにしろ変更検知を実装すれば防げる、一旦はセーブ時想定外を減らす方がリスク的には小さそう(一旦不幸が少なさそうな方向)
将来的に分けて保存する機能・片方だけ読み込みできる機能とか付けられるとよさそう
- 大多数の人はどっちでもいいはず、片方だけ保存出来ないと困る人や、両方保存できないと困る人は両者ともに少数派な気がする
- みんなを救うなら分けて保存を実装すればいい
実装は、読み込み・保存を分けられるように組めるとよさそう
- マイグレーションとか、関数化しておけると ⭕

src/store/project.ts

Hiroshiba

いろいろコメント書いていますが大枠LGTMです！

プロジェクトファイル実装したい気持ちはあるのですが、ちょっとコードぐちゃっとしそうなので、少しリファクタリングしてから実装できればと思ってます。

src/store/project.ts

src/store/singing.ts

src/store/type.ts

src/store/project.ts

Hiroshiba

LGTM！！！　お疲れ様でした！！

１点、トーク側でソングを含むプロジェクトを読み込んだ後にソングに移動するとノートが表示されてない挙動を見つけました！
簡単に解決できそうなら倒して頂けると･･･！難しそうならissueで良いのかなと思ってます。

@sigprogramming プロジェクトロード部分のとこだけ再度レビューお願いできると心強いです･･･！！

y-chan · 2024-02-14T00:27:14Z

トーク側でソングを含むプロジェクトを読み込んだ後にソングに移動するとノートが表示されてない

これは検証したところ、一度もソング画面を開かずにソングプロジェクトを読み込むと、ソング画面を開いた際にonMountedが走ってソング画面が初期化されてしまうのが問題なようです...
修正したいですが、ちょっと規模が大きくなりそうなので別PRで...!

あと、そこを見ていた際にvolumeが保存されないことに気づいたのですが、出力結果に影響を与えるvolumeをちゃんと保存した方がいいなと思いました。
ただ、ステート名がvolumeで、これがトークに対して影響を与えるのか、ソングに対して影響を与えるのかがわかりずらいので、ストアのリファクタを先にした方がいいかもです...

Hiroshiba · 2024-02-14T02:24:43Z

なるほどです！　issue作成で良いと思います！！

そこを見ていた際にvolumeが保存されないことに気づいたのですが、出力結果に影響を与えるvolumeをちゃんと保存した方がいいなと思いました。

右上のvolumeですよね。
扱いが難しいですね･･･。たしか保存される音声には影響を与えないんですよね。アプリの音量みたいな。
なのでトークのsplitterの位置みたく、グローバルな設定としてエディタ全体で保存するとかでも良いかも･･･。

sigprogramming

ほぼLGTMです！

#1842 でnotesKeyShiftとvoiceKeyShiftが追加されたので、これらも保存・ロードできると良いかもと思いました！（別PRで行っても良いと思います）

src/store/singing.ts

src/store/project.ts

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>

This reverts commit 97d68a8.

Co-authored-by: Sig <sigprogrammer@gmail.com>

y-chan · 2024-02-16T17:41:41Z

コンフリクトの解消と、それに合わせたnotesKeyShift、voiceKeyShiftの保存・読み込み対応、あと忘れていたapply<XXX>ProjectToStore関数の追加を行いました！
再度レビューいただけると助かります 🙏

Hiroshiba

LGTM！！！

お疲れ様でした！！良い実装になったように感じます！！！

トーク側でソングを含むプロジェクトを読み込んだ後にソングに移動するとノートが表示されてない

こちらのissue 作成お任せしてしてもよろしいでしょうか 🙇
（#1829 (comment) の件）

y-chan requested a review from a team as a code owner February 6, 2024 22:12

y-chan requested review from Hiroshiba and removed request for a team February 6, 2024 22:12

sevenc-nanashi reviewed Feb 7, 2024

View reviewed changes

src/store/project.ts Outdated Show resolved Hide resolved

src/store/project.ts Outdated Show resolved Hide resolved

src/store/type.ts Outdated Show resolved Hide resolved

Hiroshiba reviewed Feb 7, 2024

View reviewed changes

y-chan changed the title ~~シングエディタの編集状態を保存できるようにする~~ ソングエディタの編集状態を保存できるようにする Feb 7, 2024

Hiroshiba reviewed Feb 7, 2024

View reviewed changes

sigprogramming reviewed Feb 7, 2024

View reviewed changes

src/store/project.ts Outdated Show resolved Hide resolved

Hiroshiba mentioned this pull request Feb 8, 2024

ソング：歌wave出力時のデフォルトファイル名を良い感じにする #1833

Closed

y-chan mentioned this pull request Feb 9, 2024

[ソング] Undo/Redoの実装 #1836

Merged

Hiroshiba reviewed Feb 10, 2024

View reviewed changes

src/store/project.ts Outdated Show resolved Hide resolved

y-chan force-pushed the feat/save-sing-project branch from f2d6289 to c82a4e5 Compare February 13, 2024 00:05

Hiroshiba reviewed Feb 13, 2024

View reviewed changes

sigprogramming reviewed Feb 14, 2024

View reviewed changes

src/store/singing.ts Outdated Show resolved Hide resolved

src/store/singing.ts Show resolved Hide resolved

src/store/project.ts Outdated Show resolved Hide resolved

y-chan added 12 commits February 16, 2024 22:34

add sing schema

3433ee9

change project file shape and schema

0d24be4

fix missing attribute

f7abe20

make all editor states required in project file

c4958a0

remove await and use commit

374354f

separate phrases map and phrase data map

f51a75e

add project load/save buttons to sing editor

b252f4b

fmt

bdbc6f8

add generate singing store initial score func

59b9687

initialize song project in create new project

f878e57

rename editor detect variable

98e5cad

remove phrases

f904b05

y-chan and others added 14 commits February 16, 2024 22:36

rename sing to song

006d795

use dispatch

8b51dcc

improve comment

b0e44d5

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>

add await for set singer and score

4bed10f

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>

improve comment

8176489

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>

extract object in migration

02c4eeb

Revert "separate phrases map and phrase data map"

2e98a87

This reverts commit 97d68a8.

revert phrase schema

872765a

remove last active editor property from project

718264e

ｍove talk project validation

1090591

remove phrases from sing store initial score

9de4de1

Co-authored-by: Sig <sigprogrammer@gmail.com>

add comment of not using generate singing store initial score func

ba55cc5

add key shift to song initial object

b60e0b0

add set voice key shift to loading project

c83b1c7

y-chan force-pushed the feat/save-sing-project branch from a3d3147 to c83b1c7 Compare February 16, 2024 13:58

y-chan added 3 commits February 17, 2024 02:35

create apply talk project to store

2368523

create apply song project to store func

11aa7ca

add missing await

d9f40d4

Hiroshiba approved these changes Feb 17, 2024

View reviewed changes

Hiroshiba merged commit 821d298 into VOICEVOX:main Feb 17, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ソングエディタの編集状態を保存できるようにする #1829

ソングエディタの編集状態を保存できるようにする #1829

y-chan commented Feb 6, 2024 •

edited

Loading

Hiroshiba Feb 7, 2024 •

edited

Loading

Hiroshiba left a comment

Hiroshiba Feb 7, 2024

y-chan Feb 7, 2024

Hiroshiba Feb 7, 2024

Hiroshiba Feb 7, 2024

sigprogramming Feb 7, 2024

y-chan Feb 7, 2024

y-chan commented Feb 7, 2024 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

Hiroshiba left a comment

y-chan commented Feb 14, 2024

Hiroshiba commented Feb 14, 2024 •

edited

Loading

sigprogramming left a comment

y-chan commented Feb 16, 2024 •

edited

Loading

Hiroshiba left a comment

		value.state = "WAITING_TO_BE_RENDERED";
		context.commit("SET_PHRASE", { phraseKey: key, phrase: value });

ソングエディタの編集状態を保存できるようにする #1829

ソングエディタの編集状態を保存できるようにする #1829

Conversation

y-chan commented Feb 6, 2024 • edited Loading

内容

関連 Issue

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

その他

Hiroshiba Feb 7, 2024 • edited Loading

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

Hiroshiba Feb 7, 2024

Choose a reason for hiding this comment

y-chan Feb 7, 2024

Choose a reason for hiding this comment

Hiroshiba Feb 7, 2024

Choose a reason for hiding this comment

Hiroshiba Feb 7, 2024

Choose a reason for hiding this comment

sigprogramming Feb 7, 2024

Choose a reason for hiding this comment

y-chan Feb 7, 2024

Choose a reason for hiding this comment

y-chan commented Feb 7, 2024 • edited Loading

議題: ソングとトークでプロジェクトを分けて保存すべきか？

Hiroshiba left a comment • edited Loading

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

y-chan commented Feb 14, 2024

Hiroshiba commented Feb 14, 2024 • edited Loading

sigprogramming left a comment

Choose a reason for hiding this comment

y-chan commented Feb 16, 2024 • edited Loading

Hiroshiba left a comment

Choose a reason for hiding this comment

y-chan commented Feb 6, 2024 •

edited

Loading

Hiroshiba Feb 7, 2024 •

edited

Loading

y-chan commented Feb 7, 2024 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

Hiroshiba commented Feb 14, 2024 •

edited

Loading

y-chan commented Feb 16, 2024 •

edited

Loading