cvat/cvat-data/src/ts/3rdparty

3rdparty components

These files are from the Broadway.js repository:

• Decoder.js
• mp4.js
• avc.wasm

Why do we store them here?

Authors don't provide an npm package, so we need to store these components in our repository. We use this dependency to decode video chunks from a server and split them to frames on client side.

We need to run this package in node environent (for example for debug, or for running unit tests). But there aren't any ways to do that (even with syntetic environment, provided for example by the package browser-env). For example there are issues with canvas using (webpack doesn't work with binary canvas package for node-js) and others. So, we have solved to write patch file for this library. It modifies source code a little to support our scenario of using.

How to build awc.wasm and Decoder.js

1. Clone Emscripten SDK, install and activate the latest fastcomp SDK:

   git clone https://github.com/emscripten-core/emsdk.git && cd emsdk
   

   ./emsdk install latest-fastcomp
   

   ./emsdk activate latest-fastcomp
   

2. Clone Broadway.js

   git clone https://github.com/mbebenita/Broadway.git && cd Broadway/Decoder
   

3. Edit make.py:

   • Remove or comment the following options: '-s', 'NO_BROWSER=1',
'-s', 'PRECISE_I64_MATH=0',
   • Remove "HEAP8", "HEAP16", "HEAP32" from the EXPORTED_FUNCTIONS list.
   • Increase total memory to make possible decode 4k videos (or try to enable ALLOW_MEMORY_GROWTH, but this option has not been tested):
     '-s', 'TOTAL_MEMORY=' + str(100*1024*1024),
   • Add the following options:
     '-s', "ENVIRONMENT='worker'",
'-s', 'WASM=1',

4. Activate emsdk environment and build Broadway.js:

   . /tmp/emsdk/emsdk_env.sh
   

   python2 make.py
   

5. Copy the following files to cvat-data 3rdparty source folder:

   cd ..
   

   cp Player/avc.wasm  Player/Decoder.js Player/mp4.js <CVAT_FOLDER>/cvat-data/src/
   

   js/3rdparty
   

How work with a patch file

    # from cvat-data/src/js
    cp -r 3rdparty 3rdparty_edited
    # change 3rdparty edited as we need
    diff -u 3rdparty 3rdparty_edited/ > 3rdparty_patch.diff
    patch -p0 < 3rdparty_patch.diff # apply patch from cvat-data/src/js

Also these files have been added to ignore for git in all future revisions:

    # from cvat-data dir
    git update-index --skip-worktree src/js/3rdparty/*.js

This behaviour can be reset with:

    # from cvat-data dir
    git update-index --no-skip-worktree src/js/3rdparty/*.js

Stackoverflow issue