https://github.com/webarkit/webarkit-cv

WebARKit thanks to OpenCV and Emscripten
https://github.com/webarkit/webarkit-cv

computer-vision emscripten opencv webar webarkit webassembly

Last synced: about 1 year ago
JSON representation

WebARKit thanks to OpenCV and Emscripten

• Host: GitHub
• URL: https://github.com/webarkit/webarkit-cv
• Owner: webarkit
• Created: 2023-03-20T22:26:40.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-03-22T18:08:26.000Z (about 1 year ago)
• Last Synced: 2025-03-22T18:35:55.398Z (about 1 year ago)
• Topics: computer-vision, emscripten, opencv, webar, webarkit, webassembly
• Language: TypeScript
• Homepage:
• Size: 25.8 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![github releases](https://flat.badgen.net/github/release/webarkit/webarkit-cv)

![github stars](https://flat.badgen.net/github/stars/webarkit/webarkit-cv)

![github forks](https://flat.badgen.net/github/forks/webarkit/webarkit-cv)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![CI WebARKitCV](https://github.com/webarkit/webarkit-cv/actions/workflows/CI.yml/badge.svg)](https://github.com/webarkit/webarkit-cv/actions/workflows/CI.yml)

[![Build WebARKitCV](https://github.com/webarkit/webarkit-cv/actions/workflows/build_opencv.yml/badge.svg)](https://github.com/webarkit/webarkit-cv/actions/workflows/build_opencv.yml)

# webarkit-cv

A set of tools to build a custom and light opencv lib to be used in WebAR projects. This is a WIP, but at this moment opencv_js.js can be imported as a **ES6** module.

The main goal of this project is to develop a WebAR library that can be used to build a WebAR application, based on the OpenCV library.

We do not reccomend to use this library in production, but if you want to try it, you can clone the project and test the examples. The API and the structure of the project can change in the future, so be aware of this.

## Typescript

WebARKitCV is developed in the Typescript language; Type definitions are in the `types` folder.

## OpenCV and Emscripten emsdk

We are using OpenCV version 4.7.0 (our modified fork) and emsdk 3.1.26

### Tools

See the build.sh script. It will build the opencv_js.js lib and after it will copy in the build folder. We are trying to build a lighter opencv_js.js lib, 

So we use a config to minimize the file size. Without this the final lib will be too big in size with features that we don't need.

The opencv_js.js file is based on a modified version of OpenCV that let you import the OpenCV library as a ES6 module. If you are interested read this [issue](https://github.com/kalwalt/webarkit-cv/issues/1).

### Future development

- npm package

- documentation

- first WebAR example