add stubs for Puppet2d and LipSync, add metadata util, add build script, update lib name in Cargo.toml

Author: you-win

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "vpuppr-rust-lib"
+name = "libvpuppr"
 version = "0.1.0"
 edition = "2021"
 authors = ["Tim Yuen<[email protected]>"]

README.md

@@ -5,6 +5,12 @@ with [godot-rust](https://github.com/godot-rust/gdext) for [vpuppr](https://gith
 
 This repository is meant to be used as a git submodule in the main vpuppr repository.
 
+## Building
+
+Run `python build.py --help` for possible options. This is a simple wrapper around
+`cargo build` and `cargo build --release` that also renames the output libraries
+to `libvpuppr.dll` or `libvpuppr.so` depending on platform.
+
 ## License
 
 MPL-2.0

build.py

@@ -0,0 +1,107 @@
+# /usr/bin/env python
+
+"""
+Utility script for building consistent shared libraries for vpuppr.
+"""
+
+import os
+from os import path
+import subprocess
+from argparse import ArgumentParser
+from typing import Union, List
+from enum import Enum
+import platform
+
+
+# NOTE: this is technically the wrong way to name shared libs on Windows but whatever
+LIB_NAME_FORMAT: str = "libvpuppr.{}"
+
+
+def get_output_dir() -> Union[str, None]:
+    """
+    The output path for `cargo build`.
+    """
+    script_dir: str = path.dirname(__file__)
+    output_dir: str = path.join(script_dir, "target")
+
+    return output_dir if path.isdir(output_dir) else None
+
+
+class BuildFlag(Enum):
+    DEBUG = 0
+    RELEASE = 1
+
+
+def build(flag: BuildFlag) -> None:
+    command: List[str] = ["cargo", "build"]
+
+    if flag == BuildFlag.RELEASE:
+        command.append("--release")
+
+    ret = subprocess.run(command, text=True)
+
+    if ret.returncode != 0:
+        raise Exception("Failed to build: {}".format(ret.stderr))
+
+    output_dir = get_output_dir()
+    if not output_dir:
+        raise Exception("Unable to get output directory")
+
+    if flag == BuildFlag.DEBUG:
+        output_dir = "{}/debug".format(output_dir)
+    elif flag == BuildFlag.RELEASE:
+        output_dir = "{}/release".format(output_dir)
+    else:
+        raise Exception("Bad build flag: {}".format(flag))
+
+    if not path.isdir(output_dir):
+        raise Exception(
+            "{} does not exist, the build probably failed".format(output_dir))
+
+    # Sorry MacOS, you will have to build manually since automating builds
+    # on MacOS is a huge pain
+    lib_ending: str = "dll" if platform.system() == "Windows" else "so"
+    rename_count: int = 0
+
+    for file in os.listdir(os.fsencode(output_dir)):
+        file_name: str = os.fsdecode(file)
+
+        if file_name.lower().endswith(lib_ending):
+            rename_count += 1
+            os.rename("{}/{}".format(output_dir, file_name),
+                      "{}/{}".format(output_dir, LIB_NAME_FORMAT.format(lib_ending)))
+
+    if rename_count != 1:
+        # TODO just a warning for now
+        print("Renamed an unexpected amount of files: {}".format(
+            rename_count), flush=True)
+
+
+def main() -> None:
+    # Make sure we are building in the correct directory
+    os.chdir(path.dirname(__file__))
+
+    parser = ArgumentParser("libvpuppr-build")
+    parser.add_argument("--debug", action="store_true",
+                        help="Build the lib in debug mode")
+    parser.add_argument("--release", action="store_true",
+                        help="Build the lib in release mode")
+
+    args = parser.parse_args()
+
+    changed = False
+
+    # NOTE: I know it's possible to configure argparse to do this automatically, and I don't care
+    if args.debug:
+        changed = True
+        build(BuildFlag.DEBUG)
+    if args.release:
+        changed = True
+        build(BuildFlag.RELEASE)
+
+    if not changed:
+        raise Exception("An option must be selected")
+
+
+if __name__ == "__main__":
+    main()

libvpuppr.gdextension

@@ -3,5 +3,8 @@ entry_symbol = "gdext_rust_init"
 compatibility_minimum = 4.1
 
 [libraries]
-windows.debug.x86_64 = "res://vpuppr-rust-lib/target/debug/vpuppr_rust_lib.dll"
-windows.release.x86_64 = "res://vpuppr-rust-lib/target/release/vpuppr_rust_lib.dll"
+windows.debug.x86_64 = "res://libvpuppr/target/debug/libvpuppr.dll"
+windows.release.x86_64 = "res://libvpuppr/target/release/libvpuppr.dll"
+
+linux.debug.x86_64 = "res://libvpuppr/target/debug/libvpuppr.so"
+linux.release.x86_64 = "res://libvpuppr/target/release/libvpuppr.so"

src/lib.rs

@@ -1,4 +1,5 @@
 mod logger;
+
 pub use logger::Logger;
 pub mod model;
 mod puppets;
@@ -22,6 +23,39 @@ macro_rules! vstring {
 }
 pub(crate) use vstring;
 
+/// Helper struct for information about the libvpuppr library.
+#[derive(Debug, Default, GodotClass)]
+struct LibVpuppr;
+
+#[godot_api]
+impl RefCountedVirtual for LibVpuppr {
+    fn init(_base: godot::obj::Base<Self::Base>) -> Self {
+        Self
+    }
+}
+
+#[godot_api]
+impl LibVpuppr {
+    /// A mapping of various vpuppr metadata.
+    #[func]
+    fn metadata() -> Dictionary {
+        let mut mapping = Dictionary::new();
+
+        let is_debug = if cfg!(debug_assertions) { true } else { false };
+        mapping.insert("DEBUG", is_debug);
+        mapping.insert("RELEASE", !is_debug);
+
+        mapping.insert("VERSION", env!("CARGO_PKG_VERSION"));
+        mapping.insert("VERSION_MAJOR", env!("CARGO_PKG_VERSION_MAJOR"));
+        mapping.insert("VERSION_MINOR", env!("CARGO_PKG_VERSION_MINOR"));
+        mapping.insert("VERSION_PATCH", env!("CARGO_PKG_VERSION_PATCH"));
+
+        mapping.insert("LIBVPUPPR_AUTHORS", env!("CARGO_PKG_AUTHORS"));
+
+        mapping
+    }
+}
+
 struct GodotExtension;
 
 #[gdextension]

src/puppets.rs

@@ -1 +1,2 @@
+mod puppet_2d;
 mod puppet_3d;

src/puppets/puppet_2d.rs

@@ -0,0 +1,31 @@
+use godot::prelude::*;
+
+use crate::{gstring, vstring, Logger};
+
+#[derive(Debug, GodotClass)]
+#[class(base = Node2D)]
+struct Puppet2d {
+    #[var]
+    logger: Gd<Logger>,
+
+    #[base]
+    base: Base<Node2D>,
+}
+
+#[godot_api]
+impl Node2DVirtual for Puppet2d {
+    fn init(base: godot::obj::Base<Self::Base>) -> Self {
+        Self {
+            logger: Logger::create(gstring!("Puppet2d")),
+
+            base,
+        }
+    }
+
+    fn ready(&mut self) {
+        // TODO stub
+    }
+}
+
+#[godot_api]
+impl Puppet2d {}

src/receivers.rs

@@ -1,3 +1,4 @@
+mod lip_sync;
 mod meow_face;
 
 use godot::{engine::global::Error, prelude::*};

src/receivers/lip_sync.rs

@@ -0,0 +1,14 @@
+/*!
+A receiver for lip syncing data.
+
+This implementation takes audio input from Godot, converts that audio to text,
+and then generates phonemes from them. The text and phonemes are both usable
+from vpuppr, allowing for both model lip-sync and actions based off of voice commands.
+*/
+
+use godot::prelude::*;
+
+// TODO maybe use https://github.com/tazz4843/whisper-rs instead of own impl
+// use in conjunction with https://github.com/Dalvany/rphonetic
+
+struct LipSync {}

src/receivers/meow_face.rs

@@ -1,3 +1,7 @@
+/*!
+A receiver for [MeowFace](https://play.google.com/store/apps/details?id=com.suvidriel.meowface) data.
+*/
+
 use godot::{engine::global::Error, prelude::*};
 use std::net::{IpAddr, Ipv4Addr};