カスタムコーデック

デフォルトの Luma4 テクスチャ表現がトランスポートのニーズと一致しない場合は、コーデックを作成します。

コーデック契約は単純です。

Core provides header bytes and payload bytes.
The codec writes those bytes into pixels.
The decoder uses the codec to recover the same bytes.

シェーダーレベルの完全なチュートリアルについては、コーデック実装ガイドを参照してください。

コアシェーダに含まれるもの

カスタムデコードシェーダは通常、2 つのコア cginc ファイルを使用します。

含む	用途:	API
`TSMPDecodeCommon.cginc`	共有デコードユニフォーム、`appdata`/`v2f`、頂点関数、ブロックサンプリングヘルパー、輝度サンプリング、および YCoCg 変換ヘルパー。	スクリプト API: `TSMPDecodeCommon.cginc`
`TSMPDecodeByteOutput.cginc`	バイトインデックス付きの `DecodeByte(index)` 関数を、デコーダによって読み取られた RGBA バイト出力テクスチャに変換します。	スクリプト API: `TSMPDecodeByteOutput.cginc`

シェーダで共有 TSMPDecodeCommon.cginc、v2f、_MainTex、_BlockSize、_SampleSize、_StartBlock、_ByteCount、_ActiveWidthBlocks、_SourceWidth、_SourceHeight、_OutputWidth、または _OutputHeight が必要な場合は、最初に _FlipY を含めます。契約。コーデックのバイトリカバリ機能を実装した後、TSMPDecodeByteOutput.cginc を含めます。

パッケージの形状

推奨されるパッケージレイアウト:

com.example.tsmp.codec.mycodec/
  package.json
  Runtime/
    Scripts/
    Shaders/
    Materials/
    Prefabs/
  Samples/

パッケージは以下に依存する必要があります。

"com.kibalab.tsmp.core": "0.0.3-beta.1"

パッケージが VRChat ユーザーを対象としている場合は、VPM 依存関係メタデータも使用します。

ランタイムクラス

TSMPCodec を拡張するコンポーネントを作成します。

using K13A.TSMP;
using UnityEngine;

public sealed class TSMPCodecMyCodec : TSMPCodec
{
    private const int SymbolModeMyCodec = 128;

    public Material byteDecodeMaterial;

    public override int GetEncoderSymbolMode()
    {
        return SymbolModeMyCodec;
    }

    public override int GetEncoderPayloadStartRow(int width, int blockSize)
    {
        return 5;
    }

    public override int GetEncoderPayloadCapacityBytes(int width, int height, int blockSize)
    {
        return 0;
    }

    public override bool WriteEncoderPayload(
        Color32[] pixels,
        int width,
        int height,
        int blockSize,
        byte[] payloadBytes,
        int payloadByteCount)
    {
        return false;
    }

    public override void ApplyDecodeOptions()
    {
        selectedDecodeMaterial = byteDecodeMaterial;
    }

#if !COMPILER_UDONSHARP
    public override int SymbolMode => SymbolModeMyCodec;
#endif
}

このスケルトンは意図的に不完全です。実際のコーデックはペイロードバイトを書き込み、一致するデコードシェーダ/マテリアルの動作を提供する必要があります。

必要なエンコーダメソッド

方法	要件
`GetEncoderSymbolMode()`	フレームヘッダーに書き込まれたシンボルモードを返します。
`GetEncoderPayloadStartRow(...)`	ペイロードブロックがどこから始まるかを Core に伝えます。
`GetEncoderPayloadCapacityBytes(...)`	適合するペイロードバイト数を Core に伝えます。
`WriteEncoderPayload(...)`	提供されたピクセルバッファにペイロードバイトを書き込みます。

UdonSharp の互換性を維持するために、ロジックを単純にし、サポートされていない C# 構造を避けてください。

パッケージに安定したシンボルモード値を選択し、インストールされている他のコーデックとの衝突を回避します。コアのエンコーダーとデコーダーは、フレームヘッダーを通じてこの値を渡します。コーデックパッケージにはその意味があります。

コーデックのオプション

コーデックは、フレームヘッダーで最大 5 つのオプションバイトを公開できます。

オーバーライド：

デコーダは、codecOptionBytes が呼び出される前に、ApplyDecodeOptions() を通じてこれらのバイトを受信します。

オプションバイトは、フレームをデコードするために必要な値にのみ使用します。エディタ専用の表示データには使用しないでください。

デコーダーマテリアル

ネイティブ/エディターのデコードをサポートするには、Udon 以外のパス内でこれらをオーバーライドします。

実行時デコードの場合、ApplyDecodeOptions() は次のようなフィールドを設定する必要があります。

selectedDecodeMaterial
payloadStartRow
payloadBlockCount
シェーダに必要なコーデック固有の状態

ネイティブエディターの作成

コーデックがエディター/ネイティブ C# パスにフレームを書き込む必要がある場合は、次を実装します。

UdonSharp が使用できない API を使用する場合は、このメソッドを #if !COMPILER_UDONSHARP 内に保持してください。

＃＃登録

TSMPSetup に掲載するには:

コーデックコンポーネントをプレハブに配置します。
安定した codecId を設定します。
読み取り可能な displayName を設定します。
package.json にパッケージのメタデータを含めます。
プレハブを参照する TSMPCodecCatalog を追加または生成します。
TSMPSetup でコーデックを更新します。

エンコーダはコーデッククラスを直接参照しないでください。 TSMPCodec API を介して検出して呼び出す必要があります。

検証チェックリスト

エンコーダのペイロード容量は正しい。
ヘッダー領域とペイロード領域は重なりません。
コーデックオプションバイトはデコーダ状態に往復します。
出力は未使用領域をクリアします。
デコーダーは破損したヘッダーを拒否します。
コーデックは Unity Play モードおよび UdonSharp ランタイムで動作します。