Skip to content

Commit

Permalink
README.md: Linkfix, Sync from master
Browse files Browse the repository at this point in the history
  • Loading branch information
Rillke committed Feb 25, 2015
1 parent 0d64422 commit 08b4fea
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,18 @@ flac.js encodes or decodes whole files to FLAC, the Free Lossless Audio Codec. S
flac.js was built with Emscripten.

## Building
If you just want to use flac.js, you don't have to build it. In this case, see [using](#Using) instead.
If you just want to use flac.js, you don't have to build it. In this case, see [using](#using) instead.

### Prerequisites
- A recent linux build system
- Emscripten 1.25.0 installed and activated

### Build script
#### Encoder
```bash
git clone git://github.com/Rillke/flac.js.git flac.js
cd flac.js
git clone git://github.com/Rillke/flac.js.git flacenc.js
cd flacenc.js
git checkout encoder
git submodule update --init
./make.sh
```
Expand Down Expand Up @@ -64,6 +66,10 @@ A more extensive example is available on the [project's website](https://blog.ri
### Bummer! A 3.5 MiB web worker!
Yeah, the data file - `flac.data.js` - is huge but conists mostly of null characters and compresses very well; a compressed size of 30.2 KB when sent `gzip`ed is possible.

In case one is just out for encoding to flac, one might replace `worker/flac.js` with `worker/flac.encoder.js` and `worker/flac.data.js` with `flac.encoder.data.js` in the [downloaded project page](https://github.com/Rillke/flac.js/zipball/gh-pages). This way the worker is about 1 MiB in total (uncompressed).

The 3.5 MiB results from flac's decoder and analyzer's [huge stack size](http://lists.xiph.org/pipermail/flac-dev/2015-January/005420.html).

## Contributing
Submit patches to this GitHub repository or [file issues](https://github.com/Rillke/flac.js/issues).

Expand Down

0 comments on commit 08b4fea

Please sign in to comment.