Mouth shape analysis module More...

Inheritance diagram for CriLipsMouth:

Classes
struct	Info
	Mouth shape information structure More...

struct	MorphTargetBlendAmountAsJapanese
	Japanese 5 vowel morph target blend amount structure More...

struct	OpenInfo
	1-dimensional Mouth Shape Information Structure More...

Public Types
enum	MorphTargetType { Japanese_AIUEO = 0, MAX_NUM }
	Morph target type More...

enum	BehaviourParamsPreset { Default = 0, NoBlend }
	Presets of behaviour parameters More...

Public Member Functions
float	GetSilenceThreshold ()
	Gets the silence determination volume threshold More...

void	GetInfo (out Info info)
	Gets the mouth shape information More...

void	GetMorphTargetBlendAmountAsJapanese (out MorphTargetBlendAmountAsJapanese morph)
	Gets the Japanese 5 vowel morph target blend amount More...

void	GetOpenInfo (out OpenInfo openInfo)
	Obtaining the 1-dimensional mouth shape information More...

float	GetVolume ()
	Gets volume More...

void	GetInfoAtSilence (out Info info)
	Gets the mouth shape information in the closed state More...

bool	IsAtSilence ()
	Check if there is no voice and the mouth is closed More...

bool	IsAtSilenceForMouthOpen ()
	Check if there is no voice and the mouth is closed (1-dimensional) More...

bool	IsMorphTargetBlendAmountInterpolative ()
	Whether the blend amount is interpolative More...

override void	Dispose ()
	Discards the LipsMouth handle More...

Static Public Member Functions
static void	ConvertMorphTargetBlendAmountToArray (MorphTargetBlendAmountAsJapanese inputMorph, float[] outputArray)
	Converts the morph target blend amounts for the Japanese 5-vowels into an array More...

static void	ConvertArrayToMorphTargetBlendAmount (float[] inputArray, ref MorphTargetBlendAmountAsJapanese outputMorph)
	Conversion of the Japanese 5 vowel morph target blend amounts from an array to a structure More...

Detailed Description

Mouth shape analysis module

Description:: An analysis module class used for sound analysis.
The mouth shape information can be acquired by inputting PCM sample data and performing analysis processing.

Member Enumeration Documentation

enum MorphTargetType

strong

Morph target type

Description:: Morph target type included in the mouth shape information structure.

Enumerator
Japanese_AIUEO	Japanese “A[ɑ]、I[i]、U[u]、E[ɛ]、O[ɔ]”
MAX_NUM	The number of morph target types

enum BehaviourParamsPreset

strong

Presets of behaviour parameters

Description:: Presets of parameters related to the behaviour of the object.

Enumerator
Default	Default preset
NoBlend	Preset for models that do not support blending

Member Function Documentation

float GetSilenceThreshold ( )

inline

Gets the silence determination volume threshold

Returns: Maximum volume (dB)

Description:: Gets the volume (dB) below which the sample to be analyzed
by the CriLipsMouth::Process function is considered as silence.

Note:: Returns a value greater than 0 if an error occurred.

See also: CriLipsMouth::Process

Implements ICriLipsAnalyzeModule.

void GetInfo ( out Info info )

inline

Gets the mouth shape information

Parameters

info	Mouth shape information

Description:: Gets the mouth shape information obtained by analyzing the input PCM sample.
When analysis is not performed using the CriLipsMouth::Process function, the mouth shape information in the closed state is acquired.

See also: CriLipsMouth::Process

Implements ICriLipsAnalyzeModule.

void GetMorphTargetBlendAmountAsJapanese ( out MorphTargetBlendAmountAsJapanese morph )

inline

Gets the Japanese 5 vowel morph target blend amount

Parameters

morph Japanese 5 vowel morph target blend amount

Description:: Gets the Japanese 5 vowel morph target blend amount obtained by analyzing the input PCM sample.
When analysis is not performed using the CriLipsMouth::Process function, the blend amount information in the closed state is acquired.

See also: CriLipsMouth::Process

Implements ICriLipsAnalyzeModule.

void GetOpenInfo ( out OpenInfo openInfo )

inline

Obtaining the 1-dimensional mouth shape information

Parameters

openInfo 1-dimensional mouth shape information

Description:: Returns the mouth shape information for a model which has a 1-dimensional control for opening or closing the mouth.
If no analysis was performed with the CriLipsMouth::Process function, it will return the closed mouth shape.

See also: CriLipsMouth::Process

Implements ICriLipsAnalyzeModule.

static void ConvertMorphTargetBlendAmountToArray	(	MorphTargetBlendAmountAsJapanese	inputMorph,
		float[]	outputArray
	)

inlinestatic

Converts the morph target blend amounts for the Japanese 5-vowels into an array

Parameters

inputMorph	Japanese 5 vowel morph target blend amount
outputArray	The array that stores the converted information

Description:: Converts the morph target blend amounts for the Japanese 5-vowels into an array.

Note:: The float array passed as an argument should have a length greater or equal to 5.

static void ConvertArrayToMorphTargetBlendAmount	(	float[]	inputArray,
		ref MorphTargetBlendAmountAsJapanese	outputMorph
	)

inlinestatic

Conversion of the Japanese 5 vowel morph target blend amounts from an array to a structure

Parameters

inputArray	Array containing information of the Japanese 5-vowels morph target blend amounts
outputMorph	The structure that stores the converted information

Description:: Converts the Japanese 5 vowels morph target blend amounts (which are input as a float array) into a structure.

float GetVolume ( )

inline

Gets volume

Returns: Volume of the analyzed sample (dB)

Description:: Gets the volume (dB) of the sample analyzed by the CriLipsMouth::Process function.

Note:: Returns a value greater than 0 if an error occurred.

See also: CriLipsMouth::Process

Implements ICriLipsAnalyzeModule.

void GetInfoAtSilence ( out Info info )

inline

Gets the mouth shape information in the closed state

Parameters

info	Mouth shape information

Description:: Gets the mouth shape information in the closed state that can be acquired immediately after creating a handle or when silence is entered.

Implements ICriLipsAnalyzeModule.

bool IsAtSilence ( )

inline

Check if there is no voice and the mouth is closed

Returns: true when the mouth is closed; false otherwise

Description:: Whether the current state is "not being pronounced" (i.e. the mouth is closed).

See also: CriLipsMouth::Process, CriLipsMouth.IsAtSilenceForMouthOpen

Implements ICriLipsAnalyzeModule.

bool IsAtSilenceForMouthOpen ( )

inline

Check if there is no voice and the mouth is closed (1-dimensional)

Returns: true when the mouth is closed; false otherwise

Description:: Return whether the current state is silent (mouth closed).
Depending on the smoothing filtering parameter of the 1-dimensional lip-sync analysis process,
even if CriLipsMouth.IsAtSilence returns true,
this function may still determine that the mouth is opened and return false.

See also: CriLipsMouth.IsAtSilence

Implements ICriLipsAnalyzeModule.

bool IsMorphTargetBlendAmountInterpolative ( )

inline

Whether the blend amount is interpolative

Returns: CRI_TRUE if interpolation is used, CRI_FALSE otherwise

Description:: Whether the acquired blend amount is generated by interpolating between morph targets.

Implements ICriLipsAnalyzeModule.

override void Dispose ( )

inline

Discards the LipsMouth handle

Description:: Discards the LipsMouth handle.

See also: CriLipsMouth::CriLipsMouth

The documentation for this class was generated from the following file:

CriLips.cs

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation