# shiffman/openkinect-for-processing architecture

> Architecture diagram of the GitHub repository shiffman/openkinect-for-processing, 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/shiffman/openkinect-for-processing
- Repository: https://github.com/shiffman/openkinect-for-processing

## Overview

Open Kinect for Processing provides Processing sketches with access to Kinect v1 and v2 sensor data through Java APIs and native driver bindings. The v1 workflow initializes the device, receives depth/video frames, converts them into Processing images, and exposes events and image accessors to the sketch. The v2 bridge supports device enumeration/opening and depth, color, IR, and registered data. The README documents both driver families; v2 Java/native call wiring is only partly evidenced in the sampled files, so uncertain links are dashed.

Main entry points: [`OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/Kinect.java) (Kinect API), [`OpenKinect-Processing/src/org/openkinect/freenect/Device.java`](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Device.java) (Kinect device), [`OpenKinect-Processing/src/org/openkinect/freenect/Freenect.java`](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Freenect.java) (Freenect runtime), [`OpenKinect-Processing/src/org/openkinect/freenect2/Device.java`](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect2/Device.java) (Kinect v2 device)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Processing API"]
  node_kinect_api["Kinect API<br/>[Kinect.java]"]
  node_kinect2_api["Kinect2 API<br/>[Kinect2.java]"]
  node_depth_image["Depth conversion<br/>[DepthImage.java]"]
  node_rgb_image["RGB conversion<br/>[RGBImage.java]"]
  node_library_path["Native loading<br/>[LibraryPath.java]"]
end

subgraph group_v1["Kinect v1"]
  node_freenect["Freenect runtime<br/>[Freenect.java]"]
  node_context["Device context<br/>[Context.java]"]
  node_device_v1["Kinect device<br/>[Device.java]"]
  node_frame_callbacks["Frame callbacks<br/>[DepthHandler.java]"]
  node_video_callbacks["Video callbacks<br/>[VideoHandler.java]"]
  node_frame_modes["Frame formats<br/>[FrameMode.java]"]
end

subgraph group_v2["Kinect v2"]
  node_device_v2["Kinect v2 device<br/>[Device.java]"]
end

subgraph group_native["Native drivers"]
  node_jni_bridge["JNI bridge"]
  node_v2_device_native["Native device control"]
  node_freenect2_driver["libfreenect2 driver<br/>[libfreenect2.hpp]"]
end

node_sketch(("Processing sketch"))
node_kinect_sensor(("Kinect sensor"))

node_sketch -->|"uses"| node_kinect_api
node_sketch -->|"uses"| node_kinect2_api
node_kinect_api -->|"initializes"| node_freenect
node_kinect_api -->|"configures"| node_device_v1
node_freenect -->|"creates"| node_context
node_context -->|"opens"| node_device_v1
node_device_v1 -->|"delivers depth"| node_frame_callbacks
node_device_v1 -->|"delivers video"| node_video_callbacks
node_kinect_api -->|"converts depth"| node_depth_image
node_kinect_api -->|"converts video"| node_rgb_image
node_frame_callbacks -->|"receives mode"| node_frame_modes
node_video_callbacks -->|"receives mode"| node_frame_modes
node_kinect_api -->|"fires events"| node_sketch
node_kinect_api -->|"loads native"| node_library_path
node_kinect2_api -.->|"delegates"| node_device_v2
node_device_v2 -->|"loads native"| node_library_path
node_device_v2 -.->|"calls JNI"| node_jni_bridge
node_jni_bridge -->|"registers methods"| node_v2_device_native
node_v2_device_native -.->|"controls device"| node_freenect2_driver
node_freenect2_driver -->|"accesses"| node_kinect_sensor
node_freenect -->|"accesses"| node_kinect_sensor
node_device_v1 -.->|"controls"| node_kinect_sensor

click node_kinect_api "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/Kinect.java"
click node_kinect2_api "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/Kinect2.java"
click node_depth_image "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/DepthImage.java"
click node_rgb_image "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/RGBImage.java"
click node_library_path "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/LibraryPath.java"
click node_freenect "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Freenect.java"
click node_context "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Context.java"
click node_device_v1 "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Device.java"
click node_frame_callbacks "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/DepthHandler.java"
click node_video_callbacks "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/VideoHandler.java"
click node_frame_modes "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/FrameMode.java"
click node_device_v2 "https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect2/Device.java"
click node_jni_bridge "https://github.com/shiffman/openkinect-for-processing/blob/master/build_openKinect2/C%2B%2BCmakeLinux/src/JNILibfreenect2.cpp"
click node_v2_device_native "https://github.com/shiffman/openkinect-for-processing/blob/master/build_openKinect2/C%2B%2BCmakeLinux/src/org_openkinect_freenect2_Device.cpp"
click node_freenect2_driver "https://github.com/shiffman/openkinect-for-processing/blob/master/build_openKinect2/C%2B%2B/libs/protonect/include/libfreenect2/libfreenect2.hpp"

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_kinect_api,node_kinect2_api,node_depth_image,node_rgb_image,node_library_path toneBlue
class node_freenect,node_context,node_device_v1,node_frame_callbacks,node_video_callbacks,node_frame_modes toneAmber
class node_device_v2 toneMint
class node_jni_bridge,node_v2_device_native,node_freenect2_driver toneRose
class node_sketch,node_kinect_sensor toneIndigo
```

## Components

### Processing API

- [Kinect API](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/Kinect.java): `OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`
- [Kinect2 API](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/Kinect2.java): `OpenKinect-Processing/src/org/openkinect/processing/Kinect2.java`
- [Depth conversion](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/DepthImage.java): `OpenKinect-Processing/src/org/openkinect/processing/DepthImage.java`
- [RGB conversion](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/RGBImage.java): `OpenKinect-Processing/src/org/openkinect/processing/RGBImage.java`
- [Native loading](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/processing/LibraryPath.java): `OpenKinect-Processing/src/org/openkinect/processing/LibraryPath.java`

### Kinect v1

- [Freenect runtime](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Freenect.java): `OpenKinect-Processing/src/org/openkinect/freenect/Freenect.java`
- [Device context](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Context.java): `OpenKinect-Processing/src/org/openkinect/freenect/Context.java`
- [Kinect device](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/Device.java): `OpenKinect-Processing/src/org/openkinect/freenect/Device.java`
- [Frame callbacks](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/DepthHandler.java): `OpenKinect-Processing/src/org/openkinect/freenect/DepthHandler.java`
- [Video callbacks](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/VideoHandler.java): `OpenKinect-Processing/src/org/openkinect/freenect/VideoHandler.java`
- [Frame formats](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect/FrameMode.java): `OpenKinect-Processing/src/org/openkinect/freenect/FrameMode.java`

### Kinect v2

- [Kinect v2 device](https://github.com/shiffman/openkinect-for-processing/blob/master/OpenKinect-Processing/src/org/openkinect/freenect2/Device.java): `OpenKinect-Processing/src/org/openkinect/freenect2/Device.java`

### Native drivers

- [JNI bridge](https://github.com/shiffman/openkinect-for-processing/blob/master/build_openKinect2/C%2B%2BCmakeLinux/src/JNILibfreenect2.cpp): `build_openKinect2/C++CmakeLinux/src/JNILibfreenect2.cpp`
- [Native device control](https://github.com/shiffman/openkinect-for-processing/blob/master/build_openKinect2/C%2B%2BCmakeLinux/src/org_openkinect_freenect2_Device.cpp): `build_openKinect2/C++CmakeLinux/src/org_openkinect_freenect2_Device.cpp`
- [libfreenect2 driver](https://github.com/shiffman/openkinect-for-processing/blob/master/build_openKinect2/C%2B%2B/libs/protonect/include/libfreenect2/libfreenect2.hpp): `build_openKinect2/C++/libs/protonect/include/libfreenect2/libfreenect2.hpp`

### Other components

- **Processing sketch**
- **Kinect sensor**

## Connections

- Processing sketch → Kinect API: uses
- Processing sketch → Kinect2 API: uses
- Kinect API → Freenect runtime: initializes (evidence: `OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`)
- Kinect API → Kinect device: configures (evidence: `OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`)
- Freenect runtime → Device context: creates (evidence: `OpenKinect-Processing/src/org/openkinect/freenect/Freenect.java`)
- Device context → Kinect device: opens (evidence: `OpenKinect-Processing/src/org/openkinect/freenect/Context.java`)
- Kinect device → Frame callbacks: delivers depth (evidence: `OpenKinect-Processing/src/org/openkinect/freenect/Device.java`)
- Kinect device → Video callbacks: delivers video (evidence: `OpenKinect-Processing/src/org/openkinect/freenect/Device.java`)
- Kinect API → Depth conversion: converts depth (evidence: `OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`)
- Kinect API → RGB conversion: converts video (evidence: `OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`)
- Frame callbacks → Frame formats: receives mode (evidence: `OpenKinect-Processing/src/org/openkinect/freenect/DepthHandler.java`)
- Video callbacks → Frame formats: receives mode (evidence: `OpenKinect-Processing/src/org/openkinect/freenect/VideoHandler.java`)
- Kinect API → Processing sketch: fires events (evidence: `OpenKinect-Processing/src/org/openkinect/processing/Kinect.java`)
- Kinect API → Native loading: loads native
- Kinect2 API → Kinect v2 device: delegates
- Kinect v2 device → Native loading: loads native (evidence: `OpenKinect-Processing/src/org/openkinect/freenect2/Device.java`)
- Kinect v2 device → JNI bridge: calls JNI
- JNI bridge → Native device control: registers methods (evidence: `build_openKinect2/C++CmakeLinux/src/JNILibfreenect2.cpp`)
- Native device control → libfreenect2 driver: controls device
- libfreenect2 driver → Kinect sensor: accesses
- Freenect runtime → Kinect sensor: accesses
- Kinect device → Kinect sensor: controls
