https://github.com/charonn0/rb-brotli

A Realbasic and Xojo binding to Brotli
https://github.com/charonn0/rb-brotli

brotli realbasic xojo

Last synced: about 1 month ago
JSON representation

A Realbasic and Xojo binding to Brotli

• Host: GitHub
• URL: https://github.com/charonn0/rb-brotli
• Owner: charonn0
• License: mit
• Created: 2022-03-20T11:25:18.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-22T06:08:31.000Z (5 months ago)
• Last Synced: 2024-06-22T16:52:17.732Z (5 months ago)
• Topics: brotli, realbasic, xojo
• Language: REALbasic
• Homepage:
• Size: 53.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Introduction

[Brotli](https://github.com/google/brotli) is a generic-purpose lossless compression algorithm with a compression ratio comparable to the best currently available general-purpose compression methods. 

**RB-Brotli** is a Brotli [binding](http://en.wikipedia.org/wiki/Language_binding) for Realbasic and Xojo projects.

## Hilights

* Read and write compressed file or memory streams using a simple [BinaryStream work-alike](https://github.com/charonn0/RB-Brotli/wiki/Brotli.BrotliStream).

* A consistent, high-level API over the full range of Brotli's features.

* 64-bit ready

* Interact directly with Brotli using idiomatic RB/Xojo objects, methods, and events; no shell or plugins required.

## Become a sponsor

If you use this code in a commercial project, or just want to show your appreciation, please consider sponsoring me through GitHub. https://github.com/sponsors/charonn0

## Getting started

The [`BrotliStream`](https://github.com/charonn0/RB-Brotli/wiki/Brotli.BrotliStream) class is a `BinaryStream` work-alike, and implements both the `Readable` and `Writeable` interfaces. Anything [written](https://github.com/charonn0/RB-Brotli/wiki/Brotli.BrotliStream.Write) to a `BrotliStream` is compressed and emitted to the output stream (another `Writeable`); [reading](https://github.com/charonn0/RB-Brotli/wiki/Brotli.BrotliStream.Read) from a `BrotliStream` decompresses data from the input stream (another `Readable`).

Instances of `BrotliStream` can be created from MemoryBlocks, FolderItems, and objects that implement the `Readable` and/or `Writeable` interfaces. For example, creating an in-memory compression stream from a zero-length MemoryBlock and writing a string to it:

```realbasic

  Dim output As New MemoryBlock(0)

  Dim z As New BrotliStream(output) ' zero-length creates a compressor

  z.Write("Hello, world!")

  z.Close

```

The string will be processed through the compressor and written to the `output` MemoryBlock. To create a decompressor pass a MemoryBlock whose size is > 0 (continuing from above):

```realbasic

  z = New BrotliStream(output) ' output contains the compressed string

  Dim decompressed As String

  Do Until z.EOF

    decompressed = decompressed + z.Read(1024) ' read the decompressed string

  Loop

  MsgBox(decompressed)

```

## How to incorporate Brotli into your Realbasic/Xojo project

### Import the `Brotli` module

1. Download the RB-Brotli project either in [ZIP archive format](https://github.com/charonn0/RB-Brotli/archive/master.zip) or by cloning the repository with your Git client.

2. Open the RB-Brotli project in REALstudio or Xojo. Open your project in a separate window.

3. Copy the `Brotli` module into your project and save.

### Ensure the Brotli shared libraries are installed

Brotli is not installed by default on most systems, and will need to be installed separately (or shipped with your app). Pre-built binaries for Windows can be [downloaded from the libcurl project](https://curl.se/windows/). You will need `libbrotlicommon.dll`, `libbrotlidec.dll`, and `libbrotlienc.dll`.

RB-Brotli will raise a PlatformNotSupportedException when used if all required DLLs/SOs/DyLibs are not available at runtime.