Moonfire NVR, a security camera network video recorder
Go to file
Scott Lamb 7eac83fc51
Update install.md
fix timezone setting
2021-01-21 16:57:07 -08:00
.cargo keep frame poiners in release mode 2019-07-20 15:33:12 -07:00
.github/workflows replacing travis-ci with github actions 2020-12-22 22:49:43 -08:00
.vscode refresh some editor configs and such 2020-12-22 23:44:45 -08:00
base upgrade some deps including parking_lot 2020-11-23 22:46:05 -08:00
db new docker-based build 2021-01-15 09:54:10 -08:00
design remove stale warning about time handling 2020-12-22 19:51:50 -08:00
docker new docker-based build 2021-01-15 09:54:10 -08:00
guide Update install.md 2021-01-21 16:57:07 -08:00
src fix timestamp duration calculation panic 2020-11-27 21:56:15 -08:00
ui-src Merge branch 'master' into new-schema 2020-11-22 20:40:16 -08:00
webpack overhaul HTTP serving and caching 2020-05-29 21:20:15 -07:00
.dockerignore refresh some editor configs and such 2020-12-22 23:44:45 -08:00
.eslintrc.json fix a couple compile errors in 422cd2a 2018-11-27 12:23:44 -08:00
.gitignore refresh some editor configs and such 2020-12-22 23:44:45 -08:00
AUTHORS upgrade copyright notices 2020-03-01 22:53:41 -08:00
Cargo.lock new docker-based build 2021-01-15 09:54:10 -08:00
Cargo.toml new docker-based build 2021-01-15 09:54:10 -08:00
LICENSE.txt Initial commit, with basic functionality. 2016-01-01 22:06:47 -08:00
package.json overhaul HTTP serving and caching 2020-05-29 21:20:15 -07:00
README.md small updates to the top-level README 2021-01-21 16:30:46 -08:00
screenshot-small.png add a basic Javascript UI 2017-10-21 21:54:27 -07:00
screenshot.png add a basic Javascript UI 2017-10-21 21:54:27 -07:00
yarn.lock Bump websocket-extensions from 0.1.3 to 0.1.4 2020-06-06 16:29:51 +00:00

CI

Introduction

Moonfire NVR is an open-source security camera network video recorder, started by Scott Lamb <slamb@slamb.org>. It saves H.264-over-RTSP streams from IP cameras to disk into a hybrid format: video frames in a directory on spinning disk, other data in a SQLite3 database on flash. It can construct .mp4 files for arbitrary time ranges on-the-fly. It does not decode, analyze, or re-encode video frames, so it requires little CPU. It handles six 1080p/30fps streams on a Raspberry Pi 2, using less than 10% of the machine's total CPU.

So far, the web interface is basic: a filterable list of video segments, with support for trimming them to arbitrary time ranges. No scrub bar yet. There's also no support for motion detection, no https/SSL/TLS support (you'll need a proxy server, as described here), and only a console-based (rather than web-based) configuration UI.

screenshot

Moonfire NVR is currently at version 0.6. Until version 1.0, there will be no compatibility guarantees: configuration and storage formats may change from version to version. There is an upgrade procedure but it is not for the faint of heart.

I hope to add features such as salient motion detection. It's way too early to make promises, but it seems possible to build a full-featured hobbyist-oriented multi-camera NVR that requires nothing but a cheap machine with a big hard drive. I welcome help; see Getting help and getting involved below. There are many exciting techniques we could use to make this possible:

  • avoiding CPU-intensive H.264 encoding in favor of simply continuing to use the camera's already-encoded video streams. Cheap IP cameras these days provide pre-encoded H.264 streams in both "main" (full-sized) and "sub" (lower resolution, compression quality, and/or frame rate) varieties. The "sub" stream is more suitable for fast computer vision work as well as remote/mobile streaming. Disk space these days is quite cheap (with 4 TB drives costing about $100), so we can afford to keep many camera-months of both streams on disk.
  • off-loading on-camera analytics to an inexpensive USB or M.2 neural network accelerator.
  • using HTTP Live Streaming rather than requiring custom browser plug-ins.
  • taking advantage of on-camera analytics. This is the lowest CPU usage option, although many cameras' analytics aren't as good as what can be done on the NVR, they're hard to experiment with, and even when they use modern ML-based approaches, their built-in models can't be retrained.

Documentation

Getting help and getting involved

Please email the moonfire-nvr-users mailing list with questions, or just to say you love/hate the software and why. You can also file bugs and feature requests on the github issue tracker.

I'd welcome help with testing, development (in Rust, JavaScript, and HTML), user interface/graphic design, and documentation. Please email the mailing list if interested. Pull requests are welcome, but I encourage you to discuss large changes on the mailing list or in a github issue first to save effort.