Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ripe-tech/pconvert-rust
The Rust version of the famous P(NG)Convert
https://github.com/ripe-tech/pconvert-rust
composition image javascript pconvert png python rust wasm
Last synced: 29 days ago
JSON representation
The Rust version of the famous P(NG)Convert
- Host: GitHub
- URL: https://github.com/ripe-tech/pconvert-rust
- Owner: ripe-tech
- License: apache-2.0
- Created: 2020-09-02T14:18:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-13T15:49:51.000Z (over 1 year ago)
- Last Synced: 2024-11-16T22:38:26.356Z (about 1 month ago)
- Topics: composition, image, javascript, pconvert, png, python, rust, wasm
- Language: Rust
- Homepage:
- Size: 3.73 MB
- Stars: 6
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# P(NG)Convert Rust
The [Rust](https://www.rust-lang.org) version of the famous [P(NG)Convert](https://github.com/hivesolutions/pconvert) from Hive Solutions.
This Rust crate can be used as a **command line application**, as a **crate** in another rust project, as a **Web Assembly module** (able to be used within JavaScript that targets web browsers or NodeJS) or as a **Python package**.
## Command Line Application
### Compiling & Executing
Build and run with:
```bash
cargo run
```
Alternatively, compile first with:
```bash
cargo build
```
and then run the binary with:
```bash
./target/debug/pconvert-rust
```
Additionally, for better code optimization, compile with the `--release` flag:
```bash
cargo build --release
```
and then run the release binary with:
```bash
./target/release/pconvert-rust
```
### Usage
```console
$ pconvert-rust
Usage: pconvert-rust [args...]
where command can be one of the following: compose, convert, benchmark, version
```
```console
$ pconvert-rust compose
```
```console
$ pconvert-rust convert
```
```console
$ pconvert-rust benchmark [--parallel]
```
```console
$ pconvert-rust version
```
### Example
```rust
// blends the provided image as a new image to be used
// under the current instance
let top = pconvert_rust::utils::read_png_from_file("top.png".to_string(), false).unwrap();
let mut bottom = pconvert_rust::utils::read_png_from_file("bottom.png".to_string(), false).unwrap();
// gathers the mask top blending algorithm function and
// uses it to blend both images
let blending_fn = pconvert_rust::blending::get_blending_algorithm(
&pconvert_rust::blending::BlendAlgorithm::DestinationOver,
);
pconvert_rust::blending::blend_images(&mut bottom, &top, &blending_fn, &None);
// "outputs" the blended image contents to the `out.png` file
pconvert_rust::utils::write_png_to_file_d("out.png".to_string(), &bottom).unwrap();
```
## WebAssembly (WASM) Module
### Compiling & Executing
Follow [this guide](https://developer.mozilla.org/en-US/docs/WebAssembly/Rust_to_wasm) on how to install `wasm-pack`.
To build, use the `wasm-extension` feature:
```bash
wasm-pack build -- --features wasm-extension
```
To run the demo, follow [this](https://developer.mozilla.org/en-US/docs/WebAssembly/Rust_to_wasm#Making_our_package_availabe_to_npm).
### Usage
Check the [demo site](examples/wasm/index.js) to see how to use the PConvert WASM module.
JavaScript API exposed:
```javascript
// blends two File objects and returns a File object
blendImages(bot, top, targetFileName, algorithm, isInline, options)
// blends two ImageData objects and returns an ImageData object
blendImagesData(bot, top, algorithm, isInline, options)
// blends multiple File objects and returns a File object
blendMultiple(imageFiles, targetFileName, algorithm, algorithms, isInline, options)
// blends multiple ImageData objects and returns an ImageData object
blendMultipleData(images, algorithm, algorithms, isInline, options)
// benchmarks and prints to console various times for different combinations of blending algorithms, compression algorithms and filters for `blendImages`
blendImagesBenchmarkAll(bot, top, isInline)
// benchmarks and prints to console various times for different combinations of blending algorithms, compression algorithms and filters for `blendMultiple`
blendMultipleBenchmarkAll(imageFiles, isInline)
// returns a JSON of module constants (e.g. ALGORITHMS, FILTER_TYPES, COMPILER_VERSION, ...)
getModuleConstants()
```
## Python package
### Compiling & Executing
This crate can be installed as a python package through the use of `pip`. Simply run:
```bash
pip install .
```
### Usage
Check [this folder](examples/python/) for examples.
Import the python package with:
```python
import pconvert_rust
```
Python API exposed. The parameter `options` is a python dictionary of optional parameters and if `num_threads` is specified with a value of 1 or more, the work load will be distributed across multiple threads (belonging to a internally managed thread pool).
```python
# blends two images read from the local file system and writes the result to the file system
blend_images(bot_path, top_path, target_path, algorithm, is_inline, options)
# blends multiple images read from the local file system and writes the result to the file system
blend_multiple(img_paths, out_path, algorithm, algorithms, is_inline, options)
# returns a python dict with summary information about the internal thread pool (size, active jobs, queued jobs)
get_thread_pool_status()
# access module constants (e.g. ALGORITHMS, FILTER_TYPES, COMPILER_VERSION, ...)
pconvert_rust.ALGORITHMS
pconvert_rust.FILTER_TYPES
pconvert_rust.COMPILER_VERSION
```
## Tests
For rust crate tests:
```bash
cargo test
```
For python API tests:
```bash
python setup.py test
```
For WASM API tests:
```bash
npm test
```
## Documentation
Generate documentation using:
```bash
cargo doc --lib --all-features
```
## License
P(NG)Convert Rust is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://travis-ci.com/github/ripe-tech/pconvert-rust)
[](https://github.com/ripe-tech/pconvert-rust/actions)
[](https://crates.io/crates/pconvert-rust)
[](https://pypi.python.org/pypi/pconvert-rust)
[](https://www.npmjs.com/package/pconvert-rust)
[](https://www.apache.org/licenses/)