From 21985fe615616fa4309051b9fd903c83b288445c Mon Sep 17 00:00:00 2001 From: Lachezar Lechev Date: Mon, 13 Jun 2022 19:26:43 +0200 Subject: [PATCH] Initialize embedded-fps --- .gitignore | 2 + Cargo.toml | 36 ++++ LICENSE-APACHE | 201 ++++++++++++++++++++++ LICENSE-MIT | 23 +++ README.md | 42 +++++ examples/embedded_graphics.rs | 46 ++++++ examples/fps_counter.rs | 16 ++ src/lib.rs | 302 ++++++++++++++++++++++++++++++++++ 8 files changed, 668 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 examples/embedded_graphics.rs create mode 100644 examples/fps_counter.rs create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..869df07 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..d32e915 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,36 @@ +[package] +name = "embedded-fps" +version = "0.1.0" +authors = ["Lechev.space ", "Lachezar Lechev"] +description = "" +categories = ["embedded", "no-std", "graphics"] + +keywords = ["graphics", "embedded", "no_std", "frames per second", "fps"] +license = "MIT OR Apache-2.0" +repository = "https://github.com/LechevSpace/embedded-fps" +documentation = "https://docs.rs/embedded-fps" + +edition = "2021" +# Because of `holodeque` and the `array_map` rust feature that was introduced in 1.55 +# and edition 2021 requires at least 1.56 +rust-version = "1.56" + +[features] + +default = [] +std = [] + +[[example]] +name = "fps_counter" +required-features = ["std"] + +[[example]] +name = "embedded_graphics" +required-features = ["std"] + +[dependencies] +embedded-time = "0.12" +holodeque = {version = "0.2", default-features = false, git = "https://github.com/elpiel/holodeque", branch = "derive-copy-for-array-deque"} +# used for the `embedded-graphics` example +embedded-graphics-simulator = "0.3" +embedded-graphics = "0.7" \ No newline at end of file diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..468cd79 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c27a70 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# embedded-fps +[![sponsor-us]](https://github.com/sponsors/LechevSpace) [![crates-io]](https://crates.io/crates/embedded-fps) [![docs-rs]](https://docs.rs/embedded-fps) +## Frames Per Second counter for embedded devices. + +Create an `FPS` struct by passing the `MAX_FPS` (maximum frames per seconds) +that you expect to hit and a [`embedded_time`][embedded-time-docs]`::Clock` implementation. + +[embedded-time-docs]: https://docs.rs/embedded-time/ +[crates-io]: https://img.shields.io/crates/v/embedded-fps?logo=rust&style=for-the-badge +[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K +[sponsor-us]: https://img.shields.io/github/sponsors/LechevSpace?color=bf3989&label=Sponsor%20us&style=for-the-badge&logoColor=bf3989&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyBoZWlnaHQ9IjE2IiB2aWV3Qm94PSIwIDAgMTYgMTYiIHZlcnNpb249IjEuMSIgd2lkdGg9IjE2IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogICAgPHBhdGggZmlsbD0iI2JmMzk4OSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNNC4yNSAyLjVjLTEuMzM2IDAtMi43NSAxLjE2NC0yLjc1IDMgMCAyLjE1IDEuNTggNC4xNDQgMy4zNjUgNS42ODJBMjAuNTY1IDIwLjU2NSAwIDAwOCAxMy4zOTNhMjAuNTYxIDIwLjU2MSAwIDAwMy4xMzUtMi4yMTFDMTIuOTIgOS42NDQgMTQuNSA3LjY1IDE0LjUgNS41YzAtMS44MzYtMS40MTQtMy0yLjc1LTMtMS4zNzMgMC0yLjYwOS45ODYtMy4wMjkgMi40NTZhLjc1Ljc1IDAgMDEtMS40NDIgMEM2Ljg1OSAzLjQ4NiA1LjYyMyAyLjUgNC4yNSAyLjV6TTggMTQuMjVsLS4zNDUuNjY2LS4wMDItLjAwMS0uMDA2LS4wMDMtLjAxOC0uMDFhNy42NDMgNy42NDMgMCAwMS0uMzEtLjE3IDIyLjA3NSAyMi4wNzUgMCAwMS0zLjQzNC0yLjQxNEMyLjA0NSAxMC43MzEgMCA4LjM1IDAgNS41IDAgMi44MzYgMi4wODYgMSA0LjI1IDEgNS43OTcgMSA3LjE1MyAxLjgwMiA4IDMuMDIgOC44NDcgMS44MDIgMTAuMjAzIDEgMTEuNzUgMSAxMy45MTQgMSAxNiAyLjgzNiAxNiA1LjVjMCAyLjg1LTIuMDQ1IDUuMjMxLTMuODg1IDYuODE4YTIyLjA4IDIyLjA4IDAgMDEtMy43NDQgMi41ODRsLS4wMTguMDEtLjAwNi4wMDNoLS4wMDJMOCAxNC4yNXptMCAwbC4zNDUuNjY2YS43NTIuNzUyIDAgMDEtLjY5IDBMOCAxNC4yNXoiPjwvcGF0aD4KPC9zdmc%2BCg%3D%3D + +### Frames Per Second with a simple for-loop + +Run the example from the `examples` directory using: + +`cargo run --features=std --example fps_counter` + +### Frames Per Second with `embedded-graphics` + +This crate is suitable for usage with the [`embedded-graphics`] crate +when you want to know, log or even show the frames per second of a +display with an embedded device. + +Note: This example requires [`embedded-graphics-simulator`] and `SDL2` installed +on your machine. + +Refer to the [`embedded-graphics-simulator` documentation][simulator-docs] +for detailed instructions. + +You can run this example from the `examples` directory using: + +`cargo run --features=std --example fps_counter` + +## Crate features + +- `std` - enables [`StdClock`] - a [`Clock`] implementation using [`std`] for usage on a host machine. + +[`StdClock`]: crate::StdClock +[`embedded-graphics`]: https://crates.io/crates/embedded-graphics +[`embedded-graphics-simulator`]: https://crates.io/crates/embedded-graphics-simulator +[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup \ No newline at end of file diff --git a/examples/embedded_graphics.rs b/examples/embedded_graphics.rs new file mode 100644 index 0000000..1bea224 --- /dev/null +++ b/examples/embedded_graphics.rs @@ -0,0 +1,46 @@ +use embedded_fps::{StdClock, FPS}; +use embedded_graphics::{ + draw_target::DrawTarget, + mono_font::{ascii::FONT_10X20, MonoTextStyle}, + pixelcolor::BinaryColor, + prelude::{Point, Size}, + text::Text, + Drawable, +}; +use embedded_graphics_simulator::{ + OutputSettingsBuilder, SimulatorDisplay, SimulatorEvent, Window, +}; + +pub const DISPLAY_360P: Size = Size::new(480, 360); + +fn main() -> Result<(), core::convert::Infallible> { + let mut display = SimulatorDisplay::::new(DISPLAY_360P); + + let output_settings = OutputSettingsBuilder::new().scale(1).build(); + let mut window = Window::new("FPS using embedded-graphics & simulator", &output_settings); + + // starts the StdClock + // `200` MAX_FPS is more than enough since `SimulatorDisplay` + // doesn't reach more than `15` FPS when using `BinaryColor`. + let mut fps_counter = FPS::<200, StdClock>::default(); + // create an initial value for FPS + let mut fps = 0; + + 'running: loop { + display.clear(BinaryColor::Off)?; + + let character_style = MonoTextStyle::new(&FONT_10X20, BinaryColor::On); + let fps_position = Point::new(20, 30); + + Text::new(&format!("FPS: {fps}"), fps_position, character_style).draw(&mut display)?; + + window.update(&display); + + if window.events().any(|e| e == SimulatorEvent::Quit) { + break 'running Ok(()); + } + + // tick and update the FPS at the end of the loop + fps = fps_counter.tick(); + } +} diff --git a/examples/fps_counter.rs b/examples/fps_counter.rs new file mode 100644 index 0000000..a6552b2 --- /dev/null +++ b/examples/fps_counter.rs @@ -0,0 +1,16 @@ +use embedded_fps::{StdClock, FPS}; +use std::{thread::sleep, time::Duration}; + +fn main() { + let std_clock = StdClock::default(); + let mut fps_counter = FPS::<10, _>::new(std_clock); + + for _ in 0..30 { + // sleep for 125 milliseconds + // this will give us 8 FPS + sleep(Duration::from_millis(125)); + + let fps = fps_counter.tick(); + println!("Frames per second: {fps}") + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..2d3d60c --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,302 @@ +//! [![sponsor-us]](https://github.com/sponsors/LechevSpace) [![github]](https://github.com/LechevSpace/embedded-fps) [![crates-io]](https://crates.io/crates/embedded-fps) +//! +//! Frames Per Second counter for embedded devices. +//! +//! Create an [`FPS`] struct by passing the `MAX_FPS` (maximum frames per seconds) +//! that you expect to hit and a [`embedded_time::Clock`] implementation. +//! +//! # Examples +//! +//! ## Frames Per Second with a simple for-loop +//! +//! You can also run this example from the `examples` directory using: +//! +//! `cargo run --features=std --example fps_counter` +//! +//! ``` +//! use embedded_fps::{FPS, StdClock}; +//! use std::{thread::sleep, time::Duration}; +//! +//! let std_clock = StdClock::default(); +//! let mut fps_counter = FPS::<10, _>::new(std_clock); +//! +//! for i in 0..20 { +//! // sleep for 125 milliseconds +//! // this will give us 8 FPS +//! sleep(Duration::from_millis(125)); +//! +//! let fps = fps_counter.tick(); +//! println!("Frames per second: {fps}") +//! } +//! ``` +//! +//! ## Frames Per Second with `embedded-graphics` +//! +//! This crate is suitable for usage with the [`embedded-graphics`] crate +//! when you want to know, log or even show the frames per second of a +//! display with an embedded device. +//! +//! Note: This example requires [`embedded-graphics-simulator`] and `SDL2` installed +//! on your machine. +//! +//! Refer to the [`embedded-graphics-simulator` documentation][simulator-docs] +//! for detailed instructions. +//! +//! You can also run this example from the `examples` directory using: +//! +//! `cargo run --features=std --example fps_counter` +//! +//! ```no_run +//! use embedded_fps::{StdClock, FPS}; +//! use embedded_graphics::{ +//! draw_target::DrawTarget, +//! mono_font::{ascii::FONT_10X20, MonoTextStyle}, +//! pixelcolor::BinaryColor, +//! prelude::{Point, Size}, +//! text::Text, +//! Drawable, +//! }; +//! use embedded_graphics_simulator::{ +//! OutputSettingsBuilder, SimulatorDisplay, SimulatorEvent, Window, +//! }; +//! +//! pub const DISPLAY_360P: Size = Size::new(480, 360); +//! +//! fn main() -> Result<(), core::convert::Infallible> { +//! let mut display = SimulatorDisplay::::new(DISPLAY_360P); +//! +//! let output_settings = OutputSettingsBuilder::new().scale(1).build(); +//! let mut window = Window::new("FPS using embedded-graphics & simulator", &output_settings); +//! +//! // starts the StdClock +//! // `200` MAX_FPS is more than enough since `SimulatorDisplay` +//! // doesn't reach more than `15` FPS when using `BinaryColor`. +//! let mut fps_counter = FPS::<200, StdClock>::default(); +//! // create an initial value for FPS +//! let mut fps = 0; +//! +//! 'running: loop { +//! display.clear(BinaryColor::Off)?; +//! +//! let character_style = MonoTextStyle::new(&FONT_10X20, BinaryColor::On); +//! let fps_position = Point::new(20, 30); +//! +//! Text::new(&format!("FPS: {fps}"), fps_position, character_style).draw(&mut display)?; +//! +//! window.update(&display); +//! +//! if window.events().any(|e| e == SimulatorEvent::Quit) { +//! break 'running Ok(()); +//! } +//! +//! // tick and update the FPS at the end of the loop +//! fps = fps_counter.tick(); +//! } +//! } +//! ``` +//! +//! # Crate features +//! +//! - `std` - enables [`StdClock`] - a [`Clock`] implementation using [`std`] for usage on a host machine. +//! +//! [`StdClock`]: crate::StdClock +//! [`embedded-graphics`]: https://crates.io/crates/embedded-graphics +//! [`embedded-graphics-simulator`]: https://crates.io/crates/embedded-graphics-simulator +//! [simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup +//! [github]: https://img.shields.io/badge/github-3873AD?style=for-the-badge&labelColor=555555&logo=github +//! [crates-io]: https://img.shields.io/crates/v/embedded-fps?logo=rust&style=for-the-badge +//! [sponsor-us]: https://img.shields.io/github/sponsors/LechevSpace?color=bf3989&label=Sponsor%20us&style=for-the-badge&logoColor=bf3989&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyBoZWlnaHQ9IjE2IiB2aWV3Qm94PSIwIDAgMTYgMTYiIHZlcnNpb249IjEuMSIgd2lkdGg9IjE2IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogICAgPHBhdGggZmlsbD0iI2JmMzk4OSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNNC4yNSAyLjVjLTEuMzM2IDAtMi43NSAxLjE2NC0yLjc1IDMgMCAyLjE1IDEuNTggNC4xNDQgMy4zNjUgNS42ODJBMjAuNTY1IDIwLjU2NSAwIDAwOCAxMy4zOTNhMjAuNTYxIDIwLjU2MSAwIDAwMy4xMzUtMi4yMTFDMTIuOTIgOS42NDQgMTQuNSA3LjY1IDE0LjUgNS41YzAtMS44MzYtMS40MTQtMy0yLjc1LTMtMS4zNzMgMC0yLjYwOS45ODYtMy4wMjkgMi40NTZhLjc1Ljc1IDAgMDEtMS40NDIgMEM2Ljg1OSAzLjQ4NiA1LjYyMyAyLjUgNC4yNSAyLjV6TTggMTQuMjVsLS4zNDUuNjY2LS4wMDItLjAwMS0uMDA2LS4wMDMtLjAxOC0uMDFhNy42NDMgNy42NDMgMCAwMS0uMzEtLjE3IDIyLjA3NSAyMi4wNzUgMCAwMS0zLjQzNC0yLjQxNEMyLjA0NSAxMC43MzEgMCA4LjM1IDAgNS41IDAgMi44MzYgMi4wODYgMSA0LjI1IDEgNS43OTcgMSA3LjE1MyAxLjgwMiA4IDMuMDIgOC44NDcgMS44MDIgMTAuMjAzIDEgMTEuNzUgMSAxMy45MTQgMSAxNiAyLjgzNiAxNiA1LjVjMCAyLjg1LTIuMDQ1IDUuMjMxLTMuODg1IDYuODE4YTIyLjA4IDIyLjA4IDAgMDEtMy43NDQgMi41ODRsLS4wMTguMDEtLjAwNi4wMDNoLS4wMDJMOCAxNC4yNXptMCAwbC4zNDUuNjY2YS43NTIuNzUyIDAgMDEtLjY5IDBMOCAxNC4yNXoiPjwvcGF0aD4KPC9zdmc%2BCg%3D%3D + +// Rustdoc lints +#![deny(rustdoc::broken_intra_doc_links)] +// Rustc lints +#![deny(missing_docs, unused_imports)] +// adds `#[no_std]` attribute if the `std` feature is not enabled +#![cfg_attr(not(feature = "std"), no_std)] + +use embedded_time::{duration::Seconds, Clock, Instant}; +use holodeque::ArrayDeque; + +#[cfg(feature = "std")] +#[doc(inline)] +pub use std_clock::StdClock; + +/// Measures Frames Per Second (FPS). +/// +/// `MAX_FPS` - Defines the maximum FPS that you expect to measure. +#[derive(Debug, Clone)] +pub struct FPS { + /// The last registered frames. + last_second_frames: ArrayDeque>, MAX_FPS>, + /// The embedded [`Clock`] that will be used to track the passed second. + clock: C, +} + +impl FPS { + /// Creates a new Frames Per Second counter. + pub fn new(clock: C) -> FPS { + FPS { + last_second_frames: ArrayDeque::<_, MAX_FPS>::new(), + clock, + } + } + + /// Adds another frame tick and returns the current Frames Pre Second. + /// + /// # Panics + /// + /// When [`Clock::try_now()`] returns an error or if the `MAX_FPS` is reached. + pub fn tick(&mut self) -> usize { + self.try_tick().unwrap() + } + + /// Adds another frame tick and returns the current Frames Pre Second. + /// + /// This method will not panic if the `MAX_FPS` is reached, + /// instead it will just return the `MAX_FPS` value (capping it in a nutshell). + /// + /// # Panics + /// + /// If [`Clock::try_now()`] returns an error. + pub fn tick_max(&mut self) -> usize { + self.try_tick_max().unwrap() + } + + /// Adds another frame tick and returns the current Frames Pre Second. + /// + /// This method will not return an error if the `MAX_FPS` is reached, + /// instead it will just return the `MAX_FPS` value (capping it in a nutshell). + pub fn try_tick_max(&mut self) -> Result { + match self.try_tick() { + Ok(fps) => Ok(fps), + Err(Error::MaxFPS(_)) => Ok(MAX_FPS), + Err(err) => Err(err), + } + } + + /// Adds another frame tick and returns the current Frames Pre Second. + /// + /// # Panics + /// + /// When [`Clock::try_now()`] returns an error or if the `MAX_FPS` is reached. + pub fn try_tick(&mut self) -> Result { + let now = self.clock.try_now().map_err(Error::Clock)?; + let a_second_ago = now - Seconds(1); + + while self + .last_second_frames + .front() + .copied() + .flatten() + .map_or(false, |tick| tick < a_second_ago) + { + self.last_second_frames.pop_front(); + } + + self.last_second_frames + .push_back(Some(now)) + .map_err(|_cap_err| Error::MaxFPS(MAX_FPS))?; + + // return the frames per second + Ok(self.last_second_frames.len()) + } +} + +impl Default for FPS +where + C: Clock + Default, +{ + fn default() -> Self { + Self::new(C::default()) + } +} + +#[derive(Debug)] +/// The errors that [`FPS`] can return. +/// +/// Keep in mind that [`Error::MaxFPS`] will trigger panic on [`FPS::tick`] +/// or be returned as an error on [`FPS::try_tick`]. +pub enum Error { + /// The clock returned an error when calling [`Clock::try_now`]. + Clock(embedded_time::clock::Error), + /// The maximum reading of Frames per second was reached + /// The internal deque reached it's capacity. + /// + /// Increase the `MAX_FPS` to avoid this problem. + MaxFPS(usize), +} + +#[cfg(feature = "std")] +mod std_clock { + use std::time::Instant as StdInstant; + + use embedded_time::{clock::Error, rate::Fraction, Clock, Instant as EmbeddedInstant}; + + /// A Standard clock based on [`std`]. + /// + /// It takes the [`Instant::elapsed()`] time and uses nanoseconds converted to [`u64`]. + /// This still leaves us with ~594 years of representable time + /// + /// [`Instant::elapsed()`]: std::time::Instant::elapsed() + #[derive(Debug, Clone, Copy)] + pub struct StdClock(StdInstant); + + impl Default for StdClock { + fn default() -> Self { + Self::new() + } + } + + impl StdClock { + /// Creates a new [`StdClock`]. + /// Internally it calls [`Instant::now()`]. + /// + /// [`Instant::now()`]: std::time::Instant::now() + pub fn new() -> Self { + Self(StdInstant::now()) + } + } + + impl Clock for StdClock { + type T = u64; + + const SCALING_FACTOR: Fraction = Fraction::new(1, 1_000_000_000); + + fn try_now(&self) -> Result, Error> { + // discarding the upper u64 still leaves us with ~594 years of representable time + Ok(EmbeddedInstant::new(self.0.elapsed().as_nanos() as u64)) + } + } + + #[cfg(test)] + mod tests { + use std::thread::sleep; + + use embedded_time::{ + duration::{Extensions, Milliseconds}, + Clock, + }; + + use super::StdClock; + + #[test] + fn it_creates_std_instant_from_milliseconds_clock() { + let clock = StdClock::new(); + + sleep(std::time::Duration::from_millis(400)); + + let start = clock.try_now().unwrap(); + // wait 1.5 seconds + sleep(std::time::Duration::from_millis(1_600)); + let end = clock.try_now().unwrap(); + + let elapsed = Milliseconds::::try_from(end - start).unwrap(); + + let lower_bound = Milliseconds::::try_from(1_599_u32.milliseconds()).unwrap(); + assert!(elapsed > lower_bound); + + let upper_bound = Milliseconds::::try_from(2_000_u32.milliseconds()).unwrap(); + assert!(elapsed < upper_bound); + } + } +}