Kataglyphis-Inference-Engine
An inference engine with Flutter/Dart frontend and Rust/C++ backend, showcasing Gstreamer capabilities enhanced with AI. Read further if you are interested in cross platform AI inference.
uOverview
Kataglyphis-Inference-Engine bundles a Flutter/Dart frontend, a Rust/C++ inference core, and a rich set of camera streaming pipelines powered by GStreamer. The repository acts as an end-to-end reference for building cross-platform inference products that target desktop, web, and embedded devices.
Highlights & Key Features β Kataglyphis-Inference-Engine
π Highlights
- π¨ GStreamer native GTK integration β Leveraging users to write beautiful Linux AI inference apps.
- πΉ GStreamer WebRTC livestreaming with ready-to-use pipelines for USB, Raspberry Pi, and Orange Pi cameras.
- π flutter_rust_bridge integration β Ensures a seamless API boundary between Dart UI and Rust logic.
- π³ Containerized development flow plus native instructions for Windows, Linux, web. For details in my build environment look into Kataglyphis-ContainerHub
- π Python inference demos for rapid experimentation alongside the Rust core.
π Feature Status Matrix
Core Features
| Category | Feature | Win x64 | Linux x64 | Linux ARM64 | Linux RISC-V | Android |
|---|---|---|---|---|---|---|
| Camera Streaming | πΉ GStreamer WebRTC Livestream | βοΈ | βοΈ | βοΈ | βοΈ | N/A |
| Supported Cameras | π USB Devices | βοΈ | βοΈ | βοΈ | βοΈ | N/A |
| π Raspberry Pi Camera | N/A | βοΈ | βοΈ | βοΈ | N/A | |
| π Orange Pi Camera | N/A | β | β | β | N/A | |
| π± Native Camera API | N/A | N/A | N/A | N/A | βοΈ |
Infrastructure & Build
| Category | Feature | Win x64 | Linux x64 | Linux ARM64 | Linux RISC-V | Android |
|---|---|---|---|---|---|---|
| Containerization | π³ Dockerfile | βοΈ | βοΈ | βοΈ | βοΈ | N/A |
| π³ Docker Compose | N/A | βοΈ | βοΈ | βοΈ | N/A | |
| Native Integration | π¨ GTK Integration | N/A | βοΈ | βοΈ | βοΈ | N/A |
| πͺ Win32 API | βοΈ | N/A | N/A | N/A | N/A | |
| π€ Android NDK | N/A | N/A | N/A | N/A | βοΈ | |
| Bridge Layer | π flutter_rust_bridge | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
| Compiler | π§ Clang-CL | βοΈ | N/A | N/A | N/A | N/A |
| π§ GCC/Clang | N/A | βοΈ | βοΈ | βοΈ | βοΈ |
Testing & Quality Assurance
| Category | Feature | Win x64 | Linux x64 | Linux ARM64 | Linux RISC-V | Android |
|---|---|---|---|---|---|---|
| Unit Testing | π§ͺ Advanced unit testing | πΆ | πΆ | πΆ | πΆ | πΆ |
| Performance | β‘ Advanced performance testing | πΆ | πΆ | πΆ | πΆ | πΆ |
| Security | π Advanced fuzz testing | πΆ | πΆ | πΆ | πΆ | πΆ |
Frontend Platforms
| Category | Feature | Win x64 | Linux x64 | Linux ARM64 | Linux RISC-V | Android |
|---|---|---|---|---|---|---|
| Flutter UI | π¦ Flutter Web Support | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
| π» Flutter Desktop | βοΈ | βοΈ | βοΈ | βοΈ | N/A | |
| π± Flutter Mobile | N/A | N/A | N/A | N/A | βοΈ |
Platform Summary
| Platform | Architecture | Status | Notes |
|---|---|---|---|
| πͺ Windows | x86-64 | βοΈ | Built with clang-cl, Win32 integration |
| π§ Linux | x86-64 | βοΈ | Full GTK support, Docker ready |
| π§ Linux | ARM64 | βοΈ | SBC optimized (RPi, OPi support) |
| π§ Linux | RISC-V | βοΈ | Emerging architecture support |
| π€ Android | ARM64/x86-64 | βοΈ | Native camera, NDK integration |
Legend:
- βοΈ Completed - Feature fully implemented and tested
- πΆ In Progress - Active development underway
- β Not Started - Planned but not yet begun
- N/A - Not applicable for this platform
Quick Start
- Clone the repository with submodules:
NOTE: On Windows I use Git Bash instead of
Powershell or cmd
git clone --recurse-submodules --branch develop git@github.com:Kataglyphis/Kataglyphis-Inference-Engine.git
cd Kataglyphis-Inference-Engine
- Initialize submodules if needed.
If u used--recurse-submoduleswhile cloning you are already good.
Otherwise you can use this :smile:git submodule update --init --recursive
Refer to the detailed docs below for platform-specific requirements, camera streaming pipelines, and deployment workflows.
Im Projektroot ausfΓΌhren: dart doc
Danach Static-Server installieren: dart pub global activate dhttpd
export PATH="$PATH":"$HOME/.pub-cache/bin"
Falls dhttpd nicht gefunden wird, einmal PATH ergΓ€nzen: $env:Path += ";$env:USERPROFILE\AppData\Local\Pub\Cache\bin"
Server starten: dhttpd --path doc/api --host 127.0.0.1 --port 8080
Im Browser ΓΆffnen: http://127.0.0.1:8080
Documentation
| Topic | Location | Description |
|---|---|---|
| Getting Started | docs/source/getting-started.md | Environment prerequisites, installation, and run commands. |
| Platform Guides | docs/source/platforms.md | Container, Windows, Raspberry Pi, and web build instructions. |
| Camera Streaming | docs/source/camera-streaming.md | GStreamer WebRTC pipelines and Python inference demos. |
| Upgrade guide | docs/source/upgrade-guide.md | How to keep things up-to-date. |
Build the full documentation website with dart doc. The generated site in doc/api now includes the guides from docs/source.
Tests
Testing infrastructure is under active development. Track progress on the roadmap or contribute test plans via pull requests.
Roadmap
Upcoming features and improvements will be documented in this repository.
Please have a look docs/source/roadmap.md for more deetails.
Contributing
Contributions are what make the open-source community amazing. Any contributions are greatly appreciated.
- Fork the project.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
License
MIT (see here)
Acknowledgements
Thanks to the open-source community and all contributors!
Literature
Helpful tutorials, documentation, and resources:
Multimedia
Rust
Raspberry Pi
CMake/C++
Flutter/Dart
Protocols
Tooling
Android
Contact
Jonas Heinle
Twitter: @Cataglyphis_
Email: cataglyphis@jonasheinle.de
Project Links:
- GitHub: Kataglyphis-Inference-Engine
- Homepage: Official Site
Libraries
- blog_dependent_app_attributes
- blog_page_config
- js/gstwebrtc_api_interop
- l10n/app_localizations
- l10n/app_localizations_de
- l10n/app_localizations_en
- main
- my_two_cents_config
- Pages/AboutMePage/about_me_page
- Pages/AboutMePage/Widgets/about_me_table
- Pages/AboutMePage/Widgets/donation
- Pages/AboutMePage/Widgets/perfect_day_chart
- Pages/AboutMePage/Widgets/skill_table
- Pages/AboutMePage/Widgets/sqlite3_healthcheck_widget
- Pages/Blog/blog_page
- Pages/blog_dependent_screen_configurations
- Pages/DataPage/BlockOverviewPage/block_entry
- Pages/DataPage/BlockOverviewPage/block_entry_list
- Pages/DataPage/BlockOverviewPage/block_overview_page
- Pages/DataPage/BlockOverviewPage/block_overview_page_config
- Pages/DataPage/media_critics_page
- Pages/ErrorPage/error_page
- Pages/ErrorPage/error_page_stateful_branch_info_provider
- Pages/ErrorPage/error_page_widget
- Pages/Footer/Pages/configs/privacy_policy_config
- Pages/Home/home_config
- Pages/jotrockenmitlocken_screen_configurations
- Pages/LandingPage/landing_page
- Pages/StreamPage/stream_page
- Pages/StreamPage/webrtc_view
- Pages/StreamPage/webrtc_view_stub
- Routing/jotrockenmitlocken_router
- Widgets/Navigation/old/Navbar/mobile/drawer_item