出力ファイル名変更

1. はじめに

2. タグリファレンス

3. 連番ルール

4. ルールと制限

5. 例

※このドキュメントにおけるGUIはWaifu2x-Extension-GUIを指します

はじめに

Waifu2x-Extension-GUIは出力ファイルに自動で名前を付けます。出力ファイル名変更設定ダイアログ(名前変更ボタンをクリックして開きます)で、出力ファイル名をカスタマイズできます。

ダイアログには3つのモードがあります:

デフォルト - エンジン内蔵の命名規則を維持します(カスタム名の変更は適用されません)。
シンプル組み合わせ - 要素(番号、エンジン、拡大率、ノイズ除去レベル、画質、ソース拡張子)を選んでファイル名の前後に配置し、コネクタ(_、スペース、-)で結合します。
高度なカスタム - タグからファイル名を構築します。出力フォルダを使用する場合用と、ソースと同じ場所への保存(ファイルはソースの隣に保存されます。出力フォルダが無効な場合も含みます)用の、2つの独立した書式文字列があります。

名前変更は、ファイルが保存され出力先に移動された後に適用されます。変更されるのはファイル名(ベース名)のみで、拡張子は一切変更されません。

元ファイル名保持が有効で出力フォルダを使用中の場合、または元ファイル置換が有効な場合、名前変更は適用されません。

タグリファレンス

タグ	説明
`<name>`	ソースファイルのベース名(拡張子を除く)。例: `CatPic.png` → `CatPic`。
`<ext>`	ソースファイルの拡張子(ドットを除く)。例: `CatPic.png` → `png`。
`<outext>`	出力ファイルの拡張子(ドットを除く)。
`<scale>`	拡大率(例: `2x`)。カスタム解像度が適用されている場合はカスタム解像度(例: `1920x1080`)。拡大を伴わない処理(形式変換のみ、フレーム補間のみ、重複フレーム削除のみ)では空文字列に展開されます。
`<denoise>`	ノイズ除去レベル。ノイズ除去オプションのないエンジン(RealESRGAN、RealSR、PyTorch、Maxine)および拡大を伴わない処理では、空文字列に展開されます。
`<engine>`	拡大エンジンの短縮名: `Waifu2xNcnn`, `Waifu2xCaffe`, `Waifu2xConverter`, `SrmdNcnn`, `SrmdCuda`, `RealSR`, `RealESRGAN`, `RealCUGAN`, `Anime4K`, `Maxine`, `PyTorch`。拡大エンジンを伴わない処理(形式変換のみ、フレーム補間のみ、重複フレーム削除のみ)では空文字列に展開されます。
`<number-pad>`	ソースフォルダ内の連番(ゼロパディング)。桁数はグループ内のファイル数に応じて変わります: 77ファイル → 2桁 → `07`。連番ルールを参照してください。
`<number-pad3>`	桁数を明示した連番。例: `<number-pad3>` → `007`。
`<number-pad3:date:desc>`	インラインソートキー付きの連番。使用可能なパラメータ: `name`, `date`, `asc`, `desc`。デフォルトは`name asc`です。
`<date:yyyy-MM-dd>`	ソースファイルの更新日時。Qtネイティブの書式トークン(`QDateTime::toString`の書式文字列)でフォーマットされます。一般的な例: `yyyy-MM-dd` → `2024-01-15`, `yyyyMMdd-hhmmss` → `20240115-103000`。
`<ImgQuality:separator>`	出力画像の画質。画像ファイルのみ。コネクタを内蔵しています: `cat<ImgQuality:_>` → `cat_Q95.jpg`。画像以外のファイル(GIF、動画)では空文字列に展開されます。

タグ名は大文字小文字を区別しません: <NAME>は<name>と同じです。

連番ルール

連番はソースフォルダごとに割り当てられ、1から始まります。
連番は処理開始時に割り当てられるため、ファイルの完了順序には依存しません。後で失敗またはスキップされたファイルは、他のファイルの番号に影響しません。
解像度ベースの自動スキップで自動的にスキップされるファイルは、番号の割り当て時に区別できないため、そのままカウントされ、連番に欠番が生じる場合があります。
シンプルモード: ソートキーはドロップダウンから選択します(ファイル名 / 更新日時、昇順のみ)。
高度なカスタムモード: ソートキーは連番タグ内にインラインで設定します(例: <number-pad:date>, <number-pad3:name:asc>, <number-pad3:date:desc>)。同じ書式文字列に異なるソートキーの連番タグが複数ある場合、最初のものが有効になります。
日付ソートおよび<date:...>に使用される更新日時は、処理開始時に取得されたスナップショットです。処理中にソースファイルを変更しても、展開される値は変わりません。

ルールと制限

タグ名は大文字小文字を区別しません。
区切り文字の折りたたみ。 タグが空文字列に展開された場合、両側に隣接する区切り文字(_、スペース、-)が1つずつ取り除かれます。例: a_<empty>_b → a_b。自分で記述した連続する区切り文字は保持されます: img_<name>__v2 → img_CatPic__v2。
無効な文字。 展開後のファイル名に\ / : * ? " < > |を含めることはできません。このチェックは展開結果にも適用されます。例えば<date:hh:mm:ss>は10:30:00に展開されますが、:を含むため拒否されます。
日付書式文字列内では、Qtのシングルクォートリテラル内であっても>を使用しないでください。タグは最初の>で終了するため、書式文字列が途中で切り詰められます。
名前変更で変更されるのはファイル名のみで、拡張子は変更されません。
対象のファイル名がすでに存在する場合、_1, _2, ...が自動的に付加されます。
元ファイル名保持が有効で出力フォルダを使用中の場合、または元ファイル置換が有効な場合、名前変更は適用されません。
実行時に名前変更を適用できない場合(例: 現在の処理で書式全体が空の名前に展開される、ファイルが使用中など)、元の出力ファイル名が保持され、ログに警告が表示されます。ファイルは失敗としてマークされません。

例

ソースファイル: CatPic.png、Waifu2xNcnnエンジン、2x、ノイズ除去レベル1、出力png。

<engine>_<name>_<scale>_<denoise> → Waifu2xNcnn_CatPic_2x_1.png
RealESRGANエンジン(ノイズ除去オプションなし)、4xで同じ書式: <engine>_<name>_<scale>_<denoise> → RealESRGAN_CatPic_4x.png(空の<denoise>により隣接する_が折りたたまれます)。
形式変換のみ(エンジン、拡大率、ノイズ除去なし): <engine>_<name>_<scale>_<denoise> → CatPic.png(3つのタグすべてが空で、すべての区切り文字が折りたたまれます)。
cat<ImgQuality:_> → 画像の場合cat_Q95.jpg。GIFまたは動画の場合はcat.jpgに展開されます。
<name>_<date:yyyy-MM-dd> → CatPic_2024-01-15.png(処理開始時点のソースの更新日時)。
<number-pad>_<name>、フォルダ内に77ファイルある場合: 7番目のファイル → 07_CatPic.png。
<number-pad3:date:desc>_<name> → 更新日時の降順、3桁: 003_CatPic.png。