Add cached api end points (part 3) (following #130, #131), refactoring sound api (closes #42).

Author: boozook

Cargo.lock

@@ -25,7 +25,7 @@ display = { version = "0.3", path = "api/display", package = "playdate-display",
 fs = { version = "0.2", path = "api/fs", package = "playdate-fs", default-features = false }
 gfx = { version = "0.3", path = "api/gfx", package = "playdate-graphics", default-features = false }
 menu = { version = "0.1", path = "api/menu", package = "playdate-menu", default-features = false }
-sound = { version = "0.1", path = "api/sound", package = "playdate-sound", default-features = false }
+sound = { version = "0.2", path = "api/sound", package = "playdate-sound", default-features = false }
 sprite = { version = "0.1", path = "api/sprite", package = "playdate-sprite", default-features = false }
 system = { version = "0.3", path = "api/system", package = "playdate-system", default-features = false }
 sys = { version = "0.1", path = "api/sys", package = "playdate-sys", default-features = false }

Cargo.toml

@@ -100,6 +100,6 @@ Just run `cargo new <your options>` and add do following:
 
 - - -
 
-Made with ❤️‍🔥 by [my](https://a.koz.world).
+Made with ❤️‍🔥 by [me](https://a.koz.world).
 
 This software is not sponsored or supported by Panic.

api/playdate/README.md

@@ -1,6 +1,6 @@
 [package]
 name = "playdate-sound"
-version = "0.1.6"
+version = "0.2.0"
 readme = "README.md"
 description = "High-level sound API built on-top of Playdate API"
 keywords = ["playdate", "sdk", "api", "gamedev"]
@@ -44,12 +44,6 @@ name = "sp-simple"
 crate-type = ["dylib", "staticlib"]
 path = "examples/sp-simple.rs"
 
-# [[example]]
-# name = "sp-cached"
-# crate-type = ["dylib", "staticlib"]
-# path = "examples/sp-cached.rs"
-# required-features = ["bindings-derive-cache"]
-
 [[example]]
 name = "fp-simple"
 crate-type = ["dylib", "staticlib"]

api/sound/Cargo.toml

@@ -34,8 +34,8 @@ impl State {
 	/// Updates the state
 	fn update(&mut self) -> Option<()> {
 		let text: Cow<str> = if let Some(player) = self.player.as_ref() {
-			let offset = player.try_get_offset().ok()?;
-			let length = player.try_get_length().ok()?;
+			let offset = player.get_offset();
+			let length = player.get_length();
 			format!("{:.2} / {:.2}", offset, length).into()
 		} else {
 			"no player".into()
@@ -76,15 +76,15 @@ impl State {
 				(*(*sys::API).display).setRefreshRate?(60.0);
 
 				// create player
-				self.player = Player::try_new().ok()?.into();
+				self.player = Player::new().ok()?.into();
 				let player = self.player.as_ref()?;
 
 				// load sound
 				const SOUND_PATH: &Path = "sfx/main_theme.pda";
-				player.try_load_into_player(SOUND_PATH).ok()?;
+				player.load_into_player(SOUND_PATH).ok()?;
 
 				// start playback
-				player.try_play(Repeat::LoopsEndlessly).ok()?;
+				player.play(Repeat::LoopsEndlessly);
 			},
 			_ => {},
 		}

api/sound/examples/fp-simple.rs

@@ -35,8 +35,8 @@ impl State {
 	/// Updates the state
 	fn update(&mut self) -> Option<()> {
 		let text: Cow<str> = if let Some(player) = self.player.as_ref() {
-			let offset = player.try_get_offset().ok()?;
-			let length = player.try_get_length().ok()?;
+			let offset = player.get_offset();
+			let length = player.get_length();
 			format!("{:.2} / {:.2}", offset, length).into()
 		} else {
 			"no player".into()
@@ -77,16 +77,16 @@ impl State {
 				(*(*sys::API).display).setRefreshRate?(60.0);
 
 				// create player
-				self.player = Player::try_new().ok()?.into();
+				self.player = Player::new().ok()?.into();
 				let player = self.player.as_ref()?;
 
 				// load sound
 				const SOUND_PATH: &Path = "sfx/main_theme.pda";
-				let sample = Sample::new_from_file(SOUND_PATH);
-				player.try_set_sample(&sample).ok()?;
+				let sample = Sample::new_from_file(SOUND_PATH).ok()?;
+				player.set_sample(&sample);
 
 				// start playback
-				player.try_play(Repeat::LoopsEndlessly, 1.0).ok()?;
+				player.play(Repeat::LoopsEndlessly, 1.0);
 			},
 			_ => {},
 		}

api/sound/examples/sp-simple.rs

@@ -6,16 +6,22 @@ pub type ApiError = sys::error::Error<self::Error>;
 
 #[derive(Debug)]
 pub enum Error {
+	/// The file does not exist.
 	FileNotExist,
+
 	/// Causes when allocation failed and/or null-ptr returned.
 	Alloc,
+
+	/// Error caused by the file system.
+	Fs(fs::error::Error),
 }
 
 impl fmt::Display for Error {
 	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 		match &self {
-			Error::FileNotExist => write!(f, "Snd: File doesn't exist"),
 			Error::Alloc => write!(f, "Snd: Allocation failed"),
+			Error::FileNotExist => write!(f, "Snd: File doesn't exist"),
+			Error::Fs(err) => err.fmt(f),
 		}
 	}
 }
@@ -25,5 +31,9 @@ impl Into<ApiError> for Error {
 	fn into(self) -> ApiError { ApiError::Api(self) }
 }
 
+impl From<fs::error::Error> for Error {
+	fn from(err: fs::error::Error) -> Self { Self::Fs(err) }
+}
+
 
 impl core::error::Error for Error {}

api/sound/src/error.rs

@@ -2,14 +2,15 @@
 #![feature(error_in_core)]
 #![feature(const_trait_impl)]
 
-#[macro_use]
 extern crate sys;
 extern crate alloc;
 
 pub mod error;
 pub mod player;
 pub mod sample;
 
+// TODO: sound: channel, synth, sequence, effect, lfo, envelope, source!, etc..
+
 
 pub mod prelude {
 	pub use crate::error::ApiError as SndApiError;