pigsqueeze 2.0.1
A library to write and read arbitrary data to and from image files. You probably already know why you need it.
License: MIT
Requires Python: >=3.8,<4.0

# pigsqueeze
[![CircleCI](https://circleci.com/gh/timwedde/pigsqueeze.svg?style=svg)](https://circleci.com/gh/timwedde/pigsqueeze)
[![Downloads](https://pepy.tech/badge/pigsqueeze)](https://pepy.tech/project/pigsqueeze)

A library to write and read arbitrary data to and from image files. You probably already know why you need it.

pigsuqeeze is a command line tool as well as a Python library for easily writing arbitrary data to (and later retrieving it from) image files. Currently only JPEG and PNG are supported, but I'm open to add support for more file formats if they support this.

For JPEG's, pigsqueeze stores binary data in one or more chunks of app-specific data segments as enabled by the JPEG specification. pigsqueeze automatically handles splitting large blobs of data across multiple chunks, since the limit per chunk is ~65KB. pigsqueeze's method allows for payload sizes of up ot ~15MB per segment. Multiple unused segments are available, so there is a theoretical limit of 135MB per image, which is probably plenty. If you need more, you should probably look at a different solution to your problem.

For PNG's, data is stored in out-of-spec chunks, which each have a limit of ~2GB. Because this is plenty large, pigsqueeze does not support chunk splitting for this format.

## Installation
pigsuqeeze can be installed via pip:
```bash
$ pip install pigsqueeze
```

## Usage
```bash
Usage: psz read-jpg [OPTIONS] INPUT_IMAGE OUTPUT_FILE

Options:
  -s, --segment INTEGER  [required]
  -i, --identifier TEXT  [required]
  --help                 Show this message and exit.
```

```bash
Usage: psz write-jpg [OPTIONS] INPUT_IMAGE DATA OUTPUT_FILE

Options:
  -s, --segment INTEGER  [required]
  -i, --identifier TEXT  [required]
  --help                 Show this message and exit.
```

```bash
Usage: psz read-png [OPTIONS] INPUT_IMAGE OUTPUT_FILE

Options:
  -c, --chunk TEXT       [required]
  -i, --identifier TEXT  [required]
  --help                 Show this message and exit.
```

```bash
Usage: psz write-png [OPTIONS] INPUT_IMAGE DATA OUTPUT_FILE

Options:
  -c, --chunk TEXT       [required]
  -i, --identifier TEXT  [required]
  --help                 Show this message and exit.
```

As a Python library:
```python
from pigsqueeze import load_image

# Write some text to App segment 4 with identifier PSZ
image = load_image("path/to/image.jpg")
image.write(4, "PSZ", b"Some bytes to save in the file.")
image.save("path/to/output.jpg")

# Retrieve the text from the modified image file
image = load_image("path/to/output.jpg")
result = image.read(4, "PSZ")
```

## Usage Notes
### JPEG
When adding data, a segment number needs to be specified. Available segment numbers are:
```python
[4, 5, 6, 7, 8, 9, 10, 11, 15]
```

### PNG
When adding data, a chunk name needs to be specified. The name must be 4 characters long. The first letter must be lowercase.
It can **not** be any of the following segment names:
- `IHDR`
- `PLTE`
- `IDAT`
- `IEND`
- `tRNS`
- `cHRM`
- `gAMA`
- `iCCP`
- `sBIT`
- `sRGB`
- `iTXt`
- `tEXt`
- `zTXt`
- `bKGD`
- `hIST`
- `pHYs`
- `sPLT`
- `tIME`