Modernize library, bugfixes, improvements

.dockerignore

@@ -0,0 +1,5 @@
+.git
+*/*/.git
+.gitmodules
+.gitignore
+dist/

.github/workflows/emscripten.yml

@@ -13,9 +13,9 @@ jobs:
         git submodule sync
         git submodule update --init --force
     - name: Build the Docker image
-      run: docker build . --file Dockerfile --tag dador/javascriptsubtitlesoctopus:latest
+      run: docker build . --file Dockerfile --tag libass/javascriptsubtitlesoctopus:latest
     - name: Build All
-      run: docker run --rm -v ${PWD}:/code dador/javascriptsubtitlesoctopus:latest
+      run: docker run --rm -v ${PWD}/dist/js:/code/dist/js libass/javascriptsubtitlesoctopus:latest
     - uses: actions/upload-artifact@v1
       with:
         name: js

.gitignore

@@ -26,3 +26,6 @@ dist/libraries/
 *.pyc
 venv/
 node_modules/
+.idea/
+src/SubOctpInterface.cpp
+src/SubOctpInterface.js

Dockerfile

@@ -1,4 +1,5 @@
 FROM debian:buster
+
 RUN echo "force-unsafe-io" > /etc/dpkg/dpkg.cfg.d/force-unsafe-io
 RUN apt-get update && apt-get install -y --no-install-recommends \
         llvm \
@@ -22,15 +23,30 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
         automake \
         autoconf \
         m4 \
-        gperf && \
-    pip install ply && \
+        gperf \
+        wget && \
     rm -rf /var/lib/apt/lists/*
 
+RUN pip install ply
+
+
+ARG EMSCRIPTEN_TAG=2.0.2
+
 RUN git clone https://github.com/emscripten-core/emsdk.git && \
     cd emsdk && \
-    ./emsdk install 1.39.11 && \
-    ./emsdk activate 1.39.11
+    ./emsdk install ${EMSCRIPTEN_TAG} && \
+    ./emsdk activate ${EMSCRIPTEN_TAG}
 
-ENV PATH=$PATH:/emsdk:/emsdk/upstream/emscripten:/emsdk/node/12.9.1_64bit/bin
+ENV PATH=$PATH:/emsdk:/emsdk/upstream/emscripten:/emsdk/node/14.15.5_64bit/bin
 WORKDIR /code
+
+COPY . /code
+
+#Fixes fribidi requiring a git repository as a submodule
+RUN cd lib/fribidi/ && git init && git -c user.email="bogus@example.com" -c user.name="bogus" commit --allow-empty -m "bogus" && cd /code
+#Fixes fontconfig requiring a git repository as a submodule
+RUN cd lib/fontconfig/ && git init && git -c user.email="bogus@example.com" -c user.name="bogus" commit --allow-empty -m "bogus" && cd /code
+#Fixes libass requiring a git repository as a submodule
+RUN cd lib/libass/ && git init && git -c user.email="bogus@example.com" -c user.name="bogus" commit --allow-empty -m "bogus" && cd /code
+
 CMD ["make"]

Makefile

@@ -4,7 +4,8 @@
 BASE_DIR:=$(dir $(realpath $(firstword $(MAKEFILE_LIST))))
 DIST_DIR:=$(BASE_DIR)dist/libraries
 
-GLOBAL_CFLAGS:=-O3
+GLOBAL_CFLAGS:=-O3 -g0 -s ENVIRONMENT=web,worker -s DOUBLE_MODE=0
+GLOBAL_LDFLAGS:=
 
 all: subtitleoctopus
 
@@ -19,9 +20,12 @@ lib/fribidi/configure:
 	patch -d "$(BASE_DIR)lib/fribidi" -Np1 -i $(file);) \
 	NOCONFIGURE=1 ./autogen.sh
 
-dist/libraries/lib/libfribidi.a: lib/fribidi/configure
+$(DIST_DIR)/lib/libfribidi.a: lib/fribidi/configure
 	cd lib/fribidi && \
 	emconfigure ./configure \
+		LDFLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		CFLAGS=" \
 		-s USE_PTHREADS=0 \
 		$(GLOBAL_CFLAGS) \
@@ -49,9 +53,12 @@ lib/expat/expat/configured:
 	patch -d "$(BASE_DIR)lib/expat" -Np1 -i $(file);) \
 	touch configured && mkdir build
 
-dist/libraries/lib/libexpat.a: lib/expat/expat/configured
+$(DIST_DIR)/lib/libexpat.a: lib/expat/expat/configured
 	cd lib/expat/expat/build && \
 	emcmake cmake \
+		-DCMAKE_STATIC_LINKER_FLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		-DCMAKE_C_FLAGS=" \
 		-s USE_PTHREADS=0 \
 		$(GLOBAL_CFLAGS) \
@@ -79,31 +86,44 @@ lib/brotli/configured:
 	patch -d "$(BASE_DIR)lib/brotli" -Np1 -i $(file);) \
 	touch configured && mkdir build
 
-dist/libraries/lib/libbrotlidec.a: lib/brotli/configured
+lib/brotli/build/libbrotlidec.pc: lib/brotli/configured
 	cd lib/brotli/build && \
 	emcmake cmake \
+		-DCMAKE_STATIC_LINKER_FLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		-DCMAKE_C_FLAGS=" \
 		$(GLOBAL_CFLAGS) \
 		" \
 		-DCMAKE_INSTALL_PREFIX=$(DIST_DIR) \
 		.. \
 	&& \
 	emmake make -j8 && \
-	mkdir -p ../../../dist/libraries/lib/pkgconfig && \
-	mv libbrotlidec.pc ../../../dist/libraries/lib/pkgconfig && \
-	mv libbrotlicommon.pc ../../../dist/libraries/lib/pkgconfig && \
-	mv libbrotlidec-static.a ../../../dist/libraries/lib/libbrotlidec.a && \
-	mv libbrotlicommon-static.a ../../../dist/libraries/lib/libbrotlicommon.a && \
-	cp -r ../c/include ../../../dist/libraries/
+	cp -r ../c/include $(DIST_DIR)
+
+$(DIST_DIR)/lib/libbrotlicommon.a: lib/brotli/build/libbrotlidec.pc
+	cd lib/brotli/build && \
+	mkdir -p $(DIST_DIR)/lib/pkgconfig && \
+	cp libbrotlicommon.pc $(DIST_DIR)/lib/pkgconfig && \
+	cp libbrotlicommon-static.a $(DIST_DIR)/lib/libbrotlicommon.a
+
+$(DIST_DIR)/lib/libbrotlidec.a: lib/brotli/build/libbrotlidec.pc $(DIST_DIR)/lib/libbrotlicommon.a
+	cd lib/brotli/build && \
+	mkdir -p $(DIST_DIR)/lib/pkgconfig && \
+	cp libbrotlidec.pc $(DIST_DIR)/lib/pkgconfig && \
+	cp libbrotlidec-static.a $(DIST_DIR)/lib/libbrotlidec.a
 
 # Freetype without Harfbuzz
-lib/freetype/build_hb/dist_hb/lib/libfreetype.a: dist/libraries/lib/libbrotlidec.a
+lib/freetype/build_hb/dist_hb/lib/libfreetype.a: $(DIST_DIR)/lib/libbrotlidec.a
 	cd "lib/freetype" && \
 	NOCONFIGURE=1 ./autogen.sh && \
 	mkdir -p build_hb && \
 	cd build_hb && \
 	EM_PKG_CONFIG_PATH=$(DIST_DIR)/lib/pkgconfig \
 	emconfigure ../configure \
+		LDFLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		CFLAGS=" \
 		-s USE_PTHREADS=0 \
 		$(GLOBAL_CFLAGS) \
@@ -135,10 +155,13 @@ lib/harfbuzz/configure:
 	patch -d "$(BASE_DIR)lib/harfbuzz" -Np1 -i $(file);) \
 	NOCONFIGURE=1 ./autogen.sh
 
-dist/libraries/lib/libharfbuzz.a: lib/freetype/build_hb/dist_hb/lib/libfreetype.a lib/harfbuzz/configure
+$(DIST_DIR)/lib/libharfbuzz.a: lib/freetype/build_hb/dist_hb/lib/libfreetype.a lib/harfbuzz/configure
 	cd lib/harfbuzz && \
 	EM_PKG_CONFIG_PATH=$(DIST_DIR)/lib/pkgconfig:$(BASE_DIR)lib/freetype/build_hb/dist_hb/lib/pkgconfig \
 	emconfigure ./configure \
+		LDFLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		CFLAGS=" \
 		-s USE_PTHREADS=0 \
 		$(GLOBAL_CFLAGS) \
@@ -147,7 +170,6 @@ dist/libraries/lib/libharfbuzz.a: lib/freetype/build_hb/dist_hb/lib/libfreetype.
 		--llvm-lto 1 \
 		-s MODULARIZE=1 \
 		" \
-		LDFLAGS="" \
 		--prefix="$(DIST_DIR)" \
 		--host=x86-none-linux \
 		--build=x86_64 \
@@ -165,7 +187,7 @@ dist/libraries/lib/libharfbuzz.a: lib/freetype/build_hb/dist_hb/lib/libfreetype.
 	emmake make install
 
 # Freetype with Harfbuzz
-dist/libraries/lib/libfreetype.a: dist/libraries/lib/libharfbuzz.a dist/libraries/lib/libbrotlidec.a
+$(DIST_DIR)/lib/libfreetype.a: $(DIST_DIR)/lib/libharfbuzz.a $(DIST_DIR)/lib/libbrotlidec.a
 	cd "lib/freetype" && \
 	git reset --hard && \
 	$(foreach file, \
@@ -174,6 +196,9 @@ dist/libraries/lib/libfreetype.a: dist/libraries/lib/libharfbuzz.a dist/librarie
 	NOCONFIGURE=1 ./autogen.sh && \
 	EM_PKG_CONFIG_PATH=$(DIST_DIR)/lib/pkgconfig \
 	emconfigure ./configure \
+		LDFLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		CFLAGS=" \
 		-s USE_PTHREADS=0 \
 		$(GLOBAL_CFLAGS) \
@@ -198,18 +223,21 @@ dist/libraries/lib/libfreetype.a: dist/libraries/lib/libharfbuzz.a dist/librarie
 	emmake make install
 
 # Fontconfig
-lib/fontconfig/configure: 
+lib/fontconfig/configure:
 	cd lib/fontconfig && \
 	git reset --hard && \
 	$(foreach file, \
 	$(wildcard $(BASE_DIR)build/patches/fontconfig/*.patch), \
 	patch -d "$(BASE_DIR)lib/fontconfig" -Np1 -i $(file);) \
 	NOCONFIGURE=1 ./autogen.sh
 
-dist/libraries/lib/libfontconfig.a: dist/libraries/lib/libharfbuzz.a dist/libraries/lib/libexpat.a dist/libraries/lib/libfribidi.a dist/libraries/lib/libfreetype.a lib/fontconfig/configure
+$(DIST_DIR)/lib/libfontconfig.a: $(DIST_DIR)/lib/libharfbuzz.a $(DIST_DIR)/lib/libexpat.a $(DIST_DIR)/lib/libfribidi.a $(DIST_DIR)/lib/libfreetype.a lib/fontconfig/configure
 	cd lib/fontconfig && \
 	EM_PKG_CONFIG_PATH=$(DIST_DIR)/lib/pkgconfig \
 	emconfigure ./configure \
+		LDFLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		CFLAGS=" \
 		-s USE_PTHREADS=0 \
 		-DEMSCRIPTEN \
@@ -239,10 +267,13 @@ lib/libass/configure:
 	patch -d "$(BASE_DIR)lib/libass" -Np1 -i $(file);) \
 	NOCONFIGURE=1 ./autogen.sh
 
-dist/libraries/lib/libass.a: dist/libraries/lib/libfontconfig.a dist/libraries/lib/libharfbuzz.a dist/libraries/lib/libexpat.a dist/libraries/lib/libfribidi.a dist/libraries/lib/libfreetype.a dist/libraries/lib/libbrotlidec.a lib/libass/configure
+$(DIST_DIR)/lib/libass.a: $(DIST_DIR)/lib/libfontconfig.a $(DIST_DIR)/lib/libharfbuzz.a $(DIST_DIR)/lib/libexpat.a $(DIST_DIR)/lib/libfribidi.a $(DIST_DIR)/lib/libfreetype.a $(DIST_DIR)/lib/libbrotlidec.a lib/libass/configure
 	cd lib/libass && \
 	EM_PKG_CONFIG_PATH=$(DIST_DIR)/lib/pkgconfig \
 	emconfigure ./configure \
+		LDFLAGS=" \
+		$(GLOBAL_LDFLAGS) \
+		" \
 		CFLAGS=" \
 		-s USE_PTHREADS=0 \
 		$(GLOBAL_CFLAGS) \
@@ -256,6 +287,7 @@ dist/libraries/lib/libass.a: dist/libraries/lib/libfontconfig.a dist/libraries/l
 		--disable-shared \
 		--enable-static \
 		--disable-asm \
+		--enable-large-tiles \
 		\
 		--enable-harfbuzz \
 		--enable-fontconfig \
@@ -283,7 +315,7 @@ src/Makefile: src/SubOctpInterface.cpp
 	cd src && \
 	autoreconf -fi && \
 	EM_PKG_CONFIG_PATH=$(DIST_DIR)/lib/pkgconfig \
-	emconfigure ./configure --host=x86-none-linux --build=x86_64 CFLAGS="$(GLOBAL_CFLAGS)"
+	emconfigure ./configure --host=x86-none-linux --build=x86_64 LDFLAGS="$(GLOBAL_LDFLAGS)" CFLAGS="$(GLOBAL_CFLAGS)"
 
 src/subtitles-octopus-worker.bc: $(OCTP_DEPS) src/Makefile src/SubtitleOctopus.cpp src/SubOctpInterface.cpp
 	cd src && \
@@ -294,40 +326,38 @@ src/subtitles-octopus-worker.bc: $(OCTP_DEPS) src/Makefile src/SubtitleOctopus.c
 EMCC_COMMON_ARGS = \
 	$(GLOBAL_CFLAGS) \
 	-s EXPORTED_FUNCTIONS="['_main', '_malloc']" \
-	-s EXTRA_EXPORTED_RUNTIME_METHODS="['ccall', 'cwrap', 'getValue', 'FS_createPreloadedFile', 'FS_createFolder']" \
+	-s EXTRA_EXPORTED_RUNTIME_METHODS="['ccall', 'cwrap', 'getValue', 'FS_createPreloadedFile', 'FS_createFolder', 'FS_createLazyFile']" \
 	-s NO_EXIT_RUNTIME=1 \
-	--use-preload-plugins \
-	--preload-file assets/default.woff2 \
-	--preload-file assets/fonts.conf \
+	-s MALLOC=emmalloc \
 	-s ALLOW_MEMORY_GROWTH=1 \
+	-s INITIAL_MEMORY=67108864 \
+	--embed-file assets/fonts.conf \
 	-s FORCE_FILESYSTEM=1 \
+	-s ENVIRONMENT=web,worker \
+	-s DOUBLE_MODE=0 \
+	-s EVAL_CTORS=1 \
+	-s TEXTDECODER=2 \
+	-s LEGACY_VM_SUPPORT=0 \
+	-s MIN_CHROME_VERSION=75 \
+	-s MIN_FIREFOX_VERSION=65 \
+	-s MIN_EDGE_VERSION=0x7FFFFFFF \
+	-s MIN_SAFARI_VERSION=120000 \
 	--llvm-lto 1 \
 	--no-heap-copy \
+	--memory-init-file 0 \
+	-flto \
 	-o $@
-	#--js-opts 0 -g4 \
-	#--closure 1 \
-	#--memory-init-file 0 \
+	#-s WASM_BIGINT \
 	#-s OUTLINING_LIMIT=20000 \
 
-dist: src/subtitles-octopus-worker.bc dist/js/subtitles-octopus-worker.js dist/js/subtitles-octopus-worker-legacy.js dist/js/subtitles-octopus.js
-
-dist/js/subtitles-octopus-worker.js: src/subtitles-octopus-worker.bc src/pre-worker.js src/unbrotli.js src/SubOctpInterface.js src/post-worker.js
-	emcc src/subtitles-octopus-worker.bc $(OCTP_DEPS) \
-		--pre-js src/pre-worker.js \
-		--pre-js src/unbrotli.js \
-		--post-js src/SubOctpInterface.js \
-		--post-js src/post-worker.js \
-		-s WASM=1 \
-		$(EMCC_COMMON_ARGS)
+dist: src/subtitles-octopus-worker.bc dist/js/subtitles-octopus-worker.js dist/js/subtitles-octopus.js
 
-dist/js/subtitles-octopus-worker-legacy.js: src/subtitles-octopus-worker.bc src/pre-worker.js src/unbrotli.js src/SubOctpInterface.js src/post-worker.js
+dist/js/subtitles-octopus-worker.js: src/subtitles-octopus-worker.bc src/pre-worker.js src/SubOctpInterface.js src/post-worker.js
 	emcc src/subtitles-octopus-worker.bc $(OCTP_DEPS) \
 		--pre-js src/pre-worker.js \
-		--pre-js src/unbrotli.js \
 		--post-js src/SubOctpInterface.js \
 		--post-js src/post-worker.js \
-		-s WASM=0 \
-		-s LEGACY_VM_SUPPORT=1 \
+		-s WASM=2 \
 		$(EMCC_COMMON_ARGS)
 
 dist/js/subtitles-octopus.js: src/subtitles-octopus.js

README.md

@@ -1,9 +1,5 @@
-[![Actions Status](https://github.com/Dador/JavascriptSubtitlesOctopus/workflows/Emscripten/badge.svg)](https://github.com/Dador/JavascriptSubtitlesOctopus/actions)
-
 SubtitlesOctopus displays subtitles in .ass format and easily integrates with HTML5 videos. It supports all SSA/ASS features and fully compatible with [libass](https://github.com/libass/libass).
 
-[ONLINE DEMO](https://dador.github.io/JavascriptSubtitlesOctopus/videojs.html) / [other examples with demo](https://dador.github.io/JavascriptSubtitlesOctopus/)
-
 ## Features
 
 - Supports all SSA/ASS features
@@ -31,17 +27,17 @@ To start using SubtitlesOctopus you only need to instantiate a new instance of
 var options = {
     video: document.getElementById('video'), // HTML5 video element
     subUrl: '/test/test.ass', // Link to subtitles
+    fallbackFont: '/test/font-1.ttf', // Fallback font to be used in case none can be loaded / or has special characters
     fonts: ['/test/font-1.ttf', '/test/font-2.ttf'], // Links to fonts (not required, default font already included in build)
-    workerUrl: '/libassjs-worker.js', // Link to WebAssembly-based file "libassjs-worker.js"
-    legacyWorkerUrl: '/libassjs-worker-legacy.js' // Link to non-WebAssembly worker
+    workerUrl: '/subtitles-octopus-worker.js', // Link to worker file "libassjs-worker.js"
 };
 var instance = new SubtitlesOctopus(options);
 ```
 
 After that SubtitlesOctopus automatically "connects" to your video and it starts
 to display subtitles. You can use it with any HTML5 player.
 
-[See other examples](https://github.com/Dador/JavascriptSubtitlesOctopus/tree/master/example).
+[See other examples](https://github.com/libass/JavascriptSubtitlesOctopus/tree/master/example).
 
 ### Using only with canvas
 You're also able to use it without any video. However, that requires you to set
@@ -51,8 +47,9 @@ the time the subtitles should render at yourself:
 var options = {
     canvas: document.getElementById('canvas'), // canvas element
     subUrl: '/test/test.ass', // Link to subtitles
-    fonts: ['/test/font-1.ttf', '/test/font-2.ttf'], // Links to fonts (not required, default font already included in build)
-    workerUrl: '/libassjs-worker.js' // Link to file "libassjs-worker.js"
+    fallbackFont: '/test/font-1.ttf', // Fallback font to be used in case none can be loaded / or has special characters
+    fonts: ['/test/font-1.ttf', '/test/font-2.ttf'], // Links to fonts
+    workerUrl: '/subtitles-octopus-worker.js' // Link to file "libassjs-worker.js"
 };
 var instance = new SubtitlesOctopus(options);
 // And then...
@@ -102,7 +99,8 @@ When creating an instance of SubtitleOctopus, you can set the following options:
   `subContent` to be specified)
 - `subContent`: The content of the subtitle file to play. (Require either
   `subContent` or `subUrl` to be specified)
-- `workerUrl`: The URL of the worker. (Default: `libassjs-worker.js`)
+- `workerUrl`: The URL of the worker. (Default: `subtitles-octopus-worker.js`)
+- `fallbackFont`: The URL of a fallback font to be used in case none can be loaded / or has special characters
 - `fonts`: An array of links to the fonts used in the subtitle. (Optional)
 - `availableFonts`: Object with all available fonts - Key is font name in lower
   case, value is link: `{"arial": "/font1.ttf"}` (Optional)
@@ -122,11 +120,6 @@ The Fast Render mode has been created by @no1d as a suggestion for fix browser f
 
 To enable this mode set the option `lossyRender` to `true` when creating an instance of SubtitleOctopus.
 
-### Brotli Compressed Subtitles
-The SubtitleOctopus allow the use of compressed subtitles in brotli format, saving bandwidth and reducing library startup time
-
-To use, just run: `brotli subFile.ass` and use the .br result file with the subUrl option
-
 ## How to build?
 
 ### Dependencies
@@ -151,12 +144,12 @@ To use, just run: `brotli subFile.ass` and use the .br result file with the subU
 
 ### Get the Source
 
-Run `git clone --recursive https://github.com/Dador/JavascriptSubtitlesOctopus.git`
+Run `git clone --recursive https://github.com/libass/JavascriptSubtitlesOctopus.git`
 
 ### Build with Docker
 1) Install Docker
-2) `docker build -t dador/javascriptsubtitlesoctopus .`
-3) `docker run -it --rm -v ${PWD}:/code dador/javascriptsubtitlesoctopus:latest`
+2) `docker build -t libass/javascriptsubtitlesoctopus .`
+3) `docker run -it --rm -v ${PWD}/dist/js:/code/dist/js libas/javascriptsubtitlesoctopus:latest`
 4) Artifacts are in /dist/js
 
 ## Why "Octopus"?