https://github.com/sblantipodi/firefly_luciferin
Very fast Java screen capture PC software designed for the Glow Worm Luciferin firmware, the combination of these software create the perfect Bias Lighting and Ambient Light system for PC.
https://github.com/sblantipodi/firefly_luciferin
ambient-light ambilight bias-lighting esp esp32 esp8266 sk6812 ws2812b
Last synced: 3 months ago
JSON representation
Very fast Java screen capture PC software designed for the Glow Worm Luciferin firmware, the combination of these software create the perfect Bias Lighting and Ambient Light system for PC.
- Host: GitHub
- URL: https://github.com/sblantipodi/firefly_luciferin
- Owner: sblantipodi
- License: gpl-3.0
- Created: 2020-05-20T08:59:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-03-02T12:08:24.000Z (4 months ago)
- Last Synced: 2026-03-02T16:09:20.202Z (4 months ago)
- Topics: ambient-light, ambilight, bias-lighting, esp, esp32, esp8266, sk6812, ws2812b
- Language: Java
- Homepage:
- Size: 272 MB
- Stars: 430
- Watchers: 8
- Forks: 36
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Firefly Luciferin
Ambient Lighting or Bias Light is a technology that enhances your viewing experience by projecting colored lights onto the wall behind your TV/Monitor, matching the colors on the screen. This creates a more immersive and engaging atmosphere, making your favorite shows, movies, and games feel even more captivating.
**Luciferin** is a generic term for the light-emitting compound found in organisms that generate bioluminescence like Fireflies and Glow Worms. `Firefly Luciferin is a Java Fast Screen Capture` PC software designed for the [Glow Worm Luciferin](https://github.com/sblantipodi/glow_worm_luciferin) firmware, the combination of these software create the perfect `Bias Lighting and Ambient Light system for PC`.
_Written in Java with a native flavour for Windows and Linux._
[](https://sblantipodi.github.io/glow_worm_luciferin)
[](https://github.com/sblantipodi/firefly_luciferin/wiki)
[](https://github.com/sblantipodi/firefly_luciferin/releases)
[](https://www.dpsoftware.org)
[](https://discord.gg/aXf9jeN)
[](https://www.paypal.com/donate?hosted_button_id=ZEJM8ZLQW5E4A)
If you like **Firefly Luciferin**, give it a star, or fork it and contribute!
[](https://github.com/sblantipodi/firefly_luciferin/stargazers)
[](https://github.com/sblantipodi/firefly_luciferin/network)
[](https://github.com/sblantipodi/firefly_luciferin/releases)
[](https://github.com/sblantipodi/firefly_luciferin/actions)
[](https://github.com/sblantipodi/firefly_luciferin/actions/workflows/codeql.yml)
## Key features
- **Best in class performance** combined with ultra low CPU/GPU usage.
- Advanced algorithms for [**smooth colors transitions**](https://github.com/sblantipodi/firefly_luciferin/wiki/Smoothing-color-transitions) and [**color correction**](https://github.com/sblantipodi/firefly_luciferin/wiki/Color-Grading-(Hue-Saturation-and-Lightness-tuning)). Seeing is believing.
- [**Wireless or cabled, local or remote**](https://github.com/sblantipodi/firefly_luciferin/wiki/Remote-Access)? Choose your flavour with **MQTT** support and [**Home Assistant integration**](https://github.com/sblantipodi/firefly_luciferin/wiki/Home-Automation-configs).
- [**Multi monitor**](https://github.com/sblantipodi/firefly_luciferin/wiki/Multi-monitor-support) support with **single or multiple instances**.
- [**Surround lighting**](https://github.com/sblantipodi/firefly_luciferin/wiki/Surround-lighting-with-satellites) with satellites.
- [**Web browser firmware installer**](https://sblantipodi.github.io/glow_worm_luciferin/) and [**Web Interface**](https://github.com/sblantipodi/firefly_luciferin/wiki/Remote-Access#luciferin-web-interface).
- [**Programmable firmware**](https://github.com/sblantipodi/firefly_luciferin/wiki/Supported-GPIO-and-Baud-Rate), change your microcontroller's settings on the fly.
- Frequent updates, [**upgrade**](https://github.com/sblantipodi/firefly_luciferin/wiki/Luciferin-update-management) your PC software and your firmware **in one click**.
- Automatic [**switching between aspect ratios**](https://github.com/sblantipodi/firefly_luciferin/wiki/Aspect-ratio) based on your video content.
- **Made from a gamer, for gamers**. No added lag, stutter free.
- Multi platform, [**Windows**](https://github.com/sblantipodi/firefly_luciferin/wiki/Installers-and-binaries) and [**Linux**](https://github.com/sblantipodi/firefly_luciferin/wiki/Linux-support) ready. macOS is coming when it's ready.
- If you don't want to design your own PCB and you have a soldering iron, there is [**Luciferin's official PCB**](https://github.com/sblantipodi/firefly_luciferin/wiki/Ready-to-print-PCB).
- Have a question? [**Get answered on the community**](https://discord.gg/aXf9jeN).
## Quick start
You can **download the installer for Windows or Linux [here](https://github.com/sblantipodi/firefly_luciferin/releases)**.
The Linux version is also available on [Flathub](https://flathub.org/apps/org.dpsoftware.FireflyLuciferin)
and [Snap Store](https://github.com/sblantipodi/firefly_luciferin/issues/207)
This software can run on any Desktop PC using **Windows or Linux**. MacOS support will be added later.
To get the full `Bias Lighting` experience you need a microcontroller (ex. ESP8266, ESP32)
running [Glow Worm Luciferin](https://github.com/sblantipodi/glow_worm_luciferin) firmware. You can connect the
microcontroller to the PC via USB or via wireless (WiFi/Ethernet, MQTT server is optional).
Why don't you build your own `Luciferin`?
Here's a [**Quick Start guide**](https://github.com/sblantipodi/firefly_luciferin/wiki/Quick-start)
## Firefly Luciferin (PC Software) + Glow Worm Luciferin (Firmware)
[](https://youtu.be/PO37JC7-Nn4?si=nxVYd5b_qlfqo6HP)
#### (click the image above to watch it on YouTube)
## Easy to learn, easy to use
Effortless setup with minimal configuration required, yet highly customizable to meet specific needs.
[
](https://youtu.be/j7IV9rQr7J8)
#### (click the image above to watch it on YouTube)
## Luciferin Official PCB
If you don't want to design your own PCB and you have a soldering iron, you might
find [Luciferin's official PCB](https://github.com/sblantipodi/firefly_luciferin/wiki/Ready-to-print-PCB) interesting.
This page provides more information about
the [hardware compatibility](https://github.com/sblantipodi/firefly_luciferin/wiki/Compatible-Hardware) of Luciferin.
## What is the Performance Impact on your System?
Firefly Luciferin is a very optimized software and it has **nearly no impact on your system performance**.
By default Firefly Luciferin captures at 30FPS, if you want you can unlock the framerate.
If you are using a slow microcontroller, capturing at a very high framerate will not help. If you right click the tray icon and then click `FPS`,
you can see the output as shown in the image below. In that output you can see how fast the software is capturing the screen (producing)
and how fast your microcontroller is able to process (consume) this data.
Producer framerate should not exceed the consuming one, all data that is not consumed in time, is lost.
A good WiFi signal is required for wireless stream.
Are you interested in the achievable framerate? Click [here](https://github.com/sblantipodi/firefly_luciferin/wiki/Very-fast-capture).
## GPU Hardware Acceleration
Screen capturing is pretty slow and very CPU intensive in Windows systems (Linux is much more efficient in this regard),
for this reason I wrapped the Windows GDI32 C class using [Java Native Access](https://github.com/java-native-access/jna) to access Windows hardware acceleration.
This API captures and delivers captured frames in GPU memory.
If you are running Windows 8 or Windows 10/11 you can use `Desktop Duplication API (DDUPL)`, it's the fastest implementation yet, no lag,
no stutter, very small usage of resources. DDUPL is accessed via [JNA](https://github.com/java-native-access/jna) using the [GStreamer bindings for Java](https://gstreamer.freedesktop.org/bindings/java.html).
## Deep integration with your OS
Thanks to the `Java Foreign Function and Memory API`, Luciferin is deeply integrated with your operating system through a series of bindings to native libraries. This guarantees maximum efficiency and compatibility.
## Luciferin Web Interface
Glow Worm Luciferin FULL firmware exposes a `Web Interface` to control your lights from your browser without the needs of the Firefly Luciferin PC client.
## Home Assistant Mobile Client Screenshots
Glow Worm Luciferin firmware can be easily integrated in [Home Assistant](https://github.com/sblantipodi/firefly_luciferin/wiki/Home-Automation-configs).
## Contribute
You can contribute to Luciferin by:
- Providing Pull Requests (Features, Proof of Concepts, Language files or Fixes)
- Testing new released features and report issues
- Contributing missing documentation for features and devices
- With a donation [](https://www.paypal.com/donate?hosted_button_id=ZEJM8ZLQW5E4A)
## Credits
- Davide Perini