Realtime Video Booth using WebGL, Web Audio and MediaRecorder - no plugins!
JavaScript HTML GLSL CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
other
.gitignore
LICENSE
README.md
package.json

README.md

Boo!

This is a video booth implemented entirely in the browser, featuring realtime video and audio manipulation for fun, and video recording for extra fun! No plugins required!

We essentially use getUserMedia to get access to the webcam and microphone inputs in real time, and then WebGL and Web Audio for filtering the video and audio side of things respectively. Finally, MediaRecorder is used for capturing the filtered output and encoding to a video file.

You can access the online demo, or keep reading for how to get the sources and run it locally.

Requirements

Hardware requirements

  • A working webcam (otherwise, what's the point of a video booth?)
  • Speakers or audio output (if you want to listen to spooky sounds too)

Software requirements

  • Firefox 45. This is a Firefox technical demo. So it might not work on your browser, if it doesn't implement what we're demoing. At the time of writing (December 2015), you need to download Firefox Nightly.
  • Support for canvas.captureStream (this lets us get a video stream out of a canvas tag)
  • Support for MediaRecorder (this lets us encode a video file natively in the browser, without using additional JS libraries)

Note: MediaRecorder is an upcoming API part of the W3C MediaCapture standard. canvas.captureStream is based on another part of the same W3C standard. There's nothing proprietary or exclusive to Firefox here, other than the fact that other browsers do not implement these features yet. Once they do, this demo will work in them too!

How to get and run it

You need node.js installed in order to build the project (node.js provides the npm utility). Once you have node.js and git installed, you can go to a terminal and type in the following:

git clone https://github.com/mozdevs/boo.git
cd boo
npm install
npm start

The project will be built to the dist/ folder. Open dist/index.html in your browser to run the project.

Getting rid of the do you want to share the camera? dialog

If you serve the site using https, the browser will show you an additional option to store your camera and microphone sharing preferences. This can be really useful during development, to avoid having to give permission to use the webcam each time you reload the page.

Serving content using https is not obvious, but here's a nice tutorial explaining how to do this on Mac OS. If you know how to do the same for Linux or Windows, please let us know!

Once you have a working https server, have it serve files from the dist/ file and access its address on your browser, instead of opening dist/index.html directly. E.g. if you followed the instructions from the tutorial, your server will be running in port 8080, so go to https://localhost:8080 to access the booth. You will be asked if you want to share the camera and microphone the first time you access it, and if you select "Always share" instead of "Share selected devices", your preferences will be saved and the dialog won't pop up again when you reload, unless you click the little camera icon on the left side of the URL bar and select "Stop sharing" from the drop down.

Developing

(TODO: describe where the important files are)

If you make changes to the code and want to see the result of the changes, run the build script:

npm run build

It will regenerate the contents of the dist/ folder, and you can either open or reload dist/index.html in your browser.

But that is a bit tedious, and you might forget to run build after each change, so we also provide the watch script. You can run it and leave it watching for changes, and it will automatically run build for you each time there's a change in the JavaScript source code:

npm run watch

Note: there's an open issue to have this task watch for other types of files.

Deploying

Deploying for this project means taking the contents of dist/ and putting them anywhere accessible to the internet.

Pushing to your server

Once you have dist, you can copy the contents to your web server space using any SFTP client or rsync or anything that you like. There are no specific server-side requirements as this is all front-end code. Yay HTML5!

Pushing to GitHub

If you want to push a copy to GitHub, so you don't host this in your server, you can run the deploy task:

npm run deploy

It will attempt to create a gh-pages branch in your fork of the project, and push it to GitHub. If all goes well, you will be able to access it at http://your-github-user-name.github.io/boo/

What's next?

We'd like more effects! More fun! The issues page documents the things we want to do in more detail.

Prototypes, demos and other stuff

We're building intermediate prototypes to figure out how to do certain semi-isolated things, and putting them in the other/ folder.