Skip to content

arnauddupuis/unabara

Repository files navigation

Unabara

Unabara Logo

Unabara is a powerful tool for creating telemetry overlays for scuba diving videos. It extracts data from dive logs and generates customizable overlays that can be composited with your diving footage.

Features

  • Import Dive Logs: Import Subsurface (XML/SSRF) dive logs to extract comprehensive diving telemetry. Unabara supports most kinds of diving: from single tank recreational dives to multi-tanks technical dives in Open Circuit or Closed Circuit Rebreather.
  • Visual Timeline: View and navigate your dive data on an interactive timeline.
  • Video Import: Import video footage and sync it with your dive data.
  • Customizable Overlay: Configure which telemetry data appears in your overlay (depth, temperature, NDL, tank pressure, dive time).
  • Template Selection: Choose from built-in overlay templates or import your own designs.
  • Export Options:
    • Export as image sequence for video editing software
    • Export directly as video file (requires FFmpeg)

Screenshots

Unabara main interface

Example

Here is a (low resolution) example of what you can generate with Unabara (open circuit, 4 tanks technical dive).

unabara-low-resolution-demo.mp4

And a higher resolution one (CCR technical dive):

2026-02-28-Monastery_Beach.webm

Requirements

  • FFmpeg (optional, required for direct video export)

Installation

Pre-built packages are available on the Releases page. Download the appropriate package for your operating system:

Windows

  1. Download unabara-windows-x.x.x.zip
  2. Extract the archive to a folder of your choice
  3. It is recommended to install FFmpeg from FFmpeg website (Direct download link)
  4. Alternatively you can use the Chocolatey package manager to install FFmpeg. Once Chocolatey is installed on your windows, open a command prompt as administrator and run: choco install ffmpeg
  5. Run unabara.exe

macOS

  1. Download unabara-macos-universal-x.x.x.dmg
  2. Open the DMG file
  3. Drag the Unabara app to your Applications folder
  4. It is recommended to install FFmpeg using Homebrew: brew install ffmpeg
  5. Launch Unabara from Applications

Linux (Flatpak)

  1. Download unabara-linux-x.x.x.flatpak
  2. Install the Flatpak package:
    flatpak install unabara-linux-x.x.x.flatpak
  3. Launch Unabara from your application menu, or run:
    flatpak run org.unabara.unabara

Building from Source

Dependencies

  • Qt 6.8.0 or newer (Core, Gui, Quick, Qml, Xml, Concurrent, Widgets, Network, Multimedia)
  • CMake 3.16 or newer
  • C++17 compatible compiler (GCC 9+, Clang 10+, MSVC 2019+)

Linux

# Install dependencies (Ubuntu/Debian)
sudo apt install build-essential cmake qt6-base-dev qt6-declarative-dev libqt6xml6-dev qt6-multimedia-dev

# Install dependencies (Fedora)
sudo dnf install cmake gcc-c++ qt6-qtbase-devel qt6-qtdeclarative-devel qt6-qtbase-private-devel qt6-qtmultimedia-devel

# Install dependencies (Arch Linux)
sudo pacman -S cmake base-devel qt6-base qt6-declarative qt6-multimedia

# Clone the repository
git clone https://github.com/arnauddupuis/unabara.git
cd unabara

# Create build directory
mkdir build && cd build

# Configure and build
cmake ..
cmake --build .

# Run the application
./bin/unabara

macOS

# Install dependencies with Homebrew
brew install qt6 cmake

# Clone the repository
git clone https://github.com/arnauddupuis/unabara.git
cd unabara

# Create build directory
mkdir build && cd build

# Configure and build
cmake .. -DQt6_DIR=$(brew --prefix qt6)/lib/cmake/Qt6
cmake --build .

# Run the application
./bin/unabara

Windows

  1. Install Qt 6.8.0 or newer
  2. Install CMake
  3. Install Visual Studio 2019 or newer with C++ desktop development workload
# Clone the repository
git clone https://github.com/arnauddupuis/unabara.git
cd unabara

# Create build directory
mkdir build
cd build

# Configure and build
cmake .. -DCMAKE_PREFIX_PATH=C:\path\to\Qt\6.8.0\msvc2019_64
cmake --build . --config Release

# Run the application
.\bin\Release\unabara.exe

Video Export

For direct video export functionality, FFmpeg needs to be installed on your system:

  • Linux:
    • Ubuntu/Debian: sudo apt install ffmpeg
    • Fedora: sudo dnf install ffmpeg
    • Arch Linux: sudo pacman -S ffmpeg
  • macOS: brew install ffmpeg (Homebrew needs to be installed on your mac beforehand)
  • Windows: Download from FFmpeg website (Direct download link). It is recommended to install FFmpeg from FFmpeg website (Direct download link). Alternatively you can use the Chocolatey package manager to install FFmpeg. Once Chocolatey is installed on your windows, open a command prompt as administrator and run: choco install ffmpeg

Usage

  1. Launch Unabara
  2. Import a dive log file (Subsurface XML/SSRF format)
  3. Optionally import your dive video footage
  4. Adjust the positioning and video sync timing using the timeline
  5. Configure the overlay display options in settings
  6. Export as image sequence or video file

Then you can use the generated video or image sequence as a telemetry overlay in your video editor software.

License

Unabara is licensed under the GNU General Public License v2.0.

Name Origin

"Unabara" (海原) is a Japanese word meaning "the ocean" or "the great expanse of the sea."

About

A tool to create telemetry overlay for scuba diving

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages