godot/servers/xr/xr_face_tracker.cpp

/**************************************************************************/
/*  xr_face_tracker.cpp                                                   */
/**************************************************************************/
/*                         This file is part of:                          */
/*                             GODOT ENGINE                               */
/*                        https://godotengine.org                         */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
/*                                                                        */
/* Permission is hereby granted, free of charge, to any person obtaining  */
/* a copy of this software and associated documentation files (the        */
/* "Software"), to deal in the Software without restriction, including    */
/* without limitation the rights to use, copy, modify, merge, publish,    */
/* distribute, sublicense, and/or sell copies of the Software, and to     */
/* permit persons to whom the Software is furnished to do so, subject to  */
/* the following conditions:                                              */
/*                                                                        */
/* The above copyright notice and this permission notice shall be         */
/* included in all copies or substantial portions of the Software.        */
/*                                                                        */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
/**************************************************************************/

#include "xr_face_tracker.h"

void XRFaceTracker::_bind_methods() {
	// Base Shapes
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_OUT_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_IN_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_UP_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_DOWN_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_OUT_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_IN_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_UP_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_LOOK_DOWN_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_CLOSED_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_CLOSED_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_SQUINT_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_SQUINT_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_WIDE_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_WIDE_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_DILATION_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_DILATION_LEFT);
	BIND_ENUM_CONSTANT(FT_EYE_CONSTRICT_RIGHT);
	BIND_ENUM_CONSTANT(FT_EYE_CONSTRICT_LEFT);
	BIND_ENUM_CONSTANT(FT_BROW_PINCH_RIGHT);
	BIND_ENUM_CONSTANT(FT_BROW_PINCH_LEFT);
	BIND_ENUM_CONSTANT(FT_BROW_LOWERER_RIGHT);
	BIND_ENUM_CONSTANT(FT_BROW_LOWERER_LEFT);
	BIND_ENUM_CONSTANT(FT_BROW_INNER_UP_RIGHT);
	BIND_ENUM_CONSTANT(FT_BROW_INNER_UP_LEFT);
	BIND_ENUM_CONSTANT(FT_BROW_OUTER_UP_RIGHT);
	BIND_ENUM_CONSTANT(FT_BROW_OUTER_UP_LEFT);
	BIND_ENUM_CONSTANT(FT_NOSE_SNEER_RIGHT);
	BIND_ENUM_CONSTANT(FT_NOSE_SNEER_LEFT);
	BIND_ENUM_CONSTANT(FT_NASAL_DILATION_RIGHT);
	BIND_ENUM_CONSTANT(FT_NASAL_DILATION_LEFT);
	BIND_ENUM_CONSTANT(FT_NASAL_CONSTRICT_RIGHT);
	BIND_ENUM_CONSTANT(FT_NASAL_CONSTRICT_LEFT);
	BIND_ENUM_CONSTANT(FT_CHEEK_SQUINT_RIGHT);
	BIND_ENUM_CONSTANT(FT_CHEEK_SQUINT_LEFT);
	BIND_ENUM_CONSTANT(FT_CHEEK_PUFF_RIGHT);
	BIND_ENUM_CONSTANT(FT_CHEEK_PUFF_LEFT);
	BIND_ENUM_CONSTANT(FT_CHEEK_SUCK_RIGHT);
	BIND_ENUM_CONSTANT(FT_CHEEK_SUCK_LEFT);
	BIND_ENUM_CONSTANT(FT_JAW_OPEN);
	BIND_ENUM_CONSTANT(FT_MOUTH_CLOSED);
	BIND_ENUM_CONSTANT(FT_JAW_RIGHT);
	BIND_ENUM_CONSTANT(FT_JAW_LEFT);
	BIND_ENUM_CONSTANT(FT_JAW_FORWARD);
	BIND_ENUM_CONSTANT(FT_JAW_BACKWARD);
	BIND_ENUM_CONSTANT(FT_JAW_CLENCH);
	BIND_ENUM_CONSTANT(FT_JAW_MANDIBLE_RAISE);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_UPPER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_UPPER_LEFT);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_LOWER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_LOWER_LEFT);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_CORNER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_CORNER_LEFT);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL_UPPER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL_UPPER_LEFT);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL_LOWER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL_LOWER_LEFT);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER_UPPER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER_UPPER_LEFT);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER_LOWER_RIGHT);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER_LOWER_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_UP_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_UP_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_LOWER_DOWN_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_LOWER_DOWN_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_DEEPEN_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_DEEPEN_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_LOWER_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_LOWER_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_CORNER_PULL_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_CORNER_PULL_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_CORNER_SLANT_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_CORNER_SLANT_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_FROWN_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_FROWN_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_STRETCH_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_STRETCH_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_DIMPLE_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_DIMPLE_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_RAISER_UPPER);
	BIND_ENUM_CONSTANT(FT_MOUTH_RAISER_LOWER);
	BIND_ENUM_CONSTANT(FT_MOUTH_PRESS_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_PRESS_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_TIGHTENER_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_TIGHTENER_LEFT);
	BIND_ENUM_CONSTANT(FT_TONGUE_OUT);
	BIND_ENUM_CONSTANT(FT_TONGUE_UP);
	BIND_ENUM_CONSTANT(FT_TONGUE_DOWN);
	BIND_ENUM_CONSTANT(FT_TONGUE_RIGHT);
	BIND_ENUM_CONSTANT(FT_TONGUE_LEFT);
	BIND_ENUM_CONSTANT(FT_TONGUE_ROLL);
	BIND_ENUM_CONSTANT(FT_TONGUE_BLEND_DOWN);
	BIND_ENUM_CONSTANT(FT_TONGUE_CURL_UP);
	BIND_ENUM_CONSTANT(FT_TONGUE_SQUISH);
	BIND_ENUM_CONSTANT(FT_TONGUE_FLAT);
	BIND_ENUM_CONSTANT(FT_TONGUE_TWIST_RIGHT);
	BIND_ENUM_CONSTANT(FT_TONGUE_TWIST_LEFT);
	BIND_ENUM_CONSTANT(FT_SOFT_PALATE_CLOSE);
	BIND_ENUM_CONSTANT(FT_THROAT_SWALLOW);
	BIND_ENUM_CONSTANT(FT_NECK_FLEX_RIGHT);
	BIND_ENUM_CONSTANT(FT_NECK_FLEX_LEFT);
	// Blended Shapes
	BIND_ENUM_CONSTANT(FT_EYE_CLOSED);
	BIND_ENUM_CONSTANT(FT_EYE_WIDE);
	BIND_ENUM_CONSTANT(FT_EYE_SQUINT);
	BIND_ENUM_CONSTANT(FT_EYE_DILATION);
	BIND_ENUM_CONSTANT(FT_EYE_CONSTRICT);
	BIND_ENUM_CONSTANT(FT_BROW_DOWN_RIGHT);
	BIND_ENUM_CONSTANT(FT_BROW_DOWN_LEFT);
	BIND_ENUM_CONSTANT(FT_BROW_DOWN);
	BIND_ENUM_CONSTANT(FT_BROW_UP_RIGHT);
	BIND_ENUM_CONSTANT(FT_BROW_UP_LEFT);
	BIND_ENUM_CONSTANT(FT_BROW_UP);
	BIND_ENUM_CONSTANT(FT_NOSE_SNEER);
	BIND_ENUM_CONSTANT(FT_NASAL_DILATION);
	BIND_ENUM_CONSTANT(FT_NASAL_CONSTRICT);
	BIND_ENUM_CONSTANT(FT_CHEEK_PUFF);
	BIND_ENUM_CONSTANT(FT_CHEEK_SUCK);
	BIND_ENUM_CONSTANT(FT_CHEEK_SQUINT);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_UPPER);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK_LOWER);
	BIND_ENUM_CONSTANT(FT_LIP_SUCK);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL_UPPER);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL_LOWER);
	BIND_ENUM_CONSTANT(FT_LIP_FUNNEL);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER_UPPER);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER_LOWER);
	BIND_ENUM_CONSTANT(FT_LIP_PUCKER);
	BIND_ENUM_CONSTANT(FT_MOUTH_UPPER_UP);
	BIND_ENUM_CONSTANT(FT_MOUTH_LOWER_DOWN);
	BIND_ENUM_CONSTANT(FT_MOUTH_OPEN);
	BIND_ENUM_CONSTANT(FT_MOUTH_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_SMILE_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_SMILE_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_SMILE);
	BIND_ENUM_CONSTANT(FT_MOUTH_SAD_RIGHT);
	BIND_ENUM_CONSTANT(FT_MOUTH_SAD_LEFT);
	BIND_ENUM_CONSTANT(FT_MOUTH_SAD);
	BIND_ENUM_CONSTANT(FT_MOUTH_STRETCH);
	BIND_ENUM_CONSTANT(FT_MOUTH_DIMPLE);
	BIND_ENUM_CONSTANT(FT_MOUTH_TIGHTENER);
	BIND_ENUM_CONSTANT(FT_MOUTH_PRESS);
	BIND_ENUM_CONSTANT(FT_MAX);

	ClassDB::bind_method(D_METHOD("get_blend_shape", "blend_shape"), &XRFaceTracker::get_blend_shape);
	ClassDB::bind_method(D_METHOD("set_blend_shape", "blend_shape", "weight"), &XRFaceTracker::set_blend_shape);

	ClassDB::bind_method(D_METHOD("get_blend_shapes"), &XRFaceTracker::get_blend_shapes);
	ClassDB::bind_method(D_METHOD("set_blend_shapes", "weights"), &XRFaceTracker::set_blend_shapes);
	ADD_PROPERTY(PropertyInfo(Variant::PACKED_FLOAT32_ARRAY, "blend_shapes"), "set_blend_shapes", "get_blend_shapes");
	ADD_PROPERTY_DEFAULT("blend_shapes", PackedFloat32Array()); // To prevent ludicrously large default values.
}

void XRFaceTracker::set_tracker_type(XRServer::TrackerType p_type) {
	ERR_FAIL_COND_MSG(p_type != XRServer::TRACKER_FACE, "XRFaceTracker must be of type TRACKER_FACE.");
}

float XRFaceTracker::get_blend_shape(BlendShapeEntry p_blend_shape) const {
	// Fail if the blend shape index is out of range.
	ERR_FAIL_INDEX_V(p_blend_shape, FT_MAX, 0.0f);

	// Return the blend shape value.
	return blend_shape_values[p_blend_shape];
}

void XRFaceTracker::set_blend_shape(BlendShapeEntry p_blend_shape, float p_value) {
	// Fail if the blend shape index is out of range.
	ERR_FAIL_INDEX(p_blend_shape, FT_MAX);

	// Save the new blend shape value.
	blend_shape_values[p_blend_shape] = p_value;
}

PackedFloat32Array XRFaceTracker::get_blend_shapes() const {
	// Create a packed float32 array and copy the blend shape values into it.
	PackedFloat32Array data;
	data.resize(FT_MAX);
	memcpy(data.ptrw(), blend_shape_values, sizeof(blend_shape_values));

	// Return the blend shape array.
	return data;
}

void XRFaceTracker::set_blend_shapes(const PackedFloat32Array &p_blend_shapes) {
	// Fail if the blend shape array is not the correct size.
	ERR_FAIL_COND(p_blend_shapes.size() != FT_MAX);

	// Copy the blend shape values into the blend shape array.
	memcpy(blend_shape_values, p_blend_shapes.ptr(), sizeof(blend_shape_values));
}

XRFaceTracker::XRFaceTracker() {
	type = XRServer::TRACKER_FACE;
}