Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A JavaScript H.264 decoder.
C JavaScript Logos C++ Objective-C HTML Other
branch: master
Failed to load latest commit information.
Decoder strict mode step 2
Player removed dead code
templates strict mode step 2
AUTHORS added me to the authors
LICENSE Licensing
README.markdown real world uses

README.markdown

Broadway.js

A JavaScript H.264 decoder.

View a Live Demo:
http://mbebenita.github.io/Broadway/foxDemo.html
http://mbebenita.github.io/Broadway/storyDemo.html
http://mbebenita.github.io/Broadway/treeDemo.html

The video player first needs to download the entire video before it can start playing, thus appearing to be a bit slow at first, so have patience. You can start the video by clicking on each player. The top left player runs on the main thread, the remaining players run in background worker threads.

Use a example node app as template:
https://github.com/soliton4/BroadwayStream

Technical info

The demo is Android's H.264 decoder compiled with Emscripten to JavaScript, then further optimized with Google's JavaScript closure compiler and further optimized by hand to use WebGL.

Building the demo:

Install and configure Emscripten (https://github.com/kripken/emscripten)
The current version of Broadway was built with emscripten 1.29.0

The code for the demo is in the Decoder folder, to build it run the make.py python script. (Requires at least python 2.7)

Encoding Video

The decoder expects an .mp4 file and does not support weighted prediction for P-frames and CABAC entropy encoding. To create such bitstreams use ffmpeg and x264 with the following command line options:

ffmpeg -y -i sourceFile -r 30000/1001 -b:a 2M -bt 4M -vcodec libx264 -pass 1 -coder 0 -bf 0 -flags -loop -wpredp 0 -an targetFile.mp4

API

Player.js, Decoder.js and YUVWebGLCanvas.js all have a unified module definition.
You can use them as plain js files or with common.js / AMD

Player.js:

var p = new Player({
  <options>
});

p.canvas; // the canvas - put it where you want it

p.decode(<h264 data>);

options:

useWorker true / false
decode in a worker thread

workerFile
path to Decoder.js. Only neccessary when using worker. defaults to "Decoder.js"

webgl true / "auto" / false
use webgl. defaults to "auto"

size { width: , height: }
initial size of the canvas. canvas will resize after video starts streaming.

properties:

canvas
domNode

refers to the canvas element.

methods:

decode ()

feed the decoder with h264 stream data.

Decoder.js:

var p = new Decoder({
  <options>
});

p.onPictureDecoded; // override with a callback function

p.decode(<h264 data>);

options:

rgb true / false
if true will convert the image to rgb. sligtly slower.

properties:

onPictureDecoded callback function(, width, height)

will be called for each frame.

methods:

decode ()

feed the decoder with h264 stream data.

Real World Uses of Broadway.js

Something went wrong with that request. Please try again.