Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ authors:
orcid: "https://orcid.org/0000-0001-5846-3444"
license: "MIT"
repository-code: "https://github.com/InfantLab/VideoAnnotator"
version: "1.4.2"
date-released: "2026-03-04"
version: "1.4.4"
date-released: "2026-07-08"
43 changes: 30 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ VideoAnnotator automatically analyzes videos of human interactions and extracts

## 🖥️ Complete Solution: Processing + Visualization

VideoAnnotator provides both **automated processing** and **interactive visualization**:
VideoAnnotator provides both **automated processing** and **interactive visualization** — and installing this repository gets you both, no separate setup required.

### 📹 **VideoAnnotator** (this repository)

Expand All @@ -34,17 +34,35 @@ VideoAnnotator provides both **automated processing** and **interactive visualiz
- REST API for integration with research workflows
- Supports batch processing and custom configurations
- Outputs standardized JSON data
- Bundles **[Video Annotation Viewer](https://github.com/InfantLab/video-annotation-viewer)**, served at `/viewer`

### 🌐 **[Video Annotation Viewer](https://github.com/InfantLab/video-annotation-viewer)** (paired repository)
### 🌐 **[Video Annotation Viewer](https://github.com/InfantLab/video-annotation-viewer)** (companion project, bundled here)

**Interactive web-based visualization tool**

- Load and visualize VideoAnnotator results
- Synchronized video playback with annotation overlays
- Timeline scrubbing with pose, face, and audio data
- Export tools for further analysis
- Also fully independent: usable standalone with output from any tool that produces COCO/WebVTT/RTTM/scene-JSON files, no VideoAnnotator install required

**Complete workflow**: `Your Videos → [VideoAnnotator Processing] → Annotation Data → [Video Annotation Viewer] → Interactive Analysis`
<details>
<summary>Running Video Annotation Viewer standalone (without VideoAnnotator)</summary>

```bash
git clone https://github.com/InfantLab/video-annotation-viewer.git
cd video-annotation-viewer
npm install
npm run dev
```

Note: Ensure Node and NPM are installed. On macOS with Homebrew: `brew install node`. Open
http://localhost:3000 and load your files, or connect it to a VideoAnnotator server via `.env` or
the in-app Settings page — see that repo's README for details.

</details>

**Complete workflow**: `Your Videos → [VideoAnnotator Processing] → Annotation Data → [Video Annotation Viewer, at /viewer] → Interactive Analysis`

## 🚀 Get Started in 60 Seconds

Expand Down Expand Up @@ -82,20 +100,19 @@ curl -X POST "http://localhost:18011/api/v1/jobs/" \

### 3. Visualize Results

```bash
# Install the companion web viewer
git clone https://github.com/InfantLab/video-annotation-viewer.git
cd video-annotation-viewer
npm install
npm run dev
```
No extra install needed — VideoAnnotator bundles [Video Annotation Viewer](https://github.com/InfantLab/video-annotation-viewer) and serves it directly:

Note: Ensure Node and NPM are installed. On macOS with Homebrew: `brew install node`
```
Open http://localhost:18011/viewer
```

Open http://localhost:3000 and load your VideoAnnotator results.
It's pre-configured to talk to this server, so your job results are one click away. Set `VIDEOANNOTATOR_ENABLE_VIEWER=false` if you'd rather not serve it.

**🎉 That's it!** You now have both automated video processing and interactive visualization.

(Want to run Video Annotation Viewer on its own, without VideoAnnotator? See the standalone option
in the "Complete Solution: Processing + Visualization" section above.)

## 🧠 AI Pipelines & Capabilities

Authoritative pipeline metadata (names, tasks, modalities, capabilities) is generated from the registry:
Expand Down Expand Up @@ -223,7 +240,7 @@ VideoAnnotator produces machine-readable outputs (primarily JSON files and API r

- **Python**: Load JSON into pandas / numpy for analysis (see [examples/](examples/))
- **R / MATLAB**: Not currently supported with official helper packages, but the JSON outputs can be consumed using standard JSON readers
- **Visualization**: Use the companion [Video Annotation Viewer](https://github.com/InfantLab/video-annotation-viewer) for interactive playback + overlays
- **Visualization**: Bundled [Video Annotation Viewer](https://github.com/InfantLab/video-annotation-viewer) at `/viewer` for interactive playback + overlays; also runs standalone against output from other tools

## 🛠️ Installation Options

Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ For more copy-pasteable CLI workflows, see `usage/demo_commands.md`.

- **[Roadmap Overview (Archived)](archive/development/roadmap_overview.md)** - Historical release strategy notes
- [v1.4.0 Roadmap](development/roadmap_v1.4.0.md) - Roadmap for the v1.4.0 cycle
- [v1.5.0 Roadmap](development/roadmap_v1.5.0.md) - Roadmap for the v1.5.0 cycle
- [v1.5.0 Roadmap](development/roadmap_v1.5.0.md) - Modularity & integration release (JOSS resubmission response)
- [v1.6.0 Roadmap](development/roadmap_v1.6.0.md) - Plugin ecosystem & local LLM (Ollama/llama.cpp) backends
- [Modular Pipeline Architecture Spec](../specs/003-modular-pipeline-architecture/spec.md) - Full design spec underlying v1.5.0/v1.6.0
- [Examples CLI Update Plan](development/EXAMPLES_CLI_UPDATE_CHECKLIST.md) - CLI modernization checklist

## 🧪 Testing & QA
Expand Down
Loading
Loading