fixed rotation issues + updated readme
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "rustitch"
|
||||
version = "0.2.0"
|
||||
version = "0.2.1"
|
||||
edition = "2024"
|
||||
description = "PES embroidery file parser and thumbnail renderer"
|
||||
license = "MIT"
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
[](https://docs.rs/rustitch)
|
||||
[](../LICENSE)
|
||||
|
||||
A Rust library for parsing **PES embroidery files** and rendering stitch data to images.
|
||||
A Rust library for parsing **embroidery files** and rendering stitch data to images.
|
||||
|
||||
Supported formats: **PES**, **DST**, **EXP**, **JEF**, **VP3**
|
||||
|
||||
Part of the [stitch-peek-rs](https://git.narl.io/nvrl/stitch-peek-rs) project.
|
||||
|
||||
@@ -14,18 +16,24 @@ Add `rustitch` to your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
rustitch = "0.1"
|
||||
rustitch = "0.2"
|
||||
```
|
||||
|
||||
### Generate a thumbnail
|
||||
|
||||
```rust
|
||||
// PES files (backward-compatible API)
|
||||
let pes_data = std::fs::read("design.pes")?;
|
||||
let png_bytes = rustitch::thumbnail(&pes_data, 256)?;
|
||||
std::fs::write("preview.png", &png_bytes)?;
|
||||
|
||||
// Any supported format
|
||||
let dst_data = std::fs::read("pattern.dst")?;
|
||||
let png_bytes = rustitch::thumbnail_format(&dst_data, 256, rustitch::Format::Dst)?;
|
||||
std::fs::write("preview.png", &png_bytes)?;
|
||||
```
|
||||
|
||||
### Parse and inspect a design
|
||||
### Parse and inspect a PES design
|
||||
|
||||
```rust
|
||||
use rustitch::pes::{self, StitchCommand};
|
||||
@@ -61,15 +69,39 @@ let png_bytes = rustitch::render_thumbnail(&resolved, 512)?;
|
||||
std::fs::write("large_preview.png", &png_bytes)?;
|
||||
```
|
||||
|
||||
### Format detection
|
||||
|
||||
```rust
|
||||
use rustitch::format::{self, Format};
|
||||
use std::path::Path;
|
||||
|
||||
// Detect from file extension
|
||||
let fmt = format::detect_from_extension(Path::new("design.jef"));
|
||||
assert_eq!(fmt, Some(Format::Jef));
|
||||
|
||||
// Detect from file content (magic bytes)
|
||||
let data = std::fs::read("design.pes")?;
|
||||
let fmt = format::detect_from_bytes(&data);
|
||||
assert_eq!(fmt, Some(Format::Pes));
|
||||
```
|
||||
|
||||
## Supported formats
|
||||
|
||||
**PES** (Brother PE-Design) embroidery files, versions 1 through 10. The PEC section containing stitch data is consistent across versions.
|
||||
| Format | Manufacturer | Colors | Notes |
|
||||
|--------|-------------|--------|-------|
|
||||
| **PES** | Brother PE-Design | Embedded (PEC palette) | Versions 1-10 |
|
||||
| **DST** | Tajima | Default palette | 3-byte bit-packed records |
|
||||
| **EXP** | Melco/Bernina | Default palette | Simple 2-byte encoding |
|
||||
| **JEF** | Janome | Embedded (Janome palette) | Structured header with color table |
|
||||
| **VP3** | Pfaff/Viking | Embedded (RGB) | Hierarchical format with per-section colors |
|
||||
|
||||
Formats without embedded color info (DST, EXP) use a default palette of 12 high-contrast colors, cycling on each color change.
|
||||
|
||||
## How it works
|
||||
|
||||
1. **Parse** the PES binary header to locate the PEC section
|
||||
2. **Decode** the PEC stitch byte stream (7-bit and 12-bit encoded relative movements, jumps, trims, color changes)
|
||||
3. **Resolve** relative movements into absolute coordinate segments grouped by thread color, using the 65-color Brother PEC palette
|
||||
1. **Detect** the file format from magic bytes or extension
|
||||
2. **Parse** the format-specific binary encoding into a common `StitchCommand` stream (stitch, jump, trim, color change, end)
|
||||
3. **Resolve** relative movements into absolute coordinate segments grouped by thread color
|
||||
4. **Render** anti-aliased line segments with [tiny-skia](https://github.com/nickel-org/tiny-skia), scaled to fit the requested size
|
||||
5. **Encode** as PNG with proper alpha handling
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ pub fn parse(data: &[u8]) -> Result<Vec<StitchCommand>, Error> {
|
||||
break;
|
||||
}
|
||||
let dx = data[i] as i8 as i16;
|
||||
let dy = data[i + 1] as i8 as i16;
|
||||
let dy = -(data[i + 1] as i8 as i16);
|
||||
commands.push(StitchCommand::Jump { dx, dy });
|
||||
i += 2;
|
||||
}
|
||||
@@ -53,7 +53,7 @@ pub fn parse(data: &[u8]) -> Result<Vec<StitchCommand>, Error> {
|
||||
}
|
||||
} else {
|
||||
let dx = b1 as i8 as i16;
|
||||
let dy = b2 as i8 as i16;
|
||||
let dy = -(b2 as i8 as i16);
|
||||
commands.push(StitchCommand::Stitch { dx, dy });
|
||||
i += 2;
|
||||
}
|
||||
@@ -88,8 +88,8 @@ mod tests {
|
||||
fn parse_simple_stitches() {
|
||||
let data = [0x0A, 0x14, 0x05, 0x03];
|
||||
let cmds = parse(&data).unwrap();
|
||||
assert!(matches!(cmds[0], StitchCommand::Stitch { dx: 10, dy: 20 }));
|
||||
assert!(matches!(cmds[1], StitchCommand::Stitch { dx: 5, dy: 3 }));
|
||||
assert!(matches!(cmds[0], StitchCommand::Stitch { dx: 10, dy: -20 }));
|
||||
assert!(matches!(cmds[1], StitchCommand::Stitch { dx: 5, dy: -3 }));
|
||||
assert!(matches!(cmds[2], StitchCommand::End));
|
||||
}
|
||||
|
||||
@@ -98,10 +98,7 @@ mod tests {
|
||||
// -10 as i8 = 0xF6, -20 as i8 = 0xEC
|
||||
let data = [0xF6, 0xEC];
|
||||
let cmds = parse(&data).unwrap();
|
||||
assert!(matches!(
|
||||
cmds[0],
|
||||
StitchCommand::Stitch { dx: -10, dy: -20 }
|
||||
));
|
||||
assert!(matches!(cmds[0], StitchCommand::Stitch { dx: -10, dy: 20 }));
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -110,14 +107,14 @@ mod tests {
|
||||
let cmds = parse(&data).unwrap();
|
||||
assert!(matches!(cmds[0], StitchCommand::Stitch { .. }));
|
||||
assert!(matches!(cmds[1], StitchCommand::ColorChange));
|
||||
assert!(matches!(cmds[2], StitchCommand::Stitch { dx: 5, dy: 3 }));
|
||||
assert!(matches!(cmds[2], StitchCommand::Stitch { dx: 5, dy: -3 }));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_jump() {
|
||||
let data = [0x80, 0x04, 0x0A, 0x14];
|
||||
let cmds = parse(&data).unwrap();
|
||||
assert!(matches!(cmds[0], StitchCommand::Jump { dx: 10, dy: 20 }));
|
||||
assert!(matches!(cmds[0], StitchCommand::Jump { dx: 10, dy: -20 }));
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -61,12 +61,13 @@ pub fn decode_stitches(data: &[u8]) -> Result<Vec<StitchCommand>, Error> {
|
||||
continue;
|
||||
}
|
||||
|
||||
let (dx, dx_flags, bytes_dx) = decode_coordinate(data, i)?;
|
||||
i += bytes_dx;
|
||||
// PEC encodes coordinates as (Y, X) — read first value as vertical,
|
||||
// second as horizontal, then swap to (dx, dy) for screen coordinates.
|
||||
let (val1, flags1, bytes1) = decode_coordinate(data, i)?;
|
||||
i += bytes1;
|
||||
|
||||
// Check for special bytes at dy position — color change or end markers
|
||||
// can appear between dx and dy when the preceding stitch ends on an
|
||||
// odd byte boundary relative to the next control byte.
|
||||
// Check for special bytes at second coordinate position — color change
|
||||
// or end markers can appear between the two coordinates.
|
||||
if i < data.len() && data[i] == 0xFF {
|
||||
commands.push(StitchCommand::End);
|
||||
break;
|
||||
@@ -77,10 +78,12 @@ pub fn decode_stitches(data: &[u8]) -> Result<Vec<StitchCommand>, Error> {
|
||||
continue;
|
||||
}
|
||||
|
||||
let (dy, dy_flags, bytes_dy) = decode_coordinate(data, i)?;
|
||||
i += bytes_dy;
|
||||
let (val2, flags2, bytes2) = decode_coordinate(data, i)?;
|
||||
i += bytes2;
|
||||
|
||||
let flags = dx_flags | dy_flags;
|
||||
let flags = flags1 | flags2;
|
||||
let dx = val2;
|
||||
let dy = val1;
|
||||
|
||||
if flags & 0x20 != 0 {
|
||||
commands.push(StitchCommand::Trim);
|
||||
@@ -147,13 +150,14 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn decode_simple_stitch() {
|
||||
// PEC stores (Y, X): first=10 → dy, second=20 → dx
|
||||
let data = [0x0A, 0x14, 0xFF];
|
||||
let cmds = decode_stitches(&data).unwrap();
|
||||
assert_eq!(cmds.len(), 2);
|
||||
match &cmds[0] {
|
||||
StitchCommand::Stitch { dx, dy } => {
|
||||
assert_eq!(*dx, 10);
|
||||
assert_eq!(*dy, 20);
|
||||
assert_eq!(*dx, 20);
|
||||
assert_eq!(*dy, 10);
|
||||
}
|
||||
_ => panic!("expected Stitch"),
|
||||
}
|
||||
@@ -161,12 +165,13 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn decode_negative_7bit() {
|
||||
// PEC stores (Y, X): first=0x50(-48) → dy, second=0x60(-32) → dx
|
||||
let data = [0x50, 0x60, 0xFF];
|
||||
let cmds = decode_stitches(&data).unwrap();
|
||||
match &cmds[0] {
|
||||
StitchCommand::Stitch { dx, dy } => {
|
||||
assert_eq!(*dx, -48);
|
||||
assert_eq!(*dy, -32);
|
||||
assert_eq!(*dx, -32);
|
||||
assert_eq!(*dy, -48);
|
||||
}
|
||||
_ => panic!("expected Stitch"),
|
||||
}
|
||||
@@ -174,24 +179,27 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn decode_color_change() {
|
||||
// PEC stores (Y, X): first=10 → dy, second=20 → dx
|
||||
let data = [0xFE, 0xB0, 0x0A, 0x14, 0xFF];
|
||||
let cmds = decode_stitches(&data).unwrap();
|
||||
assert!(matches!(cmds[0], StitchCommand::ColorChange));
|
||||
assert!(matches!(cmds[1], StitchCommand::Stitch { dx: 10, dy: 20 }));
|
||||
assert!(matches!(cmds[1], StitchCommand::Stitch { dx: 20, dy: 10 }));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn decode_extended_12bit() {
|
||||
// PEC stores (Y, X): first=0x91,0x00(256 with jump flag) → dy, second=0x05(5) → dx
|
||||
let data = [0x91, 0x00, 0x05, 0xFF];
|
||||
let cmds = decode_stitches(&data).unwrap();
|
||||
assert!(matches!(cmds[0], StitchCommand::Jump { dx: 256, dy: 5 }));
|
||||
assert!(matches!(cmds[0], StitchCommand::Jump { dx: 5, dy: 256 }));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn decode_trim_jump() {
|
||||
// PEC stores (Y, X): first=0xA0,0x0A(10 with trim flag) → dy, second=0x05(5) → dx
|
||||
let data = [0xA0, 0x0A, 0x05, 0xFF];
|
||||
let cmds = decode_stitches(&data).unwrap();
|
||||
assert!(matches!(cmds[0], StitchCommand::Trim));
|
||||
assert!(matches!(cmds[1], StitchCommand::Jump { dx: 10, dy: 5 }));
|
||||
assert!(matches!(cmds[1], StitchCommand::Jump { dx: 5, dy: 10 }));
|
||||
}
|
||||
}
|
||||
|
||||
BIN
rustitch/tests/fixtures/0.3x1 INCHES.EXP
vendored
Normal file
BIN
rustitch/tests/fixtures/0.3x1 INCHES.EXP
vendored
Normal file
Binary file not shown.
BIN
rustitch/tests/fixtures/0.3x1 INCHES.JEF
vendored
Normal file
BIN
rustitch/tests/fixtures/0.3x1 INCHES.JEF
vendored
Normal file
Binary file not shown.
BIN
rustitch/tests/fixtures/0.3x1 INCHES.PES
vendored
Normal file
BIN
rustitch/tests/fixtures/0.3x1 INCHES.PES
vendored
Normal file
Binary file not shown.
Reference in New Issue
Block a user