Skip to main content
# FBpyGIF
Pure Python implemented Memory-mapped Frame Buffer mainly for GIF animation on Raspberry pi

## Description
#### Problem domain
Recent Raspberry pi and similar single-board computers which needs efficient way to show image usually uses [fbi](https://www.kraxel.org/blog/linux/fbida/).
This pack of C libraries and programs are able to show GIF image properly thorugh direct frame buffer, but in lack of function to play GIF animation files.
#### Features
So I decided to make almost pure Python implemented library that is utilizing frame buffer and memory mapping.
The only a thing about 'pure' with this library is that it uses PIL library that is default installed python libarary on official Raspbian to convert image formats into raw BGR(A) and is also providing ways to use imagemagick as decompressor.
#### Note
There are many documents online how to mmap frame buffer with C, but none of similar are with Python, which also has mmap library by default. Actually there aren't so many examples about Python mmap library either. Hope this code helps you to understand how to ioctl and mmap not only frame buffers but also general Linux drivers with pure Python.

### To-do
- [x] Upload on PyPi to let it be installable with `pip install`.
- [x] Make installation script
- [x] Proper animtation time delay on every frames
- [x] Standard argument style launcher
- [x] Checking Python version
- [ ] Add more options to program
- [x] Shuffling
- [ ] Picture frame
- [x] Custom clearing
- [ ] Layer support
- [ ] Background loading of next animation file to reduce loading delay between them
- [ ] Optimize with setting screen to RGB mode by sending mailbox message (RGB_to_BGR function will be unused)
- [ ] Bugfix with wrong ioctl command. `dmesg` shows `bcm2708_fb soc:fb: Unknown ioctl 0x5401`
- [ ] Wiki documentation about ioctl and mmap with pure Python.

### Tested on
- Latest Raspbian on Raspberry pi 2 B+
- Archlinux (No, not with the ARM version on RPi, but the one on a vagrant VM)
- Ubuntu Mate Xenial on Odroid C2

### How to install
- prerequisite for pillow (for fresh raspbian)
```
sudo apt install libjpeg8-dev libfreetype6-dev libwebp-dev -y
```
- option1: use pip
```
sudo apt install python3-pip
sudo pip3 install fbpygif
```
- option2: use git and setup.py
```
sudo apt install git
git clone https://github.com/chidea/FBpyGIF
cd FBpyGIF
sudo python3 setup.py install
```

### How to use
These three are identical.
```
sudo FBpyGIF [directory or file list...]
sudo python3 -m FBpyGIF.main [...]
sudo python3 -m FBpyGIF [...]
```
- `FBpyGIF --help` to see all commands.
- Library and script is written for Python >= 3.
- Writing directly to frame buffer driver needs superuser priviledge.
- `FBpyGIF -ct` will put you into color test mode. (Aware of hypnotising screen ;) )
- Utility
- `python3 -m FBpyGIF.util size_cat ~/pictures` will categorize pictures based on its sizes and move into folders horizontal, vertical, square under the directory you run it.


Metadata

Release files for FBpyGIF 1.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for FBpyGIF 1.0.5
File Size Uploaded
FBpyGIF-1.0.5.tar.gz 12.7 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for FBpyGIF 1.0.5
File Interpreter ABI Platform
FBpyGIF-1.0.5-py3.4.egg Legacy Egg format - - Details
FBpyGIF-1.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 53.2 kB

Release files / FBpyGIF-1.0.5.tar.gz

Download URL FBpyGIF-1.0.5.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
8b4822ce0727e457ae8ce73242b82d40d7a72c0922a7bb6b721de6a1550f6320
BLAKE2b-256 checksum
How to use checksums
b6bb2d735e37f828d2548650f6b9b5b5b9b5d07735a2971995941879aac2cd61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / FBpyGIF-1.0.5-py3.4.egg

Download URL FBpyGIF-1.0.5-py3.4.egg
Size 25.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
4e06a4f72e7ba9ba6f55b471676fbad3b7fff3685d7928712d0ba2b04b804b60
BLAKE2b-256 checksum
How to use checksums
26467cb77a719a652d30e010243d0c6a7e0add9f44d1c00efe16d3ad7718cda8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / FBpyGIF-1.0.5-py3-none-any.whl

Download URL FBpyGIF-1.0.5-py3-none-any.whl
Size 14.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
117abc9a97f5316e92e1cf3b1674330a73bd2095cacc55f0c8fe317006f5c700
BLAKE2b-256 checksum
How to use checksums
7d8d26eafb98481fd831fcc1df459020129de21b9083f60c95003ef035b7a0c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.5 This release

3 release files

1.0.4

2 release files

1.0.3

3 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page