libcimbar

README Copy Section

INTRODUCTION | ABOUT | CFC | LIBCIMBAR INTRODUCTION | ABOUT | CFC | LIBCIMBAR')" title="Copy section prompt for LLMs"> Copy Section

DETAILS | PERFORMANCE | TODO DETAILS | PERFORMANCE | TODO')" title="Copy section prompt for LLMs"> Copy Section

libcimbar: Color Icon Matrix Barcodes Copy Chapter

Behold: an experimental barcode format for air-gapped data transfer.

It can sustain speeds of 850 kilobits/s (~106 KB/s) using just a computer monitor and a smartphone camera!

<p align="center">
<img src="https://github.com/sz3/cimbar-samples/blob/v0.6/b/4cecc30f.png" width="70%" title="A non-animated mode-B cimbar code" >
</p>

Explain? Copy Chapter

The encoder outputs an animated barcode to a computer or smartphone screen:
* Encoder web app: https://cimbar.org

While the decoder is a cell phone app that uses the phone camera to read the animated barcode:
* Decoder android app: https://github.com/sz3/cfc

No internet/bluetooth/NFC/etc is used. All data is transmitted through the camera lens. You can try it out yourself, or take my word that it works. :)

How does it work? Copy Chapter

cimbar is a high-density 2D barcode format. Data is stored in a grid of colored tiles -- bits are encoded based on which tile is chosen, and which color is chosen to draw the tile. Reed Solomon error correction is applied on the data, to account for the lossy nature of the video -> digital decoding. Sub-1% error rates are expected, and corrected.

libcimbar, this optimized implementation, includes a simple protocol for file encoding built on fountain codes (wirehair) and zstd compression. Files of up to 33MB (after compression!) are encoded in a series of cimbar codes, which can be output as images or a live video feed. Once enough distinct image frames have been decoded successfully, the file will be reconstructed and decompressed successfully. This is true even if the images are received out of order, or if some have been corrupted or are missing.

Platforms Copy Chapter

The code is written in C++, and developed/tested on amd64+linux, arm64+android (decoder only), and emscripten+WASM (encoder only). It probably works, or can be made to work, on other platforms.

Crucially, because the encoder compiles to asmjs and wasm, it can run on anything with a modern web browser. For offline use, you can either install cimbar.org as a progressive web app, or download the latest release of cimbar_js.html, save it locally, and open it in your web browser.

Library dependencies Copy Chapter

OpenCV and GLFW (+ OpenGL ES headers) must be installed before building. All other dependencies are included in the source tree.

* opencv - https://opencv.org/ (libopencv-dev)
* GLFW - https://github.com/glfw/glfw (libglfw3-dev)
* GLES3/gl3.h - libgles2-mesa-dev
* base - https://github.com/r-lyeh-archived/base
* catch2 - https://github.com/catchorg/Catch2
* concurrentqueue - https://github.com/cameron314/concurrentqueue
* cxxopts - https://github.com/jarro2783/cxxopts (used for command line tools)
* fmt - https://github.com/fmtlib/fmt
* intx - https://github.com/chfast/intx
* libcorrect - https://github.com/quiet/libcorrect
* libpopcnt - https://github.com/kimwalisch/libpopcnt
* PicoSHA2 - https://github.com/okdshin/PicoSHA2 (used for testing)
* stb_image - https://github.com/nothings/stb (for loading embedded pngs)
* wirehair - https://github.com/catid/wirehair
* zstd - https://github.com/facebook/zstd

Build (linux dev) Copy Chapter

1. install opencv and GLFW. On ubuntu/debian, this looks like:

sudo apt install libopencv-dev libglfw3-dev libgles2-mesa-dev

2. run the cmake + make incantation

cmake .
make -j7
make install

By default, libcimbar will try to install build products under ./dist/bin/.

Build (windows MSVC + vcpkg) Copy Section

Install Visual Studio with the Desktop development with C++ workload, CMake 3.14 or newer, and vcpkg. Set VCPKG_ROOT to the vcpkg checkout, then configure and build from PowerShell:

cmake -S . -B build-windows -A x64 "-DCMAKE_TOOLCHAIN_FILE=$env:VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake"
cmake --build build-windows --config Release --target cimbar_send cimbar_recv cimbar_recv2 --parallel
cmake --install build-windows --config Release

The included vcpkg.json installs OpenCV, GLFW, and ANGLE during configuration. The executables and their runtime DLLs are installed under ./dist/bin/.

Note: native Windows is supported on a "best efforts" basis, so things may be a bit more buggy. (primary dev is for linux/android)

Build wasm (cimbar.js) Copy Section

To build cimbar.js (what cimbar.org uses), see WASM. Or use the latest release.

Usage Copy Chapter

Encode:
* large input files may fill up your disk with pngs!

./cimbar --encode -i inputfile.txt -o outputprefix

Decode (extracts file into output directory):

./cimbar outputprefix*.png -o /tmp

Decode a series of encoded images from stdin:

echo outputprefix*.png | ./cimbar -o /tmp

Encode and animate to window:

./cimbar_send inputfile.pdf

You can also encode a file using cimbar.org, or the latest release.

Performance numbers Copy Chapter

PERFORMANCE

Implementation details Copy Chapter

DETAILS

Room for improvement/next steps Copy Chapter

TODO

Community Tools Copy Chapter

* cimbar-bigfile — A pure-frontend wrapper that splits files into multiple parallel encode_id streams (10–15 MB chunks per stream), and ships a manifest.json for SHA256-verified reassembly. Supports 100+ MB files. No changes to libcimbar or cfc required.

Inspiration Copy Chapter

* https://github.com/JohannesBuchner/imagehash/
* https://github.com/divan/txqr
* https://en.wikipedia.org/wiki/High_Capacity_Color_Barcode

Would you like to know more? Copy Chapter

INTRODUCTION | ABOUT INTRODUCTION | ABOUT')" title="Copy section prompt for LLMs"> Copy Section

---