Emscripten update and standalone support #925
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,52 +2,116 @@ | |
| set -e | ||
| DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" | ||
|
|
||
| CORES="${CORES:-`nproc --all`}" | ||
| ENABLE_LIBDE265="${ENABLE_LIBDE265:-1}" | ||
| LIBDE265_VERSION="${LIBDE265_VERSION:-1.0.12}" | ||
| ENABLE_AOM="${ENABLE_AOM:-0}" | ||
| AOM_VERSION="${AOM_VERSION:-3.6.1}" | ||
| STANDALONE="${STANDALONE:-0}" | ||
| DEBUG="${DEBUG:-0}" | ||
| USE_WASM="${USE_WASM:-1}" | ||
|
|
||
| echo "Build using ${CORES} CPU cores" | ||
|
|
||
| LIBRARY_LINKER_FLAGS="" | ||
| LIBRARY_INCLUDE_FLAGS="" | ||
|
|
||
| CONFIGURE_ARGS_LIBDE265="" | ||
| if [ "$ENABLE_LIBDE265" = "1" ]; then | ||
| [ -s "libde265-${LIBDE265_VERSION}.tar.gz" ] || curl \ | ||
| -L \ | ||
| -o libde265-${LIBDE265_VERSION}.tar.gz \ | ||
| https://github.com/strukturag/libde265/releases/download/v${LIBDE265_VERSION}/libde265-${LIBDE265_VERSION}.tar.gz | ||
| if [ ! -s "libde265-${LIBDE265_VERSION}/libde265/.libs/libde265.so" ]; then | ||
| tar xf libde265-${LIBDE265_VERSION}.tar.gz | ||
| cd libde265-${LIBDE265_VERSION} | ||
| [ -x configure ] || ./autogen.sh | ||
| emconfigure ./configure --disable-sse --disable-dec265 --disable-sherlock265 | ||
| emmake make -j${CORES} | ||
| cd .. | ||
| fi | ||
| CONFIGURE_ARGS_LIBDE265="-DLIBDE265_INCLUDE_DIR=${DIR}/libde265-${LIBDE265_VERSION} -DLIBDE265_LIBRARY=-L${DIR}/libde265-${LIBDE265_VERSION}/libde265/.libs" | ||
| LIBRARY_LINKER_FLAGS="$LIBRARY_LINKER_FLAGS -lde265" | ||
| LIBRARY_INCLUDE_FLAGS="$LIBRARY_INCLUDE_FLAGS -L${DIR}/libde265-${LIBDE265_VERSION}/libde265/.libs" | ||
| fi | ||
|
|
||
| CONFIGURE_ARGS_AOM="" | ||
| if [ "$ENABLE_AOM" = "1" ]; then | ||
| [ -s "aom-${AOM_VERSION}.tar.gz" ] || curl \ | ||
| -L \ | ||
| -o aom-${AOM_VERSION}.tar.gz \ | ||
| "https://aomedia.googlesource.com/aom/+archive/v${AOM_VERSION}.tar.gz" | ||
| if [ ! -s "aom-${AOM_VERSION}/libaom.a" ]; then | ||
| mkdir -p aom-${AOM_VERSION}/aom-source | ||
| tar xf aom-${AOM_VERSION}.tar.gz -C aom-${AOM_VERSION}/aom-source | ||
| cd aom-${AOM_VERSION} | ||
|
|
||
| emcmake cmake aom-source \ | ||
| -DENABLE_CCACHE=1 \ | ||
| -DAOM_TARGET_CPU=generic \ | ||
| -DENABLE_DOCS=0 \ | ||
| -DENABLE_TESTS=0 \ | ||
| -DENABLE_EXAMPLES=0 \ | ||
| -DENABLE_TESTDATA=0 \ | ||
| -DENABLE_TOOLS=0 \ | ||
| -DCONFIG_MULTITHREAD=0 \ | ||
| -DCONFIG_RUNTIME_CPU_DETECT=0 \ | ||
| -DBUILD_SHARED_LIBS=1 \ | ||
| -DCMAKE_BUILD_TYPE=Release | ||
|
|
||
| emmake make -j${CORES} | ||
|
|
||
| cd .. | ||
| fi | ||
|
|
||
| CONFIGURE_ARGS_AOM="-DAOM_INCLUDE_DIR=${DIR}/aom-${AOM_VERSION}/aom-source -DAOM_LIBRARY=-L${DIR}/aom-${AOM_VERSION}" | ||
| LIBRARY_LINKER_FLAGS="$LIBRARY_LINKER_FLAGS -laom" | ||
| LIBRARY_INCLUDE_FLAGS="$LIBRARY_INCLUDE_FLAGS -L${DIR}/aom-${AOM_VERSION}" | ||
| fi | ||
|
|
||
| EXTRA_EXE_LINKER_FLAGS="-lembind" | ||
| EXTRA_COMPILER_FLAGS="" | ||
| if [ "$STANDALONE" = "1" ]; then | ||
| EXTRA_EXE_LINKER_FLAGS="" | ||
| EXTRA_COMPILER_FLAGS="-D__EMSCRIPTEN_STANDALONE_WASM__=1" | ||
| fi | ||
|
|
||
| CONFIGURE_ARGS="-DENABLE_MULTITHREADING_SUPPORT=OFF -DWITH_GDK_PIXBUF=OFF -DWITH_EXAMPLES=OFF -DBUILD_SHARED_LIBS=ON -DENABLE_PLUGIN_LOADING=OFF" | ||
| emcmake cmake $CONFIGURE_ARGS \ | ||
| -DCMAKE_C_FLAGS="${EXTRA_COMPILER_FLAGS}" \ | ||
| -DCMAKE_CXX_FLAGS="${EXTRA_COMPILER_FLAGS}" \ | ||
| -DCMAKE_EXE_LINKER_FLAGS="${LIBRARY_LINKER_FLAGS} ${EXTRA_EXE_LINKER_FLAGS}" \ | ||
| $CONFIGURE_ARGS_LIBDE265 \ | ||
| $CONFIGURE_ARGS_AOM | ||
|
|
||
| emmake make -j${CORES} | ||
|
|
||
| LIBHEIFA="libheif/libheif.a" | ||
| EXPORTED_FUNCTIONS=$($EMSDK/upstream/bin/llvm-nm $LIBHEIFA --format=just-symbols | grep "^heif_\|^de265_\|^aom_" | grep "[^:]$" | sed 's/^/_/' | paste -sd "," -) | ||
|
There was a problem hiding this comment. This is necessary to make the C API's be exposed, otherwise they won't be available exported the WASM/JS code. |
||
|
|
||
| echo "Running Emscripten..." | ||
|
|
||
| BUILD_FLAGS="-lembind -o libheif.js --pre-js pre.js --post-js post.js -sWASM=$USE_WASM" | ||
| RELEASE_BUILD_FLAGS="-O3" | ||
|
|
||
| if [ "$STANDALONE" = "1" ]; then | ||
| echo "Building in standalone (non-web) build mode" | ||
| BUILD_FLAGS="$BUILD_FLAGS -s STANDALONE_WASM=1 -s WASM=1 -o libheif.wasm --no-entry" | ||
|
There was a problem hiding this comment. @farindk I specifically did not extend There was a problem hiding this comment. Ok. I'll undo that. I must admit that I didn't really understand the 'standalone' option. There was a problem hiding this comment. @farindk Standalone builds allow you to run the generated WASM outside the browser in WebAssembly runtimes such as Wasmer, WAVM, or wasmtime. Personally I'm using the standalone build in the Wazero runtime to be used in the go-libheif library, this allows for a go library that is fully contained (because the WASM is embedded in the library) and doesn't need external native libraries, it also allows the library to run fully sandboxed. The only downside is that it's slower than CGO, and multithreaded support is pretty bad right now, which causes the decoding to be around 3x as slow as CGO. |
||
| fi | ||
|
|
||
| if [ "$DEBUG" = "1" ]; then | ||
| echo "Building in debug mode" | ||
| RELEASE_BUILD_FLAGS="--profile -g" | ||
| fi | ||
|
|
||
| emcc "$LIBHEIFA" \ | ||
| -s EXPORTED_FUNCTIONS="$EXPORTED_FUNCTIONS,_free,_malloc,_memcpy" \ | ||
| -s ALLOW_MEMORY_GROWTH=1 \ | ||
| -s ERROR_ON_UNDEFINED_SYMBOLS=0 \ | ||
|
There was a problem hiding this comment. I have removed all the old flags here, I don't think they are neccesary. There was a problem hiding this comment. When not building to WASM, but plain JS, There was a problem hiding this comment. @farindk Ah I did not even know it was possible to only emit JS, was that what the previous version had as output? There was a problem hiding this comment. Yes, previously, it was a single There was a problem hiding this comment. @farindk Shouldn't There was a problem hiding this comment. Good point. But I think in this case, I would take the risk to change the default because WASM is clearly the future and it doesn't change anything for the end-user. Just of the ones building new libheif.js files. There was a problem hiding this comment. I have notified the following repo of the change: catdad-experiments/libheif-emscripten#19 What kind of other changes do you want to make? I think it might be interesting to look at thread support (for the browser it's possible). |
||
| -s LLD_REPORT_UNDEFINED \ | ||
| --memory-init-file 0 \ | ||
| -std=c++11 \ | ||
| $LIBRARY_INCLUDE_FLAGS \ | ||
| $LIBRARY_LINKER_FLAGS \ | ||
| $BUILD_FLAGS \ | ||
| $RELEASE_BUILD_FLAGS | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -112,7 +112,7 @@ static emscripten::val heif_js_decode_image(struct heif_image_handle* handle, | |
| result.set("width", width); | ||
| int height = heif_image_get_height(image, heif_channel_Y); | ||
| result.set("height", height); | ||
| std::basic_string<unsigned char> data; | ||
|
There was a problem hiding this comment. This was needed because Embind was messing up the data transfer when using a normal std::string, however, the data transfer between strings looks very odd to me right now because I think what currently happens is:
I believe we can remove the string conversion, probably also speeds things up a bit. I'm currently talking to Emscripten what the best way to do that is in Embind. There was a problem hiding this comment. Converning passing the data around: do you think this (answer item 3) might work? There was a problem hiding this comment. Yes! |
||
| result.set("chroma", heif_image_get_chroma_format(image)); | ||
| result.set("colorspace", heif_image_get_colorspace(image)); | ||
| switch (heif_image_get_colorspace(image)) { | ||
|
|
@@ -127,7 +127,7 @@ static emscripten::val heif_js_decode_image(struct heif_image_handle* handle, | |
| const uint8_t* plane_v = heif_image_get_plane_readonly(image, | ||
| heif_channel_Cr, &stride_v); | ||
| data.resize((width * height) + (2 * round_odd(width) * round_odd(height))); | ||
| unsigned char* dest = const_cast<unsigned char*>(data.data()); | ||
| strided_copy(dest, plane_y, width, height, stride_y); | ||
| strided_copy(dest + (width * height), plane_u, | ||
| round_odd(width), round_odd(height), stride_u); | ||
|
|
@@ -142,7 +142,7 @@ static emscripten::val heif_js_decode_image(struct heif_image_handle* handle, | |
| const uint8_t* plane_rgb = heif_image_get_plane_readonly(image, | ||
| heif_channel_interleaved, &stride_rgb); | ||
| data.resize(width * height * 3); | ||
| unsigned char* dest = const_cast<unsigned char*>(data.data()); | ||
| strided_copy(dest, plane_rgb, width * 3, height, stride_rgb); | ||
| } | ||
| break; | ||
|
|
@@ -153,7 +153,7 @@ static emscripten::val heif_js_decode_image(struct heif_image_handle* handle, | |
| const uint8_t* plane_grey = heif_image_get_plane_readonly(image, | ||
| heif_channel_Y, &stride_grey); | ||
| data.resize(width * height); | ||
| unsigned char* dest = const_cast<unsigned char*>(data.data()); | ||
| strided_copy(dest, plane_grey, width, height, stride_grey); | ||
| } | ||
| break; | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added
-DENABLE_PLUGIN_LOADING=OFF, I thought it would make sense.