stuart-fb / ocean

Ocean is the in-house framework for Computer Vision (CV) and Augmented Reality (AR) applications at Meta. It is platform independent and is mainly implemented in C/C++.

Ocean

Ocean is a C++ framework for Computer Vision (CV) And Augmented Reality (AR) Applications.

Contributing

Please read the contribution guidelines before submitting any code changes.

Getting Started

For a general overview, the project website is a good starting point. For instructions to build Ocean, continue to read below.

General Prerequisites

• Install CMake 3.26 or higher.
• Define an environment variable OCEAN_DEVELOPMENT_PATH that points to the local directory containing this repository
• Ocean requires C++20
• Ensure that the Git executable is available in your path.

Building

Please refer to the platform-specific instructions when building Ocean:

• Android
• iOS
• Linux
• macOS
• Meta Quest
• Windows

Note that we provide no pre-built binaries. To use Ocean, you must build it from source.

License

Ocean is released under the MIT License.

License Exceptions

Note that all files in the directory res/ocean/.../controller are licensed under the Art Attribution License 1.0. Please review the individual files for specific licensing details.