Updating WebAssembly build and instructions (#11).

Author: gogins

WebAssembly/README.md

@@ -1,66 +1,43 @@
-# Csound for Emscripten and WebAssembly
+# Csound for WebAssembly
 
-Authors: Edward Costello, Steven Yi, Henri Manson
+Authors: Edward Costello, Steven Yi, Henri Manson, Michael Gogins
 
 ## Introduction
 
-These are the sources for Web-based Csound. They were first developed to use 
-the emscripten compiler toolchain to produce a pure JavaScript version of 
-Csound through asm.js. With the introduction of WebAssembly (WASM), we are now 
-able to produce a version of this build targetting that API. WASM code runs 
-roughly twice as fast as pure JavaScript or half as fast as native code.
+THis directory builds, packages, and tests Csound for WebAssembly. This build 
+is based upon the core Csound build for WebAssembly by Edward Costello, Steven 
+Yi, Victor Lazzarini, and Henri Manson. To this have been added:
+
+* A number of C++ opcodes (here, statically linked).
+
+* A new JavaScript interface to Csound that follows, as exactly as possible, 
+  the interface defined by CsoundThreaded in `csound_threaded.cpp` and also 
+  implemented in CsoundOboe in `csound_oboe.hpp` for the Csound for Android 
+  app, and in csound.node.
+  
+* A complete build of CsoundAC for WebAssembly will also be added.
 
 ## Requirements
 
-* [Emscripten SDK/toolchain](https://github.com/kripken/emscripten): install 
-  the Emscripten tools using these \
-  [instructions](https://kripken.github.io/emscripten-site/docs/getting_started/downloads.html)
-  thoroughly. Make sure all steps are followed to ensure a correct
-  installation of the toolchain. 
-* If you are primarily using WebAssembly you can install the toolchain 
-  from source [using these instructions](http://webassembly.org/getting-started/developers-guide/). 
+* Install the toolchain from source [using these instructions](http://webassembly.org/getting-started/developers-guide/). 
   Building the toolchain is compute and memory intensive. If the build does not 
   complete or produces a zero size clang file, run the build step using only 
   one thread: `./emsdk install sdk-incoming-64bit binaryen-master-64bit -j1`.
 
-## Build Instructions for asm.js
-
-1. First you will need to build libsndfile. Use the 
-   `download_and_build_libsndfile.sh` script. In the emscripten folder, run 
-   `sh ./download_and_build_libsndfile.sh`. This will create a deps folder, 
-   download libsndfile 1.0.25, unarchive the tarball, and then compile libsndfile 
-   with Emscripten.
-2. Run the build.sh script using `sh ./build.sh`. This will create a build 
-   folder; run cmake from there with the Csound source, then compile Csound 
-   with Emscripten. The script will then link the output with libsndfile and 
-   generate a libcsound.js script file. Finally, the script will copy the 
-   libcsound.js and src/CsoundObj.js files into a dist folder.
-
-At this point, the two .js files in the dist folder are all that are necessary to run Csound in a 
-Web browser that supports WebAudio.
-
-### Release Instructions
-
-1. Run `sh build.sh`
-2. Run `sh update_example_libs_from_dist.sh`
-3. Update CS_VERSION in build.sh if necessary
-4. Run `sh release.sh`
-
 ## Build Instructions for WebAssembly
 
-1. In the `emsdk` directory run `source emsdk_env.sh` and 
+In the `WebAssembly` directory, run `sh build-all.sh`. This will perform the 
+following steps, which may also be executed individually:
+
+1. Update the Emscripten toolchain for WebAssembly.
+2. Run `source emsdk_env.sh` in the `~/emsdk` directory which executes  
    `export EMSCRIPTEN_ROOT=$EMSCRIPTEN`.
-2. Change to the `csound/emscripten` directory.
-3. First you will need to build libsndfile. Use the
-   `download_and_build_libsndfile_wasm.sh` script. In the emscripten
-   folder, type `sh download_and_build_libsndfile_wasm.sh`. This will compile 
+3. Run `sh download_and_build_libsndfile_wasm.sh`. This will compile 
    `libsndfile-wasm.a` in `deps/libsndfile-1.0.25`.
 2. Run the `build-wasm.sh` script using `sh build-wasm.sh`. This will create a 
    build folder, run cmake from there with the Csound source,
    then compile Csound with Emscripten for WASM. The script will copy
    the required files into a dist-wasm folder for distribution.
-3. The WASM build works generally as a drop-in replacement for the
-   asm.js version, but uses different files.
 
 ### Release Instructions
 

WebAssembly/build-mkg.sh renamed to WebAssembly/build-all.sh

@@ -12,7 +12,7 @@ echo "Using EMSCRIPTEN_ROOT: $EMSCRIPTEN_ROOT"
 mkdir -p build-wasm
 cd build-wasm
 
-cmake -DUSE_COMPILER_OPTIMIZATIONS=0 -DWASM=1 -DINIT_STATIC_MODULES=0 -DUSE_DOUBLE=NO -DBUILD_MULTI_CORE=0 -DBUILD_JACK_OPCODES=0 -DEMSCRIPTEN=1 -DCMAKE_TOOLCHAIN_FILE=$EMSCRIPTEN_ROOT/cmake/Modules/Platform/Emscripten.cmake -DCMAKE_MODULE_PATH=$EMSCRIPTEN_ROOT/cmake -DCMAKE_BUILD_TYPE=Release -G"Unix Makefiles" -DHAVE_BIG_ENDIAN=0 -DCMAKE_16BIT_TYPE="unsigned short"  -DHAVE_STRTOD_L=0 -DBUILD_STATIC_LIBRARY=YES -DHAVE_ATOMIC_BUILTIN=0 -DHAVE_SPRINTF_L=NO -DUSE_GETTEXT=NO -DLIBSNDFILE_LIBRARY=../deps/libsndfile-1.0.25/libsndfile-wasm.a -DSNDFILE_H_PATH=../deps/libsndfile-1.0.25/src ../..
+cmake -DUSE_COMPILER_OPTIMIZATIONS=0 -DWASM=1 -DINIT_STATIC_MODULES=0 -DUSE_DOUBLE=NO -DBUILD_MULTI_CORE=0 -DBUILD_JACK_OPCODES=0 -DEMSCRIPTEN=1 -DCMAKE_TOOLCHAIN_FILE=$EMSCRIPTEN_ROOT/cmake/Modules/Platform/Emscripten.cmake -DCMAKE_MODULE_PATH=$EMSCRIPTEN_ROOT/cmake -DCMAKE_BUILD_TYPE=Release -G"Unix Makefiles" -DHAVE_BIG_ENDIAN=0 -DCMAKE_16BIT_TYPE="unsigned short"  -DHAVE_STRTOD_L=0 -DBUILD_STATIC_LIBRARY=YES -DHAVE_ATOMIC_BUILTIN=0 -DHAVE_SPRINTF_L=NO -DUSE_GETTEXT=NO -DLIBSNDFILE_LIBRARY=../deps/libsndfile-1.0.25/libsndfile-wasm.a -DSNDFILE_H_PATH=../deps/libsndfile-1.0.25/src ../dependencies/csound
 
 emmake make csound-static -j6 
 

WebAssembly/build-wasm.sh

@@ -1,6 +1,8 @@
 #!/bin/bash
 echo "Updating all Debian packages required for csound-extended..."
 echo
+sudo apt-get update
+sudo apt-get upgrade
 echo "Updating build-essential..."
 sudo apt-get install build-essential
 echo "Updating automake..."