# jimmyvegas29/cineremote architecture

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

- Interactive diagram: https://gitdiagram.com/jimmyvegas29/cineremote
- Repository: https://github.com/jimmyvegas29/cineremote

## Overview

CineRemote is a desktop multi-camera controller and monitor for Blackmagic Camera phones, with an Android companion that exposes a phone camera to the same remote-control protocol. The desktop flow is discovery and connection, then control and media reception, followed by studio/camera views and optional OBS or virtual-webcam output. The graph preserves documented monitoring, recording, and update capabilities; some implementations are unsampled, so only documented or indexed relationships are linked.

Main entry points: [`cineremote/session.py`](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/session.py) (Camera session), [`camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Takes.kt) (Take workflow), [`cineremote/gui.py`](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/gui.py) (Main window), [`cineremote/ui/studio.py`](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/studio.py) (Studio view)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_desktop["Desktop control"]
  node_entry["App entry<br/>[cineremote.py]"]
  node_backend["Discovery backend<br/>[backend.py]"]
end

subgraph group_protocol["Camera protocol"]
  node_session["Camera session<br/>[session.py]"]
  node_signaling["Signaling<br/>[signaling.py]"]
  node_rtc["RTC compatibility<br/>[rtc_compat.py]"]
  node_messages["Protocol messages<br/>[proto_msgs.py]"]
end

subgraph group_android["Android camera"]
  node_android_main["Phone app<br/>[MainActivity.kt]"]
  node_android_session["Controller session"]
  node_remote_server["Remote server<br/>[RemoteServer.kt]"]
  node_controller["Camera controls"]
  node_engine["Camera engine<br/>[CameraEngine.kt]"]
  node_takes["Take workflow<br/>[Takes.kt]"]
  node_recorder["Recorder<br/>[Recorder.kt]"]
  node_audio_input["Audio capture<br/>[AudioInput.kt]"]
  node_frame_tap["Frame tap<br/>[FrameTap.kt]"]
  node_prefs[("Phone preferences<br/>[Prefs.kt]")]
  node_slate["Slate metadata<br/>[Slate.kt]"]
  node_takes_store["Take tracking<br/>[Takes.kt]"]
  node_format["Media formats<br/>[Formats.kt]"]
  node_monitor_aids["Monitoring aids<br/>[MonitorAids.kt]"]
end

subgraph group_outputs["Media outputs"]
  node_obs_shm["OBS media bridge<br/>[obs_shm.py]"]
  node_obs["OBS plugin<br/>[plugin-main.c]"]
  node_vcam["Virtual webcam<br/>[vcam.py]"]
  node_vcam_platform["Platform webcam<br/>[vcam_v4l2.py]"]
end

subgraph group_ui["Desktop interface"]
  node_gui["Main window<br/>[gui.py]"]
  node_model["Control model<br/>[model.py]"]
  node_studio["Studio view<br/>[studio.py]"]
  node_camera_view["Camera view<br/>[camera_view.py]"]
  node_video["Video monitor<br/>[video.py]"]
  node_audio_ui["Audio controls<br/>[audio.py]"]
  node_widgets["Shared widgets<br/>[widgets.py]"]
  node_theme["UI theme<br/>[theme.py]"]
end

node_user(("Operator"))
node_camera(("Phone camera"))

node_user -->|"launches"| node_entry
node_entry -->|"opens"| node_gui
node_gui -->|"controls"| node_backend
node_backend -->|"connects"| node_session
node_session -->|"exchanges signaling"| node_signaling
node_session -->|"uses"| node_rtc
node_session -->|"parses messages"| node_messages
node_signaling -.->|"signals"| node_camera
node_session -->|"controls and receives media"| node_camera
node_gui -->|"uses"| node_model
node_gui -->|"shows"| node_studio
node_gui -->|"shows"| node_camera_view
node_studio -->|"renders monitor"| node_video
node_camera_view -->|"renders monitor"| node_video
node_studio -->|"uses"| node_audio_ui
node_camera_view -->|"uses"| node_audio_ui
node_studio -->|"uses"| node_widgets
node_camera_view -->|"uses"| node_widgets
node_studio -->|"uses"| node_theme
node_camera_view -->|"uses"| node_theme
node_backend -.->|"publishes media"| node_obs_shm
node_obs -.->|"reads shared media"| node_obs_shm
node_backend -->|"provides webcam"| node_vcam
node_vcam -->|"selects platform driver"| node_vcam_platform
node_user -->|"uses phone app"| node_android_main
node_android_main -->|"starts"| node_remote_server
node_remote_server -->|"creates sessions"| node_android_session
node_android_session -->|"dispatches control"| node_controller
node_android_session -->|"forwards frames"| node_frame_tap
node_android_session -.->|"exchanges signaling"| node_camera
node_controller -->|"sets camera properties"| node_engine
node_controller -->|"dispatches recording"| node_takes
node_takes -->|"sets record surface"| node_engine
node_takes -->|"starts and stops"| node_recorder
node_takes -->|"feeds audio"| node_audio_input
node_takes -->|"updates take metadata"| node_slate
node_engine -->|"checks encoder support"| node_format
node_engine -->|"reads settings"| node_prefs
node_recorder -->|"uses formats"| node_format
node_android_main -->|"configures"| node_monitor_aids
node_android_main -->|"uses preferences"| node_prefs

click node_entry "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote.py"
click node_backend "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/backend.py"
click node_session "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/session.py"
click node_signaling "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/signaling.py"
click node_rtc "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/rtc_compat.py"
click node_messages "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/proto_msgs.py"
click node_gui "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/gui.py"
click node_model "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/model.py"
click node_studio "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/studio.py"
click node_camera_view "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/camera_view.py"
click node_video "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/video.py"
click node_audio_ui "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/audio.py"
click node_widgets "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/widgets.py"
click node_theme "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/theme.py"
click node_obs_shm "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/obs_shm.py"
click node_obs "https://github.com/jimmyvegas29/cineremote/blob/main/obs-plugin/src/plugin-main.c"
click node_vcam "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/vcam.py"
click node_vcam_platform "https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/vcam_v4l2.py"
click node_android_main "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/MainActivity.kt"
click node_android_session "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/ControllerSession.kt"
click node_remote_server "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/RemoteServer.kt"
click node_controller "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/CameraController.kt"
click node_engine "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/CameraEngine.kt"
click node_takes "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Takes.kt"
click node_recorder "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Recorder.kt"
click node_audio_input "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/AudioInput.kt"
click node_frame_tap "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/FrameTap.kt"
click node_prefs "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Prefs.kt"
click node_slate "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Slate.kt"
click node_takes_store "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Takes.kt"
click node_format "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Formats.kt"
click node_monitor_aids "https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/MonitorAids.kt"

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_entry,node_backend toneBlue
class node_session,node_signaling,node_rtc,node_messages toneAmber
class node_android_main,node_android_session,node_remote_server,node_controller,node_engine,node_takes,node_recorder,node_audio_input,node_frame_tap,node_prefs,node_slate,node_takes_store,node_format,node_monitor_aids toneMint
class node_obs_shm,node_obs,node_vcam,node_vcam_platform toneRose
class node_gui,node_model,node_studio,node_camera_view,node_video,node_audio_ui,node_widgets,node_theme,node_user,node_camera toneIndigo
```

## Components

### Desktop control

- [App entry](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote.py): `cineremote.py`
- [Discovery backend](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/backend.py): `cineremote/backend.py`

### Camera protocol

- [Camera session](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/session.py): `cineremote/session.py`
- [Signaling](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/signaling.py): `cineremote/signaling.py`
- [RTC compatibility](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/rtc_compat.py): `cineremote/rtc_compat.py`
- [Protocol messages](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/proto_msgs.py): `cineremote/proto_msgs.py`

### Android camera

- [Phone app](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/MainActivity.kt): `camera-android/app/src/main/java/com/cineremote/camera/MainActivity.kt`
- [Controller session](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/ControllerSession.kt): `camera-android/app/src/main/java/com/cineremote/camera/ControllerSession.kt`
- [Remote server](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/RemoteServer.kt): `camera-android/app/src/main/java/com/cineremote/camera/RemoteServer.kt`
- [Camera controls](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/CameraController.kt): `camera-android/app/src/main/java/com/cineremote/camera/CameraController.kt`
- [Camera engine](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/CameraEngine.kt): `camera-android/app/src/main/java/com/cineremote/camera/CameraEngine.kt`
- [Take workflow](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Takes.kt): `camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`
- [Recorder](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Recorder.kt): `camera-android/app/src/main/java/com/cineremote/camera/Recorder.kt`
- [Audio capture](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/AudioInput.kt): `camera-android/app/src/main/java/com/cineremote/camera/AudioInput.kt`
- [Frame tap](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/FrameTap.kt): `camera-android/app/src/main/java/com/cineremote/camera/FrameTap.kt`
- [Phone preferences](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Prefs.kt): `camera-android/app/src/main/java/com/cineremote/camera/Prefs.kt`
- [Slate metadata](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Slate.kt): `camera-android/app/src/main/java/com/cineremote/camera/Slate.kt`
- [Take tracking](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Takes.kt): `camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`
- [Media formats](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/Formats.kt): `camera-android/app/src/main/java/com/cineremote/camera/Formats.kt`
- [Monitoring aids](https://github.com/jimmyvegas29/cineremote/blob/main/camera-android/app/src/main/java/com/cineremote/camera/MonitorAids.kt): `camera-android/app/src/main/java/com/cineremote/camera/MonitorAids.kt`

### Media outputs

- [OBS media bridge](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/obs_shm.py): `cineremote/obs_shm.py`
- [OBS plugin](https://github.com/jimmyvegas29/cineremote/blob/main/obs-plugin/src/plugin-main.c): `obs-plugin/src/plugin-main.c`
- [Virtual webcam](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/vcam.py): `cineremote/vcam.py`
- [Platform webcam](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/vcam_v4l2.py): `cineremote/vcam_v4l2.py`

### Desktop interface

- [Main window](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/gui.py): `cineremote/gui.py`
- [Control model](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/model.py): `cineremote/ui/model.py`
- [Studio view](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/studio.py): `cineremote/ui/studio.py`
- [Camera view](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/camera_view.py): `cineremote/ui/camera_view.py`
- [Video monitor](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/video.py): `cineremote/ui/video.py`
- [Audio controls](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/audio.py): `cineremote/ui/audio.py`
- [Shared widgets](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/widgets.py): `cineremote/ui/widgets.py`
- [UI theme](https://github.com/jimmyvegas29/cineremote/blob/main/cineremote/ui/theme.py): `cineremote/ui/theme.py`

### Other components

- **Operator**
- **Phone camera**

## Connections

- Operator → App entry: launches (evidence: `cineremote.py`)
- App entry → Main window: opens (evidence: `cineremote.py`)
- Main window → Discovery backend: controls (evidence: `cineremote/gui.py`)
- Discovery backend → Camera session: connects (evidence: `cineremote/backend.py`)
- Camera session → Signaling: exchanges signaling (evidence: `cineremote/session.py`)
- Camera session → RTC compatibility: uses (evidence: `cineremote/session.py`)
- Camera session → Protocol messages: parses messages (evidence: `cineremote/session.py`)
- Signaling → Phone camera: signals
- Camera session → Phone camera: controls and receives media (evidence: `README.md`)
- Main window → Control model: uses (evidence: `cineremote/gui.py`)
- Main window → Studio view: shows (evidence: `cineremote/gui.py`)
- Main window → Camera view: shows (evidence: `cineremote/gui.py`)
- Studio view → Video monitor: renders monitor (evidence: `cineremote/ui/studio.py`)
- Camera view → Video monitor: renders monitor (evidence: `cineremote/ui/camera_view.py`)
- Studio view → Audio controls: uses (evidence: `cineremote/ui/studio.py`)
- Camera view → Audio controls: uses (evidence: `cineremote/ui/camera_view.py`)
- Studio view → Shared widgets: uses (evidence: `cineremote/ui/studio.py`)
- Camera view → Shared widgets: uses (evidence: `cineremote/ui/camera_view.py`)
- Studio view → UI theme: uses (evidence: `cineremote/ui/studio.py`)
- Camera view → UI theme: uses (evidence: `cineremote/ui/camera_view.py`)
- Discovery backend → OBS media bridge: publishes media (evidence: `cineremote/backend.py`)
- OBS plugin → OBS media bridge: reads shared media (evidence: `README.md`)
- Discovery backend → Virtual webcam: provides webcam (evidence: `cineremote/backend.py`)
- Virtual webcam → Platform webcam: selects platform driver (evidence: `cineremote/vcam.py`)
- Operator → Phone app: uses phone app (evidence: `README.md`)
- Phone app → Remote server: starts (evidence: `camera-android/app/src/main/java/com/cineremote/camera/MainActivity.kt`)
- Remote server → Controller session: creates sessions (evidence: `camera-android/app/src/main/java/com/cineremote/camera/RemoteServer.kt`)
- Controller session → Camera controls: dispatches control (evidence: `camera-android/app/src/main/java/com/cineremote/camera/ControllerSession.kt`)
- Controller session → Frame tap: forwards frames (evidence: `camera-android/app/src/main/java/com/cineremote/camera/ControllerSession.kt`)
- Controller session → Phone camera: exchanges signaling
- Camera controls → Camera engine: sets camera properties (evidence: `camera-android/app/src/main/java/com/cineremote/camera/CameraController.kt`)
- Camera controls → Take workflow: dispatches recording (evidence: `camera-android/app/src/main/java/com/cineremote/camera/CameraController.kt`)
- Take workflow → Camera engine: sets record surface (evidence: `camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`)
- Take workflow → Recorder: starts and stops (evidence: `camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`)
- Take workflow → Audio capture: feeds audio (evidence: `camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`)
- Take workflow → Slate metadata: updates take metadata (evidence: `camera-android/app/src/main/java/com/cineremote/camera/Takes.kt`)
- Camera engine → Media formats: checks encoder support (evidence: `camera-android/app/src/main/java/com/cineremote/camera/CameraEngine.kt`)
- Camera engine → Phone preferences: reads settings (evidence: `camera-android/app/src/main/java/com/cineremote/camera/CameraEngine.kt`)
- Recorder → Media formats: uses formats (evidence: `camera-android/app/src/main/java/com/cineremote/camera/Recorder.kt`)
- Phone app → Monitoring aids: configures (evidence: `camera-android/app/src/main/java/com/cineremote/camera/MainActivity.kt`)
- Phone app → Phone preferences: uses preferences (evidence: `camera-android/app/src/main/java/com/cineremote/camera/MainActivity.kt`)
