API Example -- SALSA Runtime Setup (boxHead)
This example code works but is somewhat theoretical and includes configuration for demonstration purposes only. Please check the comments for details and remove the additional expression components applied to the viseme expressions if you prefer a more practical end result. Please also change the namespace to your standard/required namespace. This boxhead example demonstrates ShapeController implementation. Please see the Runtime Setup documentation for detailed information on run-time setup and configuration for other controller types.
NOTE: See the SALSA API documentation for API details.
using UnityEngine;
using CrazyMinnow.SALSA;
namespace DemoCode // change this to your custom namespace...
{
/// <summary>
/// The boxHead runtime script is included as an example of runtime implementation for SALSA and/or EmoteR.
/// This script creates additional (multiple) components on a viseme and emote which are for demonstration
/// purposes only and will not produce good results if left in place. Please remove these additional components
/// from the say medium viseme and the second (look down) for best results.
/// </summary>
public class BoxheadSalsaRuntime : MonoBehaviour
{
public static void BoxheadSalsaSetup(GameObject selectedObject)
{
var smr = selectedObject.GetComponent<SkinnedMeshRenderer>();
// Quick test to see if this object has the necessary stuff for SALSA
if (smr == null
|| smr.sharedMesh == null
|| smr.sharedMesh.blendShapeCount == 0
|| smr.sharedMesh.GetBlendShapeIndex("saySml") == -1
|| smr.sharedMesh.GetBlendShapeIndex("sayMed") == -1
|| smr.sharedMesh.GetBlendShapeIndex("sayLrg") == -1)
{
Debug.Log("This object does not have the required components.");
return;
}
// Configure AudioSource for demonstration.
var audSrc = selectedObject.GetComponent<AudioSource>();
if (audSrc == null)
audSrc = selectedObject.AddComponent<AudioSource>();
// Optional: set your audio source for your preferences...
audSrc.playOnAwake = false;
audSrc.loop = false;
// Remember to add an AudioClip to your AudioSource...
// audSrc.clip = someAudioClip;
// Remember to play your AudioSource in your code (after configuration)
// to start automatic lip-synchronization.
// Something like: CrazyMinnow.SALSA.Salsa.audioSrc.Play();
// Setup a new queue processor if we don't find one. Recommend using one
// queue processor per character (especially advanced characters with many
// components).
var qp = selectedObject.GetComponent<QueueProcessor>();
if (qp == null)
qp = selectedObject.AddComponent<QueueProcessor>();
// Configure SALSA
var salsa = selectedObject.GetComponent<Salsa>();
if (salsa == null)
salsa = selectedObject.AddComponent<Salsa>();
salsa.audioSrc = audSrc;
salsa.queueProcessor = qp;
// adjust salsa settings
// - data analysis settings
salsa.autoAdjustAnalysis = true;
salsa.autoAdjustMicrophone = false;
salsa.audioUpdateDelay = 0.0875f;
// - advanced dynamics
salsa.loCutoff = 0.015f;
salsa.hiCutoff = 0.75f;
salsa.useAdvDyn = true;
salsa.advDynPrimaryBias = 0.40f;
salsa.useAdvDynJitter = true;
salsa.advDynJitterAmount = 0.10f;
salsa.advDynJitterProb = 0.20f;
salsa.advDynSecondaryMix = 0.0f;
// setup visemes
salsa.visemes.Clear(); // start fresh
// setup viseme 1 -- saySmall
salsa.visemes.Add(new LipsyncExpression("saySmall", new InspectorControllerHelperData(), 0f));
var saySmallViseme = salsa.visemes[0].expData; // cache the say small viseme...
// Create an expression component for the say small viseme...
// NOTE: when a viseme is created, the first component is automatically created
// and default values are used. The default control type is automatically set
// to shape (blendshape)...so we do not need to manually set it.
saySmallViseme.components[0].name = "saySmall component";
saySmallViseme.controllerVars[0].smr = smr;
saySmallViseme.controllerVars[0].blendIndex = smr.sharedMesh.GetBlendShapeIndex("saySml");
saySmallViseme.controllerVars[0].minShape = 0f;
saySmallViseme.controllerVars[0].maxShape = 1f;
// setup viseme 2 -- sayMedium
salsa.visemes.Add(new LipsyncExpression("sayMedium", new InspectorControllerHelperData(), 0f));
var sayMediumViseme = salsa.visemes[1].expData; // cache the say medium viseme...
// create an expression component for the sayMedium viseme...
sayMediumViseme.components[0].name = "sayMedium component";
sayMediumViseme.controllerVars[0].smr = smr;
sayMediumViseme.controllerVars[0].blendIndex = smr.sharedMesh.GetBlendShapeIndex("sayMed");
sayMediumViseme.controllerVars[0].minShape = 0f;
sayMediumViseme.controllerVars[0].maxShape = 1f;
// ============================= Optional/theoretical example code:
// To add extra components to a viseme,
// add new .controllerVars and .components list elements
// then adjust settings...
// NOTE: the following adds the say large blendshape as a
// second component on the say medium viseme expression,
// this is not practical and is only for demonstration purposes...
// The first component's helper and component data entries are
// created automatically when a new viseme is created. When adding
// more components to a viseme, it is necessary to manually add
// the helper and component items to the respective lists.
sayMediumViseme.controllerVars.Add(new InspectorControllerHelperData());
sayMediumViseme.components.Add(new ExpressionComponent());
// Now configure the second component...
sayMediumViseme.components[1].name = "sayLarge component";
sayMediumViseme.components[1].durationOn = .08f;
sayMediumViseme.components[1].durationOff = .06f;
// It is necessary to set the easing and control type on subsequently added components.
sayMediumViseme.components[1].easing = LerpEasings.EasingType.CubicOut;
sayMediumViseme.components[1].controlType = ExpressionComponent.ControlType.Shape;
sayMediumViseme.controllerVars[1].smr = smr;
sayMediumViseme.controllerVars[1].blendIndex = smr.sharedMesh.GetBlendShapeIndex("sayLrg");
sayMediumViseme.controllerVars[1].minShape = 0f;
sayMediumViseme.controllerVars[1].maxShape = 1f;
// ====================================================== etc...
// setup viseme 3 -- sayLarge
salsa.visemes.Add(new LipsyncExpression("sayLarge", new InspectorControllerHelperData(), 0f));
var sayLargeViseme = salsa.visemes[2].expData;
sayLargeViseme.components[0].name = "sayLarge component";
sayLargeViseme.controllerVars[0].smr = smr;
sayLargeViseme.controllerVars[0].blendIndex = smr.sharedMesh.GetBlendShapeIndex("sayLrg");
sayLargeViseme.controllerVars[0].minShape = 0f;
sayLargeViseme.controllerVars[0].maxShape = 1f;
// apply api trigger distribution...
salsa.DistributeTriggers(LerpEasings.EasingType.SquaredIn);
// at runtime: apply controller baking...
salsa.UpdateExpressionControllers();
}
}
}
Test Your Runtime Code...
This isn't runtime, but you can use it to quickly test to see if your setup code (above) works (at design time) by calling an editor function...something like the following...
Select the boxhead model in your scene and then select the Unity menu item: GameObject > DemoCode > SALSA LipSync > DemoCode Boxhead SALSA Config (or whatever you have configured the menu item to be in the below script).
using UnityEditor;
using UnityEngine;
using CrazyMinnow.SALSA; // used to setup the audio clip.
using CrazyMinnow.SALSA.OneClicks; // only used to fetch the promo audio clip location...
namespace DemoCode // change this to your custom namespace...
{
public class BoxheadSalsaRuntimeTester : Editor
{
[MenuItem("GameObject/DemoCode/SALSA LipSync/DemoCode Boxhead Salsa Config")]
public static void SetupBoxheadSalsa()
{
var selectedObject = Selection.activeGameObject;
// NOTE: BoxheadSalsaRuntime is in the DemoCode namespace by default...
BoxheadSalsaRuntime.BoxheadSalsaSetup(selectedObject);
// An example of loading the demo promo audio clip into the audio source...
// NOTE: In the above script, the AudioSource was set to not 'play on awake', so
// be sure to play the audio source when you play your scene. See AudioSource
// configuration in the BoxheadSalsaRuntime code above.
var salsa = selectedObject.GetComponent<Salsa>();
if (salsa != null && salsa.audioSrc != null)
salsa.audioSrc.clip = AssetDatabase.LoadAssetAtPath<AudioClip>(OneClickBase.RESOURCE_CLIP);
}
}
}