# vaaghu/natron architecture

> Architecture diagram of the GitHub repository vaaghu/natron, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vaaghu/natron
- Repository: https://github.com/vaaghu/natron

## Overview

Natron is a node-based video compositor. Users build a compositing graph, bring in footage, apply effects and animation, preview the result, and render frames or sequences. Its engine owns nodes, projects, image processing, and rendering; the GUI exposes graph editing, parameters, timelines, and viewers. The README documents broad capabilities and workflows, while the sampled source chiefly shows application-manager setup and selected integration points; edges below rely on README-documented relationships rather than claiming unsampled calls were inspected.

Main entry points: [`Gui/Gui.h`](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/Gui.h) (Desktop interface), [`Gui/GuiApplicationManager.cpp`](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiApplicationManager.cpp) (GUI application manager), [`Engine/OutputSchedulerThread.cpp`](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/OutputSchedulerThread.cpp) (Render scheduling), [`Engine/Node.h`](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Node.h) (Composition nodes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application"]
  node_gui["Desktop interface<br/>[Gui.h]"]
  node_gui_manager["GUI application manager"]
  node_gui_private["GUI manager state"]
  node_gui_instance["GUI application instance<br/>[GuiAppInstance.h]"]
  node_docs["Documentation service"]
  node_app_manager["Application manager<br/>[AppManager.h]"]
  node_settings["Application settings<br/>[Settings.h]"]
  node_gui_knobs["Parameter widgets<br/>[KnobGuiFactory.h]"]
end

subgraph group_graph["Composition"]
  node_project["Project state<br/>[Project.h]"]
  node_create_args["Node creation arguments<br/>[CreateNodeArgs.h]"]
  node_node["Composition nodes<br/>[Node.h]"]
  node_knob["Parameters and keyframes<br/>[Knob.h]"]
  node_animation["Curve and dope sheet<br/>[CurveEditor.cpp]"]
  node_roto_track["Roto and tracking<br/>[RotoContext.cpp]"]
end

subgraph group_render["Image and render"]
  node_read["Footage input<br/>[ReadNode.cpp]"]
  node_effects["Image effects<br/>[EffectInstance.cpp]"]
  node_render_engine["Render scheduling"]
  node_cache[("RAM and disk cache<br/>[Cache.cpp]")]
  node_viewer["Interactive viewer<br/>[ViewerInstance.cpp]"]
  node_write["Frame output<br/>[WriteNode.cpp]"]
end

subgraph group_extensions["Extensions and scripting"]
  node_formats_color["Media and color support<br/>[OfxHost.cpp]"]
  node_ofx["OpenFX plugins"]
  node_python["Python scripting<br/>[PyAppInstance.cpp]"]
end

node_user(("Compositor"))

node_user -->|"edits composition"| node_gui
node_gui -->|"uses interface"| node_gui_manager
node_gui_manager -->|"manages instances"| node_gui_instance
node_gui_manager -->|"uses private state"| node_gui_private
node_gui_manager -->|"starts service"| node_docs
node_gui_manager -->|"extends manager"| node_app_manager
node_gui_manager -->|"uses settings"| node_settings
node_gui -->|"edits project"| node_project
node_gui -->|"creates nodes"| node_create_args
node_create_args -->|"configures node"| node_node
node_project -->|"stores graph"| node_node
node_gui -->|"edits parameters"| node_knob
node_gui -->|"edits keyframes"| node_animation
node_gui -->|"creates roto and tracks"| node_roto_track
node_node -->|"includes footage input"| node_read
node_node -->|"composes effects"| node_effects
node_effects -->|"renders frames"| node_render_engine
node_render_engine -->|"uses frame cache"| node_cache
node_render_engine -->|"feeds preview"| node_viewer
node_render_engine -->|"renders output"| node_write
node_read -->|"supports media and color"| node_formats_color
node_effects -->|"hosts plugins"| node_ofx
node_gui -->|"builds parameter UI"| node_gui_knobs
node_user -->|"scripts application"| node_python
node_python -->|"controls project"| node_project

click node_gui "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/Gui.h"
click node_gui_manager "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiApplicationManager.cpp"
click node_gui_private "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiApplicationManagerPrivate.cpp"
click node_gui_instance "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiAppInstance.h"
click node_docs "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/DocumentationManager.cpp"
click node_app_manager "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/AppManager.h"
click node_settings "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Settings.h"
click node_project "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Project.h"
click node_create_args "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/CreateNodeArgs.h"
click node_node "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Node.h"
click node_knob "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Knob.h"
click node_animation "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/CurveEditor.cpp"
click node_roto_track "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/RotoContext.cpp"
click node_read "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/ReadNode.cpp"
click node_effects "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/EffectInstance.cpp"
click node_render_engine "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/OutputSchedulerThread.cpp"
click node_cache "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Cache.cpp"
click node_viewer "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/ViewerInstance.cpp"
click node_write "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/WriteNode.cpp"
click node_formats_color "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/OfxHost.cpp"
click node_python "https://github.com/vaaghu/natron/blob/RB-2.6/Engine/PyAppInstance.cpp"
click node_gui_knobs "https://github.com/vaaghu/natron/blob/RB-2.6/Gui/KnobGuiFactory.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_gui,node_gui_manager,node_gui_private,node_gui_instance,node_docs,node_app_manager,node_settings,node_gui_knobs toneBlue
class node_project,node_create_args,node_node,node_knob,node_animation,node_roto_track toneAmber
class node_read,node_effects,node_render_engine,node_cache,node_viewer,node_write toneMint
class node_formats_color,node_ofx,node_python toneRose
class node_user toneIndigo
```

## Components

### Application

- [Desktop interface](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/Gui.h): `Gui/Gui.h`
- [GUI application manager](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiApplicationManager.cpp): `Gui/GuiApplicationManager.cpp`
- [GUI manager state](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiApplicationManagerPrivate.cpp): `Gui/GuiApplicationManagerPrivate.cpp`
- [GUI application instance](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/GuiAppInstance.h): `Gui/GuiAppInstance.h`
- [Documentation service](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/DocumentationManager.cpp): `Gui/DocumentationManager.cpp`
- [Application manager](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/AppManager.h): `Engine/AppManager.h`
- [Application settings](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Settings.h): `Engine/Settings.h`
- [Parameter widgets](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/KnobGuiFactory.h): `Gui/KnobGuiFactory.h`

### Composition

- [Project state](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Project.h): `Engine/Project.h`
- [Node creation arguments](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/CreateNodeArgs.h): `Engine/CreateNodeArgs.h`
- [Composition nodes](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Node.h): `Engine/Node.h`
- [Parameters and keyframes](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Knob.h): `Engine/Knob.h`
- [Curve and dope sheet](https://github.com/vaaghu/natron/blob/RB-2.6/Gui/CurveEditor.cpp): `Gui/CurveEditor.cpp`
- [Roto and tracking](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/RotoContext.cpp): `Engine/RotoContext.cpp`

### Image and render

- [Footage input](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/ReadNode.cpp): `Engine/ReadNode.cpp`
- [Image effects](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/EffectInstance.cpp): `Engine/EffectInstance.cpp`
- [Render scheduling](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/OutputSchedulerThread.cpp): `Engine/OutputSchedulerThread.cpp`
- [RAM and disk cache](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/Cache.cpp): `Engine/Cache.cpp`
- [Interactive viewer](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/ViewerInstance.cpp): `Engine/ViewerInstance.cpp`
- [Frame output](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/WriteNode.cpp): `Engine/WriteNode.cpp`

### Extensions and scripting

- [Media and color support](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/OfxHost.cpp): `Engine/OfxHost.cpp`
- **OpenFX plugins**
- [Python scripting](https://github.com/vaaghu/natron/blob/RB-2.6/Engine/PyAppInstance.cpp): `Engine/PyAppInstance.cpp`

### Other components

- **Compositor**

## Connections

- Compositor → Desktop interface: edits composition
- Desktop interface → GUI application manager: uses interface (evidence: `Gui/GuiApplicationManager.cpp`)
- GUI application manager → GUI application instance: manages instances (evidence: `Gui/GuiApplicationManager.cpp`)
- GUI application manager → GUI manager state: uses private state (evidence: `Gui/GuiApplicationManager.cpp`)
- GUI application manager → Documentation service: starts service (evidence: `Gui/GuiApplicationManager.cpp`)
- GUI application manager → Application manager: extends manager
- GUI application manager → Application settings: uses settings (evidence: `Gui/GuiApplicationManager.cpp`)
- Desktop interface → Project state: edits project
- Desktop interface → Node creation arguments: creates nodes (evidence: `Gui/GuiApplicationManager10.cpp`)
- Node creation arguments → Composition nodes: configures node (evidence: `Engine/CreateNodeArgs.h`)
- Project state → Composition nodes: stores graph (evidence: `Engine/Project.h`)
- Desktop interface → Parameters and keyframes: edits parameters
- Desktop interface → Curve and dope sheet: edits keyframes
- Desktop interface → Roto and tracking: creates roto and tracks
- Composition nodes → Footage input: includes footage input
- Composition nodes → Image effects: composes effects
- Image effects → Render scheduling: renders frames
- Render scheduling → RAM and disk cache: uses frame cache
- Render scheduling → Interactive viewer: feeds preview
- Render scheduling → Frame output: renders output
- Footage input → Media and color support: supports media and color
- Image effects → OpenFX plugins: hosts plugins
- Desktop interface → Parameter widgets: builds parameter UI (evidence: `Gui/GuiApplicationManagerPrivate.cpp`)
- Compositor → Python scripting: scripts application
- Python scripting → Project state: controls project
