飴屋／菖蒲氏によって公開されている，Windows向けに作成された歌声合成ソフトウェア「UTAU」の， プラグイン作成のためのC#(.Net Framework 4.8)クラスライブラリです． visual studioでの使用を想定しています．

UTAU公式サイト(http://utau2008.web.fc2.com/) UTAUプラグインの仕様(https://www20.atwiki.jp/utaou/pages/64.html)

Shift-Jis以外の2バイト文字がヘッダに含まれていると落ちます． 多分外国の2バイト環境でも動きます． 本家がutf-8になりそうなので，当面様子見の予定です．

NugetからKimigatame.UtauPluginをインストールしてください。

画像付きチュートリアルはこちら(https://delta-kimigatame.hatenablog.jp/entry/2024/09/01/165041)

using UtauPlugin;

namespace sample1
{
    class Program
    {
        static void Main(string[] args)
        {
            UtauPlugin.UtauPlugin utauPlugin = new UtauPlugin.UtauPlugin(args[0]);
            utauPlugin.Input();
            //
            //具体的な処理
            //
            utauPlugin.Output();
        }
    }
}

UTAU界隈おなじみの半音上げプラグイン(コンソール)の場合

using UtauPlugin;

namespace sample1
{
    class Program
    {
        static void Main(string[] args)
        {
            UtauPlugin.UtauPlugin utauPlugin = new UtauPlugin.UtauPlugin(args[0]);
            utauPlugin.Input();
            foreach(Note note in utauPlugin.note)
            {
                note.SetNoteNum(note.GetNoteNum() + 1);
            }
            utauPlugin.Output();
        }
    }
}

パラメータはUstと同じのため詳細略

UtauPlugin.filePathのファイルをshift_Jisで開き，内容を解析します．

ustのヘッダ情報はUtauPlugin UtauPluginに，ノートの情報はList UtauPlugin.noteに格納されます．

UtauPlugin.filePathのファイルに編集内容を上書きします．

UTAUプラグインの仕様に則り，書き出し内容は最小限です．

ただし@つきのパラメータはreadonlyなので書き出しません．

ファイル読み書きの際に独自エントリの扱いを設定します． 初期値hogeのMyEntryを宣言する場合，

using utauPlugin

UtauPlugin utauPlugin = new UtauPlugin(filePath);
utauPlugin.InitOriginalEntry("MyEntry", "hoge");
utauPlugin.Input()

とします．

UtauPlugin.VoiceDirを参照し，oto.iniとprefix.mapを読込ます．

oto.iniは Dictionary <string, Oto > UtauPlugin.vb.otoに，

prefix.mapは Dictionary <string, MapValue > UtauPlugin.vb.mapに格納されます．

UtauPlugin.noteのうちpreとoveが定義されていないものを，UtauPlugin.vb.mapとUtauPlugin.vb.otoに基づいて補完します． なお，Outputには反映されません．

UtauPlugin.noteのうち@filename,@alias,@pre,@pve,@stpが定義されていないものを，他のパラメータに基づいて補完します． pre/oveが定義されていない場合自動的にApplyOtoも呼ばれます．

index番目のnote.numをDELETEに変更し，前後のノートをprev/nextで繋ぎます．

index番目にnoteを追加します．追加されたノートはnote.num=INSERT以外未定義となります．

初期化．ファイルパスは宣言時でもあとからSetしても同じです．

読み書きするファイルを変更できます．

filePathはprivate要素なので，こちらのメソッドで情報取得してください．

他のパラメータについても同様にSetとGetができます．

各ノートに必ずある，セクションNo,ノート長,歌詞，音高，先行発声を初期化して持っています．

オーバーラップ値をoveで初期化します．

オーバーラップ値をoveに変更し，UtauPlugin.Output()時書き出すようフラグを立てます．

1度でもオーバーラップをSetしていればtrueを，していなければfalseを返します．

初期化されていない場合もfalseを返します．

オーバーラップを初期化していればtrueを，していなければfalseを返します．

オーバーラップ値を取得します．

初期化をしていない場合初期値を返します．

他のパラメータも同様にInit,Has,Set,Get,IsChangedが使えます．

ただし，セクションNo,ノート長,歌詞，音高，先行発声はノート初期化時に必ずInitされるためHasはありません．

テンポ情報は数値計算上の利便性を考慮して，'UtauPlugin.Input()'時に必ずInitされるためHasはありません． NoteをINSERTした時必要になるので実装しました．

ピッチ(mode1用)

ピッチ(mode2用) mode2用のピッチのパラメータは内部的には一括で宣言され，各パラメータのInitはプラグインに書き出ししない値の登録のために使用されます．

読み取り専用のパラメータ

独自エントリ

その他特殊な操作

必要な操作は全てNoteからできるため説明略

必要な操作は全てNoteからできるため説明略

Noteから直接できない操作のみ説明 Note.envelopeがEnvelope型なので，'Note.envelope.GetP()'のような使い方を想定しています．

Noteから直接できない操作のみ説明 Note.vibratoがVibrato型なので，Note.vibrato.GetLength()のような使い方を想定しています． 以下の通り各パラメータのSetとGetができます．

プロパティに変更しました．Note.vibrato.Lengthのようにそのままアクセスできます．

要素としてstring DirPathを持ちます．

dirPathのルートにあるprefix.mapをDictionary <string, MapValue> VoiceBank.prefixMapに格納します．

keyはNote.GetNoteNumNameで取得できる音高名です．

Dictionary <string, Dictionary <string, MapValue>> VoiceBank.prefixMapsにprefix.mapを格納します．

dirPathのルートはprefixMaps[""]に， サブフォルダのprefix.mapがprefixMaps["dirName"]に格納されます．

dirPathのルートにあるoto.iniをDictionary <string, Oto> VoiceBank.otoに格納します．

keyは原音設定のエイリアスとファイル名が設定されます．

同一のキーがある場合先に読み込まれた内容が適用されます．

dirPath以下サブフォルダ内のoto.iniをDictionary <string, Oto> VoiceBank.otoに格納します．

標準ではdirPathの子フォルダまでですが，Recursive=trueとすると，再帰的に子フォルダからoto.iniを探します．

string Preとstring Su を持ちます．

WavLength値を返します．不明な場合，wavファイルにアクセスしてファイル長を求めます．

UTAUにはBlankが正の場合(wav末尾からの時間)と負の場合(Offsetからの時間の-1倍)の2種類の書式があります．

Blankの正負を逆にした値を計算し返します．