https://github.com/zuidvolt/blurhash-avif
A library to generate BlurHash's and PNG data URLs for AVIF images
https://github.com/zuidvolt/blurhash-avif
Last synced: 3 months ago
JSON representation
A library to generate BlurHash's and PNG data URLs for AVIF images
- Host: GitHub
- URL: https://github.com/zuidvolt/blurhash-avif
- Owner: ZuidVolt
- License: apache-2.0
- Created: 2024-09-03T09:43:40.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-06T08:23:13.000Z (9 months ago)
- Last Synced: 2025-01-11T22:35:51.244Z (4 months ago)
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BlurHash-AVIF
A Python library extending the Python BlurHash implementation to generate BlurHash strings and PNG data URLs for AVIF images.
**Disclaimer:** This is an unofficial extension and has no affiliation with the original BlurHash developers. All credit for the BlurHash concept and implementation goes to its creators.
## Table of Contents
1. [Installation](#installation)
2. [Features](#features)
3. [Requirements](#requirements)
4. [Usage](#usage)
5. [Troubleshooting](#troubleshooting)
6. [Contributing](#contributing)
7. [Attribution](#attribution)
8. [License](#license)
## Installation
Install the library using pip:
```bash
pip install blurhash-avif
```
## Features
- Generate BlurHash strings from AVIF images
- Create base64-encoded PNG data URLs from AVIF images
- Maintain image aspect ratio during processing
- Support RGB mode images
- Optimize image loading for improved website performance
## Requirements
- Python 3.x
- Pillow (PIL) library with AVIF support
- NumPy library
- base64 library
- blurhash library
## Usage
The library provides six main functions:
1. `encode_image_to_blurhash`: Create a BlurHash string from an AVIF image.
2. `encode_image_to_png_data_url`: Generate a base64-encoded PNG data URL from an AVIF image.
3. `encode_image_to_blurhash_and_png_data_url`: Produce both a BlurHash string and a PNG data URL.
4. `batch_encode_image_to_blurhash`: Generates BlurHash strings for all AVIF images in a given directory.
5. `batch_encode_image_to_png_data_url`: Generates base64-encoded PNG data URLs for all AVIF images in a given directory.
6. `batch_encode_image_to_blurhash_and_png_data_url`: Generates BlurHash strings and base64-encoded PNG data URLs for all AVIF images in a given directory.
### Example Usage
```python
from blurhash_avif import (
encode_image_to_blurhash,
encode_image_to_png_data_url,
encode_image_to_blurhash_and_png_data_url,
batch_encode_image_to_blurhash,
batch_encode_image_to_png_data_url,
batch_encode_image_to_blurhash_and_png_data_url,
)
# Path to your AVIF file
avif_path = "path/to/your/image.avif"
# Generate BlurHash string
blurhash = encode_image_to_blurhash(avif_path)
if blurhash:
print(f"BlurHash: {blurhash}")
else:
print("Failed to generate BlurHash")
# Generate PNG data URL
data_url = encode_image_to_png_data_url(avif_path)
if data_url:
print(f"PNG Data URL: {data_url[:50]}...") # Print first 50 characters
else:
print("Failed to generate PNG Data URL")
# Generate both BlurHash and PNG data URL
blurhash, data_url = encode_image_to_blurhash_and_png_data_url(avif_path)
if blurhash and data_url:
print(f"BlurHash: {blurhash}")
print(f"PNG Data URL: {data_url[:50]}...") # Print first 50 characters
else:
print("Failed to generate BlurHash and PNG Data URL")
# Batch generate BlurHash strings
directory = "path/to/your/images"
blurhash_dict = batch_encode_image_to_blurhash(directory)
print(blurhash_dict)
# Batch generate PNG data URLs
data_url_dict = batch_encode_image_to_png_data_url(directory)
print(data_url_dict)
# Batch generate BlurHash strings and PNG data URLs
blurhash_dict, data_url_dict = batch_encode_image_to_blurhash_and_png_data_url(directory)
print(blurhash_dict)
print(data_url_dict)
```
## Troubleshooting
If you encounter issues with Pillow's AVIF support, try:
```bash
pip uninstall pillow
pip install "pillow[avif]"
```
you man need to install the `aviflib` library.
To install the required `aviflib` library, follow these steps:
**On macOS (using Homebrew):**
```bash
brew install libavif
```
**On Ubuntu/Debian:**
```bash
sudo apt-get install libavif-dev
```
**On windows**
```bash
pip install aom
```
or
**On windows (vcpkg)**
```bash
vcpkg install libavif
```
## Contributing
We welcome contributions! To contribute:
1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Open a pull request
## Attribution
This package extends the Python BlurHash library. BlurHash was originally created by Dag Ågren for Wolt. The BlurHash algorithm and official implementations are available at the [BlurHash GitHub repository](https://github.com/woltapp/blurhash).
## License
This project is licensed under the Apache License, Version 2.0 with important additional terms, including specific commercial use conditions. Users are strongly advised to read the full [LICENSE](LICENSE) file carefully before using, modifying, or distributing this work. The additional terms contain crucial information about liability, data collection, indemnification, and commercial usage requirements that may significantly affect your rights and obligations.
---
Keywords: BlurHash, AVIF, image processing, Python, base64, PNG, data URL, image optimization, web performance, placeholder images