https://github.com/nickrobinson/paparazzi
Paparazzi.js
https://github.com/nickrobinson/paparazzi
mjpeg nodejs npm
Last synced: over 1 year ago
JSON representation
Paparazzi.js
- Host: GitHub
- URL: https://github.com/nickrobinson/paparazzi
- Owner: nickrobinson
- License: mit
- Created: 2017-05-09T12:27:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T21:05:07.000Z (over 2 years ago)
- Last Synced: 2024-10-18T08:24:48.047Z (almost 2 years ago)
- Topics: mjpeg, nodejs, npm
- Language: CoffeeScript
- Size: 1.12 MB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
paparazzi.js
-
[](https://circleci.com/gh/nickrobinson/paparazzi)
[](https://www.npmjs.com/package/paparazzi)
[](https://snyk.io/test/github/nickrobinson/paparazzi)
_A stalker of [IP cameras](http://en.wikipedia.org/wiki/IP_camera)_
**What is this?**
A high performance web proxy for serving [MJPG](http://en.wikipedia.org/wiki/Motion_JPEG) streams to the masses.
IPCamera (1) <-> (1) paparazzi.js (1) <-> (N) Users
Background
-
**IP cameras can't handle web traffic**
IP cameras are slow devices that can't handle a regular amount of web traffic. So if you plan to go public with an IP camera you have the following options:
1. **The naive approach** - Embed the camera service directly in your site, e.g. http://201.166.63.44/axis-cgi/jpg/image.cgi?resolution=CIF.
2. **Ye olde approach** - Serve images as static files in your server. I've found that several sites use this approach through messy PHP background jobs that update this files at slow intervals, generating excessive (and unnecessary) disk accesses.
3. **Plug n' pray approach** - Embed a flash or Java-based player, such as the [Cambozola](http://www.charliemouse.com/code/cambozola/) player. This requires plugins.
4. **MJPG proxy** - Serve the MJPG stream directly if you are targeting only grade A browsers, (sorry IE).
5. **paparazzi.js: A web service of dynamic images** - Build a MJPG proxy server which parses the stream, updates images in memory, and delivers new images on demand. I've found that this approach is scalable, elegant, blazing fast and doesn't require disk access.
Usage
-
**Server side**
```coffeescript
# Initialize
# Same parameters as requst.get https://github.com/request/request
paparazzi = new Paparazzi
url: 'http://67.109.86.186/mjpg/video.mjpg'
auth:
user: 'admin'
password: 'admin'
sendImmediately: false
paparazzi.on "update", (image) =>
console.log "Downloaded #{image.length} bytes"
paparazzi.on 'error', (error) =>
console.log "Error: #{error.message}"
paparazzi.start()
# Serve image
# Take a look at server.coffee
```
**Client side**
You can simulate MJPG streaming by requesting new images on a specific interval. Appending a random parameter avoids caching.
```javascript
// JavaScript example using jQuery
// Active camera will refresh every 2 seconds
var TIMEOUT = 2000;
var refreshInterval = setInterval(function() {
var random = Math.floor(Math.random() * Math.pow(2, 31));
$('img#camera').attr('src', 'http://localhost:3000/camera?i=' + random);
}, TIMEOUT);
```
```html
![]()
```
Demo
-
$ make run
For a list of tested cameras check ["List of tested
cameras"](https://github.com/nickrobinson/paparazzi/wiki/List-of-tested-cameras) in the wiki
section.
Upcoming features
-
* Websockets implementation to get more FPS
TODO
-
* More tests
* Find more public cameras to test
License
-
Original Author: Rodolfo Wilhelmy, AMA on Twitter <[@rodowi](https://twitter.com/rodowi)>
Maintainer: Nick Robinson, Twitter <[@Nrobinson33](https://twitter.com/NRobinson33)>