Feature: rustg_sound_length() (#192)

Cargo.toml

@@ -64,6 +64,9 @@ ammonia = { version = "4.0.0", optional = true }
 fast_poisson = { version = "=0.5.2", optional = true, features = [
     "single_precision",
 ] } # Higher versions have problems with x86 due to 'kiddo'.
+symphonia = { version = "0.5.4", optional = true, features = [
+    "all-codecs",
+] }
 
 [features]
 default = [
@@ -79,6 +82,7 @@ default = [
     "noise",
     "rustls_tls",
     "sanitize",
+    "sound_len",
     "sql",
     "time",
     "toml",
@@ -98,6 +102,7 @@ all = [
     "noise",
     "rustls_tls",
     "sanitize",
+    "sound_len",
     "sql",
     "time",
     "toml",
@@ -123,6 +128,7 @@ http = ["ureq", "serde", "serde_json", "once_cell", "jobs"]
 json = ["serde", "serde_json"]
 log = ["chrono"]
 sanitize = ["ammonia", "serde_json"]
+sound_len = ["symphonia"]
 sql = ["mysql", "serde", "serde_json", "once_cell", "dashmap", "jobs"]
 time = []
 toml = ["serde", "serde_json", "toml-dep"]

README.md

@@ -101,6 +101,7 @@ The default features are:
 * json: Function to check JSON validity.
 * log: Faster log output.
 * noise: 2d Perlin noise.
+* sound_len: A mostly codec-agnostic library for reading the duration of an audio file.
 * sql: Asynchronous MySQL/MariaDB client library.
 * time: High-accuracy time measuring.
 * toml: TOML parser.

dmsrc/sound_len.dm

@@ -0,0 +1,42 @@
+/// Provided a static RSC file path or a raw text file path, returns the duration of the file in deciseconds as a float.
+/proc/rustg_sound_length(file_path)
+	var/static/list/sound_cache
+	if(isnull(sound_cache))
+		sound_cache = list()
+
+	. = 0
+
+	if(!istext(file_path))
+		if(!isfile(file_path))
+			CRASH("rustg_sound_length error: Passed non-text object")
+
+		if(length("[file_path]")) // Runtime generated RSC references stringify into 0-length strings.
+			file_path = "[file_path]"
+		else
+			CRASH("rustg_sound_length does not support non-static file refs.")
+
+	var/cached_length = sound_cache[file_path]
+	if(!isnull(cached_length))
+		return cached_length
+
+	var/ret = RUSTG_CALL(RUST_G, "sound_len")(file_path)
+	var/as_num = text2num(ret)
+	if(isnull(ret))
+		. = 0
+		CRASH("rustg_sound_length error: [ret]")
+
+	sound_cache[file_path] = as_num
+	return as_num
+
+
+#define RUSTG_SOUNDLEN_SUCCESSES "successes"
+#define RUSTG_SOUNDLEN_ERRORS "errors"
+/**
+ * Returns a nested key-value list containing "successes" and "errors"
+ * The format is as follows:
+ * list(
+ *  RUSTG_SOUNDLEN_SUCCESES = list("sounds/test.ogg" = 25.34),
+ *  RUSTG_SOUNDLEN_ERRORS = list("sound/bad.png" = "SoundLen: Unable to decode file."),
+ *)
+*/
+#define rustg_sound_length_list(file_paths) json_decode(RUSTG_CALL(RUST_G, "sound_len_list")(json_encode(file_paths)))

src/error.rs

@@ -49,6 +49,9 @@ pub enum Error {
     #[cfg(feature = "http")]
     #[error(transparent)]
     Request(#[from] Box<ureq::Error>),
+    #[cfg(feature = "sound_len")]
+    #[error("SoundLen error: {0}")]
+    SoundLen(String),
     #[cfg(feature = "toml")]
     #[error(transparent)]
     TomlDeserialization(#[from] toml_dep::de::Error),

src/lib.rs

@@ -42,6 +42,8 @@ pub mod redis_pubsub;
 pub mod redis_reliablequeue;
 #[cfg(feature = "sanitize")]
 pub mod sanitize;
+#[cfg(feature = "sound_len")]
+pub mod sound_len;
 #[cfg(feature = "sql")]
 pub mod sql;
 #[cfg(feature = "time")]