16 files changed, 1598 insertions, 0 deletions
diff --git a/benoit-cli/src/config/config/load.rs b/benoit-cli/src/config/config/load.rs
new file mode 100644
index 0000000..8ac0165
--- /dev/null
+++ b/benoit-cli/src/config/config/load.rs
@@ -0,0 +1,50 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::Config;
+use crate::error::Error;
+
+use std::env::args;
+
+impl Config {
+ /// Loads the configuration file as specified on the command line.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error depending on the command line arguments and validity of the configuration file.
+ pub fn load() -> Result<Self, Error> {
+ let mut args = args().skip(0x1);
+
+ let Some(config_path) = args.next() else {
+ return Err(Error::MissingConfigPath);
+ };
+
+ if args.next().is_some() { return Err(Error::TooManyCliArguments) };
+
+ let config = Self::load_from(config_path)?;
+ config.validate()?;
+
+ Ok(config)
+ }
+}
diff --git a/benoit-cli/src/config/config/load_from.rs b/benoit-cli/src/config/config/load_from.rs
new file mode 100644
index 0000000..61ae5cd
--- /dev/null
+++ b/benoit-cli/src/config/config/load_from.rs
@@ -0,0 +1,89 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in (the) hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::{Config, Section, Take};
+use crate::error::Error;
+use crate::keyframe::Keyframe;
+
+use std::path::Path;
+
+macro_rules! take_field {
+ ($name:ident in ($section:expr)) => {{
+ $section.get_child(stringify!($name)).take()?
+ }};
+
+ ($name:ident in ($section:expr) str) => {{
+ $section.get_child(stringify!($name)).take_from_str()??
+ }};
+}
+
+impl Config {
+ /// Loads the configuration file at `path`.
+ ///
+ /// # Errors
+ ///
+ /// If the configuration file could not be read or parsed, an error message is returned.
+ pub fn load_from<P: AsRef<Path>>(path: P) -> Result<Self, Error> {
+ let root_section = Section::create_root(path)?;
+
+ let render_section: Section = root_section.get_child("render").take()?;
+ let final_section: Section = root_section.get_child("final").take()?;
+ let output_section: Section = root_section.get_child("output").take()?;
+
+ let render_start_section: Section = render_section.get_child("start").take()?;
+ let render_stop_section: Section = render_section.get_child("stop").take()?;
+
+ let render_width = take_field!(width in (render_section));
+ let render_height = take_field!(height in (render_section));
+
+ Ok(Self {
+ frame_count: take_field!(count in (render_section)),
+ render_size: (render_width, render_height),
+ fractal: take_field!(fractal in (render_section) str),
+ inverse: take_field!(inverse in (render_section)),
+ julia: take_field!(julia in (render_section)),
+
+ start: Keyframe {
+ frame: take_field!(frame in (render_start_section)),
+ max_iter_count: take_field!(max_iter_count in (render_start_section)),
+ centre: take_field!(centre in (render_start_section)),
+ seed: take_field!(seed in (render_start_section)),
+ zoom: take_field!(zoom in (render_start_section)),
+ colour_range: take_field!(colour_range in (render_start_section)),
+ },
+ stop: Keyframe {
+ frame: take_field!(frame in (render_stop_section)),
+ max_iter_count: take_field!(max_iter_count in (render_stop_section)),
+ centre: take_field!(centre in (render_stop_section)),
+ seed: take_field!(seed in (render_stop_section)),
+ zoom: take_field!(zoom in (render_stop_section)),
+ colour_range: take_field!(colour_range in (render_stop_section)),
+ },
+
+ palette: take_field!(palette in (final_section) str),
+
+ output_directory: take_field!(directory in (output_section)),
+ })
+ }
+}
diff --git a/benoit-cli/src/config/config/mod.rs b/benoit-cli/src/config/config/mod.rs
new file mode 100644
index 0000000..e10c25e
--- /dev/null
+++ b/benoit-cli/src/config/config/mod.rs
@@ -0,0 +1,124 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+mod load;
+mod load_from;
+mod print_help;
+
+use crate::error::Error;
+use crate::keyframe::Keyframe;
+
+use benoit::fractal::Fractal;
+use benoit::palette::Palette;
+use std::path::PathBuf;
+
+/// For configuring animations.
+///
+/// A configuration can be loaded from a file using [`load_from`](Config::load_from).
+///
+/// An example of a configuration is the following:
+///
+/// ```toml
+/// # This renders a single frame.
+///
+/// [render]
+/// count = 1
+/// width = 1024
+/// height = 1024
+///
+/// fractal = "mandelbrot" # multibrot2
+/// inverse = false
+/// julia = false
+///
+/// [render.start]
+/// frame = 0
+///
+/// max_iter_count = 0x100
+///
+/// centre = "0.0+0.0i"
+/// seed = "0.0+0.0i"
+/// zoom = "1.0"
+///
+/// colour_range = 64.0
+///
+/// [render.stop]
+/// frame = 0
+///
+/// max_iter_count = 0x100
+///
+/// centre = "0.0+0.0i"
+/// seed = "0.0+0.0i"
+/// zoom = "1.0"
+///
+/// colour_range = 64.0
+///
+/// [final]
+/// palette = "fire"
+///
+/// [output]
+/// directory = "render/"
+/// ```
+#[derive(Clone, Debug)]
+pub struct Config {
+ pub frame_count: u32,
+ pub render_size: (u32, u32),
+ pub fractal: Fractal,
+ pub inverse: bool,
+ pub julia: bool,
+
+ pub start: Keyframe,
+ pub stop: Keyframe,
+
+ pub palette: Palette,
+
+ pub output_directory: PathBuf,
+}
+
+impl Config {
+ /// Tries to validate `self`.
+ ///
+ /// # Errors
+ ///
+ /// If any configuration field couldn't be validated, an `Err` object is returned.
+ pub fn validate(&self) -> Result<(), Error> {
+ self.start.validate()?;
+ self.stop.validate()?;
+
+ if self.start.frame > self.stop.frame {
+ Err(
+ Error::InvalidConfig {
+ message: format!("start frame ({}) cannot be after stop frame ({})", self.start.frame, self.stop.frame),
+ },
+ )
+ } else if self.stop.frame >= self.frame_count {
+ Err(
+ Error::InvalidConfig {
+ message: format!("stop frame ({}) cannot be after last frame ({})", self.stop.frame, self.frame_count - 0x1),
+ },
+ )
+ } else {
+ Ok(())
+ }
+ }
+}
diff --git a/benoit-cli/src/config/config/print_help.rs b/benoit-cli/src/config/config/print_help.rs
new file mode 100644
index 0000000..b16d6f8
--- /dev/null
+++ b/benoit-cli/src/config/config/print_help.rs
@@ -0,0 +1,45 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::Config;
+
+use benoit::VERSION;
+use std::process::exit;
+
+impl Config {
+ /// Prints help to `stdout`.
+ ///
+ /// This function marks the end of execution and does therefore not return.
+ pub fn print_help() -> ! {
+ println!("Benoit {}.{}.{}", VERSION.0, VERSION.1, VERSION.2);
+ println!();
+ println!("Usage:");
+ println!(" benoit <path>");
+ println!();
+ println!("Wherein <path> denotes the path to the configuration file.");
+ println!();
+
+ exit(0x0);
+ }
+}
diff --git a/benoit-cli/src/config/field/mod.rs b/benoit-cli/src/config/field/mod.rs
new file mode 100644
index 0000000..489dc7a
--- /dev/null
+++ b/benoit-cli/src/config/field/mod.rs
@@ -0,0 +1,68 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::error::Error;
+
+use std::str::FromStr;
+use toml::Value;
+
+/// Denotes a configuration field.
+///
+/// By default, these fields are typeless.
+/// They can, however, be "transformed" to a given type using the [`Take`](crate::config::Take) trait.
+pub struct Field<'a> {
+ pub(in super) name: String,
+ pub(in super) value: Option<&'a Value>,
+}
+
+impl<'a> Field<'a> {
+ /// Borows the contained value.
+ ///
+ /// The returned reference is still considered "typeless," as is defined by `toml`'s own [`Value`] type.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if the field could not be found.
+ pub(in super) fn borrow_value(&mut self) -> Result<&'a Value, Error> {
+ self.value
+ .take()
+ .ok_or_else(|| Error::MissingConfigField { name: self.name.clone() })
+ }
+}
+
+impl Field<'_> {
+ /// Transforms the field into the given type `T`.
+ /// The result of [`FromStr`] implementation is passed on.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if the field doesn't exist, or is a different type, or if the [`FromStr`] implementation failed.
+ pub fn take_from_str<T: FromStr>(mut self) -> Result<Result<T, <T as FromStr>::Err>, Error> {
+ let Value::String(ref s) = *self.borrow_value()? else {
+ return Err(Error::WrongFieldType { name: self.name, ok_type: "string" })
+ };
+
+ Ok(FromStr::from_str(s))
+ }
+}
diff --git a/benoit-cli/src/config/mod.rs b/benoit-cli/src/config/mod.rs
new file mode 100644
index 0000000..aeba3b4
--- /dev/null
+++ b/benoit-cli/src/config/mod.rs
@@ -0,0 +1,31 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+//! Animation configuration.
+
+use crate::use_mod;
+use_mod!(pub, config);
+use_mod!(pub, field);
+use_mod!(pub, section);
+use_mod!(pub, take);
diff --git a/benoit-cli/src/config/section/mod.rs b/benoit-cli/src/config/section/mod.rs
new file mode 100644
index 0000000..59d716a
--- /dev/null
+++ b/benoit-cli/src/config/section/mod.rs
@@ -0,0 +1,86 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::Field;
+use crate::error::Error;
+
+use std::borrow::Cow;
+use std::fs::read_to_string;
+use std::path::Path;
+use std::str::FromStr;
+use toml::Table;
+
+/// Denotes a configuration section.
+pub struct Section<'a> {
+ pub(in super) name: Option<String>,
+ pub(in super) table: Cow<'a, Table>,
+}
+
+impl<'a> Section<'a> {
+ /// Creates a new root section.
+ ///
+ /// This is done by parsing the configuration file at `path`.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if unable to read and parse the configuration file.
+ pub fn create_root<P: AsRef<Path>>(path: P) -> Result<Self, Error> {
+ let path = path.as_ref();
+
+ let config = read_to_string(path)
+ .map_err(|e| Error::ConfigReadFailure { path: path.to_owned(), source: e })?;
+
+ let table = Table::from_str(&config)
+ .map_err(|e| Error::ConfigParseFailure { path: path.to_owned(), source: e })?;
+
+ Ok(Self {
+ name: None,
+ table: Cow::Owned(table)
+ })
+ }
+
+ /// Searches the section's table for children.
+ ///
+ /// The returned child will reference its parent section.
+ ///
+ /// The child isn't guaranteed to exist, and in the event that it does, is typeless.
+ /// See the [`Field`] type for more information.
+ #[must_use]
+ pub fn get_child(&'a self, name: &str) -> Field<'a> {
+ let value = self.table.get(name);
+
+ let name = self.name
+ .as_ref()
+ .map_or_else(
+ || name.to_owned(),
+
+ |parent| format!("{parent}.{name}"),
+ );
+
+ Field {
+ name,
+ value,
+ }
+ }
+}
diff --git a/benoit-cli/src/config/take/mod.rs b/benoit-cli/src/config/take/mod.rs
new file mode 100644
index 0000000..4580e5b
--- /dev/null
+++ b/benoit-cli/src/config/take/mod.rs
@@ -0,0 +1,282 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::config::{Field, Section};
+use crate::error::Error;
+
+use benoit::PRECISION;
+use benoit::complex::Complex;
+use rug::Float;
+use std::borrow::Cow;
+use std::fs::canonicalize;
+use std::path::PathBuf;
+use std::str::FromStr;
+use toml::Value;
+
+/// Used for loading configuration fields.
+///
+/// More specifically, this is to be used with the untyped [`Field`] type, where using [`take`](Take::take) collapses the field into a definitively typed object.
+pub trait Take<T> {
+ /// Collapses the field into the given type `T`.
+ ///
+ /// # Errors
+ ///
+ /// Returns an error if the field doesn't exist or is a different type.
+
+ fn take(self) -> Result<T, Error>;
+}
+
+fn test_field_domain<T, U>(name: &str, value: &T, min: U, max: U) -> Result<(), Error>
+where
+ T: PartialOrd + ToString,
+ U: Copy + Into<T> + ToString, {
+ if *value < min.into() {
+ Err(Error::FieldLowerBounds {
+ name: name.to_owned(),
+ value: value.to_string(),
+ limit: min.to_string(),
+ })
+ } else if *value > max.into() {
+ Err(Error::FieldUpperBounds {
+ name: name.to_owned(),
+ value: value.to_string(),
+ limit: max.to_string(),
+ })
+ } else {
+ Ok(())
+ }
+}
+
+impl Take<bool> for Field<'_> {
+ fn take(mut self) -> Result<bool, Error> {
+ let Value::Boolean(value) = *self.borrow_value()? else {
+ return Err(Error::WrongFieldType { name: self.name, ok_type: "bool" });
+ };
+
+ Ok(value)
+ }
+}
+
+impl Take<Complex> for Field<'_> {
+ fn take(mut self) -> Result<Complex, Error> {
+ let s = if let Value::String(ref s) = *self.borrow_value()? {
+ Ok(s)
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "complex" })
+ }?;
+
+ FromStr::from_str(s).map_err(Into::into)
+ }
+}
+
+impl Take<f32> for Field<'_> {
+ fn take(mut self) -> Result<f32, Error> {
+ if let Value::Float(value) = *self.borrow_value()? {
+ // Is this even possible?
+ if value.is_nan() {
+ return Err(Error::NonNumberField { name: self.name });
+ }
+
+ if value.is_infinite() {
+ return Err(Error::InfiniteField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, -f32::MAX, f32::MAX)?;
+
+ Ok(value as f32)
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "float" })
+ }
+ }
+}
+
+impl Take<f64> for Field<'_> {
+ fn take(mut self) -> Result<f64, Error> {
+ if let Value::Float(value) = *self.borrow_value()? {
+ // Is this even possible?
+ if value.is_nan() {
+ return Err(Error::NonNumberField { name: self.name });
+ }
+
+ if value.is_infinite() {
+ return Err(Error::InfiniteField { name: self.name });
+ }
+
+ Ok(value)
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "float" })
+ }
+ }
+}
+
+impl Take<Float> for Field<'_> {
+ fn take(mut self) -> Result<Float, Error> {
+ if let Value::String(ref value) = *self.borrow_value()? {
+ if let Ok(value) = Float::parse(value) {
+ return Ok(Float::with_val(PRECISION, value));
+ }
+ }
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "bigfloat" })
+ }
+}
+
+impl Take<i16> for Field<'_> {
+ fn take(mut self) -> Result<i16, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ test_field_domain(&self.name, &value, i16::MIN, i16::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<i32> for Field<'_> {
+ fn take(mut self) -> Result<i32, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ test_field_domain(&self.name, &value, i32::MIN, i32::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<i64> for Field<'_> {
+ fn take(mut self) -> Result<i64, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ return Ok(value);
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<i8> for Field<'_> {
+ fn take(mut self) -> Result<i8, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ test_field_domain(&self.name, &value, i8::MIN, i8::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<PathBuf> for Field<'_> {
+ fn take(self) -> Result<PathBuf, Error> {
+ let s = <Self as Take<String>>::take(self)?;
+
+ canonicalize(&s).map_err(|e| Error::InvalidPath { path: s, source: e })
+ }
+}
+
+impl<'a> Take<Section<'a>> for Field<'a> {
+ fn take(mut self) -> Result<Section<'a>, Error> {
+ if let Value::Table(ref table) = *self.borrow_value()? {
+ return Ok(Section {
+ name: Some(self.name),
+ table: Cow::Borrowed(table),
+ });
+ }
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "section" })
+ }
+}
+
+impl Take<String> for Field<'_> {
+ fn take(mut self) -> Result<String, Error> {
+ if let Value::String(ref s) = *self.borrow_value()? {
+ Ok(s.to_owned())
+ } else {
+ Err(Error::WrongFieldType { name: self.name, ok_type: "string" })
+ }
+ }
+}
+
+impl Take<u16> for Field<'_> {
+ fn take(mut self) -> Result<u16, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, u16::MIN, u16::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<u32> for Field<'_> {
+ fn take(mut self) -> Result<u32, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, u32::MIN, u32::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<u64> for Field<'_> {
+ fn take(mut self) -> Result<u64, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name })
+ }
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
+
+impl Take<u8> for Field<'_> {
+ fn take(mut self) -> Result<u8, Error> {
+ if let Value::Integer(value) = *self.borrow_value()? {
+ if value.is_negative() {
+ return Err(Error::NegativeField { name: self.name });
+ }
+
+ test_field_domain(&self.name, &value, u8::MIN, u8::MAX)?;
+
+ return Ok(TryFrom::try_from(value).unwrap());
+ };
+
+ Err(Error::WrongFieldType { name: self.name, ok_type: "integer" })
+ }
+}
diff --git a/benoit-cli/src/error/mod.rs b/benoit-cli/src/error/mod.rs
new file mode 100644
index 0000000..32a9f40
--- /dev/null
+++ b/benoit-cli/src/error/mod.rs
@@ -0,0 +1,159 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit.
+
+ benoit is free software: you can redistribute it
+ and/or modify it under the terms of the GNU Af-
+ fero General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit is distributed in the hope that it will
+ be useful, but WITHOUT ANY WARRANTY; without
+ even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Af-
+ fero General Public License along with benoit.
+ If not, see <https://www.gnu.org/licenses/>.
+*/
+
+use benoit::error::Error as LibError;
+use std::error::Error as StdError;
+use std::fmt::{Display, Formatter, Result as FmtResult};
+use std::io::Error as IoError;
+use std::path::PathBuf;
+use toml::de::Error as TomlError;
+
+/// Denotes an error.
+#[derive(Debug)]
+pub enum Error {
+ BenoitError { source: LibError },
+
+ ConfigParseFailure { path: PathBuf, source: TomlError },
+
+ ConfigReadFailure { path: PathBuf, source: IoError },
+
+ InvalidConfig { message: String },
+
+ InvalidKeyframe { message: String },
+
+ InvalidPath { path: String, source: IoError },
+
+ FieldLowerBounds { name: String, value: String, limit: String },
+
+ FieldUpperBounds { name: String, value: String, limit: String },
+
+ InfiniteField { name: String },
+
+ MissingConfigField { name: String },
+
+ MissingConfigPath,
+
+ NegativeField { name: String },
+
+ NonNumberField { name: String },
+
+ TooManyCliArguments,
+
+ WrongFieldType { name: String, ok_type: &'static str },
+}
+
+impl Display for Error {
+ fn fmt(&self, f: &mut Formatter) -> FmtResult {
+ #[allow(clippy::enum_glob_use)]
+ use Error::*;
+
+ match *self {
+ BenoitError { ref source } => {
+ write!(f, "{source}")
+ },
+
+ ConfigParseFailure { ref path, ref source } => {
+ write!(f, "unable to parse configuration at \"{}\": \"{source}\"", path.display())
+ }
+
+ ConfigReadFailure { ref path, ref source } => {
+ write!(f, "unable to read configuration at \"{}\": \"{source}\"", path.display())
+ },
+
+ FieldLowerBounds { ref name, ref value, ref limit } => {
+ write!(f, "field `{name}` cannot be less than ({limit}) but was ({value})")
+ },
+
+ FieldUpperBounds { ref name, ref value, ref limit } => {
+ write!(f, "field `{name}` cannot be greater than ({limit}) but was ({value})")
+ },
+
+ InfiniteField { ref name } => {
+ write!(f, "field `{name}` must be finite (was infinite)")
+ },
+
+ InvalidConfig { ref message } => {
+ write!(f, "invalid configuration: {message}")
+ },
+
+ InvalidKeyframe { ref message } => {
+ write!(f, "invalid keyframe: {message}")
+ },
+
+ InvalidPath { ref path, ref source } => {
+ write!(f, "invalid path \"{path}\": \"{source}\"")
+ },
+
+ MissingConfigField { ref name } => {
+ write!(f, "missing configuration field `{name}`")
+ },
+
+ MissingConfigPath => {
+ write!(f, "missing configuration path")
+ },
+
+ NegativeField { ref name } => {
+ write!(f, "field `{name}` cannot be negative")
+ },
+
+ NonNumberField { ref name } => {
+ write!(f, "field `{name}` must be a number (was NaN)")
+ },
+
+ TooManyCliArguments => {
+ write!(f, "too many arguments provided on the command line")
+ },
+
+ WrongFieldType { ref name, ok_type } => {
+ write!(f, "type of field `{name} should'be been `{ok_type}`")
+ },
+ }
+ }
+}
+
+impl From<LibError> for Error {
+ fn from(value: LibError) -> Self {
+ Self::BenoitError { source: value }
+ }
+}
+
+impl StdError for Error {
+ fn source(&self) -> Option<&(dyn StdError + 'static)> {
+ #[allow(clippy::enum_glob_use)]
+ use Error::*;
+
+ #[allow(clippy::match_same_arms, clippy::wildcard_enum_match_arm)]
+ match *self {
+ BenoitError { ref source } => Some(source),
+
+ ConfigParseFailure { ref source, .. } => Some(source),
+
+ ConfigReadFailure { ref source, .. } => Some(source),
+
+ InvalidPath { ref source, .. } => Some(source),
+
+ _ => None,
+ }
+ }
+}
diff --git a/benoit-cli/src/instance/mod.rs b/benoit-cli/src/instance/mod.rs
new file mode 100644
index 0000000..26f67a0
--- /dev/null
+++ b/benoit-cli/src/instance/mod.rs
@@ -0,0 +1,48 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+//! Runtime.
+
+mod run;
+
+use rug::float::{free_cache, FreeCache};
+
+/// Denotes a programme instance.
+///
+/// In theory, due to Rust's safety, any ammount of instances can be created at any time... disregarding hardware constraints, of course.
+///
+/// The choice of creating this structure in the first place is a personal one.
+/// I can be argued, however, that some things should be leveraged using [`Drop`].
+pub struct Instance;
+
+impl Default for Instance {
+ #[inline(always)]
+ fn default() -> Self { Self }
+}
+
+impl Drop for Instance {
+ fn drop(&mut self) {
+ free_cache(FreeCache::All);
+ }
+}
diff --git a/benoit-cli/src/instance/run.rs b/benoit-cli/src/instance/run.rs
new file mode 100644
index 0000000..8ba86ab
--- /dev/null
+++ b/benoit-cli/src/instance/run.rs
@@ -0,0 +1,138 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::set_title;
+use crate::error::Error;
+use crate::instance::Instance;
+use crate::config::Config;
+use crate::keyframe::Keyframe;
+
+use benoit::log;
+use benoit::render::{Render, RenderConfig};
+use benoit::stopwatch::Stopwatch;
+use std::path::Path;
+
+#[cfg(feature = "notify")]
+use notify_rust::{Notification, Timeout};
+
+impl Instance {
+ /// Consumes the programme instance and starts execution.
+ ///
+ /// # Errors
+ ///
+ /// Returns any error that occurs during executiom, if any at all.
+ ///
+ /// This does not include panics, which are *not* handled by us (at the moment).
+
+ #[allow(clippy::unused_self)]
+ pub fn run(self, config: &Config) -> Result<(), Error> {
+ let mut render = Render::new(config.render_size.0, config.render_size.1)?;
+
+ let mut dump_frame = |keyframe: &Keyframe, path: &Path| -> Result<(), Error> {
+ let render_config = RenderConfig {
+ fractal: config.fractal.clone(),
+ inverse: config.inverse,
+ julia: config.julia,
+
+ max_iter_count: keyframe.max_iter_count,
+ centre: keyframe.centre.clone(),
+ seed: keyframe.seed.clone(),
+ zoom: keyframe.zoom.clone(),
+ };
+
+ run_job("render", || render.generate(&render_config));
+ run_job("paint", || render.plot(config.palette, keyframe.colour_range))?;
+ run_job("dump", || render.dump_image(path))?;
+
+ Ok(())
+ };
+
+ let mut global_timer = Stopwatch::from_now();
+
+ for keyframe in config.start.interpolate_between(&config.stop, config.frame_count) {
+ log!(value, keyframe);
+
+ let path = {
+ let mut path = config.output_directory.clone();
+ path.push(format!("frame{:010}.png", keyframe.frame));
+
+ path
+ };
+
+ eprint!("\u{001B}[1m");
+ eprintln!("frame no. {:.>10} \u{2510}", keyframe.frame);
+ eprintln!(" of {:.>10} total \u{2534}> \"{}\"", config.stop.frame, path.display());
+ eprint!("\u{001B}[22m");
+
+ let frame_timer = Stopwatch::test_result(|| dump_frame(&keyframe, &path))?;
+ global_timer.note();
+
+ eprintln!(" = \u{001B}[4m{frame_timer}\u{001B}[24m\u{001B}[2m ({global_timer} total)\u{001B}[22m");
+ eprintln!();
+ }
+
+ global_timer.note();
+
+ eprintln!("\u{001B}[1manimation completed\u{001B}[22m - took {global_timer} in total");
+ set_title!("done");
+
+ #[cfg(feature = "notify")]
+ {
+ // We don't really care if the notification fails.
+ let _ = Notification::new()
+ .appname("Benoit")
+ .summary("\u{2728} Animation completed! \u{2728}")
+ .body(&format!("Took {global_timer}."))
+ .icon("benoit")
+ .timeout(Timeout::Never)
+ .show();
+ }
+
+ Ok(())
+ }
+}
+
+pub fn run_job<F: FnOnce() -> Output, Output>(name: &str, func: F) -> Output {
+ eprint!("\u{2610} running job `{name}` ...");
+ set_title!("{name}");
+
+ let (timer, result) = Stopwatch::test(func);
+
+ // Indent to the 40th column; two have already been
+ // used for the bullet:
+ eprintln!("\r\u{2612} \u{001B}[2m{: <38}\u{001B}[22m\u{001B}[1m+ {timer}\u{001B}[22m", format!("completed job `{name}`"));
+
+ result
+}
+
+//
+// ## ##
+// # # #
+// # #
+// # #
+// # #
+// # #
+// # #
+// #
+//
diff --git a/benoit-cli/src/keyframe/keyframe/interpolate_between.rs b/benoit-cli/src/keyframe/keyframe/interpolate_between.rs
new file mode 100644
index 0000000..42e8c3e
--- /dev/null
+++ b/benoit-cli/src/keyframe/keyframe/interpolate_between.rs
@@ -0,0 +1,165 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::keyframe::{Keyframe, KeyframeInterpolater};
+
+use benoit::{log, PRECISION};
+use benoit::complex::Complex;
+use num_traits::Num;
+use rug::Float;
+use rug::ops::PowAssign;
+
+impl Keyframe {
+ /// Interpolates between `self` and the given other keyframe.
+ ///
+ /// The returned interpolater can be used as an iterator.
+ ///
+ /// The way in which the values are interpolated differ:
+ /// The centre, seed, and colour range values are interpreted as linear functions of the form (*a* &middot; *b* + *c*).
+ /// The zoom value, however, is interpreted as a growth function of the form (*a*<sup>*x*</sup> &middot; *b*).
+ ///
+ /// # Panics
+ ///
+ /// Panics if frame indices don't match.
+
+ #[must_use]
+ pub fn interpolate_between(&self, other: &Self, frame_count: u32) -> KeyframeInterpolater {
+ assert!(self.frame <= other.frame, "starting frame ({}) is after stopping frame ({})", self.frame, other.frame);
+ assert!(other.frame < frame_count, "stopping frame ({}) is after last frame ({})", other.frame, frame_count - 0x1);
+
+ let first_possible_frame = 0x0;
+ let last_possible_frame = frame_count - 0x1;
+
+ let max_iter_count_step = linear_step(
+ (first_possible_frame, i64::try_from(self.max_iter_count).unwrap()),
+ (last_possible_frame, i64::try_from(other.max_iter_count).unwrap()),
+ );
+
+ let centre_step = linear_step_complex( (first_possible_frame, &self.centre), (last_possible_frame, &other.centre));
+ let seed_step = linear_step_complex( (first_possible_frame, &self.seed), (last_possible_frame, &other.seed));
+ let zoom_factor = growth_factor_bigfloat((first_possible_frame, &self.zoom), (last_possible_frame, &other.zoom));
+ let colour_range_step = linear_step( (first_possible_frame, self.colour_range), (last_possible_frame, other.colour_range));
+
+ let mut interpolator = KeyframeInterpolater {
+ frame: Some(self.frame),
+ last_frame: other.frame,
+
+ max_iter_count: self.max_iter_count,
+ centre: self.centre.clone(),
+ seed: self.seed.clone(),
+ zoom: self.zoom.clone(),
+ colour_range: self.colour_range,
+
+ max_iter_count_step,
+ centre_step,
+ seed_step,
+ zoom_factor,
+ colour_range_step,
+ };
+
+ // Skip to the starting frame:
+ for _ in 0x0..self.frame {
+ interpolator.advance_values();
+ }
+
+ log!(value, interpolator);
+ interpolator
+ }
+}
+
+#[must_use]
+fn linear_step<T: Default + From<u32> + Num>((t0, f0): (u32, T), (t1, f1): (u32, T)) -> T {
+ if t1 == t0 || f1 == f0 { return Default::default() }
+
+ // A linear function `f` of time `t` can be defined
+ // as:
+ //
+ // f(t) = at+b
+ //
+ // The starting value `b` is already known. We use
+ // the following expression to get the slope coef-
+ // ficient `a`:
+ //
+ // a = (t1-t0)/(t1-t0)
+ //
+ // wherein f1 and f0 are the last and first results
+ // of `f` - respectively - and t1 and t0 are like-
+ // wise the last and first timepoints.
+
+ (f1 - f0) / (T::from(t1) - T::from(t0))
+}
+
+#[must_use]
+fn linear_step_bigfloat((t0, f0): (u32, &Float), (t1, f1): (u32, &Float)) -> Float {
+ if t1 == t0 || f1 == f0 { return Float::new(PRECISION) }
+
+ let denominator = f64::from(t1) - f64::from(t0);
+
+ let numerator = Float::with_val(PRECISION, f1 - f0);
+ numerator / denominator
+}
+
+#[must_use]
+fn linear_step_complex((t0, f0): (u32, &Complex), (t1, f1): (u32, &Complex)) -> Complex {
+ let real_step = linear_step_bigfloat((t0, &f0.real), (t1, &f1.real));
+ let imag_step = linear_step_bigfloat((t0, &f0.imag), (t1, &f1.imag));
+
+ Complex { real: real_step, imag: imag_step }
+}
+
+#[must_use]
+fn growth_factor_bigfloat((t0, f0): (u32, &Float), (t1, f1): (u32, &Float)) -> Float {
+ if t1 == t0 || f1 == f0 { return Float::with_val(PRECISION, 0x1) }
+
+ // The growth function `f` of time `t` is:
+ //
+ // f(t) = b*a^t
+ //
+ // wherein `b` is the starting value and `a` is the
+ // growth factor.
+ //
+ // To isolate `a` we use:
+ //
+ // a = nroot(t1-t0,f1/f0)
+ //
+ // wherein `t0`, `t1`, `f1`, and `f0` are the first
+ // and last values on the two dimensions (`t` and
+ // `f`), altough in theory arbitrary.
+ //
+ // Because the following is true:
+ //
+ // nroot(n,m) = m^(1/n)
+ //
+ // the expression for `a` is simplified for use
+ // with Rug:
+ //
+ // a = (t1/t0)^(1/(f1-f0))
+
+ let exponent = 1.0 / (f64::from(t1) - f64::from(t0));
+
+ let mut factor = Float::with_val(PRECISION, f1 / f0);
+ factor.pow_assign(exponent);
+
+ factor
+}
diff --git a/benoit-cli/src/keyframe/keyframe/mod.rs b/benoit-cli/src/keyframe/keyframe/mod.rs
new file mode 100644
index 0000000..9a4e84a
--- /dev/null
+++ b/benoit-cli/src/keyframe/keyframe/mod.rs
@@ -0,0 +1,99 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+mod interpolate_between;
+
+use crate::error::Error;
+
+use benoit::PRECISION;
+use benoit::complex::Complex;
+use rug::Float;
+
+/// Defines a single keyframe for animating.
+///
+/// Keyframes can be interpolated using the [`interpolate_between`](Keyframe::interpolate_between) method.
+#[derive(Clone, Debug)]
+pub struct Keyframe {
+ pub frame: u32,
+ pub max_iter_count: u64,
+ pub centre: Complex,
+ pub seed: Complex,
+ pub zoom: Float,
+ pub colour_range: f64,
+}
+
+impl Keyframe {
+ /// Validates `self`, wrapping it in a [`Result`].
+ ///
+ /// The following requirements must be upheld:
+ ///
+ /// * The maximum iteration count must be non-zero and less than or equal to `9223372036854775807`;
+ /// * The zoom value must be positive and non-zero;
+ /// * The colour range must be positive and non-zero;
+ ///
+ /// If these are upheld, an [`Ok`] object is returned.
+ ///
+ /// Do note that an "invalid" keyframe does not inherintly result in undefined behaviour if used.
+ ///
+ /// # Errors
+ ///
+ /// Yields an error if the keyframe could not be validated.
+ pub fn validate(&self) -> Result<(), Error> {
+ macro_rules! test {
+ ($assertion:expr, $($message:tt)*) => {{
+ if !($assertion as bool) {
+ return Err(Error::InvalidKeyframe { message: format!($($message)?) })
+ }
+ }};
+ }
+
+ test!(self.max_iter_count != 0x0, "max. iter. count ({}) cannot be zero", self.max_iter_count);
+
+ // This is also tested by Config, but we don't know
+ // if this keyframe even came from a configuration.
+ test!(
+ self.max_iter_count <= u64::try_from(i64::MAX).unwrap(),
+ "max. iter. count ({}) cannot be greater than ({})",
+ self.max_iter_count,
+ i64::MAX,
+ );
+
+ test!(self.zoom > 0x0, "zoom ({}) must be greater than zero", self.zoom);
+
+ test!(self.colour_range > 0.0, "colour range ({}) must be positive and non-zero", self.colour_range);
+
+ Ok(())
+ }
+}
+
+impl Default for Keyframe {
+ fn default() -> Self { Self {
+ frame: 0x0,
+ max_iter_count: 0x100,
+ centre: Complex::new(PRECISION),
+ seed: Complex::new(PRECISION),
+ zoom: Float::with_val(PRECISION, 0x1),
+ colour_range: 256.0,
+ } }
+}
diff --git a/benoit-cli/src/keyframe/keyframe_interpolater/mod.rs b/benoit-cli/src/keyframe/keyframe_interpolater/mod.rs
new file mode 100644
index 0000000..3faa546
--- /dev/null
+++ b/benoit-cli/src/keyframe/keyframe_interpolater/mod.rs
@@ -0,0 +1,95 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+use crate::keyframe::Keyframe;
+
+use benoit::complex::Complex;
+use rug::Float;
+
+/// Interpolater between keyframes.
+///
+/// This is done as an iterator over the interpolated values.
+#[derive(Clone, Debug)]
+pub struct KeyframeInterpolater {
+ pub(in super) frame: Option<u32>,
+ pub(in super) last_frame: u32,
+
+ pub(in super) max_iter_count: u64,
+ pub(in super) centre: Complex,
+ pub(in super) seed: Complex,
+ pub(in super) zoom: Float,
+ pub(in super) colour_range: f64,
+
+ pub(in super) max_iter_count_step: i64,
+ pub(in super) centre_step: Complex,
+ pub(in super) seed_step: Complex,
+ pub(in super) zoom_factor: Float,
+ pub(in super) colour_range_step: f64,
+}
+
+impl KeyframeInterpolater {
+ /// Advances the contained values to the next step.
+ ///
+ /// # Panics
+ ///
+ /// Panics if overflow occurs when calculating the new maximum iteration count.
+ /// This is guaranteed to not happen as long as the iterator hasn't been completed.
+ pub(in super) fn advance_values(&mut self) {
+ self.max_iter_count = self.max_iter_count
+ .checked_add_signed(self.max_iter_count_step)
+ .unwrap();
+
+ self.centre.real += &self.centre_step.real;
+ self.centre.imag += &self.centre_step.imag;
+ self.seed.real += &self.seed_step.real;
+ self.seed.imag += &self.seed_step.imag;
+ self.zoom *= &self.zoom_factor;
+ self.colour_range += self.colour_range_step;
+ }
+}
+
+impl Iterator for KeyframeInterpolater {
+ type Item = Keyframe;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ let frame = self.frame?;
+ assert!(frame <= self.last_frame);
+
+ let keyframe = Keyframe {
+ frame,
+ max_iter_count: self.max_iter_count,
+ centre: self.centre.clone(),
+ seed: self.seed.clone(),
+ zoom: self.zoom.clone(),
+ colour_range: self.colour_range,
+ };
+
+ self.frame = (frame != self.last_frame).then(|| {
+ self.advance_values();
+ frame + 0x1
+ });
+
+ Some(keyframe)
+ }
+}
diff --git a/benoit-cli/src/keyframe/mod.rs b/benoit-cli/src/keyframe/mod.rs
new file mode 100644
index 0000000..a4c722a
--- /dev/null
+++ b/benoit-cli/src/keyframe/mod.rs
@@ -0,0 +1,29 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+//! Animation keyframes.
+
+use crate::use_mod;
+use_mod!(pub, keyframe);
+use_mod!(pub, keyframe_interpolater);
diff --git a/benoit-cli/src/main.rs b/benoit-cli/src/main.rs
new file mode 100644
index 0000000..03494bd
--- /dev/null
+++ b/benoit-cli/src/main.rs
@@ -0,0 +1,90 @@
+/*
+ Copyright 2021, 2023-2024 Gabriel Bjørnager Jen-
+ sen.
+
+ This file is part of benoit-cli.
+
+ benoit-cli is free software: you can redistrib-
+ ute it and/or modify it under the terms of the
+ GNU General Public License as published by the
+ Free Software Foundation, either version 3 of
+ the License, or (at your option) any later ver-
+ sion.
+
+ benoit-cli is distributed in the hope that it
+ will be useful, but WITHOUT ANY WARRANTY; with-
+ out even the implied warranty of MERCHANTABILITY
+ or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU Gene-
+ ral Public License along with benoit-cli. If
+ not, see <https://www.gnu.org/licenses/>.
+*/
+
+macro_rules! use_mod {
+ ($visibility:vis, $name:ident) => {
+ mod $name;
+ $visibility use $name::*;
+ };
+}
+pub(in crate) use use_mod;
+
+pub mod config;
+pub mod error;
+pub mod instance;
+pub mod keyframe;
+
+use benoit::log;
+
+#[cfg(windows)]
+use windows::Win32::System::Console::SetConsoleTitleA;
+
+/// Execute according to the build mode.
+///
+/// Use this as a shorthand for testing `debug_assertions`.
+#[macro_export]
+macro_rules! debug {
+ ($($body:stmt)*) => { if cfg!(debug_assertions) { $($body)? } };
+}
+
+/// Sets the terminal's title.
+#[macro_export]
+macro_rules! set_title {
+ ($($format:tt)*) => {{
+ #[cfg(unix)]
+ let set_title = |title: &str| {
+ eprint!("\u{001B}]0;{title}\u{0007}");
+ };
+
+ #[cfg(windows)]
+ let set_title = |title: &str| {
+ unsafe { SetConsoleTitleA(title) };
+ };
+
+ let message = format!($($format)?);
+ set_title(&message);
+ }};
+}
+
+fn main() -> Result<(), i32> {
+ let config = match config::Config::load() {
+ Ok(config) => config,
+
+ Err(message) => {
+ log!(error, "{message}");
+ return Err(0x2);
+ },
+ };
+
+ log!(value, config);
+
+ let instance: instance::Instance = Default::default();
+
+ if let Err(message) = instance.run(&config) {
+ log!(error, "{message}");
+ return Err(0x1);
+ }
+
+ Ok(())
+}