Quick start examples for integrating Banuba SDK on Desktop in C++ apps.

Getting Started

1. Get the latest Banuba SDK archive for MacOS/Windows and the client token. Please fill out our form at form at banuba.com website, or contact us via [email protected].
2. Copy bnb_viewer_standalone/bnb_sdk/ into the quickstart-desktop-cpp/bnb_sdk dir: bnb_viewer_standalone/bnb_sdk/ => quickstart-desktop-cpp/bnb_sdk
3. Copy bnb_viewer_standalone/resources/ files into the quickstart-desktop-cpp/resources dir: bnb_viewer_standalone/resources/ => quickstart-desktop-cpp/resources
4. Copy bnb_viewer_standalone/third files into the quickstart-desktop-cpp/third dir: bnb_viewer_standalone/third/ => quickstart-desktop-cpp/third
5. Copy and Paste your client token into the appropriate section of quickstart-desktop-cpp/main.cpp
6. Generate project files by executing the following commands:

   Windows x86 build:

       cd %path_to_repository%
       mkdir build
       cd build
       cmake -A Win32 ..
   

   Windows x64 build:

       cd %path_to_repository%
       mkdir build
       cd build
       cmake -A x64 ..
   

   MacOS build:

       cd %path_to_repository%
       mkdir build
       cd build
       cmake -G Xcode ..
   

7. The previous step will generate a Xcode project for MacOS and a Visual Studio project for Windows. Open the viewer_standalone project in an appropriate IDE on your platform.
8. Select target example.
9. Run build.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Sample structure

• offscreen_effect_player - is a wrapper for effect_player. It allows you to use your own implementation for offscreen_render_target
• offscreen_render_target - is an implementation option for the offscreen_render_target interface. Allows to prepare gl framebuffers and textures for receiving a frame from gpu, receive bytes of the processed frame from the gpu and pass them to the cpu, as well as, if necessary, set the orientation for the received frame. This implementation uses GLFW to work with gl context
• libraries
  • renderer - used only to demonstrate how to work with offscreen_effect_player. Draws received frames to the specified GLFW window
  • utils
    • glfw_utils - contains helper classes to work with GLFW
    • ogl_utils - contains helper classes to work with Open GL
    • utils - сontains common helper classes such as thread_pool
• interfaces - offscreen effect player interfaces
• main.cpp - contains the main function implementation, demonstrating basic pipeline for frame processing to apply effect offscreen

Note

For integration of the Offscreen Effect player to your application it is necessary to copy the offscreen_effect_player folder and implement interfaces for offscreen_render_target, but if your application is based on the GLFW library, you can just reuse offscreen_render_target with the utility library.