valeriyvan / swift-geometrize Goto Github PK

View Code? Open in Web Editor NEW

16.0 5.0 2.0 13.16 MB

Swift package for recreating images as geometric primitives in form of SVG files

Home Page: https://geometrize.w7software.com

License: MIT License

Swift 100.00%

swift vectorizer vectorization auto-tracing svg vector-graphics geometrizing svg-images vector art

swift-geometrize's Introduction

swift-geometrize

Swift package for recreating images as geometric primitives. It began as a Swift port of the geometrize-lib C++ library, but it has since evolved in a distinct direction. You can give it a try in web version.

Usage

Look geometrize-cli target how package could be used to geometrize images.

Shape Comparison

The matrix below shows typical results for a combination of circles, triangles, rotated rectangles, rotated ellipses and all supported shapes at 50, 200 and 500 total shapes:

	50 Shapes	200 Shapes	500 Shapes
Circles
Triangles
Rotated Rectangles
Rotated Ellipses
All Shapes

Geometrizebot

You could try swift-geometrize in action in Telegram bot Geometrizebot which is also written in Swift and open-sourced.

TODO:

✅ add stroke width for line, polyline and bezier curve;
✅ multithreading;
add polygon as shape type;
filling shapes with gradient;
solve dealing with randomness in tests;
geometrize with predefined or user supplied brush strokes;
geometrize with characters (on output will be something which could be called ascii art or art produced by James Cook Type Writer Artist);
photo mosaic,
string art.

License

Licensed under MIT license.

swift-geometrize's People

Contributors

Stargazers

Watchers

Forkers

linearitygmbh tayloraswift

swift-geometrize's Issues

Add BitmapExporter to export geometrization result back to Bitmap

Currently there's only one exporter, SVGExporter to export geometrization result into SVG.
It's convenient in some cases to export into same format as source images have, Bitmap, PNG, JPEG.

Use caching in build-run-tests-ubuntu workflow

build-run-tests-ubuntu Action currently doesn't use caching for dependencies and installs dependencies from scratch every time it runs. It just waists GitHub resources and slows down PR checks.

Could be nice to change workflow to use caching or use one of existing Actions in Marketplace, like Swift Setup.

Implement Bresenham line drawing with line thickness (line width)

Consider adding Playground to the package

Geometrizing with lines produces tons of warnings

geometrize-cli -t line -c 1000 -i Tests/geometrizeTests/Resources/grapefruit.png -o grapefruit.svg produces a lot of warnings like following:

Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.

Compile error running tests on Ubuntu

swift test
Building for debugging...
error: emit-module command failed with exit code 1 (use -v to see invocation)
/******/Tests/geometrizeTests/BitmapDiffing.swift:7:17: error: initializers in structs are not marked with 'convenience'
    convenience init(bitmap: Bitmap) {
    ~~~~~~~~~~~~^
    
/******/Tests/geometrizeTests/BitmapDiffing.swift:7:17: error: initializers in structs are not marked with 'convenience'
    convenience init(bitmap: Bitmap) {
    ~~~~~~~~~~~~^
    
/******/Tests/geometrizeTests/BitmapDiffing.swift:32:27: error: value of type 'XCTAttachment' has no member 'name'
            oldAttachment.name = "reference"
            ~~~~~~~~~~~~~ ^~~~
/******/Tests/geometrizeTests/BitmapDiffing.swift:7:17: error: initializers in structs are not marked with 'convenience'
    convenience init(bitmap: Bitmap) {
    ~~~~~~~~~~~~^
    
/******/Tests/geometrizeTests/BitmapDiffing.swift:32:27: error: value of type 'XCTAttachment' has no member 'name'
            oldAttachment.name = "reference"
            ~~~~~~~~~~~~~ ^~~~
/******/Tests/geometrizeTests/ImageRunnerTests.swift:12:9: warning: code after 'throw' will never be executed
        let url = Bundle.module.url(forResource: "kris", withExtension: "png")!
        ^
/******/Tests/geometrizeTests/ImageRunnerTests.swift:12:9: warning: code after 'throw' will never be executed
        let url = Bundle.module.url(forResource: "kris", withExtension: "png")!
        ^
error: fatalError

error: fatalError

Extend Bitmap with initialiser with PAM string

Consider turning .txt files in test resources like `defaultEnergyFunction buffer bitmap on exit.txt` into .pam or alike

Consider replacing XCTest with swift-testing

swift-testing

Consider adding hyphen (-) for input and output files in geometric-cli

Running tests fails with compile error

swift test
Building for debugging...
/Users/******/swift-geometrize/.build/checkouts/swift-snapshot-testing/Sources/SnapshotTesting/Snapshotting/NSBezierPath.swift:46:8: error: 'curveTo' is only available in macOS 11.0 or newer
      .curveTo: "CurveTo",
       ^
/Users/******/swift-geometrize/.build/checkouts/swift-snapshot-testing/Sources/SnapshotTesting/Snapshotting/NSBezierPath.swift:46:8: note: add 'if #available' version check
      .curveTo: "CurveTo",
       ^
/Users/******/swift-geometrize/.build/checkouts/swift-snapshot-testing/Sources/SnapshotTesting/Snapshotting/NSBezierPath.swift:42:22: note: add @available attribute to enclosing static method
  public static func elementsDescription(numberFormatter: NumberFormatter) -> Snapshotting {
                     ^

Make CLI input .PPM files

Extend Bitmap with initialiser from data of png/jpeg and exporter to png/jpeg

Add 'PrivacyInfo.xcprivacy'

https://developer.apple.com/documentation/bundleresources/privacy_manifest_files

Conform ImageRunner to IteratorProtocol

Add all other platforms to manifest to make Swift Package Index show compatibility

Swift Package Index shows swift-geometrize is compatible with macOS and Linux only while it should everywhere.

Get rid of Bitmap(stringLiteral:) initialiser accepting custom format

Currently Bitmap(stringLiteral:) accepts custom format.
It makes sense replace it by Bitmap(ppmString:) or one accepting PAM format.

Consider introducing Copying protocol

protocol Copying {
    func copy() -> Self
}

Consider moving Bitmap into separate package

this package could be reused here and in RaspberryPiSenseHat swift package.

Fix bug Bitmap(ppmString:) not accepting comments in PPM string

Extend geometrize-cli with exporting geometric result into png/jpeg

Create GitHub action workflow for committing test coverage and cloc

This is good starting point: https://github.com/vapor/vapor/blob/main/.github/workflows/sponsors.yml

Geometrizing with ellipses produces tons of warnings

geometrize-cli -t ellipse -c 1000 -i Tests/geometrizeTests/Resources/grapefruit.png -o grapefruit.svg produces a lot of warnings like this:

Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: rasterize(xMin:yMin:xMax:yMax:) produced no scanlines
Warning: there are no scanlines.
Warning: Scanline has x1(511) > x2(510. This makes scanline invisible.
Warning: Scanline has x1(511) > x2(510. This makes scanline invisible.
Warning: Scanline has x1(511) > x2(510. This makes scanline invisible.
Warning: Scanline has x1(511) > x2(510. This makes scanline invisible.
Warning: Scanline has x1(511) > x2(510. This makes scanline invisible.
Warning: Scanline has x1(511) > x2(510. This makes scanline invisible.

Geometrizing the same image with rotated ellipses gives no warnings.

PNGs with non 1 alpha are geometrised wrong

Source PNG:

Geometried result:

Consider introducing Mutable protocol

protocol Mutable {
    func setup(x: ClosedRange<Int>, y: ClosedRange<Int>, using: inout SplitMix64)
    func mutate(x: ClosedRange<Int>, y: ClosedRange<Int>, using: inout SplitMix64)
}