Files
sbox-public/engine/Sandbox.Engine/Resources/Sound/SoundFile.Visemes.cs
Garry Newman 4fd85ce69d Add SkinnedModelRenderer.SpeakSound with baked viseme lipsync; remove dead native code (#5306)
// SkinnedModelRenderer - the only new entry point for speaking
SoundHandle SpeakSound( SoundEvent sound, GameObject mouth = null )
SoundHandle SpeakSound( SoundFile sound, float volume = 1, float pitch = 1, GameObject mouth = null )

// SoundFile - the authored lipsync track, read from the compiled vsnd
VisemeTrack Visemes { get; }   // null = no track (or not loaded yet, see IsValidForPlayback)

// VisemeTrack - visemes over time, authored in the sound editor
IReadOnlyList<VisemeFrame> Frames { get; }
float Duration { get; }
bool Sample( float time, Span<float> weights )

// VisemeFrame - one viseme span (struct: Viseme, StartTime, EndTime)

// Visemes - the standard 15-viseme table, OVR order
static IReadOnlyList<string> MorphNames { get; }
static int Count { get; }

// MorphCollection - the one shared viseme blend (sounds, voice chat, editor preview)
void ApplyVisemes( ReadOnlySpan<float> visemeWeights, float scale = 1, float smoothTime = 0 )

// ModelMorphs - per-model viseme weight table, cached managed-side (no interop on lookups)
float GetVisemeMorph( int viseme, int morph )
float GetVisemeMorph( string viseme, int morph )

// ResourceCompileContext - inject managed data into natively-compiled resources
void WriteBlock( string blockName, ReadOnlySpan<byte> data )   // four-char block names, eg "LIPS"
void WriteBlockJson( string blockName, object obj )
JsonObject ReadMeta()                                          // the asset's .meta, registers a compile dependency
T ReadMeta<T>( string key, T defaultValue = default )

// ResourceLoadContext - read blocks back when the resource loads (Resource.OnLoaded, engine-internal for now)
// public ref struct, only valid during the load callback
bool Exists( string blockName )
ReadOnlySpan<byte> ReadData( string blockName )
string ReadString( string blockName )
T ReadJson<T>( string blockName, T defaultValue = default )
2026-07-09 20:04:02 +01:00

31 lines
1.1 KiB
C#

namespace Sandbox;
public partial class SoundFile
{
/// <summary>
/// Name of the custom resource block holding the viseme frames in a compiled
/// sound. Injected at compile time by the managed sound compiler from the
/// visemes authored in the sound editor (stored in the sound's .meta).
/// </summary>
internal const string VisemeBlockName = "LIPS";
/// <summary>
/// The lipsync track for this sound, or null if it doesn't have one. Authored
/// in the sound editor's viseme timeline. Read from the compiled file when the
/// sound resource loads - check <see cref="IsValidForPlayback"/> to tell
/// "no track" apart from "not loaded yet".
/// </summary>
public VisemeTrack Visemes { get; private set; }
/// <summary>
/// Read the viseme track out of the sound's compiled file data. Called when
/// the sound resource loads or reloads.
/// </summary>
void ReadVisemes( ResourceLoadContext context )
{
var frames = context.ReadJson<List<VisemeFrame>>( VisemeBlockName );
Visemes = frames is { Count: > 0 } ? new VisemeTrack( frames ) : null;
}
}