Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sing APIの利用に関する解説ドキュメントの作成 #1142

Open
3 tasks
nmori opened this issue Mar 25, 2024 · 3 comments
Open
3 tasks

Sing APIの利用に関する解説ドキュメントの作成 #1142

nmori opened this issue Mar 25, 2024 · 3 comments
Assignees
Labels
機能向上 状態:実装 実装をおこなっている状態

Comments

@nmori
Copy link

nmori commented Mar 25, 2024

内容

APIをつかうことで、比較的簡単に歌唱させることができる反面、
必要なスピード、リズムで歌わせるためには、パラメータの算出が必要となる。

しかし、パラメータの意味・中身を知らないとマジックナンバーのようにみえるため
タイミングをあわせて歌わせようにも 計算の理解に時間が必要で、利用に関し少々の困難さを伴う。

そこで、モデルケースの楽譜をもとに、パラメータ算出の考え方を解説することで
サードパーティツール等がAPIを使おうとするきっかけを醸成する。

Pros 良くなる点

・意味がわかるようになる
・APIユーザの成功体験確率が高まる

Cons 悪くなる点

・特に無いと考えられる

実現方法

・Discordで事前にすり合わせた情報をもとに マークダウン化

VOICEVOXのバージョン

0.18.0

OSの種類/ディストリ/バージョン

  • Windows
  • macOS
  • Linux

その他

想定する読者のレベルは、
・ツールなどを使い、HTTPでPOSTすることはできる
・楽譜が最低限よめる
・MIDIに関する知識は、事前にほとんど持ち合わせていない
・読者のモチベ―ションは「簡単に 音符→WAV 変換したい」と仮定

@nmori
Copy link
Author

nmori commented Mar 25, 2024

ファイルは 「voicevox_engine/docs/ソングAPIの使い方例.md」を想定。

事前検討の会話はこちら:
https://discord.com/channels/879570910208733277/883257983029624853/1221841395434651668
(この先の議論はこのIssueにて)

@tarepan tarepan added the 要議論 実行する前に議論が必要そうなもの label Mar 25, 2024
@nmori
Copy link
Author

nmori commented Mar 30, 2024

Discordで質問した内容から数字の整理をした場合、このような関係性になっていると理解しました。
これをドキュメントとして整理し、「データ→WAV化」するための最初の一歩ドキュメントになればとおもっています。
image

※サンプルは下記を引用
 https://twitter.com/voicevox_pj/status/1770264265808904510

@tarepan tarepan added the 状態:設計 設計をおこなっている状態 label Apr 2, 2024
@Hiroshiba
Copy link
Member

Hiroshiba commented Apr 8, 2024

@nmori すみません大変遅くなりました!! 🙇

ぜひドキュメント化を目指せればと思っています!!!

読者層は仰るとおりの想定が良さそうに思いました。
より周辺のイメージを広げると、知識レベルは「義務教育で音楽の授業をそこそこちゃんと習った」とかでしょうか。

サンプルはそんな感じです!!
実はBPM120のサンプルを作ろうとしたのですが、たしか2番めか3番目のノートの長さがroundすると46になっちゃって、説明めんどうだから45にしちゃいました・・・。

より詳しいQiitaやNote解説記事が書かれるまでの案内を作れると個人的にはすごく嬉しいです!!
ちょっと時間が空いてしまったのですが、もしよければぜひ・・・!!

nmori added a commit to nmori/voicevox_engine that referenced this issue May 5, 2024
@tarepan tarepan added 状態:実装 実装をおこなっている状態 and removed 要議論 実行する前に議論が必要そうなもの 状態:設計 設計をおこなっている状態 labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
機能向上 状態:実装 実装をおこなっている状態
Projects
None yet
Development

No branches or pull requests

3 participants