Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 46 additions & 31 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,14 @@ let package = Package(
targets: ["SwiftCompression"]
),

.library(
name: "SwiftCompressionCSS",
targets: ["CompressionCSS"]
),

.library(
name: "SwiftCompressionDNA",
targets: ["CompressionDNA"]
),

.library(
name: "SwiftCompressionJavaScript",
targets: ["CompressionJavaScript"]
name: "Brotli",
targets: ["Brotli"]
),

.library(
Expand All @@ -32,8 +27,13 @@ let package = Package(
),

.library(
name: "SwiftCompressionSnappy",
targets: ["CompressionSnappy"]
name: "Snappy",
targets: ["Snappy"]
),

.library(
name: "Zlib",
targets: ["Zlib"]
),
],
// MARK: Targets
Expand All @@ -45,36 +45,42 @@ let package = Package(
.target(
name: "SwiftCompression",
dependencies: [
"Brotli",
"SwiftCompressionUtilities",
"CompressionCSS",
"CompressionDNA",
"CompressionJavaScript",
"CompressionLZ",
"CompressionSnappy"
"Snappy",
"Zlib"
]
),

// MARK: Techniques
.systemLibrary(name: "BrotliShim"),
.target(
name: "CompressionCSS",
name: "Brotli",
dependencies: [
"SwiftCompressionUtilities"
"SwiftCompressionUtilities",
"BrotliShim"
],
path: "Sources/CSS"
linkerSettings: [
.unsafeFlags(["-lbrotlienc", "-lbrotlidec"]),
]
),
.systemLibrary(name: "ZlibShim"),
.target(
name: "CompressionDNA",
name: "Zlib",
dependencies: [
"SwiftCompressionUtilities"
],
path: "Sources/DNA"
"SwiftCompressionUtilities",
"ZlibShim"
]
),

.target(
name: "CompressionJavaScript",
name: "CompressionDNA",
dependencies: [
"SwiftCompressionUtilities"
],
path: "Sources/JavaScript"
path: "Sources/DNA"
),
.target(
name: "CompressionLZ",
Expand All @@ -83,12 +89,19 @@ let package = Package(
],
path: "Sources/LZ"
),

.systemLibrary(
name: "SnappyShim"
),
.target(
name: "CompressionSnappy",
name: "Snappy",
dependencies: [
"SwiftCompressionUtilities"
"SwiftCompressionUtilities",
"SnappyShim"
],
path: "Sources/Snappy"
linkerSettings: [
.unsafeFlags(["-lsnappy"])
]
),

// MARK: Run
Expand All @@ -105,24 +118,26 @@ let package = Package(
dependencies: ["SwiftCompression"]
),
.testTarget(
name: "CSSTests",
dependencies: ["CompressionCSS"]
name: "BrotliTests",
dependencies: ["Brotli"]
),
.testTarget(
name: "DNATests",
dependencies: ["CompressionDNA"]
),
.testTarget(
name: "JavaScriptTests",
dependencies: ["CompressionJavaScript"]
),
.testTarget(
name: "LZTests",
dependencies: ["CompressionLZ"]
),
.testTarget(
name: "SnappyTests",
dependencies: ["CompressionSnappy"]
dependencies: ["Snappy"]
),
.testTarget(
name: "ZlibTests",
dependencies: [
"Zlib"
]
)
]
)
Expand Down
44 changes: 20 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
# Swift Compression

<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.9+-F05138?style=&logo=swift" alt="Requires at least Swift 5.9"></a> <img src="https://img.shields.io/badge/Platforms-Any-gold"> <a href="https://discord.com/invite/VyuFQUpcUz"><img src="https://img.shields.io/badge/Chat-Discord-7289DA?style=&logo=discord"></a> <a href="https://github.com/RandomHashTags/destiny/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue" alt="Apache 2.0 License"></a>
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.9+-F05138?style=&logo=swift" alt="Requires at least Swift 5.9"></a> <img src="https://img.shields.io/badge/Platforms-Any-gold"> <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue" alt="Apache 2.0 License"></a>

Standalone compression & decompression library.

## Techniques

### Compression and decompression

- [Brotli](https://github.com/google/brotli)
- [DEFLATE](https://www.rfc-editor.org/rfc/rfc1951)
- [DNA Binary Encoding](https://en.wikipedia.org/wiki/DNA_digital_data_storage)
- [DNA Single-Block Encoding](https://www.mdpi.com/1999-4893/13/4/99)
- [Huffman Coding](https://en.wikipedia.org/wiki/Huffman_coding)
- [iWork Archive](https://en.wikipedia.org/wiki/IWork)
- [LZ77 & LZ78](https://en.wikipedia.org/wiki/LZ77_and_LZ78)
- [Move-to-front](https://en.wikipedia.org/wiki/Move-to-front_transform)
- [Run-Length Encoding](https://en.wikipedia.org/wiki/Run-length_encoding)
- [Snappy](https://github.com/google/snappy)
- [Snappy Framed](https://github.com/google/snappy/blob/main/framing_format.txt)
- [Zstd](https://github.com/facebook/zstd)

### Minification

- CSS
- JavaScript
- Swift

## Getting starting
- [x] [Brotli](https://github.com/google/brotli)
- [ ] [DEFLATE](https://www.rfc-editor.org/rfc/rfc1951)
- [x] via zlib
- [ ] via libdeflate
- [x] [DNA Binary Encoding](https://en.wikipedia.org/wiki/DNA_digital_data_storage)
- [ ] [DNA Single-Block Encoding](https://www.mdpi.com/1999-4893/13/4/99)
- [x] [Huffman Coding](https://en.wikipedia.org/wiki/Huffman_coding)
- [ ] [iWork Archive](https://en.wikipedia.org/wiki/IWork)
- [ ] [LZ77 & LZ78](https://en.wikipedia.org/wiki/LZ77_and_LZ78)
- [x] [Move-to-front](https://en.wikipedia.org/wiki/Move-to-front_transform)
- [x] [Run-Length Encoding](https://en.wikipedia.org/wiki/Run-length_encoding)
- [x] [Snappy](https://github.com/google/snappy)
- [ ] [Snappy Framed](https://github.com/google/snappy/blob/main/framing_format.txt)
- [ ] [Zstd](https://github.com/facebook/zstd)

## Getting started

coming soon...

Expand All @@ -36,11 +32,11 @@ coming soon...
The products are broken up into their respective algorithms, but the __SwiftCompression__ product includes all of them and is the recommended one to use in your projects.

- SwiftCompression
- SwiftCompressionCSS
- SwiftCompressionDNA
- SwiftCompressionJavaScript
- SwiftCompressionLZ
- SwiftCompressionSnappy
- Brotli
- Snappy
- Zlib

## Contributing

Expand Down
28 changes: 28 additions & 0 deletions Sources/Brotli/Brotli+Compress+Span.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@

import BrotliShim

extension Brotli {
public func compress(
span: Span<UInt8>,
configuration: CompressConfiguration
) -> ConcreteCompressionResult {
var outLength = span.count
let maxSize = BrotliEncoderMaxCompressedSize(outLength)
let outBuffer = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: maxSize)
outBuffer.initialize(repeating: 0)
defer { outBuffer.deallocate() }

let success = span.withUnsafeBytes {
return BrotliEncoderCompress(
quality,
windowSize,
BrotliEncoderMode(rawValue: mode),
outLength,
$0.baseAddress,
&outLength,
outBuffer.baseAddress
)
}
return success == BROTLI_TRUE ? [UInt8](outBuffer.prefix(outLength)) : nil
}
}
45 changes: 45 additions & 0 deletions Sources/Brotli/Brotli+Compress.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

import BrotliShim
import SwiftCompressionUtilities

extension Brotli: Compressor {
public typealias ConcreteCompressionConfiguration = CompressConfiguration
public typealias ConcreteCompressionResult = [UInt8]?

/// - Parameters:
/// - data: Sequence of bytes to compress.
/// - Complexity: O(_n_) where _n_ is the length of `data`.
public func compress(
data: some Collection<UInt8>,
configuration: ConcreteCompressionConfiguration
) -> ConcreteCompressionResult {
var outLength = data.count
let maxSize = BrotliEncoderMaxCompressedSize(outLength)
let outBuffer = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: maxSize)
outBuffer.initialize(repeating: 0)
defer { outBuffer.deallocate() }

let success = data.withContiguousStorageIfAvailable {
return BrotliEncoderCompress(
quality,
windowSize,
BrotliEncoderMode(rawValue: mode),
outLength,
$0.baseAddress,
&outLength,
outBuffer.baseAddress
)
} ?? BROTLI_FALSE
return success == BROTLI_TRUE ? [UInt8](outBuffer.prefix(outLength)) : nil
}
}

// MARK: Configuration
extension Brotli {
public struct CompressConfiguration: CompressionConfiguration, DecompressionConfiguration {
public static var `default`: Self { .init() }

public init() {
}
}
}
51 changes: 51 additions & 0 deletions Sources/Brotli/Brotli+Decompress.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

import BrotliShim
import SwiftCompressionUtilities

extension Brotli: Decompressor {
public typealias ConcreteDecompressionConfiguration = DecompressConfiguration
public typealias ConcreteDecompressionResult = [UInt8]?

/// - Parameters:
/// - data: Collection of bytes to decompress.
/// - closure: Logic to execute when a byte is decompressed.
/// - Complexity: O(_n_) where _n_ is the length of `data`.
public func decompress(
data: some Collection<UInt8>,
configuration: ConcreteDecompressionConfiguration
) -> ConcreteDecompressionResult {
let compressedCount = data.count
var decodedSize = configuration.estimatedSize
let outBuffer = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: decodedSize)
defer { outBuffer.deallocate() }
let result = data.withContiguousStorageIfAvailable { inPtr in
BrotliDecoderDecompress(
compressedCount,
inPtr.baseAddress!,
&decodedSize,
outBuffer.baseAddress
)
} ?? BROTLI_DECODER_RESULT_ERROR
if result == BROTLI_DECODER_RESULT_SUCCESS {
return [UInt8](outBuffer.prefix(decodedSize))
} else if result == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT {
return decompress(data: data, configuration: .init(estimatedSize: configuration.estimatedSize * 2))
}
return nil
}
}

// MARK: Configuration
extension Brotli {
public struct DecompressConfiguration: DecompressionConfiguration {
public static var `default`: Self { .init(estimatedSize: 32768) }

public let estimatedSize:Int

public init(
estimatedSize: Int
) {
self.estimatedSize = estimatedSize
}
}
}
35 changes: 35 additions & 0 deletions Sources/Brotli/Brotli.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

import BrotliShim
import SwiftCompressionUtilities

/// The Brotli compression technique.
///
/// https://github.com/google/brotli
///
/// https://en.wikipedia.org/wiki/Brotli
public struct Brotli: Sendable {
public let quality:Int32

/// Size of the window.
public let windowSize:Int32

public let mode:UInt32

public init(
quality: Int32 = BROTLI_DEFAULT_QUALITY,
windowSize: Int32 = BROTLI_DEFAULT_WINDOW,
mode: UInt32 = BROTLI_MODE_GENERIC.rawValue
) {
self.quality = quality
self.windowSize = windowSize
self.mode = mode
}

public var algorithm: CompressionAlgorithm {
.brotli(quality: quality, windowSize: windowSize, mode: mode)
}

public var compressionQuality: CompressionQuality {
.lossless
}
}
6 changes: 6 additions & 0 deletions Sources/BrotliShim/module.modulemap
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module BrotliShim [system] {
header "/usr/include/brotli/decode.h"
header "/usr/include/brotli/encode.h"
header "/usr/include/brotli/types.h"
export *
}
Loading