scottokeebs/Extras/ScottoScripts/OLED Video/readme.md

OLED Video

Used to convert a video for display on a QMK OLED.

This should work on pretty much any QMK keyboard but I highly recommend using a controller with a decent amount of flash memory such as an RP2040.

Instructions

1. Generate your frames using extract_frames.py
   • They will output to the frames directory.
2. Upload those to Image2CPP
   1. Choose your dithering mode if you want to play with the look.
   2. Output should be set to Draw mode: Vertical - 1 bit per pixel
   3. Click Generate code and copy the output to frames.txt.
3. Generate your frames.c using create_frames_array.py.
   1. Copy frames.c and oled.c to your QMK keymap.
   2. Import oled.c into your keymap.c.
   3. Compile and flash.
4. You should now see a video playing on your OLED!

extract_frames.py

This is the script used to generate the video frames you will use to convert.

Argument	Type	Default	Description
input	str	required	Path to the input video file.
--fps	float	15	Playback frames per second.
--width	int	128	Width of the output frames in pixels.
--height	int	64	Height of the output frames in pixels.
--frames	int	120	Number of frames to extract from the video.
--format	str	gray	Output pixel format: gray, rgb24, or monow.
--speed	float	1.0	Playback speed of the video.